Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::ConverseConversationRequest.
Request message for ConversationalSearchService.ConverseConversation method.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#boost_spec
def boost_spec() -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec
- (::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec) — Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see Boosting
#boost_spec=
def boost_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec
- value (::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec) — 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::V1::SearchRequest::BoostSpec) — Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see Boosting
#conversation
def conversation() -> ::Google::Cloud::DiscoveryEngine::V1::Conversation
- (::Google::Cloud::DiscoveryEngine::V1::Conversation) — 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.
#conversation=
def conversation=(value) -> ::Google::Cloud::DiscoveryEngine::V1::Conversation
- value (::Google::Cloud::DiscoveryEngine::V1::Conversation) — 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::V1::Conversation) — 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.
#filter
def filter() -> ::String
-
(::String) — 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
#filter=
def filter=(value) -> ::String
-
value (::String) — 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) — 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
#name
def name() -> ::String
-
(::String) — 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}
. Useprojects/{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.
#name=
def name=(value) -> ::String
-
value (::String) — 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}
. Useprojects/{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) — 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}
. Useprojects/{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.
#query
def query() -> ::Google::Cloud::DiscoveryEngine::V1::TextInput
- (::Google::Cloud::DiscoveryEngine::V1::TextInput) — Required. Current user input.
#query=
def query=(value) -> ::Google::Cloud::DiscoveryEngine::V1::TextInput
- value (::Google::Cloud::DiscoveryEngine::V1::TextInput) — Required. Current user input.
- (::Google::Cloud::DiscoveryEngine::V1::TextInput) — Required. Current user input.
#safe_search
def safe_search() -> ::Boolean
- (::Boolean) — Whether to turn on safe search.
#safe_search=
def safe_search=(value) -> ::Boolean
- value (::Boolean) — Whether to turn on safe search.
- (::Boolean) — Whether to turn on safe search.
#serving_config
def serving_config() -> ::String
-
(::String) — 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.
#serving_config=
def serving_config=(value) -> ::String
-
value (::String) — 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) — 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.
#summary_spec
def summary_spec() -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec
- (::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec) — A specification for configuring the summary returned in the response.
#summary_spec=
def summary_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec
- value (::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec) — A specification for configuring the summary returned in the response.
- (::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec) — A specification for configuring the summary returned in the response.
#user_labels
def user_labels() -> ::Google::Protobuf::Map{::String => ::String}
-
(::Google::Protobuf::Map{::String => ::String}) — 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.
#user_labels=
def user_labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
-
value (::Google::Protobuf::Map{::String => ::String}) — 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.
-
(::Google::Protobuf::Map{::String => ::String}) — 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.