SearchResponse

SearchService.Search 方法的回應訊息。

JSON 表示法 
{
  "results": [
    {
      object (SearchResult)
    }
  ],
  "facets": [
    {
      object (Facet)
    }
  ],
  "totalSize": integer,
  "attributionToken": string,
  "redirectUri": string,
  "nextPageToken": string,
  "correctedQuery": string,
  "summary": {
    object (Summary)
  },
  "appliedControls": [
    string
  ],
  "queryExpansionInfo": {
    object (QueryExpansionInfo)
  },
  "naturalLanguageQueryUnderstandingInfo": {
    object (NaturalLanguageQueryUnderstandingInfo)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "searchLinkPromotions": [
    {
      object (SearchLinkPromotion)
    }
  ],
  "semanticState": enum (SemanticState)
}
欄位
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 時才傳回此欄位。
appliedControls[]

string

選用。透過 Control 服務套用的控制項。
queryExpansionInfo

object (QueryExpansionInfo)

傳回結果的查詢擴充資訊。
naturalLanguageQueryUnderstandingInfo

object (NaturalLanguageQueryUnderstandingInfo)

僅供輸出。傳回結果的自然語言查詢理解資訊。
sessionInfo

object (SessionInfo)

工作階段資訊。

只有在提供 SearchRequest.session 時才需要設定。詳情請參閱說明。
semanticState

enum (SemanticState)

僅供輸出。指出搜尋回應的語意狀態。

facet

Facet 結果。

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

string

這個 Facet 的鍵。例如 "colors" 或 "price"。與 SearchRequest.FacetSpec.FacetKey.key 相符。
values[]

object (FacetValue)

這個欄位的刻面值。
dynamicFacet

boolean

該層面是否為動態產生。

FacetValue

包含值名稱和計數的 Facet 值。

JSON 表示法 
{
  "count": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "value": string,
  "interval": {
    object (Interval)
  }
  // End of mutually exclusive fields.
}
欄位
count

string (int64 format)

具有這個 Facet 值的項目數量。
包含值的 facet 值。以下列出互斥的欄位。回應中最多只會設定一個欄位：
value

string

商情項目的文字值，例如商情項目「colors」的「Black」。
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 時，才會設定這個欄位。

NaturalLanguageQueryUnderstandingInfo

說明系統對輸入查詢內容執行的自然語言理解作業。

JSON 表示法 
{
  "extractedFilters": string,
  "rewrittenQuery": string,
  "classifiedIntents": [
    string
  ],
  "structuredExtractedFilter": {
    object (StructuredExtractedFilter)
  }
}
欄位
extractedFilters

string

從輸入查詢擷取的篩選器。
rewrittenQuery

string

重新寫入的輸入查詢，減去擷取的篩選器。
classifiedIntents[]

string

輸入查詢中分類的意圖。
structuredExtractedFilter

object (StructuredExtractedFilter)

從輸入查詢中提取的過濾器以結構化形式表示。

StructuredExtractedFilter

以結構化形式呈現從輸入查詢擷取的篩選條件。

JSON 表示法 
{
  "expression": {
    object (Expression)
  }
}
欄位
expression

object (Expression)

以結構化形式表示從輸入查詢中提取的過濾器的表達式。它可以是表示單一字串、數值或地理位置約束的簡單表達式，也可以是使用邏輯（或和）運算子連接的多個表達式的組合的複合表達式。

運算式

表示從輸入查詢擷取的篩選條件運算式。

JSON 表示法 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringConstraint": {
    object (StringConstraint)
  },
  "numberConstraint": {
    object (NumberConstraint)
  },
  "geolocationConstraint": {
    object (GeolocationConstraint)
  },
  "andExpr": {
    object (AndExpression)
  },
  "orExpr": {
    object (OrExpression)
  }
  // End of mutually exclusive fields.
}
欄位
運算式類型。以下列出互斥的欄位。回應中最多只會設定一個欄位：
stringConstraint

object (StringConstraint)

字串限制運算式。
numberConstraint

object (NumberConstraint)

數值限制運算式。
geolocationConstraint

object (GeolocationConstraint)

地理位置限制運算式。
andExpr

object (AndExpression)

邏輯「And」複合運算子，可連結多個運算式。
orExpr

object (OrExpression)

邏輯「Or」複合運算子，可連結多個運算式。
互斥欄位的結尾。

StringConstraint

字串欄位的限制運算式。

JSON 表示法 
{
  "fieldName": string,
  "values": [
    string
  ],
  "querySegment": string
}
欄位
fieldName

string

結構定義中定義的字串欄位名稱。
values[]

string

字串欄位的值。只有在欄位值與此處指定的值相符時，系統才會傳回記錄。
querySegment

string

找出搜尋查詢中符合篩選條件的關鍵字。

NumberConstraint

數字欄位的限制運算式。例如：price < 100。

JSON 表示法 
{
  "fieldName": string,
  "comparison": enum (Comparison),
  "value": number,
  "querySegment": string
}
欄位
fieldName

string

結構定義中定義的數值欄位名稱。
comparison

enum (Comparison)

在欄位值和限制中指定的值之間執行的比較作業。
value

number

數值限制中指定的值。
querySegment

string

找出搜尋查詢中符合篩選條件的關鍵字。

比較

執行的比較作業。

列舉
COMPARISON_UNSPECIFIED 未定義的比較運算子。
EQUALS 表示等號 = 運算子。
LESS_THAN_EQUALS 表示小於或等於 <= 運算子。
LESS_THAN 表示「小於」< 運算子。
GREATER_THAN_EQUALS 表示大於或等於 >= 運算子。
GREATER_THAN 表示大於 > 運算子。

GeolocationConstraint

地理位置欄位的限制。地理位置欄位的名稱，如結構定義中所定義。

JSON 表示法 
{
  "fieldName": string,
  "address": string,
  "latitude": number,
  "longitude": number,
  "radiusInMeters": number
}
欄位
fieldName

string

結構定義中定義的地理位置欄位名稱。
address

string

系統從輸入查詢推斷出的參考地址。系統會根據參照地址與地理位置欄位的鄰近程度，篩選結果。
latitude

number

從輸入查詢推斷出的地理位置緯度。
longitude

number

從輸入查詢推斷出的地理位置經度。
radiusInMeters

number

地址周圍的半徑 (以公尺為單位)。如果地理位置欄位的位置在半徑範圍內，系統就會傳回記錄。

AndExpression

邏輯 And 運算子。

JSON 表示法 
{
  "expressions": [
    {
      object (Expression)
    }
  ]
}
欄位
expressions[]

object (Expression)

以 AND 運算子連結的運算式。

OrExpression

邏輯 Or 運算子。

JSON 表示法 
{
  "expressions": [
    {
      object (Expression)
    }
  ]
}
欄位
expressions[]

object (Expression)

以 OR 運算子合併的運算式。

SessionInfo

工作階段的相關資訊。

JSON 表示法 
{
  "name": string,
  "queryId": string
}
欄位
name

string

工作階段名稱。如果使用自動工作階段模式 (SearchRequest.session 結尾為「-」)，這個欄位會保留新生成的工作階段名稱。
queryId

string

與此搜尋 API 呼叫相應的查詢 ID。一個工作階段可以有多個輪次，每個輪次都有專屬的查詢 ID。

在 Answer API 呼叫中指定工作階段名稱和這項查詢 ID，系統就會根據這項搜尋呼叫的搜尋結果生成回覆。

SemanticState

搜尋結果的語意狀態。

列舉
SEMANTIC_STATE_UNSPECIFIED 預設值。不應使用。
DISABLED 這項搜尋回覆已停用語意搜尋。
ENABLED 這項搜尋回覆已啟用語意搜尋。