This preview documentation is deprecated as of October 27, 2023. For GA documentation, go to the Vertex AI Search documentation.

Changes in GA:

Name: Discovery for Media is renamed to Vertex AI Search for media. Vertex AI Search includes media recommendations and media search.
Google Cloud Console page: Use the Agent Builder page in the console. The Discovery Engine console page is deprecated.
API reference: Continue to use the discoveryengine.googleapis.com service. The API remains the same but the documentation has moved. Go to the up-to-date, GA version of the Discovery Engine API reference in the Vertex AI Search documentation.
All changes: To see what else changed between preview and GA, see Switch from Discovery for Media to media recommendations in the Vertex AI Search documentation.

CompleteQueryResponse

JSON representation
{ "querySuggestions": [ { object (`QuerySuggestion`) } ], "tailMatchTriggered": boolean }

Fields

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.

querySuggestions[]

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.

QuerySuggestion

Suggestions as search queries.

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

Fields

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.

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.