Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolUse

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

Overview

Stores metadata of the invocation of an action supported by a tool.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1ToolUse

Returns a new instance of GoogleCloudDialogflowCxV3beta1ToolUse.



14976
14977
14978
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14976

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

Instance Attribute Details

#action ⇒ String

Optional. Name of the action to be called during the tool use. Corresponds to the JSON property action

Returns:

  • (String) 


14943
14944
14945
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14943

def action
  @action
end

#data_store_tool_trace ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolUseDataStoreToolTrace

The tracing information for the data store tool. Corresponds to the JSON property dataStoreToolTrace

Returns:



14948
14949
14950
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14948

def data_store_tool_trace
  @data_store_tool_trace
end

#display_name ⇒ String

Output only. The display name of the tool. Corresponds to the JSON property displayName

Returns:

  • (String) 


14953
14954
14955
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14953

def display_name
  @display_name
end

#input_action_parameters ⇒ Hash<String,Object>

Optional. A list of input parameters for the action. Corresponds to the JSON property inputActionParameters

Returns:

  • (Hash<String,Object>) 


14958
14959
14960
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14958

def input_action_parameters
  @input_action_parameters
end

#output_action_parameters ⇒ Hash<String,Object>

Optional. A list of output parameters generated by the action. Corresponds to the JSON property outputActionParameters

Returns:

  • (Hash<String,Object>) 


14963
14964
14965
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14963

def output_action_parameters
  @output_action_parameters
end

#tool ⇒ String

Required. The tool that should be used. Format: projects//locations//agents// tools/. Corresponds to the JSON property tool

Returns:

  • (String) 


14969
14970
14971
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14969

def tool
  @tool
end

#webhook_tool_trace ⇒ Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1ToolUseWebhookToolTrace

The tracing information for the webhook tool. Corresponds to the JSON property webhookToolTrace

Returns:



14974
14975
14976
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14974

def webhook_tool_trace
  @webhook_tool_trace
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



14981
14982
14983
14984
14985
14986
14987
14988
14989
 
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 14981

def update!(**args)
  @action = args[:action] if args.key?(:action)
  @data_store_tool_trace = args[:data_store_tool_trace] if args.key?(:data_store_tool_trace)
  @display_name = args[:display_name] if args.key?(:display_name)
  @input_action_parameters = args[:input_action_parameters] if args.key?(:input_action_parameters)
  @output_action_parameters = args[:output_action_parameters] if args.key?(:output_action_parameters)
  @tool = args[:tool] if args.key?(:tool)
  @webhook_tool_trace = args[:webhook_tool_trace] if args.key?(:webhook_tool_trace)
end