chore: document union variants in yard doc (#16)

Author: stainless-app[bot]

lib/openai/base_model.rb

@@ -443,13 +443,18 @@ class << self
 
       # @api private
       #
-      # All of the specified variants for this union.
-      #
       # @return [Array<Array(Symbol, Object)>]
-      protected def variants
+      protected def derefed_variants
         @known_variants.map { |key, variant_fn| [key, variant_fn.call] }
       end
 
+      # All of the specified variants for this union.
+      #
+      # @return [Array<Object>]
+      def variants
+        derefed_variants.map(&:last)
+      end
+
       # @api private
       #
       # @param property [Symbol]
@@ -529,7 +534,7 @@ def self.===(other)
     #
     # @return [Boolean]
     def self.==(other)
-      other.is_a?(Class) && other <= OpenAI::Union && other.variants == variants
+      other.is_a?(Class) && other <= OpenAI::Union && other.derefed_variants == derefed_variants
     end
 
     class << self

lib/openai/models/audio/speech_create_params.rb

@@ -73,6 +73,12 @@ class Model < OpenAI::Union
 
           # One of the available [TTS models](https://platform.openai.com/docs/models#tts): `tts-1` or `tts-1-hd`
           variant enum: -> { OpenAI::Models::Audio::SpeechModel }
+
+          # @!parse
+          #   class << self
+          #     # @return [Array(String, Symbol, OpenAI::Models::Audio::SpeechModel)]
+          #     def variants; end
+          #   end
         end
 
         # @abstract

lib/openai/models/audio/transcription_create_params.rb

@@ -122,6 +122,12 @@ class Model < OpenAI::Union
 
           # ID of the model to use. Only `whisper-1` (which is powered by our open source Whisper V2 model) is currently available.
           variant enum: -> { OpenAI::Models::AudioModel }
+
+          # @!parse
+          #   class << self
+          #     # @return [Array(String, Symbol, OpenAI::Models::AudioModel)]
+          #     def variants; end
+          #   end
         end
 
         # @abstract

lib/openai/models/audio/transcription_create_response.rb

@@ -13,6 +13,12 @@ class TranscriptionCreateResponse < OpenAI::Union
 
         # Represents a verbose json transcription response returned by model, based on the provided input.
         variant -> { OpenAI::Models::Audio::TranscriptionVerbose }
+
+        # @!parse
+        #   class << self
+        #     # @return [Array(OpenAI::Models::Audio::Transcription, OpenAI::Models::Audio::TranscriptionVerbose)]
+        #     def variants; end
+        #   end
       end
     end
   end

lib/openai/models/audio/translation_create_params.rb

@@ -81,6 +81,12 @@ class Model < OpenAI::Union
 
           # ID of the model to use. Only `whisper-1` (which is powered by our open source Whisper V2 model) is currently available.
           variant enum: -> { OpenAI::Models::AudioModel }
+
+          # @!parse
+          #   class << self
+          #     # @return [Array(String, Symbol, OpenAI::Models::AudioModel)]
+          #     def variants; end
+          #   end
         end
       end
     end

lib/openai/models/audio/translation_create_response.rb

@@ -8,6 +8,12 @@ class TranslationCreateResponse < OpenAI::Union
         variant -> { OpenAI::Models::Audio::Translation }
 
         variant -> { OpenAI::Models::Audio::TranslationVerbose }
+
+        # @!parse
+        #   class << self
+        #     # @return [Array(OpenAI::Models::Audio::Translation, OpenAI::Models::Audio::TranslationVerbose)]
+        #     def variants; end
+        #   end
       end
     end
   end

lib/openai/models/beta/assistant_create_params.rb

@@ -169,6 +169,12 @@ class Model < OpenAI::Union
 
           # ID of the model to use. You can use the [List models](https://platform.openai.com/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](https://platform.openai.com/docs/models) for descriptions of them.
           variant enum: -> { OpenAI::Models::ChatModel }
+
+          # @!parse
+          #   class << self
+          #     # @return [Array(String, Symbol, OpenAI::Models::ChatModel)]
+          #     def variants; end
+          #   end
         end
 
         class ToolResources < OpenAI::BaseModel
@@ -384,6 +390,12 @@ class Static < OpenAI::BaseModel
                     # def initialize: (Hash | OpenAI::BaseModel) -> void
                   end
                 end
+
+                # @!parse
+                #   class << self
+                #     # @return [Array(OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Auto, OpenAI::Models::Beta::AssistantCreateParams::ToolResources::FileSearch::VectorStore::ChunkingStrategy::Static)]
+                #     def variants; end
+                #   end
               end
             end
           end

lib/openai/models/beta/assistant_response_format_option.rb

@@ -41,6 +41,12 @@ class AssistantResponseFormatOption < OpenAI::Union
         # JSON Schema response format. Used to generate structured JSON responses.
         # Learn more about [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
         variant -> { OpenAI::Models::ResponseFormatJSONSchema }
+
+        # @!parse
+        #   class << self
+        #     # @return [Array(Symbol, :auto, OpenAI::Models::ResponseFormatText, OpenAI::Models::ResponseFormatJSONObject, OpenAI::Models::ResponseFormatJSONSchema)]
+        #     def variants; end
+        #   end
       end
     end
   end

lib/openai/models/beta/assistant_stream_event.rb

@@ -725,6 +725,12 @@ class ErrorEvent < OpenAI::BaseModel
 
           # def initialize: (Hash | OpenAI::BaseModel) -> void
         end
+
+        # @!parse
+        #   class << self
+        #     # @return [Array(OpenAI::Models::Beta::AssistantStreamEvent::ThreadCreated, OpenAI::Models::Beta::AssistantStreamEvent::ThreadRunCreated, OpenAI::Models::Beta::AssistantStreamEvent::ThreadRunQueued, OpenAI::Models::Beta::AssistantStreamEvent::ThreadRunInProgress, OpenAI::Models::Beta::AssistantStreamEvent::ThreadRunRequiresAction, OpenAI::Models::Beta::AssistantStreamEvent::ThreadRunCompleted, OpenAI::Models::Beta::AssistantStreamEvent::ThreadRunIncomplete, OpenAI::Models::Beta::AssistantStreamEvent::ThreadRunFailed, OpenAI::Models::Beta::AssistantStreamEvent::ThreadRunCancelling, OpenAI::Models::Beta::AssistantStreamEvent::ThreadRunCancelled, OpenAI::Models::Beta::AssistantStreamEvent::ThreadRunExpired, OpenAI::Models::Beta::AssistantStreamEvent::ThreadRunStepCreated, OpenAI::Models::Beta::AssistantStreamEvent::ThreadRunStepInProgress, OpenAI::Models::Beta::AssistantStreamEvent::ThreadRunStepDelta, OpenAI::Models::Beta::AssistantStreamEvent::ThreadRunStepCompleted, OpenAI::Models::Beta::AssistantStreamEvent::ThreadRunStepFailed, OpenAI::Models::Beta::AssistantStreamEvent::ThreadRunStepCancelled, OpenAI::Models::Beta::AssistantStreamEvent::ThreadRunStepExpired, OpenAI::Models::Beta::AssistantStreamEvent::ThreadMessageCreated, OpenAI::Models::Beta::AssistantStreamEvent::ThreadMessageInProgress, OpenAI::Models::Beta::AssistantStreamEvent::ThreadMessageDelta, OpenAI::Models::Beta::AssistantStreamEvent::ThreadMessageCompleted, OpenAI::Models::Beta::AssistantStreamEvent::ThreadMessageIncomplete, OpenAI::Models::Beta::AssistantStreamEvent::ErrorEvent)]
+        #     def variants; end
+        #   end
       end
     end
   end

lib/openai/models/beta/assistant_tool.rb

@@ -12,6 +12,12 @@ class AssistantTool < OpenAI::Union
         variant :file_search, -> { OpenAI::Models::Beta::FileSearchTool }
 
         variant :function, -> { OpenAI::Models::Beta::FunctionTool }
+
+        # @!parse
+        #   class << self
+        #     # @return [Array(OpenAI::Models::Beta::CodeInterpreterTool, OpenAI::Models::Beta::FileSearchTool, OpenAI::Models::Beta::FunctionTool)]
+        #     def variants; end
+        #   end
       end
     end
   end