openai 0.92.0 → 0.94.0

data/sig/openai/models/audio/transcription_text_done_event.rbs

@@ -11,28 +11,58 @@ module OpenAI
         }
 
       class TranscriptionTextDoneEvent < OpenAI::Internal::Type::BaseModel
+        # The text that was transcribed.
         attr_accessor text: String
 
+        # The type of the event. Always `transcript.text.done`.
         attr_accessor type: :"transcript.text.done"
 
+        # The languages detected in the audio. Returned by `gpt-transcribe`. An empty
+        # array indicates that no language could be reliably detected.
         attr_reader languages: ::Array[OpenAI::Audio::TranscriptionLanguage]?
 
+        # The languages detected in the audio. Returned by `gpt-transcribe`. An empty
+        # array indicates that no language could be reliably detected.
         def languages=: (
           ::Array[OpenAI::Audio::TranscriptionLanguage]
         ) -> ::Array[OpenAI::Audio::TranscriptionLanguage]
 
+        # 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`.
         attr_reader logprobs: ::Array[OpenAI::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`.
         def logprobs=: (
           ::Array[OpenAI::Audio::TranscriptionTextDoneEvent::Logprob]
         ) -> ::Array[OpenAI::Audio::TranscriptionTextDoneEvent::Logprob]
 
+        # Usage statistics for models billed by token usage.
         attr_reader usage: OpenAI::Audio::TranscriptionTextDoneEvent::Usage?
 
+        # Usage statistics for models billed by token usage.
         def usage=: (
           OpenAI::Audio::TranscriptionTextDoneEvent::Usage
         ) -> OpenAI::Audio::TranscriptionTextDoneEvent::Usage
 
+        # @param text
+        #   The text that was transcribed.
+        # @param languages
+        #   The languages detected in the audio. Returned by `gpt-transcribe`. An empty
+        #   array indicates that no language could be reliably detected.
+        # @param logprobs
+        #   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
+        #   Usage statistics for models billed by token usage.
+        # @param type
+        #   The type of the event. Always `transcript.text.done`.
         def initialize: (
           text: String,
           ?languages: ::Array[OpenAI::Audio::TranscriptionLanguage],
@@ -53,18 +83,30 @@ module OpenAI
           { ?token: String, ?bytes: ::Array[Integer], ?logprob: Float }
 
         class Logprob < OpenAI::Internal::Type::BaseModel
+          # The token that was used to generate the log probability.
           attr_reader token: String?
 
+          # The token that was used to generate the log probability.
           def token=: (String) -> String
 
+          # The bytes that were used to generate the log probability.
           attr_reader bytes: ::Array[Integer]?
 
+          # The bytes that were used to generate the log probability.
           def bytes=: (::Array[Integer]) -> ::Array[Integer]
 
+          # The log probability of the token.
           attr_reader logprob: Float?
 
+          # The log probability of the token.
           def logprob=: (Float) -> Float
 
+          # @param token
+          #   The token that was used to generate the log probability.
+          # @param bytes
+          #   The bytes that were used to generate the log probability.
+          # @param logprob
+          #   The log probability of the token.
           def initialize: (
             ?token: String,
             ?bytes: ::Array[Integer],
@@ -88,20 +130,36 @@ module OpenAI
           }
 
         class Usage < OpenAI::Internal::Type::BaseModel
+          # Number of input tokens billed for this request.
           attr_accessor input_tokens: Integer
 
+          # Number of output tokens generated.
           attr_accessor output_tokens: Integer
 
+          # Total number of tokens used (input + output).
           attr_accessor total_tokens: Integer
 
+          # The type of the usage object. Always `tokens` for this variant.
           attr_accessor type: :tokens
 
+          # Details about the input tokens billed for this request.
           attr_reader input_token_details: OpenAI::Audio::TranscriptionTextDoneEvent::Usage::InputTokenDetails?
 
+          # Details about the input tokens billed for this request.
           def input_token_details=: (
             OpenAI::Audio::TranscriptionTextDoneEvent::Usage::InputTokenDetails
           ) -> OpenAI::Audio::TranscriptionTextDoneEvent::Usage::InputTokenDetails
 
+          # @param input_tokens
+          #   Number of input tokens billed for this request.
+          # @param output_tokens
+          #   Number of output tokens generated.
+          # @param total_tokens
+          #   Total number of tokens used (input + output).
+          # @param input_token_details
+          #   Details about the input tokens billed for this request.
+          # @param type
+          #   The type of the usage object. Always `tokens` for this variant.
           def initialize: (
             input_tokens: Integer,
             output_tokens: Integer,
@@ -122,14 +180,22 @@ module OpenAI
             { ?audio_tokens: Integer, ?text_tokens: Integer }
 
           class InputTokenDetails < OpenAI::Internal::Type::BaseModel
+            # Number of audio tokens billed for this request.
             attr_reader audio_tokens: Integer?
 
+            # Number of audio tokens billed for this request.
             def audio_tokens=: (Integer) -> Integer
 
+            # Number of text tokens billed for this request.
             attr_reader text_tokens: Integer?
 
+            # Number of text tokens billed for this request.
             def text_tokens=: (Integer) -> Integer
 
+            # @param audio_tokens
+            #   Number of audio tokens billed for this request.
+            # @param text_tokens
+            #   Number of text tokens billed for this request.
             def initialize: (
               ?audio_tokens: Integer,
               ?text_tokens: Integer

data/sig/openai/models/audio/transcription_text_segment_event.rbs

@@ -12,18 +12,36 @@ module OpenAI
         }
 
       class TranscriptionTextSegmentEvent < OpenAI::Internal::Type::BaseModel
+        # Unique identifier for the segment.
         attr_accessor id: String
 
+        # End timestamp of the segment in seconds.
         attr_accessor end_: Float
 
+        # Speaker label for this segment.
         attr_accessor speaker: String
 
+        # Start timestamp of the segment in seconds.
         attr_accessor start: Float
 
+        # Transcript text for this segment.
         attr_accessor text: String
 
+        # The type of the event. Always `transcript.text.segment`.
         attr_accessor type: :"transcript.text.segment"
 
+        # @param id
+        #   Unique identifier for the segment.
+        # @param end_
+        #   End timestamp of the segment in seconds.
+        # @param speaker
+        #   Speaker label for this segment.
+        # @param start
+        #   Start timestamp of the segment in seconds.
+        # @param text
+        #   Transcript text for this segment.
+        # @param type
+        #   The type of the event. Always `transcript.text.segment`.
         def initialize: (
           id: String,
           end_: Float,

data/sig/openai/models/audio/transcription_verbose.rbs

@@ -12,30 +12,51 @@ module OpenAI
         }
 
       class TranscriptionVerbose < OpenAI::Internal::Type::BaseModel
+        # The duration of the input audio.
         attr_accessor duration: Float
 
+        # The language of the input audio.
         attr_accessor language: String
 
+        # The transcribed text.
         attr_accessor text: String
 
+        # Segments of the transcribed text and their corresponding details.
         attr_reader segments: ::Array[OpenAI::Audio::TranscriptionSegment]?
 
+        # Segments of the transcribed text and their corresponding details.
         def segments=: (
           ::Array[OpenAI::Audio::TranscriptionSegment]
         ) -> ::Array[OpenAI::Audio::TranscriptionSegment]
 
+        # Usage statistics for models billed by audio input duration.
         attr_reader usage: OpenAI::Audio::TranscriptionVerbose::Usage?
 
+        # Usage statistics for models billed by audio input duration.
         def usage=: (
           OpenAI::Audio::TranscriptionVerbose::Usage
         ) -> OpenAI::Audio::TranscriptionVerbose::Usage
 
+        # Extracted words and their corresponding timestamps.
         attr_reader words: ::Array[OpenAI::Audio::TranscriptionWord]?
 
+        # Extracted words and their corresponding timestamps.
         def words=: (
           ::Array[OpenAI::Audio::TranscriptionWord]
         ) -> ::Array[OpenAI::Audio::TranscriptionWord]
 
+        # @param duration
+        #   The duration of the input audio.
+        # @param language
+        #   The language of the input audio.
+        # @param text
+        #   The transcribed text.
+        # @param segments
+        #   Segments of the transcribed text and their corresponding details.
+        # @param usage
+        #   Usage statistics for models billed by audio input duration.
+        # @param words
+        #   Extracted words and their corresponding timestamps.
         def initialize: (
           duration: Float,
           language: String,
@@ -57,10 +78,16 @@ module OpenAI
         type usage = { seconds: Float, ?type: :duration }
 
         class Usage < OpenAI::Internal::Type::BaseModel
+          # Duration of the input audio in seconds.
           attr_accessor seconds: Float
 
+          # The type of the usage object. Always `duration` for this variant.
           attr_accessor type: :duration
 
+          # @param seconds
+          #   Duration of the input audio in seconds.
+          # @param type
+          #   The type of the usage object. Always `duration` for this variant.
           def initialize: (seconds: Float, ?type: :duration) -> void
 
           def to_hash: -> { seconds: Float, ?type: :duration }

data/sig/openai/models/audio/transcription_word.rbs

@@ -4,12 +4,21 @@ module OpenAI
       type transcription_word = { end_: Float, start: Float, word: String }
 
       class TranscriptionWord < OpenAI::Internal::Type::BaseModel
+        # End time of the word in seconds.
         attr_accessor end_: Float
 
+        # Start time of the word in seconds.
         attr_accessor start: Float
 
+        # The text content of the word.
         attr_accessor word: String
 
+        # @param end_
+        #   End time of the word in seconds.
+        # @param start
+        #   Start time of the word in seconds.
+        # @param word
+        #   The text content of the word.
         def initialize: (end_: Float, start: Float, word: String) -> void
 
         def to_hash: -> { end_: Float, start: Float, word: String }

data/sig/openai/models/audio/translation_create_params.rbs

@@ -15,24 +15,82 @@ module OpenAI
         extend OpenAI::Internal::Type::RequestParameters::Converter
         include OpenAI::Internal::Type::RequestParameters
 
+        # 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.
+        #
+        # `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.
         attr_accessor file: OpenAI::Internal::file_input
 
+        # ID of the model to use. Only `whisper-1` (which is powered by our open source
+        # Whisper V2 model) is currently available.
         attr_accessor model: OpenAI::Models::Audio::TranslationCreateParams::model
 
+        # 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.
         attr_reader 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.
         def prompt=: (String) -> String
 
+        # The format of the output, in one of these options: `json`, `text`, `srt`,
+        # `verbose_json`, or `vtt`.
         attr_reader response_format: OpenAI::Models::Audio::TranslationCreateParams::response_format?
 
+        # The format of the output, in one of these options: `json`, `text`, `srt`,
+        # `verbose_json`, or `vtt`.
         def response_format=: (
           OpenAI::Models::Audio::TranslationCreateParams::response_format
         ) -> OpenAI::Models::Audio::TranslationCreateParams::response_format
 
+        # 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.
         attr_reader 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.
         def temperature=: (Float) -> Float
 
+        # @param file
+        #   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.
+        #
+        #   `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
+        #   ID of the model to use. Only `whisper-1` (which is powered by our open source
+        #   Whisper V2 model) is currently available.
+        # @param prompt
+        #   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
+        #   The format of the output, in one of these options: `json`, `text`, `srt`,
+        #   `verbose_json`, or `vtt`.
+        # @param temperature
+        #   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.
         def initialize: (
           file: OpenAI::Internal::file_input,
           model: OpenAI::Models::Audio::TranslationCreateParams::model,

data/sig/openai/models/audio/translation_verbose.rbs

@@ -10,18 +10,31 @@ module OpenAI
         }
 
       class TranslationVerbose < OpenAI::Internal::Type::BaseModel
+        # The duration of the input audio.
         attr_accessor duration: Float
 
+        # The language of the output translation (always `english`).
         attr_accessor language: String
 
+        # The translated text.
         attr_accessor text: String
 
+        # Segments of the translated text and their corresponding details.
         attr_reader segments: ::Array[OpenAI::Audio::TranscriptionSegment]?
 
+        # Segments of the translated text and their corresponding details.
         def segments=: (
           ::Array[OpenAI::Audio::TranscriptionSegment]
         ) -> ::Array[OpenAI::Audio::TranscriptionSegment]
 
+        # @param duration
+        #   The duration of the input audio.
+        # @param language
+        #   The language of the output translation (always `english`).
+        # @param text
+        #   The translated text.
+        # @param segments
+        #   Segments of the translated text and their corresponding details.
         def initialize: (
           duration: Float,
           language: String,

data/sig/openai/models/auto_file_chunking_strategy_param.rbs

@@ -3,8 +3,11 @@ module OpenAI
     type auto_file_chunking_strategy_param = { ?type: :auto }
 
     class AutoFileChunkingStrategyParam < OpenAI::Internal::Type::BaseModel
+      # Always `auto`.
       attr_accessor type: :auto
 
+      # @param type
+      #   Always `auto`.
       def initialize: (?type: :auto) -> void
 
       def to_hash: -> { ?type: :auto }

data/sig/openai/models/batch.rbs

@@ -29,78 +29,179 @@ module OpenAI
     class Batch < OpenAI::Internal::Type::BaseModel
       attr_accessor id: String
 
+      # The time frame within which the batch should be processed.
       attr_accessor completion_window: String
 
+      # The Unix timestamp (in seconds) for when the batch was created.
       attr_accessor created_at: Integer
 
+      # The OpenAI API endpoint used by the batch.
       attr_accessor endpoint: String
 
+      # The ID of the input file for the batch.
       attr_accessor input_file_id: String
 
+      # The object type, which is always `batch`.
       attr_accessor object: :batch
 
+      # The current status of the batch.
       attr_accessor status: OpenAI::Models::Batch::status
 
+      # The Unix timestamp (in seconds) for when the batch was cancelled.
       attr_reader cancelled_at: Integer?
 
+      # The Unix timestamp (in seconds) for when the batch was cancelled.
       def cancelled_at=: (Integer) -> Integer
 
+      # The Unix timestamp (in seconds) for when the batch started cancelling.
       attr_reader cancelling_at: Integer?
 
+      # The Unix timestamp (in seconds) for when the batch started cancelling.
       def cancelling_at=: (Integer) -> Integer
 
+      # The Unix timestamp (in seconds) for when the batch was completed.
       attr_reader completed_at: Integer?
 
+      # The Unix timestamp (in seconds) for when the batch was completed.
       def completed_at=: (Integer) -> Integer
 
+      # The ID of the file containing the outputs of requests with errors.
       attr_reader error_file_id: String?
 
+      # The ID of the file containing the outputs of requests with errors.
       def error_file_id=: (String) -> String
 
       attr_reader errors: OpenAI::Batch::Errors?
 
       def errors=: (OpenAI::Batch::Errors) -> OpenAI::Batch::Errors
 
+      # The Unix timestamp (in seconds) for when the batch expired.
       attr_reader expired_at: Integer?
 
+      # The Unix timestamp (in seconds) for when the batch expired.
       def expired_at=: (Integer) -> Integer
 
+      # The Unix timestamp (in seconds) for when the batch will expire.
       attr_reader expires_at: Integer?
 
+      # The Unix timestamp (in seconds) for when the batch will expire.
       def expires_at=: (Integer) -> Integer
 
+      # The Unix timestamp (in seconds) for when the batch failed.
       attr_reader failed_at: Integer?
 
+      # The Unix timestamp (in seconds) for when the batch failed.
       def failed_at=: (Integer) -> Integer
 
+      # The Unix timestamp (in seconds) for when the batch started finalizing.
       attr_reader finalizing_at: Integer?
 
+      # The Unix timestamp (in seconds) for when the batch started finalizing.
       def finalizing_at=: (Integer) -> Integer
 
+      # The Unix timestamp (in seconds) for when the batch started processing.
       attr_reader in_progress_at: Integer?
 
+      # The Unix timestamp (in seconds) for when the batch started processing.
       def in_progress_at=: (Integer) -> Integer
 
+      # 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.
+      #
+      # Keys are strings with a maximum length of 64 characters. Values are strings with
+      # a maximum length of 512 characters.
       attr_accessor metadata: OpenAI::Models::metadata?
 
+      # 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.
       attr_reader 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.
       def model=: (String) -> String
 
+      # The ID of the file containing the outputs of successfully executed requests.
       attr_reader output_file_id: String?
 
+      # The ID of the file containing the outputs of successfully executed requests.
       def output_file_id=: (String) -> String
 
+      # The request counts for different statuses within the batch.
       attr_reader request_counts: OpenAI::BatchRequestCounts?
 
+      # The request counts for different statuses within the batch.
       def request_counts=: (
         OpenAI::BatchRequestCounts
       ) -> OpenAI::BatchRequestCounts
 
+      # 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.
       attr_reader usage: OpenAI::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.
       def usage=: (OpenAI::BatchUsage) -> OpenAI::BatchUsage
 
+      # @param completion_window
+      #   The time frame within which the batch should be processed.
+      # @param created_at
+      #   The Unix timestamp (in seconds) for when the batch was created.
+      # @param endpoint
+      #   The OpenAI API endpoint used by the batch.
+      # @param input_file_id
+      #   The ID of the input file for the batch.
+      # @param status
+      #   The current status of the batch.
+      # @param cancelled_at
+      #   The Unix timestamp (in seconds) for when the batch was cancelled.
+      # @param cancelling_at
+      #   The Unix timestamp (in seconds) for when the batch started cancelling.
+      # @param completed_at
+      #   The Unix timestamp (in seconds) for when the batch was completed.
+      # @param error_file_id
+      #   The ID of the file containing the outputs of requests with errors.
+      # @param expired_at
+      #   The Unix timestamp (in seconds) for when the batch expired.
+      # @param expires_at
+      #   The Unix timestamp (in seconds) for when the batch will expire.
+      # @param failed_at
+      #   The Unix timestamp (in seconds) for when the batch failed.
+      # @param finalizing_at
+      #   The Unix timestamp (in seconds) for when the batch started finalizing.
+      # @param in_progress_at
+      #   The Unix timestamp (in seconds) for when the batch started processing.
+      # @param metadata
+      #   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.
+      #
+      #   Keys are strings with a maximum length of 64 characters. Values are strings with
+      #   a maximum length of 512 characters.
+      # @param model
+      #   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
+      #   The ID of the file containing the outputs of successfully executed requests.
+      # @param request_counts
+      #   The request counts for different statuses within the batch.
+      # @param usage
+      #   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
+      #   The object type, which is always `batch`.
       def initialize: (
         id: String,
         completion_window: String,
@@ -183,10 +284,14 @@ module OpenAI
 
         def data=: (::Array[OpenAI::BatchError]) -> ::Array[OpenAI::BatchError]
 
+        # The object type, which is always `list`.
         attr_reader object: String?
 
+        # The object type, which is always `list`.
         def object=: (String) -> String
 
+        # @param object
+        #   The object type, which is always `list`.
         def initialize: (
           ?data: ::Array[OpenAI::BatchError],
           ?object: String