openai 0.42.0 → 0.45.0

data/rbi/openai/models/chat/chat_completion_audio_param.rbi

@@ -21,8 +21,9 @@ module OpenAI
         end
         attr_accessor :format_
 
-        # 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`.
         sig do
           returns(
             T.any(
@@ -50,8 +51,9 @@ module OpenAI
           # Specifies the output audio format. Must be one of `wav`, `mp3`, `flac`, `opus`,
           # or `pcm16`.
           format_:,
-          # 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`.
           voice:
         )
         end
@@ -124,8 +126,9 @@ module OpenAI
           end
         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`.
         module Voice
           extend OpenAI::Internal::Type::Union
 

data/rbi/openai/models/conversations/message.rbi

@@ -87,7 +87,7 @@ module OpenAI
         def to_hash
         end
 
-        # 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/rbi/openai/models/file_create_params.rbi

@@ -15,10 +15,14 @@ module OpenAI
       sig { returns(OpenAI::Internal::FileInput) }
       attr_accessor :file
 
-      # The intended purpose of the uploaded file. One of: - `assistants`: Used in the
-      # Assistants API - `batch`: Used in the Batch API - `fine-tune`: Used for
-      # fine-tuning - `vision`: Images used for vision fine-tuning - `user_data`:
-      # Flexible file type for any purpose - `evals`: Used for eval data sets
+      # The intended purpose of the uploaded file. One of:
+      #
+      # - `assistants`: Used in the Assistants API
+      # - `batch`: Used in the Batch API
+      # - `fine-tune`: Used for fine-tuning
+      # - `vision`: Images used for vision fine-tuning
+      # - `user_data`: Flexible file type for any purpose
+      # - `evals`: Used for eval data sets
       sig { returns(OpenAI::FilePurpose::OrSymbol) }
       attr_accessor :purpose
 
@@ -45,10 +49,14 @@ module OpenAI
       def self.new(
         # The File object (not file name) to be uploaded.
         file:,
-        # The intended purpose of the uploaded file. One of: - `assistants`: Used in the
-        # Assistants API - `batch`: Used in the Batch API - `fine-tune`: Used for
-        # fine-tuning - `vision`: Images used for vision fine-tuning - `user_data`:
-        # Flexible file type for any purpose - `evals`: Used for eval data sets
+        # The intended purpose of the uploaded file. One of:
+        #
+        # - `assistants`: Used in the Assistants API
+        # - `batch`: Used in the Batch API
+        # - `fine-tune`: Used for fine-tuning
+        # - `vision`: Images used for vision fine-tuning
+        # - `user_data`: Flexible file type for any purpose
+        # - `evals`: Used for eval data sets
         purpose:,
         # The expiration policy for a file. By default, files with `purpose=batch` expire
         # after 30 days and all other files are persisted until they are manually deleted.

data/rbi/openai/models/file_purpose.rbi

@@ -2,10 +2,14 @@
 
 module OpenAI
   module Models
-    # The intended purpose of the uploaded file. One of: - `assistants`: Used in the
-    # Assistants API - `batch`: Used in the Batch API - `fine-tune`: Used for
-    # fine-tuning - `vision`: Images used for vision fine-tuning - `user_data`:
-    # Flexible file type for any purpose - `evals`: Used for eval data sets
+    # The intended purpose of the uploaded file. One of:
+    #
+    # - `assistants`: Used in the Assistants API
+    # - `batch`: Used in the Batch API
+    # - `fine-tune`: Used for fine-tuning
+    # - `vision`: Images used for vision fine-tuning
+    # - `user_data`: Flexible file type for any purpose
+    # - `evals`: Used for eval data sets
     module FilePurpose
       extend OpenAI::Internal::Type::Enum
 

data/rbi/openai/models/realtime/conversation_item_create_event.rbi

@@ -42,10 +42,14 @@ module OpenAI
         attr_writer :event_id
 
         # The ID of the preceding item after which the new item will be inserted. If not
-        # set, the new item will be appended to the end of the conversation. If set to
-        # `root`, the new item will be added to the beginning of the conversation. If set
-        # to an existing ID, it allows an item to be inserted mid-conversation. If the ID
-        # cannot be found, an error will be returned and the item will not be added.
+        # set, the new item will be appended to the end of the conversation.
+        #
+        # If set to `root`, the new item will be added to the beginning of the
+        # conversation.
+        #
+        # If set to an existing ID, it allows an item to be inserted mid-conversation. If
+        # the ID cannot be found, an error will be returned and the item will not be
+        # added.
         sig { returns(T.nilable(String)) }
         attr_reader :previous_item_id
 
@@ -84,10 +88,14 @@ module OpenAI
           # Optional client-generated ID used to identify this event.
           event_id: nil,
           # The ID of the preceding item after which the new item will be inserted. If not
-          # set, the new item will be appended to the end of the conversation. If set to
-          # `root`, the new item will be added to the beginning of the conversation. If set
-          # to an existing ID, it allows an item to be inserted mid-conversation. If the ID
-          # cannot be found, an error will be returned and the item will not be added.
+          # set, the new item will be appended to the end of the conversation.
+          #
+          # If set to `root`, the new item will be added to the beginning of the
+          # conversation.
+          #
+          # If set to an existing ID, it allows an item to be inserted mid-conversation. If
+          # the ID cannot be found, an error will be returned and the item will not be
+          # added.
           previous_item_id: nil,
           # The event type, must be `conversation.item.create`.
           type: :"conversation.item.create"

data/rbi/openai/models/realtime/realtime_audio_config_output.rbi

@@ -51,10 +51,10 @@ module OpenAI
         sig { params(speed: Float).void }
         attr_writer :speed
 
-        # 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.
         sig do
           returns(
             T.nilable(
@@ -105,10 +105,10 @@ module OpenAI
           # This parameter is a post-processing adjustment to the audio after it is
           # generated, it's also possible to prompt the model to speak faster or slower.
           speed: nil,
-          # 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.
           voice: nil
         )
         end
@@ -134,10 +134,10 @@ module OpenAI
         def to_hash
         end
 
-        # 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.
         module Voice
           extend OpenAI::Internal::Type::Union
 

data/rbi/openai/models/realtime/realtime_response_create_audio_output.rbi

@@ -85,10 +85,10 @@ module OpenAI
           end
           attr_writer :format_
 
-          # 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.
           sig do
             returns(
               T.nilable(
@@ -130,10 +130,10 @@ module OpenAI
           def self.new(
             # The format of the output audio.
             format_: nil,
-            # 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.
             voice: nil
           )
           end
@@ -158,10 +158,10 @@ module OpenAI
           def to_hash
           end
 
-          # 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.
           module Voice
             extend OpenAI::Internal::Type::Union
 

data/rbi/openai/models/realtime/response_function_call_arguments_done_event.rbi

@@ -28,6 +28,10 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :item_id
 
+        # The name of the function that was called.
+        sig { returns(String) }
+        attr_accessor :name
+
         # The index of the output item in the response.
         sig { returns(Integer) }
         attr_accessor :output_index
@@ -48,6 +52,7 @@ module OpenAI
             call_id: String,
             event_id: String,
             item_id: String,
+            name: String,
             output_index: Integer,
             response_id: String,
             type: Symbol
@@ -62,6 +67,8 @@ module OpenAI
           event_id:,
           # The ID of the function call item.
           item_id:,
+          # The name of the function that was called.
+          name:,
           # The index of the output item in the response.
           output_index:,
           # The ID of the response.
@@ -78,6 +85,7 @@ module OpenAI
               call_id: String,
               event_id: String,
               item_id: String,
+              name: String,
               output_index: Integer,
               response_id: String,
               type: Symbol

data/rbi/openai/models/responses/input_token_count_params.rbi

@@ -88,9 +88,7 @@ module OpenAI
         end
         attr_writer :text
 
-        # 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.
         sig do
           returns(
             T.nilable(
@@ -249,9 +247,7 @@ module OpenAI
           # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
           # - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
           text: nil,
-          # 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.
           tool_choice: nil,
           # An array of tools the model may call while generating a response. You can
           # specify which tool to use by setting the `tool_choice` parameter.
@@ -540,9 +536,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/rbi/openai/models/responses/response.rbi

@@ -139,8 +139,13 @@ module OpenAI
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :background
 
-        # The conversation that this response belongs to. Input items and output items
-        # from this response are automatically added to this conversation.
+        # Unix timestamp (in seconds) of when this Response was completed. Only present
+        # when the status is `completed`.
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :completed_at
+
+        # The conversation that this response belonged to. Input items and output items
+        # from this response were automatically added to this conversation.
         sig { returns(T.nilable(OpenAI::Responses::Response::Conversation)) }
         attr_reader :conversation
 
@@ -380,6 +385,7 @@ module OpenAI
               ],
             top_p: T.nilable(Float),
             background: T.nilable(T::Boolean),
+            completed_at: T.nilable(Float),
             conversation:
               T.nilable(OpenAI::Responses::Response::Conversation::OrHash),
             max_output_tokens: T.nilable(Integer),
@@ -481,8 +487,11 @@ module OpenAI
           # Whether to run the model response in the background.
           # [Learn more](https://platform.openai.com/docs/guides/background).
           background: nil,
-          # The conversation that this response belongs to. Input items and output items
-          # from this response are automatically added to this conversation.
+          # Unix timestamp (in seconds) of when this Response was completed. Only present
+          # when the status is `completed`.
+          completed_at: nil,
+          # The conversation that this response belonged to. Input items and output items
+          # from this response were automatically added to this conversation.
           conversation: nil,
           # An upper bound for the number of tokens that can be generated for a response,
           # including visible output tokens and
@@ -592,6 +601,7 @@ module OpenAI
               tools: T::Array[OpenAI::Responses::Tool::Variants],
               top_p: T.nilable(Float),
               background: T.nilable(T::Boolean),
+              completed_at: T.nilable(Float),
               conversation:
                 T.nilable(OpenAI::Responses::Response::Conversation),
               max_output_tokens: T.nilable(Integer),
@@ -782,15 +792,15 @@ module OpenAI
               )
             end
 
-          # The unique ID of the conversation.
+          # The unique ID of the conversation that this response was associated with.
           sig { returns(String) }
           attr_accessor :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.
           sig { params(id: String).returns(T.attached_class) }
           def self.new(
-            # The unique ID of the conversation.
+            # The unique ID of the conversation that this response was associated with.
             id:
           )
           end

data/rbi/openai/models/responses/response_compaction_item.rbi

@@ -16,6 +16,7 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :id
 
+        # The encrypted content that was produced by compaction.
         sig { returns(String) }
         attr_accessor :encrypted_content
 
@@ -23,6 +24,7 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
+        # The identifier of the actor that created the item.
         sig { returns(T.nilable(String)) }
         attr_reader :created_by
 
@@ -42,7 +44,9 @@ module OpenAI
         def self.new(
           # The unique ID of the compaction item.
           id:,
+          # The encrypted content that was produced by compaction.
           encrypted_content:,
+          # The identifier of the actor that created the item.
           created_by: nil,
           # The type of the item. Always `compaction`.
           type: :compaction

data/rbi/openai/models/responses/response_compaction_item_param.rbi

@@ -12,6 +12,7 @@ module OpenAI
             )
           end
 
+        # The encrypted content of the compaction summary.
         sig { returns(String) }
         attr_accessor :encrypted_content
 
@@ -33,6 +34,7 @@ module OpenAI
           ).returns(T.attached_class)
         end
         def self.new(
+          # The encrypted content of the compaction summary.
           encrypted_content:,
           # The ID of the compaction item.
           id: nil,

data/rbi/openai/models/responses/response_function_call_output_item.rbi

@@ -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/rbi/openai/models/responses/response_function_shell_tool_call_output.rbi

@@ -36,17 +36,27 @@ module OpenAI
         end
         attr_accessor :output
 
+        # The status of the shell call output. One of `in_progress`, `completed`, or
+        # `incomplete`.
+        sig do
+          returns(
+            OpenAI::Responses::ResponseFunctionShellToolCallOutput::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
         # The type of the shell call output. Always `shell_call_output`.
         sig { returns(Symbol) }
         attr_accessor :type
 
+        # The identifier of the actor that created the item.
         sig { returns(T.nilable(String)) }
         attr_reader :created_by
 
         sig { params(created_by: String).void }
         attr_writer :created_by
 
-        # The output of a shell tool call.
+        # The output of a shell tool call that was emitted.
         sig do
           params(
             id: String,
@@ -56,6 +66,8 @@ module OpenAI
               T::Array[
                 OpenAI::Responses::ResponseFunctionShellToolCallOutput::Output::OrHash
               ],
+            status:
+              OpenAI::Responses::ResponseFunctionShellToolCallOutput::Status::OrSymbol,
             created_by: String,
             type: Symbol
           ).returns(T.attached_class)
@@ -71,6 +83,10 @@ module OpenAI
           max_output_length:,
           # An array of shell call output contents
           output:,
+          # The status of the shell call output. One of `in_progress`, `completed`, or
+          # `incomplete`.
+          status:,
+          # The identifier of the actor that created the item.
           created_by: nil,
           # The type of the shell call output. Always `shell_call_output`.
           type: :shell_call_output
@@ -87,6 +103,8 @@ module OpenAI
                 T::Array[
                   OpenAI::Responses::ResponseFunctionShellToolCallOutput::Output
                 ],
+              status:
+                OpenAI::Responses::ResponseFunctionShellToolCallOutput::Status::TaggedSymbol,
               type: Symbol,
               created_by: String
             }
@@ -113,19 +131,22 @@ module OpenAI
           end
           attr_accessor :outcome
 
+          # The standard error output that was captured.
           sig { returns(String) }
           attr_accessor :stderr
 
+          # The standard output that was captured.
           sig { returns(String) }
           attr_accessor :stdout
 
+          # The identifier of the actor that created the item.
           sig { returns(T.nilable(String)) }
           attr_reader :created_by
 
           sig { params(created_by: String).void }
           attr_writer :created_by
 
-          # The content of a shell call output.
+          # The content of a shell tool call output that was emitted.
           sig do
             params(
               outcome:
@@ -142,8 +163,11 @@ module OpenAI
             # Represents either an exit outcome (with an exit code) or a timeout outcome for a
             # shell call output chunk.
             outcome:,
+            # The standard error output that was captured.
             stderr:,
+            # The standard output that was captured.
             stdout:,
+            # The identifier of the actor that created the item.
             created_by: nil
           )
           end
@@ -248,6 +272,47 @@ module OpenAI
             end
           end
         end
+
+        # The status of the shell call output. One of `in_progress`, `completed`, or
+        # `incomplete`.
+        module Status
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Responses::ResponseFunctionShellToolCallOutput::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          IN_PROGRESS =
+            T.let(
+              :in_progress,
+              OpenAI::Responses::ResponseFunctionShellToolCallOutput::Status::TaggedSymbol
+            )
+          COMPLETED =
+            T.let(
+              :completed,
+              OpenAI::Responses::ResponseFunctionShellToolCallOutput::Status::TaggedSymbol
+            )
+          INCOMPLETE =
+            T.let(
+              :incomplete,
+              OpenAI::Responses::ResponseFunctionShellToolCallOutput::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::ResponseFunctionShellToolCallOutput::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end