public final class AdvancedCompleteQueryRequest extends com.google.protobuf.GeneratedMessageV3 implements AdvancedCompleteQueryRequestOrBuilder
Request message for [CompletionService.AdvancedCompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.AdvancedCompleteQuery] method. .Protobuf type
google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest| Modifier and Type | Class and Description |
|---|---|
static class |
AdvancedCompleteQueryRequest.BoostSpec
Specification to boost suggestions based on the condtion of the suggestion.
|
static interface |
AdvancedCompleteQueryRequest.BoostSpecOrBuilder |
static class |
AdvancedCompleteQueryRequest.Builder
Request message for
[CompletionService.AdvancedCompleteQuery][google.cloud.discoveryengine.v1beta.CompletionService.AdvancedCompleteQuery]
method.
.
|
static class |
AdvancedCompleteQueryRequest.SuggestionType
Suggestion type to return.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
BOOST_SPEC_FIELD_NUMBER |
static int |
COMPLETION_CONFIG_FIELD_NUMBER |
static int |
INCLUDE_TAIL_SUGGESTIONS_FIELD_NUMBER |
static int |
QUERY_FIELD_NUMBER |
static int |
QUERY_MODEL_FIELD_NUMBER |
static int |
SUGGESTION_TYPES_FIELD_NUMBER |
static int |
USER_INFO_FIELD_NUMBER |
static int |
USER_PSEUDO_ID_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
AdvancedCompleteQueryRequest.BoostSpec |
getBoostSpec()
Optional.
|
AdvancedCompleteQueryRequest.BoostSpecOrBuilder |
getBoostSpecOrBuilder()
Optional.
|
String |
getCompletionConfig()
Required.
|
com.google.protobuf.ByteString |
getCompletionConfigBytes()
Required.
|
static AdvancedCompleteQueryRequest |
getDefaultInstance() |
AdvancedCompleteQueryRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
boolean |
getIncludeTailSuggestions()
Indicates if tail suggestions should be returned if there are no
suggestions that match the full query.
|
com.google.protobuf.Parser<AdvancedCompleteQueryRequest> |
getParserForType() |
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.
|
int |
getSerializedSize() |
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.
|
int |
hashCode() |
boolean |
hasUserInfo()
Optional.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static AdvancedCompleteQueryRequest.Builder |
newBuilder() |
static AdvancedCompleteQueryRequest.Builder |
newBuilder(AdvancedCompleteQueryRequest prototype) |
AdvancedCompleteQueryRequest.Builder |
newBuilderForType() |
protected AdvancedCompleteQueryRequest.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static AdvancedCompleteQueryRequest |
parseDelimitedFrom(InputStream input) |
static AdvancedCompleteQueryRequest |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AdvancedCompleteQueryRequest |
parseFrom(byte[] data) |
static AdvancedCompleteQueryRequest |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AdvancedCompleteQueryRequest |
parseFrom(ByteBuffer data) |
static AdvancedCompleteQueryRequest |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AdvancedCompleteQueryRequest |
parseFrom(com.google.protobuf.ByteString data) |
static AdvancedCompleteQueryRequest |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AdvancedCompleteQueryRequest |
parseFrom(com.google.protobuf.CodedInputStream input) |
static AdvancedCompleteQueryRequest |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static AdvancedCompleteQueryRequest |
parseFrom(InputStream input) |
static AdvancedCompleteQueryRequest |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<AdvancedCompleteQueryRequest> |
parser() |
AdvancedCompleteQueryRequest.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int COMPLETION_CONFIG_FIELD_NUMBER
public static final int QUERY_FIELD_NUMBER
public static final int QUERY_MODEL_FIELD_NUMBER
public static final int USER_PSEUDO_ID_FIELD_NUMBER
public static final int USER_INFO_FIELD_NUMBER
public static final int INCLUDE_TAIL_SUGGESTIONS_FIELD_NUMBER
public static final int BOOST_SPEC_FIELD_NUMBER
public static final int SUGGESTION_TYPES_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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) = { ... }
getCompletionConfig in interface AdvancedCompleteQueryRequestOrBuilderpublic 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) = { ... }
getCompletionConfigBytes in interface AdvancedCompleteQueryRequestOrBuilderpublic 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];getQuery in interface AdvancedCompleteQueryRequestOrBuilderpublic 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];getQueryBytes in interface AdvancedCompleteQueryRequestOrBuilderpublic 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;getQueryModel in interface AdvancedCompleteQueryRequestOrBuilderpublic 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;getQueryModelBytes in interface AdvancedCompleteQueryRequestOrBuilderpublic 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;getUserPseudoId in interface AdvancedCompleteQueryRequestOrBuilderpublic 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;getUserPseudoIdBytes in interface AdvancedCompleteQueryRequestOrBuilderpublic 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];
hasUserInfo in interface AdvancedCompleteQueryRequestOrBuilderpublic 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];
getUserInfo in interface AdvancedCompleteQueryRequestOrBuilderpublic 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];
getUserInfoOrBuilder in interface AdvancedCompleteQueryRequestOrBuilderpublic 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;getIncludeTailSuggestions in interface AdvancedCompleteQueryRequestOrBuilderpublic boolean hasBoostSpec()
Optional. Specification to boost suggestions matching the condition.
.google.cloud.discoveryengine.v1beta.AdvancedCompleteQueryRequest.BoostSpec boost_spec = 6 [(.google.api.field_behavior) = OPTIONAL];
hasBoostSpec in interface AdvancedCompleteQueryRequestOrBuilderpublic 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];
getBoostSpec in interface AdvancedCompleteQueryRequestOrBuilderpublic 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];
getBoostSpecOrBuilder in interface AdvancedCompleteQueryRequestOrBuilderpublic 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];
getSuggestionTypesList in interface AdvancedCompleteQueryRequestOrBuilderpublic 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];
getSuggestionTypesCount in interface AdvancedCompleteQueryRequestOrBuilderpublic 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];
getSuggestionTypes in interface AdvancedCompleteQueryRequestOrBuilderindex - The index of the element to return.public 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];
getSuggestionTypesValueList in interface AdvancedCompleteQueryRequestOrBuilderpublic 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];
getSuggestionTypesValue in interface AdvancedCompleteQueryRequestOrBuilderindex - The index of the value to return.public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static AdvancedCompleteQueryRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AdvancedCompleteQueryRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AdvancedCompleteQueryRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AdvancedCompleteQueryRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AdvancedCompleteQueryRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AdvancedCompleteQueryRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static AdvancedCompleteQueryRequest parseFrom(InputStream input) throws IOException
IOExceptionpublic static AdvancedCompleteQueryRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static AdvancedCompleteQueryRequest parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static AdvancedCompleteQueryRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static AdvancedCompleteQueryRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static AdvancedCompleteQueryRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic AdvancedCompleteQueryRequest.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static AdvancedCompleteQueryRequest.Builder newBuilder()
public static AdvancedCompleteQueryRequest.Builder newBuilder(AdvancedCompleteQueryRequest prototype)
public AdvancedCompleteQueryRequest.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected AdvancedCompleteQueryRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static AdvancedCompleteQueryRequest getDefaultInstance()
public static com.google.protobuf.Parser<AdvancedCompleteQueryRequest> parser()
public com.google.protobuf.Parser<AdvancedCompleteQueryRequest> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public AdvancedCompleteQueryRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2025 Google LLC. All rights reserved.