检索分段列表

搜索指定知识文档中段列表的详细信息。

Path Parameters

dataset_id string required

知识库ID。

document_id string required

知识ID。

application/json

Request Body required

dataset_id string

知识库ID。

document_id string

知识ID。

keyword string

支持关键词搜索

page_token string

当前页的起始值。

page_size int32

此请求的页面大小。

order_by string

排序关键字，如：create_time desc。

Responses

• 200
• default

---

OK

application/json

Schema

Example (from schema)

---

Schema

segments object[]
段列表
Array [
segment_id string
段ID
dataset_id string
知识库ID
document_id string
知识ID
content string
段内容
token_count int32
令牌数量
number int32
段编号
metadata object
元数据
key_words string[]
关键词
image_name_value string
图片名称
image_size int32
图片大小
table_name_value string
表格名称
table_rows int32
表格行数
table_columns string[]
表格列
score float
分数
words int32
单词数量
segment_type enum
段落类型
table_content string
表格内容
image_key string
图片键值
image_uri string
图片URI
display_type enum
显示类型
image_keys string
图片键值列表
display_content string
展示内容
]
total_size int32

总数

next_page_token string

用于分页的下一页令牌字段。

{
  "segments": [
    {
      "segment_id": "string",
      "dataset_id": "string",
      "document_id": "string",
      "content": "string",
      "token_count": 0,
      "number": 0,
      "metadata": {
        "key_words": [
          "string"
        ],
        "image_name_value": "string",
        "image_size": 0,
        "table_name_value": "string",
        "table_rows": 0,
        "table_columns": [
          "string"
        ],
        "score": 0
      },
      "words": 0,
      "segment_type": 0,
      "table_content": "string",
      "image_key": "string",
      "image_uri": "string",
      "display_type": 0,
      "image_keys": "string",
      "display_content": "string"
    }
  ],
  "total_size": 0,
  "next_page_token": "string"
}

Default error response

application/json

Schema

Example (from schema)

---

Schema

code int32

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

message string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

details object[]
A list of messages that carry the error details. There is a common set of message types for APIs to use.
Array [
@type string
The type of the serialized message.
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...