Class: Google::Cloud::Ces::V1beta::ExecuteToolResponse

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/ces/v1beta/tool_service.rb

Overview

Response message for ToolService.ExecuteTool.

Instance Attribute Summary collapse

Instance Attribute Details

#citations ⇒ ::Google::Cloud::Ces::V1beta::Citations

Returns Citations that provide the source information for the tool's execution.

Returns:



98
99
100
101
 
# File 'proto_docs/google/cloud/ces/v1beta/tool_service.rb', line 98

class ExecuteToolResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#google_search_suggestions ⇒ ::Google::Cloud::Ces::V1beta::GoogleSearchSuggestions

Returns The suggestions returned from Google Search as a result of invoking the Google Search Tool during the tool execution.

Returns:



98
99
100
101
 
# File 'proto_docs/google/cloud/ces/v1beta/tool_service.rb', line 98

class ExecuteToolResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#response ⇒ ::Google::Protobuf::Struct

Returns 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.

Returns:

  • (::Google::Protobuf::Struct) —

    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.



98
99
100
101
 
# File 'proto_docs/google/cloud/ces/v1beta/tool_service.rb', line 98

class ExecuteToolResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#tool ⇒ ::String

Returns The name of the tool that got executed. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

Note: The following fields are mutually exclusive: tool, toolset_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

    The name of the tool that got executed. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

    Note: The following fields are mutually exclusive: tool, toolset_tool. If a field in that set is populated, all other fields in the set will automatically be cleared.



98
99
100
101
 
# File 'proto_docs/google/cloud/ces/v1beta/tool_service.rb', line 98

class ExecuteToolResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#toolset_tool ⇒ ::Google::Cloud::Ces::V1beta::ToolsetTool

Returns The toolset tool that got executed.

Note: The following fields are mutually exclusive: toolset_tool, tool. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::Google::Cloud::Ces::V1beta::ToolsetTool) —

    The toolset tool that got executed.

    Note: The following fields are mutually exclusive: toolset_tool, tool. If a field in that set is populated, all other fields in the set will automatically be cleared.



98
99
100
101
 
# File 'proto_docs/google/cloud/ces/v1beta/tool_service.rb', line 98

class ExecuteToolResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#variables ⇒ ::Google::Protobuf::Struct

Returns The variable values at the end of the tool execution.

Returns:



98
99
100
101
 
# File 'proto_docs/google/cloud/ces/v1beta/tool_service.rb', line 98

class ExecuteToolResponse
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end