Gemini Enterprise for Customer Experience V1BETA API - Class Google::Cloud::Ces::V1beta::ToolResponse (v1.3.0)

Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1BETA API class Google::Cloud::Ces::V1beta::ToolResponse.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#agent_name

def agent_name() -> ::String
Returns
  • (::String) — Output only. Human-readable name of the agent that issued this call, e.g. "Contract Architect". Empty when the root agent issued it.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Output only. Display name of the tool.

#id

def id() -> ::String
Returns
  • (::String) — Optional. The matching ID of the [tool call][google.cloud.ces.v1beta.ToolCall] the response is for.

#id=

def id=(value) -> ::String
Parameter
  • value (::String) — Optional. The matching ID of the [tool call][google.cloud.ces.v1beta.ToolCall] the response is for.
Returns
  • (::String) — Optional. The matching ID of the [tool call][google.cloud.ces.v1beta.ToolCall] the response is for.

#parent_tool_call_id

def parent_tool_call_id() -> ::String
Returns
  • (::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.

#response

def response() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — 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.

#response=

def response=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — 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.
Returns
  • (::Google::Protobuf::Struct) — 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.

#tool

def tool() -> ::String
Returns
  • (::String) — Optional. The name of the tool to execute. 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.

#tool=

def tool=(value) -> ::String
Parameter
  • value (::String) — Optional. The name of the tool to execute. 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) — Optional. The name of the tool to execute. 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.

#toolset_tool

def toolset_tool() -> ::Google::Cloud::Ces::V1beta::ToolsetTool
Returns
  • (::Google::Cloud::Ces::V1beta::ToolsetTool) — Optional. 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.

#toolset_tool=

def toolset_tool=(value) -> ::Google::Cloud::Ces::V1beta::ToolsetTool
Parameter
  • value (::Google::Cloud::Ces::V1beta::ToolsetTool) — Optional. 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) — Optional. 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.