文档平台 API 中心 云推荐引擎 推荐服务请求 API

推荐服务请求 API

最近更新时间:2017-10-23 11:35:25

1. 接口描述

功能:获取推荐结果
测试接口: https://sdtj.y.qq.com:8008/test-query
正式接口: https://sdtj.y.qq.com:8008/query
请求方式:POST

2. 输入参数

参数名称 必选 类型 含义
seq_no String 请求标识,接口原样返回
token String 用作鉴权,由云推荐引擎分配
proj_id String 项目 ID。由 CRE 分配给客户
scn_id String 场景 ID。由 CRE 分配给客户
uid_type String "0" - QQ, "1" - 微信号, "2" - openid, "3" - IMEI/IDFA, "4" – 手机号,"5" - App 唯一用户
user_id String 用户 ID。标识请求中对应的用户。uid_type 指定类型的用户标识,QQ 号,微信号等等。若为空则当冷启动处理
pool_id String 推荐池子 ID。不填时默认为全局池子 ID "0"。多个池子以,分割,例如 "pool_id1,pool_id2,pool_id3"。当传入带排序物品列表(带 pool 字段)时忽略该字段
pool item_type String 物品 ID 类型。"0" - 整数,"1" - 字符串。当传入物品列表时必填
items Array 待排序物品列表,例如"["1", "2", "3"]"。此时忽略 pool_id
request_num String 指定排序后的物料返回个数,取 topN 。默认返回全部物料
geo latitude String 用户发生行为的经度,例如 "22.558220"
longitude String 用户发生行为的纬度,例如 "114.084778"
country String 用户发生行为的国家,ISO 3166-1 alpha-3 编码,例如 "CHN" (中国)
city String 用户发生行为的城市,例如"深圳"
extend key1 String 自定义字段 1
key2 String 自定义字段 2,业务自行扩充

3. 输出参数

参数名称 必选 类型 含义
seq_no String 请求序列号。请求接口原样返回该字段
code String 错误码,"0" 表示成功,非 "0" 表示失败
message String 错误信息
test_id String 推荐场景 ID,比如有"猜你喜欢"。例如 "1000190"
abtag String 策略 ID。通常一个推荐场景下会有多个算法 ID,用于算法迭代
trace_id String 跟踪串,系统自动分配的唯一标识单次推荐请求的 ID
rec id String 物品 ID。rec 为 JsonObject,每个元素是 key-value 对,key 为 pool_id ,value 为对当前池子(pool_id)打分后的物品列表
score String 物品分数

4. 示例

输入:

{
  "seq_no":"987654321",
  "token":"61f6b4db-e680-4765-941c-39ad004e12fd",
  "proj_id":"100001",
  "scn_id":"123456789",
  "uid_type":"2",
  "user_id":"000000000000000000000000401EEEC1",
  "pool_id":"11016775",
  "pool":{
    "item_type":"1",
    "items":["100", "101", "102"]
  },
  "request_num":"500",
 "geo":{
    "latitude":"22.558220",
    "longitude":"114.084778",
    "country":"CHN",
    "city":"深圳"
  },
  "extend":{
    "key1":"val1",
    "key2":"val2"
  }
}

输出:

{
  "code": "0",
  "message": null,
  "abtag": "123456789",
  "trace_id": "737213799686931157",
  "seq_no": "987654321",
  "test_id": "123456789",
  "rec": {
    "11016775": [
      {
        "id": "0",
        "score": "100"
      },
      {
        "id": "1",
        "score": "99"
      }
    ]
  }
}

如果有其他疑问,您也可以在问答社区中寻求帮助。前往问答社区 >