AdvancedCompleteQueryResponse

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

JSON 表現 
{
  "querySuggestions": [
    {
      object (QuerySuggestion)
    }
  ],
  "tailMatchTriggered": boolean,
  "peopleSuggestions": [
    {
      object (PersonSuggestion)
    }
  ],
  "contentSuggestions": [
    {
      object (ContentSuggestion)
    }
  ],
  "recentSearchSuggestions": [
    {
      object (RecentSearchSuggestion)
    }
  ]
}
フィールド
querySuggestions[]

object (QuerySuggestion)

一致したクエリ候補の結果。結果リストが並べ替えられ、最初の結果が上位の候補になります。
tailMatchTriggered

boolean

返された候補がすべて後方一致候補である場合は True。

後方一致をトリガーするには、リクエストの includeTailSuggestions が true であり、かつクエリ全体と一致する候補が存在しないことが必要です。
peopleSuggestions[]

object (PersonSuggestion)

一致した人物の候補の結果。結果リストは並べ替えられ、最初の結果が上位の候補になります。
contentSuggestions[]

object (ContentSuggestion)

一致したコンテンツの候補の結果。結果リストは並べ替えられ、最初の結果が上位の候補になります。
recentSearchSuggestions[]

object (RecentSearchSuggestion)

一致した「最近の検索」候補の結果。結果リストは並べ替えられ、最初の結果が上位の候補になります。

QuerySuggestion

検索クエリとしての候補。

JSON 表現 
{
  "suggestion": string,
  "completableFieldPaths": [
    string
  ],
  "dataStore": [
    string
  ],
  "score": number
}
フィールド
suggestion

string

クエリへの候補。
completableFieldPaths[]

string

完成可能なフィールドから生成された場合にこの候補のソースとなる一意のドキュメント フィールド パス。

このフィールドは、ドキュメント完成可能なモデルに対してのみ入力されます。
dataStore[]

string

この候補が属する dataStore の名前。
score

number

各候補のスコア。スコアの範囲は [0, 1] です。

PersonSuggestion

人物の候補。

JSON 表現 
{
  "suggestion": string,
  "personType": enum (PersonType),
  "document": {
    object (Document)
  },
  "dataStore": string,
  "score": number,
  "displayPhotoUri": string,
  "destinationUri": string
}
フィールド
suggestion

string

クエリへの候補。
personType

enum (PersonType)

人物のタイプ。
document

object (Document)

候補内のドキュメント データ スニペット。フィールドのサブセットのみが入力されます。
dataStore

string

この候補が属する dataStore の名前。
score

number

各候補のスコア。スコアの範囲は [0, 1] です。
displayPhotoUri

string

人物候補の写真の URI。
destinationUri

string

人物候補の宛先の URI。

PersonType

ソースに基づく人物のタイプ。

列挙型
PERSON_TYPE_UNSPECIFIED デフォルト値。
CLOUD_IDENTITY 候補は GOOGLE_IDENTITY ソースからのものです。
THIRD_PARTY_IDENTITY 候補は THIRD_PARTY_IDENTITY ソースからのものです。

ContentSuggestion

コンテンツとしての候補。

JSON 表現 
{
  "suggestion": string,
  "contentType": enum (ContentType),
  "document": {
    object (Document)
  },
  "dataStore": string,
  "score": number,
  "iconUri": string,
  "destinationUri": string
}
フィールド
suggestion

string

クエリへの候補。
contentType

enum (ContentType)

コンテンツ候補のタイプ。
document

object (Document)

候補内のドキュメント データ スニペット。入力されるのはフィールドのサブセットのみです。
dataStore

string

この候補が属する dataStore の名前。
score

number

各候補のスコア。スコアの範囲は [0, 1] です。
iconUri

string

コンテンツ候補のアイコンの URI。
destinationUri

string

コンテンツ候補の宛先の URI。

ContentType

コンテンツ候補に対して返されるコンテンツのタイプ。

列挙型
CONTENT_TYPE_UNSPECIFIED デフォルト値。
GOOGLE_WORKSPACE 候補は Google Workspace のソースからのものです。
THIRD_PARTY 候補がサードパーティのソースからのものです。

RecentSearchSuggestion

最近の検索履歴に基づく候補。

JSON 表現 
{
  "suggestion": string,
  "recentSearchTime": string,
  "score": number
}
フィールド
suggestion

string

クエリへの候補。
recentSearchTime

string (Timestamp format)

最近の検索が行われた時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
score

number

各候補のスコア。スコアの範囲は [0, 1] です。