openai 0.87.0 → 0.89.0

data/lib/openai/resources/admin/organization/users/roles.rb

@@ -10,9 +10,11 @@ module OpenAI
             #
             # @overload create(user_id, role_id:, request_options: {})
             #
-            # @param user_id [String] The ID of the user that should receive the organization role.
+            # @param user_id [String]
+            #   The ID of the user that should receive the organization role.
             #
-            # @param role_id [String] Identifier of the role to assign.
+            # @param role_id [String]
+            #   Identifier of the role to assign.
             #
             # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
             #
@@ -35,9 +37,11 @@ module OpenAI
             #
             # @overload retrieve(role_id, user_id:, request_options: {})
             #
-            # @param role_id [String] The ID of the organization role to retrieve for the user.
+            # @param role_id [String]
+            #   The ID of the organization role to retrieve for the user.
             #
-            # @param user_id [String] The ID of the user to inspect.
+            # @param user_id [String]
+            #   The ID of the user to inspect.
             #
             # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
             #
@@ -59,20 +63,22 @@ module OpenAI
               )
             end
 
-            # Some parameter documentations has been truncated, see
-            # {OpenAI::Models::Admin::Organization::Users::RoleListParams} for more details.
-            #
             # Lists the organization roles assigned to a user within the organization.
             #
             # @overload list(user_id, after: nil, limit: nil, order: nil, request_options: {})
             #
-            # @param user_id [String] The ID of the user to inspect.
+            # @param user_id [String]
+            #   The ID of the user to inspect.
             #
-            # @param after [String] Cursor for pagination. Provide the value from the previous response's `next` fie
+            # @param after [String]
+            #   Cursor for pagination. Provide the value from the previous response's `next`
+            #   field to continue listing organization roles.
             #
-            # @param limit [Integer] A limit on the number of organization role assignments to return.
+            # @param limit [Integer]
+            #   A limit on the number of organization role assignments to return.
             #
-            # @param order [Symbol, OpenAI::Models::Admin::Organization::Users::RoleListParams::Order] Sort order for the returned organization roles.
+            # @param order [Symbol, OpenAI::Models::Admin::Organization::Users::RoleListParams::Order]
+            #   Sort order for the returned organization roles.
             #
             # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
             #
@@ -97,9 +103,11 @@ module OpenAI
             #
             # @overload delete(role_id, user_id:, request_options: {})
             #
-            # @param role_id [String] The ID of the organization role to remove from the user.
+            # @param role_id [String]
+            #   The ID of the organization role to remove from the user.
             #
-            # @param user_id [String] The ID of the user to modify.
+            # @param user_id [String]
+            #   The ID of the user to modify.
             #
             # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
             #

data/lib/openai/resources/admin/organization/users.rb

@@ -12,7 +12,8 @@ module OpenAI
           #
           # @overload retrieve(user_id, request_options: {})
           #
-          # @param user_id [String] The ID of the user.
+          # @param user_id [String]
+          #   The ID of the user.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -33,15 +34,20 @@ module OpenAI
           #
           # @overload update(user_id, developer_persona: nil, role: nil, role_id: nil, technical_level: nil, request_options: {})
           #
-          # @param user_id [String] The ID of the user.
+          # @param user_id [String]
+          #   The ID of the user.
           #
-          # @param developer_persona [String, nil] Developer persona metadata.
+          # @param developer_persona [String, nil]
+          #   Developer persona metadata.
           #
-          # @param role [String, nil] `owner` or `reader`
+          # @param role [String, nil]
+          #   `owner` or `reader`
           #
-          # @param role_id [String, nil] Role ID to assign to the user.
+          # @param role_id [String, nil]
+          #   Role ID to assign to the user.
           #
-          # @param technical_level [String, nil] Technical level metadata.
+          # @param technical_level [String, nil]
+          #   Technical level metadata.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -60,18 +66,22 @@ module OpenAI
             )
           end
 
-          # Some parameter documentations has been truncated, see
-          # {OpenAI::Models::Admin::Organization::UserListParams} for more details.
-          #
           # Lists all of the users in the organization.
           #
           # @overload list(after: nil, emails: nil, limit: nil, request_options: {})
           #
-          # @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
+          # @param after [String]
+          #   A cursor for use in pagination. `after` is an object ID that defines your place
+          #   in the list. For instance, if you make a list request and receive 100 objects,
+          #   ending with obj_foo, your subsequent call can include after=obj_foo in order to
+          #   fetch the next page of the list.
           #
-          # @param emails [Array<String>] Filter by the email address of users.
+          # @param emails [Array<String>]
+          #   Filter by the email address of users.
           #
-          # @param limit [Integer] A limit on the number of objects to be returned. Limit can range between 1 and 1
+          # @param limit [Integer]
+          #   A limit on the number of objects to be returned. Limit can range between 1 and
+          #   100, and the default is 20.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #
@@ -96,7 +106,8 @@ module OpenAI
           #
           # @overload delete(user_id, request_options: {})
           #
-          # @param user_id [String] The ID of the user.
+          # @param user_id [String]
+          #   The ID of the user.
           #
           # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
           #

data/lib/openai/resources/audio/speech.rb

@@ -5,28 +5,43 @@ module OpenAI
     class Audio
       # Turn audio into text or text into audio.
       class Speech
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Audio::SpeechCreateParams} for more details.
-        #
         # Generates audio from the input text.
         #
         # Returns the audio file content, or a stream of audio events.
         #
         # @overload create(input:, model:, voice:, instructions: nil, response_format: nil, speed: nil, stream_format: nil, request_options: {})
         #
-        # @param input [String] The text to generate audio for. The maximum length is 4096 characters.
+        # @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 model [String, Symbol, OpenAI::Models::Audio::SpeechModel]
+        #   One of the available
+        #   [TTS models](https://developers.openai.com/api/docs/guides/text-to-speech):
+        #   `tts-1`, `tts-1-hd`, `gpt-4o-mini-tts`, or `gpt-4o-mini-tts-2025-12-15`.
         #
-        # @param voice [String, Symbol, OpenAI::Models::Audio::SpeechCreateParams::Voice::ID, OpenAI::Models::Audio::SpeechCreateParams::Voice] The voice to use when generating the audio. Supported built-in voices are `alloy
+        # @param voice [String, Symbol, OpenAI::Models::Audio::SpeechCreateParams::Voice::ID, OpenAI::Models::Audio::SpeechCreateParams::Voice]
+        #   The voice to use when generating the audio. Supported built-in voices are
+        #   `alloy`, `ash`, `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`,
+        #   `shimmer`, `verse`, `marin`, and `cedar`. You may also provide a custom voice
+        #   object with an `id`, for example `{ "id": "voice_1234" }`. Previews of the
+        #   voices are available in the
+        #   [Text to speech guide](https://developers.openai.com/api/docs/guides/text-to-speech#voice-options).
         #
-        # @param instructions [String] Control the voice of your generated audio with additional instructions. Does not
+        # @param instructions [String]
+        #   Control the voice of your generated audio with additional instructions. Does not
+        #   work with `tts-1` or `tts-1-hd`.
         #
-        # @param response_format [Symbol, OpenAI::Models::Audio::SpeechCreateParams::ResponseFormat] The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`, `wav
+        # @param response_format [Symbol, OpenAI::Models::Audio::SpeechCreateParams::ResponseFormat]
+        #   The format to audio in. Supported formats are `mp3`, `opus`, `aac`, `flac`,
+        #   `wav`, and `pcm`.
         #
-        # @param speed [Float] The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is
+        # @param speed [Float]
+        #   The speed of the generated audio. Select a value from `0.25` to `4.0`. `1.0` is
+        #   the default.
         #
-        # @param stream_format [Symbol, OpenAI::Models::Audio::SpeechCreateParams::StreamFormat] The format to stream the audio in. Supported formats are `sse` and `audio`. `sse
+        # @param stream_format [Symbol, OpenAI::Models::Audio::SpeechCreateParams::StreamFormat]
+        #   The format to stream the audio in. Supported formats are `sse` and `audio`.
+        #   `sse` is not supported for `tts-1` or `tts-1-hd`.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/openai/resources/audio/transcriptions.rb

@@ -8,9 +8,6 @@ module OpenAI
         # See {OpenAI::Resources::Audio::Transcriptions#create_streaming} for streaming
         # counterpart.
         #
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Audio::TranscriptionCreateParams} for more details.
-        #
         # Transcribes audio into the input language.
         #
         # Returns a transcription object in `json`, `diarized_json`, or `verbose_json`
@@ -22,31 +19,92 @@ module OpenAI
         #
         # @overload create(file:, model:, chunking_strategy: nil, include: nil, keywords: nil, known_speaker_names: nil, known_speaker_references: nil, language: nil, languages: nil, prompt: nil, response_format: nil, temperature: nil, timestamp_granularities: nil, request_options: {})
         #
-        # @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::Models::AudioModel] ID of the model to use. The options are `gpt-transcribe`, `gpt-4o-transcribe`, `
-        #
-        # @param chunking_strategy [Symbol, :auto, OpenAI::Models::Audio::TranscriptionCreateParams::ChunkingStrategy::VadConfig, nil] Controls how the audio is cut into chunks. When set to `"auto"`, the server firs
-        #
-        # @param include [Array<Symbol, OpenAI::Models::Audio::TranscriptionInclude>] Additional information to include in the transcription response.
-        #
-        # @param keywords [Array<String>] Words or phrases to guide transcription of the input audio. Supported by `gpt-tr
-        #
-        # @param known_speaker_names [Array<String>] Optional list of speaker names that correspond to the audio samples provided in
-        #
-        # @param known_speaker_references [Array<String>] Optional list of audio samples (as [data URLs](https://developer.mozilla.org/en-
-        #
-        # @param language [String] The language of the input audio. Supplying the input language in [ISO-639-1](htt
-        #
-        # @param languages [Array<String>] Possible languages of the input audio, in [ISO-639-1](https://en.wikipedia.org/w
-        #
-        # @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 file [Pathname, StringIO, IO, String, OpenAI::FilePart]
+        #   The audio file object (not file name) to transcribe, 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 [String, Symbol, OpenAI::Models::AudioModel]
+        #   ID of the model to use. The options are `gpt-transcribe`, `gpt-4o-transcribe`,
+        #   `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `whisper-1`
+        #   (which is powered by our open source Whisper V2 model), and
+        #   `gpt-4o-transcribe-diarize`.
+        #
+        # @param chunking_strategy [Symbol, :auto, OpenAI::Models::Audio::TranscriptionCreateParams::ChunkingStrategy::VadConfig, nil]
+        #   Controls how the audio is cut into chunks. When set to `"auto"`, the server
+        #   first normalizes loudness and then uses voice activity detection (VAD) to choose
+        #   boundaries. `server_vad` object can be provided to tweak VAD detection
+        #   parameters manually. If unset, the audio is transcribed as a single block.
+        #   Required when using `gpt-4o-transcribe-diarize` for inputs longer than 30
+        #   seconds.
+        #
+        # @param include [Array<Symbol, OpenAI::Models::Audio::TranscriptionInclude>]
+        #   Additional information to include in the transcription response. `logprobs` will
+        #   return the log probabilities of the tokens in the response to understand the
+        #   model's confidence in the transcription. `logprobs` only works with
+        #   response_format set to `json` and only with the models `gpt-4o-transcribe`,
+        #   `gpt-4o-mini-transcribe`, and `gpt-4o-mini-transcribe-2025-12-15`. This field is
+        #   not supported when using `gpt-4o-transcribe-diarize`.
+        #
+        # @param keywords [Array<String>]
+        #   Words or phrases to guide transcription of the input audio. Supported by
+        #   `gpt-transcribe`.
+        #
+        # @param known_speaker_names [Array<String>]
+        #   Optional list of speaker names that correspond to the audio samples provided in
+        #   `known_speaker_references[]`. Each entry should be a short identifier (for
+        #   example `customer` or `agent`). Up to 4 speakers are supported.
+        #
+        # @param known_speaker_references [Array<String>]
+        #   Optional list of audio samples (as
+        #   [data URLs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs))
+        #   that contain known speaker references matching `known_speaker_names[]`. Each
+        #   sample must be between 2 and 10 seconds, and can use any of the same input audio
+        #   formats supported by `file`.
+        #
+        # @param language [String]
+        #   The language of the input audio. Supplying the input language in
+        #   [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`)
+        #   format will improve accuracy and latency.
+        #
+        # @param languages [Array<String>]
+        #   Possible languages of the input audio, in
+        #   [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+        #   Supported by `gpt-transcribe`.
+        #
+        # @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 match the audio language. This field is not supported when using
+        #   `gpt-4o-transcribe-diarize`.
+        #
+        # @param response_format [Symbol, OpenAI::Models::AudioResponseFormat]
+        #   The format of the output, in one of these options: `json`, `text`, `srt`,
+        #   `verbose_json`, `vtt`, or `diarized_json`. For `gpt-4o-transcribe` and
+        #   `gpt-4o-mini-transcribe`, the only supported format is `json`. For
+        #   `gpt-4o-transcribe-diarize`, the supported formats are `json`, `text`, and
+        #   `diarized_json`, with `diarized_json` required to receive speaker annotations.
+        #
+        # @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 timestamp_granularities [Array<Symbol, OpenAI::Models::Audio::TranscriptionCreateParams::TimestampGranularity>]
+        #   The timestamp granularities to populate for this transcription.
+        #   `response_format` must be set `verbose_json` to use timestamp granularities.
+        #   Either or both of these options are supported: `word`, or `segment`. Note: There
+        #   is no additional latency for segment timestamps, but generating word timestamps
+        #   incurs additional latency. This option is not available for
+        #   `gpt-4o-transcribe-diarize`.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -74,9 +132,6 @@ module OpenAI
         # See {OpenAI::Resources::Audio::Transcriptions#create} for non-streaming
         # counterpart.
         #
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Audio::TranscriptionCreateParams} for more details.
-        #
         # Transcribes audio into the input language.
         #
         # Returns a transcription object in `json`, `diarized_json`, or `verbose_json`
@@ -88,31 +143,92 @@ module OpenAI
         #
         # @overload create_streaming(file:, model:, chunking_strategy: nil, include: nil, keywords: nil, known_speaker_names: nil, known_speaker_references: nil, language: nil, languages: nil, prompt: nil, response_format: nil, temperature: nil, timestamp_granularities: nil, request_options: {})
         #
-        # @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::Models::AudioModel] ID of the model to use. The options are `gpt-transcribe`, `gpt-4o-transcribe`, `
-        #
-        # @param chunking_strategy [Symbol, :auto, OpenAI::Models::Audio::TranscriptionCreateParams::ChunkingStrategy::VadConfig, nil] Controls how the audio is cut into chunks. When set to `"auto"`, the server firs
-        #
-        # @param include [Array<Symbol, OpenAI::Models::Audio::TranscriptionInclude>] Additional information to include in the transcription response.
-        #
-        # @param keywords [Array<String>] Words or phrases to guide transcription of the input audio. Supported by `gpt-tr
-        #
-        # @param known_speaker_names [Array<String>] Optional list of speaker names that correspond to the audio samples provided in
-        #
-        # @param known_speaker_references [Array<String>] Optional list of audio samples (as [data URLs](https://developer.mozilla.org/en-
-        #
-        # @param language [String] The language of the input audio. Supplying the input language in [ISO-639-1](htt
-        #
-        # @param languages [Array<String>] Possible languages of the input audio, in [ISO-639-1](https://en.wikipedia.org/w
-        #
-        # @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 file [Pathname, StringIO, IO, String, OpenAI::FilePart]
+        #   The audio file object (not file name) to transcribe, 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 [String, Symbol, OpenAI::Models::AudioModel]
+        #   ID of the model to use. The options are `gpt-transcribe`, `gpt-4o-transcribe`,
+        #   `gpt-4o-mini-transcribe`, `gpt-4o-mini-transcribe-2025-12-15`, `whisper-1`
+        #   (which is powered by our open source Whisper V2 model), and
+        #   `gpt-4o-transcribe-diarize`.
+        #
+        # @param chunking_strategy [Symbol, :auto, OpenAI::Models::Audio::TranscriptionCreateParams::ChunkingStrategy::VadConfig, nil]
+        #   Controls how the audio is cut into chunks. When set to `"auto"`, the server
+        #   first normalizes loudness and then uses voice activity detection (VAD) to choose
+        #   boundaries. `server_vad` object can be provided to tweak VAD detection
+        #   parameters manually. If unset, the audio is transcribed as a single block.
+        #   Required when using `gpt-4o-transcribe-diarize` for inputs longer than 30
+        #   seconds.
+        #
+        # @param include [Array<Symbol, OpenAI::Models::Audio::TranscriptionInclude>]
+        #   Additional information to include in the transcription response. `logprobs` will
+        #   return the log probabilities of the tokens in the response to understand the
+        #   model's confidence in the transcription. `logprobs` only works with
+        #   response_format set to `json` and only with the models `gpt-4o-transcribe`,
+        #   `gpt-4o-mini-transcribe`, and `gpt-4o-mini-transcribe-2025-12-15`. This field is
+        #   not supported when using `gpt-4o-transcribe-diarize`.
+        #
+        # @param keywords [Array<String>]
+        #   Words or phrases to guide transcription of the input audio. Supported by
+        #   `gpt-transcribe`.
+        #
+        # @param known_speaker_names [Array<String>]
+        #   Optional list of speaker names that correspond to the audio samples provided in
+        #   `known_speaker_references[]`. Each entry should be a short identifier (for
+        #   example `customer` or `agent`). Up to 4 speakers are supported.
+        #
+        # @param known_speaker_references [Array<String>]
+        #   Optional list of audio samples (as
+        #   [data URLs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URLs))
+        #   that contain known speaker references matching `known_speaker_names[]`. Each
+        #   sample must be between 2 and 10 seconds, and can use any of the same input audio
+        #   formats supported by `file`.
+        #
+        # @param language [String]
+        #   The language of the input audio. Supplying the input language in
+        #   [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) (e.g. `en`)
+        #   format will improve accuracy and latency.
+        #
+        # @param languages [Array<String>]
+        #   Possible languages of the input audio, in
+        #   [ISO-639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
+        #   Supported by `gpt-transcribe`.
+        #
+        # @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 match the audio language. This field is not supported when using
+        #   `gpt-4o-transcribe-diarize`.
+        #
+        # @param response_format [Symbol, OpenAI::Models::AudioResponseFormat]
+        #   The format of the output, in one of these options: `json`, `text`, `srt`,
+        #   `verbose_json`, `vtt`, or `diarized_json`. For `gpt-4o-transcribe` and
+        #   `gpt-4o-mini-transcribe`, the only supported format is `json`. For
+        #   `gpt-4o-transcribe-diarize`, the supported formats are `json`, `text`, and
+        #   `diarized_json`, with `diarized_json` required to receive speaker annotations.
+        #
+        # @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 timestamp_granularities [Array<Symbol, OpenAI::Models::Audio::TranscriptionCreateParams::TimestampGranularity>]
+        #   The timestamp granularities to populate for this transcription.
+        #   `response_format` must be set `verbose_json` to use timestamp granularities.
+        #   Either or both of these options are supported: `word`, or `segment`. Note: There
+        #   is no additional latency for segment timestamps, but generating word timestamps
+        #   incurs additional latency. This option is not available for
+        #   `gpt-4o-transcribe-diarize`.
         #
         # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/openai/resources/audio/translations.rb

@@ -5,9 +5,6 @@ module OpenAI
     class Audio
       # Turn audio into text or text into audio.
       class Translations
-        # Some parameter documentations has been truncated, see
-        # {OpenAI::Models::Audio::TranslationCreateParams} for more details.
-        #
         # Translates audio into English.
         #
         # `String`, `StringIO`, and pathless `IO` inputs are sent with generic upload
@@ -16,15 +13,36 @@ module OpenAI
         #
         # @overload create(file:, model:, prompt: nil, response_format: nil, temperature: nil, request_options: {})
         #
-        # @param file [Pathname, StringIO, IO, String, 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,
+        #   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 [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}, nil]
         #

data/lib/openai/resources/batches.rb

@@ -4,22 +4,45 @@ module OpenAI
   module Resources
     # Create large batches of API requests to run asynchronously.
     class Batches
-      # Some parameter documentations has been truncated, see
-      # {OpenAI::Models::BatchCreateParams} for more details.
-      #
       # Creates and executes a batch from an uploaded file of requests
       #
       # @overload create(completion_window:, endpoint:, input_file_id:, metadata: nil, output_expires_after: nil, request_options: {})
       #
-      # @param completion_window [Symbol, OpenAI::Models::BatchCreateParams::CompletionWindow] The time frame within which the batch should be processed. Currently only `24h`
+      # @param completion_window [Symbol, OpenAI::Models::BatchCreateParams::CompletionWindow]
+      #   The time frame within which the batch should be processed. Currently only `24h`
+      #   is supported.
+      #
+      # @param endpoint [Symbol, OpenAI::Models::BatchCreateParams::Endpoint]
+      #   The endpoint to be used for all requests in the batch. Currently
+      #   `/v1/responses`, `/v1/chat/completions`, `/v1/embeddings`, `/v1/completions`,
+      #   `/v1/moderations`, `/v1/images/generations`, `/v1/images/edits`, and
+      #   `/v1/videos` are supported. Note that `/v1/embeddings` batches are also
+      #   restricted to a maximum of 50,000 embedding inputs across all requests in the
+      #   batch.
+      #
+      # @param input_file_id [String]
+      #   The ID of an uploaded file that contains requests for the new batch.
       #
-      # @param endpoint [Symbol, OpenAI::Models::BatchCreateParams::Endpoint] The endpoint to be used for all requests in the batch. Currently `/v1/responses`
+      #   See
+      #   [upload file](https://developers.openai.com/api/reference/resources/files/methods/create)
+      #   for how to upload a file.
       #
-      # @param input_file_id [String] The ID of an uploaded file that contains requests for the new batch.
+      #   Your input file must be formatted as a
+      #   [JSONL file](https://developers.openai.com/api/docs/guides/batch#1-prepare-your-batch-file),
+      #   and must be uploaded with the purpose `batch`. The file can contain up to 50,000
+      #   requests, and can be up to 200 MB in size.
       #
-      # @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
+      # @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 output_expires_after [OpenAI::Models::BatchCreateParams::OutputExpiresAfter] The expiration policy for the output and/or error file that are generated for a
+      #   Keys are strings with a maximum length of 64 characters. Values are strings with
+      #   a maximum length of 512 characters.
+      #
+      # @param output_expires_after [OpenAI::Models::BatchCreateParams::OutputExpiresAfter]
+      #   The expiration policy for the output and/or error file that are generated for a
+      #   batch.
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -42,7 +65,8 @@ module OpenAI
       #
       # @overload retrieve(batch_id, request_options: {})
       #
-      # @param batch_id [String] The ID of the batch to retrieve.
+      # @param batch_id [String]
+      #   The ID of the batch to retrieve.
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -59,16 +83,19 @@ module OpenAI
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {OpenAI::Models::BatchListParams} for more details.
-      #
       # List your organization's batches.
       #
       # @overload list(after: nil, limit: nil, request_options: {})
       #
-      # @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
+      # @param after [String]
+      #   A cursor for use in pagination. `after` is an object ID that defines your place
+      #   in the list. For instance, if you make a list request and receive 100 objects,
+      #   ending with obj_foo, your subsequent call can include after=obj_foo in order to
+      #   fetch the next page of the list.
       #
-      # @param limit [Integer] A limit on the number of objects to be returned. Limit can range between 1 and 1
+      # @param limit [Integer]
+      #   A limit on the number of objects to be returned. Limit can range between 1 and
+      #   100, and the default is 20.
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -95,7 +122,8 @@ module OpenAI
       #
       # @overload cancel(batch_id, request_options: {})
       #
-      # @param batch_id [String] The ID of the batch to cancel.
+      # @param batch_id [String]
+      #   The ID of the batch to cancel.
       #
       # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
       #