腾讯云搜
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 腾讯云搜

数据检索接口

最近更新时间：2024-03-12 02:08:07

我的收藏

本页目录：

1. 接口描述

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

用于检索云搜中的数据。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DataSearch。
Version 是 String 公共参数，本接口取值：2019-11-15。
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. 输出参数

参数名称 类型 描述
Data SearchResult 检索结果
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 数据搜索接口

输入示例

https://yunsou.tencentcloudapi.com/?Action=DataSearch
&NumPerPage=10
&PageId=0
&ResourceId=80680002
&SearchId=b65234af-9eb4-4e4d-a25e-d5b32c189545
&SearchQuery=abcde
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "f65234af-adfs-4wws-2dsa-d5b3swr575",
        "Data": {
            "CostTime": 5,
            "DisplayNum": 1,
            "Echo": "",
            "EResultNum": 1,
            "ResultList": [
                {
                    "DocAbs": "",
                    "DocId": "122",
                    "DocMeta": "{\"NC\":\"9999\",\"TD\" : \"中文\",\"NA\" : \"1000\",\"NB\" : \"9999\",\"TA\" : \"中文\",\"TB\" : \"abcde\",\"TC\" : \"中文\",\"TE\":\"tttteeee\",\"TF\":\"efeefe\",\"countrycode\":\"cn\",\"renderType\":\"rrr\"}\n",
                    "L2Score": 0
                }
            ],
            "ResultNum": 1,
            "SegList": [
                {
                    "SegStr": "abcde"
                }
            ]
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码 描述
FailedOperation.AccountInfo 查询用户信息失败。
FailedOperation.AppInfo 查询应用信息失败。
FailedOperation.Search 搜索接口异常。
FailedOperation.UploadDataApiFail 数据上传异常。
InvalidParameter 参数错误。
InvalidParameter.DataContent 数据文件无效。
LimitExceeded.Search 请求的次数超过了频率限制。
UnauthorizedOperation 未授权操作。
中国站