openai 0.8.0 → 0.10.0

data/rbi/openai/models/responses/response.rbi

@@ -42,13 +42,16 @@ module OpenAI
         end
         attr_writer :incomplete_details
 
-        # Inserts a system (or developer) message as the first item in the model's
-        # context.
+        # A system (or developer) message inserted into the model's context.
         #
         # When using along with `previous_response_id`, the instructions from a previous
         # response will not be carried over to the next response. This makes it simple to
         # swap out system (or developer) messages in new responses.
-        sig { returns(T.nilable(String)) }
+        sig do
+          returns(
+            T.nilable(OpenAI::Responses::Response::Instructions::Variants)
+          )
+        end
         attr_accessor :instructions
 
         # Set of 16 key-value pairs that can be attached to an object. This can be useful
@@ -143,6 +146,18 @@ module OpenAI
         sig { returns(T.nilable(String)) }
         attr_accessor :previous_response_id
 
+        # Reference to a prompt template and its variables.
+        # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+        sig { returns(T.nilable(OpenAI::Responses::ResponsePrompt)) }
+        attr_reader :prompt
+
+        sig do
+          params(
+            prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash)
+          ).void
+        end
+        attr_writer :prompt
+
         # **o-series models only**
         #
         # Configuration options for
@@ -236,7 +251,8 @@ module OpenAI
             error: T.nilable(OpenAI::Responses::ResponseError::OrHash),
             incomplete_details:
               T.nilable(OpenAI::Responses::Response::IncompleteDetails::OrHash),
-            instructions: T.nilable(String),
+            instructions:
+              T.nilable(OpenAI::Responses::Response::Instructions::Variants),
             metadata: T.nilable(T::Hash[Symbol, String]),
             model:
               T.any(
@@ -286,6 +302,7 @@ module OpenAI
             background: T.nilable(T::Boolean),
             max_output_tokens: T.nilable(Integer),
             previous_response_id: T.nilable(String),
+            prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash),
             reasoning: T.nilable(OpenAI::Reasoning::OrHash),
             service_tier:
               T.nilable(OpenAI::Responses::Response::ServiceTier::OrSymbol),
@@ -307,8 +324,7 @@ module OpenAI
           error:,
           # Details about why the response is incomplete.
           incomplete_details:,
-          # Inserts a system (or developer) message as the first item in the model's
-          # context.
+          # A system (or developer) message inserted into the model's context.
           #
           # When using along with `previous_response_id`, the instructions from a previous
           # response will not be carried over to the next response. This makes it simple to
@@ -378,6 +394,9 @@ module OpenAI
           # multi-turn conversations. Learn more about
           # [conversation state](https://platform.openai.com/docs/guides/conversation-state).
           previous_response_id: nil,
+          # Reference to a prompt template and its variables.
+          # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+          prompt: nil,
           # **o-series models only**
           #
           # Configuration options for
@@ -438,7 +457,8 @@ module OpenAI
               error: T.nilable(OpenAI::Responses::ResponseError),
               incomplete_details:
                 T.nilable(OpenAI::Responses::Response::IncompleteDetails),
-              instructions: T.nilable(String),
+              instructions:
+                T.nilable(OpenAI::Responses::Response::Instructions::Variants),
               metadata: T.nilable(T::Hash[Symbol, String]),
               model: OpenAI::ResponsesModel::Variants,
               object: Symbol,
@@ -451,6 +471,7 @@ module OpenAI
               background: T.nilable(T::Boolean),
               max_output_tokens: T.nilable(Integer),
               previous_response_id: T.nilable(String),
+              prompt: T.nilable(OpenAI::Responses::ResponsePrompt),
               reasoning: T.nilable(OpenAI::Reasoning),
               service_tier:
                 T.nilable(
@@ -557,6 +578,39 @@ module OpenAI
           end
         end
 
+        # A system (or developer) message inserted into the model's context.
+        #
+        # When using along with `previous_response_id`, the instructions from a previous
+        # response will not be carried over to the next response. This makes it simple to
+        # swap out system (or developer) messages in new responses.
+        module Instructions
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                String,
+                T::Array[OpenAI::Responses::ResponseInputItem::Variants]
+              )
+            end
+
+          sig do
+            override.returns(
+              T::Array[OpenAI::Responses::Response::Instructions::Variants]
+            )
+          end
+          def self.variants
+          end
+
+          ResponseInputItemArray =
+            T.let(
+              OpenAI::Internal::Type::ArrayOf[
+                union: OpenAI::Responses::ResponseInputItem
+              ],
+              OpenAI::Internal::Type::Converter
+            )
+        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.
@@ -616,6 +670,11 @@ module OpenAI
             )
           FLEX =
             T.let(:flex, OpenAI::Responses::Response::ServiceTier::TaggedSymbol)
+          SCALE =
+            T.let(
+              :scale,
+              OpenAI::Responses::Response::ServiceTier::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/openai/models/responses/response_code_interpreter_call_code_delta_event.rbi

@@ -12,15 +12,20 @@ module OpenAI
             )
           end
 
-        # The partial code snippet added by the code interpreter.
+        # The partial code snippet being streamed by the code interpreter.
         sig { returns(String) }
         attr_accessor :delta
 
-        # The index of the output item that the code interpreter call is in progress.
+        # The unique identifier of the code interpreter tool call item.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the output item in the response for which the code is being
+        # streamed.
         sig { returns(Integer) }
         attr_accessor :output_index
 
-        # The sequence number of this event.
+        # The sequence number of this event, used to order streaming events.
         sig { returns(Integer) }
         attr_accessor :sequence_number
 
@@ -28,21 +33,25 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
-        # Emitted when a partial code snippet is added by the code interpreter.
+        # Emitted when a partial code snippet is streamed by the code interpreter.
         sig do
           params(
             delta: String,
+            item_id: String,
             output_index: Integer,
             sequence_number: Integer,
             type: Symbol
           ).returns(T.attached_class)
         end
         def self.new(
-          # The partial code snippet added by the code interpreter.
+          # The partial code snippet being streamed by the code interpreter.
           delta:,
-          # The index of the output item that the code interpreter call is in progress.
+          # The unique identifier of the code interpreter tool call item.
+          item_id:,
+          # The index of the output item in the response for which the code is being
+          # streamed.
           output_index:,
-          # The sequence number of this event.
+          # The sequence number of this event, used to order streaming events.
           sequence_number:,
           # The type of the event. Always `response.code_interpreter_call_code.delta`.
           type: :"response.code_interpreter_call_code.delta"
@@ -53,6 +62,7 @@ module OpenAI
           override.returns(
             {
               delta: String,
+              item_id: String,
               output_index: Integer,
               sequence_number: Integer,
               type: Symbol

data/rbi/openai/models/responses/response_code_interpreter_call_code_done_event.rbi

@@ -16,11 +16,15 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :code
 
-        # The index of the output item that the code interpreter call is in progress.
+        # The unique identifier of the code interpreter tool call item.
+        sig { returns(String) }
+        attr_accessor :item_id
+
+        # The index of the output item in the response for which the code is finalized.
         sig { returns(Integer) }
         attr_accessor :output_index
 
-        # The sequence number of this event.
+        # The sequence number of this event, used to order streaming events.
         sig { returns(Integer) }
         attr_accessor :sequence_number
 
@@ -28,10 +32,11 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
-        # Emitted when code snippet output is finalized by the code interpreter.
+        # Emitted when the code snippet is finalized by the code interpreter.
         sig do
           params(
             code: String,
+            item_id: String,
             output_index: Integer,
             sequence_number: Integer,
             type: Symbol
@@ -40,9 +45,11 @@ module OpenAI
         def self.new(
           # The final code snippet output by the code interpreter.
           code:,
-          # The index of the output item that the code interpreter call is in progress.
+          # The unique identifier of the code interpreter tool call item.
+          item_id:,
+          # The index of the output item in the response for which the code is finalized.
           output_index:,
-          # The sequence number of this event.
+          # The sequence number of this event, used to order streaming events.
           sequence_number:,
           # The type of the event. Always `response.code_interpreter_call_code.done`.
           type: :"response.code_interpreter_call_code.done"
@@ -53,6 +60,7 @@ module OpenAI
           override.returns(
             {
               code: String,
+              item_id: String,
               output_index: Integer,
               sequence_number: Integer,
               type: Symbol

data/rbi/openai/models/responses/response_code_interpreter_call_completed_event.rbi

@@ -12,23 +12,16 @@ module OpenAI
             )
           end
 
-        # A tool call to run code.
-        sig { returns(OpenAI::Responses::ResponseCodeInterpreterToolCall) }
-        attr_reader :code_interpreter_call
+        # The unique identifier of the code interpreter tool call item.
+        sig { returns(String) }
+        attr_accessor :item_id
 
-        sig do
-          params(
-            code_interpreter_call:
-              OpenAI::Responses::ResponseCodeInterpreterToolCall::OrHash
-          ).void
-        end
-        attr_writer :code_interpreter_call
-
-        # The index of the output item that the code interpreter call is in progress.
+        # The index of the output item in the response for which the code interpreter call
+        # is completed.
         sig { returns(Integer) }
         attr_accessor :output_index
 
-        # The sequence number of this event.
+        # The sequence number of this event, used to order streaming events.
         sig { returns(Integer) }
         attr_accessor :sequence_number
 
@@ -39,19 +32,19 @@ module OpenAI
         # Emitted when the code interpreter call is completed.
         sig do
           params(
-            code_interpreter_call:
-              OpenAI::Responses::ResponseCodeInterpreterToolCall::OrHash,
+            item_id: String,
             output_index: Integer,
             sequence_number: Integer,
             type: Symbol
           ).returns(T.attached_class)
         end
         def self.new(
-          # A tool call to run code.
-          code_interpreter_call:,
-          # The index of the output item that the code interpreter call is in progress.
+          # The unique identifier of the code interpreter tool call item.
+          item_id:,
+          # The index of the output item in the response for which the code interpreter call
+          # is completed.
           output_index:,
-          # The sequence number of this event.
+          # The sequence number of this event, used to order streaming events.
           sequence_number:,
           # The type of the event. Always `response.code_interpreter_call.completed`.
           type: :"response.code_interpreter_call.completed"
@@ -61,8 +54,7 @@ module OpenAI
         sig do
           override.returns(
             {
-              code_interpreter_call:
-                OpenAI::Responses::ResponseCodeInterpreterToolCall,
+              item_id: String,
               output_index: Integer,
               sequence_number: Integer,
               type: Symbol

data/rbi/openai/models/responses/response_code_interpreter_call_in_progress_event.rbi

@@ -12,23 +12,16 @@ module OpenAI
             )
           end
 
-        # A tool call to run code.
-        sig { returns(OpenAI::Responses::ResponseCodeInterpreterToolCall) }
-        attr_reader :code_interpreter_call
+        # The unique identifier of the code interpreter tool call item.
+        sig { returns(String) }
+        attr_accessor :item_id
 
-        sig do
-          params(
-            code_interpreter_call:
-              OpenAI::Responses::ResponseCodeInterpreterToolCall::OrHash
-          ).void
-        end
-        attr_writer :code_interpreter_call
-
-        # The index of the output item that the code interpreter call is in progress.
+        # The index of the output item in the response for which the code interpreter call
+        # is in progress.
         sig { returns(Integer) }
         attr_accessor :output_index
 
-        # The sequence number of this event.
+        # The sequence number of this event, used to order streaming events.
         sig { returns(Integer) }
         attr_accessor :sequence_number
 
@@ -39,19 +32,19 @@ module OpenAI
         # Emitted when a code interpreter call is in progress.
         sig do
           params(
-            code_interpreter_call:
-              OpenAI::Responses::ResponseCodeInterpreterToolCall::OrHash,
+            item_id: String,
             output_index: Integer,
             sequence_number: Integer,
             type: Symbol
           ).returns(T.attached_class)
         end
         def self.new(
-          # A tool call to run code.
-          code_interpreter_call:,
-          # The index of the output item that the code interpreter call is in progress.
+          # The unique identifier of the code interpreter tool call item.
+          item_id:,
+          # The index of the output item in the response for which the code interpreter call
+          # is in progress.
           output_index:,
-          # The sequence number of this event.
+          # The sequence number of this event, used to order streaming events.
           sequence_number:,
           # The type of the event. Always `response.code_interpreter_call.in_progress`.
           type: :"response.code_interpreter_call.in_progress"
@@ -61,8 +54,7 @@ module OpenAI
         sig do
           override.returns(
             {
-              code_interpreter_call:
-                OpenAI::Responses::ResponseCodeInterpreterToolCall,
+              item_id: String,
               output_index: Integer,
               sequence_number: Integer,
               type: Symbol

data/rbi/openai/models/responses/response_code_interpreter_call_interpreting_event.rbi

@@ -12,23 +12,16 @@ module OpenAI
             )
           end
 
-        # A tool call to run code.
-        sig { returns(OpenAI::Responses::ResponseCodeInterpreterToolCall) }
-        attr_reader :code_interpreter_call
+        # The unique identifier of the code interpreter tool call item.
+        sig { returns(String) }
+        attr_accessor :item_id
 
-        sig do
-          params(
-            code_interpreter_call:
-              OpenAI::Responses::ResponseCodeInterpreterToolCall::OrHash
-          ).void
-        end
-        attr_writer :code_interpreter_call
-
-        # The index of the output item that the code interpreter call is in progress.
+        # The index of the output item in the response for which the code interpreter is
+        # interpreting code.
         sig { returns(Integer) }
         attr_accessor :output_index
 
-        # The sequence number of this event.
+        # The sequence number of this event, used to order streaming events.
         sig { returns(Integer) }
         attr_accessor :sequence_number
 
@@ -39,19 +32,19 @@ module OpenAI
         # Emitted when the code interpreter is actively interpreting the code snippet.
         sig do
           params(
-            code_interpreter_call:
-              OpenAI::Responses::ResponseCodeInterpreterToolCall::OrHash,
+            item_id: String,
             output_index: Integer,
             sequence_number: Integer,
             type: Symbol
           ).returns(T.attached_class)
         end
         def self.new(
-          # A tool call to run code.
-          code_interpreter_call:,
-          # The index of the output item that the code interpreter call is in progress.
+          # The unique identifier of the code interpreter tool call item.
+          item_id:,
+          # The index of the output item in the response for which the code interpreter is
+          # interpreting code.
           output_index:,
-          # The sequence number of this event.
+          # The sequence number of this event, used to order streaming events.
           sequence_number:,
           # The type of the event. Always `response.code_interpreter_call.interpreting`.
           type: :"response.code_interpreter_call.interpreting"
@@ -61,8 +54,7 @@ module OpenAI
         sig do
           override.returns(
             {
-              code_interpreter_call:
-                OpenAI::Responses::ResponseCodeInterpreterToolCall,
+              item_id: String,
               output_index: Integer,
               sequence_number: Integer,
               type: Symbol