ListChunks - 获取文档块详情-云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

获取文档块详情

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。说明您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情，包括实例 ID。	gp-xxxxxxxxx
RegionId	string	是	地域 ID。	cn-hangzhou
Namespace	string	否	命名空间，默认为 public。说明您可以通过 CreateNamespace 接口创建命名空间，通过 ListNamespaces 接口查看列表。	mynamespace
NamespacePassword	string	是	命名空间对应的密码。说明本值为 CreateNamespace 接口指定。	testpassword
Collection	string	是	文档库名称。说明由 CreateDocumentCollection 接口创建。您可以调用 ListDocumentCollections 接口查看已经创建的文档库。	testcollection
FileName	string	否	文件名。说明上传过的文件名称，您可以通过 ListDocuments 接口查询文件列表。	mydoc.txt
Filter	string	否	要查询的数据的过滤条件，格式为 SQL 的 WHERE 格式。是一个返回布尔值（真或假）的表达式，条件可以是简单的比较运算符，如等于(=)、不等于(<>或!=)、大于(>), 小于(<)、大于等于(>=)、小于等于(<=)，也可以是逻辑运算符（AND, OR, NOT）组合的更复杂的表达式，以及使用 IN、BETWEEN、LIKE 等关键字的条件。说明详细语法可参考：https://www.postgresqltutorial.com/postgresql-tutorial/postgresql-where/	title = 'test' AND name like 'test%'
IncludeVector	boolean	否	是否返回向量。默认为 false。说明 false：不返回向量。 true：返回向量。	true
PageSize	integer	否	每页记录数，取值说明： 20 50 100 默认值：20。	20
PageNumber	integer	否	页码。	1

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad
PageNumber	integer	当前页码。	1
PageRecordCount	integer	当前页记录数。	20
TotalRecordCount	integer	总记录数。	30
Chunks	object
chunks	array<object>	文档块列表
	array<object>
Id	string	向量数据的唯一 Id。	doc_1234
Content	string	文本内容。	云原生数据仓库AnalyticDB PostgreSQL版提供简单、快速、经济高效的PB级云端数据仓库解决方案。
Vector	object
vector	array	向量数据列表。
	number	向量数据。	[1.2123,-0.12314,...]
Metadata	object	元数据。
	any	向量数据的元信息，为 MAP 格式的 JSON 字符串。其中 key 代表字段名，value 代表数据类型。	{"title":"test"}
LoaderMetadata	string	文档加载器加载时的元信息。	{"page_index":0}
FileName	string	文件名。	mydoc.txt
PageIndex	integer	文件内所在页码。	1

示例

正常返回示例

JSON格式

{
  "RequestId": "34b32a0a-08ef-4a87-b6be-cdd9f56fc3ad",
  "PageNumber": 1,
  "PageRecordCount": 20,
  "TotalRecordCount": 30,
  "Chunks": {
    "chunks": [
      {
        "Id": "doc_1234",
        "Content": "云原生数据仓库AnalyticDB PostgreSQL版提供简单、快速、经济高效的PB级云端数据仓库解决方案。",
        "Vector": {
          "vector": [
            0
          ]
        },
        "Metadata": {
          "key": "{\"title\":\"test\"}"
        },
        "LoaderMetadata": "{\"page_index\":0}",
        "FileName": "mydoc.txt\n",
        "PageIndex": 1
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。