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

简介: 通过调用该接口,开发者可查询租户内知识库列表,支持分页参数配置,需提供有效授权令牌。返回信息包含知识库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 条的限制。
  • 解决方案:请修改后,重试。


相关文章
|
7月前
|
存储 API 开发者
百宝箱开放平台 ✖️ 查询知识库文件列表
通过调用该接口,开发者可查询指定知识库中的文件列表,支持分页参数设置,需提供Authorization令牌及知识库ID,返回文件信息包括名称、大小等,并附带错误码说明。
255 4
|
7月前
|
API 开发者
百宝箱开放平台 ✖️ 查询知识库文件的构建状态
本接口用于查询目标文件在知识库中的构建状态,需提供documentId并配置有效token。支持查看初始化、处理中、成功、失败等状态,并返回详细错误信息以便排查问题。
395 4
|
7月前
|
JSON API 开发工具
百宝箱开放平台 ✖️ 添加知识库文件
本接口用于将已上传的文件添加至指定知识库。调用前需通过文件上传接口获取fileId,并确保token有效。请求需包含datasetId和fileId,支持txt、pdf、md等格式,单文件不超过20M,最多2万行数据。
349 4
|
7月前
|
JSON API 开发者
百宝箱开放平台 ✖️ 发起知识库召回
开发者可通过调用该接口发起知识库召回,从海量数据中快速检索与查询相关的知识条目。需提供query、datasetId等参数,支持设置返回条数,默认5条,上限10条。
326 3
|
7月前
|
JSON API 数据格式
百宝箱开放平台 ✖️ 删除知识库文件
本接口用于删除知识库中指定文件,调用前需解除文件与智能体应用的关联。通过DELETE请求发送documentId参数,并在请求头中携带Authorization令牌完成身份验证。
226 3
|
7月前
|
JSON API 数据格式
百宝箱开放平台 ✖️ 删除知识库
调用该接口可删除指定知识库,需提前解除其与智能体应用的关联。请求方式为DELETE,需提供Authorization令牌和datasetId参数,成功返回errorCode为0,否则根据错误码排查问题。
265 2
【YashanDB知识库】手工迁移Doris数据到崖山分布式
【YashanDB知识库】手工迁移Doris数据到崖山分布式
|
存储 人工智能 搜索推荐
WiseMindAI:一款AI智能知识库,数据完全本地化,支持文档对话、10+种文档、10+AI大模型等
WiseMindAI 是一款由 Chris 开发的 AI 智能学习助手,支持数据完全本地化存储,确保用户隐私安全。它兼容多种文档格式(如 PDF、Markdown 等),并提供 AI 文档总结、智能笔记、沉浸式翻译、知识卡片生成等功能。此外,WiseMindAI 支持 10+ 大语言模型和自定义 AI 插件,适用于 Windows 和 Mac 平台,支持简体中文、繁体中文及英文。
1423 74
WiseMindAI:一款AI智能知识库,数据完全本地化,支持文档对话、10+种文档、10+AI大模型等
|
Java 数据库连接
【YashanDB知识库】使用DBeaver 插入数据 nvarchar字段插入为空
【YashanDB知识库】使用DBeaver 插入数据 nvarchar字段插入为空
【YashanDB知识库】使用DBeaver 插入数据 nvarchar字段插入为空
|
Oracle 关系型数据库 Java
【YashanDB知识库】Flink CDC实时同步Oracle数据到崖山
本文介绍通过Flink CDC实现Oracle数据实时同步至崖山数据库(YashanDB)的方法,支持全量与增量同步,并涵盖新增、修改和删除的DML操作。内容包括环境准备(如JDK、Flink版本等)、Oracle日志归档启用、用户权限配置、增量日志记录设置、元数据迁移、Flink安装与配置、生成Flink SQL文件、Streampark部署,以及创建和启动实时同步任务的具体步骤。适合需要跨数据库实时同步方案的技术人员参考。
【YashanDB知识库】Flink CDC实时同步Oracle数据到崖山

热门文章

最新文章