Class ConverseConversationRequest.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<ConverseConversationRequest.Builder>
com.google.cloud.discoveryengine.v1beta.ConverseConversationRequest.Builder
- All Implemented Interfaces:
ConverseConversationRequestOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- ConverseConversationRequest
public static final class ConverseConversationRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<ConverseConversationRequest.Builder>
implements ConverseConversationRequestOrBuilder
Request message for [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1beta.ConversationalSearchService.ConverseConversation] method.Protobuf type
google.cloud.discoveryengine.v1beta.ConverseConversationRequest-
Method Summary
Modifier and TypeMethodDescriptionbuild()clear()Boost specification to boost certain documents in search results which may affect the converse response.The conversation to be used by auto session only.The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.Required.Required.Whether to turn on safe search.The resource name of the Serving Config to use.A specification for configuring the summary returned in the response.booleancontainsUserLabels(String key) The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64Boost specification to boost certain documents in search results which may affect the converse response.Boost specification to boost certain documents in search results which may affect the converse response.Boost specification to boost certain documents in search results which may affect the converse response.The conversation to be used by auto session only.The conversation to be used by auto session only.The conversation to be used by auto session only.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorThe filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.com.google.protobuf.ByteStringThe filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.Deprecated.getName()Required.com.google.protobuf.ByteStringRequired.getQuery()Required.Required.Required.booleanWhether to turn on safe search.The resource name of the Serving Config to use.com.google.protobuf.ByteStringThe resource name of the Serving Config to use.A specification for configuring the summary returned in the response.A specification for configuring the summary returned in the response.A specification for configuring the summary returned in the response.Deprecated.intThe user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64getUserLabelsOrDefault(String key, String defaultValue) The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64booleanBoost specification to boost certain documents in search results which may affect the converse response.booleanThe conversation to be used by auto session only.booleanhasQuery()Required.booleanA specification for configuring the summary returned in the response.protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) protected com.google.protobuf.MapFieldReflectionAccessorinternalGetMutableMapFieldReflection(int number) final booleanBoost specification to boost certain documents in search results which may affect the converse response.mergeConversation(Conversation value) The conversation to be used by auto session only.mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeQuery(TextInput value) Required.A specification for configuring the summary returned in the response.putAllUserLabels(Map<String, String> values) The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64putUserLabels(String key, String value) The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64removeUserLabels(String key) The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64Boost specification to boost certain documents in search results which may affect the converse response.setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue) Boost specification to boost certain documents in search results which may affect the converse response.setConversation(Conversation value) The conversation to be used by auto session only.setConversation(Conversation.Builder builderForValue) The conversation to be used by auto session only.The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.setFilterBytes(com.google.protobuf.ByteString value) The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered.Required.setNameBytes(com.google.protobuf.ByteString value) Required.Required.setQuery(TextInput.Builder builderForValue) Required.setSafeSearch(boolean value) Whether to turn on safe search.setServingConfig(String value) The resource name of the Serving Config to use.setServingConfigBytes(com.google.protobuf.ByteString value) The resource name of the Serving Config to use.A specification for configuring the summary returned in the response.setSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec.Builder builderForValue) A specification for configuring the summary returned in the response.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage.Builder<ConverseConversationRequest.Builder>
-
internalGetMutableMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number) - Overrides:
internalGetMutableMapFieldReflectionin classcom.google.protobuf.GeneratedMessage.Builder<ConverseConversationRequest.Builder>
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage.Builder<ConverseConversationRequest.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessage.Builder<ConverseConversationRequest.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage.Builder<ConverseConversationRequest.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<ConverseConversationRequest.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage.Builder<ConverseConversationRequest.Builder>
-
mergeFrom
public ConverseConversationRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<ConverseConversationRequest.Builder>- Throws:
IOException
-
getName
Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Specified by:
getNamein interfaceConverseConversationRequestOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Specified by:
getNameBytesin interfaceConverseConversationRequestOrBuilder- Returns:
- The bytes for name.
-
setName
Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Parameters:
value- The name to set.- Returns:
- This builder for chaining.
-
clearName
Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Returns:
- This builder for chaining.
-
setNameBytes
Required. The resource name of the Conversation to get. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }- Parameters:
value- The bytes for name to set.- Returns:
- This builder for chaining.
-
hasQuery
public boolean hasQuery()Required. Current user input.
.google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];- Specified by:
hasQueryin interfaceConverseConversationRequestOrBuilder- Returns:
- Whether the query field is set.
-
getQuery
Required. Current user input.
.google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getQueryin interfaceConverseConversationRequestOrBuilder- Returns:
- The query.
-
setQuery
Required. Current user input.
.google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED]; -
setQuery
Required. Current user input.
.google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED]; -
mergeQuery
Required. Current user input.
.google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED]; -
clearQuery
Required. Current user input.
.google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED]; -
getQueryBuilder
Required. Current user input.
.google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED]; -
getQueryOrBuilder
Required. Current user input.
.google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];- Specified by:
getQueryOrBuilderin interfaceConverseConversationRequestOrBuilder
-
getServingConfig
The resource name of the Serving Config to use. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.string serving_config = 3 [(.google.api.resource_reference) = { ... }- Specified by:
getServingConfigin interfaceConverseConversationRequestOrBuilder- Returns:
- The servingConfig.
-
getServingConfigBytes
public com.google.protobuf.ByteString getServingConfigBytes()The resource name of the Serving Config to use. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.string serving_config = 3 [(.google.api.resource_reference) = { ... }- Specified by:
getServingConfigBytesin interfaceConverseConversationRequestOrBuilder- Returns:
- The bytes for servingConfig.
-
setServingConfig
The resource name of the Serving Config to use. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.string serving_config = 3 [(.google.api.resource_reference) = { ... }- Parameters:
value- The servingConfig to set.- Returns:
- This builder for chaining.
-
clearServingConfig
The resource name of the Serving Config to use. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.string serving_config = 3 [(.google.api.resource_reference) = { ... }- Returns:
- This builder for chaining.
-
setServingConfigBytes
public ConverseConversationRequest.Builder setServingConfigBytes(com.google.protobuf.ByteString value) The resource name of the Serving Config to use. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.string serving_config = 3 [(.google.api.resource_reference) = { ... }- Parameters:
value- The bytes for servingConfig to set.- Returns:
- This builder for chaining.
-
hasConversation
public boolean hasConversation()The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
.google.cloud.discoveryengine.v1beta.Conversation conversation = 5;- Specified by:
hasConversationin interfaceConverseConversationRequestOrBuilder- Returns:
- Whether the conversation field is set.
-
getConversation
The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
.google.cloud.discoveryengine.v1beta.Conversation conversation = 5;- Specified by:
getConversationin interfaceConverseConversationRequestOrBuilder- Returns:
- The conversation.
-
setConversation
The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
.google.cloud.discoveryengine.v1beta.Conversation conversation = 5; -
setConversation
The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
.google.cloud.discoveryengine.v1beta.Conversation conversation = 5; -
mergeConversation
The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
.google.cloud.discoveryengine.v1beta.Conversation conversation = 5; -
clearConversation
The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
.google.cloud.discoveryengine.v1beta.Conversation conversation = 5; -
getConversationBuilder
The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
.google.cloud.discoveryengine.v1beta.Conversation conversation = 5; -
getConversationOrBuilder
The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
.google.cloud.discoveryengine.v1beta.Conversation conversation = 5;- Specified by:
getConversationOrBuilderin interfaceConverseConversationRequestOrBuilder
-
getSafeSearch
public boolean getSafeSearch()Whether to turn on safe search.
bool safe_search = 6;- Specified by:
getSafeSearchin interfaceConverseConversationRequestOrBuilder- Returns:
- The safeSearch.
-
setSafeSearch
Whether to turn on safe search.
bool safe_search = 6;- Parameters:
value- The safeSearch to set.- Returns:
- This builder for chaining.
-
clearSafeSearch
Whether to turn on safe search.
bool safe_search = 6;- Returns:
- This builder for chaining.
-
getUserLabelsCount
public int getUserLabelsCount()Description copied from interface:ConverseConversationRequestOrBuilderThe user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> user_labels = 7;- Specified by:
getUserLabelsCountin interfaceConverseConversationRequestOrBuilder
-
containsUserLabels
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> user_labels = 7;- Specified by:
containsUserLabelsin interfaceConverseConversationRequestOrBuilder
-
getUserLabels
Deprecated.UsegetUserLabelsMap()instead.- Specified by:
getUserLabelsin interfaceConverseConversationRequestOrBuilder
-
getUserLabelsMap
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> user_labels = 7;- Specified by:
getUserLabelsMapin interfaceConverseConversationRequestOrBuilder
-
getUserLabelsOrDefault
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> user_labels = 7;- Specified by:
getUserLabelsOrDefaultin interfaceConverseConversationRequestOrBuilder
-
getUserLabelsOrThrow
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> user_labels = 7;- Specified by:
getUserLabelsOrThrowin interfaceConverseConversationRequestOrBuilder
-
clearUserLabels
-
removeUserLabels
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> user_labels = 7; -
getMutableUserLabels
Deprecated.Use alternate mutation accessors instead. -
putUserLabels
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> user_labels = 7; -
putAllUserLabels
The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
map<string, string> user_labels = 7; -
hasSummarySpec
public boolean hasSummarySpec()A specification for configuring the summary returned in the response.
.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;- Specified by:
hasSummarySpecin interfaceConverseConversationRequestOrBuilder- Returns:
- Whether the summarySpec field is set.
-
getSummarySpec
A specification for configuring the summary returned in the response.
.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;- Specified by:
getSummarySpecin interfaceConverseConversationRequestOrBuilder- Returns:
- The summarySpec.
-
setSummarySpec
public ConverseConversationRequest.Builder setSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec value) A specification for configuring the summary returned in the response.
.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8; -
setSummarySpec
public ConverseConversationRequest.Builder setSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec.Builder builderForValue) A specification for configuring the summary returned in the response.
.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8; -
mergeSummarySpec
public ConverseConversationRequest.Builder mergeSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec value) A specification for configuring the summary returned in the response.
.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8; -
clearSummarySpec
A specification for configuring the summary returned in the response.
.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8; -
getSummarySpecBuilder
A specification for configuring the summary returned in the response.
.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8; -
getSummarySpecOrBuilder
A specification for configuring the summary returned in the response.
.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;- Specified by:
getSummarySpecOrBuilderin interfaceConverseConversationRequestOrBuilder
-
getFilter
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)string filter = 9;- Specified by:
getFilterin interfaceConverseConversationRequestOrBuilder- Returns:
- The filter.
-
getFilterBytes
public com.google.protobuf.ByteString getFilterBytes()The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)string filter = 9;- Specified by:
getFilterBytesin interfaceConverseConversationRequestOrBuilder- Returns:
- The bytes for filter.
-
setFilter
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)string filter = 9;- Parameters:
value- The filter to set.- Returns:
- This builder for chaining.
-
clearFilter
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)string filter = 9;- Returns:
- This builder for chaining.
-
setFilterBytes
The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)string filter = 9;- Parameters:
value- The bytes for filter to set.- Returns:
- This builder for chaining.
-
hasBoostSpec
public boolean hasBoostSpec()Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;- Specified by:
hasBoostSpecin interfaceConverseConversationRequestOrBuilder- Returns:
- Whether the boostSpec field is set.
-
getBoostSpec
Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;- Specified by:
getBoostSpecin interfaceConverseConversationRequestOrBuilder- Returns:
- The boostSpec.
-
setBoostSpec
Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10; -
setBoostSpec
public ConverseConversationRequest.Builder setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue) Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10; -
mergeBoostSpec
Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10; -
clearBoostSpec
Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10; -
getBoostSpecBuilder
Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10; -
getBoostSpecOrBuilder
Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;- Specified by:
getBoostSpecOrBuilderin interfaceConverseConversationRequestOrBuilder
-