ナレッジベース API

このドキュメントは AI によって自動翻訳されています。不正確な部分がある場合は、英語版を参照してください。

ナレッジベースの種類ごとに API が分かれていますが、どちらも同じ API キーを使います。

API キーの作成 #

Info

キーを作成、表示、削除できるのは、ワークスペースのオーナーと管理者だけです。

ナレッジ 画面で右上の サービスAPI をクリックし、続けて APIキー をクリックします。1 つのワークスペースで作成できるキーは最大 10 個です。

同じパネルには、両方の API のベース URL であるサービス API エンドポイントも表示されます。

キーの作成時に、すべてのナレッジベースへのアクセスを許可するか、選んだナレッジベースだけに限定するかを決めます。選べるのはどちらの種類のナレッジベースでもかまいません。連携先が扱うナレッジベースだけを選んでください。

特定のナレッジベースを指定しない操作も呼び出す場合は、代わりにすべてのナレッジベースへのアクセスを許可します。従来型ナレッジベースの一覧取得や作成、タグの管理、利用可能なモデルの取得などがこれにあたります。

アクセス範囲は後から変更できません。変更が必要な場合は、キーを置き換えてください。

キーのアクセス範囲を変更する場合やキーをローテーションする場合は、新しいキーを作成して連携先を切り替えてから、古いキーを削除します。削除したキーはすぐに使えなくなります。

Agent ナレッジベースのリサーチタスクと削除ジョブは、それを開始したキーでしか読み取れません。古いキーを削除する前に、それらの完了を待ち、結果を読み取っておいてください。

原因	従来型ナレッジベース	Agent ナレッジベース
ナレッジベースがキーのアクセス範囲外にある	403 `forbidden`	403 `knowledge_fs_access_denied`
アクセス範囲を限定したキーで、ナレッジベースを指定しない操作を呼び出した	403 `forbidden`	403 `forbidden`
ナレッジベースの API アクセスがオフになっている	403 `forbidden`	403 `knowledge_fs_access_denied`
キーが直接削除された、または対象だった唯一のナレッジベースとともに削除された	401 `unauthorized`	401 `unauthorized`
Dify Cloud で、ワークスペースがリクエストレート制限に達した	403 `forbidden`	403 `forbidden`

従来型ナレッジベースの 403 forbidden は上記のいくつかの原因で返るため、エラーの message を読んで区別してください。

従来型ナレッジベースにアクセス範囲を限定したキーは、そのナレッジベースからアップグレードした Agent ナレッジベースには使えません。Agent ナレッジベースにアクセスするには、それを含むキーに置き換えてください。

キーのワークスペースに存在しない Agent ナレッジベース ID を指定すると、無効なキーと同じく 401 knowledge_fs_invalid_credential が返ります。キーを置き換える前に、ID を確認してください。