用户在搜索“贺卡在线制作”、“h5 邀请函”等泛需求,“新年贺卡”、“生日贺卡”等精准需求时,搜索结果页会展现贺卡制作卡片。用户可在结果页横滑查看五张单一场景下的贺卡模板图片,并点击图文结构体跳转至贺卡制作页;或点击卡片标题、tag 跳转至资源方落地页查看更多类型的贺卡模板。
示意图
intent 上传接口
当前资源 intent 意图参数
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
card_type | string | 贺卡/邀请函类型 | 必选,资源所覆盖的贺卡/邀请函适用的场景名称,如:“生日”、“节日”、“中秋”“新年”等 |
通过平台上传 txt 文件
资源方需要将自己落地页数据能够覆盖的所有 intent 参数通过 txt 文件上传到平台上,txt 文件的具体要求参见接入流程-上传 Intent 数据。
当前资源分类 txt 上传文件内容示例如下:
1 | {"card_type":"新年"} |
注意:为了能够召回“贺卡制作”一类未指定场景的泛需求 query,必须上传一个空的 intent,此时资源方上传的数据为默认的热门场景贺卡模板。
通过开放 API 上传
详细接入方式参见API 上传方式
Webhook API
发送给 webhook 的请求
公共字段
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
type | string | 请求类型 | 在小程序阿拉丁下永远为 “sp_ala” |
surface | string | 搜索场景 | mobile: 支持小程序的移动搜索,web_h5: 支持 H5 的移动搜索 |
srcid | string | 资源编号 | 每个资源分类不同 |
intent | object | 搜索意图参数 | JSON 对象,每个资源分类不同 |
query_info.query_type | string | 用户Query中指定的搜索意图 | “手抄报”/“贺卡”,可能为空 |
当前资源 srcid 资源编号
key | 类型 | 含义 | 设定 |
---|---|---|---|
srcid | string | 资源编号 | 48054 |
当前资源的 intent 参数参考上节 “intent 上传接口“。
举例:发送给 webhook 的 JSON (解密后)
1 | { |
从 webhook 返回的结果
外层通用数据字段
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
status | integer | 结果状态码,0 代表正确,1 代表无结果, 2 代表请求参数错误,3 代表内部服务错误 |
0 |
msg | string | 出错消息,当非 0 时提供 | “” |
data | object | 要返回的资源数据内容 | JSON 对象,每个资源分类不同 |
当前资源分类的 data
object 字段内容
key | 类型 | 要求 | 说明 |
---|---|---|---|
adjective | string | 必选 | 类目名称,如:贺卡制作 |
jump_url | string | 必选 | 点击卡片标题的跳转链接地址,跳转至能够提供该工具服务的落地页,落地页内容必须与结果页卡片保持高度一致,不得有与所提供的工具服务无关的信息。该字段需返回 H5 或智能小程序页面路径,如果收到的 surface 请求是 mobile,请返回小程序路径,如果收到的 surface 请求是 web_h5,请返回 H5 路径,例如:“/page/of/target”(以/开头,不含域名),若跳转至 H5 或智能小程序首页(无路径),则需要返回“/?from=baidu”。 |
group_title | string | 可选 | 组卡标题 |
tag | array | 可选 | 横滑Tag 列表,最少2个,最多10个,tag是对工具内容的分类,tag下的内容应默认和第一个tag对应,而第一个tag必须和intent(即用户搜索意图)相对应 |
tag.text | string | 可选 | Tag文案,最短1个字符,最长6个字符 |
tag.tag_url | string | 可选 | tag链接地址。如:“/page/of/target” |
img_col | integer | 必选 | 上图下文所占栅格,固定为4 |
item | array | 必选 | 上图下文列表数据配置,最多10个,最少3个 |
item.image | string | 必选 | 图片链接,以“https”开头的图片链接 |
item.title | string | 必选 | 标题文案,最长200个字符 |
item.item_url | string | 必选 | 点击上图下文结构的跳转链接地址,跳转页内容应与图文内容呼应。url字段需返回H5或智能小程序页面路径。如:“/page/of/target“ |
img_ratio | number | 必选 | 图片宽高比,固定为0.75 |
slink | array | 可选 | 子链列表,最少2个,最多3个 |
slink.text | string | 可选 | 子链文案,最短1个字符,最长10个字符,例如:子链 |
slink.slink_url | string | 可选 | 子链跳转链接,如:“/page/of/target” |
statement | string | 可选 | 底部声明文案,最长100个字符 |
举例:从 webhook 返回的 JSON (加密前)
1 | { |