chore: refine Yard and Sorbet types and ensure linting is turned on for examples

Author: stainless-app[bot]

Rakefile

@@ -9,6 +9,7 @@ require "rake/clean"
 require "rubocop/rake_task"
 
 tapioca = "sorbet/tapioca"
+examples = "examples"
 ignore_file = ".ignore"
 
 CLEAN.push(*%w[.idea/ .ruby-lsp/ .yardoc/ doc/], *FileList["*.gem"], ignore_file)
@@ -39,7 +40,7 @@ locale = {"LC_ALL" => "C.UTF-8"}
 
 desc("Lint `*.rb(i)`")
 multitask(:"lint:rubocop") do
-  find = %w[find ./lib ./test ./rbi -type f -and ( -name *.rb -or -name *.rbi ) -print0]
+  find = %w[find ./lib ./test ./rbi ./examples -type f -and ( -name *.rb -or -name *.rbi ) -print0]
 
   rubocop = %w[rubocop]
   rubocop += %w[--format github] if ENV.key?("CI")
@@ -54,7 +55,7 @@ end
 desc("Format `*.rb`")
 multitask(:"format:rb") do
   # while `syntax_tree` is much faster than `rubocop`, `rubocop` is the only formatter with full syntax support
-  find = %w[find ./lib ./test -type f -and -name *.rb -print0]
+  find = %w[find ./lib ./test ./examples -type f -and -name *.rb -print0]
   fmt = xargs + %w[rubocop --fail-level F --autocorrect --format simple --]
   sh("#{find.shelljoin} | #{fmt.shelljoin}")
 end
@@ -117,12 +118,14 @@ multitask(:"typecheck:steep") do
   sh(*%w[steep check])
 end
 
+directory(examples)
+
 desc("Typecheck `*.rbi`")
-multitask(:"typecheck:sorbet") do
-  sh(*%w[srb typecheck])
+multitask("typecheck:sorbet": examples) do
+  sh(*%w[srb typecheck --dir], examples)
 end
 
-file(tapioca) do
+directory(tapioca) do
   sh(*%w[tapioca init])
 end
 

lib/openai/internal.rb

@@ -13,5 +13,8 @@ module Internal
     define_sorbet_constant!(:AnyHash) do
       T.type_alias { T::Hash[Symbol, T.anything] }
     end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, OpenAI::FilePart) }
+    end
   end
 end

lib/openai/models/audio/transcription_create_params.rb

@@ -14,7 +14,7 @@ class TranscriptionCreateParams < OpenAI::Internal::Type::BaseModel
         #   The audio file object (not file name) to transcribe, in one of these formats:
         #   flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
         #
-        #   @return [Pathname, StringIO, IO, OpenAI::FilePart]
+        #   @return [Pathname, StringIO, IO, String, OpenAI::FilePart]
         required :file, OpenAI::Internal::Type::FileInput
 
         # @!attribute model
@@ -98,7 +98,7 @@ class TranscriptionCreateParams < OpenAI::Internal::Type::BaseModel
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Audio::TranscriptionCreateParams} for more details.
         #
-        #   @param file [Pathname, StringIO, IO, OpenAI::FilePart] The audio file object (not file name) to transcribe, in one of these formats: fl
+        #   @param file [Pathname, StringIO, IO, String, OpenAI::FilePart] The audio file object (not file name) to transcribe, in one of these formats: fl
         #
         #   @param model [String, Symbol, OpenAI::AudioModel] ID of the model to use. The options are `gpt-4o-transcribe`, `gpt-4o-mini-transc
         #

lib/openai/models/audio/translation_create_params.rb

@@ -12,7 +12,7 @@ class TranslationCreateParams < OpenAI::Internal::Type::BaseModel
         #   The audio file object (not file name) translate, in one of these formats: flac,
         #   mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
         #
-        #   @return [Pathname, StringIO, IO, OpenAI::FilePart]
+        #   @return [Pathname, StringIO, IO, String, OpenAI::FilePart]
         required :file, OpenAI::Internal::Type::FileInput
 
         # @!attribute model
@@ -52,7 +52,7 @@ class TranslationCreateParams < OpenAI::Internal::Type::BaseModel
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Audio::TranslationCreateParams} for more details.
         #
-        #   @param file [Pathname, StringIO, IO, OpenAI::FilePart] The audio file object (not file name) translate, in one of these formats: flac,
+        #   @param file [Pathname, StringIO, IO, String, OpenAI::FilePart] The audio file object (not file name) translate, in one of these formats: flac,
         #
         #   @param model [String, Symbol, OpenAI::AudioModel] ID of the model to use. Only `whisper-1` (which is powered by our open source Wh
         #

lib/openai/models/file_create_params.rb

@@ -10,7 +10,7 @@ class FileCreateParams < OpenAI::Internal::Type::BaseModel
       # @!attribute file
       #   The File object (not file name) to be uploaded.
       #
-      #   @return [Pathname, StringIO, IO, OpenAI::FilePart]
+      #   @return [Pathname, StringIO, IO, String, OpenAI::FilePart]
       required :file, OpenAI::Internal::Type::FileInput
 
       # @!attribute purpose
@@ -26,7 +26,7 @@ class FileCreateParams < OpenAI::Internal::Type::BaseModel
       #   Some parameter documentations has been truncated, see
       #   {OpenAI::Models::FileCreateParams} for more details.
       #
-      #   @param file [Pathname, StringIO, IO, OpenAI::FilePart] The File object (not file name) to be uploaded.
+      #   @param file [Pathname, StringIO, IO, String, OpenAI::FilePart] The File object (not file name) to be uploaded.
       #
       #   @param purpose [Symbol, OpenAI::FilePurpose] The intended purpose of the uploaded file. One of: - `assistants`: Used in the A
       #

lib/openai/models/image_create_variation_params.rb

@@ -11,7 +11,7 @@ class ImageCreateVariationParams < OpenAI::Internal::Type::BaseModel
       #   The image to use as the basis for the variation(s). Must be a valid PNG file,
       #   less than 4MB, and square.
       #
-      #   @return [Pathname, StringIO, IO, OpenAI::FilePart]
+      #   @return [Pathname, StringIO, IO, String, OpenAI::FilePart]
       required :image, OpenAI::Internal::Type::FileInput
 
       # @!attribute model
@@ -54,7 +54,7 @@ class ImageCreateVariationParams < OpenAI::Internal::Type::BaseModel
       #   Some parameter documentations has been truncated, see
       #   {OpenAI::Models::ImageCreateVariationParams} for more details.
       #
-      #   @param image [Pathname, StringIO, IO, OpenAI::FilePart] The image to use as the basis for the variation(s). Must be a valid PNG file, le
+      #   @param image [Pathname, StringIO, IO, String, OpenAI::FilePart] The image to use as the basis for the variation(s). Must be a valid PNG file, le
       #
       #   @param model [String, Symbol, OpenAI::ImageModel, nil] The model to use for image generation. Only `dall-e-2` is supported at this time
       #

lib/openai/models/image_edit_params.rb

@@ -16,7 +16,7 @@ class ImageEditParams < OpenAI::Internal::Type::BaseModel
       #   For `dall-e-2`, you can only provide one image, and it should be a square `png`
       #   file less than 4MB.
       #
-      #   @return [Pathname, StringIO, IO, OpenAI::FilePart, Array<Pathname, StringIO, IO, OpenAI::FilePart>]
+      #   @return [Pathname, StringIO, IO, String, OpenAI::FilePart, Array<Pathname, StringIO, IO, String, OpenAI::FilePart>]
       required :image, union: -> { OpenAI::ImageEditParams::Image }
 
       # @!attribute prompt
@@ -44,7 +44,7 @@ class ImageEditParams < OpenAI::Internal::Type::BaseModel
       #   the mask will be applied on the first image. Must be a valid PNG file, less than
       #   4MB, and have the same dimensions as `image`.
       #
-      #   @return [Pathname, StringIO, IO, OpenAI::FilePart, nil]
+      #   @return [Pathname, StringIO, IO, String, OpenAI::FilePart, nil]
       optional :mask, OpenAI::Internal::Type::FileInput
 
       # @!attribute model
@@ -98,13 +98,13 @@ class ImageEditParams < OpenAI::Internal::Type::BaseModel
       #   Some parameter documentations has been truncated, see
       #   {OpenAI::Models::ImageEditParams} for more details.
       #
-      #   @param image [Pathname, StringIO, IO, OpenAI::FilePart, Array<Pathname, StringIO, IO, OpenAI::FilePart>] The image(s) to edit. Must be a supported image file or an array of images.
+      #   @param image [Pathname, StringIO, IO, String, OpenAI::FilePart, Array<Pathname, StringIO, IO, String, OpenAI::FilePart>] The image(s) to edit. Must be a supported image file or an array of images.
       #
       #   @param prompt [String] A text description of the desired image(s). The maximum length is 1000 character
       #
       #   @param background [Symbol, OpenAI::ImageEditParams::Background, nil] Allows to set transparency for the background of the generated image(s).
       #
-      #   @param mask [Pathname, StringIO, IO, OpenAI::FilePart] An additional image whose fully transparent areas (e.g. where alpha is zero) ind
+      #   @param mask [Pathname, StringIO, IO, String, OpenAI::FilePart] An additional image whose fully transparent areas (e.g. where alpha is zero) ind
       #
       #   @param model [String, Symbol, OpenAI::ImageModel, nil] The model to use for image generation. Only `dall-e-2` and `gpt-image-1` are sup
       #

lib/openai/models/uploads/part_create_params.rb

@@ -11,14 +11,14 @@ class PartCreateParams < OpenAI::Internal::Type::BaseModel
         # @!attribute data
         #   The chunk of bytes for this Part.
         #
-        #   @return [Pathname, StringIO, IO, OpenAI::FilePart]
+        #   @return [Pathname, StringIO, IO, String, OpenAI::FilePart]
         required :data, OpenAI::Internal::Type::FileInput
 
         # @!method initialize(data:, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Uploads::PartCreateParams} for more details.
         #
-        #   @param data [Pathname, StringIO, IO, OpenAI::FilePart] The chunk of bytes for this Part.
+        #   @param data [Pathname, StringIO, IO, String, OpenAI::FilePart] The chunk of bytes for this Part.
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
       end

lib/openai/resources/audio/transcriptions.rb

@@ -14,7 +14,7 @@ class Transcriptions
         #
         # @overload create(file:, model:, chunking_strategy: nil, include: nil, language: nil, prompt: nil, response_format: nil, temperature: nil, timestamp_granularities: nil, request_options: {})
         #
-        # @param file [Pathname, StringIO, IO, OpenAI::FilePart] The audio file object (not file name) to transcribe, in one of these formats: fl
+        # @param file [Pathname, StringIO, IO, String, OpenAI::FilePart] The audio file object (not file name) to transcribe, in one of these formats: fl
         #
         # @param model [String, Symbol, OpenAI::AudioModel] ID of the model to use. The options are `gpt-4o-transcribe`, `gpt-4o-mini-transc
         #
@@ -63,7 +63,7 @@ def create(params)
         #
         # @overload create_streaming(file:, model:, chunking_strategy: nil, include: nil, language: nil, prompt: nil, response_format: nil, temperature: nil, timestamp_granularities: nil, request_options: {})
         #
-        # @param file [Pathname, StringIO, IO, OpenAI::FilePart] The audio file object (not file name) to transcribe, in one of these formats: fl
+        # @param file [Pathname, StringIO, IO, String, OpenAI::FilePart] The audio file object (not file name) to transcribe, in one of these formats: fl
         #
         # @param model [String, Symbol, OpenAI::AudioModel] ID of the model to use. The options are `gpt-4o-transcribe`, `gpt-4o-mini-transc
         #

lib/openai/resources/audio/translations.rb

@@ -11,7 +11,7 @@ class Translations
         #
         # @overload create(file:, model:, prompt: nil, response_format: nil, temperature: nil, request_options: {})
         #
-        # @param file [Pathname, StringIO, IO, OpenAI::FilePart] The audio file object (not file name) translate, in one of these formats: flac,
+        # @param file [Pathname, StringIO, IO, String, OpenAI::FilePart] The audio file object (not file name) translate, in one of these formats: flac,
         #
         # @param model [String, Symbol, OpenAI::AudioModel] ID of the model to use. Only `whisper-1` (which is powered by our open source Wh
         #