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

値の名前とその数を含むファセット値。

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_value は次のいずれかになります。
value

string

ファセットのテキスト値（ファセット colors の Black など）。
interval

object (Interval)

ファセットのインターバル値（ファセット price の [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。1 つのセッションに複数のターンを含めることができ、各ターンに一意のクエリ ID が割り当てられます。

Answer API 呼び出しでセッション名とこのクエリ ID を指定すると、この検索呼び出しの検索結果のコンテキストで回答が生成されます。