74 lines
2.6 KiB
Markdown
74 lines
2.6 KiB
Markdown
# Prompt Customization
|
|
|
|
Customize the prompts used by haiku.rag's skills to better match your domain and use case.
|
|
|
|
## Configuration
|
|
|
|
```yaml
|
|
prompts:
|
|
# Domain context prepended to skill instructions
|
|
domain_preamble: |
|
|
This knowledge base contains technical documentation for the Helios solar panel
|
|
system, including installation manuals, maintenance procedures, and safety guidelines.
|
|
Questions about "the system" or unqualified specs refer to the Helios panel.
|
|
|
|
# VLM prompt for image description during conversion (optional)
|
|
picture_description: null # Uses default prompt
|
|
```
|
|
|
|
## Domain Preamble
|
|
|
|
The `domain_preamble` field provides **domain context** prepended to the rag and rag-analysis skill instructions. Use this to:
|
|
|
|
- Describe what the knowledge base contains
|
|
- Clarify domain-specific terminology
|
|
- Provide context that helps the model interpret ambiguous queries
|
|
|
|
**Important:** `domain_preamble` is for domain context, not behavioral instructions. Descriptions of subject matter, terminology, and content scope belong here. Behavioral guidance (tone, response style, formatting rules) lives in the skill's SKILL.md. Fork the skill via `haiku-rag create-skill` to customize behavior.
|
|
|
|
**Example:**
|
|
|
|
```yaml
|
|
prompts:
|
|
domain_preamble: |
|
|
This knowledge base contains product documentation, API references,
|
|
and troubleshooting guides for Acme Corp's cloud platform.
|
|
"Deployment" refers to Acme's managed deployment service, not general CI/CD.
|
|
```
|
|
|
|
## Picture Description Prompt
|
|
|
|
Customize the prompt used when generating VLM descriptions for embedded images during document conversion. This prompt is sent to the configured Vision Language Model for each image.
|
|
|
|
**Default prompt:**
|
|
|
|
```
|
|
Describe this image for a blind user. State the image type (screenshot, chart, photo, etc.),
|
|
what it depicts, any visible text, and key visual details. Be concise and accurate.
|
|
```
|
|
|
|
**Custom example:**
|
|
|
|
```yaml
|
|
prompts:
|
|
picture_description: |
|
|
Describe this image for a document search system.
|
|
Focus on: image type, main content, any text, key visual elements.
|
|
Be concise and factual.
|
|
```
|
|
|
|
The prompt is used when `processing.pictures` is `"description"`. See [Picture Handling](processing.md#picture-handling) for full configuration.
|
|
|
|
## Programmatic Configuration
|
|
|
|
```python
|
|
from haiku.rag.config import AppConfig
|
|
from haiku.rag.config.models import PromptsConfig
|
|
|
|
config = AppConfig(
|
|
prompts=PromptsConfig(
|
|
domain_preamble="This knowledge base contains Acme Corp product documentation and API references.",
|
|
picture_description="Describe this image for search indexing.",
|
|
)
|
|
)
|
|
```
|