找不到 API ? 点击 反馈吧
- 应用数据
- 知识库
- Prompt工程
- 长期记忆
ListChunks分页
对于非结构化知识库,获取指定文档的所有切片的详细信息;对于结构化知识库,获取所有文本切片的详细信息
服务地址:
华东2 金融云
参数配置
高级配置
输入参数
只看必填
注意事项
WorkspaceId知识库所属的业务空间 ID
body请求参数的主体信息
FieldsFields是一个字段名数组
Filed本字段为百炼旧版SDK中的文档ID字段
FileId文档 ID
IndexId知识库 ID
PageNum指定要查询的页码
PageSize指定分页查询时每页展示的文本切片数量
文档
调用结果
SDK 示例
CLI示例
相关示例
调用历史
错误码
流控
插件下载了解更多
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
接口说明
- RAM 用户(子账号)需要首先获取百炼的数据权限(需要
AliyunBailianDataFullAccess
,已包括 sfm:ChunkList 权限点),然后才能调用本接口,详见为 RAM 用户授予数据权限。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版百炼 SDK来调用本接口。 - 调用本接口前,请确保您的知识库已经创建完成且未被删除(即知识库 ID
IndexId
有效)。 - 本接口具有幂等性。
限流说明: 本接口频繁调用会被限流,频率请勿超过 10 次/秒。如遇限流,请稍后重试。
请求语法
POST /{WorkspaceId}/index/list_chunks HTTP/1.1
路径参数
字段名称 | 字段详情 |
---|---|
WorkspaceIdstring | 知识库所属的业务空间 ID。获取方式请参见如何使用业务空间。 示例值:llm-3z7uw7fwz0vxxxx |
请求参数
字段名称 | 字段详情 |
---|---|
bodyobject | 请求参数的主体信息。 |
返回参数
字段名称 | 字段详情 |
---|---|
Codestring | 错误状态码。 示例值:Index.InvalidParameter |
Dataobject | 接口返回的业务字段。 |
Messagestring | 错误信息。 示例值:Required parameter(%s) missing or invalid, please check the request parameters. |
RequestIdstring | 请求 ID。 示例值:8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1 |
Statusstring | 接口返回的状态码。 示例值:200 |
Successboolean | 接口调用是否成功,可能值:展开详情 示例值:true |
变更历史
暂无变更历史