Module: OpenAI::Helpers::StructuredOutput::JsonSchemaConverter

Included in:
ArrayOf, BaseModel, Boolean, EnumOf, UnionOf
Defined in:
lib/openai/helpers/structured_output/json_schema_converter.rb

Overview

To customize the JSON schema conversion for a type, implement the JsonSchemaConverter interface.

Constant Summary collapse

POINTERS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

Object
.new
.tap do
  _1.define_singleton_method(:inspect) do
    "#<#{OpenAI::Helpers::StructuredOutput::JsonSchemaConverter}::POINTERS>"
  end
end
.freeze
NO_REF =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

Object
.new
.tap do
  _1.define_singleton_method(:inspect) do
    "#<#{OpenAI::Helpers::StructuredOutput::JsonSchemaConverter}::NO_REF>"
  end
end
.freeze

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.assoc_meta!(schema, meta:) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • schema (Hash{Symbol=>Object}) 


72
73
74
75
76
77
78
79
 
# File 'lib/openai/helpers/structured_output/json_schema_converter.rb', line 72

def assoc_meta!(schema, meta:)
  xformed = meta.transform_keys(doc: :description)
  if schema.key?(:$ref) && !xformed.empty?
    schema.merge!(OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::NO_REF => true)
  end

  schema.merge!(xformed)
end

.cache_def!(state, type:, &blk) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • state (Hash{Symbol=>Object}) —

    @option state [HashObject=>String] :defs

    @option state [Array] :path

  • type (Object)
  • blk (Proc) 


93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/openai/helpers/structured_output/json_schema_converter.rb', line 93

def cache_def!(state, type:, &blk)
  defs, path = state.fetch_values(:defs, :path)
  if (stored = defs[type])
    pointers = stored.fetch(OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::POINTERS)
    pointers.first.except(OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::NO_REF).tap do
      pointers << _1
    end
  else
    ref_path = String.new
    ref = {"$ref": ref_path}
    stored = {
      OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::POINTERS => [ref]
    }
    defs.store(type, stored)
    schema = blk.call
    definition_name = path.map { _1.gsub("~", "~0").gsub("/", "~1") }.join("/")
    pointer_token = definition_name.gsub("~", "~0").gsub("/", "~1")
    escaped_name = URI::RFC2396_PARSER.escape(pointer_token, /[^A-Za-z0-9._~-]/)
    ref_path.replace("#/$defs/#{escaped_name}")
    stored.update(schema)
    ref
  end
end

.to_json_schema(type) ⇒ Hash{Symbol=>Object}

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

Returns:

  • (Hash{Symbol=>Object}) 


122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/openai/helpers/structured_output/json_schema_converter.rb', line 122

def to_json_schema(type)
  defs = {}
  state = {defs: defs, path: []}
  schema = OpenAI::Helpers::StructuredOutput::JsonSchemaConverter.to_json_schema_inner(
    type,
    state: state
  )
  reused_defs = {}
  defs.each_value do |acc|
    sch = acc.except(OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::POINTERS)
    pointers = acc.fetch(OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::POINTERS)

    no_refs, refs = pointers.partition do
      _1.delete(OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::NO_REF)
    end

    case refs
    in [ref]
      ref.replace(ref.except(:$ref).merge(sch))
    in [_, ref, *]
      reused_defs.store(ref.fetch(:$ref), sch)
      refs.each do
        unless (meta = _1.except(:$ref)).empty?
          _1.replace(allOf: [_1.slice(:$ref), meta])
        end
      end
    else
    end

    no_refs.each { _1.replace(_1.except(:$ref).merge(sch)) }
  end

  xformed = reused_defs.transform_keys do
    pointer_token = URI::RFC2396_PARSER.unescape(_1.delete_prefix("#/$defs/"))
    pointer_token.gsub("~1", "/").gsub("~0", "~")
  end

  xformed.empty? ? schema : {"$defs": xformed}.update(schema)
end

.to_json_schema_inner(type, state:) ⇒ Hash{Symbol=>Object}

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

Returns:

  • (Hash{Symbol=>Object})

Raises:

  • (ArgumentError) 


173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/openai/helpers/structured_output/json_schema_converter.rb', line 173

def to_json_schema_inner(type, state:)
  case type
  in {"$ref": String}
    return type
  in OpenAI::Helpers::StructuredOutput::JsonSchemaConverter
    return type.to_json_schema_inner(state: state)
  in Class
    case type
    in -> { _1 <= NilClass }
      return {type: "null"}
    in -> { _1 <= Integer }
      return {type: "integer"}
    in -> { _1 <= Float }
      return {type: "number"}
    in -> { _1 <= Symbol || _1 <= String }
      return {type: "string"}
    else
    end

  in _ if OpenAI::Internal::Util.primitive?(type)
    return {const: type.is_a?(Symbol) ? type.to_s : type}
  else
  end

  models = %w[
    NilClass
    String
    Symbol
    Integer
    Float
    OpenAI::Boolean
    OpenAI::ArrayOf
    OpenAI::EnumOf
    OpenAI::UnionOf
    OpenAI::BaseModel
  ]
  message = "#{type} does not implement the #{OpenAI::Helpers::StructuredOutput::JsonSchemaConverter} interface. Please use one of the supported types: #{models}"
  raise ArgumentError.new(message)
end

.to_nilable(schema) ⇒ Hash{Symbol=>Object}

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

  • schema (Hash{Symbol=>Object})

Returns:

  • (Hash{Symbol=>Object}) 


49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/openai/helpers/structured_output/json_schema_converter.rb', line 49

def to_nilable(schema)
  null = "null"
  case schema
  in {"$ref": String}
    {
      anyOf: [
        schema.merge!(OpenAI::Helpers::StructuredOutput::JsonSchemaConverter::NO_REF => true),
        {type: null}
      ]
    }
  in {anyOf: schemas}
    null = {type: null}
    schemas.any? { _1 == null || _1 == {type: ["null"]} } ? schema : {anyOf: [*schemas, null]}
  in {type: String => type}
    type == null ? schema : schema.update(type: [type, null])
  in {type: Array => types}
    types.include?(null) ? schema : schema.update(type: [*types, null])
  end
end

Instance Method Details

#to_json_schema_inner(state:) ⇒ Hash{Symbol=>Object}

The exact JSON schema produced is subject to improvement between minor release versions.

Parameters:

  • state (Hash{Symbol=>Object}) —

    @option state [HashObject=>String] :defs

    @option state [Array] :path

Returns:

  • (Hash{Symbol=>Object}) 


38
 
# File 'lib/openai/helpers/structured_output/json_schema_converter.rb', line 38

def to_json_schema_inner(state:) = (raise NotImplementedError)