Class: OpenApiOpenAIClient::ResponseFormatJsonSchemaJsonSchema

Inherits:
ApiModelBase
  • Object
show all
Defined in:
lib/openapi_openai/models/response_format_json_schema_json_schema.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ ResponseFormatJsonSchemaJsonSchema

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/openapi_openai/models/response_format_json_schema_json_schema.rb', line 69

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenApiOpenAIClient::ResponseFormatJsonSchemaJsonSchema` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenApiOpenAIClient::ResponseFormatJsonSchemaJsonSchema`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'description')
    self.description = attributes[:'description']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

  if attributes.key?(:'schema')
    if (value = attributes[:'schema']).is_a?(Hash)
      self.schema = value
    end
  end

  if attributes.key?(:'strict')
    self.strict = attributes[:'strict']
  else
    self.strict = false
  end
end

Instance Attribute Details

#description ⇒ Object

A description of what the response format is for, used by the model to determine how to respond in the format.



19
20
21
 
# File 'lib/openapi_openai/models/response_format_json_schema_json_schema.rb', line 19

def description
  @description
end

#name ⇒ Object

The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.



22
23
24
 
# File 'lib/openapi_openai/models/response_format_json_schema_json_schema.rb', line 22

def name
  @name
end

#schema ⇒ Object

The schema for the response format, described as a JSON Schema object.



25
26
27
 
# File 'lib/openapi_openai/models/response_format_json_schema_json_schema.rb', line 25

def schema
  @schema
end

#strict ⇒ Object

Whether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true. To learn more, read the [Structured Outputs guide](/docs/guides/structured-outputs).



28
29
30
 
# File 'lib/openapi_openai/models/response_format_json_schema_json_schema.rb', line 28

def strict
  @strict
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



41
42
43
 
# File 'lib/openapi_openai/models/response_format_json_schema_json_schema.rb', line 41

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



46
47
48
 
# File 'lib/openapi_openai/models/response_format_json_schema_json_schema.rb', line 46

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



31
32
33
34
35
36
37
38
 
# File 'lib/openapi_openai/models/response_format_json_schema_json_schema.rb', line 31

def self.attribute_map
  {
    :'description' => :'description',
    :'name' => :'name',
    :'schema' => :'schema',
    :'strict' => :'strict'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/openapi_openai/models/response_format_json_schema_json_schema.rb', line 162

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



61
62
63
64
65
 
# File 'lib/openapi_openai/models/response_format_json_schema_json_schema.rb', line 61

def self.openapi_nullable
  Set.new([
    :'strict'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
 
# File 'lib/openapi_openai/models/response_format_json_schema_json_schema.rb', line 51

def self.openapi_types
  {
    :'description' => :'String',
    :'name' => :'String',
    :'schema' => :'Hash<String, Object>',
    :'strict' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



138
139
140
141
142
143
144
145
 
# File 'lib/openapi_openai/models/response_format_json_schema_json_schema.rb', line 138

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      name == o.name &&
      schema == o.schema &&
      strict == o.strict
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


149
150
151
 
# File 'lib/openapi_openai/models/response_format_json_schema_json_schema.rb', line 149

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



155
156
157
 
# File 'lib/openapi_openai/models/response_format_json_schema_json_schema.rb', line 155

def hash
  [description, name, schema, strict].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



108
109
110
111
112
113
114
115
116
 
# File 'lib/openapi_openai/models/response_format_json_schema_json_schema.rb', line 108

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/openapi_openai/models/response_format_json_schema_json_schema.rb', line 184

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



120
121
122
123
124
 
# File 'lib/openapi_openai/models/response_format_json_schema_json_schema.rb', line 120

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  true
end