openai 0.17.1 → 0.19.0

data/rbi/openai/models/conversations/container_file_citation_body.rbi

@@ -0,0 +1,82 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class ContainerFileCitationBody < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Conversations::ContainerFileCitationBody,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The ID of the container file.
+        sig { returns(String) }
+        attr_accessor :container_id
+
+        # The index of the last character of the container file citation in the message.
+        sig { returns(Integer) }
+        attr_accessor :end_index
+
+        # The ID of the file.
+        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
+
+        # The type of the container file citation. Always `container_file_citation`.
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        sig do
+          params(
+            container_id: String,
+            end_index: Integer,
+            file_id: String,
+            filename: String,
+            start_index: Integer,
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The ID of the container file.
+          container_id:,
+          # The index of the last character of the container file citation in the message.
+          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`.
+          type: :container_file_citation
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              container_id: String,
+              end_index: Integer,
+              file_id: String,
+              filename: String,
+              start_index: Integer,
+              type: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/conversations/conversation.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class Conversation < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Conversations::Conversation,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # The unique ID of the conversation.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The time at which the conversation was created, measured in seconds since the
+        # Unix epoch.
+        sig { returns(Integer) }
+        attr_accessor :created_at
+
+        # 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.anything) }
+        attr_accessor :metadata
+
+        # The object type, which is always `conversation`.
+        sig { returns(Symbol) }
+        attr_accessor :object
+
+        sig do
+          params(
+            id: String,
+            created_at: Integer,
+            metadata: T.anything,
+            object: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The unique ID of the conversation.
+          id:,
+          # The time at which the conversation was created, measured in seconds since the
+          # Unix epoch.
+          created_at:,
+          # 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:,
+          # The object type, which is always `conversation`.
+          object: :conversation
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Integer,
+              metadata: T.anything,
+              object: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/conversations/conversation_create_params.rbi

@@ -0,0 +1,144 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class ConversationCreateParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Conversations::ConversationCreateParams,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        # Initial items to include in the conversation context. You may add up to 20 items
+        # at a time.
+        sig do
+          returns(
+            T.nilable(
+              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
+
+        # Set of 16 key-value pairs that can be attached to an object. Useful for storing
+        # additional information about the object in a structured format.
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_accessor :metadata
+
+        sig do
+          params(
+            items:
+              T.nilable(
+                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
+                  )
+                ]
+              ),
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            request_options: OpenAI::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Initial items to include in the conversation context. You may add up to 20 items
+          # at a time.
+          items: nil,
+          # Set of 16 key-value pairs that can be attached to an object. Useful for storing
+          # additional information about the object in a structured format.
+          metadata: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              items:
+                T.nilable(
+                  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
+                    )
+                  ]
+                ),
+              metadata: T.nilable(T::Hash[Symbol, String]),
+              request_options: OpenAI::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/conversations/conversation_delete_params.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class ConversationDeleteParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Conversations::ConversationDeleteParams,
+              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_deleted.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class ConversationDeleted < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Conversations::ConversationDeleted,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(T::Boolean) }
+        attr_accessor :deleted
+
+        sig { returns(Symbol) }
+        attr_accessor :object
+
+        sig do
+          params(id: String, deleted: T::Boolean, object: Symbol).returns(
+            T.attached_class
+          )
+        end
+        def self.new(id:, deleted:, object: :"conversation.deleted")
+        end
+
+        sig do
+          override.returns({ id: String, deleted: T::Boolean, object: Symbol })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/conversations/conversation_deleted_resource.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Conversations
+      class ConversationDeletedResource < OpenAI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              OpenAI::Conversations::ConversationDeletedResource,
+              OpenAI::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(T::Boolean) }
+        attr_accessor :deleted
+
+        sig { returns(Symbol) }
+        attr_accessor :object
+
+        sig do
+          params(id: String, deleted: T::Boolean, object: Symbol).returns(
+            T.attached_class
+          )
+        end
+        def self.new(id:, deleted:, object: :"conversation.deleted")
+        end
+
+        sig do
+          override.returns({ id: String, deleted: T::Boolean, object: Symbol })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end