ドキュメント詳細を取得

特定のドキュメントの詳細情報（インデックスステータス、メタデータ、処理統計を含む）を取得します。

GET /datasets/{dataset_id}/documents/{document_id}

Error

A valid request URL is required to generate request examples

200

{
  "id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac",
  "position": 1,
  "data_source_type": "upload_file",
  "data_source_info": {
    "upload_file_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "dataset_process_rule_id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
  "dataset_process_rule": {
    "id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
    "mode": "custom"
  },
  "document_process_rule": {
    "mode": "custom",
    "rules": {
      "pre_processing_rules": [],
      "segmentation": {
        "separator": "###",
        "max_tokens": 500,
        "chunk_overlap": 50
      }
    }
  },
  "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_language": "English",
  "doc_type": null,
  "doc_metadata": [],
  "completed_at": 1741267260,
  "updated_at": 1741267260,
  "indexing_latency": 60,
  "segment_count": 5,
  "average_segment_length": 70,
  "summary_index_status": null,
  "need_summary": false
}

承認

Authorization · string · header · 必須

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

パスパラメータ

dataset_id · string<uuid> · 必須

ナレッジベース ID です。

document_id · string<uuid> · 必須

Document ID.

クエリパラメータ

metadata · enum<string> · デフォルト: all

all はメタデータを含むすべてのフィールドを返します。only は id、doc_type、doc_metadata のみを返します。without は doc_metadata を除くすべてのフィールドを返します。

利用可能なオプション: all, only, without

レスポンス

200

application/json

ドキュメントの詳細です。レスポンスの形式は metadata クエリパラメータによって異なります。metadata が only の場合、id、doc_type、doc_metadata のみが返されます。metadata が without の場合、doc_type と doc_metadata は省略されます。

id · string

ドキュメント識別子です。

position · integer

ナレッジベース内の位置インデックスです。

data_source_type · string

ドキュメントのアップロード方法です。ファイルアップロードの場合は upload_file、Notion インポートの場合は notion_import です。

data_source_info · object

生データソース情報です。

dataset_process_rule_id · string

このドキュメントに適用された処理ルールの ID です。

dataset_process_rule · object

ナレッジベースレベルの処理ルール設定です。

document_process_rule · object

ドキュメントレベルの処理ルール設定です。

name · string

ドキュメント名です。

created_from · string

ドキュメントの作成元です。API で作成した場合は api、UI で作成した場合は web です。

created_by · string

ドキュメントを作成したユーザーの ID です。

created_at · number

ドキュメント作成の Unix タイムスタンプです。

tokens · integer

ドキュメント内のトークン数です。

indexing_status · string

現在のインデックスステータスです（例：waiting、parsing、cleaning、splitting、indexing、completed、error、paused）。

error · string | null

インデックス作成が失敗した場合のエラーメッセージです。それ以外は null です。

enabled · boolean

このドキュメントが検索に対して有効かどうかです。

disabled_at · number | null

ドキュメントが無効化された Unix タイムスタンプです。有効な場合は null です。

disabled_by · string | null

ドキュメントを無効化したユーザーの ID です。有効な場合は null です。

archived · boolean

ドキュメントがアーカイブ済みかどうかです。

display_status · string

UI 向けの表示用インデックスステータスです。

word_count · integer

ドキュメントの合計単語数です。

hit_count · integer

このドキュメントが検索された回数です。

doc_form · string

ドキュメントのチャンキングモードです。text_model は標準テキスト、hierarchical_model は親子構造、qa_model は QA ペアを示します。

doc_language · string

ドキュメント内容の言語です。

doc_type · string | null

ドキュメントタイプの分類です。未設定の場合は null です。

doc_metadata · object[]

このドキュメントのカスタムメタデータキーバリューペア。

Show child attributes

completed_at · number | null

処理が完了した Unix タイムスタンプです。まだ完了していない場合は null です。

updated_at · number | null

最終更新の Unix タイムスタンプです。更新されたことがない場合は null です。

indexing_latency · number | null

インデックス作成にかかった時間（秒）です。未完了の場合は null です。

segment_count · integer

ドキュメント内のチャンク数です。

average_segment_length · number

チャンクの平均文字長です。

summary_index_status · string | null

要約インデックスのステータスです。要約インデックスが有効でない場合は null です。

need_summary · boolean

このドキュメントが要約生成を必要とするかどうかです。