Class ConverseConversationRequest (0.41.0)

public final class ConverseConversationRequest extends GeneratedMessageV3 implements ConverseConversationRequestOrBuilder

Request message for ConversationalSearchService.ConverseConversation method.

Protobuf type google.cloud.discoveryengine.v1alpha.ConverseConversationRequest

Static Fields

BOOST_SPEC_FIELD_NUMBER

public static final int BOOST_SPEC_FIELD_NUMBER
Field Value
Type Description
int

CONVERSATION_FIELD_NUMBER

public static final int CONVERSATION_FIELD_NUMBER
Field Value
Type Description
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
Type Description
int

SAFE_SEARCH_FIELD_NUMBER

public static final int SAFE_SEARCH_FIELD_NUMBER
Field Value
Type Description
int

SERVING_CONFIG_FIELD_NUMBER

public static final int SERVING_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

SUMMARY_SPEC_FIELD_NUMBER

public static final int SUMMARY_SPEC_FIELD_NUMBER
Field Value
Type Description
int

USER_LABELS_FIELD_NUMBER

public static final int USER_LABELS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ConverseConversationRequest getDefaultInstance()
Returns
Type Description
ConverseConversationRequest

getDescriptor()

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

newBuilder()

public static ConverseConversationRequest.Builder newBuilder()
Returns
Type Description
ConverseConversationRequest.Builder

newBuilder(ConverseConversationRequest prototype)

public static ConverseConversationRequest.Builder newBuilder(ConverseConversationRequest prototype)
Parameter
Name Description
prototype ConverseConversationRequest
Returns
Type Description
ConverseConversationRequest.Builder

parseDelimitedFrom(InputStream input)

public static ConverseConversationRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConverseConversationRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConverseConversationRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConverseConversationRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ConverseConversationRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ConverseConversationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ConverseConversationRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConverseConversationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ConverseConversationRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ConverseConversationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ConverseConversationRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConverseConversationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ConverseConversationRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ConverseConversationRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ConverseConversationRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConverseConversationRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ConverseConversationRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConverseConversationRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConverseConversationRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConverseConversationRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ConverseConversationRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ConverseConversationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ConverseConversationRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConverseConversationRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ConverseConversationRequest> parser()
Returns
Type Description
Parser<ConverseConversationRequest>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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

Returns
Type Description
SearchRequest.BoostSpec

The boostSpec.

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

Returns
Type Description
Conversation

The conversation.

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

Returns
Type Description
ConversationOrBuilder

getDefaultInstanceForType()

public ConverseConversationRequest getDefaultInstanceForType()
Returns
Type Description
ConverseConversationRequest

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.

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.

getParserForType()

public Parser<ConverseConversationRequest> getParserForType()
Returns
Type Description
Parser<ConverseConversationRequest>
Overrides

getQuery()

public 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 TextInputOrBuilder getQueryOrBuilder()

Required. Current user input.

.google.cloud.discoveryengine.v1alpha.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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.v1alpha.SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;

Returns
Type Description
SearchRequest.ContentSearchSpec.SummarySpec

The summarySpec.

getSummarySpecOrBuilder()

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

Returns
Type Description
boolean

Whether the conversation field is set.

hasQuery()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ConverseConversationRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ConverseConversationRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException