Gemini Enterprise for Customer Experience V1BETA API - Class Google::Cloud::Ces::V1beta::MockedToolCall (v0.1.0)

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

A mocked tool call.

Expresses the target tool + a pattern to match against that tool's args / inputs. If the pattern matches, then the mock response will be returned.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#expected_args_pattern

def expected_args_pattern() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — Required. A pattern to match against the args / inputs of all dispatched tool calls. If the tool call inputs match this pattern, then mock output will be returned.

#expected_args_pattern=

def expected_args_pattern=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — Required. A pattern to match against the args / inputs of all dispatched tool calls. If the tool call inputs match this pattern, then mock output will be returned.
Returns
  • (::Google::Protobuf::Struct) — Required. A pattern to match against the args / inputs of all dispatched tool calls. If the tool call inputs match this pattern, then mock output will be returned.

#mock_response

def mock_response() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — Optional. The mock response / output to return if the tool call args / inputs match the pattern.

#mock_response=

def mock_response=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — Optional. The mock response / output to return if the tool call args / inputs match the pattern.
Returns
  • (::Google::Protobuf::Struct) — Optional. The mock response / output to return if the tool call args / inputs match the pattern.

#tool

def tool() -> ::String
Returns
  • (::String) — Optional. Deprecated. Use tool_identifier instead.

#tool=

def tool=(value) -> ::String
Parameter
  • value (::String) — Optional. Deprecated. Use tool_identifier instead.
Returns
  • (::String) — Optional. Deprecated. Use tool_identifier instead.

#tool_id

def tool_id() -> ::String
Returns
  • (::String) — Optional. The name of the tool to mock. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

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

#tool_id=

def tool_id=(value) -> ::String
Parameter
  • value (::String) — Optional. The name of the tool to mock. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

    Note: The following fields are mutually exclusive: tool_id, toolset. 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 mock. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

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

#toolset

def toolset() -> ::Google::Cloud::Ces::V1beta::ToolsetTool
Returns
  • (::Google::Cloud::Ces::V1beta::ToolsetTool) — Optional. The toolset to mock.

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

#toolset=

def toolset=(value) -> ::Google::Cloud::Ces::V1beta::ToolsetTool
Parameter
  • value (::Google::Cloud::Ces::V1beta::ToolsetTool) — Optional. The toolset to mock.

    Note: The following fields are mutually exclusive: toolset, tool_id. 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 to mock.

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