com.google.cloud.discoveryengine.v1beta

Interface AdvancedCompleteQueryRequestOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

AdvancedCompleteQueryRequest, AdvancedCompleteQueryRequest.Builder

public interface AdvancedCompleteQueryRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
AdvancedCompleteQueryRequest.BoostSpec	getBoostSpec() Optional.
AdvancedCompleteQueryRequest.BoostSpecOrBuilder	getBoostSpecOrBuilder() Optional.
String	getCompletionConfig() Required.
com.google.protobuf.ByteString	getCompletionConfigBytes() 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() Specifies the autocomplete data model.
com.google.protobuf.ByteString	getQueryModelBytes() Specifies the autocomplete data model.
AdvancedCompleteQueryRequest.SuggestionType	getSuggestionTypes(int index) Optional.
int	getSuggestionTypesCount() Optional.
List<AdvancedCompleteQueryRequest.SuggestionType>	getSuggestionTypesList() Optional.
int	getSuggestionTypesValue(int index) Optional.
List<Integer>	getSuggestionTypesValueList() Optional.
UserInfo	getUserInfo() Optional.
UserInfoOrBuilder	getUserInfoOrBuilder() Optional.
String	getUserPseudoId() A unique identifier for tracking visitors.
com.google.protobuf.ByteString	getUserPseudoIdBytes() A unique identifier for tracking visitors.
boolean	hasBoostSpec() Optional.
boolean	hasUserInfo() Optional.

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

getCompletionConfig

String getCompletionConfig()

 Required. The completion_config of the parent dataStore or engine resource
 name for which the completion is performed, such as
 `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig`
 `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.
 

string completion_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The completionConfig.

getCompletionConfigBytes

com.google.protobuf.ByteString getCompletionConfigBytes()

 Required. The completion_config of the parent dataStore or engine resource
 name for which the completion is performed, such as
 `projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig`
 `projects/*/locations/global/collections/default_collection/engines/*/completionConfig`.
 

string completion_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for completionConfig.

getQuery

String getQuery()

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

 The query can not be empty for most of the suggestion types. If it is
 empty, an `INVALID_ARGUMENT` error is returned. The exception is when the
 suggestion_types contains only the type `RECENT_SEARCH`, the query can
 be an empty string. The is called "zero prefix" feature, which returns
 user's recently searched queries given the empty query.
 

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.

 The query can not be empty for most of the suggestion types. If it is
 empty, an `INVALID_ARGUMENT` error is returned. The exception is when the
 suggestion_types contains only the type `RECENT_SEARCH`, the query can
 be an empty string. The is called "zero prefix" feature, which returns
 user's recently searched queries given the empty query.
 

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

Returns:

The bytes for query.

getQueryModel

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][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 site search dataStores.
 

string query_model = 3;

Returns:

The queryModel.

getQueryModelBytes

com.google.protobuf.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][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 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.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
 

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

string user_pseudo_id = 4;

Returns:

The bytes for userPseudoId.

hasUserInfo

boolean hasUserInfo()

 Optional. Information about the end user.

 This should be the same identifier information as
 [UserEvent.user_info][google.cloud.discoveryengine.v1beta.UserEvent.user_info]
 and
 [SearchRequest.user_info][google.cloud.discoveryengine.v1beta.SearchRequest.user_info].
 

.google.cloud.discoveryengine.v1beta.UserInfo user_info = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the userInfo field is set.

getUserInfo

UserInfo getUserInfo()

 Optional. Information about the end user.

 This should be the same identifier information as
 [UserEvent.user_info][google.cloud.discoveryengine.v1beta.UserEvent.user_info]
 and
 [SearchRequest.user_info][google.cloud.discoveryengine.v1beta.SearchRequest.user_info].
 

.google.cloud.discoveryengine.v1beta.UserInfo user_info = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The userInfo.

getUserInfoOrBuilder

UserInfoOrBuilder getUserInfoOrBuilder()

 Optional. Information about the end user.

 This should be the same identifier information as
 [UserEvent.user_info][google.cloud.discoveryengine.v1beta.UserEvent.user_info]
 and
 [SearchRequest.user_info][google.cloud.discoveryengine.v1beta.SearchRequest.user_info].
 

.google.cloud.discoveryengine.v1beta.UserInfo user_info = 9 [(.google.api.field_behavior) = OPTIONAL];

getIncludeTailSuggestions

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:

The includeTailSuggestions.

hasBoostSpec

boolean hasBoostSpec()

 Optional. Specification to boost suggestions matching the condition.
 

.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the boostSpec field is set.

getBoostSpec

AdvancedCompleteQueryRequest.BoostSpec getBoostSpec()

 Optional. Specification to boost suggestions matching the condition.
 

.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The boostSpec.

getBoostSpecOrBuilder

AdvancedCompleteQueryRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()

 Optional. Specification to boost suggestions matching the condition.
 

.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];

getSuggestionTypesList

List<AdvancedCompleteQueryRequest.SuggestionType> getSuggestionTypesList()

 Optional. Suggestion types to return. If empty or unspecified, query
 suggestions are returned. Only one suggestion type is supported at the
 moment.
 

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns:

A list containing the suggestionTypes.

getSuggestionTypesCount

int getSuggestionTypesCount()

 Optional. Suggestion types to return. If empty or unspecified, query
 suggestions are returned. Only one suggestion type is supported at the
 moment.
 

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The count of suggestionTypes.

getSuggestionTypes

AdvancedCompleteQueryRequest.SuggestionType getSuggestionTypes(int index)

 Optional. Suggestion types to return. If empty or unspecified, query
 suggestions are returned. Only one suggestion type is supported at the
 moment.
 

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the element to return.

Returns:

The suggestionTypes at the given index.

getSuggestionTypesValueList

List<Integer> getSuggestionTypesValueList()

 Optional. Suggestion types to return. If empty or unspecified, query
 suggestions are returned. Only one suggestion type is supported at the
 moment.
 

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns:

A list containing the enum numeric values on the wire for suggestionTypes.

getSuggestionTypesValue

int getSuggestionTypesValue(int index)

 Optional. Suggestion types to return. If empty or unspecified, query
 suggestions are returned. Only one suggestion type is supported at the
 moment.
 

repeated .google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.SuggestionType suggestion_types = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

index - The index of the value to return.

Returns:

The enum numeric value on the wire of suggestionTypes at the given index.