Class ConverseConversationRequest.Builder (0.43.0) 

public static final class ConverseConversationRequest.Builder extends GeneratedMessageV3.Builder<ConverseConversationRequest.Builder> implements ConverseConversationRequestOrBuilder

Request message for ConversationalSearchService.ConverseConversation method.

Protobuf type google.cloud.discoveryengine.v1beta.ConverseConversationRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ConverseConversationRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ConverseConversationRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ConverseConversationRequest.Builder
Overrides

build()

public ConverseConversationRequest build()
Returns
Type Description
ConverseConversationRequest

buildPartial()

public ConverseConversationRequest buildPartial()
Returns
Type Description
ConverseConversationRequest

clear()

public ConverseConversationRequest.Builder clear()
Returns
Type Description
ConverseConversationRequest.Builder
Overrides

clearBoostSpec()

public ConverseConversationRequest.Builder clearBoostSpec()

Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;

Returns
Type Description
ConverseConversationRequest.Builder

clearConversation()

public ConverseConversationRequest.Builder 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;

Returns
Type Description
ConverseConversationRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public ConverseConversationRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ConverseConversationRequest.Builder
Overrides

clearFilter()

public ConverseConversationRequest.Builder 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

string filter = 9;

Returns
Type Description
ConverseConversationRequest.Builder

This builder for chaining.

clearName()

public ConverseConversationRequest.Builder clearName()

Required. The resource name of the Conversation to get. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}. Use projects/{project_number}/locations/{location_id}/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
Type Description
ConverseConversationRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ConverseConversationRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ConverseConversationRequest.Builder
Overrides

clearQuery()

public ConverseConversationRequest.Builder clearQuery()

Required. Current user input.

.google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ConverseConversationRequest.Builder

clearSafeSearch()

public ConverseConversationRequest.Builder clearSafeSearch()

Whether to turn on safe search.

bool safe_search = 6;

Returns
Type Description
ConverseConversationRequest.Builder

This builder for chaining.

clearServingConfig()

public ConverseConversationRequest.Builder clearServingConfig()

The resource name of the Serving Config to use. Format: projects/{project_number}/locations/{location_id}/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
Type Description
ConverseConversationRequest.Builder

This builder for chaining.

clearSummarySpec()

public ConverseConversationRequest.Builder clearSummarySpec()

A specification for configuring the summary returned in the response.

.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;

Returns
Type Description
ConverseConversationRequest.Builder

clearUserLabels()

public ConverseConversationRequest.Builder clearUserLabels()
Returns
Type Description
ConverseConversationRequest.Builder

clone()

public ConverseConversationRequest.Builder clone()
Returns
Type Description
ConverseConversationRequest.Builder
Overrides

containsUserLabels(String key)

public boolean containsUserLabels(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 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 for more details.

map<string, string> user_labels = 7;

Parameter
Name Description
key String
Returns
Type Description
boolean

getBoostSpec()

public SearchRequest.BoostSpec getBoostSpec()

Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;

Returns
Type Description
SearchRequest.BoostSpec

The boostSpec.

getBoostSpecBuilder()

public SearchRequest.BoostSpec.Builder getBoostSpecBuilder()

Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;

Returns
Type Description
SearchRequest.BoostSpec.Builder

getBoostSpecOrBuilder()

public SearchRequest.BoostSpecOrBuilder getBoostSpecOrBuilder()

Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;

Returns
Type Description
SearchRequest.BoostSpecOrBuilder

getConversation()

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

Returns
Type Description
Conversation

The conversation.

getConversationBuilder()

public Conversation.Builder 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;

Returns
Type Description
Conversation.Builder

getConversationOrBuilder()

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

Returns
Type Description
ConversationOrBuilder

getDefaultInstanceForType()

public ConverseConversationRequest getDefaultInstanceForType()
Returns
Type Description
ConverseConversationRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

public String 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

string filter = 9;

Returns
Type Description
String

The filter.

getFilterBytes()

public 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

string filter = 9;

Returns
Type Description
ByteString

The bytes for filter.

getMutableUserLabels() (deprecated)

public Map<String,String> getMutableUserLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

Required. The resource name of the Conversation to get. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}. Use projects/{project_number}/locations/{location_id}/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
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The resource name of the Conversation to get. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}. Use projects/{project_number}/locations/{location_id}/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
Type Description
ByteString

The bytes for name.

getQuery()

public TextInput getQuery()

Required. Current user input.

.google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TextInput

The query.

getQueryBuilder()

public TextInput.Builder getQueryBuilder()

Required. Current user input.

.google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TextInput.Builder

getQueryOrBuilder()

public TextInputOrBuilder getQueryOrBuilder()

Required. Current user input.

.google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
TextInputOrBuilder

getSafeSearch()

public boolean getSafeSearch()

Whether to turn on safe search.

bool safe_search = 6;

Returns
Type Description
boolean

The safeSearch.

getServingConfig()

public String getServingConfig()

The resource name of the Serving Config to use. Format: projects/{project_number}/locations/{location_id}/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
Type Description
String

The servingConfig.

getServingConfigBytes()

public ByteString getServingConfigBytes()

The resource name of the Serving Config to use. Format: projects/{project_number}/locations/{location_id}/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
Type Description
ByteString

The bytes for servingConfig.

getSummarySpec()

public SearchRequest.ContentSearchSpec.SummarySpec getSummarySpec()

A specification for configuring the summary returned in the response.

.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;

Returns
Type Description
SearchRequest.ContentSearchSpec.SummarySpec

The summarySpec.

getSummarySpecBuilder()

public SearchRequest.ContentSearchSpec.SummarySpec.Builder getSummarySpecBuilder()

A specification for configuring the summary returned in the response.

.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;

Returns
Type Description
SearchRequest.ContentSearchSpec.SummarySpec.Builder

getSummarySpecOrBuilder()

public SearchRequest.ContentSearchSpec.SummarySpecOrBuilder getSummarySpecOrBuilder()

A specification for configuring the summary returned in the response.

.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;

Returns
Type Description
SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

getUserLabels() (deprecated)

public Map<String,String> getUserLabels()

Use #getUserLabelsMap() instead.

Returns
Type Description
Map<String,String>

getUserLabelsCount()

public int getUserLabelsCount()

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 for more details.

map<string, string> user_labels = 7;

Returns
Type Description
int

getUserLabelsMap()

public Map<String,String> 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 for more details.

map<string, string> user_labels = 7;

Returns
Type Description
Map<String,String>

getUserLabelsOrDefault(String key, String defaultValue)

public String getUserLabelsOrDefault(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 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 for more details.

map<string, string> user_labels = 7;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getUserLabelsOrThrow(String key)

public String getUserLabelsOrThrow(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 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 for more details.

map<string, string> user_labels = 7;

Parameter
Name Description
key String
Returns
Type Description
String

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

.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;

Returns
Type Description
boolean

Whether the boostSpec field is set.

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;

Returns
Type Description
boolean

Whether the conversation field is set.

hasQuery()

public boolean hasQuery()

Required. Current user input.

.google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the query field is set.

hasSummarySpec()

public boolean hasSummarySpec()

A specification for configuring the summary returned in the response.

.google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;

Returns
Type Description
boolean

Whether the summarySpec field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBoostSpec(SearchRequest.BoostSpec value)

public ConverseConversationRequest.Builder mergeBoostSpec(SearchRequest.BoostSpec value)

Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;

Parameter
Name Description
value SearchRequest.BoostSpec
Returns
Type Description
ConverseConversationRequest.Builder

mergeConversation(Conversation value)

public ConverseConversationRequest.Builder mergeConversation(Conversation value)

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;

Parameter
Name Description
value Conversation
Returns
Type Description
ConverseConversationRequest.Builder

mergeFrom(ConverseConversationRequest other)

public ConverseConversationRequest.Builder mergeFrom(ConverseConversationRequest other)
Parameter
Name Description
other ConverseConversationRequest
Returns
Type Description
ConverseConversationRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ConverseConversationRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConverseConversationRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ConverseConversationRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ConverseConversationRequest.Builder
Overrides

mergeQuery(TextInput value)

public ConverseConversationRequest.Builder mergeQuery(TextInput value)

Required. Current user input.

.google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value TextInput
Returns
Type Description
ConverseConversationRequest.Builder

mergeSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec value)

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;

Parameter
Name Description
value SearchRequest.ContentSearchSpec.SummarySpec
Returns
Type Description
ConverseConversationRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ConverseConversationRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ConverseConversationRequest.Builder
Overrides

putAllUserLabels(Map<String,String> values)

public ConverseConversationRequest.Builder 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 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 for more details.

map<string, string> user_labels = 7;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
ConverseConversationRequest.Builder

putUserLabels(String key, String value)

public ConverseConversationRequest.Builder putUserLabels(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 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 for more details.

map<string, string> user_labels = 7;

Parameters
Name Description
key String
value String
Returns
Type Description
ConverseConversationRequest.Builder

removeUserLabels(String key)

public ConverseConversationRequest.Builder removeUserLabels(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 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 for more details.

map<string, string> user_labels = 7;

Parameter
Name Description
key String
Returns
Type Description
ConverseConversationRequest.Builder

setBoostSpec(SearchRequest.BoostSpec value)

public ConverseConversationRequest.Builder setBoostSpec(SearchRequest.BoostSpec value)

Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see Boosting

.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;

Parameter
Name Description
value SearchRequest.BoostSpec
Returns
Type Description
ConverseConversationRequest.Builder

setBoostSpec(SearchRequest.BoostSpec.Builder builderForValue)

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

.google.cloud.discoveryengine.v1beta.SearchRequest.BoostSpec boost_spec = 10;

Parameter
Name Description
builderForValue SearchRequest.BoostSpec.Builder
Returns
Type Description
ConverseConversationRequest.Builder

setConversation(Conversation value)

public ConverseConversationRequest.Builder setConversation(Conversation value)

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;

Parameter
Name Description
value Conversation
Returns
Type Description
ConverseConversationRequest.Builder

setConversation(Conversation.Builder builderForValue)

public ConverseConversationRequest.Builder setConversation(Conversation.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Conversation.Builder
Returns
Type Description
ConverseConversationRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ConverseConversationRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ConverseConversationRequest.Builder
Overrides

setFilter(String value)

public ConverseConversationRequest.Builder setFilter(String value)

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

string filter = 9;

Parameter
Name Description
value String

The filter to set.
Returns
Type Description
ConverseConversationRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ConverseConversationRequest.Builder setFilterBytes(ByteString value)

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

string filter = 9;

Parameter
Name Description
value ByteString

The bytes for filter to set.
Returns
Type Description
ConverseConversationRequest.Builder

This builder for chaining.

setName(String value)

public ConverseConversationRequest.Builder setName(String value)

Required. The resource name of the Conversation to get. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}. Use projects/{project_number}/locations/{location_id}/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) = { ... }

Parameter
Name Description
value String

The name to set.
Returns
Type Description
ConverseConversationRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ConverseConversationRequest.Builder setNameBytes(ByteString value)

Required. The resource name of the Conversation to get. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}. Use projects/{project_number}/locations/{location_id}/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) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
ConverseConversationRequest.Builder

This builder for chaining.

setQuery(TextInput value)

public ConverseConversationRequest.Builder setQuery(TextInput value)

Required. Current user input.

.google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value TextInput
Returns
Type Description
ConverseConversationRequest.Builder

setQuery(TextInput.Builder builderForValue)

public ConverseConversationRequest.Builder setQuery(TextInput.Builder builderForValue)

Required. Current user input.

.google.cloud.discoveryengine.v1beta.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue TextInput.Builder
Returns
Type Description
ConverseConversationRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ConverseConversationRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ConverseConversationRequest.Builder
Overrides

setSafeSearch(boolean value)

public ConverseConversationRequest.Builder setSafeSearch(boolean value)

Whether to turn on safe search.

bool safe_search = 6;

Parameter
Name Description
value boolean

The safeSearch to set.
Returns
Type Description
ConverseConversationRequest.Builder

This builder for chaining.

setServingConfig(String value)

public ConverseConversationRequest.Builder setServingConfig(String value)

The resource name of the Serving Config to use. Format: projects/{project_number}/locations/{location_id}/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) = { ... }

Parameter
Name Description
value String

The servingConfig to set.
Returns
Type Description
ConverseConversationRequest.Builder

This builder for chaining.

setServingConfigBytes(ByteString value)

public ConverseConversationRequest.Builder setServingConfigBytes(ByteString value)

The resource name of the Serving Config to use. Format: projects/{project_number}/locations/{location_id}/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) = { ... }

Parameter
Name Description
value ByteString

The bytes for servingConfig to set.
Returns
Type Description
ConverseConversationRequest.Builder

This builder for chaining.

setSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec value)

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;

Parameter
Name Description
value SearchRequest.ContentSearchSpec.SummarySpec
Returns
Type Description
ConverseConversationRequest.Builder

setSummarySpec(SearchRequest.ContentSearchSpec.SummarySpec.Builder builderForValue)

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;

Parameter
Name Description
builderForValue SearchRequest.ContentSearchSpec.SummarySpec.Builder
Returns
Type Description
ConverseConversationRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ConverseConversationRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ConverseConversationRequest.Builder
Overrides