Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationRequest
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationRequest
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/discoveryengine_v1alpha/classes.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb,
lib/google/apis/discoveryengine_v1alpha/representations.rb
Overview
Request message for ConversationalSearchService.ConverseConversation method.
Instance Attribute Summary collapse
-
#conversation ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation
External conversation proto definition.
-
#name ⇒ String
Required.
-
#query ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTextInput
Defines text input.
-
#safe_search ⇒ Boolean
(also: #safe_search?)
Whether to turn on safe search.
-
#serving_config ⇒ String
The resource name of the Serving Config to use.
-
#summary_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec
A specification for configuring a summary returned in a search response.
-
#user_labels ⇒ Hash<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.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaConverseConversationRequest
constructor
A new instance of GoogleCloudDiscoveryengineV1alphaConverseConversationRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaConverseConversationRequest
Returns a new instance of GoogleCloudDiscoveryengineV1alphaConverseConversationRequest.
1045 1046 1047 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1045 def initialize(**args) update!(**args) end |
Instance Attribute Details
#conversation ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation
External conversation proto definition.
Corresponds to the JSON property conversation
994 995 996 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 994 def conversation @conversation end |
#name ⇒ 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`. 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.
Corresponds to the JSON property
name`
1004 1005 1006 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1004 def name @name end |
#query ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTextInput
Defines text input.
Corresponds to the JSON property query
1009 1010 1011 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1009 def query @query end |
#safe_search ⇒ Boolean Also known as: safe_search?
Whether to turn on safe search.
Corresponds to the JSON property safeSearch
1014 1015 1016 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1014 def safe_search @safe_search end |
#serving_config ⇒ 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.
Corresponds to the JSON property
servingConfig`
1023 1024 1025 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1023 def serving_config @serving_config end |
#summary_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec
A specification for configuring a summary returned in a search response.
Corresponds to the JSON property summarySpec
1028 1029 1030 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1028 def summary_spec @summary_spec end |
#user_labels ⇒ Hash<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.
Corresponds to the JSON property userLabels
1043 1044 1045 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1043 def user_labels @user_labels end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1050 1051 1052 1053 1054 1055 1056 1057 1058 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 1050 def update!(**args) @conversation = args[:conversation] if args.key?(:conversation) @name = args[:name] if args.key?(:name) @query = args[:query] if args.key?(:query) @safe_search = args[:safe_search] if args.key?(:safe_search) @serving_config = args[:serving_config] if args.key?(:serving_config) @summary_spec = args[:summary_spec] if args.key?(:summary_spec) @user_labels = args[:user_labels] if args.key?(:user_labels) end |