Class: Google::Apis::ContactcenterinsightsV1::GoogleCloudCesV1mainToolResponse

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

Overview

The execution result of a specific tool from the client or the agent.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudCesV1mainToolResponse

Returns a new instance of GoogleCloudCesV1mainToolResponse.



394
395
396
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 394

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

Instance Attribute Details

#agent_name ⇒ String

Output only. Human-readable name of the agent that issued this call, e.g. " Contract Architect". Empty when the root agent issued it. Corresponds to the JSON property agentName

Returns:

  • (String) 


355
356
357
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 355

def agent_name
  @agent_name
end

#display_name ⇒ String

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

Returns:

  • (String) 


360
361
362
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 360

def display_name
  @display_name
end

#id ⇒ String

Optional. The matching ID of the tool call the response is for. Corresponds to the JSON property id

Returns:

  • (String) 


365
366
367
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 365

def id
  @id
end

#parent_tool_call_id ⇒ String

Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling. Corresponds to the JSON property parentToolCallId

Returns:

  • (String) 


373
374
375
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 373

def parent_tool_call_id
  @parent_tool_call_id
end

#response ⇒ Hash<String,Object>

Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If " output" and "error" keys are not specified, then whole "response" is treated as tool execution result. Corresponds to the JSON property response

Returns:

  • (Hash<String,Object>) 


381
382
383
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 381

def response
  @response
end

#tool ⇒ String

Optional. The name of the tool to execute. Format: projects/project/ locations/location/apps/app/tools/tool` Corresponds to the JSON propertytool`

Returns:

  • (String) 


387
388
389
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 387

def tool
  @tool
end

#toolset_tool ⇒ Google::Apis::ContactcenterinsightsV1::GoogleCloudCesV1mainToolsetTool

A tool that is created from a toolset. Corresponds to the JSON property toolsetTool

Returns:



392
393
394
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 392

def toolset_tool
  @toolset_tool
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



399
400
401
402
403
404
405
406
407
 
# File 'lib/google/apis/contactcenterinsights_v1/classes.rb', line 399

def update!(**args)
  @agent_name = args[:agent_name] if args.key?(:agent_name)
  @display_name = args[:display_name] if args.key?(:display_name)
  @id = args[:id] if args.key?(:id)
  @parent_tool_call_id = args[:parent_tool_call_id] if args.key?(:parent_tool_call_id)
  @response = args[:response] if args.key?(:response)
  @tool = args[:tool] if args.key?(:tool)
  @toolset_tool = args[:toolset_tool] if args.key?(:toolset_tool)
end