openai 0.27.1 → 0.28.0

data/rbi/openai/models/responses/response_input_image_content.rbi

@@ -0,0 +1,125 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseInputImageContent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Responses::ResponseInputImageContent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The type of the input item. Always `input_image`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The detail level of the image to be sent to the model. One of `high`, `low`, or
+        # `auto`. Defaults to `auto`.
+        sig do
+          returns(
+            T.nilable(
+              OpenAI::Responses::ResponseInputImageContent::Detail::OrSymbol
+            )
+          )
+        end
+        attr_accessor :detail
+
+        # The ID of the file to be sent to the model.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :file_id
+
+        # The URL of the image to be sent to the model. A fully qualified URL or base64
+        # encoded image in a data URL.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :image_url
+
+        # An image input to the model. Learn about
+        # [image inputs](https://platform.openai.com/docs/guides/vision)
+        sig do
+          params(
+            detail:
+              T.nilable(
+                OpenAI::Responses::ResponseInputImageContent::Detail::OrSymbol
+              ),
+            file_id: T.nilable(String),
+            image_url: T.nilable(String),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The detail level of the image to be sent to the model. One of `high`, `low`, or
+          # `auto`. Defaults to `auto`.
+          detail: nil,
+          # The ID of the file to be sent to the model.
+          file_id: nil,
+          # The URL of the image to be sent to the model. A fully qualified URL or base64
+          # encoded image in a data URL.
+          image_url: nil,
+          # The type of the input item. Always `input_image`.
+          type: :input_image
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              type: Symbol,
+              detail:
+                T.nilable(
+                  OpenAI::Responses::ResponseInputImageContent::Detail::OrSymbol
+                ),
+              file_id: T.nilable(String),
+              image_url: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The detail level of the image to be sent to the model. One of `high`, `low`, or
+        # `auto`. Defaults to `auto`.
+        module Detail
+          extend OpenAI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                OpenAI::Responses::ResponseInputImageContent::Detail
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LOW =
+            T.let(
+              :low,
+              OpenAI::Responses::ResponseInputImageContent::Detail::TaggedSymbol
+            )
+          HIGH =
+            T.let(
+              :high,
+              OpenAI::Responses::ResponseInputImageContent::Detail::TaggedSymbol
+            )
+          AUTO =
+            T.let(
+              :auto,
+              OpenAI::Responses::ResponseInputImageContent::Detail::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::ResponseInputImageContent::Detail::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

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

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.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

data/sig/openai/models/responses/response_custom_tool_call_output.rbs

@@ -4,7 +4,7 @@ module OpenAI
       type response_custom_tool_call_output =
         {
           call_id: String,
-          output: String,
+          output: OpenAI::Models::Responses::ResponseCustomToolCallOutput::output,
           type: :custom_tool_call_output,
           id: String
         }
@@ -12,7 +12,7 @@ module OpenAI
       class ResponseCustomToolCallOutput < OpenAI::Internal::Type::BaseModel
         attr_accessor call_id: String
 
-        attr_accessor output: String
+        attr_accessor output: OpenAI::Models::Responses::ResponseCustomToolCallOutput::output
 
         attr_accessor type: :custom_tool_call_output
 
@@ -22,17 +22,40 @@ module OpenAI
 
         def initialize: (
           call_id: String,
-          output: String,
+          output: OpenAI::Models::Responses::ResponseCustomToolCallOutput::output,
           ?id: String,
           ?type: :custom_tool_call_output
         ) -> void
 
         def to_hash: -> {
           call_id: String,
-          output: String,
+          output: OpenAI::Models::Responses::ResponseCustomToolCallOutput::output,
           type: :custom_tool_call_output,
           id: String
         }
+
+        type output =
+          String
+          | ::Array[OpenAI::Models::Responses::ResponseCustomToolCallOutput::Output::output_content_list]
+
+        module Output
+          extend OpenAI::Internal::Type::Union
+
+          type output_content_list =
+            OpenAI::Responses::ResponseInputText
+            | OpenAI::Responses::ResponseInputImage
+            | OpenAI::Responses::ResponseInputFile
+
+          module OutputContentList
+            extend OpenAI::Internal::Type::Union
+
+            def self?.variants: -> ::Array[OpenAI::Models::Responses::ResponseCustomToolCallOutput::Output::output_content_list]
+          end
+
+          def self?.variants: -> ::Array[OpenAI::Models::Responses::ResponseCustomToolCallOutput::output]
+
+          OutputContentListArray: OpenAI::Internal::Type::Converter
+        end
       end
     end
   end

data/sig/openai/models/responses/response_function_call_arguments_done_event.rbs

@@ -5,6 +5,7 @@ module OpenAI
         {
           arguments: String,
           item_id: String,
+          name: String,
           output_index: Integer,
           sequence_number: Integer,
           type: :"response.function_call_arguments.done"
@@ -15,6 +16,8 @@ module OpenAI
 
         attr_accessor item_id: String
 
+        attr_accessor name: String
+
         attr_accessor output_index: Integer
 
         attr_accessor sequence_number: Integer
@@ -24,6 +27,7 @@ module OpenAI
         def initialize: (
           arguments: String,
           item_id: String,
+          name: String,
           output_index: Integer,
           sequence_number: Integer,
           ?type: :"response.function_call_arguments.done"
@@ -32,6 +36,7 @@ module OpenAI
         def to_hash: -> {
           arguments: String,
           item_id: String,
+          name: String,
           output_index: Integer,
           sequence_number: Integer,
           type: :"response.function_call_arguments.done"

data/sig/openai/models/responses/response_function_call_output_item.rbs

@@ -0,0 +1,16 @@
+module OpenAI
+  module Models
+    module Responses
+      type response_function_call_output_item =
+        OpenAI::Responses::ResponseInputTextContent
+        | OpenAI::Responses::ResponseInputImageContent
+        | OpenAI::Responses::ResponseInputFileContent
+
+      module ResponseFunctionCallOutputItem
+        extend OpenAI::Internal::Type::Union
+
+        def self?.variants: -> ::Array[OpenAI::Models::Responses::response_function_call_output_item]
+      end
+    end
+  end
+end

data/sig/openai/models/responses/response_function_call_output_item_list.rbs

@@ -0,0 +1,10 @@
+module OpenAI
+  module Models
+    module Responses
+      type response_function_call_output_item_list =
+        ::Array[OpenAI::Models::Responses::response_function_call_output_item]
+
+      ResponseFunctionCallOutputItemList: OpenAI::Internal::Type::Converter
+    end
+  end
+end

data/sig/openai/models/responses/response_function_tool_call_output_item.rbs

@@ -5,7 +5,7 @@ module OpenAI
         {
           id: String,
           call_id: String,
-          output: String,
+          output: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::output,
           type: :function_call_output,
           status: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::status
         }
@@ -15,7 +15,7 @@ module OpenAI
 
         attr_accessor call_id: String
 
-        attr_accessor output: String
+        attr_accessor output: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::output
 
         attr_accessor type: :function_call_output
 
@@ -28,7 +28,7 @@ module OpenAI
         def initialize: (
           id: String,
           call_id: String,
-          output: String,
+          output: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::output,
           ?status: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::status,
           ?type: :function_call_output
         ) -> void
@@ -36,11 +36,34 @@ module OpenAI
         def to_hash: -> {
           id: String,
           call_id: String,
-          output: String,
+          output: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::output,
           type: :function_call_output,
           status: OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::status
         }
 
+        type output =
+          String
+          | ::Array[OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::Output::output_content_list]
+
+        module Output
+          extend OpenAI::Internal::Type::Union
+
+          type output_content_list =
+            OpenAI::Responses::ResponseInputText
+            | OpenAI::Responses::ResponseInputImage
+            | OpenAI::Responses::ResponseInputFile
+
+          module OutputContentList
+            extend OpenAI::Internal::Type::Union
+
+            def self?.variants: -> ::Array[OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::Output::output_content_list]
+          end
+
+          def self?.variants: -> ::Array[OpenAI::Models::Responses::ResponseFunctionToolCallOutputItem::output]
+
+          OutputContentListArray: OpenAI::Internal::Type::Converter
+        end
+
         type status = :in_progress | :completed | :incomplete
 
         module Status

data/sig/openai/models/responses/response_input_file_content.rbs

@@ -0,0 +1,42 @@
+module OpenAI
+  module Models
+    module Responses
+      type response_input_file_content =
+        {
+          type: :input_file,
+          file_data: String?,
+          file_id: String?,
+          file_url: String?,
+          filename: String?
+        }
+
+      class ResponseInputFileContent < OpenAI::Internal::Type::BaseModel
+        attr_accessor type: :input_file
+
+        attr_accessor file_data: String?
+
+        attr_accessor file_id: String?
+
+        attr_accessor file_url: String?
+
+        attr_accessor filename: String?
+
+        def initialize: (
+          ?file_data: String?,
+          ?file_id: String?,
+          ?file_url: String?,
+          ?filename: String?,
+          ?type: :input_file
+        ) -> void
+
+        def to_hash: -> {
+          type: :input_file,
+          file_data: String?,
+          file_id: String?,
+          file_url: String?,
+          filename: String?
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/responses/response_input_image_content.rbs

@@ -0,0 +1,49 @@
+module OpenAI
+  module Models
+    module Responses
+      type response_input_image_content =
+        {
+          type: :input_image,
+          detail: OpenAI::Models::Responses::ResponseInputImageContent::detail?,
+          file_id: String?,
+          image_url: String?
+        }
+
+      class ResponseInputImageContent < OpenAI::Internal::Type::BaseModel
+        attr_accessor type: :input_image
+
+        attr_accessor detail: OpenAI::Models::Responses::ResponseInputImageContent::detail?
+
+        attr_accessor file_id: String?
+
+        attr_accessor image_url: String?
+
+        def initialize: (
+          ?detail: OpenAI::Models::Responses::ResponseInputImageContent::detail?,
+          ?file_id: String?,
+          ?image_url: String?,
+          ?type: :input_image
+        ) -> void
+
+        def to_hash: -> {
+          type: :input_image,
+          detail: OpenAI::Models::Responses::ResponseInputImageContent::detail?,
+          file_id: String?,
+          image_url: String?
+        }
+
+        type detail = :low | :high | :auto
+
+        module Detail
+          extend OpenAI::Internal::Type::Enum
+
+          LOW: :low
+          HIGH: :high
+          AUTO: :auto
+
+          def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseInputImageContent::detail]
+        end
+      end
+    end
+  end
+end