Interface ConverseConversationRequestOrBuilder (0.42.0) 

public interface ConverseConversationRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsUserLabels(String key)

public abstract 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 abstract 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.v1alpha.SearchRequest.BoostSpec boost_spec = 10;

Returns
Type Description
SearchRequest.BoostSpec

The boostSpec.

getBoostSpecOrBuilder()

public abstract 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.v1alpha.SearchRequest.BoostSpec boost_spec = 10;

Returns
Type Description
SearchRequest.BoostSpecOrBuilder

getConversation()

public abstract 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.v1alpha.Conversation conversation = 5;

Returns
Type Description
Conversation

The conversation.

getConversationOrBuilder()

public abstract 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.v1alpha.Conversation conversation = 5;

Returns
Type Description
ConversationOrBuilder

getFilter()

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

getName()

public abstract 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 abstract 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 abstract TextInput getQuery()

Required. Current user input.

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

Returns
Type Description
TextInput

The query.

getQueryOrBuilder()

public abstract TextInputOrBuilder getQueryOrBuilder()

Required. Current user input.

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

Returns
Type Description
TextInputOrBuilder

getSafeSearch()

public abstract boolean getSafeSearch()

Whether to turn on safe search.

bool safe_search = 6;

Returns
Type Description
boolean

The safeSearch.

getServingConfig()

public abstract 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 abstract 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 abstract SearchRequest.ContentSearchSpec.SummarySpec getSummarySpec()

A specification for configuring the summary returned in the response.

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

Returns
Type Description
SearchRequest.ContentSearchSpec.SummarySpec

The summarySpec.

getSummarySpecOrBuilder()

public abstract SearchRequest.ContentSearchSpec.SummarySpecOrBuilder getSummarySpecOrBuilder()

A specification for configuring the summary returned in the response.

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

Returns
Type Description
SearchRequest.ContentSearchSpec.SummarySpecOrBuilder

getUserLabels() (deprecated)

public abstract Map<String,String> getUserLabels()

Use #getUserLabelsMap() instead.

Returns
Type Description
Map<String,String>

getUserLabelsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.v1alpha.SearchRequest.BoostSpec boost_spec = 10;

Returns
Type Description
boolean

Whether the boostSpec field is set.

hasConversation()

public abstract 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.v1alpha.Conversation conversation = 5;

Returns
Type Description
boolean

Whether the conversation field is set.

hasQuery()

public abstract boolean hasQuery()

Required. Current user input.

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

Returns
Type Description
boolean

Whether the query field is set.

hasSummarySpec()

public abstract boolean hasSummarySpec()

A specification for configuring the summary returned in the response.

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

Returns
Type Description
boolean

Whether the summarySpec field is set.