Method: query.suggest

提供自动补全查询的建议。

注意：此 API 需要使用标准最终用户账号才能执行。服务账号无法直接执行查询 API 请求；如需使用服务账号执行查询，请设置 Google Workspace 全网域授权。

HTTP 请求

POST https://cloudsearch.googleapis.com/v1/query/suggest

网址采用 gRPC 转码语法。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "requestOptions": {
    object (RequestOptions)
  },
  "query": string,
  "dataSourceRestrictions": [
    {
      object (DataSourceRestriction)
    }
  ]
}
字段
requestOptions

object (RequestOptions)

请求选项，例如搜索应用和用户时区。
query

string

系统将针对该部分查询显示自动补全建议。例如，如果查询是“sea”，则服务器可能会返回“season”“search”“seagull”等。
dataSourceRestrictions[]

object (DataSourceRestriction)

用于提供建议的来源。如果未指定，则数据源会从当前搜索应用中获取。

注意：只有以下来源支持建议功能：

  • 第三方数据源
  • PredefinedSource.PERSON
  • PredefinedSource.GOOGLE_DRIVE

响应正文

suggest API 的响应。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "suggestResults": [
    {
      object (SuggestResult)
    }
  ]
}
字段
suggestResults[]

object (SuggestResult)

建议列表。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/cloud_search.query
  • https://www.googleapis.com/auth/cloud_search

如需了解详情，请参阅授权指南。

SuggestResult

一个建议结果。

JSON 表示法 
{
  "suggestedQuery": string,
  "source": {
    object (Source)
  },

  // Union field suggestion can be only one of the following:
  "querySuggestion": {
    object (QuerySuggestion)
  },
  "peopleSuggestion": {
    object (PeopleSuggestion)
  }
  // End of list of possible types for union field suggestion.
}
字段
suggestedQuery

string

当用户点击建议时，将用于搜索的建议查询
source

object (Source)

建议的来源。
联合字段 suggestion。包含有关建议的查询的其他元数据。它还会指明建议的查询类型。例如，如果存在 PeopleSuggestion，则表示 suggested_query 是人物建议。suggestion 只能是下列其中一项：
querySuggestion

object (QuerySuggestion)

如果建议的查询是字词/短语补全，则此字段会显示。
peopleSuggestion

object (PeopleSuggestion)

当建议指向某个人时，系统会显示此图标。其中包含与该用户相关的更多信息，例如其电子邮件 ID、姓名等。

QuerySuggestion

此类型没有字段。

此字段目前不包含任何内容，仅用于指示建议结果是短语补全。

PeopleSuggestion

此字段包含与建议的用户相关的信息。

JSON 表示法 
{
  "person": {
    object (Person)
  }
}
字段
person

object (Person)

推荐的联系人。系统可能不会填充人员对象的所有字段。