跳转到主要内容
GET
/
datasets
/
{dataset_id}
/
documents
/
{document_id}
/
segments
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "position": 123,
      "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "content": "<string>",
      "answer": "<string>",
      "word_count": 123,
      "tokens": 123,
      "keywords": [
        "<string>"
      ],
      "index_node_id": "<string>",
      "index_node_hash": "<string>",
      "hit_count": 123,
      "enabled": true,
      "disabled_at": 123,
      "disabled_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "<string>",
      "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": 123,
      "indexing_at": 123,
      "completed_at": 123,
      "error": "<string>",
      "stopped_at": 123
    }
  ],
  "doc_form": "<string>",
  "has_more": true,
  "limit": 123,
  "total": 123,
  "page": 123
}

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

keyword
string

按内容过滤段落的关键词。

status
string

按索引状态过滤段落。

Example:

"completed"

page
integer
default:1

分页的页码。

limit
integer
default:20

每页返回的项目数。

Required range: 1 <= x <= 100

Response

200 - application/json

段落的分页列表。

data
object[]
doc_form
string
has_more
boolean
limit
integer
total
integer
page
integer