Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Tool

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

Overview

Represents a tool.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1Tool

Returns a new instance of GoogleCloudDialogflowV2beta1Tool.



23471
23472
23473
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 23471

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

Instance Attribute Details

#action_confirmation_requirement ⇒ Hash<String,String>

Optional. Confirmation requirement for the actions. Each key is an action name in the action_schemas. If an action's confirmation requirement is unspecified ( either the key is not present, or its value is CONFIRMATION_REQUIREMENT_UNSPECIFIED), the requirement is inferred from the action's method_type - confirmation is not required if and only if method_type is GET. Corresponds to the JSON property actionConfirmationRequirement

Returns:

  • (Hash<String,String>) 


23401
23402
23403
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 23401

def action_confirmation_requirement
  @action_confirmation_requirement
end

#connector_spec ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ToolConnectorTool

A ConnectorTool enabling using Integration Connectors Connections as tools. Corresponds to the JSON property connectorSpec

Returns:



23406
23407
23408
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 23406

def connector_spec
  @connector_spec
end

#create_time ⇒ String

Output only. Creation time of this tool. Corresponds to the JSON property createTime

Returns:

  • (String) 


23411
23412
23413
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 23411

def create_time
  @create_time
end

#description ⇒ String

Optional. A human readable description of the tool. Corresponds to the JSON property description

Returns:

  • (String) 


23416
23417
23418
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 23416

def description
  @description
end

#display_name ⇒ String

Optional. A human readable short name of the tool, to be shown on the UI. Corresponds to the JSON property displayName

Returns:

  • (String) 


23421
23422
23423
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 23421

def display_name
  @display_name
end

#extension_spec ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ToolExtensionTool

An ExtensionTool is a way to use Vertex Extensions as a tool. Corresponds to the JSON property extensionSpec

Returns:



23426
23427
23428
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 23426

def extension_spec
  @extension_spec
end

#function_spec ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ToolFunctionTool

A Function tool describes the functions to be invoked on the client side. Corresponds to the JSON property functionSpec

Returns:



23431
23432
23433
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 23431

def function_spec
  @function_spec
end

#name ⇒ String

Output only. Identifier. The resource name of the tool. Format: projects// locations//tools/. Corresponds to the JSON property name

Returns:

  • (String) 


23437
23438
23439
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 23437

def name
  @name
end

#open_api_spec ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1ToolOpenApiTool

An OpenAPI tool is a way to provide the Tool specifications in the Open API schema format. Corresponds to the JSON property openApiSpec

Returns:



23443
23444
23445
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 23443

def open_api_spec
  @open_api_spec
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

Output only. A read only boolean field reflecting Zone Isolation status of the tool. If the field is absent, it means the status is unknown. Corresponds to the JSON property satisfiesPzi

Returns:

  • (Boolean) 


23449
23450
23451
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 23449

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. A read only boolean field reflecting Zone Separation status of the tool. If the field is absent, it means the status is unknown. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


23456
23457
23458
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 23456

def satisfies_pzs
  @satisfies_pzs
end

#tool_key ⇒ String

Required. A human readable short name of the tool, which should be unique within the project. It should only contain letters, numbers, and underscores, and it will be used by LLM to identify the tool. Corresponds to the JSON property toolKey

Returns:

  • (String) 


23464
23465
23466
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 23464

def tool_key
  @tool_key
end

#update_time ⇒ String

Output only. Update time of this tool. Corresponds to the JSON property updateTime

Returns:

  • (String) 


23469
23470
23471
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 23469

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



23476
23477
23478
23479
23480
23481
23482
23483
23484
23485
23486
23487
23488
23489
23490
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 23476

def update!(**args)
  @action_confirmation_requirement = args[:action_confirmation_requirement] if args.key?(:action_confirmation_requirement)
  @connector_spec = args[:connector_spec] if args.key?(:connector_spec)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @extension_spec = args[:extension_spec] if args.key?(:extension_spec)
  @function_spec = args[:function_spec] if args.key?(:function_spec)
  @name = args[:name] if args.key?(:name)
  @open_api_spec = args[:open_api_spec] if args.key?(:open_api_spec)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @tool_key = args[:tool_key] if args.key?(:tool_key)
  @update_time = args[:update_time] if args.key?(:update_time)
end