SearchResponse

SearchService.Search 方法的响应消息。

JSON 表示法 
{
  "results": [
    {
      object (SearchResult)
    }
  ],
  "facets": [
    {
      object (Facet)
    }
  ],
  "totalSize": integer,
  "attributionToken": string,
  "redirectUri": string,
  "nextPageToken": string,
  "correctedQuery": string,
  "summary": {
    object (Summary)
  },
  "queryExpansionInfo": {
    object (QueryExpansionInfo)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "searchLinkPromotions": [
    {
      object (SearchLinkPromotion)
    }
  ]
}
字段
results[]

object (SearchResult)

匹配的文档列表。顺序表示排名。
facets[]

object (Facet)

用户请求的分面结果。
totalSize

integer

估算的匹配商品总数量，不考虑分页。分页返回的 results 数量可能少于匹配的 totalSize 数量。
attributionToken

string

唯一的搜索令牌。此令牌应包含在相应搜索生成的 UserEvent 日志中，以便对搜索模型效果进行准确归因。这也有助于在客户支持场景中识别请求。
redirectUri

string

客户自定义的重定向页面的 URI。如果触发了重定向操作，则不会执行搜索，并且响应中仅设置 redirectUri 和 attributionToken。
nextPageToken

string

可作为 SearchRequest.page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。
correctedQuery

string

包含拼写更正后的查询（如果找到）。如果拼写校正类型为 AUTOMATIC，则搜索结果基于 correctedQuery。否则，系统会使用原始查询进行搜索。
summary

object (Summary)

作为搜索结果的一部分的摘要。只有在设置了 SearchRequest.ContentSearchSpec.summary_spec 时，系统才会返回此字段。
queryExpansionInfo

object (QueryExpansionInfo)

返回结果的查询扩展信息。
sessionInfo

object (SessionInfo)

会话信息。

仅当提供 SearchRequest.session 时才设置。如需了解详情，请参阅其说明。

商品详情

一种分面结果。

JSON 表示法 
{
  "key": string,
  "values": [
    {
      object (FacetValue)
    }
  ],
  "dynamicFacet": boolean
}
字段
key

string

相应构面的键。例如 "colors" 或 "price"。 它与 SearchRequest.FacetSpec.FacetKey.key 相匹配。
values[]

object (FacetValue)

相应字段的构面值。
dynamicFacet

boolean

分面是否是动态生成的。

FacetValue

包含值名称及其数量的 Facet 值。

JSON 表示法 
{
  "count": string,

  // Union field facet_value can be only one of the following:
  "value": string,
  "interval": {
    object (Interval)
  }
  // End of list of possible types for union field facet_value.
}
字段
count

string (int64 format)

具有相应分面值的商品的数量。
联合字段 facet_value。包含值的 facet 值。facet_value 只能是下列其中一项：
value

string

相应构面的文本值，例如构面“颜色”的“黑色”。
interval

object (Interval)

某个详情的区间值，例如“价格”详情的 [10, 20)。它与 SearchRequest.FacetSpec.FacetKey.intervals 相匹配。

QueryExpansionInfo

描述查询扩展的信息，包括是否已发生扩展。

JSON 表示法 
{
  "expandedQuery": boolean,
  "pinnedResultCount": string
}
字段
expandedQuery

boolean

一个布尔值，用于描述是否发生了查询扩展。
pinnedResultCount

string (int64 format)

固定结果的数量。只有在发生扩展且 SearchRequest.QueryExpansionSpec.pin_unexpanded_results 设置为 true 时，系统才会设置此字段。

SessionInfo

有关会话的信息。

JSON 表示法 
{
  "name": string,
  "queryId": string
}
字段
name

string

会话名称。如果使用自动会话模式（当 SearchRequest.session 以“-”结尾时），此字段会保存新生成的会话名称。
queryId

string

与此搜索 API 调用对应的查询 ID。一个会话可以包含多个对话轮次，每个对话轮次都有一个唯一的查询 ID。

通过在 Answer API 调用中指定会话名称和此查询 ID，系统会在相应搜索调用的搜索结果上下文中生成回答。