注意:以下文档只适用于TOP接口,请谨慎使用!

文档中心 > API类目 > 三方AI项目

taobao.top.rag.knowledge.list (AI-RAG 查询知识库)

查询知识库

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
name String 可选 CRM 知识库 知识库名称
id Number 可选 123456 知识库 ID
page_no Number 必须 1 页码。正整数,默认值为1。当深翻时(page_no*page_size>1万),为了性能考虑,部分接口将报错。请尽可能细化搜索,如:根据时间分段
page_size Number 必须 20 每页获取条数。正整数,默认值10,最大值100。

响应参数

名称 类型 示例值 描述
result Result result
  • └ success
  • Boolean
  • true
  • 是否成功
  • └ code
  • Number
  • 401
  • 错误编码
  • └ error_msg
  • String
  • 授权异常
  • 错误信息
  • ai_paas_knowledge_biz_d_t_o_base_page_result
  • BasePageResult
  • 响应结果
  • ai_paas_knowledge_biz_d_t_o_list
  • AiPaasKnowledgeBizDto []
  • List<String>
  • 结果集合 List
  • └ id
  • Number
  • 1
  • 知识库主键
  • └ gmt_create
  • Date
  • 2024-12-25 20:13:29
  • 创建时间
  • └ gmt_modified
  • Date
  • 2024-12-25 20:13:29
  • 修改时间
  • └ name
  • String
  • CRM 知识库
  • 知识库名称
  • └ description
  • String
  • CRM 知识库
  • 知识库描述
  • └ icon
  • String
  • www.icon.com
  • 知识库图标
  • └ unit_count
  • Number
  • 5
  • 知识库下知识单元数量
  • └ knowledge_size
  • Number
  • 5
  • 知识库大小
  • └ scenes
  • String
  • 客服场景
  • 知识库场景
  • └ total_page
  • Number
  • 10
  • 总页数
  • └ total_count
  • Number
  • 100
  • 总数

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TopRagKnowledgeListRequest req = new TopRagKnowledgeListRequest();
req.setName("CRM 知识库");
req.setId(123456L);
req.setPageNo(1L);
req.setPageSize(20L);
TopRagKnowledgeListResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<top_rag_knowledge_list_response>
    <result>
        <success>true</success>
        <code>401</code>
        <error_msg>授权异常</error_msg>
        <ai_paas_knowledge_biz_d_t_o_base_page_result>
            <ai_paas_knowledge_biz_d_t_o_list>
                <ai_paas_knowledge_biz_dto>
                    <id>1</id>
                    <gmt_create>2024-12-25 20:13:29</gmt_create>
                    <gmt_modified>2024-12-25 20:13:29</gmt_modified>
                    <name>CRM 知识库</name>
                    <description>CRM 知识库</description>
                    <icon>www.icon.com</icon>
                    <unit_count>5</unit_count>
                    <knowledge_size>5</knowledge_size>
                    <scenes>客服场景</scenes>
                </ai_paas_knowledge_biz_dto>
            </ai_paas_knowledge_biz_d_t_o_list>
            <total_page>10</total_page>
            <total_count>100</total_count>
        </ai_paas_knowledge_biz_d_t_o_base_page_result>
    </result>
</top_rag_knowledge_list_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部