用户在搜索“特殊符号”、“emoji 符号”等泛需求,“笑哭符号”、“爱心符号”等精准需求时,搜索结果页会展现符号工具卡片。用户可在结果页查看并复制想要的符号,或点击卡片跳转至资源方落地页查看和使用更多符号。
示意图
泛需求
精准需求
intent 上传接口
当前资源 intent 意图参数
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
symbol_type | string | 符号类型 | 必选,资源所覆盖的符号类型名称,如:“emoji”、“数学符号”、“货币符号”等 |
symbol_name | string | 符号名称 | 必选,具体的热门符号名称,如:“笑哭”、“爱心”、“白眼”等 |
通过平台上传 txt 文件
资源方需要将自己落地页数据能够覆盖的所有 intent 参数组合通过 txt 文件上传到平台上,txt 文件的具体要求参见接入流程-上传 Intent 数据。
当前资源分类 txt 上传文件内容示例如下:
1 | {"symbol_type":"","symbol_name":""} |
注意:上述四种 intent 组合分别在以下四类 query 下召回此卡片:
intent 组合 | query 类型 | 举例 |
---|---|---|
symbol_type 为空、symbol_name 为空 | 符号查询泛需求,卡片 tag 可自行设置为热门符号类型 | 如“符号大全可复制” |
symbol_type 上传实体名、symbol_name 为空 | 指定符号类型的泛需求,卡片默认 tag 须与 symbol_type 保持一致 | 如:“emoji 表情” |
symbol_type 为空、symbol_name 上传实体名 | 精准需求 | 如“笑哭表情” |
symbol_type 上传实体名、symbol_name 上传实体名 | 精准需求 | 如:“笑哭 emoji 符号” |
通过开放 API 上传
详细接入方式参见API 上传方式
Webhook API
发送给 webhook 的请求
公共字段
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
type | string | 请求类型 | 在小程序阿拉丁下永远为 “sp_ala” |
surface | string | 搜索场景 | mobile: 支持小程序的移动搜索,web_h5: 支持 H5 的移动搜索 |
srcid | string | 资源编号 | 每个资源分类不同 |
intent | object | 搜索意图参数 | JSON 对象,每个资源分类不同 |
当前资源 srcid 资源编号
key | 类型 | 含义 | 设定 |
---|---|---|---|
srcid | string | 资源编号 | 48055 |
当前资源的 intent 参数参考上节 “intent 上传接口“。
举例:发送给 webhook 的 JSON (解密后)
1 | { |
从 webhook 返回的结果
外层通用数据字段
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
status | integer | 结果状态码,0 代表正确,1 代表无结果, 2 代表请求参数错误,3 代表内部服务错误 |
0 |
msg | string | 出错消息,当非 0 时提供 | “” |
data | object | 要返回的资源数据内容 | JSON 对象,每个资源分类不同 |
当前资源分类的 data
object 字段内容
key | 类型 | 要求 | 说明 |
---|---|---|---|
jump_url | string | 必选 | 卡片跳转链接地址,跳转至资源方提供可复制符号大全的落地页。该字段需返回 H5 或智能小程序页面路径,例如“/page/of/target” |
tag_list | array | 可选 | tag 列表,最少 2 个,最多 5 个,泛需求下上传,精准需求下不上传 |
tag_list.text | string | 必选 | tag 文案,泛需求下为符号类型,如:“emoji”。最短 1 个字符,最长 6 个字符 |
tag_list.url | string | 必选 | tag 跳转链接地址,泛需求下为具体类型的符号列表页面 |
symbol_name | string | 必选 | 短答案,泛需求下为符号类型名称,与默认 tag 的符号类型保持一致,如:“emoji 符号”;精准需求下为具体符号文本+空格+符号名称,如“😂 笑哭” |
symbol_desc | string | 可选 | 辅助短答案,泛需求下可上传对服务的描述,与默认 tag 的符号类型保持一致;精准需求下不上传 |
symbol_text | string | 必选 | 符号文本,泛需求下为该类型的热门符号组成的文本段落;精准需求下为对该符号的描述,如有多个同名符合的情况,可在此处对短答案进行补充 |
举例:从 webhook 返回的 JSON (加密前)
1 | { |