ドキュメントリストの取得

エージェント内のナレッジベースに登録されたドキュメントリストを取得します。

リクエストメソッド

GET

リクエストURL

https://api-${endpoint}.gptbots.ai/v1/bot/doc/query/page

リクエスト認証

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

リクエスト

リクエスト例

curl -X GET 'https://api.gptbots.ai/v1/bot/doc/query/page?page=1&page_size=10&knowledge_base_id=67457fea6f658672d6482542' \ -H 'Authorization: Bearer ${API Key}'

                      
                      curl -X GET 'https://api.gptbots.ai/v1/bot/doc/query/page?page=1&page_size=10&knowledge_base_id=67457fea6f658672d6482542' \
-H 'Authorization: Bearer ${API Key}'

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

リクエストヘッダー

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

リクエストボディ

フィールド	タイプ	必須	説明
knowledge_base_id	String	必須	ナレッジベースのIDです。
page	Integer	必須	ページの番号です（1ページ目から始まります）。
page_size	Integer	必須	1ページに表示するドキュメントの件数を、10〜100の範囲で指定してください。

レスポンス

レスポンス例

{ "list": [ { "id": "xxxxxx", "name": "My Doc", "format": "pdf", "source_url": "https://gptbots.ai/article_1.pdf", "status": "ACTIVE", "chunk": 100, "token": 1000000, "char_count": 10000000, "create_time": 1699843200, "update_time": 1699843200, "creator_id": "xxxxxx", "creator_email": "johnlee@gptbots.ai" }, { "id": "xxxxxx", "name": "My Doc 2", "format": "txt", "source_url": "https://gptbots.ai/article_2.html", "status": "ACTIVE", "chunk": 100, "token": 1000000, "char_count": 10000000, "create_time": 1699843200, "update_time": 1699843200, "creator_id": "xxxxxx", "creator_email": "johnlee@gptbots.ai" } ], "total": 100 }

                      
                      {
    "list": [
        {
            "id": "xxxxxx",
            "name": "My Doc",
            "format": "pdf",
            "source_url": "https://gptbots.ai/article_1.pdf",
            "status": "ACTIVE",
            "chunk": 100,
            "token": 1000000,
            "char_count": 10000000,
            "create_time": 1699843200,
            "update_time": 1699843200,
            "creator_id": "xxxxxx",
            "creator_email": "johnlee@gptbots.ai"
        },
        {
            "id": "xxxxxx",
            "name": "My Doc 2",
            "format": "txt",
            "source_url": "https://gptbots.ai/article_2.html",
            "status": "ACTIVE",
            "chunk": 100,
            "token": 1000000,
            "char_count": 10000000,
            "create_time": 1699843200,
            "update_time": 1699843200,
            "creator_id": "xxxxxx",
            "creator_email": "johnlee@gptbots.ai"
        }
    ],
    "total": 100
}

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

成功時のレスポンス

フィールド名	タイプ	説明
list	Array<Object>	ドキュメントの一覧です。
id	String	ドキュメントのIDです。
name	String	ドキュメントの名前です。
format	String	ドキュメントの形式（ファイルタイプ）です。
source_url	String	ドキュメントのソースURLです。
status	String	ドキュメントのステータスです。
chunk	Integer	ドキュメント内のナレッジチャンクの数です。
token	Integer	ドキュメントに含まれるトークンの数です。
char_count	Integer	ドキュメント内の文字数です。
create_time	Long	ドキュメントの作成時間（タイムスタンプ）
update_time	Long	ドキュメントの更新時間（タイムスタンプ）
creator_id	String	ドキュメントを作成したユーザーIDです。
creator_email	String	ドキュメントを作成したユーザーのメールアドレスです。
total	Integer	検索でヒットしたドキュメントの総数です。

エラー時のレスポンス

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