public final class ConverseConversationRequest extends GeneratedMessageV3 implements ConverseConversationRequestOrBuilder
Request message for
ConversationalSearchService.ConverseConversation
method.
Protobuf type google.cloud.discoveryengine.v1alpha.ConverseConversationRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ConverseConversationRequest.Builder newBuilder()
newBuilder(ConverseConversationRequest prototype)
public static ConverseConversationRequest.Builder newBuilder(ConverseConversationRequest prototype)
public static ConverseConversationRequest parseDelimitedFrom(InputStream input)
public static ConverseConversationRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ConverseConversationRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ConverseConversationRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ConverseConversationRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ConverseConversationRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ConverseConversationRequest parseFrom(CodedInputStream input)
public static ConverseConversationRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ConverseConversationRequest parseFrom(InputStream input)
public static ConverseConversationRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ConverseConversationRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ConverseConversationRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ConverseConversationRequest> parser()
Methods
containsUserLabels(String key)
public boolean containsUserLabels(String key)
The user labels applied to a resource must meet the following requirements:
map<string, string> user_labels = 7;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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;
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;
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;
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;
getDefaultInstanceForType()
public ConverseConversationRequest getDefaultInstanceForType()
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()
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()
Overrides
getQuery()
public TextInput getQuery()
Required. Current user input.
.google.cloud.discoveryengine.v1alpha.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];
getQueryOrBuilder()
public TextInputOrBuilder getQueryOrBuilder()
Required. Current user input.
.google.cloud.discoveryengine.v1alpha.TextInput query = 2 [(.google.api.field_behavior) = REQUIRED];
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;
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;
getUserLabels() (deprecated)
public Map<String,String> getUserLabels()
getUserLabelsCount()
public int getUserLabelsCount()
The user labels applied to a resource must meet the following requirements:
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:
map<string, string> user_labels = 7;
getUserLabelsOrDefault(String key, String defaultValue)
public String getUserLabelsOrDefault(String key, String defaultValue)
The user labels applied to a resource must meet the following requirements:
map<string, string> user_labels = 7;
getUserLabelsOrThrow(String key)
public String getUserLabelsOrThrow(String key)
The user labels applied to a resource must meet the following requirements:
map<string, string> user_labels = 7;
| Parameter |
|---|
| Name | Description |
key | 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()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
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()
Overrides
newBuilderForType()
public ConverseConversationRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ConverseConversationRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public ConverseConversationRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
