ListChunks_大模型服务平台百炼_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • RAM 用户(子账号)需要首先获取百炼的数据权限(需要AliyunBailianDataFullAccess,已包括 sfm:ChunkList 权限点),然后才能调用本接口,详见为 RAM 用户授予数据权限。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版百炼 SDK来调用本接口。
  • 调用本接口前,请确保您的知识库已经创建完成且未被删除(即知识库 IDIndexId有效)。
  • 本接口具有幂等性。

限流说明: 本接口频繁调用会被限流,频率请勿超过 10 次/秒。如遇限流,请稍后重试。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
sfm:ChunkList
List
全部资源
*

请求语法

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

返回示例

变更历史

变更时间变更内容概要操作
2024-12-12
变更请求参数body
2024-09-25
变更请求参数body

相关示例