Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::ConverseConversationRequest.
Request message for ConversationalSearchService.ConverseConversation method.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#conversation
def conversation() -> ::Google::Cloud::DiscoveryEngine::V1beta::Conversation
Returns
- (::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::Conversation
Parameter
- value (::Google::Cloud::DiscoveryEngine::V1beta::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.
Returns
- (::Google::Cloud::DiscoveryEngine::V1beta::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.
#name
def name() -> ::String
Returns
-
(::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
Parameter
-
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.
Returns
-
(::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::V1beta::TextInput
Returns
- (::Google::Cloud::DiscoveryEngine::V1beta::TextInput) — Required. Current user input.
#query=
def query=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::TextInput
Parameter
- value (::Google::Cloud::DiscoveryEngine::V1beta::TextInput) — Required. Current user input.
Returns
- (::Google::Cloud::DiscoveryEngine::V1beta::TextInput) — Required. Current user input.
#safe_search
def safe_search() -> ::Boolean
Returns
- (::Boolean) — Whether to turn on safe search.
#safe_search=
def safe_search=(value) -> ::Boolean
Parameter
- value (::Boolean) — Whether to turn on safe search.
Returns
- (::Boolean) — Whether to turn on safe search.
#serving_config
def serving_config() -> ::String
Returns
-
(::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
Parameter
-
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.
Returns
-
(::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::V1beta::SearchRequest::ContentSearchSpec::SummarySpec
Returns
- (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec) — A specification for configuring the summary returned in the response.
#summary_spec=
def summary_spec=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec
Parameter
- value (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec) — A specification for configuring the summary returned in the response.
Returns
- (::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec) — A specification for configuring the summary returned in the response.
#user_labels
def user_labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
-
(::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}
Parameter
-
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.
Returns
-
(::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.