ナレッジベースのドキュメントリストを取得

ナレッジベース内のドキュメントのページネーションされた一覧を返します。キーワードやインデックスステータスによるフィルタリングをサポートしています。

GET /datasets/{dataset_id}/documents

Error

A valid request URL is required to generate request examples

200

{
  "data": [
    {
      "id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac",
      "position": 1,
      "data_source_type": "upload_file",
      "data_source_info": {
        "upload_file_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      },
      "data_source_detail_dict": {
        "upload_file": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "name": "guide.txt",
          "size": 2048,
          "extension": "txt",
          "mime_type": "text/plain",
          "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
          "created_at": 1741267200
        }
      },
      "dataset_process_rule_id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
      "name": "guide.txt",
      "created_from": "api",
      "created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
      "created_at": 1741267200,
      "tokens": 512,
      "indexing_status": "completed",
      "error": null,
      "enabled": true,
      "disabled_at": null,
      "disabled_by": null,
      "archived": false,
      "display_status": "available",
      "word_count": 350,
      "hit_count": 0,
      "doc_form": "text_model",
      "doc_metadata": [],
      "summary_index_status": null,
      "need_summary": false
    }
  ],
  "has_more": false,
  "limit": 20,
  "total": 1,
  "page": 1
}

承認

Authorization · string · header · 必須

API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例：Authorization: Bearer {API_KEY}。API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。

パスパラメータ

dataset_id · string<uuid> · 必須

ナレッジベース ID です。

クエリパラメータ

page · integer · デフォルト: 1

取得するページ番号。

limit · integer · デフォルト: 20

1 ページあたりの項目数です。サーバーの上限は 100 です。

keyword · string

ドキュメント名でフィルタリングするための検索キーワードです。

status · enum<string>

表示ステータスでフィルタリングします。

利用可能なオプション: queuing, indexing, paused, error, available, disabled, archived

レスポンス

200

application/json

ドキュメントのリストです。

data · object[]

ナレッジベースオブジェクトの配列です。

Show child attributes

has_more · boolean

次のページにさらに項目が存在するかどうかです。

limit · integer

1 ページあたりの件数です。

total · integer

一致する項目の合計数です。

page · integer

現在のページ番号です。