openai 0.42.0 → 0.43.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 464227db3c30bad373f3cd4600bb7409c8ace214249c3257016363d533d848c8
-  data.tar.gz: a3828202f21732efa015e97198bf160fff5dca941a25cc1010f688a583ac8ccb
+  metadata.gz: d4083372aec70ae767e55529226345fd14c51b526994a100ac2985ab1990cd48
+  data.tar.gz: 79cc5f4c8ad7b26a1ec05490a80b55105393750839b2ecb3bf4da1a22385952d
 SHA512:
-  metadata.gz: c062d515f082c87524e10ccce322304923f4db54cd489218248f63e2d47e1f976db323f9e1cff5753f66a603112d8b56df3a9ed4f9a144d4e8867c6cdc075e52
-  data.tar.gz: 566f420ae6db1b332fe1dd253544271c470f9863d4278ebcf22a873ff2cc4102999d0ed741f68671011c5a761e39d988e3679e41e139f2a7d526334ba48cd452
+  metadata.gz: 95ff955307367382d388f0d575f733a7c384b513a72be89010dfe70aefa1868c39c36c9a49c7130ea124f793feed59543b7f837facbd738082cd1e0db1e2d658
+  data.tar.gz: 378b3dc58226b56d9a362578a879fc3f48acdcfecbea44507798bbfb53ed4fc8f96a5b2849004db91aeab9acadcde2829be897321e38bafa987e819e0ca1aa1a

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 0.43.0 (2026-01-09)
+
+Full Changelog: [v0.42.0...v0.43.0](https://github.com/openai/openai-ruby/compare/v0.42.0...v0.43.0)
+
+### Features
+
+* **api:** add new Response completed_at prop ([c32e1c2](https://github.com/openai/openai-ruby/commit/c32e1c2a0a0ae6a9b7724e1c6d251ba14e8499e1))
+
+
+### Chores
+
+* add ci tests for ruby 4 compatibility [#235](https://github.com/openai/openai-ruby/issues/235) ([#236](https://github.com/openai/openai-ruby/issues/236)) ([1aa0d7a](https://github.com/openai/openai-ruby/commit/1aa0d7abf5a4714fa28cfe7ee5aecefbe2c683d2))
+* **internal:** codegen related update ([ef23de3](https://github.com/openai/openai-ruby/commit/ef23de347b5f541853a32a288cd02a54938793cf))
+* **internal:** use different example values for some enums ([8b6c4ad](https://github.com/openai/openai-ruby/commit/8b6c4ade813244e8c65690c66fe09f2566dd3ff0))
+* move `cgi` into dependencies for ruby 4 ([bd9c798](https://github.com/openai/openai-ruby/commit/bd9c798552a3d378ec943c7e07d6cf1334f72b1d))
+
 ## 0.42.0 (2025-12-19)
 
 Full Changelog: [v0.41.0...v0.42.0](https://github.com/openai/openai-ruby/compare/v0.41.0...v0.42.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "openai", "~> 0.42.0"
+gem "openai", "~> 0.43.0"
 ```
 
 <!-- x-release-please-end -->
@@ -30,10 +30,7 @@ openai = OpenAI::Client.new(
   api_key: ENV["OPENAI_API_KEY"] # This is the default and can be omitted
 )
 
-chat_completion = openai.chat.completions.create(
-  messages: [{role: "user", content: "Say this is a test"}],
-  model: :"gpt-5.2"
-)
+chat_completion = openai.chat.completions.create(messages: [{role: "user", content: "Say this is a test"}], model: "gpt-4o")
 
 puts(chat_completion)
 ```
@@ -45,7 +42,7 @@ We provide support for streaming responses using Server-Sent Events (SSE).
 ```ruby
 stream = openai.responses.stream(
   input: "Write a haiku about OpenAI.",
-  model: :"gpt-5.2"
+  model: "gpt-4o"
 )
 
 stream.each do |event|
@@ -298,7 +295,7 @@ When the library is unable to connect to the API, or if the API returns a non-su
 
 ```ruby
 begin
-  job = openai.fine_tuning.jobs.create(model: :"babbage-002", training_file: "file-abc123")
+  job = openai.fine_tuning.jobs.create(model: "gpt-4o", training_file: "file-abc123")
 rescue OpenAI::Errors::APIConnectionError => e
   puts("The server could not be reached")
   puts(e.cause)  # an underlying Exception, likely raised within `net/http`
@@ -343,7 +340,7 @@ openai = OpenAI::Client.new(
 # Or, configure per-request:
 openai.chat.completions.create(
   messages: [{role: "user", content: "How can I get the name of the current day in JavaScript?"}],
-  model: :"gpt-5.2",
+  model: "gpt-4o",
   request_options: {max_retries: 5}
 )
 ```
@@ -361,7 +358,7 @@ openai = OpenAI::Client.new(
 # Or, configure per-request:
 openai.chat.completions.create(
   messages: [{role: "user", content: "How can I list all files in a directory using Python?"}],
-  model: :"gpt-5.2",
+  model: "gpt-4o",
   request_options: {timeout: 5}
 )
 ```
@@ -396,7 +393,7 @@ Note: the `extra_` parameters of the same name overrides the documented paramete
 chat_completion =
   openai.chat.completions.create(
     messages: [{role: "user", content: "How can I get the name of the current day in JavaScript?"}],
-    model: :"gpt-5.2",
+    model: "gpt-4o",
     request_options: {
       extra_query: {my_query_parameter: value},
       extra_body: {my_body_parameter: value},
@@ -444,7 +441,7 @@ You can provide typesafe request parameters like so:
 ```ruby
 openai.chat.completions.create(
   messages: [OpenAI::Chat::ChatCompletionUserMessageParam.new(content: "Say this is a test")],
-  model: :"gpt-5.2"
+  model: "gpt-4o"
 )
 ```
 
@@ -452,15 +449,12 @@ Or, equivalently:
 
 ```ruby
 # Hashes work, but are not typesafe:
-openai.chat.completions.create(
-  messages: [{role: "user", content: "Say this is a test"}],
-  model: :"gpt-5.2"
-)
+openai.chat.completions.create(messages: [{role: "user", content: "Say this is a test"}], model: "gpt-4o")
 
 # You can also splat a full Params class:
 params = OpenAI::Chat::CompletionCreateParams.new(
   messages: [OpenAI::Chat::ChatCompletionUserMessageParam.new(content: "Say this is a test")],
-  model: :"gpt-5.2"
+  model: "gpt-4o"
 )
 openai.chat.completions.create(**params)
 ```

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

@@ -22,9 +22,10 @@ module OpenAI
         required :model, union: -> { OpenAI::Audio::SpeechCreateParams::Model }
 
         # @!attribute voice
-        #   The voice to use when generating the audio. Supported voices are `alloy`, `ash`,
-        #   `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`, `shimmer`, and
-        #   `verse`. Previews of the voices are available in the
+        #   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`. Previews of the voices are available
+        #   in the
         #   [Text to speech guide](https://platform.openai.com/docs/guides/text-to-speech#voice-options).
         #
         #   @return [String, Symbol, OpenAI::Models::Audio::SpeechCreateParams::Voice]
@@ -66,7 +67,7 @@ module OpenAI
         #
         #   @param model [String, Symbol, OpenAI::Models::Audio::SpeechModel] One of the available [TTS models](https://platform.openai.com/docs/models#tts):
         #
-        #   @param voice [String, Symbol, OpenAI::Models::Audio::SpeechCreateParams::Voice] The voice to use when generating the audio. Supported voices are `alloy`, `ash`,
+        #   @param voice [String, Symbol, OpenAI::Models::Audio::SpeechCreateParams::Voice] The voice to use when generating the audio. Supported built-in voices are `alloy
         #
         #   @param instructions [String] Control the voice of your generated audio with additional instructions. Does not
         #
@@ -92,9 +93,10 @@ module OpenAI
           #   @return [Array(String, Symbol, OpenAI::Models::Audio::SpeechModel)]
         end
 
-        # The voice to use when generating the audio. Supported voices are `alloy`, `ash`,
-        # `ballad`, `coral`, `echo`, `fable`, `onyx`, `nova`, `sage`, `shimmer`, and
-        # `verse`. Previews of the voices are available in the
+        # 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`. Previews of the voices are available
+        # in the
         # [Text to speech guide](https://platform.openai.com/docs/guides/text-to-speech#voice-options).
         module Voice
           extend OpenAI::Internal::Type::Union

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

@@ -12,8 +12,9 @@ module OpenAI
         required :format_, enum: -> { OpenAI::Chat::ChatCompletionAudioParam::Format }, api_name: :format
 
         # @!attribute voice
-        #   The voice the model uses to respond. Supported voices are `alloy`, `ash`,
-        #   `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, and `shimmer`.
+        #   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`.
         #
         #   @return [String, Symbol, OpenAI::Models::Chat::ChatCompletionAudioParam::Voice]
         required :voice, union: -> { OpenAI::Chat::ChatCompletionAudioParam::Voice }
@@ -28,7 +29,7 @@ module OpenAI
         #
         #   @param format_ [Symbol, OpenAI::Models::Chat::ChatCompletionAudioParam::Format] Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`,
         #
-        #   @param voice [String, Symbol, OpenAI::Models::Chat::ChatCompletionAudioParam::Voice] The voice the model uses to respond. Supported voices are
+        #   @param voice [String, Symbol, OpenAI::Models::Chat::ChatCompletionAudioParam::Voice] The voice the model uses to respond. Supported built-in voices are `alloy`, `ash
 
         # Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`, `opus`,
         # or `pcm16`.
@@ -48,8 +49,9 @@ module OpenAI
           #   @return [Array<Symbol>]
         end
 
-        # The voice the model uses to respond. Supported voices are `alloy`, `ash`,
-        # `ballad`, `coral`, `echo`, `fable`, `nova`, `onyx`, `sage`, and `shimmer`.
+        # 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`.
         #
         # @see OpenAI::Models::Chat::ChatCompletionAudioParam#voice
         module Voice

data/lib/openai/models/conversations/conversation_item.rb

@@ -57,7 +57,7 @@ module OpenAI
         # A tool call that executes one or more shell commands in a managed environment.
         variant :shell_call, -> { OpenAI::Responses::ResponseFunctionShellToolCall }
 
-        # The output of a shell tool call.
+        # The output of a shell tool call that was emitted.
         variant :shell_call_output, -> { OpenAI::Responses::ResponseFunctionShellToolCallOutput }
 
         # A tool call that applies file diffs by creating, deleting, or updating files.

data/lib/openai/models/conversations/message.rb

@@ -52,7 +52,7 @@ module OpenAI
         #
         #   @param type [Symbol, :message] The type of the message. Always set to `message`.
 
-        # A text input to the model.
+        # A content part that makes up an input or output item.
         module Content
           extend OpenAI::Internal::Type::Union
 

data/lib/openai/models/realtime/realtime_audio_config_output.rb

@@ -23,10 +23,10 @@ module OpenAI
         optional :speed, Float
 
         # @!attribute voice
-        #   The voice the model uses to respond. Voice cannot be changed during the session
-        #   once the model has responded with audio at least once. Current voice options are
-        #   `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`,
-        #   and `cedar`. We recommend `marin` and `cedar` for best quality.
+        #   The voice the model uses to respond. Supported built-in voices are `alloy`,
+        #   `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
+        #   `cedar`. Voice cannot be changed during the session once the model has responded
+        #   with audio at least once. We recommend `marin` and `cedar` for best quality.
         #
         #   @return [String, Symbol, OpenAI::Models::Realtime::RealtimeAudioConfigOutput::Voice, nil]
         optional :voice, union: -> { OpenAI::Realtime::RealtimeAudioConfigOutput::Voice }
@@ -39,12 +39,12 @@ module OpenAI
         #
         #   @param speed [Float] The speed of the model's spoken response as a multiple of the original speed.
         #
-        #   @param voice [String, Symbol, OpenAI::Models::Realtime::RealtimeAudioConfigOutput::Voice] The voice the model uses to respond. Voice cannot be changed during the
+        #   @param voice [String, Symbol, OpenAI::Models::Realtime::RealtimeAudioConfigOutput::Voice] The voice the model uses to respond. Supported built-in voices are `alloy`, `ash
 
-        # The voice the model uses to respond. Voice cannot be changed during the session
-        # once the model has responded with audio at least once. Current voice options are
-        # `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`,
-        # and `cedar`. We recommend `marin` and `cedar` for best quality.
+        # The voice the model uses to respond. Supported built-in voices are `alloy`,
+        # `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
+        # `cedar`. Voice cannot be changed during the session once the model has responded
+        # with audio at least once. We recommend `marin` and `cedar` for best quality.
         #
         # @see OpenAI::Models::Realtime::RealtimeAudioConfigOutput#voice
         module Voice

data/lib/openai/models/realtime/realtime_response_create_audio_output.rb

@@ -23,10 +23,10 @@ module OpenAI
           optional :format_, union: -> { OpenAI::Realtime::RealtimeAudioFormats }, api_name: :format
 
           # @!attribute voice
-          #   The voice the model uses to respond. Voice cannot be changed during the session
-          #   once the model has responded with audio at least once. Current voice options are
-          #   `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`,
-          #   and `cedar`. We recommend `marin` and `cedar` for best quality.
+          #   The voice the model uses to respond. Supported built-in voices are `alloy`,
+          #   `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
+          #   `cedar`. Voice cannot be changed during the session once the model has responded
+          #   with audio at least once.
           #
           #   @return [String, Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice, nil]
           optional :voice, union: -> { OpenAI::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice }
@@ -38,12 +38,12 @@ module OpenAI
           #
           #   @param format_ [OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCM, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMU, OpenAI::Models::Realtime::RealtimeAudioFormats::AudioPCMA] The format of the output audio.
           #
-          #   @param voice [String, Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice] The voice the model uses to respond. Voice cannot be changed during the
+          #   @param voice [String, Symbol, OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output::Voice] The voice the model uses to respond. Supported built-in voices are `alloy`, `ash
 
-          # The voice the model uses to respond. Voice cannot be changed during the session
-          # once the model has responded with audio at least once. Current voice options are
-          # `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`,
-          # and `cedar`. We recommend `marin` and `cedar` for best quality.
+          # The voice the model uses to respond. Supported built-in voices are `alloy`,
+          # `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and
+          # `cedar`. Voice cannot be changed during the session once the model has responded
+          # with audio at least once.
           #
           # @see OpenAI::Models::Realtime::RealtimeResponseCreateAudioOutput::Output#voice
           module Voice

data/lib/openai/models/responses/input_token_count_params.rb

@@ -79,9 +79,7 @@ module OpenAI
         optional :text, -> { OpenAI::Responses::InputTokenCountParams::Text }, nil?: true
 
         # @!attribute tool_choice
-        #   How the model should select which tool (or tools) to use when generating a
-        #   response. See the `tools` parameter to see how to specify which tools the model
-        #   can call.
+        #   Controls which tool the model should use, if any.
         #
         #   @return [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceAllowed, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp, OpenAI::Models::Responses::ToolChoiceCustom, OpenAI::Models::Responses::ToolChoiceApplyPatch, OpenAI::Models::Responses::ToolChoiceShell, nil]
         optional :tool_choice, union: -> { OpenAI::Responses::InputTokenCountParams::ToolChoice }, nil?: true
@@ -123,7 +121,7 @@ module OpenAI
         #
         #   @param text [OpenAI::Models::Responses::InputTokenCountParams::Text, nil] Configuration options for a text response from the model. Can be plain
         #
-        #   @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceAllowed, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp, OpenAI::Models::Responses::ToolChoiceCustom, OpenAI::Models::Responses::ToolChoiceApplyPatch, OpenAI::Models::Responses::ToolChoiceShell, nil] How the model should select which tool (or tools) to use when generating
+        #   @param tool_choice [Symbol, OpenAI::Models::Responses::ToolChoiceOptions, OpenAI::Models::Responses::ToolChoiceAllowed, OpenAI::Models::Responses::ToolChoiceTypes, OpenAI::Models::Responses::ToolChoiceFunction, OpenAI::Models::Responses::ToolChoiceMcp, OpenAI::Models::Responses::ToolChoiceCustom, OpenAI::Models::Responses::ToolChoiceApplyPatch, OpenAI::Models::Responses::ToolChoiceShell, nil] Controls which tool the model should use, if any.
         #
         #   @param tools [Array<OpenAI::Models::Responses::FunctionTool, OpenAI::Models::Responses::FileSearchTool, OpenAI::Models::Responses::ComputerTool, OpenAI::Models::Responses::Tool::Mcp, OpenAI::Models::Responses::Tool::CodeInterpreter, OpenAI::Models::Responses::Tool::ImageGeneration, OpenAI::Models::Responses::Tool::LocalShell, OpenAI::Models::Responses::FunctionShellTool, OpenAI::Models::Responses::CustomTool, OpenAI::Models::Responses::ApplyPatchTool, OpenAI::Models::Responses::WebSearchTool, OpenAI::Models::Responses::WebSearchPreviewTool>, nil] An array of tools the model may call while generating a response. You can specif
         #
@@ -155,6 +153,7 @@ module OpenAI
           # A text input to the model, equivalent to a text input with the `user` role.
           variant String
 
+          # A list of one or many input items to the model, containing different content types.
           variant -> { OpenAI::Models::Responses::InputTokenCountParams::Input::ResponseInputItemArray }
 
           # @!method self.variants
@@ -227,9 +226,7 @@ module OpenAI
           end
         end
 
-        # How the model should select which tool (or tools) to use when generating a
-        # response. See the `tools` parameter to see how to specify which tools the model
-        # can call.
+        # Controls which tool the model should use, if any.
         module ToolChoice
           extend OpenAI::Internal::Type::Union
 

data/lib/openai/models/responses/response.rb

@@ -144,9 +144,16 @@ module OpenAI
         #   @return [Boolean, nil]
         optional :background, OpenAI::Internal::Type::Boolean, nil?: true
 
+        # @!attribute completed_at
+        #   Unix timestamp (in seconds) of when this Response was completed. Only present
+        #   when the status is `completed`.
+        #
+        #   @return [Float, nil]
+        optional :completed_at, Float, nil?: true
+
         # @!attribute conversation
-        #   The conversation that this response belongs to. Input items and output items
-        #   from this response are automatically added to this conversation.
+        #   The conversation that this response belonged to. Input items and output items
+        #   from this response were automatically added to this conversation.
         #
         #   @return [OpenAI::Models::Responses::Response::Conversation, nil]
         optional :conversation, -> { OpenAI::Responses::Response::Conversation }, nil?: true
@@ -318,7 +325,7 @@ module OpenAI
           texts.join
         end
 
-        # @!method initialize(id:, created_at:, error:, incomplete_details:, instructions:, metadata:, model:, output:, parallel_tool_calls:, temperature:, tool_choice:, tools:, top_p:, background: nil, conversation: nil, max_output_tokens: nil, max_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, status: nil, text: nil, top_logprobs: nil, truncation: nil, usage: nil, user: nil, object: :response)
+        # @!method initialize(id:, created_at:, error:, incomplete_details:, instructions:, metadata:, model:, output:, parallel_tool_calls:, temperature:, tool_choice:, tools:, top_p:, background: nil, completed_at: nil, conversation: nil, max_output_tokens: nil, max_tool_calls: nil, previous_response_id: nil, prompt: nil, prompt_cache_key: nil, prompt_cache_retention: nil, reasoning: nil, safety_identifier: nil, service_tier: nil, status: nil, text: nil, top_logprobs: nil, truncation: nil, usage: nil, user: nil, object: :response)
         #   Some parameter documentations has been truncated, see
         #   {OpenAI::Models::Responses::Response} for more details.
         #
@@ -350,7 +357,9 @@ module OpenAI
         #
         #   @param background [Boolean, nil] Whether to run the model response in the background.
         #
-        #   @param conversation [OpenAI::Models::Responses::Response::Conversation, nil] The conversation that this response belongs to. Input items and output items fro
+        #   @param completed_at [Float, nil] Unix timestamp (in seconds) of when this Response was completed.
+        #
+        #   @param conversation [OpenAI::Models::Responses::Response::Conversation, nil] The conversation that this response belonged to. Input items and output items fr
         #
         #   @param max_output_tokens [Integer, nil] An upper bound for the number of tokens that can be generated for a response, in
         #
@@ -484,16 +493,16 @@ module OpenAI
         # @see OpenAI::Models::Responses::Response#conversation
         class Conversation < OpenAI::Internal::Type::BaseModel
           # @!attribute id
-          #   The unique ID of the conversation.
+          #   The unique ID of the conversation that this response was associated with.
           #
           #   @return [String]
           required :id, String
 
           # @!method initialize(id:)
-          #   The conversation that this response belongs to. Input items and output items
-          #   from this response are automatically added to this conversation.
+          #   The conversation that this response belonged to. Input items and output items
+          #   from this response were automatically added to this conversation.
           #
-          #   @param id [String] The unique ID of the conversation.
+          #   @param id [String] The unique ID of the conversation that this response was associated with.
         end
 
         # The retention policy for the prompt cache. Set to `24h` to enable extended

data/lib/openai/models/responses/response_compact_params.rb

@@ -344,6 +344,7 @@ module OpenAI
           # A text input to the model, equivalent to a text input with the `user` role.
           variant String
 
+          # A list of one or many input items to the model, containing different content types.
           variant -> { OpenAI::Models::Responses::ResponseCompactParams::Input::ResponseInputItemArray }
 
           # @!method self.variants

data/lib/openai/models/responses/response_compaction_item.rb

@@ -11,6 +11,7 @@ module OpenAI
         required :id, String
 
         # @!attribute encrypted_content
+        #   The encrypted content that was produced by compaction.
         #
         #   @return [String]
         required :encrypted_content, String
@@ -22,6 +23,7 @@ module OpenAI
         required :type, const: :compaction
 
         # @!attribute created_by
+        #   The identifier of the actor that created the item.
         #
         #   @return [String, nil]
         optional :created_by, String
@@ -32,9 +34,9 @@ module OpenAI
         #
         #   @param id [String] The unique ID of the compaction item.
         #
-        #   @param encrypted_content [String]
+        #   @param encrypted_content [String] The encrypted content that was produced by compaction.
         #
-        #   @param created_by [String]
+        #   @param created_by [String] The identifier of the actor that created the item.
         #
         #   @param type [Symbol, :compaction] The type of the item. Always `compaction`.
       end

data/lib/openai/models/responses/response_compaction_item_param.rb

@@ -5,6 +5,7 @@ module OpenAI
     module Responses
       class ResponseCompactionItemParam < OpenAI::Internal::Type::BaseModel
         # @!attribute encrypted_content
+        #   The encrypted content of the compaction summary.
         #
         #   @return [String]
         required :encrypted_content, String
@@ -25,7 +26,7 @@ module OpenAI
         #   A compaction item generated by the
         #   [`v1/responses/compact` API](https://platform.openai.com/docs/api-reference/responses/compact).
         #
-        #   @param encrypted_content [String]
+        #   @param encrypted_content [String] The encrypted content of the compaction summary.
         #
         #   @param id [String, nil] The ID of the compaction item.
         #

data/lib/openai/models/responses/response_function_call_output_item.rb

@@ -3,7 +3,7 @@
 module OpenAI
   module Models
     module Responses
-      # A text input to the model.
+      # A piece of message content, such as text, an image, or a file.
       module ResponseFunctionCallOutputItem
         extend OpenAI::Internal::Type::Union
 

data/lib/openai/models/responses/response_function_shell_tool_call_output.rb

@@ -38,6 +38,7 @@ module OpenAI
         required :type, const: :shell_call_output
 
         # @!attribute created_by
+        #   The identifier of the actor that created the item.
         #
         #   @return [String, nil]
         optional :created_by, String
@@ -47,7 +48,7 @@ module OpenAI
         #   {OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput} for more
         #   details.
         #
-        #   The output of a shell tool call.
+        #   The output of a shell tool call that was emitted.
         #
         #   @param id [String] The unique ID of the shell call output. Populated when this item is returned via
         #
@@ -57,7 +58,7 @@ module OpenAI
         #
         #   @param output [Array<OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput::Output>] An array of shell call output contents
         #
-        #   @param created_by [String]
+        #   @param created_by [String] The identifier of the actor that created the item.
         #
         #   @param type [Symbol, :shell_call_output] The type of the shell call output. Always `shell_call_output`.
 
@@ -70,16 +71,19 @@ module OpenAI
           required :outcome, union: -> { OpenAI::Responses::ResponseFunctionShellToolCallOutput::Output::Outcome }
 
           # @!attribute stderr
+          #   The standard error output that was captured.
           #
           #   @return [String]
           required :stderr, String
 
           # @!attribute stdout
+          #   The standard output that was captured.
           #
           #   @return [String]
           required :stdout, String
 
           # @!attribute created_by
+          #   The identifier of the actor that created the item.
           #
           #   @return [String, nil]
           optional :created_by, String
@@ -89,15 +93,15 @@ module OpenAI
           #   {OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput::Output} for
           #   more details.
           #
-          #   The content of a shell call output.
+          #   The content of a shell tool call output that was emitted.
           #
           #   @param outcome [OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput::Output::Outcome::Timeout, OpenAI::Models::Responses::ResponseFunctionShellToolCallOutput::Output::Outcome::Exit] Represents either an exit outcome (with an exit code) or a timeout outcome for a
           #
-          #   @param stderr [String]
+          #   @param stderr [String] The standard error output that was captured.
           #
-          #   @param stdout [String]
+          #   @param stdout [String] The standard output that was captured.
           #
-          #   @param created_by [String]
+          #   @param created_by [String] The identifier of the actor that created the item.
 
           # Represents either an exit outcome (with an exit code) or a timeout outcome for a
           # shell call output chunk.

data/lib/openai/models/responses/response_function_web_search.rb

@@ -65,7 +65,7 @@ module OpenAI
 
           class Search < OpenAI::Internal::Type::BaseModel
             # @!attribute query
-            #   The search query.
+            #   [DEPRECATED] The search query.
             #
             #   @return [String]
             required :query, String
@@ -76,6 +76,12 @@ module OpenAI
             #   @return [Symbol, :search]
             required :type, const: :search
 
+            # @!attribute queries
+            #   The search queries.
+            #
+            #   @return [Array<String>, nil]
+            optional :queries, OpenAI::Internal::Type::ArrayOf[String]
+
             # @!attribute sources
             #   The sources used in the search.
             #
@@ -83,14 +89,16 @@ module OpenAI
             optional :sources,
                      -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Responses::ResponseFunctionWebSearch::Action::Search::Source] }
 
-            # @!method initialize(query:, sources: nil, type: :search)
+            # @!method initialize(query:, queries: nil, sources: nil, type: :search)
             #   Some parameter documentations has been truncated, see
             #   {OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::Search} for more
             #   details.
             #
             #   Action type "search" - Performs a web search query.
             #
-            #   @param query [String] The search query.
+            #   @param query [String] [DEPRECATED] The search query.
+            #
+            #   @param queries [Array<String>] The search queries.
             #
             #   @param sources [Array<OpenAI::Models::Responses::ResponseFunctionWebSearch::Action::Search::Source>] The sources used in the search.
             #

data/lib/openai/models/responses/response_input_item.rb

@@ -359,6 +359,7 @@ module OpenAI
             # A JSON string of the output of the function tool call.
             variant String
 
+            # An array of content outputs (text, image, file) for the function tool call.
             variant -> { OpenAI::Responses::ResponseFunctionCallOutputItemList }
 
             # @!method self.variants

data/lib/openai/models/responses/response_item.rb

@@ -49,7 +49,7 @@ module OpenAI
         # A tool call that executes one or more shell commands in a managed environment.
         variant :shell_call, -> { OpenAI::Responses::ResponseFunctionShellToolCall }
 
-        # The output of a shell tool call.
+        # The output of a shell tool call that was emitted.
         variant :shell_call_output, -> { OpenAI::Responses::ResponseFunctionShellToolCallOutput }
 
         # A tool call that applies file diffs by creating, deleting, or updating files.

data/lib/openai/models/responses/response_output_item.rb

@@ -49,7 +49,7 @@ module OpenAI
         # A tool call that executes one or more shell commands in a managed environment.
         variant :shell_call, -> { OpenAI::Responses::ResponseFunctionShellToolCall }
 
-        # The output of a shell tool call.
+        # The output of a shell tool call that was emitted.
         variant :shell_call_output, -> { OpenAI::Responses::ResponseFunctionShellToolCallOutput }
 
         # A tool call that applies file diffs by creating, deleting, or updating files.

data/lib/openai/models/responses/response_output_text.rb

@@ -47,7 +47,7 @@ module OpenAI
         #
         #   @param type [Symbol, :output_text] The type of the output text. Always `output_text`.
 
-        # A citation to a file.
+        # An annotation that applies to a span of output text.
         module Annotation
           extend OpenAI::Internal::Type::Union
 

data/lib/openai/models/responses/tool.rb

@@ -399,6 +399,7 @@ module OpenAI
               optional :file_ids, OpenAI::Internal::Type::ArrayOf[String]
 
               # @!attribute memory_limit
+              #   The memory limit for the code interpreter container.
               #
               #   @return [Symbol, OpenAI::Models::Responses::Tool::CodeInterpreter::Container::CodeInterpreterToolAuto::MemoryLimit, nil]
               optional :memory_limit,
@@ -413,10 +414,12 @@ module OpenAI
               #
               #   @param file_ids [Array<String>] An optional list of uploaded files to make available to your code.
               #
-              #   @param memory_limit [Symbol, OpenAI::Models::Responses::Tool::CodeInterpreter::Container::CodeInterpreterToolAuto::MemoryLimit, nil]
+              #   @param memory_limit [Symbol, OpenAI::Models::Responses::Tool::CodeInterpreter::Container::CodeInterpreterToolAuto::MemoryLimit, nil] The memory limit for the code interpreter container.
               #
               #   @param type [Symbol, :auto] Always `auto`.
 
+              # The memory limit for the code interpreter container.
+              #
               # @see OpenAI::Models::Responses::Tool::CodeInterpreter::Container::CodeInterpreterToolAuto#memory_limit
               module MemoryLimit
                 extend OpenAI::Internal::Type::Enum