Class: Cerca::Models::HTTPToolDefinition

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Cerca::Models::HTTPToolDefinition

Defined in:

lib/cerca/models/http_tool_definition.rb

Instance Attribute Summary

• #approval ⇒ Symbol, ...
• #description ⇒ String
• #endpoint ⇒ Cerca::Models::HTTPEndpoint

  HTTP endpoint invoked when the tool is called.

• #execution ⇒ Cerca::Models::HTTPToolExecutionPolicy^?

  HTTP tool execution retry and timeout policy.

• #input_schema ⇒ Hash{Symbol=>Object}

  JSON Schema object describing tool input parameters.

• #name ⇒ String
• #response ⇒ Cerca::Models::ResponseNormalizationHint^?

  How the HTTP response should be normalized for the agent.

Instance Method Summary

• #initialize(description:, endpoint:, input_schema:, name:, approval: nil, execution: nil, response: nil) ⇒ Object constructor

  Definition for a single HTTP tool exposed by a tool source.

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(description:, endpoint:, input_schema:, name:, approval: nil, execution: nil, response: nil) ⇒ Object

Definition for a single HTTP tool exposed by a tool source.

Parameters:

• description (String)
• endpoint (Cerca::Models::HTTPEndpoint) —

  HTTP endpoint invoked when the tool is called.

• input_schema (Hash{Symbol=>Object}) —

  JSON Schema object describing tool input parameters.

• name (String)
• approval (Symbol, Cerca::Models::ToolApprovalMode) (defaults to: nil)
• execution (Cerca::Models::HTTPToolExecutionPolicy) (defaults to: nil) —

  HTTP tool execution retry and timeout policy.

• response (Cerca::Models::ResponseNormalizationHint) (defaults to: nil) —

  How the HTTP response should be normalized for the agent.

# File 'lib/cerca/models/http_tool_definition.rb', line 47

Instance Attribute Details

#approval ⇒ Symbol, ...

Returns:

• (Symbol, Cerca::Models::ToolApprovalMode, nil)

# File 'lib/cerca/models/http_tool_definition.rb', line 33

optional :approval, enum: -> { Cerca::ToolApprovalMode }

#description ⇒ String

Returns:

• (String)

# File 'lib/cerca/models/http_tool_definition.rb', line 9

required :description, String

#endpoint ⇒ Cerca::Models::HTTPEndpoint

HTTP endpoint invoked when the tool is called.

Returns:

• (Cerca::Models::HTTPEndpoint)

# File 'lib/cerca/models/http_tool_definition.rb', line 15

required :endpoint, -> { Cerca::HTTPEndpoint }

#execution ⇒ Cerca::Models::HTTPToolExecutionPolicy^?

HTTP tool execution retry and timeout policy.

Returns:

• (Cerca::Models::HTTPToolExecutionPolicy, nil)

# File 'lib/cerca/models/http_tool_definition.rb', line 39

optional :execution, -> { Cerca::HTTPToolExecutionPolicy }

#input_schema ⇒ Hash{Symbol=>Object}

JSON Schema object describing tool input parameters.

Returns:

• (Hash{Symbol=>Object})

# File 'lib/cerca/models/http_tool_definition.rb', line 21

required :input_schema,
Cerca::Internal::Type::HashOf[Cerca::Internal::Type::Unknown],
api_name: :inputSchema

#name ⇒ String

Returns:

• (String)

# File 'lib/cerca/models/http_tool_definition.rb', line 28

required :name, String

#response ⇒ Cerca::Models::ResponseNormalizationHint^?

How the HTTP response should be normalized for the agent.

Returns:

• (Cerca::Models::ResponseNormalizationHint, nil)

# File 'lib/cerca/models/http_tool_definition.rb', line 45

optional :response, -> { Cerca::ResponseNormalizationHint }