- HTTP 请求
- 请求正文
- 响应正文
- 授权作用域
- QueryInterpretationOptions
- QueryInterpretation
- QueryInterpretation.InterpretationType
- QueryInterpretation.Reason
- SearchResult
- 代码段
- MatchRange
- 元数据
- ResultDisplayMetadata
- ResultDisplayMetadata.ResultDisplayLine
- ResultDisplayMetadata.ResultDisplayField
- ResultDebugInfoResultDebugInfo
- StructuredResult
- SpellResult
- FacetResult
- FacetBucket
- ResponseDebugInfo
- ErrorInfo
- ErrorMessage
- ResultCounts 个
- SourceResultCount
- 试试看!
Cloud Search Query API 提供了搜索方法,该方法会返回用户查询中最相关的结果。这些结果可能来自 Google Workspace 应用(例如 Gmail 或 Google 云端硬盘),也可能来自您已从第三方编入索引的数据。
注意:执行此 API 需要标准的最终用户帐号。服务帐号无法直接执行 Query API 请求;要使用服务帐号执行查询,请设置 Google Workspace 全网域授权。
HTTP 请求
POST https://cloudsearch.googleapis.com/v1/query/search
网址采用 gRPC 转码语法。
请求正文
请求正文中包含结构如下的数据:
JSON 表示法 |
---|
{ "requestOptions": { object ( |
字段 | |
---|---|
requestOptions |
请求选项,例如搜索应用和用户时区。 |
query |
原始查询字符串。请参阅使用运算符缩小搜索范围,了解受支持的搜索运算符 |
pageSize |
一页中返回的搜索结果数量上限。有效值介于 1 和 100 之间(含 1 和 100)。默认值为 10。如果请求的结果数超过 2000,则最小值为 50。 |
start |
结果的起始索引。 |
dataSourceRestrictions[] |
用于查询的来源。如果未指定,则系统会使用当前搜索应用中的所有数据源。 |
facetOptions[] |
|
sortOptions |
用于对搜索结果进行排序的选项 |
queryInterpretationOptions |
用于解释用户查询的选项。 |
contextAttributes[] |
请求的上下文属性,将用于调整搜索结果的排名。元素数量上限为 10 个。 |
响应正文
如果成功,响应正文将包含结构如下的数据:
搜索 API 响应。
JSON 表示法 |
---|
{ "queryInterpretation": { object ( |
字段 | |
---|---|
queryInterpretation |
用户查询的查询解释结果。如果查询解释已停用,则为空。 |
results[] |
来自搜索查询的结果。 |
structuredResults[] |
用户查询的结构化结果。这些结果不计入 pageSize。 |
spellResults[] |
查询的建议拼写。 |
facetResults[] |
重复的分面结果。 |
hasMoreResults |
是否还有其他与查询匹配的搜索结果。 |
debugInfo |
有关响应的调试信息。 |
errorInfo |
有关响应的错误信息。 |
resultCounts |
已展开结果计数信息。 |
联合字段
在极少数情况下,当系统无法搜索所有文档时,请重新运行查询。 |
|
resultCountEstimate |
此查询的估算结果计数。 |
resultCountExact |
此查询的确切结果计数。 |
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/cloud_search.query
https://www.googleapis.com/auth/cloud_search
有关详情,请参阅授权指南。
QueryInterpretationOptions
用于解释用户查询的选项。
JSON 表示法 |
---|
{ "disableNlInterpretation": boolean, "enableVerbatimMode": boolean, "disableSupplementalResults": boolean } |
字段 | |
---|---|
disableNlInterpretation |
用于停用查询的自然语言 (NL) 解释功能的标志。默认值为 false,设置为 true 可停用自然语言解释。NL 解释仅适用于预定义的数据源。 |
enableVerbatimMode |
启用此标志可停用所有内部优化功能,例如查询的自然语言 (NL) 解释、补充结果检索以及使用同义词(包括自定义关键字)。如果两个标记中的任何一个为 true,系统将停用 Nl 解释。 |
disableSupplementalResults |
使用此标志可以停用查询的补充结果。如果设为 True,系统将优先在 SearchApplication 级别选择补充结果设置。 |
QueryInterpretation
JSON 表示法 |
---|
{ "interpretedQuery": string, "interpretationType": enum ( |
字段 | |
---|---|
interpretedQuery |
对搜索中使用的查询的解释。例如,包含自然语言意图(例如“来自 john 的电子邮件”)的查询将被解读为“from:john source:mail”。当原因为 NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY 时,此字段将不会被填充。 |
interpretationType |
|
reason |
对查询进行解释的原因。如果解释类型不是“无”,则此字段将显示为“未指定”。 |
QueryInterpretation.InterpretationType
枚举 | |
---|---|
NONE |
Google 既不使用自然语言解释,也不使用更宽泛的查询版本来提取搜索结果。 |
BLEND |
原始查询的结果与其他结果混合在一起。将其他结果与原始查询结果混合的原因会填入下面的“原因”字段中。 |
REPLACE |
原始查询的结果将被替换。替换原始查询的结果的原因会填入下面的“原因”字段中。 |
QueryInterpretation.Reason
枚举 | |
---|---|
UNSPECIFIED |
|
QUERY_HAS_NATURAL_LANGUAGE_INTENT |
使用查询的自然语言解释来提取搜索结果。 |
NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY |
查询和文档术语相似性用于选择性地扩大查询范围,以检索更多搜索结果,因为没有针对该用户查询找到足够的结果。在这种情况下,解释的查询将为空。 |
SearchResult
包含文档的已编入索引的信息的结果。
JSON 表示法 |
---|
{ "title": string, "url": string, "snippet": { object ( |
字段 | |
---|---|
title |
搜索结果的标题。 |
url |
搜索结果的网址。网址包含指向实际商品的 Google 重定向。此网址已签名,不应更改。 |
snippet |
此结果可用所有代码段(摘要)的串联。 |
metadata |
搜索结果的元数据。 |
clusteredResults[] |
如果来源经过聚类,请提供聚类结果的列表。聚类结果只有一个级别。如果当前来源未启用聚类,则此字段将为空。 |
debugInfo |
有关此搜索结果的调试信息。 |
Snippet
搜索结果摘要,总结了所返回网页的内容。
JSON 表示法 |
---|
{
"snippet": string,
"matchRanges": [
{
object ( |
字段 | |
---|---|
snippet |
文档的摘要。文档的摘要。可能包含在呈现前应不转义的已转义 HTML 字符。 |
matchRanges[] |
摘要中的匹配范围。 |
MatchRange
摘要的匹配范围 [start, end)。
JSON 表示法 |
---|
{ "start": integer, "end": integer } |
字段 | |
---|---|
start |
匹配项在摘要中的起始位置。 |
end |
片段中的比赛结束。 |
元数据
所匹配搜索结果的元数据。
JSON 表示法 |
---|
{ "source": { object ( |
字段 | |
---|---|
source |
搜索结果的指定来源,例如 Gmail。 |
mimeType |
搜索结果的 MIME 类型。 |
thumbnailUrl |
结果的缩略图网址。 |
owner |
搜索结果中的文档或对象的所有者(通常是创建者)。 |
createTime |
此文档或对象在搜索结果中的创建时间。 时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例: |
updateTime |
搜索结果中对象的上次修改日期。如果未在该项中设置,则此处返回的值为空。当 时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例: |
fields[] |
结构化数据中的编入索引的字段,作为通用的命名属性返回。 |
displayOptions |
用于指定如何显示结构化数据搜索结果的选项。 |
objectType |
搜索结果的对象类型。 |
ResultDisplayMetadata
JSON 表示法 |
---|
{
"objectTypeLabel": string,
"metalines": [
{
object ( |
字段 | |
---|---|
objectTypeLabel |
对象的显示标签。 |
metalines[] |
与结果一起显示的元行内容。 |
ResultDisplayMetadata.ResultDisplayLine
构成所显示行的字段集合
JSON 表示法 |
---|
{
"fields": [
{
object ( |
字段 | |
---|---|
fields[] |
ResultDisplayMetadata.ResultDisplayField
query.search 结果的显示字段
JSON 表示法 |
---|
{
"label": string,
"operatorName": string,
"property": {
object ( |
字段 | |
---|---|
label |
属性的显示标签。 |
operatorName |
属性的运算符名称。 |
property |
属性的名称值对。 |
ResultDebugInfo
与结果相关的调试信息。
JSON 表示法 |
---|
{ "formattedDebugInfo": string } |
字段 | |
---|---|
formattedDebugInfo |
常规调试信息,采用适合显示的格式。 |
StructuredResult
作为搜索请求的一部分返回的结构化结果。
JSON 表示法 |
---|
{
"person": {
object ( |
字段 | |
---|---|
person |
代表人物 |
SpellResult
JSON 表示法 |
---|
{ "suggestedQuery": string } |
字段 | |
---|---|
suggestedQuery |
查询的建议拼写。 |
FacetResult
来源特定分面响应
JSON 表示法 |
---|
{
"sourceName": string,
"objectType": string,
"operatorName": string,
"buckets": [
{
object ( |
字段 | |
---|---|
sourceName |
返回分面结果的来源名称。不得为空。 |
objectType |
返回分面结果的对象类型。可以留空。 |
operatorName |
为分面选择的操作符的名称。@see cloudsearch.SchemaPropertyOptions |
buckets[] |
响应值中至少包含一条具有相应过滤条件的结果的 FacetBuckets。 |
FacetBucket
构面中的分区是基本操作单位。分区可以包含一个值或连续的值范围,具体取决于分区字段的类型。FacetBucket 目前仅用于返回响应对象。
JSON 表示法 |
---|
{ "count": integer, "percentage": integer, "filter": { object ( |
字段 | |
---|---|
count |
与存储分区值匹配的结果数。只有在能确保计数准确性的情况下,才会针对搜索返回计数。Cloud Search 不保证任何查询的分面计数,且构面计数可能只会间歇性地出现,即使对于相同的查询也是如此。不要依赖于构面计数存在性构建依赖关系;而是使用始终返回的分面事件百分比。 |
percentage |
与存储分区值匹配的结果所占的百分比。返回的值介于 (0-100] 之间,若有小数,则向下舍入为整数。如果未明确返回该值,则它表示百分比值,四舍五入为 0。系统会针对所有搜索返回百分比,但这是一个估算值。由于始终返回百分比,因此您应呈现百分比而不是计数。 |
filter |
要在搜索请求中传递的过滤条件(如果选择了相应的存储分区)。 |
value |
|
ResponseDebugInfo
有关响应的调试信息。
JSON 表示法 |
---|
{ "formattedDebugInfo": string } |
字段 | |
---|---|
formattedDebugInfo |
常规调试信息,采用适合显示的格式。 |
ErrorInfo
有关响应的错误信息。
JSON 表示法 |
---|
{
"errorMessages": [
{
object ( |
字段 | |
---|---|
errorMessages[] |
|
ErrorMessage
每个来源响应的错误消息。
JSON 表示法 |
---|
{
"source": {
object ( |
字段 | |
---|---|
source |
|
errorMessage |
|
ResultCounts
结果数量信息
JSON 表示法 |
---|
{
"sourceResultCounts": [
{
object ( |
字段 | |
---|---|
sourceResultCounts[] |
每个含结果的来源的结果计数信息。 |
SourceResultCount
每个来源的结果计数信息。
JSON 表示法 |
---|
{ "source": { object ( |
字段 | |
---|---|
source |
与结果计数信息关联的来源。 |
hasMoreResults |
此来源是否有更多搜索结果。 |
联合字段
|
|
resultCountEstimate |
此来源的估算结果计数。 |
resultCountExact |
此来源的确切结果计数。 |