蚂蚁开放平台 ✖️ 查询知识库列表

简介: 通过调用该接口,开发者可查询租户内知识库列表,支持分页参数配置,需提供有效授权令牌。返回信息包含知识库ID、名称、描述及存储大小等。

通过调用本接口,开发者可以查询租户内知识库列表。

请求地址

GEThttps://api.tbox.cn/api/datasets/queryDatasetsList

请求头

参数名

必填

类型

说明

示例

Authorization

String

用于验证客户端身份的访问令牌,你可以在百宝箱中获取,获取方式可参见:授权管理

pat_2j4e******THUIVRH1

Content-Type


text/plain

解释请求正文的方式。

-

请求参数

参数名

必填

类型

说明

示例

pageNum

Integer

分页页码,默认为 1,从第一页数据开始返回。

1

pageSize

Integer

分页大小,默认为 10,最大为 50。

10

请求示例

curl  --location --request GET 'https://api.tbox.cn/api/datasets/queryDatasetsList?pageNum=1&pageSize=20' \
--header 'Authorization: {your_token}' \
--header 'Content-Type: text/plain'

返回参数

参数名

类型

说明

示例

errorCode

String

错误码,为 0 表示成功。

0

errorMsg

String

错误信息。

success

data

PageObject

知识库列表信息,详细说明请参见:data 定义

-

traceId

String

本次请求的唯一标识,通常用于发生错误时的排查定位。

0b****4d9

其中,errorCode 与 errorMsg 的对照关系以及对应的解决方案,请参见下方错误码。  

data 定义

参数名

类型

说明

currentPage

Integer

当前页

datasets

List<Dataset>

知识库文件对象列表,详细说明请参见:datasets 定义

pageSize

Integer

分页大小

total

Integer

列表总数

datasets 定义

参数名

类型

说明

datasetId

String

知识库 ID

description

String

知识库描述

name

String

知识库名称

storeSize

Double

知识库存储大小

返回示例

{
    "data": {
        "currentPage": 1,
        "datasets": [
            {
                "datasetId": "202508059lUk00458063",
                "description": "测试2",
                "name": "测试1",
                "storeSize": 0.0
            },
            {
                "datasetId": "20250804tpAo00457894",
                "description": "测试2",
                "name": "测试2",
                "storeSize": 7808.0
            }
        ],
        "pageSize": 20,
        "total": 2
    },
    "errorCode": "0",
    "errorMsg": "success",
    "traceId": "0b446a1717543635033032613e386f"
}


{
    "errorCode": "P_1_00_005",
    "errorMsg": "pageSize不能大于50",
    "solution": "请确认参数值是否正确!",
    "traceId": "0be8c63017543648690345786e1a1c"
}

错误码

公共错误码

errorCode

errorMsg

说明

S40000

系统异常

  • 原因:系统出现错误。
  • 解决方案:请稍后重试,若持续报错,请点击此处与我们取得联系,并将错误码与 traceId 一同反馈,帮助我们快速定位问题。

P_1_10_183

授权令牌无效

  • 原因:token 不正确。
  • 解决方案:请校验是否输入了有效令牌或配置新令牌。

P_1_10_184

授权令牌已失效

  • 原因:当前 token 已过期。
  • 解决方案:请前往百宝箱开放平台申请新令牌并更新到调用配置中。

P_1_10_185

未检测到授权令牌

  • 原因:未填写 token 信息。
  • 解决方案:请参考授权管理完成授权令牌的申请和配置。

P_1_13_682

非法访问,请联系平台

  • 原因:系统检测到异常活动。
  • 解决方案:请稍后重试,若持续报错,请点击此处与我们取得联系,并将错误码与 traceId 一同反馈,帮助我们快速定位问题。

参数校验与业务错误码

errorCode

errorMsg

说明

P_1_00_005

pageSize不能大于50

  • 原因:分页大小超出最大 50 条的限制。
  • 解决方案:请修改后,重试。


相关文章
|
2月前
|
存储 API 开发者
百宝箱开放平台 ✖️ 查询知识库文件列表
通过调用该接口,开发者可查询指定知识库中的文件列表,支持分页参数设置,需提供Authorization令牌及知识库ID,返回文件信息包括名称、大小等,并附带错误码说明。
120 4
|
2月前
|
API 开发者
百宝箱开放平台 ✖️ 查询知识库文件的构建状态
本接口用于查询目标文件在知识库中的构建状态,需提供documentId并配置有效token。支持查看初始化、处理中、成功、失败等状态,并返回详细错误信息以便排查问题。
112 4
|
2月前
|
JSON API 开发工具
百宝箱开放平台 ✖️ 添加知识库文件
本接口用于将已上传的文件添加至指定知识库。调用前需通过文件上传接口获取fileId,并确保token有效。请求需包含datasetId和fileId,支持txt、pdf、md等格式,单文件不超过20M,最多2万行数据。
158 4
|
2月前
|
JSON API 开发者
百宝箱开放平台 ✖️ 发起知识库召回
开发者可通过调用该接口发起知识库召回,从海量数据中快速检索与查询相关的知识条目。需提供query、datasetId等参数,支持设置返回条数,默认5条,上限10条。
136 3
|
2月前
|
JSON API 数据格式
百宝箱开放平台 ✖️ 删除知识库文件
本接口用于删除知识库中指定文件,调用前需解除文件与智能体应用的关联。通过DELETE请求发送documentId参数,并在请求头中携带Authorization令牌完成身份验证。
106 3
|
2月前
|
JSON API 数据格式
百宝箱开放平台 ✖️ 删除知识库
调用该接口可删除指定知识库,需提前解除其与智能体应用的关联。请求方式为DELETE,需提供Authorization令牌和datasetId参数,成功返回errorCode为0,否则根据错误码排查问题。
114 2
|
9月前
|
SQL 存储 关系型数据库
【YashanDB知识库】共享从 MySQL异常处理CONTINUE HANDLER的改写方法
【YashanDB知识库】共享从 MySQL异常处理CONTINUE HANDLER的改写方法
|
8月前
|
SQL 测试技术 数据库
【YashanDB知识库】IMP跨网络导入慢问题
问题现象:290M数据,本地导入2分钟,跨机导入耗时显著增加(最高30分钟)。 原因分析:`imp`逐条SQL通过网络传输至yashanDB执行,交互频繁导致性能下降。 影响版本:客户测试环境22.2.8.3。 解决方法:将导入文件上传至与yashanDB同机后使用`imp`,减少网络延迟。 经验总结:优化`imp`工具,支持直接上传文件至服务器端执行,降低网络依赖。
|
8月前
|
监控 数据库
【YashanDB 知识库】ycm 托管数据库时报错 OM host ip:127.0.0.1 is not support join to YCM
在托管数据库时,若 OM 的 IP 被设置为 127.0.0.1,将导致无法托管至 YCM,并使数据库失去监控。此问题源于安装时修改了 OM 的监听 IP。解决方法包括:将 OM 的 IP 修改为本机实际 IP 或 0.0.0.0,同时更新 env 文件及 yasom 后台数据库中的相关配置。经验总结指出,应避免非必要的后台 IP 修改,且数据库安装需遵循规范,不使用仅限本机访问的 IP(如 127.0.0.1)。
|
8月前
|
监控 网络安全 数据库
YashanDB 知识库:ycm 纳管主机安装 YCM-AGENT 时报错 “任务提交失败,无法连接主机”
在安装 ycm-agent 纳管主机时,可能出现因端口未开放导致的报错问题。此问题会阻止 YCM 对主机和数据库的监控功能,影响版本为 `yashandb-cloud-manager-23.2.1.100-linux-aarch64.tar`。原因是目标主机(如 10.149.223.121)未开放 9070 或 9071 端口。解决方法包括关闭防火墙、添加白名单或开放指定端口,需与管理员确认操作。处理过程涉及网络检查、端口测试等步骤。端口问题解决后,若再次安装报唯一键错误,需先移除失败主机再重试。

热门文章

最新文章