openai 0.98.0 → 0.100.0

data/lib/openai/models/chat/chat_completion_audio_param.rb

@@ -15,7 +15,8 @@ module OpenAI
         #   The voice the model uses to respond. Supported built-in voices are `alloy`,
         #   `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`,
         #   `marin`, and `cedar`. You may also provide a custom voice object with an `id`,
-        #   for example `{ "id": "voice_1234" }`.
+        #   for example `{ "id": "voice_1234" }`. Custom voices must be created from audio
+        #   samples. Voices created from text prompts are supported only in Live.
         #
         #   @return [String, Symbol, OpenAI::Models::Chat::ChatCompletionAudioParam::Voice::ID, OpenAI::Models::Chat::ChatCompletionAudioParam::Voice]
         required :voice, union: -> { OpenAI::Chat::ChatCompletionAudioParam::Voice }
@@ -33,7 +34,8 @@ module OpenAI
         #     The voice the model uses to respond. Supported built-in voices are `alloy`,
         #     `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`,
         #     `marin`, and `cedar`. You may also provide a custom voice object with an `id`,
-        #     for example `{ "id": "voice_1234" }`.
+        #     for example `{ "id": "voice_1234" }`. Custom voices must be created from audio
+        #     samples. Voices created from text prompts are supported only in Live.
 
         # Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`, `opus`,
         # or `pcm16`.
@@ -56,7 +58,8 @@ module OpenAI
         # The voice the model uses to respond. Supported built-in voices are `alloy`,
         # `ash`, `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, `shimmer`,
         # `marin`, and `cedar`. You may also provide a custom voice object with an `id`,
-        # for example `{ "id": "voice_1234" }`.
+        # for example `{ "id": "voice_1234" }`. Custom voices must be created from audio
+        # samples. Voices created from text prompts are supported only in Live.
         #
         # @see OpenAI::Models::Chat::ChatCompletionAudioParam#voice
         module Voice

data/lib/openai/models/chat/chat_completion_chunk.rb

@@ -172,21 +172,30 @@ module OpenAI
         #     The object type, which is always `chat.completion.chunk`.
         class Choice < OpenAI::Internal::Type::BaseModel
           # @!attribute delta
-          #   A chat completion delta generated by streamed model responses.
+          #   A chat completion delta generated by streamed model responses. Streamed audio
+          #   can arrive in partial updates with an ID, base64 data, or transcript text. The
+          #   final audio update contains only its expiry timestamp.
           #
           #   @return [OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta]
           required :delta, -> { OpenAI::Chat::ChatCompletionChunk::Choice::Delta }
 
+          # @!attribute index
+          #   The index of the choice in the list of choices.
+          #
+          #   @return [Integer]
+          required :index, Integer
+
           # @!attribute finish_reason
           #   The reason the model stopped generating tokens. This will be `stop` if the model
           #   hit a natural stop point or a provided stop sequence, `length` if the maximum
           #   number of tokens specified in the request was reached, `content_filter` if
           #   content was omitted due to a flag from our content filters, `tool_calls` if the
           #   model called a tool, or `function_call` (deprecated) if the model called a
-          #   function.
+          #   function. Omitted from the final audio update containing only
+          #   `delta.audio.expires_at`.
           #
           #   @return [Symbol, OpenAI::Models::Chat::ChatCompletionChunk::Choice::FinishReason, nil]
-          required(
+          optional(
             :finish_reason,
             enum: -> {
               OpenAI::Chat::ChatCompletionChunk::Choice::FinishReason
@@ -194,21 +203,20 @@ module OpenAI
             nil?: true
           )
 
-          # @!attribute index
-          #   The index of the choice in the list of choices.
-          #
-          #   @return [Integer]
-          required :index, Integer
-
           # @!attribute logprobs
           #   Log probability information for the choice.
           #
           #   @return [OpenAI::Models::Chat::ChatCompletionChunk::Choice::Logprobs, nil]
           optional :logprobs, -> { OpenAI::Chat::ChatCompletionChunk::Choice::Logprobs }, nil?: true
 
-          # @!method initialize(delta:, finish_reason:, index:, logprobs: nil)
+          # @!method initialize(delta:, index:, finish_reason: nil, logprobs: nil)
           #   @param delta [OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta]
-          #     A chat completion delta generated by streamed model responses.
+          #     A chat completion delta generated by streamed model responses. Streamed audio
+          #     can arrive in partial updates with an ID, base64 data, or transcript text. The
+          #     final audio update contains only its expiry timestamp.
+          #
+          #   @param index [Integer]
+          #     The index of the choice in the list of choices.
           #
           #   @param finish_reason [Symbol, OpenAI::Models::Chat::ChatCompletionChunk::Choice::FinishReason, nil]
           #     The reason the model stopped generating tokens. This will be `stop` if the model
@@ -216,16 +224,21 @@ module OpenAI
           #     number of tokens specified in the request was reached, `content_filter` if
           #     content was omitted due to a flag from our content filters, `tool_calls` if the
           #     model called a tool, or `function_call` (deprecated) if the model called a
-          #     function.
-          #
-          #   @param index [Integer]
-          #     The index of the choice in the list of choices.
+          #     function. Omitted from the final audio update containing only
+          #     `delta.audio.expires_at`.
           #
           #   @param logprobs [OpenAI::Models::Chat::ChatCompletionChunk::Choice::Logprobs, nil]
           #     Log probability information for the choice.
 
           # @see OpenAI::Models::Chat::ChatCompletionChunk::Choice#delta
           class Delta < OpenAI::Internal::Type::BaseModel
+            # @!attribute audio
+            #   A partial audio response. Audio chunks may carry an ID, base64 data, or
+            #   transcript text; the final audio update contains only its expiry timestamp.
+            #
+            #   @return [OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta::Audio, nil]
+            optional :audio, -> { OpenAI::Chat::ChatCompletionChunk::Choice::Delta::Audio }
+
             # @!attribute content
             #   The contents of the chunk message.
             #
@@ -261,8 +274,14 @@ module OpenAI
               -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Chat::ChatCompletionChunk::Choice::Delta::ToolCall] }
             )
 
-            # @!method initialize(content: nil, function_call: nil, refusal: nil, role: nil, tool_calls: nil)
-            #   A chat completion delta generated by streamed model responses.
+            # @!method initialize(audio: nil, content: nil, function_call: nil, refusal: nil, role: nil, tool_calls: nil)
+            #   A chat completion delta generated by streamed model responses. Streamed audio
+            #   can arrive in partial updates with an ID, base64 data, or transcript text. The
+            #   final audio update contains only its expiry timestamp.
+            #
+            #   @param audio [OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta::Audio]
+            #     A partial audio response. Audio chunks may carry an ID, base64 data, or
+            #     transcript text; the final audio update contains only its expiry timestamp.
             #
             #   @param content [String, nil]
             #     The contents of the chunk message.
@@ -279,6 +298,53 @@ module OpenAI
             #
             #   @param tool_calls [Array<OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta::ToolCall>]
 
+            # @see OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta#audio
+            class Audio < OpenAI::Internal::Type::BaseModel
+              # @!attribute id
+              #   Unique identifier for this audio response.
+              #
+              #   @return [String, nil]
+              optional :id, String
+
+              # @!attribute data
+              #   Base64 encoded audio bytes generated by the model, in the format specified in
+              #   the request.
+              #
+              #   @return [String, nil]
+              optional :data, String
+
+              # @!attribute expires_at
+              #   The Unix timestamp (in seconds) for when this audio response will no longer be
+              #   accessible on the server for use in multi-turn conversations.
+              #
+              #   @return [Integer, nil]
+              optional :expires_at, Integer
+
+              # @!attribute transcript
+              #   Transcript text from this audio chunk.
+              #
+              #   @return [String, nil]
+              optional :transcript, String
+
+              # @!method initialize(id: nil, data: nil, expires_at: nil, transcript: nil)
+              #   A partial audio response. Audio chunks may carry an ID, base64 data, or
+              #   transcript text; the final audio update contains only its expiry timestamp.
+              #
+              #   @param id [String]
+              #     Unique identifier for this audio response.
+              #
+              #   @param data [String]
+              #     Base64 encoded audio bytes generated by the model, in the format specified in
+              #     the request.
+              #
+              #   @param expires_at [Integer]
+              #     The Unix timestamp (in seconds) for when this audio response will no longer be
+              #     accessible on the server for use in multi-turn conversations.
+              #
+              #   @param transcript [String]
+              #     Transcript text from this audio chunk.
+            end
+
             # @deprecated
             #
             # @see OpenAI::Models::Chat::ChatCompletionChunk::Choice::Delta#function_call
@@ -409,7 +475,8 @@ module OpenAI
           # number of tokens specified in the request was reached, `content_filter` if
           # content was omitted due to a flag from our content filters, `tool_calls` if the
           # model called a tool, or `function_call` (deprecated) if the model called a
-          # function.
+          # function. Omitted from the final audio update containing only
+          # `delta.audio.expires_at`.
           #
           # @see OpenAI::Models::Chat::ChatCompletionChunk::Choice#finish_reason
           module FinishReason

data/lib/openai/models/chat_model.rb

@@ -19,80 +19,258 @@ module OpenAI
       GPT_5_4_NANO = :"gpt-5.4-nano"
       GPT_5_4_MINI_2026_03_17 = :"gpt-5.4-mini-2026-03-17"
       GPT_5_4_NANO_2026_03_17 = :"gpt-5.4-nano-2026-03-17"
+      # @deprecated Announced shutdown date: 2026-08-10. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_3_CHAT_LATEST = :"gpt-5.3-chat-latest"
       GPT_5_2 = :"gpt-5.2"
       GPT_5_2_2025_12_11 = :"gpt-5.2-2025-12-11"
+      # @deprecated Announced shutdown date: 2026-08-10. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_2_CHAT_LATEST = :"gpt-5.2-chat-latest"
       GPT_5_2_PRO = :"gpt-5.2-pro"
       GPT_5_2_PRO_2025_12_11 = :"gpt-5.2-pro-2025-12-11"
       GPT_5_1 = :"gpt-5.1"
       GPT_5_1_2025_11_13 = :"gpt-5.1-2025-11-13"
+      # @deprecated Announced shutdown date: 2026-07-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_1_CODEX = :"gpt-5.1-codex"
+      # @deprecated Not a supported model ID. Retained for SDK compatibility.
       GPT_5_1_MINI = :"gpt-5.1-mini"
+      # @deprecated Announced shutdown date: 2026-07-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_1_CHAT_LATEST = :"gpt-5.1-chat-latest"
+      # @deprecated Announced shutdown date: 2026-12-11. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5 = :"gpt-5"
+      # @deprecated Announced shutdown date: 2026-12-11. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_MINI = :"gpt-5-mini"
+      # @deprecated Announced shutdown date: 2026-12-11. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_NANO = :"gpt-5-nano"
+      # @deprecated Announced shutdown date: 2026-12-11. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_2025_08_07 = :"gpt-5-2025-08-07"
+      # @deprecated Announced shutdown date: 2026-12-11. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_MINI_2025_08_07 = :"gpt-5-mini-2025-08-07"
+      # @deprecated Announced shutdown date: 2026-12-11. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_NANO_2025_08_07 = :"gpt-5-nano-2025-08-07"
+      # @deprecated Announced shutdown date: 2026-07-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_5_CHAT_LATEST = :"gpt-5-chat-latest"
       GPT_4_1 = :"gpt-4.1"
       GPT_4_1_MINI = :"gpt-4.1-mini"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_1_NANO = :"gpt-4.1-nano"
       GPT_4_1_2025_04_14 = :"gpt-4.1-2025-04-14"
       GPT_4_1_MINI_2025_04_14 = :"gpt-4.1-mini-2025-04-14"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_1_NANO_2025_04_14 = :"gpt-4.1-nano-2025-04-14"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O4_MINI = :"o4-mini"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O4_MINI_2025_04_16 = :"o4-mini-2025-04-16"
+      # @deprecated Announced shutdown date: 2026-12-11. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O3 = :o3
+      # @deprecated Announced shutdown date: 2026-12-11. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O3_2025_04_16 = :"o3-2025-04-16"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O3_MINI = :"o3-mini"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O3_MINI_2025_01_31 = :"o3-mini-2025-01-31"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O1 = :o1
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O1_2024_12_17 = :"o1-2024-12-17"
+      # @deprecated Announced shutdown date: 2025-07-28. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O1_PREVIEW = :"o1-preview"
+      # @deprecated Announced shutdown date: 2025-07-28. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O1_PREVIEW_2024_09_12 = :"o1-preview-2024-09-12"
+      # @deprecated Announced shutdown date: 2025-10-27. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O1_MINI = :"o1-mini"
+      # @deprecated Announced shutdown date: 2025-10-27. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       O1_MINI_2024_09_12 = :"o1-mini-2024-09-12"
       GPT_4O = :"gpt-4o"
       GPT_4O_2024_11_20 = :"gpt-4o-2024-11-20"
       GPT_4O_2024_08_06 = :"gpt-4o-2024-08-06"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_2024_05_13 = :"gpt-4o-2024-05-13"
+      # @deprecated Announced shutdown date: 2027-01-20. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_AUDIO_MINI = :"gpt-audio-mini"
+      # @deprecated Announced shutdown date: 2027-01-20. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_AUDIO_MINI_2025_12_15 = :"gpt-audio-mini-2025-12-15"
+      # @deprecated Announced shutdown date: 2026-05-07. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_AUDIO_PREVIEW = :"gpt-4o-audio-preview"
+      # @deprecated Announced shutdown date: 2025-10-10. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_AUDIO_PREVIEW_2024_10_01 = :"gpt-4o-audio-preview-2024-10-01"
+      # @deprecated Announced shutdown date: 2026-05-07. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_AUDIO_PREVIEW_2024_12_17 = :"gpt-4o-audio-preview-2024-12-17"
+      # @deprecated Announced shutdown date: 2026-05-07. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_AUDIO_PREVIEW_2025_06_03 = :"gpt-4o-audio-preview-2025-06-03"
+      # @deprecated Announced shutdown date: 2026-05-07. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_MINI_AUDIO_PREVIEW = :"gpt-4o-mini-audio-preview"
+      # @deprecated Announced shutdown date: 2026-05-07. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_MINI_AUDIO_PREVIEW_2024_12_17 = :"gpt-4o-mini-audio-preview-2024-12-17"
+      # @deprecated Announced shutdown date: 2026-07-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_SEARCH_PREVIEW = :"gpt-4o-search-preview"
+      # @deprecated Announced shutdown date: 2026-07-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_MINI_SEARCH_PREVIEW = :"gpt-4o-mini-search-preview"
+      # @deprecated Announced shutdown date: 2026-07-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_SEARCH_PREVIEW_2025_03_11 = :"gpt-4o-search-preview-2025-03-11"
+      # @deprecated Announced shutdown date: 2026-07-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4O_MINI_SEARCH_PREVIEW_2025_03_11 = :"gpt-4o-mini-search-preview-2025-03-11"
+      # @deprecated Announced shutdown date: 2026-02-17. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       CHATGPT_4O_LATEST = :"chatgpt-4o-latest"
+      # @deprecated Announced shutdown date: 2026-02-12. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       CODEX_MINI_LATEST = :"codex-mini-latest"
       GPT_4O_MINI = :"gpt-4o-mini"
       GPT_4O_MINI_2024_07_18 = :"gpt-4o-mini-2024-07-18"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_TURBO = :"gpt-4-turbo"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_TURBO_2024_04_09 = :"gpt-4-turbo-2024-04-09"
+      # @deprecated Announced shutdown date: 2026-03-26. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_0125_PREVIEW = :"gpt-4-0125-preview"
+      # @deprecated Announced shutdown date: 2026-03-26. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_TURBO_PREVIEW = :"gpt-4-turbo-preview"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_1106_PREVIEW = :"gpt-4-1106-preview"
+      # @deprecated Announced shutdown date: 2024-12-06. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_VISION_PREVIEW = :"gpt-4-vision-preview"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4 = :"gpt-4"
+      # @deprecated Announced shutdown date: 2026-03-26. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_0314 = :"gpt-4-0314"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_0613 = :"gpt-4-0613"
+      # @deprecated Announced shutdown date: 2025-06-06. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_32K = :"gpt-4-32k"
+      # @deprecated Announced shutdown date: 2025-06-06. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_32K_0314 = :"gpt-4-32k-0314"
+      # @deprecated Announced shutdown date: 2025-06-06. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_4_32K_0613 = :"gpt-4-32k-0613"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_3_5_TURBO = :"gpt-3.5-turbo"
+      # @deprecated Announced shutdown date: 2024-09-13. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_3_5_TURBO_16K = :"gpt-3.5-turbo-16k"
+      # @deprecated Announced shutdown date: 2024-09-13. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_3_5_TURBO_0301 = :"gpt-3.5-turbo-0301"
+      # @deprecated Announced shutdown date: 2024-09-13. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_3_5_TURBO_0613 = :"gpt-3.5-turbo-0613"
+      # @deprecated Announced shutdown date: 2026-09-28. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_3_5_TURBO_1106 = :"gpt-3.5-turbo-1106"
+      # @deprecated Announced shutdown date: 2026-10-23. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_3_5_TURBO_0125 = :"gpt-3.5-turbo-0125"
+      # @deprecated Announced shutdown date: 2024-09-13. See
+      # https://developers.openai.com/api/docs/deprecations for details and recommended
+      # replacements.
       GPT_3_5_TURBO_16K_0613 = :"gpt-3.5-turbo-16k-0613"
 
       # @!method self.values

data/lib/openai/models/error_object.rb

@@ -49,19 +49,30 @@ module OpenAI
         #   @return [String, Symbol, OpenAI::Models::ErrorObject::Misalignment::ErrorType, nil]
         optional :error_type, union: -> { OpenAI::ErrorObject::Misalignment::ErrorType }
 
+        # @!attribute review_target
+        #   An opaque target for explicitly continuing this review, or null when
+        #   unavailable.
+        #
+        #   @return [String, nil]
+        optional :review_target, String, nil?: true
+
         # @!attribute steer
         #   An optional public continuation instruction.
         #
         #   @return [OpenAI::Models::ErrorObject::Misalignment::Steer, nil]
         optional :steer, -> { OpenAI::ErrorObject::Misalignment::Steer }
 
-        # @!method initialize(detailed_explanation: nil, error_type: nil, steer: nil)
+        # @!method initialize(detailed_explanation: nil, error_type: nil, review_target: nil, steer: nil)
         #   @param detailed_explanation [String]
         #     The public explanation for this block.
         #
         #   @param error_type [String, Symbol, OpenAI::Models::ErrorObject::Misalignment::ErrorType]
         #     An optional classification; clients must accept additional values.
         #
+        #   @param review_target [String, nil]
+        #     An opaque target for explicitly continuing this review, or null when
+        #     unavailable.
+        #
         #   @param steer [OpenAI::Models::ErrorObject::Misalignment::Steer]
         #     An optional public continuation instruction.
 

data/lib/openai/models/eval_create_params.rb

@@ -552,7 +552,7 @@ module OpenAI
           #     The name of the grader.
           #
           #   @param range [Array<Float>]
-          #     The range of the score. Defaults to `[0, 1]`.
+          #     The service requires two numbers for the score range. Defaults to `[0, 1]`.
           #
           #   @param sampling_params [OpenAI::Models::Graders::ScoreModelGrader::SamplingParams]
           #     The sampling parameters for the model.

data/lib/openai/models/eval_create_response.rb

@@ -261,7 +261,7 @@ module OpenAI
           #     The name of the grader.
           #
           #   @param range [Array<Float>]
-          #     The range of the score. Defaults to `[0, 1]`.
+          #     The service requires two numbers for the score range. Defaults to `[0, 1]`.
           #
           #   @param sampling_params [OpenAI::Models::Graders::ScoreModelGrader::SamplingParams]
           #     The sampling parameters for the model.

data/lib/openai/models/eval_list_response.rb

@@ -261,7 +261,7 @@ module OpenAI
           #     The name of the grader.
           #
           #   @param range [Array<Float>]
-          #     The range of the score. Defaults to `[0, 1]`.
+          #     The service requires two numbers for the score range. Defaults to `[0, 1]`.
           #
           #   @param sampling_params [OpenAI::Models::Graders::ScoreModelGrader::SamplingParams]
           #     The sampling parameters for the model.

data/lib/openai/models/eval_retrieve_response.rb

@@ -261,7 +261,7 @@ module OpenAI
           #     The name of the grader.
           #
           #   @param range [Array<Float>]
-          #     The range of the score. Defaults to `[0, 1]`.
+          #     The service requires two numbers for the score range. Defaults to `[0, 1]`.
           #
           #   @param sampling_params [OpenAI::Models::Graders::ScoreModelGrader::SamplingParams]
           #     The sampling parameters for the model.

data/lib/openai/models/eval_update_response.rb

@@ -261,7 +261,7 @@ module OpenAI
           #     The name of the grader.
           #
           #   @param range [Array<Float>]
-          #     The range of the score. Defaults to `[0, 1]`.
+          #     The service requires two numbers for the score range. Defaults to `[0, 1]`.
           #
           #   @param sampling_params [OpenAI::Models::Graders::ScoreModelGrader::SamplingParams]
           #     The sampling parameters for the model.

data/lib/openai/models/fine_tuning/job_list_params.rb

@@ -21,8 +21,13 @@ module OpenAI
         optional :limit, Integer
 
         # @!attribute metadata
-        #   Optional metadata filter. To filter, use the syntax `metadata[k]=v`.
-        #   Alternatively, set `metadata=null` to indicate no metadata.
+        #   Optional metadata filter. To filter, use the syntax `metadata[k]=v`. Omitting
+        #   the parameter or passing an empty object applies no metadata filter. An empty
+        #   value, such as `metadata[k]=`, filters for that key with an empty string value.
+        #   To select jobs with null metadata, send the literal query string
+        #   `metadata=null`. Nullable caller types do not specify how a client serializes
+        #   null for a deep-object parameter. Use a raw query parameter if the client omits
+        #   null. Do not combine the two query forms.
         #
         #   @return [Hash{Symbol=>String}, nil]
         optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
@@ -35,8 +40,13 @@ module OpenAI
         #     Number of fine-tuning jobs to retrieve.
         #
         #   @param metadata [Hash{Symbol=>String}, nil]
-        #     Optional metadata filter. To filter, use the syntax `metadata[k]=v`.
-        #     Alternatively, set `metadata=null` to indicate no metadata.
+        #     Optional metadata filter. To filter, use the syntax `metadata[k]=v`. Omitting
+        #     the parameter or passing an empty object applies no metadata filter. An empty
+        #     value, such as `metadata[k]=`, filters for that key with an empty string value.
+        #     To select jobs with null metadata, send the literal query string
+        #     `metadata=null`. Nullable caller types do not specify how a client serializes
+        #     null for a deep-object parameter. Use a raw query parameter if the client omits
+        #     null. Do not combine the two query forms.
         #
         #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/openai/models/graders/score_model_grader.rb

@@ -30,7 +30,7 @@ module OpenAI
         required :type, const: :score_model
 
         # @!attribute range
-        #   The range of the score. Defaults to `[0, 1]`.
+        #   The service requires two numbers for the score range. Defaults to `[0, 1]`.
         #
         #   @return [Array<Float>, nil]
         optional :range, OpenAI::Internal::Type::ArrayOf[Float]
@@ -55,7 +55,7 @@ module OpenAI
         #     The name of the grader.
         #
         #   @param range [Array<Float>]
-        #     The range of the score. Defaults to `[0, 1]`.
+        #     The service requires two numbers for the score range. Defaults to `[0, 1]`.
         #
         #   @param sampling_params [OpenAI::Models::Graders::ScoreModelGrader::SamplingParams]
         #     The sampling parameters for the model.

data/lib/openai/models/image.rb

@@ -4,23 +4,23 @@ module OpenAI
   module Models
     class Image < OpenAI::Internal::Type::BaseModel
       # @!attribute b64_json
-      #   The base64-encoded JSON of the generated image. Returned by default for the GPT
-      #   image models, and only present if `response_format` is set to `b64_json` for
-      #   `dall-e-2` and `dall-e-3`.
+      #   The base64-encoded JSON of the generated image. Returned by default for GPT
+      #   image models, or when `response_format` is set to `b64_json` for models that
+      #   support that parameter.
       #
       #   @return [String, nil]
       optional :b64_json, String
 
       # @!attribute revised_prompt
-      #   For `dall-e-3` only, the revised prompt that was used to generate the image.
+      #   The revised prompt used to generate the image, for models that support prompt
+      #   revision. Not returned by GPT image models.
       #
       #   @return [String, nil]
       optional :revised_prompt, String
 
       # @!attribute url
-      #   When using `dall-e-2` or `dall-e-3`, the URL of the generated image if
-      #   `response_format` is set to `url` (default value). Unsupported for the GPT image
-      #   models.
+      #   The URL of the generated image when `response_format` is set to `url` for models
+      #   that support that parameter. Unsupported for GPT image models.
       #
       #   @return [String, nil]
       optional :url, String
@@ -29,17 +29,17 @@ module OpenAI
       #   Represents the content or the URL of an image generated by the OpenAI API.
       #
       #   @param b64_json [String]
-      #     The base64-encoded JSON of the generated image. Returned by default for the GPT
-      #     image models, and only present if `response_format` is set to `b64_json` for
-      #     `dall-e-2` and `dall-e-3`.
+      #     The base64-encoded JSON of the generated image. Returned by default for GPT
+      #     image models, or when `response_format` is set to `b64_json` for models that
+      #     support that parameter.
       #
       #   @param revised_prompt [String]
-      #     For `dall-e-3` only, the revised prompt that was used to generate the image.
+      #     The revised prompt used to generate the image, for models that support prompt
+      #     revision. Not returned by GPT image models.
       #
       #   @param url [String]
-      #     When using `dall-e-2` or `dall-e-3`, the URL of the generated image if
-      #     `response_format` is set to `url` (default value). Unsupported for the GPT image
-      #     models.
+      #     The URL of the generated image when `response_format` is set to `url` for models
+      #     that support that parameter. Unsupported for GPT image models.
     end
   end
 end