com.google.cloud.discoveryengine.v1

Interface CompleteQueryRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

CompleteQueryRequest, CompleteQueryRequest.Builder

public interface CompleteQueryRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getDataStore() Required.
com.google.protobuf.ByteString	getDataStoreBytes() Required.
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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getDataStore

String 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) = { ... }

Returns:

The dataStore.

getDataStoreBytes

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) = { ... }

Returns:

The bytes for dataStore.

getQuery

String getQuery()

 Required. The typeahead input used to fetch suggestions. Maximum length is
 128 characters.
 

string query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns:

The query.

getQueryBytes

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];

Returns:

The bytes for query.

getQueryModel

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.v1.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.

 Default values:

 * `document` is the default model for regular dataStores.
 * `search-history` is the default model for
 [IndustryVertical.SITE_SEARCH][google.cloud.discoveryengine.v1.IndustryVertical.SITE_SEARCH]
 dataStores.
 

string query_model = 3;

Returns:

The queryModel.

getQueryModelBytes

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.v1.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.

 Default values:

 * `document` is the default model for regular dataStores.
 * `search-history` is the default model for
 [IndustryVertical.SITE_SEARCH][google.cloud.discoveryengine.v1.IndustryVertical.SITE_SEARCH]
 dataStores.
 

string query_model = 3;

Returns:

The bytes for queryModel.

getUserPseudoId

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.v1.UserEvent.user_pseudo_id]
 and
 [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1.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;

Returns:

The userPseudoId.

getUserPseudoIdBytes

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.v1.UserEvent.user_pseudo_id]
 and
 [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1.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;

Returns:

The bytes for userPseudoId.