阿里大于 -

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	描述
knowledge_id_list	Number	必须	[1, 2, 3]	知识库 ID List
query	String	必须	XX商品怎么用？	查询语句
top_n	Number	可选	5	返回 topN 个数
search_type_list	Number	可选	[1,2]	搜索类型, 1.向量查询 Doc 2.向量查询 QA 3. 根据 target_ids 精确匹配全量召回
search_ids	String	可选	ITEM_XXX,ITEM_YYY	标签字符串，多值使用','分割,为 and 关系
tags	String	可选	[{"tagCode":"标签Code","cateName":"标签类目"},{"tagCode":"shop","cateName":"makeup"}]	JSON 序列化数组
page_index	Number	可选	1	searchType 传 [3] ，精确全量召回时使用
page_size	Number	可选	10	searchType 传 [3] ，精确全量召回时使用

名称	类型	示例值	描述
result	Result		result
└ success Boolean true 是否成功 └ code Number 401 错误编码 └ error_msg String 授权异常错误信息 ai_paas_knowledge_doc_vector_biz_d_t_o_list AiPaasKnowledgeDocVectorBizDto [] 响应结果 └ 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或店铺信息，枚举类型_ID ，ID 在类型中唯一。目前支持SKU,ITEM,SH0P,SELFDEF(自定义类型)几种类型，举例：SKU123,ITEM333,SH0P_222 SELFDEF_111

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TopRagChunkSearchRequest req = new TopRagChunkSearchRequest();
req.setKnowledgeIdList([1, 2, 3]L);
req.setQuery("XX商品怎么用？");
req.setTopN(5L);
req.setSearchTypeList([1,2]L);
req.setSearchIds("ITEM_XXX,ITEM_YYY");
req.setTags("[{\"tagCode\":\"标签Code\",\"cateName\":\"标签类目\"},{\"tagCode\":\"shop\",\"cateName\":\"makeup\"}]");
req.setPageIndex(1L);
req.setPageSize(10L);
TopRagChunkSearchResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TopRagChunkSearchRequest req = new TopRagChunkSearchRequest();
req.KnowledgeIdList = [1, 2, 3]L;
req.Query = "XX商品怎么用？";
req.TopN = 5L;
req.SearchTypeList = [1,2]L;
req.SearchIds = "ITEM_XXX,ITEM_YYY";
req.Tags = "[{\"tagCode\":\"标签Code\",\"cateName\":\"标签类目\"},{\"tagCode\":\"shop\",\"cateName\":\"makeup\"}]";
req.PageIndex = 1L;
req.PageSize = 10L;
TopRagChunkSearchResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TopRagChunkSearchRequest;
$req->setKnowledgeIdList("[1, 2, 3]");
$req->setQuery("XX商品怎么用？");
$req->setTopN("5");
$req->setSearchTypeList("[1,2]");
$req->setSearchIds("ITEM_XXX,ITEM_YYY");
$req->setTags("[{\"tagCode\":\"标签Code\",\"cateName\":\"标签类目\"},{\"tagCode\":\"shop\",\"cateName\":\"makeup\"}]");
$req->setPageIndex("1");
$req->setPageSize("10");
$resp = $c->execute($req, $sessionKey);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=taobao.top.rag.chunk.search' \
-d 'partner_id=apidoc' \
-d 'session=ef7566a8-3fc0-41b8-a9cd-516f67703a1d' \
-d 'sign=EAA0ECB5B792510B1C8DFF2D6769944F' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-18+02%3A37%3A18' \
-d 'v=2.0' \
-d 'knowledge_id_list=1%2C+2%2C+3' \
-d 'page_index=1' \
-d 'page_size=10' \
-d 'query=XX%E5%95%86%E5%93%81%E6%80%8E%E4%B9%88%E7%94%A8%EF%BC%9F' \
-d 'search_ids=ITEM_XXX%2CITEM_YYY' \
-d 'search_type_list=1%2C2' \
-d 'tags=%7B%22tagCode%22%3A%22%E6%A0%87%E7%AD%BECode%22%2C%22cateName%22%3A%22%E6%A0%87%E7%AD%BE%E7%B1%BB%E7%9B%AE%22%7D%2C%7B%22tagCode%22%3A%22shop%22%2C%22cateName%22%3A%22makeup%22%7D' \
-d 'top_n=5'

# -*- coding: utf-8 -*-
import top.api

req=top.api.TopRagChunkSearchRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.knowledge_id_list=[1, 2, 3]
req.query="XX商品怎么用？"
req.top_n=5
req.search_type_list=[1,2]
req.search_ids="ITEM_XXX,ITEM_YYY"
req.tags="[{\"tagCode\":\"标签Code\",\"cateName\":\"标签类目\"},{\"tagCode\":\"shop\",\"cateName\":\"makeup\"}]"
req.page_index=1
req.page_size=10
try:
	resp= req.getResponse(sessionkey)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"taobao.top.rag.chunk.search");
add_param(pRequest,"knowledge_id_list","1, 2, 3");
add_param(pRequest,"query","XX商品怎么用？");
add_param(pRequest,"top_n","5");
add_param(pRequest,"search_type_list","1,2");
add_param(pRequest,"search_ids","ITEM_XXX,ITEM_YYY");
add_param(pRequest,"tags","{"tagCode":"标签Code","cateName":"标签类目"},{"tagCode":"shop","cateName":"makeup"}");
add_param(pRequest,"page_index","1");
add_param(pRequest,"page_size","10");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('taobao.top.rag.chunk.search', {
	'knowledge_id_list':'1, 2, 3',
	'query':'XX商品怎么用？',
	'top_n':'5',
	'search_type_list':'1,2',
	'search_ids':'ITEM_XXX,ITEM_YYY',
	'tags':'{"tagCode":"标签Code","cateName":"标签类目"},{"tagCode":"shop","cateName":"makeup"}',
	'page_index':'1',
	'page_size':'10'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<top_rag_chunk_search_response>
    <result>
        <success>true</success>
        <code>401</code>
        <error_msg>授权异常</error_msg>
        <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>SKU_123</string>
                    <string>ITEM_333</string>
                    <string>SHOP_222</string>
                </target_ids>
            </ai_paas_knowledge_doc_vector_biz_dto>
        </ai_paas_knowledge_doc_vector_biz_d_t_o_list>
    </result>
</top_rag_chunk_search_response>

{
    "top_rag_chunk_search_response":{
        "result":{
            "success":true,
            "code":401,
            "error_msg":"授权异常",
            "ai_paas_knowledge_doc_vector_biz_d_t_o_list":{
                "ai_paas_knowledge_doc_vector_biz_dto":[
                    {
                        "id":"1-2-3-0",
                        "knowledge_id":1,
                        "unit_id":"2",
                        "unit_name":"CRM 知识单元",
                        "chunk_num":0,
                        "chunk_content":"这是一篇 CRM 文档",
                        "labels":{
                            "string":[
                                "Tag"
                            ]
                        },
                        "target_ids":{
                            "string":[
                                "SKU_123",
                                "ITEM_333",
                                "SHOP_222"
                            ]
                        }
                    }
                ]
            }
        }
    }
}

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>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

三方AI项目

taobao.top.rag.chunk.search (AI-RAG 知识检索)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ