Interface CompleteQueryRequestOrBuilder (0.44.0) 

public interface CompleteQueryRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDataStore()

public abstract 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
Type Description
String

The dataStore.

getDataStoreBytes()

public abstract 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
Type Description
ByteString

The bytes for dataStore.

getIncludeTailSuggestions()

public abstract 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;

Returns
Type Description
boolean

The includeTailSuggestions.

getQuery()

public abstract String getQuery()

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

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

Returns
Type Description
String

The query.

getQueryBytes()

public abstract ByteString getQueryBytes()

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

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

Returns
Type Description
ByteString

The bytes for query.

getQueryModel()

public abstract String getQueryModel()

Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. 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.

string query_model = 3;

Returns
Type Description
String

The queryModel.

getQueryModelBytes()

public abstract ByteString getQueryModelBytes()

Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. 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.

string query_model = 3;

Returns
Type Description
ByteString

The bytes for queryModel.

getUserPseudoId()

public abstract 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 and 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
Type Description
String

The userPseudoId.

getUserPseudoIdBytes()

public abstract 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 and 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
Type Description
ByteString

The bytes for userPseudoId.