1 つのナレッジベース API キーは、ワークスペースオーナーから見えるすべてのナレッジベースにアクセスできます（リクエストはキーの作成者にかかわらずオーナー権限で実行されます）。データの意図しない漏えいを防ぐため、キーは慎重に管理してください。
API エンドポイントとキーの取得
ナレッジ 画面で APIアクセス タブを開きます。ここから以下を行えます。- APIサーバー のアドレスをコピーします。すべてのナレッジ API リクエストのベース URL です。
- APIキー をクリックしてキーを作成・管理します。
ナレッジベースの作成と管理
- 空のナレッジベースを作成：ドキュメントを含まないナレッジベースを作成します。
- ナレッジベースリストを取得：キーワードまたはタグで絞り込めるページネーション付きリストを返します。
- ナレッジベースを削除：ナレッジベースとその中のすべてのドキュメントを完全に削除します。
- ナレッジベースからチャンクを取得 / テスト検索：ナレッジベースを検索し、最も関連性の高いチャンクを返します。本番検索と検索テストの両方に同じエンドポイントを使います。
ドキュメントの追加と更新
ドキュメントの作成は非同期です。作成後、インデックスが完了するまでポーリングします。1
ナレッジベースの作成
空のナレッジベースを作成 を呼び出します。既存のナレッジベースをそのまま使うこともできます。
2
ドキュメントの追加
テキストからドキュメントを作成 または ファイルからドキュメントを作成 を呼び出します。どちらも
batch ID を返します。ナレッジベース作成時に indexing_technique（検索用に内容をインデックスする方法）を設定しなかった場合は、この最初のドキュメントで設定します。以降のドキュメントには自動的に引き継がれます。3
インデックス状況のポーリング
batch ID を使って ドキュメント埋め込みステータス（進捗）を取得 をポーリングします。indexing_status が completed または error になるまで待ちます。処理は waiting、parsing、cleaning、splitting、indexing の順に進みます。- ナレッジベースのドキュメントリストを取得：キーワードで絞り込めるページネーション付きリストを返します。
- テキストでドキュメントを更新：ドキュメントのテキスト内容、名前、処理設定をインラインで更新します。内容が変わるとインデックスを再実行します。
- ファイルでドキュメントを更新：新しいファイルをアップロードして内容を置き換え、インデックスを再実行します。
- ドキュメントを削除：ドキュメントとその中のすべてのチャンクを完全に削除します。
チャンクの管理
- ドキュメントにチャンクを追加：チャンクを手動でドキュメントに追加します（アップロードされた内容は、インデックス処理が自動でチャンク化します）。各チャンクには
contentが必須で、Q&A モードのドキュメントではanswerも必須です。 - チャンク一覧を取得：キーワードやステータスで絞り込めるチャンクのリストを返します。
- ドキュメント内のチャンクを更新：チャンクの内容、キーワード、回答を変更し、そのチャンクのインデックスを再実行します。
- ドキュメント内のチャンクを削除：チャンクを完全に削除します。