精选文档查询

用户在搜索教育类文档需求时,搜索会展现精选文档聚合卡片,提供优质的文档资源查看下载信息。

示意图

精选文档查询 - 图1

intent 上传接口

当前资源 intent 意图参数

key类型含义要求示例/说明
variablestring文档名称可选“一年级语文上册”
categorystring文档分类可选“教案”

通过平台上传 txt 文件

资源方需要将自己小程序能够覆盖的所有 intent 参数组合通过 txt 文件上传到平台上,txt 文件的具体要求参见接入流程-上传 Intent 数据

当前资源分类 txt 上传文件内容示例如下:

  1. { "variable": "一年级语文上册", "catetory": "教案" }

通过开放 API 上传

未开放

Webhook API

发送给 webhook 的请求

公共字段

key类型含义示例/说明
typestring请求类型(大部分开发者可不关心)在小程序阿拉丁下永远为 “sp_ala”
surfacestring搜索场景(大部分开发者可不关心)mobile: 支持小程序的移动搜索,web_h5: 支持 H5 的移动搜索
srcidstring资源编号每个资源分类不同
intentobject搜索意图参数JSON 对象,每个资源分类不同

当前资源 srcid 资源编号

key类型含义设定
srcidstring资源编号48012

当前资源的 intent 参数参考上节 “intent 上传接口“。

举例:发送给 webhook 的 JSON (解密后)

  1. {
    "type": "sp_ala",
    "srcid": "48012",
    "surface": "mobile",
    "intent": {
    "variable": "一年级语文上册",
    "category": "教案"
    }
    }

从 webhook 返回的结果

外层通用数据字段

key类型含义示例/说明
statusinteger结果状态码,0 代表正确,1 代表无结果,2 代表请求参数错误,3 代表内部服务错误0
msgstring出错消息,当非 0 时提供“”
dataobject要返回的资源数据内容JSON 对象,每个资源分类不同

当前资源分类的 data object 字段内容

key类型要求说明
jump_urlstring必选结构化元素:链接,点击卡片标题跳转的链接。当卡片展示 1 个文档,跳转到展示该文档的页面;当卡片展现大于 1 个文档,跳转到卡片包含的文档列表页(小程序样例数据:/path/to/page h5 样例数据:http://www.lottery.gov.cn/)
tag_listarray整体可选,选后不可为空Tags,该文档的结构化列表数据,最少 2 个,最多 10 个
tag_list.textstring必选选项 tag 标签上的文案,如一年级、二年级等,默认展示第一个 tag,且该 tag 需要满足 intent 所体现的用户主需求。
tag_list.urlstring必选结构化元素:链接,点击 tag 区域跳转的链接
item_listarray必选个数组件数据(数组),指文档篇数,最少 1 个,最多 3 个
item_list.titlestring必选文档标题文案,两行截断
item_list.imagestring必选文档缩略图的图片链接,图片尺寸 3:4,像素 364*486,不符合比例的图片将按固定比例被居中裁剪
item_list.extra_infostring必选文案,文档类型、文档页数,中间用符号隔开
item_list.read_numstring必选文案,文档浏览量
item_list.labelsarray可选,选后不可为空标签组,如热、新、免费阅读等。字符串数组,最多 3 个,字数在 5 个字以内
item_list.source_iconstring必选作者头像,必须 https 开头
item_list.source_textstring必选作者名称
item_list.source_extrastring可选,选后不可为空作者等级,如高级教师
item_list.urlstring必选结构化元素:链接,文档链接
linksarray整体可选,选后不可为空Slink 子链列表数据,最少 2 个,最多 5 个
links.textstring必选子链文案,2/3/4/5 等分分别最大支持 8/6/4/2 个字,具体文案如教案、教学设计等
links.urlstring必选结构化元素:链接

举例:从 webhook 返回的 JSON (加密前)

  1. {
    "data": {
    "item_list": [
    {
    "extra_info": "ppt | 65 页",
    "image": "https://xxx.jpg",
    "labels": ["免费阅读", "新"],
    "read_num": "阅读量: 82",
    "source_extra": "二级教师",
    "source_icon": "https://xxx.jpg",
    "source_text": "小A",
    "title": "精编人教部编版2019四年级上册语文教学课件—2走月亮",
    "url": "/path/to/page"
    },
    {
    "extra_info": "word | 7 页",
    "image": "https://xxx.jpg",
    "labels": ["免费阅读", "新"],
    "read_num": "阅读量: 64",
    "source_extra": "教师",
    "source_icon": "https://xxx.jpg",
    "source_text": "元宝老师",
    "title": "精编部编版2019年五年级上册语文教案-2.落花生",
    "url": "/path/to/page"
    }
    ],
    "jump_url": "/path/to/page",
    "links": [
    {
    "text": "教案",
    "url": "/path/to/page"
    },
    {
    "text": "教学设计",
    "url": "/path/to/page"
    }
    ],
    "tag_list": [
    {
    "text": "全部",
    "url": "/path/to/page"
    },
    {
    "text": "一年级",
    "url": "/path/to/page"
    },
    {
    "text": "二年级",
    "url": "/path/to/page"
    },
    {
    "text": "三年级",
    "url": "/path/to/page"
    },
    {
    "text": "四年级",
    "url": "/path/to/page"
    },
    {
    "text": "五年级",
    "url": "/path/to/page"
    },
    {
    "text": "六年级",
    "url": "/path/to/page"
    }
    ]
    },
    "msg": "",
    "status": 0
    }