Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1Assistant

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1beta/classes.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb

Overview

Discovery Engine Assistant resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1Assistant

Returns a new instance of GoogleCloudDiscoveryengineV1Assistant.



1145
1146
1147
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1145

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

Instance Attribute Details

#create_time ⇒ String

Output only. Represents the time when this Assistant was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


1078
1079
1080
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1078

def create_time
  @create_time
end

#customer_policy ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1AssistantCustomerPolicy

Customer-defined policy for the assistant. Corresponds to the JSON property customerPolicy

Returns:



1083
1084
1085
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1083

def customer_policy
  @customer_policy
end

#default_web_grounding_toggle_off ⇒ Boolean Also known as: default_web_grounding_toggle_off?

Optional. This field controls the default web grounding toggle for end users if web_grounding_type is set to WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. By default, this field is set to false. If web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled. Corresponds to the JSON property defaultWebGroundingToggleOff

Returns:

  • (Boolean) 


1095
1096
1097
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1095

def default_web_grounding_toggle_off
  @default_web_grounding_toggle_off
end

#description ⇒ String

Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant. Corresponds to the JSON property description

Returns:

  • (String) 


1102
1103
1104
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1102

def description
  @description
end

#display_name ⇒ String

Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


1108
1109
1110
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1108

def display_name
  @display_name
end

#enabled_tools ⇒ Hash<String,Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1AssistantToolList>

Optional. Note: not implemented yet. Use enabled_actions instead. The enabled tools on this assistant. The keys are connector name, for example "projects/ projectId/locations/locationId/collections/collectionId/dataconnector The values consist of admin enabled tools towards the connector instance. Admin can selectively enable multiple tools on any of the connector instances that they created in the project. For example "jira1ConnectorName": [(toolId1, " createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] Corresponds to the JSON property enabledTools

Returns:



1120
1121
1122
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1120

def enabled_tools
  @enabled_tools
end

#generation_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1AssistantGenerationConfig

Configuration for the generation of the assistant response. Corresponds to the JSON property generationConfig

Returns:



1125
1126
1127
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1125

def generation_config
  @generation_config
end

#name ⇒ String

Immutable. Resource name of the assistant. Format: projects/project/ locations/location/collections/collection/engines/engine/assistants/ assistant`It must be a UTF-8 encoded string with a length limit of 1024 characters. Corresponds to the JSON propertyname`

Returns:

  • (String) 


1133
1134
1135
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1133

def name
  @name
end

#update_time ⇒ String

Output only. Represents the time when this Assistant was most recently updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1138
1139
1140
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1138

def update_time
  @update_time
end

#web_grounding_type ⇒ String

Optional. The type of web grounding to use. Corresponds to the JSON property webGroundingType

Returns:

  • (String) 


1143
1144
1145
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1143

def web_grounding_type
  @web_grounding_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1150

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @customer_policy = args[:customer_policy] if args.key?(:customer_policy)
  @default_web_grounding_toggle_off = args[:default_web_grounding_toggle_off] if args.key?(:default_web_grounding_toggle_off)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @enabled_tools = args[:enabled_tools] if args.key?(:enabled_tools)
  @generation_config = args[:generation_config] if args.key?(:generation_config)
  @name = args[:name] if args.key?(:name)
  @update_time = args[:update_time] if args.key?(:update_time)
  @web_grounding_type = args[:web_grounding_type] if args.key?(:web_grounding_type)
end