检索知识列表

搜索导入知识的列表，包括进行中、已完成和失败的知识。

Path Parameters

dataset_id string required

知识库ID。

application/json

Request Body required

dataset_id string

知识库ID。

p_id string

父知识的 ID。

dir_path string

知识的文件路径。

order_by string

排序关键字，如：create_time desc。

page_token string

当前页的起始值。

page_size int32

此请求的页面大小。

Responses

• 200
• default

---

OK

application/json

Schema

Example (from schema)

---

Schema

documents object[] required
知识列表
Array [
document_id string
知识ID
display_name string
知识名称
type enum
知识类型
document_size int64
知识大小
token_count int64
令牌计数
segment_count int64
段落计数
dataset_id string
知识库ID
dataset_display string
知识库名称
p_id string
父知识ID
data_source_type enum
数据源类型
creator string
知识创建者
create_time date-time
创建时间。
update_time date-time
更新时间
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
展示内容
]
uri string
文档在OSS中的预签名URI
]
total_size int32

知识总数

next_page_token string

用于分页的下一页标记字段

{
  "documents": [
    {
      "document_id": "string",
      "display_name": "string",
      "type": 0,
      "document_size": 0,
      "token_count": 0,
      "segment_count": 0,
      "dataset_id": "string",
      "dataset_display": "string",
      "p_id": "string",
      "data_source_type": 0,
      "creator": "string",
      "create_time": "2024-12-05T02:41:59.748Z",
      "update_time": "2024-12-05T02:41:59.748Z",
      "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"
        }
      ],
      "uri": "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...