用户在搜索“书法字典”、“百字楷书写法”等需求时,结果页会展现书法字典卡片。卡片摘要展示用户所检索单字的不同书体写法图片及其来源、作者,点击单字书法图片可跳转至字体详情页或单字图片列表页(带锚点)对应位置;点击书体tag可跳转至资源方落地页中该书体下对应单字的检索结果页;点击整卡除图片、tag外任意一处,跳转至资源方落地页(端内小程序+端外H5)默认字体的单字检索结果页。
示意图
intent 上传接口
当前资源 intent 意图参数
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
character | string | 待查字 | 必选,用户试图转换为书法的汉字,如:"百""川"等 |
通过平台上传 txt 文件
资源方需要将自己落地页数据能够覆盖的所有 intent 参数组合通过 txt 文件上传到平台上,txt 文件的具体要求参见接入流程-上传 Intent 数据。
当前资源分类 txt 上传文件内容示例如下:
1 | {"character":"百"} |
注意:为了能够召回泛需求,必须上传一个空的 intent,此时资源方上传的数据为默认字的书法图片。
通过开放 API 上传
详细接入方式参见 API 上传方式
Webhook API
发送给 webhook 的请求
公共字段
key | 类型 | 含义 | 示例/说明 |
---|---|---|---|
type | string | 请求类型 | 在小程序阿拉丁下永远为 “sp_ala” |
surface | string | 搜索场景 | mobile: 支持小程序的移动搜索,web_h5: 支持 H5 的移动搜索 |
srcid | string | 资源编号 | 每个资源分类不同 |
intent | object | 搜索意图参数 | JSON 对象,每个资源分类不同 |
query_info.handwriting_type | string | 用户 Query 中指定的书体 | “楷书”/“行书”,可能为空 |
注:为满足用户的检索需求,资源方应返回query_info中的字体信息对应的字体。
当前资源 srcid 资源编号
key | 类型 | 含义 | 设定 |
---|---|---|---|
srcid | string | 资源编号 | 48032 |
当前资源的 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 | 必选 | 点击整卡除图片、tag 外任意一处的跳转链接,跳转至能满足书法字典需求的落地页。该字段需返回 H5 或智能小程序页面路径,例如“/page/of/target”;若跳转至 H5 或智能小程序首页(无路径),则需要返回“/?from=baidu”。 |
tag_list | array | 必选 | tag 列表,最少 2 个,最多 10 个 |
tag_list.tag_text | string | 必选 | Tag 文案列表,一般为书体类型,如“楷书”“行书”“隶书”等,以列表形式上传。第一个 tag 必须满足用户主需求,用户主需求详见发送给 webhook 的 JSON——query_info。 |
tag_list.tag_url | string | 必选 | Tag 跳转链接地址,一般为资源方落地页中对应书体的首页(泛需求)或单字检索结果页(精准需求)。该字段需返回 H5 或智能小程序页面路径,例如“/page/of/target”;若跳转至 H5 或智能小程序首页(无路径),则需要返回“/?from=baidu”。 |
content_list | array | 必选 | 内容区上图下文列表数据,最少 3 个 |
content_list.img_src | string | 必选 | 图片链接,具体单字的特定书体写法图片,以列表形式上传 |
content_list.img_title | string | 必选 | 图片下方标题,一般为图中书体的来源,如“玄秘塔碑”“九成宫端方本”等,以列表形式上传 |
content_list.content_url | string | 必选 | 每个上图下文结构体的跳转链接,一般为字体详情页或者带锚点信息的书体图片列表落地页链接,例如“/page/of/target”;若跳转至H5或智能小程序首页(无路径),则需要返回“/?from=baidu”。 |
content_list.img_text | string | 必选 | 图片右下角文案,一般为图中书体的作者,如“柳公权”“欧阳询”等,以列表形式上传 |
举例:从 webhook 返回的 JSON (加密前)
1 | { |