数据检索接口

最近更新时间:2019-07-24 16:20:52

1. 接口描述

接口请求域名: yunsou.tencentcloudapi.com 。

用于检索云搜中的数据

默认接口请求频率限制:20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DataSearch
Version String 公共参数,本接口取值:2018-05-04
Region String 公共参数,本接口不需要传递此参数。
ResourceId Integer 云搜的业务ID,用以表明当前数据请求的业务
SearchQuery String 检索串
PageId Integer 当前页,从第0页开始计算
NumPerPage Integer 每页结果数
SearchId String 当前检索号,用于定位问题,建议指定并且全局唯一
QueryEncode Integer 请求编码,0表示utf8,1表示gbk,建议指定
RankType Integer 排序类型
NumFilter String 数值过滤,结果中按属性过滤
ClFilter String 分类过滤,导航类检索请求
Extra String 检索用户相关字段
SourceId Integer 检索来源
SecondSearch Integer 是否进行二次检索,0关闭,1打开
MaxDocReturn Integer 指定返回最大篇数,无特殊原因不建议指定
IsSmartbox Integer 是否smartbox检索,0关闭,1打开
EnableAbsHighlight Integer 是否打开高红标亮,0关闭,1打开
QcBid Integer 指定访问QC纠错业务ID
GroupBy String 按指定字段进行group by,只能对数值字段进行操作
Distinct String 按指定字段进行distinct,只能对数值字段进行操作
L4RankExpression String 高级排序参数,具体参见高级排序说明
MatchValue String 高级排序参数,具体参见高级排序说明
Longitude Float 经度信息
Latitude Float 纬度信息
MultiFilter.N Array of String 分类过滤并集

3. 输出参数

参数名称 类型 描述
RetMsg String 数据返回信息
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 数据检索

输入示例

https://yunsou.tencentcloudapi.com/?Action=DataSearch
&NumPerPage=10
&PageId=0
&ResourceId=76340002
&SearchId=uuunnnllliiikkkkeeee
&SearchQuery=%E6%BC%94%E5%91%98
&<公共请求参数>

输出示例

{
  "Response": {
    "RetMsg": "{\"data\":{\"cost_time\":4,\"display_num\":5,\"echo\":\"\",\"eresult_num\":5,\"result_list\":[{\"doc_abs\":\"\",\"doc_id\":\"1004\",\"doc_meta\":\"{\\\"NA\\\":\\\"1004\\\",\\\"NB\\\":\\\"9999\\\",\\\"NC\\\":\\\"9999\\\",\\\"TA\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TB\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TC\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TD\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TE\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TF\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"countrycode\\\":\\\"该字段可以是文本、数值,引擎不进行分词,整体建索引并提供检索,适合按某个文本字段进行过滤的搜索场景。比如视频应用中需要按电影类型进行过滤\\\",\\\"renderType\\\":\\\"该字段可以是文本、数值,引擎不进行分词,整体建索引并提供检索,适合按某个文本字段进行过滤的搜索场景。比如视频应用中需要按电影类型进行过滤\\\"}\\n\",\"l2_score\":0,\"search_debug_info\":\"\"},{\"doc_abs\":\"\",\"doc_id\":\"1002\",\"doc_meta\":\"{\\\"NA\\\":\\\"1002\\\",\\\"NB\\\":\\\"9999\\\",\\\"NC\\\":\\\"9999\\\",\\\"TA\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TB\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TC\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TD\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TE\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TF\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"countrycode\\\":\\\"该字段可以是文本、数值,引擎不进行分词,整体建索引并提供检索,适合按某个文本字段进行过滤的搜索场景。比如视频应用中需要按电影类型进行过滤\\\",\\\"renderType\\\":\\\"该字段可以是文本、数值,引擎不进行分词,整体建索引并提供检索,适合按某个文本字段进行过滤的搜索场景。比如视频应用中需要按电影类型进行过滤\\\"}\\n\",\"l2_score\":0,\"search_debug_info\":\"\"},{\"doc_abs\":\"\",\"doc_id\":\"1001\",\"doc_meta\":\"{\\\"NA\\\":\\\"1001\\\",\\\"NB\\\":\\\"9999\\\",\\\"NC\\\":\\\"9999\\\",\\\"TA\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TB\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TC\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TD\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TE\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TF\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"countrycode\\\":\\\"该字段可以是文本、数值,引擎不进行分词,整体建索引并提供检索,适合按某个文本字段进行过滤的搜索场景。比如视频应用中需要按电影类型进行过滤\\\",\\\"renderType\\\":\\\"该字段可以是文本、数值,引擎不进行分词,整体建索引并提供检索,适合按某个文本字段进行过滤的搜索场景。比如视频应用中需要按电影类型进行过滤\\\"}\\n\",\"l2_score\":0,\"search_debug_info\":\"\"},{\"doc_abs\":\"\",\"doc_id\":\"1003\",\"doc_meta\":\"{\\\"NA\\\":\\\"1003\\\",\\\"NB\\\":\\\"9999\\\",\\\"NC\\\":\\\"9999\\\",\\\"TA\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TB\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TC\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TD\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TE\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TF\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"countrycode\\\":\\\"该字段可以是文本、数值,引擎不进行分词,整体建索引并提供检索,适合按某个文本字段进行过滤的搜索场景。比如视频应用中需要按电影类型进行过滤\\\",\\\"renderType\\\":\\\"该字段可以是文本、数值,引擎不进行分词,整体建索引并提供检索,适合按某个文本字段进行过滤的搜索场景。比如视频应用中需要按电影类型进行过滤\\\"}\\n\",\"l2_score\":0,\"search_debug_info\":\"\"},{\"doc_abs\":\"\",\"doc_id\":\"1000\",\"doc_meta\":\"{\\\"NA\\\":\\\"1000\\\",\\\"NB\\\":\\\"9999\\\",\\\"NC\\\":\\\"9999\\\",\\\"TA\\\":\\\"xxxef\\\",\\\"TB\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TC\\\":\\\"需要进行分词、索引并提供检索的中文或英文文本字段,如视频应用中文档的标题、演员、导演、剧情描述等字段。\\\",\\\"TD\\\":\\\"该字段可以是文本、数值,引擎不进行分词,整体建索引并提供检索,适合按某个文本字段进行过滤的搜索场景。比如视频应用中需要按电影类型进行过滤\\\",\\\"TE\\\":\\\"tttteeee\\\",\\\"TF\\\":\\\"efeefe\\\",\\\"countrycode\\\":\\\"cn\\\",\\\"renderType\\\":\\\"rrr\\\"}\\n\",\"l2_score\":0,\"search_debug_info\":\"\"}],\"result_num\":5,\"seg_list\":[{\"seg_str\":\"演员\"},{\"seg_str\":\"演职员\"}]},\"retcode\":0,\"retmsg\":\"\"}",
    "RequestId": "5313c890-1e1a-4ff7-9021-5d36cbd439ee"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码