Class: OpenAI::Models::Beta::AgentSessionTurnFailedEvent

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/beta/agent_session_turn_failed_event.rb,
sig/openai/models/beta/agent_session_turn_failed_event.rbs

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, 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, coerce_with_error, 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(event_id:, session_id:, turn:, turn_id:, usage:, type: :"agent.session.turn.failed") ⇒ Object

Emitted when a turn fails.

Parameters:

  • event_id (String) —

    The unique ID of the event.

  • session_id (String) —

    The ID of the session associated with the event.

  • turn (OpenAI::Models::Beta::Agents::Sessions::Turn) —

    The failed turn.

  • turn_id (String) —

    The ID of the turn associated with the event.

  • usage (OpenAI::Models::Beta::TokenUsage, nil) —

    Recorded token usage for a session or turn. Usage is best effort and may change.

  • type (Symbol, :"agent.session.turn.failed") (defaults to: :"agent.session.turn.failed") —

    The type of the object. Always agent.session.turn.failed.




# File 'lib/openai/models/beta/agent_session_turn_failed_event.rb', line 43

Instance Attribute Details

#event_id ⇒ String

The unique ID of the event.

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/openai/models/beta/agent_session_turn_failed_event.rb', line 11

required :event_id, String

#session_id ⇒ String

The ID of the session associated with the event.

Parameters:

  • value (String)

Returns:

  • (String) 


17
 
# File 'lib/openai/models/beta/agent_session_turn_failed_event.rb', line 17

required :session_id, String

#turn ⇒ OpenAI::Models::Beta::Agents::Sessions::Turn

The failed turn.

Parameters:

  • value (OpenAI::Beta::Agents::Sessions::Turn)

Returns:



23
 
# File 'lib/openai/models/beta/agent_session_turn_failed_event.rb', line 23

required :turn, -> { OpenAI::Beta::Agents::Sessions::Turn }

#turn_id ⇒ String

The ID of the turn associated with the event.

Parameters:

  • value (String)

Returns:

  • (String) 


29
 
# File 'lib/openai/models/beta/agent_session_turn_failed_event.rb', line 29

required :turn_id, String

#type ⇒ Symbol, :"agent.session.turn.failed"

The type of the object. Always agent.session.turn.failed.

Parameters:

  • value (:"agent.session.turn.failed")

Returns:

  • (Symbol, :"agent.session.turn.failed") 


35
 
# File 'lib/openai/models/beta/agent_session_turn_failed_event.rb', line 35

required :type, const: :"agent.session.turn.failed"

#usage ⇒ OpenAI::Models::Beta::TokenUsage?

Recorded token usage for a session or turn. Usage is best effort and may change.

Parameters:

  • value (OpenAI::Beta::TokenUsage, nil)

Returns:



41
 
# File 'lib/openai/models/beta/agent_session_turn_failed_event.rb', line 41

required :usage, -> { OpenAI::Beta::TokenUsage }, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


36
 
# File 'sig/openai/models/beta/agent_session_turn_failed_event.rbs', line 36

def to_hash: -> {