openai 0.27.1 → 0.28.1

data/rbi/openai/models/responses/response_custom_tool_call_output.rbi

@@ -16,8 +16,13 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :call_id
 
-        # The output from the custom tool call generated by your code.
-        sig { returns(String) }
+        # The output from the custom tool call generated by your code. Can be a string or
+        # an list of output content.
+        sig do
+          returns(
+            OpenAI::Responses::ResponseCustomToolCallOutput::Output::Variants
+          )
+        end
         attr_accessor :output
 
         # The type of the custom tool call output. Always `custom_tool_call_output`.
@@ -35,7 +40,8 @@ module OpenAI
         sig do
           params(
             call_id: String,
-            output: String,
+            output:
+              OpenAI::Responses::ResponseCustomToolCallOutput::Output::Variants,
             id: String,
             type: Symbol
           ).returns(T.attached_class)
@@ -43,7 +49,8 @@ module OpenAI
         def self.new(
           # The call ID, used to map this custom tool call output to a custom tool call.
           call_id:,
-          # The output from the custom tool call generated by your code.
+          # The output from the custom tool call generated by your code. Can be a string or
+          # an list of output content.
           output:,
           # The unique ID of the custom tool call output in the OpenAI platform.
           id: nil,
@@ -54,11 +61,76 @@ module OpenAI
 
         sig do
           override.returns(
-            { call_id: String, output: String, type: Symbol, id: String }
+            {
+              call_id: String,
+              output:
+                OpenAI::Responses::ResponseCustomToolCallOutput::Output::Variants,
+              type: Symbol,
+              id: String
+            }
           )
         end
         def to_hash
         end
+
+        # The output from the custom tool call generated by your code. Can be a string or
+        # an list of output content.
+        module Output
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                String,
+                T::Array[
+                  OpenAI::Responses::ResponseCustomToolCallOutput::Output::OutputContentList::Variants
+                ]
+              )
+            end
+
+          # A text input to the model.
+          module OutputContentList
+            extend OpenAI::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::ResponseInputText,
+                  OpenAI::Responses::ResponseInputImage,
+                  OpenAI::Responses::ResponseInputFile
+                )
+              end
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Responses::ResponseCustomToolCallOutput::Output::OutputContentList::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::ResponseCustomToolCallOutput::Output::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+
+          OutputContentListArray =
+            T.let(
+              OpenAI::Internal::Type::ArrayOf[
+                union:
+                  OpenAI::Responses::ResponseCustomToolCallOutput::Output::OutputContentList
+              ],
+              OpenAI::Internal::Type::Converter
+            )
+        end
       end
     end
   end

data/rbi/openai/models/responses/response_function_call_arguments_done_event.rbi

@@ -20,6 +20,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.
         sig { returns(Integer) }
         attr_accessor :output_index
@@ -36,6 +40,7 @@ module OpenAI
           params(
             arguments: String,
             item_id: String,
+            name: String,
             output_index: Integer,
             sequence_number: Integer,
             type: Symbol
@@ -46,6 +51,8 @@ module OpenAI
           arguments:,
           # The ID of the item.
           item_id:,
+          # The name of the function that was called.
+          name:,
           # The index of the output item.
           output_index:,
           # The sequence number of this event.
@@ -59,6 +66,7 @@ module OpenAI
             {
               arguments: String,
               item_id: String,
+              name: String,
               output_index: Integer,
               sequence_number: Integer,
               type: Symbol

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

@@ -0,0 +1,31 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Responses
+      # A text input to the model.
+      module ResponseFunctionCallOutputItem
+        extend OpenAI::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              OpenAI::Responses::ResponseInputTextContent,
+              OpenAI::Responses::ResponseInputImageContent,
+              OpenAI::Responses::ResponseInputFileContent
+            )
+          end
+
+        sig do
+          override.returns(
+            T::Array[
+              OpenAI::Responses::ResponseFunctionCallOutputItem::Variants
+            ]
+          )
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/responses/response_function_call_output_item_list.rbi

@@ -0,0 +1,15 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Responses
+      ResponseFunctionCallOutputItemList =
+        T.let(
+          OpenAI::Internal::Type::ArrayOf[
+            union: OpenAI::Responses::ResponseFunctionCallOutputItem
+          ],
+          OpenAI::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/openai/models/responses/response_function_tool_call_output_item.rbi

@@ -20,8 +20,13 @@ module OpenAI
         sig { returns(String) }
         attr_accessor :call_id
 
-        # A JSON string of the output of the function tool call.
-        sig { returns(String) }
+        # The output from the function call generated by your code. Can be a string or an
+        # list of output content.
+        sig do
+          returns(
+            OpenAI::Responses::ResponseFunctionToolCallOutputItem::Output::Variants
+          )
+        end
         attr_accessor :output
 
         # The type of the function tool call output. Always `function_call_output`.
@@ -51,7 +56,8 @@ module OpenAI
           params(
             id: String,
             call_id: String,
-            output: String,
+            output:
+              OpenAI::Responses::ResponseFunctionToolCallOutputItem::Output::Variants,
             status:
               OpenAI::Responses::ResponseFunctionToolCallOutputItem::Status::OrSymbol,
             type: Symbol
@@ -62,7 +68,8 @@ module OpenAI
           id:,
           # 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.
+          # The output from the function call generated by your code. Can be a string or an
+          # list of output content.
           output:,
           # The status of the item. One of `in_progress`, `completed`, or `incomplete`.
           # Populated when items are returned via API.
@@ -77,7 +84,8 @@ module OpenAI
             {
               id: String,
               call_id: String,
-              output: String,
+              output:
+                OpenAI::Responses::ResponseFunctionToolCallOutputItem::Output::Variants,
               type: Symbol,
               status:
                 OpenAI::Responses::ResponseFunctionToolCallOutputItem::Status::TaggedSymbol
@@ -87,6 +95,65 @@ module OpenAI
         def to_hash
         end
 
+        # The output from the function call generated by your code. Can be a string or an
+        # list of output content.
+        module Output
+          extend OpenAI::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                String,
+                T::Array[
+                  OpenAI::Responses::ResponseFunctionToolCallOutputItem::Output::OutputContentList::Variants
+                ]
+              )
+            end
+
+          # A text input to the model.
+          module OutputContentList
+            extend OpenAI::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  OpenAI::Responses::ResponseInputText,
+                  OpenAI::Responses::ResponseInputImage,
+                  OpenAI::Responses::ResponseInputFile
+                )
+              end
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Responses::ResponseFunctionToolCallOutputItem::Output::OutputContentList::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Responses::ResponseFunctionToolCallOutputItem::Output::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+
+          OutputContentListArray =
+            T.let(
+              OpenAI::Internal::Type::ArrayOf[
+                union:
+                  OpenAI::Responses::ResponseFunctionToolCallOutputItem::Output::OutputContentList
+              ],
+              OpenAI::Internal::Type::Converter
+            )
+        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_file_content.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Responses
+      class ResponseInputFileContent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Responses::ResponseInputFileContent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The type of the input item. Always `input_file`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The base64-encoded data of the file to be sent to the model.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :file_data
+
+        # The ID of the file to be sent to the model.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :file_id
+
+        # The URL of the file to be sent to the model.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :file_url
+
+        # The name of the file to be sent to the model.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :filename
+
+        # A file input to the model.
+        sig do
+          params(
+            file_data: T.nilable(String),
+            file_id: T.nilable(String),
+            file_url: T.nilable(String),
+            filename: T.nilable(String),
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The base64-encoded data of the file to be sent to the model.
+          file_data: nil,
+          # The ID of the file to be sent to the model.
+          file_id: nil,
+          # The URL of the file to be sent to the model.
+          file_url: nil,
+          # The name of the file to be sent to the model.
+          filename: nil,
+          # The type of the input item. Always `input_file`.
+          type: :input_file
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              type: Symbol,
+              file_data: T.nilable(String),
+              file_id: T.nilable(String),
+              file_url: T.nilable(String),
+              filename: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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