Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConverseConversationRequest

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaConverseConversationRequest

Returns a new instance of GoogleCloudDiscoveryengineV1alphaConverseConversationRequest.



2162
2163
2164
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2162

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#boost_spec ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec

Boost specification to boost certain documents. Corresponds to the JSON property boostSpec

Returns:



2090
2091
2092
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2090

def boost_spec
  @boost_spec
end

#conversation ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaConversation

External conversation proto definition. Corresponds to the JSON property conversation

Returns:



2095
2096
2097
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2095

def conversation
  @conversation
end

#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 Corresponds to the JSON property filter

Returns:

  • (String) 


2111
2112
2113
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2111

def filter
  @filter
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`. 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. Corresponds to the JSON propertyname`

Returns:

  • (String) 


2121
2122
2123
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2121

def name
  @name
end

#query ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaTextInput

Defines text input. Corresponds to the JSON property query

Returns:



2126
2127
2128
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2126

def query
  @query
end

#safe_search ⇒ Boolean Also known as: safe_search?

Whether to turn on safe search. Corresponds to the JSON property safeSearch

Returns:

  • (Boolean) 


2131
2132
2133
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2131

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 propertyservingConfig`

Returns:

  • (String) 


2140
2141
2142
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2140

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

Returns:



2145
2146
2147
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2145

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

Returns:

  • (Hash<String,String>) 


2160
2161
2162
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2160

def user_labels
  @user_labels
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2167

def update!(**args)
  @boost_spec = args[:boost_spec] if args.key?(:boost_spec)
  @conversation = args[:conversation] if args.key?(:conversation)
  @filter = args[:filter] if args.key?(:filter)
  @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