- 0.51.0 (latest)
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public interface AdvancedCompleteQueryRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getBoostSpec()
public abstract 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 | |
|---|---|
| Type | Description |
AdvancedCompleteQueryRequest.BoostSpec |
The boostSpec. |
getBoostSpecOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
AdvancedCompleteQueryRequest.BoostSpecOrBuilder |
|
getCompletionConfig()
public abstract 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 | |
|---|---|
| Type | Description |
String |
The completionConfig. |
getCompletionConfigBytes()
public abstract 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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for completionConfig. |
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.
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 | |
|---|---|
| Type | Description |
String |
The query. |
getQueryBytes()
public abstract 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 | |
|---|---|
| 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:
documentis the default model for regular dataStores.search-historyis 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:
documentis the default model for regular dataStores.search-historyis the default model for site search dataStores.
string query_model = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for queryModel. |
getSuggestionTypes(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
AdvancedCompleteQueryRequest.SuggestionType |
The suggestionTypes at the given index. |
getSuggestionTypesCount()
public abstract 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 | |
|---|---|
| Type | Description |
int |
The count of suggestionTypes. |
getSuggestionTypesList()
public abstract 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 | |
|---|---|
| Type | Description |
List<SuggestionType> |
A list containing the suggestionTypes. |
getSuggestionTypesValue(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire of suggestionTypes at the given index. |
getSuggestionTypesValueList()
public abstract 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 | |
|---|---|
| Type | Description |
List<Integer> |
A list containing the enum numeric values on the wire for suggestionTypes. |
getUserInfo()
public abstract UserInfo getUserInfo()Optional. Information about the end user.
This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.
.google.cloud.discoveryengine.v1beta.UserInfo user_info = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
UserInfo |
The userInfo. |
getUserInfoOrBuilder()
public abstract UserInfoOrBuilder getUserInfoOrBuilder()Optional. Information about the end user.
This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.
.google.cloud.discoveryengine.v1beta.UserInfo user_info = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
UserInfoOrBuilder |
|
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
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
string user_pseudo_id = 4;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for userPseudoId. |
hasBoostSpec()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
Whether the boostSpec field is set. |
hasUserInfo()
public abstract boolean hasUserInfo()Optional. Information about the end user.
This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info.
.google.cloud.discoveryengine.v1beta.UserInfo user_info = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the userInfo field is set. |