AdvancedCompleteQueryResponse

Response message for CompletionService.AdvancedCompleteQuery method.

JSON representation
{
  "querySuggestions": [
    {
      object (QuerySuggestion)
    }
  ],
  "tailMatchTriggered": boolean,
  "peopleSuggestions": [
    {
      object (PersonSuggestion)
    }
  ],
  "contentSuggestions": [
    {
      object (ContentSuggestion)
    }
  ],
  "recentSearchSuggestions": [
    {
      object (RecentSearchSuggestion)
    }
  ]
}
Fields
querySuggestions[]

object (QuerySuggestion)

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

tailMatchTriggered

boolean

True if the returned suggestions are all tail suggestions.

For tail matching to be triggered, includeTailSuggestions in the request must be true and there must be no suggestions that match the full query.

peopleSuggestions[]

object (PersonSuggestion)

Results of the matched people suggestions. The result list is ordered and the first result is the top suggestion.

contentSuggestions[]

object (ContentSuggestion)

Results of the matched content suggestions. The result list is ordered and the first result is the top suggestion.

recentSearchSuggestions[]

object (RecentSearchSuggestion)

Results of the matched "recent search" suggestions. The result list is ordered and the first result is the top suggestion.

QuerySuggestion

Suggestions as search queries.

JSON representation
{
  "suggestion": string,
  "completableFieldPaths": [
    string
  ],
  "dataStore": [
    string
  ]
}
Fields
suggestion

string

The suggestion for the query.

completableFieldPaths[]

string

The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.

This field is only populated for the document-completable model.

dataStore[]

string

The name of the dataStore that this suggestion belongs to.

PersonSuggestion

Suggestions as people.

JSON representation
{
  "suggestion": string,
  "personType": enum (PersonType),
  "document": {
    object (Document)
  },
  "dataStore": string
}
Fields
suggestion

string

The suggestion for the query.

personType

enum (PersonType)

The type of the person.

document

object (Document)

The document data snippet in the suggestion. Only a subset of fields is populated.

dataStore

string

The name of the dataStore that this suggestion belongs to.

PersonType

The type of the person based on the source.

Enums
PERSON_TYPE_UNSPECIFIED Default value.
CLOUD_IDENTITY The suggestion is from a GOOGLE_IDENTITY source.
THIRD_PARTY_IDENTITY The suggestion is from a THIRD_PARTY_IDENTITY source.

ContentSuggestion

Suggestions as content.

JSON representation
{
  "suggestion": string,
  "contentType": enum (ContentType),
  "document": {
    object (Document)
  },
  "dataStore": string
}
Fields
suggestion

string

The suggestion for the query.

contentType

enum (ContentType)

The type of the content suggestion.

document

object (Document)

The document data snippet in the suggestion. Only a subset of fields will be populated.

dataStore

string

The name of the dataStore that this suggestion belongs to.

ContentType

The type of the content returned for content suggestions.

Enums
CONTENT_TYPE_UNSPECIFIED Default value.
GOOGLE_WORKSPACE The suggestion is from a Google Workspace source.
THIRD_PARTY The suggestion is from a third party source.

RecentSearchSuggestion

Suggestions from recent search history.

JSON representation
{
  "suggestion": string,
  "recentSearchTime": string
}
Fields
suggestion

string

The suggestion for the query.

recentSearchTime

string (Timestamp format)

The time when this recent rearch happened.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".