dify-knowledge-base-search について
dify-knowledge-base-search は、Dify 経由でデータセットを検索するスキルです。リクエストの設定、応答の解釈、検索時のトラブルシューティングを案内します。
主な機能
- 01Dify のデータセット検索エンドポイントを呼び出し
- 02クエリと任意の top_k を設定
- 03応答内のレコードを解釈
- 04認証やルートの問題を確認
活用シーン
- 01クエリで Dify のデータセットを検索
- 02レコードを増やすため top_k を調整
- 03API の認証またはルーティングエラーを解決
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ tiangong-ai/ agent-skills --skill dify-knowledge-base-searchインストール後、Claude Code で/dify-knowledge-base-searchを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
agents/openai.yamlassets/example-request.jsonreferences/env.mdrequest-response.mdtesting.md詳細
Dify ナレッジベース検索
必要な入力を準備する
queryと任意のretrieval_model.top_kを含む JSON としてdataを指定します。- 次の環境変数を読み取ります。
DIFY_API_BASE_URL:/v1を含むベース API URL(例:https://api.dify.ai/v1)。DIFY_DATASET_ID:対象のデータセット ID。DIFY_API_KEY:Authorization: Bearer <DIFY_API_KEY>として送信します。
リクエストを送信する
- エンドポイント:
${DIFY_API_BASE_URL}/datasets/${DIFY_DATASET_ID}/retrieve - ヘッダー:
Content-Type: application/jsonAuthorization: Bearer <DIFY_API_KEY>
- ペイロードのテンプレートとして
assets/example-request.jsonを使用します。
curl -sS --location --request POST "$DIFY_API_BASE_URL/datasets/$DIFY_DATASET_ID/retrieve" \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer $DIFY_API_KEY" \
--data @assets/example-request.json
レスポンスを解釈する
- リクエスト形式:
{ "query": string, "retrieval_model"?: { "top_k": number } } - 成功時の形式:200 と
{ query, records: [...] } recordsが空の場合は、retrieval_model.top_kを適度に増やして再試行します。
すばやくトラブルシューティングする
- 認証に失敗する場合は、
DIFY_API_KEYとAuthorizationヘッダーの形式を確認します。 - ルートへのアクセスに失敗する場合は、
DIFY_API_BASE_URLに/v1が含まれていることを確認します。 - 結果の品質が低い場合は、
queryを調整し、top_kを調整します。
参考資料
references/env.mdreferences/request-response.mdreferences/testing.md
アセット
assets/example-request.json
コメント
Markdown 対応