Class: Zavudev::Models::Senders::Agent::ToolTestResponse::Run

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/zavudev/models/senders/agent/tool_test_response.rb,
sig/zavudev/models/senders/agent/tool_test_response.rbs

Overview

See Also:

  • Zavudev::Models::Senders::Agent::ToolTestResponse#run

Instance Attribute Summary collapse

Instance Method Summary collapse

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(id:, created_at:, duration_ms:, success:, tool_id:, error: nil, params: nil, response: nil, status_code: nil) ⇒ Object

Some parameter documentations has been truncated, see Zavudev::Models::Senders::Agent::ToolTestResponse::Run for more details.

One run of a tool triggered from the test endpoint. Recorded so a test is verifiable after the fact rather than only visible in the response.

Parameters:

  • id (String)
  • created_at (Time)
  • duration_ms (Integer)
  • success (Boolean) —

    Whether the tool returned without error. A tool that answered with a non-2xx sta

  • tool_id (String)
  • error (String, nil) (defaults to: nil) —

    Why the run failed, when it did.

  • params (Hash{Symbol=>Object}) (defaults to: nil) —

    The parameters the tool was called with.

  • response (String, nil) (defaults to: nil) —

    The tool's response body, truncated.

  • status_code (Integer, nil) (defaults to: nil) —

    HTTP status the tool's webhook returned. Absent for tools that do not go over HT




# File 'lib/zavudev/models/senders/agent/tool_test_response.rb', line 76

Instance Attribute Details

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


32
 
# File 'lib/zavudev/models/senders/agent/tool_test_response.rb', line 32

required :created_at, Time, api_name: :createdAt

#duration_ms ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


37
 
# File 'lib/zavudev/models/senders/agent/tool_test_response.rb', line 37

required :duration_ms, Integer, api_name: :durationMs

#error ⇒ String?

Why the run failed, when it did.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


55
 
# File 'lib/zavudev/models/senders/agent/tool_test_response.rb', line 55

optional :error, String, nil?: true

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


27
 
# File 'lib/zavudev/models/senders/agent/tool_test_response.rb', line 27

required :id, String

#params ⇒ Hash{Symbol=>Object}?

The parameters the tool was called with.

Parameters:

  • (::Hash[Symbol, top])

Returns:

  • (Hash{Symbol=>Object}, nil) 


61
 
# File 'lib/zavudev/models/senders/agent/tool_test_response.rb', line 61

optional :params, Zavudev::Internal::Type::HashOf[Zavudev::Internal::Type::Unknown]

#response ⇒ String?

The tool's response body, truncated.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


67
 
# File 'lib/zavudev/models/senders/agent/tool_test_response.rb', line 67

optional :response, String, nil?: true

#status_code ⇒ Integer?

HTTP status the tool's webhook returned. Absent for tools that do not go over HTTP.

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


74
 
# File 'lib/zavudev/models/senders/agent/tool_test_response.rb', line 74

optional :status_code, Integer, api_name: :statusCode, nil?: true

#success ⇒ Boolean

Whether the tool returned without error. A tool that answered with a non-2xx status is a failed run, not an error of this endpoint.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


44
 
# File 'lib/zavudev/models/senders/agent/tool_test_response.rb', line 44

required :success, Zavudev::Internal::Type::Boolean

#tool_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


49
 
# File 'lib/zavudev/models/senders/agent/tool_test_response.rb', line 49

required :tool_id, String, api_name: :toolId

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


65
 
# File 'sig/zavudev/models/senders/agent/tool_test_response.rbs', line 65

def to_hash: -> {