Class: Google::Apis::CesV1::ExecuteToolResponse

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

Overview

Response message for ToolService.ExecuteTool.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ExecuteToolResponse

Returns a new instance of ExecuteToolResponse.



3371
3372
3373
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3371

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

Instance Attribute Details

#citations ⇒ Google::Apis::CesV1::Citations

Citations associated with the agent response. Corresponds to the JSON property citations

Returns:



3340
3341
3342
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3340

def citations
  @citations
end

#google_search_suggestions ⇒ Google::Apis::CesV1::GoogleSearchSuggestions

Search suggestions from Google Search Tool. Corresponds to the JSON property googleSearchSuggestions

Returns:



3345
3346
3347
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3345

def google_search_suggestions
  @google_search_suggestions
end

#response ⇒ Hash<String,Object>

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>) 


3353
3354
3355
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3353

def response
  @response
end

#tool ⇒ String

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

Returns:

  • (String) 


3359
3360
3361
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3359

def tool
  @tool
end

#toolset_tool ⇒ Google::Apis::CesV1::ToolsetTool

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

Returns:



3364
3365
3366
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3364

def toolset_tool
  @toolset_tool
end

#variables ⇒ Hash<String,Object>

The variable values at the end of the tool execution. Corresponds to the JSON property variables

Returns:

  • (Hash<String,Object>) 


3369
3370
3371
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3369

def variables
  @variables
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3376
3377
3378
3379
3380
3381
3382
3383
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3376

def update!(**args)
  @citations = args[:citations] if args.key?(:citations)
  @google_search_suggestions = args[:google_search_suggestions] if args.key?(:google_search_suggestions)
  @response = args[:response] if args.key?(:response)
  @tool = args[:tool] if args.key?(:tool)
  @toolset_tool = args[:toolset_tool] if args.key?(:toolset_tool)
  @variables = args[:variables] if args.key?(:variables)
end