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

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

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

查询知识 chunk

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
ids String 可选 1-2-3-0, 1-2-3-1 chunk ID 主键列表
knowledge_id Number 必须 7 知识库 ID
unit_id Number 必须 4 知识单元 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_doc_vector_biz_d_t_o_base_page_result
  • BasePageResult
  • 响应结果
  • ai_paas_knowledge_doc_vector_biz_d_t_o_list
  • AiPaasKnowledgeDocVectorBizDto []
  • List<String>
  • 结果集合 List
  • └ id
  • String
  • 1-2-3-0
  • 知识 chunk 主键
  • └ knowledge_id
  • Number
  • 1
  • 知识库主键
  • └ unit_id
  • String
  • 2
  • 知识库单元主键
  • └ unit_name
  • String
  • CRM 知识单元
  • 知识库单元名称
  • └ chunk_num
  • Number
  • 0
  • 知识 chunk 序号
  • └ chunk_content
  • String
  • 这是一篇 CRM 文档
  • 知识内容
  • └ labels
  • String []
  • Tag
  • chunk 标签
  • └ target_ids
  • String []
  • ["SKU_123","ITEM_333" ,"SHOP_222"]
  • 知识关联的商品 SKU或店铺信息
  • └ total_page
  • Number
  • 10
  • 总页数
  • └ total_count
  • Number
  • 100
  • 总数

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TopRagChunkListRequest req = new TopRagChunkListRequest();
req.setIds("1-2-3-0, 1-2-3-1");
req.setKnowledgeId(7L);
req.setUnitId(4L);
req.setPageNo(1L);
req.setPageSize(20L);
TopRagChunkListResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<top_rag_chunk_list_response>
    <result>
        <success>true</success>
        <code>401</code>
        <error_msg>授权异常</error_msg>
        <ai_paas_knowledge_doc_vector_biz_d_t_o_base_page_result>
            <ai_paas_knowledge_doc_vector_biz_d_t_o_list>
                <ai_paas_knowledge_doc_vector_biz_dto>
                    <id>1-2-3-0</id>
                    <knowledge_id>1</knowledge_id>
                    <unit_id>2</unit_id>
                    <unit_name>CRM 知识单元</unit_name>
                    <chunk_num>0</chunk_num>
                    <chunk_content>这是一篇 CRM 文档</chunk_content>
                    <labels>
                        <string>Tag</string>
                    </labels>
                    <target_ids>
                        <string>[&quot;SKU_123&quot;</string>
                        <string>&quot;ITEM_333&quot;</string>
                        <string>&quot;SHOP_222&quot;]</string>
                    </target_ids>
                </ai_paas_knowledge_doc_vector_biz_dto>
            </ai_paas_knowledge_doc_vector_biz_d_t_o_list>
            <total_page>10</total_page>
            <total_count>100</total_count>
        </ai_paas_knowledge_doc_vector_biz_d_t_o_base_page_result>
    </result>
</top_rag_chunk_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

返回
顶部