Class: OpenAI::Models::Responses::ResponseSteerFailedEvent::Error

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::Responses::ResponseSteerFailedEvent::Error

Defined in:

lib/openai/models/responses/response_steer_failed_event.rb,
sig/openai/models/responses/response_steer_failed_event.rbs

Overview

See Also:

• OpenAI::Models::Responses::ResponseSteerFailedEvent#error

Instance Attribute Summary

• #code ⇒ Symbol, ...

  A machine-readable steering error code.

• #message ⇒ String

  A human-readable description of the error.

• #type ⇒ Symbol, :invalid_request_error

  The error type.

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary

• #initialize ⇒ Object constructor
• #to_hash ⇒ {

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 ⇒ Object

# File 'sig/openai/models/responses/response_steer_failed_event.rbs', line 56

def initialize: (

Instance Attribute Details

#code ⇒ Symbol, ...

A machine-readable steering error code. Clients should handle unknown values because additional codes may be introduced. Known values include:

• response_not_found: The target response is not available on this connection.
• invalid_input: The event or input failed validation.
• steering_not_supported: The model or response execution mode does not support steering.
• too_many_pending_steers: Too much steering input is pending for the response.
• response_already_completed: The response completed and is no longer accepting steering input.
• response_not_active: The response is no longer accepting steering input.
• successor_creation_failed: The successor response could not be created.

Parameters:

• value (OpenAI::Models::Responses::response_steer_error_code)

Returns:

• (Symbol, String, OpenAI::Models::Responses::ResponseSteerErrorCode)

# File 'lib/openai/models/responses/response_steer_failed_event.rb', line 82

required :code, union: -> { OpenAI::Responses::ResponseSteerErrorCode }

#message ⇒ String

A human-readable description of the error.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/openai/models/responses/response_steer_failed_event.rb', line 88

required :message, String

#type ⇒ Symbol, :invalid_request_error

The error type. Always invalid_request_error.

Parameters:

• value (:invalid_request_error)

Returns:

• (Symbol, :invalid_request_error)

# File 'lib/openai/models/responses/response_steer_failed_event.rb', line 94

required :type, const: :invalid_request_error

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/openai/models/responses/response_steer_failed_event.rbs', line 62

def to_hash: -> {