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.
Required. The parent data store resource name for which the completion is performed, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store.
Query parameters
Parameters
query
string
Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
queryModel
string
Selects data model of query suggestions for serving. Currently supported values:
document - Using suggestions generated from user-imported documents.
search-history - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API.
user-event - Using suggestions generated from user-imported search events.
document-completable - Using suggestions taken directly from user-imported document fields marked as completable.
Default values:
document is the default model for regular dataStores.
search-history is the default model for site search dataStores.
userPseudoId
string
A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website.
This field should NOT have a fixed value such as unknown_visitor.
The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
includeTailSuggestions
boolean
Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-02-13 UTC."],[[["The HTTP request to complete a query is a `GET` request to a specific URL utilizing gRPC Transcoding syntax, including a required data store path parameter."],["The `query` parameter is required to fetch suggestions, with a maximum length of 128 characters, and various models can be selected via the `queryModel` parameter."],["A unique visitor identifier, `userPseudoId`, is required for tracking and should not be a fixed value; this identifier must match that used in `UserEvent.user_pseudo_id` and `SearchRequest.user_pseudo_id`."],["The `includeTailSuggestions` parameter allows for the retrieval of tail suggestions if there are no matches to the full query, however, if there are matches, tail suggestions will not be included."],["To perform this operation, the request requires OAuth scope `https://www.googleapis.com/auth/cloud-platform` and the IAM permission `discoveryengine.dataStores.completeQuery` on the data store resource."]]],[]]
