Class: OCI::GenerativeAiInference::Models::ResponseJsonSchema

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai_inference/models/response_json_schema.rb

Overview

The JSON schema definition to be used in JSON_SCHEMA response format.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResponseJsonSchema

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :description (String) —

    The value to assign to the #description property

  • :schema (Object) —

    The value to assign to the #schema property

  • :is_strict (BOOLEAN) —

    The value to assign to the #is_strict property



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/generative_ai_inference/models/response_json_schema.rb', line 62

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.name = attributes[:'name'] if attributes[:'name']

  self.description = attributes[:'description'] if attributes[:'description']

  self.schema = attributes[:'schema'] if attributes[:'schema']

  self.is_strict = attributes[:'isStrict'] unless attributes[:'isStrict'].nil?

  raise 'You cannot provide both :isStrict and :is_strict' if attributes.key?(:'isStrict') && attributes.key?(:'is_strict')

  self.is_strict = attributes[:'is_strict'] unless attributes[:'is_strict'].nil?
end

Instance Attribute Details

#description ⇒ String

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

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/generative_ai_inference/models/response_json_schema.rb', line 17

def description
  @description
end

#is_strict ⇒ BOOLEAN

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.

Returns:

  • (BOOLEAN) 


26
27
28
 
# File 'lib/oci/generative_ai_inference/models/response_json_schema.rb', line 26

def is_strict
  @is_strict
end

#name ⇒ String

[Required] The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/generative_ai_inference/models/response_json_schema.rb', line 13

def name
  @name
end

#schema ⇒ Object

The schema used by the structured output, described as a JSON Schema object.

Returns:

  • (Object) 


21
22
23
 
# File 'lib/oci/generative_ai_inference/models/response_json_schema.rb', line 21

def schema
  @schema
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
37
38
 
# File 'lib/oci/generative_ai_inference/models/response_json_schema.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'description': :'description',
    'schema': :'schema',
    'is_strict': :'isStrict'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
49
50
 
# File 'lib/oci/generative_ai_inference/models/response_json_schema.rb', line 41

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'description': :'String',
    'schema': :'Object',
    'is_strict': :'BOOLEAN'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/generative_ai_inference/models/response_json_schema.rb', line 88

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    name == other.name &&
    description == other.description &&
    schema == other.schema &&
    is_strict == other.is_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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/generative_ai_inference/models/response_json_schema.rb', line 121

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


101
102
103
 
# File 'lib/oci/generative_ai_inference/models/response_json_schema.rb', line 101

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



110
111
112
 
# File 'lib/oci/generative_ai_inference/models/response_json_schema.rb', line 110

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/generative_ai_inference/models/response_json_schema.rb', line 154

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



148
149
150
 
# File 'lib/oci/generative_ai_inference/models/response_json_schema.rb', line 148

def to_s
  to_hash.to_s
end