ドキュメント詳細を取得
1 つのドキュメントの詳細情報を返します。
承認
すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。
キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401(unauthorized)で失敗します。
クエリパラメータ
all はメタデータを含むすべてのフィールドを返します。only は id、doc_type、doc_metadata のみを返します。without は doc_metadata を除くすべてのフィールドを返します。
all, only, without レスポンス
ドキュメントの詳細です。返されるフィールドは metadata クエリパラメータによって異なります。
ドキュメント識別子です。
ナレッジベース内の位置インデックスです。
ドキュメントのアップロード方法です。ファイルアップロードの場合は upload_file、Notion インポートの場合は notion_import です。
データソースの詳細です。ファイルアップロードの場合、この詳細エンドポイントは upload_file 配下に完全なファイルオブジェクトを返します(リストエンドポイントは upload_file_id のみを返します)。
このドキュメントに適用された処理ルールの ID です。
ナレッジベースレベルの処理ルール設定です。
ドキュメントレベルの処理ルール設定です。
ドキュメント名です。
ドキュメントの作成元です。API で作成した場合は api、UI で作成した場合は web です。
ドキュメントを作成したユーザーの ID です。
ドキュメント作成の Unix タイムスタンプです。
ドキュメント内のトークン数です。
現在のインデックスステータスです(例:waiting、parsing、cleaning、splitting、indexing、completed、error、paused)。
インデックス作成が失敗した場合のエラーメッセージです。それ以外は null です。
このドキュメントが検索に対して有効かどうかです。
ドキュメントが無効化された Unix タイムスタンプです。有効な場合は null です。
ドキュメントを無効化したユーザーの ID です。有効な場合は null です。
ドキュメントがアーカイブ済みかどうかです。
UI 向けの表示用インデックスステータスです。
このドキュメントが検索された回数です。
ドキュメントのチャンキングモードです。text_model は標準テキスト、hierarchical_model は親子構造、qa_model は QA ペアを示します。
ドキュメント内容の言語です。
ドキュメントタイプの分類です。未設定の場合は null です。
このドキュメントのカスタムメタデータキーバリューペア。
処理が完了した Unix タイムスタンプです。まだ完了していない場合は null です。
最終更新の Unix タイムスタンプです。更新されたことがない場合は null です。
インデックス作成にかかった時間(秒)です。未完了の場合は null です。
ドキュメント内のチャンク数です。
チャンクの平均文字長です。
要約インデックスのステータスです。要約インデックスが有効でない場合は null です。
このドキュメントが要約生成を必要とするかどうかです。