ナレッジベースリストの取得

エージェント内のナレッジベースリストを取得します。

リクエストメソッド

GET

リクエストURL

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

リクエスト認証

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

リクエスト

リクエスト例

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/knowledge/base/page' \ -H 'Authorization: Bearer ${API Key}'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/bot/knowledge/base/page' \
-H 'Authorization: Bearer ${API Key}'

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

リクエストヘッダー

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

リクエストボディ

なし

レスポンス

レスポンス例

{ "knowledge_base": [ { "id": "xxxxxx", "name": "My Knowledge Base", "desc": "This is my knowledge base.", "doc": 10, "chunk": 1000, "token": 1000000, "owner_id": "xxxxxx", "owner_email": "johnlee@gptbots.ai" }, { "id": "xxxxxx", "name": "My Knowledge Base 2", "desc": "This is my knowledge base 2.", "doc": 10, "chunk": 1000, "token": 1000000, "owner_id": "xxxxxx", "owner_email": "jasonwong@gptbots.ai" } ] }

                      
                      {
    "knowledge_base": [
        {
            "id": "xxxxxx",
            "name": "My Knowledge Base",
            "desc": "This is my knowledge base.",
            "doc": 10,
            "chunk": 1000,
            "token": 1000000,
            "owner_id": "xxxxxx",
            "owner_email": "johnlee@gptbots.ai"
        },
        {
            "id": "xxxxxx",
            "name": "My Knowledge Base 2",
            "desc": "This is my knowledge base 2.",
            "doc": 10,
            "chunk": 1000,
            "token": 1000000,
            "owner_id": "xxxxxx",
            "owner_email": "jasonwong@gptbots.ai"
        }
    ]
}

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

成功時のレスポンス

フィールド	タイプ	説明
knowledge_base	Array<Object>	ドキュメントの一覧です。
id	String	ドキュメントのIDです。
name	String	ドキュメントの名前です。
desc	String	ナレッジベースの説明です。
doc	Integer	ナレッジベースに含まれるドキュメントの数です
chunk	Integer	ナレッジベースに含まれるチャンクの数です。
token	Number	ナレッジベース内に含まれるトークンの数です。
owner_id	String	ナレッジベースの所有者のIDです。
owner_email	String	ナレッジベースの所有者のメールアドレスです。

エラー時のレスポンス

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