Class: OpenAI::Models::Safety::SafetyAlert

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

Overview

See Also:

  • OpenAI::Resources::Safety::Alerts#retrieve

Defined Under Namespace

Modules: ErrorType

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(id:, created_at:, error_type:, model:, reason:, request_id:, request_paused:, response_id:, object: :"safety.alert") ⇒ Object

Parameters:

  • id (String)
  • created_at (Integer)
  • error_type (Symbol, OpenAI::Models::Safety::SafetyAlert::ErrorType)
  • model (String)
  • reason (String, nil) —

    A customer-safe description derived from error_type, or null for zero data retention requests.

  • request_id (String)
  • request_paused (Boolean) —

    Whether block registration succeeded for this request. This does not confirm that response execution stopped.

  • response_id (String)
  • object (Symbol, :"safety.alert") (defaults to: :"safety.alert") 



# File 'lib/openai/models/safety/safety_alert.rb', line 57

Instance Attribute Details

#created_at ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


16
 
# File 'lib/openai/models/safety/safety_alert.rb', line 16

required :created_at, Integer

#error_type ⇒ Symbol, OpenAI::Models::Safety::SafetyAlert::ErrorType

Parameters:

  • value (OpenAI::Models::Safety::SafetyAlert::error_type)

Returns:



21
 
# File 'lib/openai/models/safety/safety_alert.rb', line 21

required :error_type, enum: -> { OpenAI::Safety::SafetyAlert::ErrorType }

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/openai/models/safety/safety_alert.rb', line 11

required :id, String

#model ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


26
 
# File 'lib/openai/models/safety/safety_alert.rb', line 26

required :model, String

#object ⇒ Symbol, :"safety.alert"

Parameters:

  • value (:"safety.alert")

Returns:

  • (Symbol, :"safety.alert") 


31
 
# File 'lib/openai/models/safety/safety_alert.rb', line 31

required :object, const: :"safety.alert"

#reason ⇒ String?

A customer-safe description derived from error_type, or null for zero data retention requests.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


38
 
# File 'lib/openai/models/safety/safety_alert.rb', line 38

required :reason, String, nil?: true

#request_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


43
 
# File 'lib/openai/models/safety/safety_alert.rb', line 43

required :request_id, String

#request_paused ⇒ Boolean

Whether block registration succeeded for this request. This does not confirm that response execution stopped.

Parameters:

Returns:



50
 
# File 'lib/openai/models/safety/safety_alert.rb', line 50

required :request_paused, OpenAI::Internal::Type::Boolean

#response_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


55
 
# File 'lib/openai/models/safety/safety_alert.rb', line 55

required :response_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


50
 
# File 'sig/openai/models/safety/safety_alert.rbs', line 50

def to_hash: -> {