chore: show truncated parameter docs in yard

Author: stainless-app[bot]

lib/openai/models/audio/speech_create_params.rb

@@ -52,12 +52,26 @@ class SpeechCreateParams < OpenAI::Internal::Type::BaseModel
         optional :speed, Float
 
         # @!method initialize(input:, model:, voice:, instructions: nil, response_format: nil, speed: nil, request_options: {})
-        #   @param input [String]
-        #   @param model [String, Symbol, OpenAI::Models::Audio::SpeechModel]
-        #   @param voice [String, Symbol, OpenAI::Models::Audio::SpeechCreateParams::Voice]
-        #   @param instructions [String]
-        #   @param response_format [Symbol, OpenAI::Models::Audio::SpeechCreateParams::ResponseFormat]
-        #   @param speed [Float]
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Audio::SpeechCreateParams} for more details.
+        #
+        #   @param input [String] The text to generate audio for. The maximum length is 4096 characters.
+        #
+        #   @param model [String, Symbol, OpenAI::Models::Audio::SpeechModel] One of the available [TTS models](https://platform.openai.com/docs/models#tts):
+        #   ...
+        #
+        #   @param voice [String, Symbol, OpenAI::Models::Audio::SpeechCreateParams::Voice] The voice to use when generating the audio. Supported voices are `alloy`, `ash`,
+        #   ...
+        #
+        #   @param instructions [String] Control the voice of your generated audio with additional instructions. Does not
+        #   ...
+        #
+        #   @param response_format [Symbol, OpenAI::Models::Audio::SpeechCreateParams::ResponseFormat] The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav
+        #   ...
+        #
+        #   @param speed [Float] The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is
+        #   ...
+        #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 
         # One of the available [TTS models](https://platform.openai.com/docs/models#tts):

lib/openai/models/audio/transcription.rb

@@ -19,11 +19,16 @@ class Transcription < OpenAI::Internal::Type::BaseModel
         optional :logprobs, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Models::Audio::Transcription::Logprob] }
 
         # @!method initialize(text:, logprobs: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Audio::Transcription} for more details.
+        #
         #   Represents a transcription response returned by model, based on the provided
         #   input.
         #
-        #   @param text [String]
-        #   @param logprobs [Array<OpenAI::Models::Audio::Transcription::Logprob>]
+        #   @param text [String] The transcribed text.
+        #
+        #   @param logprobs [Array<OpenAI::Models::Audio::Transcription::Logprob>] The log probabilities of the tokens in the transcription. Only returned with the
+        #   ...
 
         class Logprob < OpenAI::Internal::Type::BaseModel
           # @!attribute token
@@ -45,9 +50,11 @@ class Logprob < OpenAI::Internal::Type::BaseModel
           optional :logprob, Float
 
           # @!method initialize(token: nil, bytes: nil, logprob: nil)
-          #   @param token [String]
-          #   @param bytes [Array<Float>]
-          #   @param logprob [Float]
+          #   @param token [String] The token in the transcription.
+          #
+          #   @param bytes [Array<Float>] The bytes of the token.
+          #
+          #   @param logprob [Float] The log probability of the token.
         end
       end
     end

lib/openai/models/audio/transcription_create_params.rb

@@ -83,14 +83,32 @@ class TranscriptionCreateParams < OpenAI::Internal::Type::BaseModel
                  -> { OpenAI::Internal::Type::ArrayOf[enum: OpenAI::Models::Audio::TranscriptionCreateParams::TimestampGranularity] }
 
         # @!method initialize(file:, model:, include: nil, language: nil, prompt: nil, response_format: nil, temperature: nil, timestamp_granularities: nil, request_options: {})
-        #   @param file [Pathname, StringIO]
-        #   @param model [String, Symbol, OpenAI::Models::AudioModel]
-        #   @param include [Array<Symbol, OpenAI::Models::Audio::TranscriptionInclude>]
-        #   @param language [String]
-        #   @param prompt [String]
-        #   @param response_format [Symbol, OpenAI::Models::AudioResponseFormat]
-        #   @param temperature [Float]
-        #   @param timestamp_granularities [Array<Symbol, OpenAI::Models::Audio::TranscriptionCreateParams::TimestampGranularity>]
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Audio::TranscriptionCreateParams} for more details.
+        #
+        #   @param file [Pathname, StringIO] The audio file object (not file name) to transcribe, in one of these formats: fl
+        #   ...
+        #
+        #   @param model [String, Symbol, OpenAI::Models::AudioModel] ID of the model to use. The options are `gpt-4o-transcribe`, `gpt-4o-mini-transc
+        #   ...
+        #
+        #   @param include [Array<Symbol, OpenAI::Models::Audio::TranscriptionInclude>] Additional information to include in the transcription response. ...
+        #
+        #   @param language [String] The language of the input audio. Supplying the input language in [ISO-639-1](htt
+        #   ...
+        #
+        #   @param prompt [String] An optional text to guide the model's style or continue a previous audio segment
+        #   ...
+        #
+        #   @param response_format [Symbol, OpenAI::Models::AudioResponseFormat] The format of the output, in one of these options: `json`, `text`, `srt`, `verbo
+        #   ...
+        #
+        #   @param temperature [Float] The sampling temperature, between 0 and 1. Higher values like 0.8 will make the
+        #   ...
+        #
+        #   @param timestamp_granularities [Array<Symbol, OpenAI::Models::Audio::TranscriptionCreateParams::TimestampGranularity>] The timestamp granularities to populate for this transcription. `response_format
+        #   ...
+        #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 
         # ID of the model to use. The options are `gpt-4o-transcribe`,

lib/openai/models/audio/transcription_segment.rb

@@ -68,16 +68,31 @@ class TranscriptionSegment < OpenAI::Internal::Type::BaseModel
         required :tokens, OpenAI::Internal::Type::ArrayOf[Integer]
 
         # @!method initialize(id:, avg_logprob:, compression_ratio:, end_:, no_speech_prob:, seek:, start:, temperature:, text:, tokens:)
-        #   @param id [Integer]
-        #   @param avg_logprob [Float]
-        #   @param compression_ratio [Float]
-        #   @param end_ [Float]
-        #   @param no_speech_prob [Float]
-        #   @param seek [Integer]
-        #   @param start [Float]
-        #   @param temperature [Float]
-        #   @param text [String]
-        #   @param tokens [Array<Integer>]
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Audio::TranscriptionSegment} for more details.
+        #
+        #   @param id [Integer] Unique identifier of the segment.
+        #
+        #   @param avg_logprob [Float] Average logprob of the segment. If the value is lower than -1, consider the logp
+        #   ...
+        #
+        #   @param compression_ratio [Float] Compression ratio of the segment. If the value is greater than 2.4, consider the
+        #   ...
+        #
+        #   @param end_ [Float] End time of the segment in seconds.
+        #
+        #   @param no_speech_prob [Float] Probability of no speech in the segment. If the value is higher than 1.0 and the
+        #   ...
+        #
+        #   @param seek [Integer] Seek offset of the segment.
+        #
+        #   @param start [Float] Start time of the segment in seconds.
+        #
+        #   @param temperature [Float] Temperature parameter used for generating the segment.
+        #
+        #   @param text [String] Text content of the segment.
+        #
+        #   @param tokens [Array<Integer>] Array of token IDs for the text content.
       end
     end
   end

lib/openai/models/audio/transcription_text_delta_event.rb

@@ -26,14 +26,20 @@ class TranscriptionTextDeltaEvent < OpenAI::Internal::Type::BaseModel
                  -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Models::Audio::TranscriptionTextDeltaEvent::Logprob] }
 
         # @!method initialize(delta:, logprobs: nil, type: :"transcript.text.delta")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Audio::TranscriptionTextDeltaEvent} for more details.
+        #
         #   Emitted when there is an additional text delta. This is also the first event
         #   emitted when the transcription starts. Only emitted when you
         #   [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription)
         #   with the `Stream` parameter set to `true`.
         #
-        #   @param delta [String]
-        #   @param logprobs [Array<OpenAI::Models::Audio::TranscriptionTextDeltaEvent::Logprob>]
-        #   @param type [Symbol, :"transcript.text.delta"]
+        #   @param delta [String] The text delta that was additionally transcribed. ...
+        #
+        #   @param logprobs [Array<OpenAI::Models::Audio::TranscriptionTextDeltaEvent::Logprob>] The log probabilities of the delta. Only included if you [create a transcription
+        #   ...
+        #
+        #   @param type [Symbol, :"transcript.text.delta"] The type of the event. Always `transcript.text.delta`. ...
 
         class Logprob < OpenAI::Internal::Type::BaseModel
           # @!attribute token
@@ -55,9 +61,14 @@ class Logprob < OpenAI::Internal::Type::BaseModel
           optional :logprob, Float
 
           # @!method initialize(token: nil, bytes: nil, logprob: nil)
-          #   @param token [String]
-          #   @param bytes [Array<Object>]
-          #   @param logprob [Float]
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Audio::TranscriptionTextDeltaEvent::Logprob} for more details.
+          #
+          #   @param token [String] The token that was used to generate the log probability. ...
+          #
+          #   @param bytes [Array<Object>] The bytes that were used to generate the log probability. ...
+          #
+          #   @param logprob [Float] The log probability of the token. ...
         end
       end
     end

lib/openai/models/audio/transcription_text_done_event.rb

@@ -27,14 +27,20 @@ class TranscriptionTextDoneEvent < OpenAI::Internal::Type::BaseModel
                  -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Models::Audio::TranscriptionTextDoneEvent::Logprob] }
 
         # @!method initialize(text:, logprobs: nil, type: :"transcript.text.done")
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Audio::TranscriptionTextDoneEvent} for more details.
+        #
         #   Emitted when the transcription is complete. Contains the complete transcription
         #   text. Only emitted when you
         #   [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription)
         #   with the `Stream` parameter set to `true`.
         #
-        #   @param text [String]
-        #   @param logprobs [Array<OpenAI::Models::Audio::TranscriptionTextDoneEvent::Logprob>]
-        #   @param type [Symbol, :"transcript.text.done"]
+        #   @param text [String] The text that was transcribed. ...
+        #
+        #   @param logprobs [Array<OpenAI::Models::Audio::TranscriptionTextDoneEvent::Logprob>] The log probabilities of the individual tokens in the transcription. Only includ
+        #   ...
+        #
+        #   @param type [Symbol, :"transcript.text.done"] The type of the event. Always `transcript.text.done`. ...
 
         class Logprob < OpenAI::Internal::Type::BaseModel
           # @!attribute token
@@ -56,9 +62,14 @@ class Logprob < OpenAI::Internal::Type::BaseModel
           optional :logprob, Float
 
           # @!method initialize(token: nil, bytes: nil, logprob: nil)
-          #   @param token [String]
-          #   @param bytes [Array<Object>]
-          #   @param logprob [Float]
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Audio::TranscriptionTextDoneEvent::Logprob} for more details.
+          #
+          #   @param token [String] The token that was used to generate the log probability. ...
+          #
+          #   @param bytes [Array<Object>] The bytes that were used to generate the log probability. ...
+          #
+          #   @param logprob [Float] The log probability of the token. ...
         end
       end
     end

lib/openai/models/audio/transcription_verbose.rb

@@ -38,11 +38,15 @@ class TranscriptionVerbose < OpenAI::Internal::Type::BaseModel
         #   Represents a verbose json transcription response returned by model, based on the
         #   provided input.
         #
-        #   @param duration [Float]
-        #   @param language [String]
-        #   @param text [String]
-        #   @param segments [Array<OpenAI::Models::Audio::TranscriptionSegment>]
-        #   @param words [Array<OpenAI::Models::Audio::TranscriptionWord>]
+        #   @param duration [Float] The duration of the input audio.
+        #
+        #   @param language [String] The language of the input audio.
+        #
+        #   @param text [String] The transcribed text.
+        #
+        #   @param segments [Array<OpenAI::Models::Audio::TranscriptionSegment>] Segments of the transcribed text and their corresponding details.
+        #
+        #   @param words [Array<OpenAI::Models::Audio::TranscriptionWord>] Extracted words and their corresponding timestamps.
       end
     end
   end

lib/openai/models/audio/transcription_word.rb

@@ -23,9 +23,11 @@ class TranscriptionWord < OpenAI::Internal::Type::BaseModel
         required :word, String
 
         # @!method initialize(end_:, start:, word:)
-        #   @param end_ [Float]
-        #   @param start [Float]
-        #   @param word [String]
+        #   @param end_ [Float] End time of the word in seconds.
+        #
+        #   @param start [Float] Start time of the word in seconds.
+        #
+        #   @param word [String] The text content of the word.
       end
     end
   end

lib/openai/models/audio/translation_create_params.rb

@@ -49,11 +49,24 @@ class TranslationCreateParams < OpenAI::Internal::Type::BaseModel
         optional :temperature, Float
 
         # @!method initialize(file:, model:, prompt: nil, response_format: nil, temperature: nil, request_options: {})
-        #   @param file [Pathname, StringIO]
-        #   @param model [String, Symbol, OpenAI::Models::AudioModel]
-        #   @param prompt [String]
-        #   @param response_format [Symbol, OpenAI::Models::Audio::TranslationCreateParams::ResponseFormat]
-        #   @param temperature [Float]
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::Audio::TranslationCreateParams} for more details.
+        #
+        #   @param file [Pathname, StringIO] The audio file object (not file name) translate, in one of these formats: flac,
+        #   ...
+        #
+        #   @param model [String, Symbol, OpenAI::Models::AudioModel] ID of the model to use. Only `whisper-1` (which is powered by our open source Wh
+        #   ...
+        #
+        #   @param prompt [String] An optional text to guide the model's style or continue a previous audio segment
+        #   ...
+        #
+        #   @param response_format [Symbol, OpenAI::Models::Audio::TranslationCreateParams::ResponseFormat] The format of the output, in one of these options: `json`, `text`, `srt`, `verbo
+        #   ...
+        #
+        #   @param temperature [Float] The sampling temperature, between 0 and 1. Higher values like 0.8 will make the
+        #   ...
+        #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 
         # ID of the model to use. Only `whisper-1` (which is powered by our open source

lib/openai/models/audio/translation_verbose.rb

@@ -29,10 +29,13 @@ class TranslationVerbose < OpenAI::Internal::Type::BaseModel
         optional :segments, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Models::Audio::TranscriptionSegment] }
 
         # @!method initialize(duration:, language:, text:, segments: nil)
-        #   @param duration [Float]
-        #   @param language [String]
-        #   @param text [String]
-        #   @param segments [Array<OpenAI::Models::Audio::TranscriptionSegment>]
+        #   @param duration [Float] The duration of the input audio.
+        #
+        #   @param language [String] The language of the output translation (always `english`).
+        #
+        #   @param text [String] The translated text.
+        #
+        #   @param segments [Array<OpenAI::Models::Audio::TranscriptionSegment>] Segments of the translated text and their corresponding details.
       end
     end
   end

lib/openai/models/auto_file_chunking_strategy_param.rb

@@ -13,7 +13,7 @@ class AutoFileChunkingStrategyParam < OpenAI::Internal::Type::BaseModel
       #   The default strategy. This strategy currently uses a `max_chunk_size_tokens` of
       #   `800` and `chunk_overlap_tokens` of `400`.
       #
-      #   @param type [Symbol, :auto]
+      #   @param type [Symbol, :auto] Always `auto`.
     end
   end
 end