调用Recommend获取指定实例的推荐结果_智能推荐 AIRec(AIRec)-阿里云帮助中心

该接口用于获取指定实例的推荐结果。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /v2/openapi/instances/{instanceId}/actions/recommend

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 ID	airec-test001
sceneId	string	否	物品被投放的场景 ID	test
userId	string	是	用户唯一 ID	123
ip	string	否	用户最后登录的 IP	192.168.1.1
imei	string	否	设备 ID	06e1565409c9fc4887036b974421****
returnCount	integer	是	返回结果条数（0-50 之间）	10
items	string	否	用于相关推荐的 item（限于相关推荐场景使用）	1001
serviceType	string	否	略	1
userInfo	string	否	略	1
rankOpen	boolean	否	召回排序阶段是否根据用户 ID 个性化排序	true
recType	string	否	推荐服务类型	gul
filter	string	否	推荐过滤字符串	eyJqb2luIjoiYW5kIiwiZmlsdGVycyI6W3siY29uZCI6ImNvbnRhaW4iLCJmaWVsZCI6InRhZ3MiLCJ2YWx1ZSI6IuWPjOS6uiJ9XX0.
strategy	string	否	如果需要使用坑位策略，请求参数内新增 strategy="fixedSlot"，此时系统将按照坑位配置返回推荐结果	fixedSlot

返回参数

名称	类型	描述	示例值
	object
result	object []	返回结果
matchInfo	string	不用关心，debug 时可能用到	xxx
traceId	string	回传日志时使用，回传日志时，trace_id=ali	ali
position	integer	物品在需要展示的位置，从 0 开始（注意：返回结果已经按照 position 排序，可以不用关注）	1
itemId	string	物品 ID	123
itemType	string	物品类型	item
traceInfo	string	返回结果里 traceInfo 的值（注意：每个 item 的值均不一样，回传日志时，需要传对应的）	"1007.62381.131491.100200300000000:bcb946ed-3f09-4e9b-bf4a-c19862f42231:792783::0:s101:::15:content___130788_stall:item:i2i_common_common:0.0205279946753756:null:null:1673258031504::context__recall_index=156,context__hour=17,context__trigger_num=2::C7EF99C9-6C55-5D45-A8D5-0754082E9DCF:hot_common,i2i_common_common,i2i_swing_common,hot_full:::::"
weight	float	权重	1
flowWeight	double	流控加权字段；=0 未加权；>0 加权；<0 降权	0
message	string	状态信息	Successful
code	string	状态码	200
requestId	string	请求 ID	04707E49-642A-4649-827A-F8EEB07D4C27
message	string	状态信息	"i2i_common_common;NotFound;1673254401;similar product/content of clicked ones;2023-01-09 16:53:21"

示例

正常返回示例

JSON格式

{
  "result": [
    {
      "matchInfo": "xxx",
      "traceId": "ali",
      "position": 1,
      "itemId": "123",
      "itemType": "item",
      "traceInfo": "\"1007.62381.131491.100200300000000:bcb946ed-3f09-4e9b-bf4a-c19862f42231:792783::0:s101:::15:content___130788_stall:item:i2i_common_common:0.0205279946753756:null:null:1673258031504::context__recall_index=156,context__hour=17,context__trigger_num=2::C7EF99C9-6C55-5D45-A8D5-0754082E9DCF:hot_common,i2i_common_common,i2i_swing_common,hot_full:::::\"",
      "weight": 1,
      "flowWeight": 0,
      "message": "Successful"
    }
  ],
  "code": "200",
  "requestId": "04707E49-642A-4649-827A-F8EEB07D4C27",
  "message": "\"i2i_common_common;NotFound;1673254401;similar product/content of clicked ones;2023-01-09 16:53:21\""
}

错误码

访问错误中心查看更多错误码。

Recommend - 智能推荐

调试

授权信息

请求语法

请求参数

返回参数

示例

错误码

变更历史