openai 0.18.1 → 0.19.0

data/rbi/openai/models/conversations/conversation_item_list.rbi

@@ -0,0 +1,101 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    ConversationItemList = Conversations::ConversationItemList
+
+    module Conversations
+      class ConversationItemList < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Conversations::ConversationItemList,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # A list of conversation items.
+        sig do
+          returns(T::Array[OpenAI::Conversations::ConversationItem::Variants])
+        end
+        attr_accessor :data
+
+        # The ID of the first item in the list.
+        sig { returns(String) }
+        attr_accessor :first_id
+
+        # Whether there are more items available.
+        sig { returns(T::Boolean) }
+        attr_accessor :has_more
+
+        # The ID of the last item in the list.
+        sig { returns(String) }
+        attr_accessor :last_id
+
+        # The type of object returned, must be `list`.
+        sig { returns(Symbol) }
+        attr_accessor :object
+
+        # A list of Conversation items.
+        sig do
+          params(
+            data:
+              T::Array[
+                T.any(
+                  OpenAI::Conversations::Message::OrHash,
+                  OpenAI::Responses::ResponseFunctionToolCallItem::OrHash,
+                  OpenAI::Responses::ResponseFunctionToolCallOutputItem::OrHash,
+                  OpenAI::Responses::ResponseFileSearchToolCall::OrHash,
+                  OpenAI::Responses::ResponseFunctionWebSearch::OrHash,
+                  OpenAI::Conversations::ConversationItem::ImageGenerationCall::OrHash,
+                  OpenAI::Responses::ResponseComputerToolCall::OrHash,
+                  OpenAI::Responses::ResponseComputerToolCallOutputItem::OrHash,
+                  OpenAI::Responses::ResponseReasoningItem::OrHash,
+                  OpenAI::Responses::ResponseCodeInterpreterToolCall::OrHash,
+                  OpenAI::Conversations::ConversationItem::LocalShellCall::OrHash,
+                  OpenAI::Conversations::ConversationItem::LocalShellCallOutput::OrHash,
+                  OpenAI::Conversations::ConversationItem::McpListTools::OrHash,
+                  OpenAI::Conversations::ConversationItem::McpApprovalRequest::OrHash,
+                  OpenAI::Conversations::ConversationItem::McpApprovalResponse::OrHash,
+                  OpenAI::Conversations::ConversationItem::McpCall::OrHash,
+                  OpenAI::Responses::ResponseCustomToolCall::OrHash,
+                  OpenAI::Responses::ResponseCustomToolCallOutput::OrHash
+                )
+              ],
+            first_id: String,
+            has_more: T::Boolean,
+            last_id: String,
+            object: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A list of conversation items.
+          data:,
+          # The ID of the first item in the list.
+          first_id:,
+          # Whether there are more items available.
+          has_more:,
+          # The ID of the last item in the list.
+          last_id:,
+          # The type of object returned, must be `list`.
+          object: :list
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              data: T::Array[OpenAI::Conversations::ConversationItem::Variants],
+              first_id: String,
+              has_more: T::Boolean,
+              last_id: String,
+              object: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/conversations/conversation_retrieve_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class ConversationRetrieveParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Conversations::ConversationRetrieveParams,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        sig do
+          params(request_options: OpenAI::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(request_options: {})
+        end
+
+        sig { override.returns({ request_options: OpenAI::RequestOptions }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/conversations/conversation_update_params.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class ConversationUpdateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Conversations::ConversationUpdateParams,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # Set of 16 key-value pairs that can be attached to an object. This can be useful
+        # for storing additional information about the object in a structured format, and
+        # querying for objects via API or the dashboard. Keys are strings with a maximum
+        # length of 64 characters. Values are strings with a maximum length of 512
+        # characters.
+        sig { returns(T::Hash[Symbol, String]) }
+        attr_accessor :metadata
+
+        sig do
+          params(
+            metadata: T::Hash[Symbol, String],
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Set of 16 key-value pairs that can be attached to an object. This can be useful
+          # for storing additional information about the object in a structured format, and
+          # querying for objects via API or the dashboard. Keys are strings with a maximum
+          # length of 64 characters. Values are strings with a maximum length of 512
+          # characters.
+          metadata:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              metadata: T::Hash[Symbol, String],
+              request_options: OpenAI::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/conversations/file_citation_body.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class FileCitationBody < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Conversations::FileCitationBody,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The ID of the file.
+        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
+
+        # The type of the file citation. Always `file_citation`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        sig do
+          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`.
+          type: :file_citation
+        )
+        end
+
+        sig do
+          override.returns(
+            { file_id: String, filename: String, index: Integer, type: Symbol }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/conversations/input_file_content.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class InputFileContent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Conversations::InputFileContent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The ID of the file to be sent to the model.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :file_id
+
+        # The type of the input item. Always `input_file`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The URL of the file to be sent to the model.
+        sig { returns(T.nilable(String)) }
+        attr_reader :file_url
+
+        sig { params(file_url: String).void }
+        attr_writer :file_url
+
+        # The name of the file to be sent to the model.
+        sig { returns(T.nilable(String)) }
+        attr_reader :filename
+
+        sig { params(filename: String).void }
+        attr_writer :filename
+
+        sig do
+          params(
+            file_id: T.nilable(String),
+            file_url: String,
+            filename: String,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the file to be sent to the model.
+          file_id:,
+          # 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(
+            {
+              file_id: T.nilable(String),
+              type: Symbol,
+              file_url: String,
+              filename: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/conversations/input_image_content.rbi

@@ -0,0 +1,113 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class InputImageContent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Conversations::InputImageContent,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The detail level of the image to be sent to the model. One of `high`, `low`, or
+        # `auto`. Defaults to `auto`.
+        sig do
+          returns(
+            OpenAI::Conversations::InputImageContent::Detail::TaggedSymbol
+          )
+        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
+
+        # The type of the input item. Always `input_image`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        sig do
+          params(
+            detail: OpenAI::Conversations::InputImageContent::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:,
+          # The ID of the file to be sent to the model.
+          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.
+          image_url:,
+          # The type of the input item. Always `input_image`.
+          type: :input_image
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              detail:
+                OpenAI::Conversations::InputImageContent::Detail::TaggedSymbol,
+              file_id: T.nilable(String),
+              image_url: T.nilable(String),
+              type: Symbol
+            }
+          )
+        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::Conversations::InputImageContent::Detail)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          LOW =
+            T.let(
+              :low,
+              OpenAI::Conversations::InputImageContent::Detail::TaggedSymbol
+            )
+          HIGH =
+            T.let(
+              :high,
+              OpenAI::Conversations::InputImageContent::Detail::TaggedSymbol
+            )
+          AUTO =
+            T.let(
+              :auto,
+              OpenAI::Conversations::InputImageContent::Detail::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                OpenAI::Conversations::InputImageContent::Detail::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/conversations/input_text_content.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class InputTextContent < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Conversations::InputTextContent,
+              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
+
+        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/conversations/item_create_params.rbi

@@ -0,0 +1,150 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class ItemCreateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Conversations::ItemCreateParams,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The items to add to the conversation. You may add up to 20 items at a time.
+        sig do
+          returns(
+            T::Array[
+              T.any(
+                OpenAI::Responses::EasyInputMessage,
+                OpenAI::Responses::ResponseInputItem::Message,
+                OpenAI::Responses::ResponseOutputMessage,
+                OpenAI::Responses::ResponseFileSearchToolCall,
+                OpenAI::Responses::ResponseComputerToolCall,
+                OpenAI::Responses::ResponseInputItem::ComputerCallOutput,
+                OpenAI::Responses::ResponseFunctionWebSearch,
+                OpenAI::Responses::ResponseFunctionToolCall,
+                OpenAI::Responses::ResponseInputItem::FunctionCallOutput,
+                OpenAI::Responses::ResponseReasoningItem,
+                OpenAI::Responses::ResponseInputItem::ImageGenerationCall,
+                OpenAI::Responses::ResponseCodeInterpreterToolCall,
+                OpenAI::Responses::ResponseInputItem::LocalShellCall,
+                OpenAI::Responses::ResponseInputItem::LocalShellCallOutput,
+                OpenAI::Responses::ResponseInputItem::McpListTools,
+                OpenAI::Responses::ResponseInputItem::McpApprovalRequest,
+                OpenAI::Responses::ResponseInputItem::McpApprovalResponse,
+                OpenAI::Responses::ResponseInputItem::McpCall,
+                OpenAI::Responses::ResponseCustomToolCallOutput,
+                OpenAI::Responses::ResponseCustomToolCall,
+                OpenAI::Responses::ResponseInputItem::ItemReference
+              )
+            ]
+          )
+        end
+        attr_accessor :items
+
+        # Additional fields to include in the response. See the `include` parameter for
+        # [listing Conversation items above](https://platform.openai.com/docs/api-reference/conversations/list-items#conversations_list_items-include)
+        # for more information.
+        sig do
+          returns(
+            T.nilable(T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol])
+          )
+        end
+        attr_reader :include
+
+        sig do
+          params(
+            include: T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol]
+          ).void
+        end
+        attr_writer :include
+
+        sig do
+          params(
+            items:
+              T::Array[
+                T.any(
+                  OpenAI::Responses::EasyInputMessage::OrHash,
+                  OpenAI::Responses::ResponseInputItem::Message::OrHash,
+                  OpenAI::Responses::ResponseOutputMessage::OrHash,
+                  OpenAI::Responses::ResponseFileSearchToolCall::OrHash,
+                  OpenAI::Responses::ResponseComputerToolCall::OrHash,
+                  OpenAI::Responses::ResponseInputItem::ComputerCallOutput::OrHash,
+                  OpenAI::Responses::ResponseFunctionWebSearch::OrHash,
+                  OpenAI::Responses::ResponseFunctionToolCall::OrHash,
+                  OpenAI::Responses::ResponseInputItem::FunctionCallOutput::OrHash,
+                  OpenAI::Responses::ResponseReasoningItem::OrHash,
+                  OpenAI::Responses::ResponseInputItem::ImageGenerationCall::OrHash,
+                  OpenAI::Responses::ResponseCodeInterpreterToolCall::OrHash,
+                  OpenAI::Responses::ResponseInputItem::LocalShellCall::OrHash,
+                  OpenAI::Responses::ResponseInputItem::LocalShellCallOutput::OrHash,
+                  OpenAI::Responses::ResponseInputItem::McpListTools::OrHash,
+                  OpenAI::Responses::ResponseInputItem::McpApprovalRequest::OrHash,
+                  OpenAI::Responses::ResponseInputItem::McpApprovalResponse::OrHash,
+                  OpenAI::Responses::ResponseInputItem::McpCall::OrHash,
+                  OpenAI::Responses::ResponseCustomToolCallOutput::OrHash,
+                  OpenAI::Responses::ResponseCustomToolCall::OrHash,
+                  OpenAI::Responses::ResponseInputItem::ItemReference::OrHash
+                )
+              ],
+            include: T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol],
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The items to add to the conversation. You may add up to 20 items at a time.
+          items:,
+          # Additional fields to include in the response. See the `include` parameter for
+          # [listing Conversation items above](https://platform.openai.com/docs/api-reference/conversations/list-items#conversations_list_items-include)
+          # for more information.
+          include: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              items:
+                T::Array[
+                  T.any(
+                    OpenAI::Responses::EasyInputMessage,
+                    OpenAI::Responses::ResponseInputItem::Message,
+                    OpenAI::Responses::ResponseOutputMessage,
+                    OpenAI::Responses::ResponseFileSearchToolCall,
+                    OpenAI::Responses::ResponseComputerToolCall,
+                    OpenAI::Responses::ResponseInputItem::ComputerCallOutput,
+                    OpenAI::Responses::ResponseFunctionWebSearch,
+                    OpenAI::Responses::ResponseFunctionToolCall,
+                    OpenAI::Responses::ResponseInputItem::FunctionCallOutput,
+                    OpenAI::Responses::ResponseReasoningItem,
+                    OpenAI::Responses::ResponseInputItem::ImageGenerationCall,
+                    OpenAI::Responses::ResponseCodeInterpreterToolCall,
+                    OpenAI::Responses::ResponseInputItem::LocalShellCall,
+                    OpenAI::Responses::ResponseInputItem::LocalShellCallOutput,
+                    OpenAI::Responses::ResponseInputItem::McpListTools,
+                    OpenAI::Responses::ResponseInputItem::McpApprovalRequest,
+                    OpenAI::Responses::ResponseInputItem::McpApprovalResponse,
+                    OpenAI::Responses::ResponseInputItem::McpCall,
+                    OpenAI::Responses::ResponseCustomToolCallOutput,
+                    OpenAI::Responses::ResponseCustomToolCall,
+                    OpenAI::Responses::ResponseInputItem::ItemReference
+                  )
+                ],
+              include:
+                T::Array[OpenAI::Responses::ResponseIncludable::OrSymbol],
+              request_options: OpenAI::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/conversations/item_delete_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class ItemDeleteParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Conversations::ItemDeleteParams,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :conversation_id
+
+        sig do
+          params(
+            conversation_id: String,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(conversation_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { conversation_id: String, request_options: OpenAI::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end