跳转到主要内容
GET
/
datasets
/
{dataset_id}
/
documents
/
{document_id}
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "position": 123,
  "data_source_type": "<string>",
  "data_source_info": {},
  "dataset_process_rule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "created_from": "<string>",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": 123,
  "tokens": 123,
  "indexing_status": "<string>",
  "error": "<string>",
  "enabled": true,
  "disabled_at": 123,
  "disabled_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "archived": true,
  "display_status": "<string>",
  "word_count": 123,
  "hit_count": 123,
  "doc_form": "<string>",
  "dataset_process_rule": {
    "mode": "automatic",
    "rules": {
      "pre_processing_rules": [
        {
          "id": "remove_extra_spaces",
          "enabled": true
        }
      ],
      "segmentation": {
        "separator": "<string>",
        "max_tokens": 123
      },
      "parent_mode": "full-doc",
      "subchunk_segmentation": {
        "separator": "<string>",
        "max_tokens": 123,
        "chunk_overlap": 123
      }
    }
  },
  "document_process_rule": {
    "mode": "automatic",
    "rules": {
      "pre_processing_rules": [
        {
          "id": "remove_extra_spaces",
          "enabled": true
        }
      ],
      "segmentation": {
        "separator": "<string>",
        "max_tokens": 123
      },
      "parent_mode": "full-doc",
      "subchunk_segmentation": {
        "separator": "<string>",
        "max_tokens": 123,
        "chunk_overlap": 123
      }
    },
    "id": "<string>",
    "dataset_id": "<string>"
  },
  "indexing_latency": 123,
  "segment_count": 123,
  "average_segment_length": 123,
  "doc_language": "<string>"
}

Authorizations

Authorization
string
header
required

API-Key 鉴权。所有 API 请求都应在 Authorization HTTP Header 中包含你的 API-Key,格式为 Bearer {API_KEY}强烈建议开发者把 API-Key 放在后端存储,而非分享或者放在客户端存储,以免 API-Key 泄露,导致财产损失。

Path Parameters

dataset_id
string<uuid>
required

知识库的 ID。

document_id
string<uuid>
required

文档的 ID。

Query Parameters

metadata
enum<string>
default:all

元数据过滤器:all 返回所有元数据,only 仅返回自定义元数据,without 不返回元数据。

可用选项:
all,
only,
without

Response

200 - application/json

关于文档的详细信息。

id
string<uuid>
position
integer
data_source_type
string
data_source_info
object | null
dataset_process_rule_id
string<uuid> | null
name
string
created_from
string
created_by
string<uuid>
created_at
integer
tokens
integer
indexing_status
string
error
string | null
enabled
boolean
disabled_at
integer | null
disabled_by
string<uuid> | null
archived
boolean
display_status
string
word_count
integer
hit_count
integer
doc_form
string
dataset_process_rule
object

用于处理文档的规则集,包括清理和分割。

document_process_rule
object

用于处理文档的规则集,包括清理和分割。

indexing_latency
number | null
segment_count
integer
average_segment_length
integer
doc_language
string | null