openai 0.8.0 → 0.10.0

data/rbi/openai/models/responses/response_code_interpreter_tool_call.rbi

@@ -16,22 +16,29 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :id
 
-        # The code to run.
-        sig { returns(String) }
+        # The code to run, or null if not available.
+        sig { returns(T.nilable(String)) }
         attr_accessor :code
 
-        # The results of the code interpreter tool call.
+        # The ID of the container used to run the code.
+        sig { returns(String) }
+        attr_accessor :container_id
+
+        # The outputs generated by the code interpreter, such as logs or images. Can be
+        # null if no outputs are available.
         sig do
           returns(
-            T::Array[
-              T.any(
-                OpenAI::Responses::ResponseCodeInterpreterToolCall::Result::Logs,
-                OpenAI::Responses::ResponseCodeInterpreterToolCall::Result::Files
-              )
-            ]
+            T.nilable(
+              T::Array[
+                T.any(
+                  OpenAI::Responses::ResponseCodeInterpreterToolCall::Output::Logs,
+                  OpenAI::Responses::ResponseCodeInterpreterToolCall::Output::Image
+                )
+              ]
+            )
           )
         end
-        attr_accessor :results
+        attr_accessor :outputs
 
         # The status of the code interpreter tool call.
         sig do
@@ -45,42 +52,38 @@ module OpenAI
         sig { returns(Symbol) }
         attr_accessor :type
 
-        # The ID of the container used to run the code.
-        sig { returns(T.nilable(String)) }
-        attr_reader :container_id
-
-        sig { params(container_id: String).void }
-        attr_writer :container_id
-
         # A tool call to run code.
         sig do
           params(
             id: String,
-            code: String,
-            results:
-              T::Array[
-                T.any(
-                  OpenAI::Responses::ResponseCodeInterpreterToolCall::Result::Logs::OrHash,
-                  OpenAI::Responses::ResponseCodeInterpreterToolCall::Result::Files::OrHash
-                )
-              ],
+            code: T.nilable(String),
+            container_id: String,
+            outputs:
+              T.nilable(
+                T::Array[
+                  T.any(
+                    OpenAI::Responses::ResponseCodeInterpreterToolCall::Output::Logs::OrHash,
+                    OpenAI::Responses::ResponseCodeInterpreterToolCall::Output::Image::OrHash
+                  )
+                ]
+              ),
             status:
               OpenAI::Responses::ResponseCodeInterpreterToolCall::Status::OrSymbol,
-            container_id: String,
             type: Symbol
           ).returns(T.attached_class)
         end
         def self.new(
           # The unique ID of the code interpreter tool call.
           id:,
-          # The code to run.
+          # The code to run, or null if not available.
           code:,
-          # The results of the code interpreter tool call.
-          results:,
+          # The ID of the container used to run the code.
+          container_id:,
+          # The outputs generated by the code interpreter, such as logs or images. Can be
+          # null if no outputs are available.
+          outputs:,
           # The status of the code interpreter tool call.
           status:,
-          # The ID of the container used to run the code.
-          container_id: nil,
           # The type of the code interpreter tool call. Always `code_interpreter_call`.
           type: :code_interpreter_call
         )
@@ -90,33 +93,35 @@ module OpenAI
           override.returns(
             {
               id: String,
-              code: String,
-              results:
-                T::Array[
-                  T.any(
-                    OpenAI::Responses::ResponseCodeInterpreterToolCall::Result::Logs,
-                    OpenAI::Responses::ResponseCodeInterpreterToolCall::Result::Files
-                  )
-                ],
+              code: T.nilable(String),
+              container_id: String,
+              outputs:
+                T.nilable(
+                  T::Array[
+                    T.any(
+                      OpenAI::Responses::ResponseCodeInterpreterToolCall::Output::Logs,
+                      OpenAI::Responses::ResponseCodeInterpreterToolCall::Output::Image
+                    )
+                  ]
+                ),
               status:
                 OpenAI::Responses::ResponseCodeInterpreterToolCall::Status::OrSymbol,
-              type: Symbol,
-              container_id: String
+              type: Symbol
             }
           )
         end
         def to_hash
         end
 
-        # The output of a code interpreter tool.
-        module Result
+        # The logs output from the code interpreter.
+        module Output
           extend OpenAI::Internal::Type::Union
 
           Variants =
             T.type_alias do
               T.any(
-                OpenAI::Responses::ResponseCodeInterpreterToolCall::Result::Logs,
-                OpenAI::Responses::ResponseCodeInterpreterToolCall::Result::Files
+                OpenAI::Responses::ResponseCodeInterpreterToolCall::Output::Logs,
+                OpenAI::Responses::ResponseCodeInterpreterToolCall::Output::Image
               )
             end
 
@@ -124,25 +129,25 @@ module OpenAI
             OrHash =
               T.type_alias do
                 T.any(
-                  OpenAI::Responses::ResponseCodeInterpreterToolCall::Result::Logs,
+                  OpenAI::Responses::ResponseCodeInterpreterToolCall::Output::Logs,
                   OpenAI::Internal::AnyHash
                 )
               end
 
-            # The logs of the code interpreter tool call.
+            # The logs output from the code interpreter.
             sig { returns(String) }
             attr_accessor :logs
 
-            # The type of the code interpreter text output. Always `logs`.
+            # The type of the output. Always 'logs'.
             sig { returns(Symbol) }
             attr_accessor :type
 
-            # The output of a code interpreter tool call that is text.
+            # The logs output from the code interpreter.
             sig { params(logs: String, type: Symbol).returns(T.attached_class) }
             def self.new(
-              # The logs of the code interpreter tool call.
+              # The logs output from the code interpreter.
               logs:,
-              # The type of the code interpreter text output. Always `logs`.
+              # The type of the output. Always 'logs'.
               type: :logs
             )
             end
@@ -152,99 +157,42 @@ module OpenAI
             end
           end
 
-          class Files < OpenAI::Internal::Type::BaseModel
+          class Image < OpenAI::Internal::Type::BaseModel
             OrHash =
               T.type_alias do
                 T.any(
-                  OpenAI::Responses::ResponseCodeInterpreterToolCall::Result::Files,
+                  OpenAI::Responses::ResponseCodeInterpreterToolCall::Output::Image,
                   OpenAI::Internal::AnyHash
                 )
               end
 
-            sig do
-              returns(
-                T::Array[
-                  OpenAI::Responses::ResponseCodeInterpreterToolCall::Result::Files::File
-                ]
-              )
-            end
-            attr_accessor :files
-
-            # The type of the code interpreter file output. Always `files`.
+            # The type of the output. Always 'image'.
             sig { returns(Symbol) }
             attr_accessor :type
 
-            # The output of a code interpreter tool call that is a file.
-            sig do
-              params(
-                files:
-                  T::Array[
-                    OpenAI::Responses::ResponseCodeInterpreterToolCall::Result::Files::File::OrHash
-                  ],
-                type: Symbol
-              ).returns(T.attached_class)
-            end
+            # The URL of the image output from the code interpreter.
+            sig { returns(String) }
+            attr_accessor :url
+
+            # The image output from the code interpreter.
+            sig { params(url: String, type: Symbol).returns(T.attached_class) }
             def self.new(
-              files:,
-              # The type of the code interpreter file output. Always `files`.
-              type: :files
+              # The URL of the image output from the code interpreter.
+              url:,
+              # The type of the output. Always 'image'.
+              type: :image
             )
             end
 
-            sig do
-              override.returns(
-                {
-                  files:
-                    T::Array[
-                      OpenAI::Responses::ResponseCodeInterpreterToolCall::Result::Files::File
-                    ],
-                  type: Symbol
-                }
-              )
-            end
+            sig { override.returns({ type: Symbol, url: String }) }
             def to_hash
             end
-
-            class File < OpenAI::Internal::Type::BaseModel
-              OrHash =
-                T.type_alias do
-                  T.any(
-                    OpenAI::Responses::ResponseCodeInterpreterToolCall::Result::Files::File,
-                    OpenAI::Internal::AnyHash
-                  )
-                end
-
-              # The ID of the file.
-              sig { returns(String) }
-              attr_accessor :file_id
-
-              # The MIME type of the file.
-              sig { returns(String) }
-              attr_accessor :mime_type
-
-              sig do
-                params(file_id: String, mime_type: String).returns(
-                  T.attached_class
-                )
-              end
-              def self.new(
-                # The ID of the file.
-                file_id:,
-                # The MIME type of the file.
-                mime_type:
-              )
-              end
-
-              sig { override.returns({ file_id: String, mime_type: String }) }
-              def to_hash
-              end
-            end
           end
 
           sig do
             override.returns(
               T::Array[
-                OpenAI::Responses::ResponseCodeInterpreterToolCall::Result::Variants
+                OpenAI::Responses::ResponseCodeInterpreterToolCall::Output::Variants
               ]
             )
           end
@@ -270,14 +218,24 @@ module OpenAI
               :in_progress,
               OpenAI::Responses::ResponseCodeInterpreterToolCall::Status::TaggedSymbol
             )
+          COMPLETED =
+            T.let(
+              :completed,
+              OpenAI::Responses::ResponseCodeInterpreterToolCall::Status::TaggedSymbol
+            )
+          INCOMPLETE =
+            T.let(
+              :incomplete,
+              OpenAI::Responses::ResponseCodeInterpreterToolCall::Status::TaggedSymbol
+            )
           INTERPRETING =
             T.let(
               :interpreting,
               OpenAI::Responses::ResponseCodeInterpreterToolCall::Status::TaggedSymbol
             )
-          COMPLETED =
+          FAILED =
             T.let(
-              :completed,
+              :failed,
               OpenAI::Responses::ResponseCodeInterpreterToolCall::Status::TaggedSymbol
             )
 

data/rbi/openai/models/responses/response_create_params.rbi

@@ -15,36 +15,6 @@ module OpenAI
             )
           end
 
-        # Text, image, or file inputs to the model, used to generate a response.
-        #
-        # Learn more:
-        #
-        # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
-        # - [Image inputs](https://platform.openai.com/docs/guides/images)
-        # - [File inputs](https://platform.openai.com/docs/guides/pdf-files)
-        # - [Conversation state](https://platform.openai.com/docs/guides/conversation-state)
-        # - [Function calling](https://platform.openai.com/docs/guides/function-calling)
-        sig do
-          returns(OpenAI::Responses::ResponseCreateParams::Input::Variants)
-        end
-        attr_accessor :input
-
-        # Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
-        # wide range of models with different capabilities, performance characteristics,
-        # and price points. Refer to the
-        # [model guide](https://platform.openai.com/docs/models) to browse and compare
-        # available models.
-        sig do
-          returns(
-            T.any(
-              String,
-              OpenAI::ChatModel::OrSymbol,
-              OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
-            )
-          )
-        end
-        attr_accessor :model
-
         # Whether to run the model response in the background.
         # [Learn more](https://platform.openai.com/docs/guides/background).
         sig { returns(T.nilable(T::Boolean)) }
@@ -72,8 +42,30 @@ module OpenAI
         end
         attr_accessor :include
 
-        # Inserts a system (or developer) message as the first item in the model's
-        # context.
+        # Text, image, or file inputs to the model, used to generate a response.
+        #
+        # Learn more:
+        #
+        # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
+        # - [Image inputs](https://platform.openai.com/docs/guides/images)
+        # - [File inputs](https://platform.openai.com/docs/guides/pdf-files)
+        # - [Conversation state](https://platform.openai.com/docs/guides/conversation-state)
+        # - [Function calling](https://platform.openai.com/docs/guides/function-calling)
+        sig do
+          returns(
+            T.nilable(OpenAI::Responses::ResponseCreateParams::Input::Variants)
+          )
+        end
+        attr_reader :input
+
+        sig do
+          params(
+            input: OpenAI::Responses::ResponseCreateParams::Input::Variants
+          ).void
+        end
+        attr_writer :input
+
+        # 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
@@ -96,6 +88,36 @@ module OpenAI
         sig { returns(T.nilable(T::Hash[Symbol, String])) }
         attr_accessor :metadata
 
+        # Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
+        # wide range of models with different capabilities, performance characteristics,
+        # and price points. Refer to the
+        # [model guide](https://platform.openai.com/docs/models) to browse and compare
+        # available models.
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                String,
+                OpenAI::ChatModel::OrSymbol,
+                OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
+              )
+            )
+          )
+        end
+        attr_reader :model
+
+        sig do
+          params(
+            model:
+              T.any(
+                String,
+                OpenAI::ChatModel::OrSymbol,
+                OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
+              )
+          ).void
+        end
+        attr_writer :model
+
         # Whether to allow the model to run tool calls in parallel.
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :parallel_tool_calls
@@ -106,6 +128,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
@@ -288,23 +322,24 @@ module OpenAI
 
         sig do
           params(
-            input: OpenAI::Responses::ResponseCreateParams::Input::Variants,
-            model:
-              T.any(
-                String,
-                OpenAI::ChatModel::OrSymbol,
-                OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
-              ),
             background: T.nilable(T::Boolean),
             include:
               T.nilable(
                 T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol]
               ),
+            input: OpenAI::Responses::ResponseCreateParams::Input::Variants,
             instructions: T.nilable(String),
             max_output_tokens: T.nilable(Integer),
             metadata: T.nilable(T::Hash[Symbol, String]),
+            model:
+              T.any(
+                String,
+                OpenAI::ChatModel::OrSymbol,
+                OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
+              ),
             parallel_tool_calls: T.nilable(T::Boolean),
             previous_response_id: T.nilable(String),
+            prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash),
             reasoning: T.nilable(OpenAI::Reasoning::OrHash),
             service_tier:
               T.nilable(
@@ -342,22 +377,6 @@ module OpenAI
           ).returns(T.attached_class)
         end
         def self.new(
-          # Text, image, or file inputs to the model, used to generate a response.
-          #
-          # Learn more:
-          #
-          # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
-          # - [Image inputs](https://platform.openai.com/docs/guides/images)
-          # - [File inputs](https://platform.openai.com/docs/guides/pdf-files)
-          # - [Conversation state](https://platform.openai.com/docs/guides/conversation-state)
-          # - [Function calling](https://platform.openai.com/docs/guides/function-calling)
-          input:,
-          # Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
-          # wide range of models with different capabilities, performance characteristics,
-          # and price points. Refer to the
-          # [model guide](https://platform.openai.com/docs/models) to browse and compare
-          # available models.
-          model:,
           # Whether to run the model response in the background.
           # [Learn more](https://platform.openai.com/docs/guides/background).
           background: nil,
@@ -377,8 +396,17 @@ module OpenAI
           # - `code_interpreter_call.outputs`: Includes the outputs of python code execution
           #   in code interpreter tool call items.
           include: nil,
-          # Inserts a system (or developer) message as the first item in the model's
-          # context.
+          # Text, image, or file inputs to the model, used to generate a response.
+          #
+          # Learn more:
+          #
+          # - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
+          # - [Image inputs](https://platform.openai.com/docs/guides/images)
+          # - [File inputs](https://platform.openai.com/docs/guides/pdf-files)
+          # - [Conversation state](https://platform.openai.com/docs/guides/conversation-state)
+          # - [Function calling](https://platform.openai.com/docs/guides/function-calling)
+          input: nil,
+          # 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
@@ -395,12 +423,21 @@ module OpenAI
           # Keys are strings with a maximum length of 64 characters. Values are strings with
           # a maximum length of 512 characters.
           metadata: nil,
+          # Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
+          # wide range of models with different capabilities, performance characteristics,
+          # and price points. Refer to the
+          # [model guide](https://platform.openai.com/docs/models) to browse and compare
+          # available models.
+          model: nil,
           # Whether to allow the model to run tool calls in parallel.
           parallel_tool_calls: nil,
           # The unique ID of the previous response to the model. Use this to create
           # 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
@@ -481,23 +518,24 @@ module OpenAI
         sig do
           override.returns(
             {
-              input: OpenAI::Responses::ResponseCreateParams::Input::Variants,
-              model:
-                T.any(
-                  String,
-                  OpenAI::ChatModel::OrSymbol,
-                  OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
-                ),
               background: T.nilable(T::Boolean),
               include:
                 T.nilable(
                   T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol]
                 ),
+              input: OpenAI::Responses::ResponseCreateParams::Input::Variants,
               instructions: T.nilable(String),
               max_output_tokens: T.nilable(Integer),
               metadata: T.nilable(T::Hash[Symbol, String]),
+              model:
+                T.any(
+                  String,
+                  OpenAI::ChatModel::OrSymbol,
+                  OpenAI::ResponsesModel::ResponsesOnlyModel::OrSymbol
+                ),
               parallel_tool_calls: T.nilable(T::Boolean),
               previous_response_id: T.nilable(String),
+              prompt: T.nilable(OpenAI::Responses::ResponsePrompt),
               reasoning: T.nilable(OpenAI::Reasoning),
               service_tier:
                 T.nilable(
@@ -611,6 +649,11 @@ module OpenAI
               :flex,
               OpenAI::Responses::ResponseCreateParams::ServiceTier::TaggedSymbol
             )
+          SCALE =
+            T.let(
+              :scale,
+              OpenAI::Responses::ResponseCreateParams::ServiceTier::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/openai/models/responses/response_output_text.rbi

@@ -131,6 +131,10 @@ module OpenAI
             sig { returns(String) }
             attr_accessor :file_id
 
+            # The filename of the file cited.
+            sig { returns(String) }
+            attr_accessor :filename
+
             # The index of the file in the list of files.
             sig { returns(Integer) }
             attr_accessor :index
@@ -141,13 +145,18 @@ module OpenAI
 
             # A citation to a file.
             sig do
-              params(file_id: String, index: Integer, type: Symbol).returns(
-                T.attached_class
-              )
+              params(
+                file_id: String,
+                filename: String,
+                index: Integer,
+                type: Symbol
+              ).returns(T.attached_class)
             end
             def self.new(
               # The ID of the file.
               file_id:,
+              # The filename of the file cited.
+              filename:,
               # The index of the file in the list of files.
               index:,
               # The type of the file citation. Always `file_citation`.
@@ -157,7 +166,12 @@ module OpenAI
 
             sig do
               override.returns(
-                { file_id: String, index: Integer, type: Symbol }
+                {
+                  file_id: String,
+                  filename: String,
+                  index: Integer,
+                  type: Symbol
+                }
               )
             end
             def to_hash
@@ -253,6 +267,10 @@ module OpenAI
             sig { returns(String) }
             attr_accessor :file_id
 
+            # The filename of the container file cited.
+            sig { returns(String) }
+            attr_accessor :filename
+
             # The index of the first character of the container file citation in the message.
             sig { returns(Integer) }
             attr_accessor :start_index
@@ -267,6 +285,7 @@ module OpenAI
                 container_id: String,
                 end_index: Integer,
                 file_id: String,
+                filename: String,
                 start_index: Integer,
                 type: Symbol
               ).returns(T.attached_class)
@@ -278,6 +297,8 @@ module OpenAI
               end_index:,
               # The ID of the file.
               file_id:,
+              # The filename of the container file cited.
+              filename:,
               # The index of the first character of the container file citation in the message.
               start_index:,
               # The type of the container file citation. Always `container_file_citation`.
@@ -291,6 +312,7 @@ module OpenAI
                   container_id: String,
                   end_index: Integer,
                   file_id: String,
+                  filename: String,
                   start_index: Integer,
                   type: Symbol
                 }