openai 0.87.0 → 0.89.0

data/lib/openai/models/audio/transcription_segment.rb

@@ -68,28 +68,38 @@ module OpenAI
         required :tokens, OpenAI::Internal::Type::ArrayOf[Integer]
 
         # @!method initialize(id:, avg_logprob:, compression_ratio:, end_:, no_speech_prob:, seek:, start:, temperature:, text:, tokens:)
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Audio::TranscriptionSegment} for more details.
+        #   @param id [Integer]
+        #     Unique identifier of the segment.
         #
-        #   @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
+        #     logprobs failed.
         #
-        #   @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
+        #     compression failed.
         #
-        #   @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 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
+        #     `avg_logprob` is below -1, consider this segment silent.
         #
-        #   @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 seek [Integer] Seek offset of the segment.
+        #   @param start [Float]
+        #     Start time of the segment in seconds.
         #
-        #   @param start [Float] Start time of the segment in seconds.
+        #   @param temperature [Float]
+        #     Temperature parameter used for generating the segment.
         #
-        #   @param temperature [Float] Temperature parameter used for generating the segment.
+        #   @param text [String]
+        #     Text content of the segment.
         #
-        #   @param text [String] Text content of the segment.
-        #
-        #   @param tokens [Array<Integer>] Array of token IDs for the text content.
+        #   @param tokens [Array<Integer>]
+        #     Array of token IDs for the text content.
       end
     end
   end

data/lib/openai/models/audio/transcription_stream_event.rb

@@ -5,20 +5,20 @@ module OpenAI
     module Audio
       # Emitted when a diarized transcription returns a completed segment with speaker
       # information. Only emitted when you
-      # [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription)
+      # [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
       # with `stream` set to `true` and `response_format` set to `diarized_json`.
       module TranscriptionStreamEvent
         extend OpenAI::Internal::Type::Union
 
         discriminator :type
 
-        # Emitted when a diarized transcription returns a completed segment with speaker information. Only emitted when you [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription) with `stream` set to `true` and `response_format` set to `diarized_json`.
+        # Emitted when a diarized transcription returns a completed segment with speaker information. Only emitted when you [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create) with `stream` set to `true` and `response_format` set to `diarized_json`.
         variant :"transcript.text.segment", -> { OpenAI::Audio::TranscriptionTextSegmentEvent }
 
-        # 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`.
+        # 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://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create) with the `Stream` parameter set to `true`.
         variant :"transcript.text.delta", -> { OpenAI::Audio::TranscriptionTextDeltaEvent }
 
-        # 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`.
+        # Emitted when the transcription is complete. Contains the complete transcription text. Only emitted when you [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create) with the `Stream` parameter set to `true`.
         variant :"transcript.text.done", -> { OpenAI::Audio::TranscriptionTextDoneEvent }
 
         # @!method self.variants

data/lib/openai/models/audio/transcription_text_delta_event.rb

@@ -18,7 +18,7 @@ module OpenAI
 
         # @!attribute logprobs
         #   The log probabilities of the delta. Only included if you
-        #   [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription)
+        #   [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
         #   with the `include[]` parameter set to `logprobs`.
         #
         #   @return [Array<OpenAI::Models::Audio::TranscriptionTextDeltaEvent::Logprob>, nil]
@@ -35,22 +35,25 @@ module OpenAI
         optional :segment_id, String
 
         # @!method initialize(delta:, logprobs: nil, segment_id: 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)
+        #   [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
         #   with the `Stream` parameter set to `true`.
         #
-        #   @param delta [String] The text delta that was additionally transcribed.
+        #   @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 logprobs [Array<OpenAI::Models::Audio::TranscriptionTextDeltaEvent::Logprob>]
+        #     The log probabilities of the delta. Only included if you
+        #     [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
+        #     with the `include[]` parameter set to `logprobs`.
         #
-        #   @param segment_id [String] Identifier of the diarized segment that this delta belongs to. Only present when
+        #   @param segment_id [String]
+        #     Identifier of the diarized segment that this delta belongs to. Only present when
+        #     using `gpt-4o-transcribe-diarize`.
         #
-        #   @param type [Symbol, :"transcript.text.delta"] The type of the event. Always `transcript.text.delta`.
-
+        #   @param type [Symbol, :"transcript.text.delta"]
+        #     The type of the event. Always `transcript.text.delta`.
         class Logprob < OpenAI::Internal::Type::BaseModel
           # @!attribute token
           #   The token that was used to generate the log probability.
@@ -71,14 +74,14 @@ module OpenAI
           optional :logprob, Float
 
           # @!method initialize(token: nil, bytes: nil, logprob: nil)
-          #   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 token [String]
+          #     The token that was used to generate the log probability.
           #
-          #   @param bytes [Array<Integer>] The bytes that were used to generate the log probability.
+          #   @param bytes [Array<Integer>]
+          #     The bytes that were used to generate the log probability.
           #
-          #   @param logprob [Float] The log probability of the token.
+          #   @param logprob [Float]
+          #     The log probability of the token.
         end
       end
     end

data/lib/openai/models/audio/transcription_text_done_event.rb

@@ -26,7 +26,7 @@ module OpenAI
         # @!attribute logprobs
         #   The log probabilities of the individual tokens in the transcription. Only
         #   included if you
-        #   [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription)
+        #   [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
         #   with the `include[]` parameter set to `logprobs`.
         #
         #   @return [Array<OpenAI::Models::Audio::TranscriptionTextDoneEvent::Logprob>, nil]
@@ -42,24 +42,29 @@ module OpenAI
         optional :usage, -> { OpenAI::Audio::TranscriptionTextDoneEvent::Usage }
 
         # @!method initialize(text:, languages: nil, logprobs: nil, usage: 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)
+        #   [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
         #   with the `Stream` parameter set to `true`.
         #
-        #   @param text [String] The text that was transcribed.
+        #   @param text [String]
+        #     The text that was transcribed.
         #
-        #   @param languages [Array<OpenAI::Models::Audio::TranscriptionLanguage>] The languages detected in the audio. Returned by `gpt-transcribe`. An empty arra
+        #   @param languages [Array<OpenAI::Models::Audio::TranscriptionLanguage>]
+        #     The languages detected in the audio. Returned by `gpt-transcribe`. An empty
+        #     array indicates that no language could be reliably detected.
         #
-        #   @param logprobs [Array<OpenAI::Models::Audio::TranscriptionTextDoneEvent::Logprob>] The log probabilities of the individual tokens in the transcription. Only includ
+        #   @param logprobs [Array<OpenAI::Models::Audio::TranscriptionTextDoneEvent::Logprob>]
+        #     The log probabilities of the individual tokens in the transcription. Only
+        #     included if you
+        #     [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
+        #     with the `include[]` parameter set to `logprobs`.
         #
-        #   @param usage [OpenAI::Models::Audio::TranscriptionTextDoneEvent::Usage] Usage statistics for models billed by token usage.
+        #   @param usage [OpenAI::Models::Audio::TranscriptionTextDoneEvent::Usage]
+        #     Usage statistics for models billed by token usage.
         #
-        #   @param type [Symbol, :"transcript.text.done"] The type of the event. Always `transcript.text.done`.
-
+        #   @param type [Symbol, :"transcript.text.done"]
+        #     The type of the event. Always `transcript.text.done`.
         class Logprob < OpenAI::Internal::Type::BaseModel
           # @!attribute token
           #   The token that was used to generate the log probability.
@@ -80,14 +85,14 @@ module OpenAI
           optional :logprob, Float
 
           # @!method initialize(token: nil, bytes: nil, logprob: nil)
-          #   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 token [String]
+          #     The token that was used to generate the log probability.
           #
-          #   @param bytes [Array<Integer>] The bytes that were used to generate the log probability.
+          #   @param bytes [Array<Integer>]
+          #     The bytes that were used to generate the log probability.
           #
-          #   @param logprob [Float] The log probability of the token.
+          #   @param logprob [Float]
+          #     The log probability of the token.
         end
 
         # @see OpenAI::Models::Audio::TranscriptionTextDoneEvent#usage
@@ -125,15 +130,20 @@ module OpenAI
           # @!method initialize(input_tokens:, output_tokens:, total_tokens:, input_token_details: nil, type: :tokens)
           #   Usage statistics for models billed by token usage.
           #
-          #   @param input_tokens [Integer] Number of input tokens billed for this request.
+          #   @param input_tokens [Integer]
+          #     Number of input tokens billed for this request.
           #
-          #   @param output_tokens [Integer] Number of output tokens generated.
+          #   @param output_tokens [Integer]
+          #     Number of output tokens generated.
           #
-          #   @param total_tokens [Integer] Total number of tokens used (input + output).
+          #   @param total_tokens [Integer]
+          #     Total number of tokens used (input + output).
           #
-          #   @param input_token_details [OpenAI::Models::Audio::TranscriptionTextDoneEvent::Usage::InputTokenDetails] Details about the input tokens billed for this request.
+          #   @param input_token_details [OpenAI::Models::Audio::TranscriptionTextDoneEvent::Usage::InputTokenDetails]
+          #     Details about the input tokens billed for this request.
           #
-          #   @param type [Symbol, :tokens] The type of the usage object. Always `tokens` for this variant.
+          #   @param type [Symbol, :tokens]
+          #     The type of the usage object. Always `tokens` for this variant.
 
           # @see OpenAI::Models::Audio::TranscriptionTextDoneEvent::Usage#input_token_details
           class InputTokenDetails < OpenAI::Internal::Type::BaseModel
@@ -152,9 +162,11 @@ module OpenAI
             # @!method initialize(audio_tokens: nil, text_tokens: nil)
             #   Details about the input tokens billed for this request.
             #
-            #   @param audio_tokens [Integer] Number of audio tokens billed for this request.
+            #   @param audio_tokens [Integer]
+            #     Number of audio tokens billed for this request.
             #
-            #   @param text_tokens [Integer] Number of text tokens billed for this request.
+            #   @param text_tokens [Integer]
+            #     Number of text tokens billed for this request.
           end
         end
       end

data/lib/openai/models/audio/transcription_text_segment_event.rb

@@ -43,20 +43,26 @@ module OpenAI
         # @!method initialize(id:, end_:, speaker:, start:, text:, type: :"transcript.text.segment")
         #   Emitted when a diarized transcription returns a completed segment with speaker
         #   information. Only emitted when you
-        #   [create a transcription](https://platform.openai.com/docs/api-reference/audio/create-transcription)
+        #   [create a transcription](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
         #   with `stream` set to `true` and `response_format` set to `diarized_json`.
         #
-        #   @param id [String] Unique identifier for the segment.
+        #   @param id [String]
+        #     Unique identifier for the segment.
         #
-        #   @param end_ [Float] End timestamp of the segment in seconds.
+        #   @param end_ [Float]
+        #     End timestamp of the segment in seconds.
         #
-        #   @param speaker [String] Speaker label for this segment.
+        #   @param speaker [String]
+        #     Speaker label for this segment.
         #
-        #   @param start [Float] Start timestamp of the segment in seconds.
+        #   @param start [Float]
+        #     Start timestamp of the segment in seconds.
         #
-        #   @param text [String] Transcript text for this segment.
+        #   @param text [String]
+        #     Transcript text for this segment.
         #
-        #   @param type [Symbol, :"transcript.text.segment"] The type of the event. Always `transcript.text.segment`.
+        #   @param type [Symbol, :"transcript.text.segment"]
+        #     The type of the event. Always `transcript.text.segment`.
       end
     end
   end

data/lib/openai/models/audio/transcription_verbose.rb

@@ -44,17 +44,23 @@ module OpenAI
         #   Represents a verbose json transcription response returned by model, based on the
         #   provided input.
         #
-        #   @param duration [Float] The duration of the input audio.
+        #   @param duration [Float]
+        #     The duration of the input audio.
         #
-        #   @param language [String] The language of the input audio.
+        #   @param language [String]
+        #     The language of the input audio.
         #
-        #   @param text [String] The transcribed text.
+        #   @param text [String]
+        #     The transcribed text.
         #
-        #   @param segments [Array<OpenAI::Models::Audio::TranscriptionSegment>] Segments of the transcribed text and their corresponding details.
+        #   @param segments [Array<OpenAI::Models::Audio::TranscriptionSegment>]
+        #     Segments of the transcribed text and their corresponding details.
         #
-        #   @param usage [OpenAI::Models::Audio::TranscriptionVerbose::Usage] Usage statistics for models billed by audio input duration.
+        #   @param usage [OpenAI::Models::Audio::TranscriptionVerbose::Usage]
+        #     Usage statistics for models billed by audio input duration.
         #
-        #   @param words [Array<OpenAI::Models::Audio::TranscriptionWord>] Extracted words and their corresponding timestamps.
+        #   @param words [Array<OpenAI::Models::Audio::TranscriptionWord>]
+        #     Extracted words and their corresponding timestamps.
 
         # @see OpenAI::Models::Audio::TranscriptionVerbose#usage
         class Usage < OpenAI::Internal::Type::BaseModel
@@ -73,9 +79,11 @@ module OpenAI
           # @!method initialize(seconds:, type: :duration)
           #   Usage statistics for models billed by audio input duration.
           #
-          #   @param seconds [Float] Duration of the input audio in seconds.
+          #   @param seconds [Float]
+          #     Duration of the input audio in seconds.
           #
-          #   @param type [Symbol, :duration] The type of the usage object. Always `duration` for this variant.
+          #   @param type [Symbol, :duration]
+          #     The type of the usage object. Always `duration` for this variant.
         end
       end
     end

data/lib/openai/models/audio/transcription_word.rb

@@ -23,11 +23,14 @@ module OpenAI
         required :word, String
 
         # @!method initialize(end_:, start:, word:)
-        #   @param end_ [Float] End time of the word in seconds.
+        #   @param end_ [Float]
+        #     End time of the word in seconds.
         #
-        #   @param start [Float] Start 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.
+        #   @param word [String]
+        #     The text content of the word.
       end
     end
   end

data/lib/openai/models/audio/translation_create_params.rb

@@ -31,7 +31,7 @@ module OpenAI
         # @!attribute prompt
         #   An optional text to guide the model's style or continue a previous audio
         #   segment. The
-        #   [prompt](https://platform.openai.com/docs/guides/speech-to-text#prompting)
+        #   [prompt](https://developers.openai.com/api/docs/guides/speech-to-text#prompting)
         #   should be in English.
         #
         #   @return [String, nil]
@@ -55,18 +55,36 @@ module OpenAI
         optional :temperature, Float
 
         # @!method initialize(file:, model:, prompt: nil, response_format: nil, temperature: nil, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {OpenAI::Models::Audio::TranslationCreateParams} for more details.
+        #   @param file [Pathname, StringIO, IO, String, OpenAI::FilePart]
+        #     The audio file object (not file name) translate, in one of these formats: flac,
+        #     mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm. The request must include enough
+        #     format metadata for the file to be identified. We recommend an extension-bearing
+        #     filename and an appropriate content type.
         #
-        #   @param file [Pathname, StringIO, IO, String, OpenAI::FilePart] The audio file object (not file name) translate, in one of these formats: flac,
+        #     `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
+        #     metadata. Use `OpenAI::FilePart` when you need to override the filename or
+        #     content type.
         #
-        #   @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 model [String, Symbol, OpenAI::Models::AudioModel]
+        #     ID of the model to use. Only `whisper-1` (which is powered by our open source
+        #     Whisper V2 model) is currently available.
         #
-        #   @param prompt [String] An optional text to guide the model's style or continue a previous audio segment
+        #   @param prompt [String]
+        #     An optional text to guide the model's style or continue a previous audio
+        #     segment. The
+        #     [prompt](https://developers.openai.com/api/docs/guides/speech-to-text#prompting)
+        #     should be in English.
         #
-        #   @param response_format [Symbol, OpenAI::Models::Audio::TranslationCreateParams::ResponseFormat] The format of the output, in one of these options: `json`, `text`, `srt`, `verbo
+        #   @param response_format [Symbol, OpenAI::Models::Audio::TranslationCreateParams::ResponseFormat]
+        #     The format of the output, in one of these options: `json`, `text`, `srt`,
+        #     `verbose_json`, or `vtt`.
         #
-        #   @param temperature [Float] The sampling temperature, between 0 and 1. Higher values like 0.8 will make the
+        #   @param temperature [Float]
+        #     The sampling temperature, between 0 and 1. Higher values like 0.8 will make the
+        #     output more random, while lower values like 0.2 will make it more focused and
+        #     deterministic. If set to 0, the model will use
+        #     [log probability](https://en.wikipedia.org/wiki/Log_probability) to
+        #     automatically increase the temperature until certain thresholds are hit.
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/openai/models/audio/translation_verbose.rb

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

data/lib/openai/models/auto_file_chunking_strategy_param.rb

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

data/lib/openai/models/batch.rb

@@ -119,8 +119,8 @@ module OpenAI
       #   Model ID used to process the batch, like `gpt-6-astra`. OpenAI offers a wide
       #   range of models with different capabilities, performance characteristics, and
       #   price points. Refer to the
-      #   [model guide](https://platform.openai.com/docs/models) to browse and compare
-      #   available models.
+      #   [model guide](https://developers.openai.com/api/docs/models) to browse and
+      #   compare available models.
       #
       #   @return [String, nil]
       optional :model, String
@@ -146,52 +146,80 @@ module OpenAI
       optional :usage, -> { OpenAI::BatchUsage }
 
       # @!method initialize(id:, completion_window:, created_at:, endpoint:, input_file_id:, status:, cancelled_at: nil, cancelling_at: nil, completed_at: nil, error_file_id: nil, errors: nil, expired_at: nil, expires_at: nil, failed_at: nil, finalizing_at: nil, in_progress_at: nil, metadata: nil, model: nil, output_file_id: nil, request_counts: nil, usage: nil, object: :batch)
-      #   Some parameter documentations has been truncated, see {OpenAI::Models::Batch}
-      #   for more details.
-      #
       #   @param id [String]
       #
-      #   @param completion_window [String] The time frame within which the batch should be processed.
+      #   @param completion_window [String]
+      #     The time frame within which the batch should be processed.
       #
-      #   @param created_at [Integer] The Unix timestamp (in seconds) for when the batch was created.
+      #   @param created_at [Integer]
+      #     The Unix timestamp (in seconds) for when the batch was created.
       #
-      #   @param endpoint [String] The OpenAI API endpoint used by the batch.
+      #   @param endpoint [String]
+      #     The OpenAI API endpoint used by the batch.
       #
-      #   @param input_file_id [String] The ID of the input file for the batch.
+      #   @param input_file_id [String]
+      #     The ID of the input file for the batch.
       #
-      #   @param status [Symbol, OpenAI::Models::Batch::Status] The current status of the batch.
+      #   @param status [Symbol, OpenAI::Models::Batch::Status]
+      #     The current status of the batch.
       #
-      #   @param cancelled_at [Integer] The Unix timestamp (in seconds) for when the batch was cancelled.
+      #   @param cancelled_at [Integer]
+      #     The Unix timestamp (in seconds) for when the batch was cancelled.
       #
-      #   @param cancelling_at [Integer] The Unix timestamp (in seconds) for when the batch started cancelling.
+      #   @param cancelling_at [Integer]
+      #     The Unix timestamp (in seconds) for when the batch started cancelling.
       #
-      #   @param completed_at [Integer] The Unix timestamp (in seconds) for when the batch was completed.
+      #   @param completed_at [Integer]
+      #     The Unix timestamp (in seconds) for when the batch was completed.
       #
-      #   @param error_file_id [String] The ID of the file containing the outputs of requests with errors.
+      #   @param error_file_id [String]
+      #     The ID of the file containing the outputs of requests with errors.
       #
       #   @param errors [OpenAI::Models::Batch::Errors]
       #
-      #   @param expired_at [Integer] The Unix timestamp (in seconds) for when the batch expired.
+      #   @param expired_at [Integer]
+      #     The Unix timestamp (in seconds) for when the batch expired.
+      #
+      #   @param expires_at [Integer]
+      #     The Unix timestamp (in seconds) for when the batch will expire.
       #
-      #   @param expires_at [Integer] The Unix timestamp (in seconds) for when the batch will expire.
+      #   @param failed_at [Integer]
+      #     The Unix timestamp (in seconds) for when the batch failed.
       #
-      #   @param failed_at [Integer] The Unix timestamp (in seconds) for when the batch failed.
+      #   @param finalizing_at [Integer]
+      #     The Unix timestamp (in seconds) for when the batch started finalizing.
       #
-      #   @param finalizing_at [Integer] The Unix timestamp (in seconds) for when the batch started finalizing.
+      #   @param in_progress_at [Integer]
+      #     The Unix timestamp (in seconds) for when the batch started processing.
       #
-      #   @param in_progress_at [Integer] The Unix timestamp (in seconds) for when the batch started processing.
+      #   @param metadata [Hash{Symbol=>String}, nil]
+      #     Set of 16 key-value pairs that can be attached to an object. This can be useful
+      #     for storing additional information about the object in a structured format, and
+      #     querying for objects via API or the dashboard.
       #
-      #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
+      #     Keys are strings with a maximum length of 64 characters. Values are strings with
+      #     a maximum length of 512 characters.
       #
-      #   @param model [String] Model ID used to process the batch, like `gpt-6-astra`. OpenAI
+      #   @param model [String]
+      #     Model ID used to process the batch, like `gpt-6-astra`. OpenAI offers a wide
+      #     range of models with different capabilities, performance characteristics, and
+      #     price points. Refer to the
+      #     [model guide](https://developers.openai.com/api/docs/models) to browse and
+      #     compare available models.
       #
-      #   @param output_file_id [String] The ID of the file containing the outputs of successfully executed requests.
+      #   @param output_file_id [String]
+      #     The ID of the file containing the outputs of successfully executed requests.
       #
-      #   @param request_counts [OpenAI::Models::BatchRequestCounts] The request counts for different statuses within the batch.
+      #   @param request_counts [OpenAI::Models::BatchRequestCounts]
+      #     The request counts for different statuses within the batch.
       #
-      #   @param usage [OpenAI::Models::BatchUsage] Represents token usage details including input tokens, output tokens, a
+      #   @param usage [OpenAI::Models::BatchUsage]
+      #     Represents token usage details including input tokens, output tokens, a
+      #     breakdown of output tokens, and the total tokens used. Only populated on batches
+      #     created after September 7, 2025.
       #
-      #   @param object [Symbol, :batch] The object type, which is always `batch`.
+      #   @param object [Symbol, :batch]
+      #     The object type, which is always `batch`.
 
       # The current status of the batch.
       #
@@ -228,7 +256,8 @@ module OpenAI
         # @!method initialize(data: nil, object: nil)
         #   @param data [Array<OpenAI::Models::BatchError>]
         #
-        #   @param object [String] The object type, which is always `list`.
+        #   @param object [String]
+        #     The object type, which is always `list`.
       end
     end
   end