ドキュメント詳細を取得
1 つのドキュメントの詳細情報を返します。
curl --request GET \
--url https://{api_base_url}/datasets/{dataset_id}/documents/{document_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{api_base_url}/datasets/{dataset_id}/documents/{document_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{api_base_url}/datasets/{dataset_id}/documents/{document_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{api_base_url}/datasets/{dataset_id}/documents/{document_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{api_base_url}/datasets/{dataset_id}/documents/{document_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{api_base_url}/datasets/{dataset_id}/documents/{document_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_base_url}/datasets/{dataset_id}/documents/{document_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"archived": false,
"average_segment_length": 70,
"completed_at": 1741267260,
"created_at": 1741267200,
"created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
"created_from": "api",
"data_source_info": {
"upload_file": {
"created_at": 1741267200,
"created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
"extension": "txt",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"mime_type": "text/plain",
"name": "guide.txt",
"size": 2048
}
},
"data_source_type": "upload_file",
"dataset_process_rule": {
"id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
"mode": "custom"
},
"dataset_process_rule_id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
"disabled_at": null,
"disabled_by": null,
"display_status": "available",
"doc_form": "text_model",
"doc_language": "English",
"doc_metadata": [],
"doc_type": null,
"document_process_rule": {
"mode": "custom",
"rules": {
"pre_processing_rules": [],
"segmentation": {
"chunk_overlap": 50,
"max_tokens": 500,
"separator": "###"
}
}
},
"enabled": true,
"error": null,
"hit_count": 0,
"id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac",
"indexing_latency": 60,
"indexing_status": "completed",
"name": "guide.txt",
"need_summary": false,
"position": 1,
"segment_count": 5,
"summary_index_status": null,
"tokens": 512,
"updated_at": 1741267260
}Authorizations
すべてのリクエストは API キーで認証します:Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します(Dify API クイックスタート)。
キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401(unauthorized)で失敗します。
Path Parameters
ナレッジベース ID。ナレッジベースリストを取得 で取得します。スコープを限定したキーでは、Dify の URL から ID をコピー してください。
ドキュメント ID です。ナレッジベースのドキュメントリストを取得 から取得します。
Query Parameters
all はメタデータを含むすべてのフィールドを返します。only は id、doc_type、doc_metadata のみを返します。without は doc_type と doc_metadata を除くすべてのフィールドを返します。
all, only, without Response
ドキュメントの詳細です。返されるフィールドは metadata クエリパラメータによって異なります。
ドキュメントがアーカイブ済みかどうかです。
チャンクの平均文字長です。
処理が完了した Unix タイムスタンプです。まだ完了していない場合は null です。
ドキュメント作成の Unix タイムスタンプです。
ドキュメントを作成したユーザーの ID です。
ドキュメントの作成元です。API で作成した場合は api、UI で作成した場合は web です。
データソースの詳細です。ファイルアップロードの場合、この詳細エンドポイントは upload_file 配下に完全なファイルオブジェクトを返します(リストエンドポイントは upload_file_id のみを返します)。
Show child attributes
Show child attributes
ドキュメントのアップロード方法です。ファイルアップロードの場合は upload_file、Notion インポートの場合は notion_import です。
ナレッジベースレベルの処理ルール設定です。
このドキュメントに適用された処理ルールの ID です。
ドキュメントが無効化された Unix タイムスタンプです。有効な場合は null です。
ドキュメントを無効化したユーザーの ID です。有効な場合は null です。
UI 向けの表示用インデックスステータスです。
ドキュメントのチャンキングモードです。text_model は標準テキスト、hierarchical_model は親子構造、qa_model は QA ペアを示します。
ドキュメント内容の言語です。
このドキュメントのカスタムメタデータキーバリューペア。
Show child attributes
Show child attributes
ドキュメントタイプの分類です。未設定の場合は null です。
ドキュメントレベルの処理ルール設定です。
このドキュメントが検索に対して有効かどうかです。
インデックス作成が失敗した場合のエラーメッセージです。それ以外は null です。
このドキュメントが検索された回数です。
ドキュメント識別子です。
インデックス作成にかかった時間(秒)です。未完了の場合は null です。
現在のインデックスステータスです(例:waiting、parsing、cleaning、splitting、indexing、completed、error、paused)。
ドキュメント名です。
このドキュメントが要約生成を必要とするかどうかです。
ナレッジベース内の位置インデックスです。
ドキュメント内のチャンク数です。
要約インデックスのステータスです。要約インデックスが有効でない場合は null です。
ドキュメント内のトークン数です。
最終更新の Unix タイムスタンプです。更新されたことがない場合は null です。
Was this page helpful?
curl --request GET \
--url https://{api_base_url}/datasets/{dataset_id}/documents/{document_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{api_base_url}/datasets/{dataset_id}/documents/{document_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{api_base_url}/datasets/{dataset_id}/documents/{document_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{api_base_url}/datasets/{dataset_id}/documents/{document_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{api_base_url}/datasets/{dataset_id}/documents/{document_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{api_base_url}/datasets/{dataset_id}/documents/{document_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_base_url}/datasets/{dataset_id}/documents/{document_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"archived": false,
"average_segment_length": 70,
"completed_at": 1741267260,
"created_at": 1741267200,
"created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
"created_from": "api",
"data_source_info": {
"upload_file": {
"created_at": 1741267200,
"created_by": "ad313dd6-ef04-4dd1-a5b0-c0f0b9e2e7e4",
"extension": "txt",
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"mime_type": "text/plain",
"name": "guide.txt",
"size": 2048
}
},
"data_source_type": "upload_file",
"dataset_process_rule": {
"id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
"mode": "custom"
},
"dataset_process_rule_id": "e1f2a3b4-c5d6-7890-ef12-345678901234",
"disabled_at": null,
"disabled_by": null,
"display_status": "available",
"doc_form": "text_model",
"doc_language": "English",
"doc_metadata": [],
"doc_type": null,
"document_process_rule": {
"mode": "custom",
"rules": {
"pre_processing_rules": [],
"segmentation": {
"chunk_overlap": 50,
"max_tokens": 500,
"separator": "###"
}
}
},
"enabled": true,
"error": null,
"hit_count": 0,
"id": "a8e0e5b5-78c6-4130-a5ce-25feb0e0b4ac",
"indexing_latency": 60,
"indexing_status": "completed",
"name": "guide.txt",
"need_summary": false,
"position": 1,
"segment_count": 5,
"summary_index_status": null,
"tokens": 512,
"updated_at": 1741267260
}