找不到 API ? 点击 反馈吧
- 应用数据
- 知识库
- Prompt工程
- 长期记忆
ListFile分页
获取指定类目下一个或多个文档的详细信息
服务地址:
华东2 金融云
参数配置
高级配置
输入参数
只看必填
注意事项
WorkspaceId类目所属的业务空间 ID
CategoryId类目 ID
FileName文件名称(不含后缀)
分页参数
NextToken查询凭证(Token)
MaxResults分页查询时每页行数
文档
调用结果
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:ListFile 权限点),然后才能调用本接口,详见为 RAM 用户授予数据权限。阿里云账号(主账号)可直接调用无须授权。建议您通过最新版百炼 SDK来调用本接口。 -
分页查询首页时,仅需设置
MaxResults
以限制返回信息的条目数,返回结果中的NextToken
将作为查询后续页的凭证。查询后续页时,将NextToken
参数设置为上一次返回结果中获取到的NextToken
作为查询凭证(如果NextToken
为空,表示结果已经完全返回,不需要再请求),并设置MaxResults
限制返回条目数。 -
本接口具有幂等性。
限流说明: 本接口频繁调用会被限流,频率请勿超过 5 次/秒。如遇限流,请稍后重试。
请求语法
GET /{WorkspaceId}/datacenter/files HTTP/1.1
路径参数
字段名称 | 字段详情 |
---|---|
WorkspaceIdstring | 类目所属的业务空间 ID。获取方式请参见如何使用业务空间。 示例值:llm-3shx2gu255oqxxxx
|
请求参数
字段名称 | 字段详情 |
---|---|
CategoryIdstring | 类目 ID,即 AddCategory 接口返回的 示例值:cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx |
NextTokenstring | 查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。 示例值:AAAAAdH70eOCSCKtacdomNzak4U= |
MaxResultsinteger<int32> | 分页查询时每页行数。取值范围[1-200]。展开详情 示例值:20 |
FileNamestring | 文件名称(不含后缀),仅支持按照文件名精准查找,不支持模糊搜索。 示例值:测试文件名参考取值来源: DescribeFile |
返回参数
字段名称 | 字段详情 |
---|---|
Codestring | 错误状态码。 示例值:success |
Dataobject | 接口业务数据字段。 |
Messagestring | 错误信息。 示例值:Requests throttling triggered. |
RequestIdstring | 请求 ID。 示例值:8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1 |
Statusstring | 接口返回的状态码。 示例值:200 |
Successboolean | 接口调用是否成功,可能值为:展开详情 示例值:true |
变更历史
暂无变更历史