fix: structured output union decorations

Author: ms-jpq

examples/structured_outputs_chat_completions.rb

@@ -29,7 +29,7 @@ class CalendarEvent < OpenAI::BaseModel
            doc: "Event location"
 end
 
-# # gets API Key from environment variable `OPENAI_API_KEY`
+# gets API Key from environment variable `OPENAI_API_KEY`
 client = OpenAI::Client.new
 
 chat_completion = client.chat.completions.create(

lib/openai/helpers/structured_output/union_of.rb

@@ -49,9 +49,13 @@ def initialize(*variants)
           case variants
           in [Symbol => d, Hash => vs]
             discriminator(d)
-            vs.each { variant(_1, _2) }
+            vs.each do |k, v|
+              v.is_a?(Proc) ? variant(k, v) : variant(k, -> { v })
+            end
           else
-            variants.each { variant(_1) }
+            variants.each do |v|
+              v.is_a?(Proc) ? variant(v) : variant(-> { v })
+            end
           end
         end
       end

lib/openai/models/chat/completion_create_params.rb

@@ -294,7 +294,7 @@ class CompletionCreateParams < OpenAI::Internal::Type::BaseModel
         #   @return [Array<OpenAI::Chat::ChatCompletionTool, OpenAI::StructuredOutput::JsonSchemaConverter>, nil]
         optional :tools,
                  -> {
-                   OpenAI::Internal::Type::ArrayOf[OpenAI::StructuredOutput::UnionOf[
+                   OpenAI::Internal::Type::ArrayOf[union: OpenAI::StructuredOutput::UnionOf[
                      OpenAI::Chat::ChatCompletionTool, OpenAI::StructuredOutput::JsonSchemaConverter
                    ]]
                  }

lib/openai/models/response_format_json_schema.rb

@@ -48,7 +48,13 @@ class JSONSchema < OpenAI::Internal::Type::BaseModel
         #   to build JSON schemas [here](https://json-schema.org/).
         #
         #   @return [Hash{Symbol=>Object}, nil]
-        optional :schema, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown]
+        optional :schema,
+                 union: -> {
+                   OpenAI::StructuredOutput::UnionOf[
+                     OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown],
+                     OpenAI::StructuredOutput::JsonSchemaConverter
+                   ]
+                 }
 
         # @!attribute strict
         #   Whether to enable strict schema adherence when generating the output. If set to
@@ -70,7 +76,7 @@ class JSONSchema < OpenAI::Internal::Type::BaseModel
         #
         #   @param description [String] A description of what the response format is for, used by the model to
         #
-        #   @param schema [Hash{Symbol=>Object}] The schema for the response format, described as a JSON Schema object.
+        #   @param schema [Hash{Symbol=>Object}, OpenAI::StructuredOutput::JsonSchemaConverter] The schema for the response format, described as a JSON Schema object.
         #
         #   @param strict [Boolean, nil] Whether to enable strict schema adherence when generating the output.
       end

lib/openai/resources/chat/completions.rb

@@ -108,7 +108,7 @@ def create(params)
           model = nil
           tool_models = {}
           case parsed
-          in {response_format: OpenAI::Helpers::StructuredOutput::JsonSchemaConverter => model}
+          in {response_format: OpenAI::StructuredOutput::JsonSchemaConverter => model}
             parsed.update(
               response_format: {
                 type: :json_schema,
@@ -119,12 +119,12 @@ def create(params)
                 }
               }
             )
-          in {response_format: {type: :json_schema, json_schema: {schema: OpenAI::Helpers::StructuredOutput::JsonSchemaConverter => model}}}
+          in {response_format: {type: :json_schema, json_schema: {schema: OpenAI::StructuredOutput::JsonSchemaConverter => model}}}
             parsed.dig(:response_format, :json_schema).store(:schema, model.to_json_schema)
           in {tools: Array => tools}
             mapped = tools.map do |tool|
               case tool
-              in OpenAI::Helpers::StructuredOutput::JsonSchemaConverter
+              in OpenAI::StructuredOutput::JsonSchemaConverter
                 name = tool.name.split("::").last
                 tool_models.store(name, tool)
                 {
@@ -135,7 +135,7 @@ def create(params)
                     parameters: tool.to_json_schema
                   }
                 }
-              in {function: {parameters: OpenAI::Helpers::StructuredOutput::JsonSchemaConverter => params}}
+              in {function: {parameters: OpenAI::StructuredOutput::JsonSchemaConverter => params}}
                 func = tool.fetch(:function)
                 name = func[:name] ||= params.name.split("::").last
                 tool_models.store(name, params)
@@ -148,7 +148,7 @@ def create(params)
           end
 
           unwrap = ->(raw) do
-            if model.is_a?(OpenAI::Helpers::StructuredOutput::JsonSchemaConverter)
+            if model.is_a?(OpenAI::StructuredOutput::JsonSchemaConverter)
               raw[:choices]&.each do |choice|
                 message = choice.fetch(:message)
                 parsed = JSON.parse(message.fetch(:content), symbolize_names: true)

rbi/openai/models/chat/completion_create_params.rbi

@@ -468,6 +468,7 @@ module OpenAI
               T.any(
                 OpenAI::ResponseFormatText::OrHash,
                 OpenAI::ResponseFormatJSONSchema::OrHash,
+                OpenAI::StructuredOutput::JsonSchemaConverter,
                 OpenAI::ResponseFormatJSONObject::OrHash
               ),
             seed: T.nilable(Integer),

rbi/openai/models/response_format_json_schema.rbi

@@ -9,12 +9,23 @@ module OpenAI
         end
 
       # Structured Outputs configuration options, including a JSON Schema.
-      sig { returns(OpenAI::ResponseFormatJSONSchema::JSONSchema) }
+      sig do
+        returns(
+          T.any(
+            OpenAI::ResponseFormatJSONSchema::JSONSchema::OrHash,
+            OpenAI::StructuredOutput::JsonSchemaConverter
+          )
+        )
+      end
       attr_reader :json_schema
 
       sig do
         params(
-          json_schema: OpenAI::ResponseFormatJSONSchema::JSONSchema::OrHash
+          json_schema:
+            T.any(
+              OpenAI::ResponseFormatJSONSchema::JSONSchema::OrHash,
+              OpenAI::StructuredOutput::JsonSchemaConverter
+            )
         ).void
       end
       attr_writer :json_schema
@@ -28,7 +39,11 @@ module OpenAI
       # [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
       sig do
         params(
-          json_schema: OpenAI::ResponseFormatJSONSchema::JSONSchema::OrHash,
+          json_schema:
+            T.any(
+              OpenAI::ResponseFormatJSONSchema::JSONSchema::OrHash,
+              OpenAI::StructuredOutput::JsonSchemaConverter
+            ),
           type: Symbol
         ).returns(T.attached_class)
       end