openai 0.27.1 → 0.28.1

data/rbi/openai/models/responses/response_input_item.rbi

@@ -508,8 +508,12 @@ module OpenAI
           sig { returns(String) }
           attr_accessor :call_id
 
-          # A JSON string of the output of the function tool call.
-          sig { returns(String) }
+          # Text, image, or file output of the function tool call.
+          sig do
+            returns(
+              OpenAI::Responses::ResponseInputItem::FunctionCallOutput::Output::Variants
+            )
+          end
           attr_accessor :output
 
           # The type of the function tool call output. Always `function_call_output`.
@@ -536,7 +540,8 @@ module OpenAI
           sig do
             params(
               call_id: String,
-              output: String,
+              output:
+                OpenAI::Responses::ResponseInputItem::FunctionCallOutput::Output::Variants,
               id: T.nilable(String),
               status:
                 T.nilable(
@@ -548,7 +553,7 @@ module OpenAI
           def self.new(
             # The unique ID of the function tool call generated by the model.
             call_id:,
-            # A JSON string of the output of the function tool call.
+            # Text, image, or file output of the function tool call.
             output:,
             # The unique ID of the function tool call output. Populated when this item is
             # returned via API.
@@ -565,7 +570,8 @@ module OpenAI
             override.returns(
               {
                 call_id: String,
-                output: String,
+                output:
+                  OpenAI::Responses::ResponseInputItem::FunctionCallOutput::Output::Variants,
                 type: Symbol,
                 id: T.nilable(String),
                 status:
@@ -578,6 +584,31 @@ module OpenAI
           def to_hash
           end
 
+          # Text, image, or file output of the function tool call.
+          module Output
+            extend OpenAI::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  String,
+                  T::Array[
+                    OpenAI::Responses::ResponseFunctionCallOutputItem::Variants
+                  ]
+                )
+              end
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Responses::ResponseInputItem::FunctionCallOutput::Output::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
+
           # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
           # Populated when items are returned via API.
           module Status
@@ -1350,6 +1381,12 @@ module OpenAI
           sig { returns(Symbol) }
           attr_accessor :type
 
+          # Unique identifier for the MCP tool call approval request. Include this value in
+          # a subsequent `mcp_approval_response` input to approve or reject the
+          # corresponding tool call.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :approval_request_id
+
           # The error from the tool call, if any.
           sig { returns(T.nilable(String)) }
           attr_accessor :error
@@ -1358,6 +1395,25 @@ module OpenAI
           sig { returns(T.nilable(String)) }
           attr_accessor :output
 
+          # The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
+          # `calling`, or `failed`.
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Responses::ResponseInputItem::McpCall::Status::OrSymbol
+              )
+            )
+          end
+          attr_reader :status
+
+          sig do
+            params(
+              status:
+                OpenAI::Responses::ResponseInputItem::McpCall::Status::OrSymbol
+            ).void
+          end
+          attr_writer :status
+
           # An invocation of a tool on an MCP server.
           sig do
             params(
@@ -1365,8 +1421,11 @@ module OpenAI
               arguments: String,
               name: String,
               server_label: String,
+              approval_request_id: T.nilable(String),
               error: T.nilable(String),
               output: T.nilable(String),
+              status:
+                OpenAI::Responses::ResponseInputItem::McpCall::Status::OrSymbol,
               type: Symbol
             ).returns(T.attached_class)
           end
@@ -1379,10 +1438,17 @@ module OpenAI
             name:,
             # The label of the MCP server running the tool.
             server_label:,
+            # Unique identifier for the MCP tool call approval request. Include this value in
+            # a subsequent `mcp_approval_response` input to approve or reject the
+            # corresponding tool call.
+            approval_request_id: nil,
             # The error from the tool call, if any.
             error: nil,
             # The output from the tool call.
             output: nil,
+            # The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
+            # `calling`, or `failed`.
+            status: nil,
             # The type of the item. Always `mcp_call`.
             type: :mcp_call
           )
@@ -1396,13 +1462,67 @@ module OpenAI
                 name: String,
                 server_label: String,
                 type: Symbol,
+                approval_request_id: T.nilable(String),
                 error: T.nilable(String),
-                output: T.nilable(String)
+                output: T.nilable(String),
+                status:
+                  OpenAI::Responses::ResponseInputItem::McpCall::Status::OrSymbol
               }
             )
           end
           def to_hash
           end
+
+          # The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
+          # `calling`, or `failed`.
+          module Status
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  OpenAI::Responses::ResponseInputItem::McpCall::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            IN_PROGRESS =
+              T.let(
+                :in_progress,
+                OpenAI::Responses::ResponseInputItem::McpCall::Status::TaggedSymbol
+              )
+            COMPLETED =
+              T.let(
+                :completed,
+                OpenAI::Responses::ResponseInputItem::McpCall::Status::TaggedSymbol
+              )
+            INCOMPLETE =
+              T.let(
+                :incomplete,
+                OpenAI::Responses::ResponseInputItem::McpCall::Status::TaggedSymbol
+              )
+            CALLING =
+              T.let(
+                :calling,
+                OpenAI::Responses::ResponseInputItem::McpCall::Status::TaggedSymbol
+              )
+            FAILED =
+              T.let(
+                :failed,
+                OpenAI::Responses::ResponseInputItem::McpCall::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Responses::ResponseInputItem::McpCall::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
 
         class ItemReference < OpenAI::Internal::Type::BaseModel

data/rbi/openai/models/responses/response_input_text_content.rbi

@@ -0,0 +1,39 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseInputTextContent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Responses::ResponseInputTextContent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The text input to the model.
+        sig { returns(String) }
+        attr_accessor :text
+
+        # The type of the input item. Always `input_text`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # A text input to the model.
+        sig { params(text: String, type: Symbol).returns(T.attached_class) }
+        def self.new(
+          # The text input to the model.
+          text:,
+          # The type of the input item. Always `input_text`.
+          type: :input_text
+        )
+        end
+
+        sig { override.returns({ text: String, type: Symbol }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/responses/response_item.rbi

@@ -754,6 +754,12 @@ module OpenAI
           sig { returns(Symbol) }
           attr_accessor :type
 
+          # Unique identifier for the MCP tool call approval request. Include this value in
+          # a subsequent `mcp_approval_response` input to approve or reject the
+          # corresponding tool call.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :approval_request_id
+
           # The error from the tool call, if any.
           sig { returns(T.nilable(String)) }
           attr_accessor :error
@@ -762,6 +768,24 @@ module OpenAI
           sig { returns(T.nilable(String)) }
           attr_accessor :output
 
+          # The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
+          # `calling`, or `failed`.
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Responses::ResponseItem::McpCall::Status::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :status
+
+          sig do
+            params(
+              status: OpenAI::Responses::ResponseItem::McpCall::Status::OrSymbol
+            ).void
+          end
+          attr_writer :status
+
           # An invocation of a tool on an MCP server.
           sig do
             params(
@@ -769,8 +793,11 @@ module OpenAI
               arguments: String,
               name: String,
               server_label: String,
+              approval_request_id: T.nilable(String),
               error: T.nilable(String),
               output: T.nilable(String),
+              status:
+                OpenAI::Responses::ResponseItem::McpCall::Status::OrSymbol,
               type: Symbol
             ).returns(T.attached_class)
           end
@@ -783,10 +810,17 @@ module OpenAI
             name:,
             # The label of the MCP server running the tool.
             server_label:,
+            # Unique identifier for the MCP tool call approval request. Include this value in
+            # a subsequent `mcp_approval_response` input to approve or reject the
+            # corresponding tool call.
+            approval_request_id: nil,
             # The error from the tool call, if any.
             error: nil,
             # The output from the tool call.
             output: nil,
+            # The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
+            # `calling`, or `failed`.
+            status: nil,
             # The type of the item. Always `mcp_call`.
             type: :mcp_call
           )
@@ -800,13 +834,64 @@ module OpenAI
                 name: String,
                 server_label: String,
                 type: Symbol,
+                approval_request_id: T.nilable(String),
                 error: T.nilable(String),
-                output: T.nilable(String)
+                output: T.nilable(String),
+                status:
+                  OpenAI::Responses::ResponseItem::McpCall::Status::TaggedSymbol
               }
             )
           end
           def to_hash
           end
+
+          # The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
+          # `calling`, or `failed`.
+          module Status
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, OpenAI::Responses::ResponseItem::McpCall::Status)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            IN_PROGRESS =
+              T.let(
+                :in_progress,
+                OpenAI::Responses::ResponseItem::McpCall::Status::TaggedSymbol
+              )
+            COMPLETED =
+              T.let(
+                :completed,
+                OpenAI::Responses::ResponseItem::McpCall::Status::TaggedSymbol
+              )
+            INCOMPLETE =
+              T.let(
+                :incomplete,
+                OpenAI::Responses::ResponseItem::McpCall::Status::TaggedSymbol
+              )
+            CALLING =
+              T.let(
+                :calling,
+                OpenAI::Responses::ResponseItem::McpCall::Status::TaggedSymbol
+              )
+            FAILED =
+              T.let(
+                :failed,
+                OpenAI::Responses::ResponseItem::McpCall::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Responses::ResponseItem::McpCall::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
 
         sig do

data/rbi/openai/models/responses/response_output_item.rbi

@@ -370,6 +370,12 @@ module OpenAI
           sig { returns(Symbol) }
           attr_accessor :type
 
+          # Unique identifier for the MCP tool call approval request. Include this value in
+          # a subsequent `mcp_approval_response` input to approve or reject the
+          # corresponding tool call.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :approval_request_id
+
           # The error from the tool call, if any.
           sig { returns(T.nilable(String)) }
           attr_accessor :error
@@ -378,6 +384,25 @@ module OpenAI
           sig { returns(T.nilable(String)) }
           attr_accessor :output
 
+          # The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
+          # `calling`, or `failed`.
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Responses::ResponseOutputItem::McpCall::Status::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :status
+
+          sig do
+            params(
+              status:
+                OpenAI::Responses::ResponseOutputItem::McpCall::Status::OrSymbol
+            ).void
+          end
+          attr_writer :status
+
           # An invocation of a tool on an MCP server.
           sig do
             params(
@@ -385,8 +410,11 @@ module OpenAI
               arguments: String,
               name: String,
               server_label: String,
+              approval_request_id: T.nilable(String),
               error: T.nilable(String),
               output: T.nilable(String),
+              status:
+                OpenAI::Responses::ResponseOutputItem::McpCall::Status::OrSymbol,
               type: Symbol
             ).returns(T.attached_class)
           end
@@ -399,10 +427,17 @@ module OpenAI
             name:,
             # The label of the MCP server running the tool.
             server_label:,
+            # Unique identifier for the MCP tool call approval request. Include this value in
+            # a subsequent `mcp_approval_response` input to approve or reject the
+            # corresponding tool call.
+            approval_request_id: nil,
             # The error from the tool call, if any.
             error: nil,
             # The output from the tool call.
             output: nil,
+            # The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
+            # `calling`, or `failed`.
+            status: nil,
             # The type of the item. Always `mcp_call`.
             type: :mcp_call
           )
@@ -416,13 +451,67 @@ module OpenAI
                 name: String,
                 server_label: String,
                 type: Symbol,
+                approval_request_id: T.nilable(String),
                 error: T.nilable(String),
-                output: T.nilable(String)
+                output: T.nilable(String),
+                status:
+                  OpenAI::Responses::ResponseOutputItem::McpCall::Status::TaggedSymbol
               }
             )
           end
           def to_hash
           end
+
+          # The status of the tool call. One of `in_progress`, `completed`, `incomplete`,
+          # `calling`, or `failed`.
+          module Status
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  OpenAI::Responses::ResponseOutputItem::McpCall::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            IN_PROGRESS =
+              T.let(
+                :in_progress,
+                OpenAI::Responses::ResponseOutputItem::McpCall::Status::TaggedSymbol
+              )
+            COMPLETED =
+              T.let(
+                :completed,
+                OpenAI::Responses::ResponseOutputItem::McpCall::Status::TaggedSymbol
+              )
+            INCOMPLETE =
+              T.let(
+                :incomplete,
+                OpenAI::Responses::ResponseOutputItem::McpCall::Status::TaggedSymbol
+              )
+            CALLING =
+              T.let(
+                :calling,
+                OpenAI::Responses::ResponseOutputItem::McpCall::Status::TaggedSymbol
+              )
+            FAILED =
+              T.let(
+                :failed,
+                OpenAI::Responses::ResponseOutputItem::McpCall::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Responses::ResponseOutputItem::McpCall::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
         end
 
         class McpListTools < OpenAI::Internal::Type::BaseModel

data/rbi/openai/models.rbi

@@ -25,6 +25,8 @@ module OpenAI
 
   BatchRetrieveParams = OpenAI::Models::BatchRetrieveParams
 
+  BatchUsage = OpenAI::Models::BatchUsage
+
   Beta = OpenAI::Models::Beta
 
   Chat = OpenAI::Models::Chat

data/sig/openai/internal/type/base_stream.rbs

@@ -4,10 +4,6 @@ module OpenAI
       module BaseStream[Message, Elem]
         include Enumerable[Elem]
 
-        def self.defer_closing: (
-          Enumerable[top] stream
-        ) -> (^(Integer arg0) -> void)
-
         attr_reader status: Integer
 
         attr_reader headers: ::Hash[String, String]

data/sig/openai/models/batch.rbs

@@ -20,8 +20,10 @@ module OpenAI
         finalizing_at: Integer,
         in_progress_at: Integer,
         metadata: OpenAI::Models::metadata?,
+        model: String,
         output_file_id: String,
-        request_counts: OpenAI::BatchRequestCounts
+        request_counts: OpenAI::BatchRequestCounts,
+        usage: OpenAI::BatchUsage
       }
 
     class Batch < OpenAI::Internal::Type::BaseModel
@@ -81,6 +83,10 @@ module OpenAI
 
       attr_accessor metadata: OpenAI::Models::metadata?
 
+      attr_reader model: String?
+
+      def model=: (String) -> String
+
       attr_reader output_file_id: String?
 
       def output_file_id=: (String) -> String
@@ -91,6 +97,10 @@ module OpenAI
         OpenAI::BatchRequestCounts
       ) -> OpenAI::BatchRequestCounts
 
+      attr_reader usage: OpenAI::BatchUsage?
+
+      def usage=: (OpenAI::BatchUsage) -> OpenAI::BatchUsage
+
       def initialize: (
         id: String,
         completion_window: String,
@@ -109,8 +119,10 @@ module OpenAI
         ?finalizing_at: Integer,
         ?in_progress_at: Integer,
         ?metadata: OpenAI::Models::metadata?,
+        ?model: String,
         ?output_file_id: String,
         ?request_counts: OpenAI::BatchRequestCounts,
+        ?usage: OpenAI::BatchUsage,
         ?object: :batch
       ) -> void
 
@@ -133,8 +145,10 @@ module OpenAI
         finalizing_at: Integer,
         in_progress_at: Integer,
         metadata: OpenAI::Models::metadata?,
+        model: String,
         output_file_id: String,
-        request_counts: OpenAI::BatchRequestCounts
+        request_counts: OpenAI::BatchRequestCounts,
+        usage: OpenAI::BatchUsage
       }
 
       type status =

data/sig/openai/models/batch_usage.rbs

@@ -0,0 +1,60 @@
+module OpenAI
+  module Models
+    type batch_usage =
+      {
+        input_tokens: Integer,
+        input_tokens_details: OpenAI::BatchUsage::InputTokensDetails,
+        output_tokens: Integer,
+        output_tokens_details: OpenAI::BatchUsage::OutputTokensDetails,
+        total_tokens: Integer
+      }
+
+    class BatchUsage < OpenAI::Internal::Type::BaseModel
+      attr_accessor input_tokens: Integer
+
+      attr_accessor input_tokens_details: OpenAI::BatchUsage::InputTokensDetails
+
+      attr_accessor output_tokens: Integer
+
+      attr_accessor output_tokens_details: OpenAI::BatchUsage::OutputTokensDetails
+
+      attr_accessor total_tokens: Integer
+
+      def initialize: (
+        input_tokens: Integer,
+        input_tokens_details: OpenAI::BatchUsage::InputTokensDetails,
+        output_tokens: Integer,
+        output_tokens_details: OpenAI::BatchUsage::OutputTokensDetails,
+        total_tokens: Integer
+      ) -> void
+
+      def to_hash: -> {
+        input_tokens: Integer,
+        input_tokens_details: OpenAI::BatchUsage::InputTokensDetails,
+        output_tokens: Integer,
+        output_tokens_details: OpenAI::BatchUsage::OutputTokensDetails,
+        total_tokens: Integer
+      }
+
+      type input_tokens_details = { cached_tokens: Integer }
+
+      class InputTokensDetails < OpenAI::Internal::Type::BaseModel
+        attr_accessor cached_tokens: Integer
+
+        def initialize: (cached_tokens: Integer) -> void
+
+        def to_hash: -> { cached_tokens: Integer }
+      end
+
+      type output_tokens_details = { reasoning_tokens: Integer }
+
+      class OutputTokensDetails < OpenAI::Internal::Type::BaseModel
+        attr_accessor reasoning_tokens: Integer
+
+        def initialize: (reasoning_tokens: Integer) -> void
+
+        def to_hash: -> { reasoning_tokens: Integer }
+      end
+    end
+  end
+end