ナレッジベースの作成

このAPIを使用して、API Keyに紐づくエージェントに新しいナレッジベースを作成できます。

リクエストメソッド

POST

リクエストURL

https://api-${endpoint}.gptbots.ai/v1/bot/knowledge/base/create

リクエスト認証

認証方法の説明についてはAPI Overviewをご参照ください。

リクエスト

リクエスト例

curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/bot/knowledge/base/create' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "name": "製品ナレッジベース", "desc": "製品マニュアル、FAQ、業務資料を格納するためのナレッジベース", "graph_enable": false, "access_control_enabled": false }'

                      
                      curl -X POST 'https://api-${endpoint}.gptbots.ai/v1/bot/knowledge/base/create' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
    "name": "製品ナレッジベース",
    "desc": "製品マニュアル、FAQ、業務資料を格納するためのナレッジベース",
    "graph_enable": false,
    "access_control_enabled": false
}'

このコードブロックをポップアップで表示

リクエストヘッダー

フィールド	タイプ	説明
Authorization	Bearer ${API Key}	認証には `Authorization: Bearer ${API Key}` を使用してください。トークンはAPIキーページから取得できます。

リクエストボディ

フィールド名	タイプ	必須	説明
name	String	必須	ナレッジベースの名前です。
desc	String	必須	ナレッジベースの説明です。
graph_enable	Boolean	任意	ナレッジグラフを有効にするかどうかです。
kg_ner_extraction_user_prompt	String	任意	トリプル抽出プロンプトです。空の場合はシステムのデフォルト設定が使用されます。
access_control_enabled	Boolean	任意	アクセス制御（ロールまたはドキュメントレベルの権限フィルタリング）を有効にするかどうかです。

レスポンス

レスポンス例

{ "knowledge_base_id": "6a475ee61d276b3d062a1bcb" }

                      
                      {
    "knowledge_base_id": "6a475ee61d276b3d062a1bcb"
}

このコードブロックをポップアップで表示

成功時のレスポンス

フィールド	タイプ	説明
knowledge_base_id	String	新規作成されたナレッジベースのIDです。

エラー時のレスポンス

フィールド	タイプ	説明
code	Integer	エラーコード
message	String	エラーの詳細内容