kapa-setup-custom-qa

Files (1)

• SKILL.md

SKILL.md (first lines)

# Set up custom answers

The one source the user writes themselves. Use it when an answer exists nowhere
else, or when Kapa keeps getting something wrong and they want to correct it
directly.

## 1. Create the source

`create_custom_qa_source` with `project` and `name`. Keep the returned id.

## 2. Add the pairs

`add_custom_qa_pair` with `custom_qa_source`, `question` and `answer`. **Call it
once per pair**; there is no batch call.

Confirm the full list with the user before you start, then add them one at a
time.

## Writing them well

- Write the `question` the way a user would actually ask it, not as a heading.
  "How do I rotate an API key?" rather than "API key rotation".
- The `answer` takes Markdown.
- The same question text cannot be added twice to one source.

## After adding

Each pair ingests as it is added, so there is no separate publish step.

## Finish the job

Saving the configuration starts ingestion. There is no separate publish step,
so once the config saves the source is live.

Then call `list_sources` with `project_id` to confirm what the project holds.

From kapa-ai/kapa-plugin, MIT.

More from kapa-ai/kapa-plugin