SearchResponse

SearchService.Search メソッドに対するレスポンス メッセージ。

JSON 表現 
{
  "results": [
    {
      object (SearchResult)
    }
  ],
  "facets": [
    {
      object (Facet)
    }
  ],
  "guidedSearchResult": {
    object (GuidedSearchResult)
  },
  "totalSize": integer,
  "attributionToken": string,
  "redirectUri": string,
  "nextPageToken": string,
  "correctedQuery": string,
  "suggestedQuery": string,
  "summary": {
    object (Summary)
  },
  "appliedControls": [
    string
  ],
  "geoSearchDebugInfo": [
    {
      object (GeoSearchDebugInfo)
    }
  ],
  "queryExpansionInfo": {
    object (QueryExpansionInfo)
  },
  "naturalLanguageQueryUnderstandingInfo": {
    object (NaturalLanguageQueryUnderstandingInfo)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "oneBoxResults": [
    {
      object (OneBoxResult)
    }
  ],
  "searchLinkPromotions": [
    {
      object (SearchLinkPromotion)
    }
  ]
}
フィールド
results[]

object (SearchResult)

一致するドキュメントのリスト。順序はランキングを表します。
facets[]

object (Facet)

ユーザーがリクエストしたファセットの結果。
guidedSearchResult

object (GuidedSearchResult)

ガイド付き検索結果。
totalSize

integer

ページネーションに関係なく、一致したアイテムの推定合計数。ページネーションで返される results の数は、一致する totalSize よりも少ない場合があります。
attributionToken

string

一意の検索トークン。これは、この検索の結果として得られる UserEvent ログに含まれる必要があります。これにより、検索モデルのパフォーマンスを正確に特定できます。また、カスタマー サポートのシナリオでリクエストを特定するのにも役立ちます。
redirectUri

string

顧客が定義したリダイレクト ページの URI。リダイレクト アクションがトリガーされると、検索は実行されず、レスポンスに redirectUri と attributionToken のみが設定されます。
nextPageToken

string

次のページを取得するために SearchRequest.page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。
correctedQuery

string

スペルチェックで修正されたクエリが含まれます（見つかった場合）。スペル修正のタイプが AUTOMATIC の場合、検索結果は correctedQuery に基づきます。それ以外の場合は、元のクエリが検索に使用されます。
suggestedQuery

string

信頼度の低いクエリを修正したクエリ（「もしかして」クエリ）。correctedQuery と比較して、このフィールドは SpellCorrector がレスポンスを返したときに設定されますが、修正の信頼度が低いため（ドキュメント コーパスに元のクエリの一致があるため反転されたなど）、FPR（全ページ置換）はトリガーされません。
summary

object (Summary)

検索結果の一部としての要約。このフィールドは、SearchRequest.ContentSearchSpec.summary_spec が設定されている場合にのみ返されます。
appliedControls[]

string

Control サービスの一部として適用されるコントロール。
geoSearchDebugInfo[]

object (GeoSearchDebugInfo)
queryExpansionInfo

object (QueryExpansionInfo)

返された結果のクエリ拡張情報。
naturalLanguageQueryUnderstandingInfo

object (NaturalLanguageQueryUnderstandingInfo)

返された結果の自然言語クエリ理解情報。
sessionInfo

object (SessionInfo)

セッション情報。

SearchRequest.session が指定されている場合にのみ設定されます。詳しくは、説明をご覧ください。
oneBoxResults[]

object (OneBoxResult)

One box の結果のリスト。さまざまな種類の One box の結果が複数表示されることがあります。

ファセット

ファセット結果。

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 と一致します。

GuidedSearchResult

ガイド付き検索結果。ガイド付き検索は、検索結果を絞り込み、広範な検索結果からユーザーの実際のニーズに絞り込むのに役立ちます。

JSON 表現 
{
  "refinementAttributes": [
    {
      object (RefinementAttribute)
    }
  ],
  "followUpQuestions": [
    string
  ]
}
フィールド
refinementAttributes[]

object (RefinementAttribute)

ランク付けされた絞り込み属性のリスト。
followUpQuestions[]

string

フォローアップの質問の候補。

RefinementAttribute

検索結果の絞り込みに役立つ属性。

JSON 表現 
{
  "attributeKey": string,
  "attributeValue": string
}
フィールド
attributeKey

string

結果を絞り込むために使用される属性キー。例: "movie_type"
attributeValue

string

結果を絞り込むために使用される属性値。例: "drama"

GeoSearchDebugInfo

位置情報検索で発生したフォワード ジオコーディングの問題に固有のデバッグ情報。

JSON 表現 
{
  "originalAddressQuery": string,
  "errorMessage": string
}
フィールド
originalAddressQuery

string

フォワード ジオコーディングの取り込みで問題が発生した住所。
errorMessage

string

生成されたエラー。

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)

構造化された形式で入力クエリから抽出されたフィルタを示す式。単一の文字列、数値、位置情報の制約を示す単純な式にすることも、論理演算子（OR、AND）を使用して複数の式を組み合わせた複合式にすることもできます。

式

入力クエリから抽出されたフィルタを示す式。

JSON 表現 
{

  // Union field expr can be only one of the following:
  "stringConstraint": {
    object (StringConstraint)
  },
  "numberConstraint": {
    object (NumberConstraint)
  },
  "geolocationConstraint": {
    object (GeolocationConstraint)
  },
  "andExpr": {
    object (AndExpression)
  },
  "orExpr": {
    object (OrExpression)
  }
  // End of list of possible types for union field expr.
}
Fields
共用体フィールド expr。式のタイプ。expr は次のいずれかになります。
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。1 つのセッションに複数のターンを含めることができ、各ターンには一意のクエリ ID があります。

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

OneBoxResult

OneBoxResult は、UI で異なる方法で表示する特定のタイプの結果をすべて保持するホルダーです。

JSON 表現 
{
  "oneBoxType": enum (OneBoxType),
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
フィールド
oneBoxType

enum (OneBoxType)

One box の検索結果のタイプ。
searchResults[]

object (SearchResult)

この One ボックスの検索結果。

OneBoxType

One box の検索結果のタイプ。

列挙型
ONE_BOX_TYPE_UNSPECIFIED デフォルト値。これは使用しないでください。
PEOPLE 1 つのボックスの結果に人物の結果が含まれています。
ORGANIZATION 1 つのボックス結果には組織の検索結果が含まれます。
SLACK 1 つのボックス結果に Slack の結果が含まれています。
KNOWLEDGE_GRAPH OneBox の検索結果には、ナレッジグラフの検索レスポンスが含まれています。