public interface CompleteQueryRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
String |
getDataStore()
Required.
|
com.google.protobuf.ByteString |
getDataStoreBytes()
Required.
|
boolean |
getIncludeTailSuggestions()
Indicates if tail suggestions should be returned if there are no
suggestions that match the full query.
|
String |
getQuery()
Required.
|
com.google.protobuf.ByteString |
getQueryBytes()
Required.
|
String |
getQueryModel()
Selects data model of query suggestions for serving.
|
com.google.protobuf.ByteString |
getQueryModelBytes()
Selects data model of query suggestions for serving.
|
String |
getUserPseudoId()
A unique identifier for tracking visitors.
|
com.google.protobuf.ByteString |
getUserPseudoIdBytes()
A unique identifier for tracking visitors.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofString getDataStore()
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`.
string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
com.google.protobuf.ByteString getDataStoreBytes()
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`.
string data_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
String getQuery()
Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
string query = 2 [(.google.api.field_behavior) = REQUIRED];com.google.protobuf.ByteString getQueryBytes()
Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
string query = 2 [(.google.api.field_behavior) = REQUIRED];String getQueryModel()
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][google.cloud.discoveryengine.v1beta.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 [IndustryVertical.SITE_SEARCH][] dataStores.
string query_model = 3;com.google.protobuf.ByteString getQueryModelBytes()
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][google.cloud.discoveryengine.v1beta.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 [IndustryVertical.SITE_SEARCH][] dataStores.
string query_model = 3;String getUserPseudoId()
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`. This should be the same identifier as [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id] and [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id]. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
string user_pseudo_id = 4;com.google.protobuf.ByteString getUserPseudoIdBytes()
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`. This should be the same identifier as [UserEvent.user_pseudo_id][google.cloud.discoveryengine.v1beta.UserEvent.user_pseudo_id] and [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id]. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
string user_pseudo_id = 4;boolean getIncludeTailSuggestions()
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.
bool include_tail_suggestions = 5;Copyright © 2024 Google LLC. All rights reserved.