Gemini Enterprise for Customer Experience V1 API - Class Google::Cloud::Ces::V1::ExecuteToolRequest (v0.1.0)

Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1 API class Google::Cloud::Ces::V1::ExecuteToolRequest.

Request message for ToolService.ExecuteTool.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#args

def args() -> ::Google::Protobuf::Struct
Returns

#args=

def args=(value) -> ::Google::Protobuf::Struct
Parameter
Returns

#context

def context() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — Optional. The ToolCallContext to be passed to the Python tool.

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

#context=

def context=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — Optional. The ToolCallContext to be passed to the Python tool.

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

Returns
  • (::Google::Protobuf::Struct) — Optional. The ToolCallContext to be passed to the Python tool.

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

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The resource name of the app which the tool/toolset belongs to. Format: projects/{project}/locations/{location}/apps/{app}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The resource name of the app which the tool/toolset belongs to. Format: projects/{project}/locations/{location}/apps/{app}
Returns
  • (::String) — Required. The resource name of the app which the tool/toolset belongs to. Format: projects/{project}/locations/{location}/apps/{app}

#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::V1::ToolsetTool
Returns
  • (::Google::Cloud::Ces::V1::ToolsetTool) — Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

    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::V1::ToolsetTool
Parameter
  • value (::Google::Cloud::Ces::V1::ToolsetTool) — Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

    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::V1::ToolsetTool) — Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

    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.

#variables

def variables() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — Optional. The variables that are available for the tool execution.

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

#variables=

def variables=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — Optional. The variables that are available for the tool execution.

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

Returns
  • (::Google::Protobuf::Struct) — Optional. The variables that are available for the tool execution.

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