openai 0.1.0.pre.beta.2 → 0.1.0

data/rbi/openai/models/vector_stores/file_list_params.rbi

@@ -1,202 +0,0 @@
-# typed: strong
-
-module OpenAI
-  module Models
-    module VectorStores
-      class FileListParams < OpenAI::Internal::Type::BaseModel
-        extend OpenAI::Internal::Type::RequestParameters::Converter
-        include OpenAI::Internal::Type::RequestParameters
-
-        OrHash =
-          T.type_alias do
-            T.any(
-              OpenAI::VectorStores::FileListParams,
-              OpenAI::Internal::AnyHash
-            )
-          end
-
-        # A cursor for use in pagination. `after` is an object ID that defines your place
-        # in the list. For instance, if you make a list request and receive 100 objects,
-        # ending with obj_foo, your subsequent call can include after=obj_foo in order to
-        # fetch the next page of the list.
-        sig { returns(T.nilable(String)) }
-        attr_reader :after
-
-        sig { params(after: String).void }
-        attr_writer :after
-
-        # A cursor for use in pagination. `before` is an object ID that defines your place
-        # in the list. For instance, if you make a list request and receive 100 objects,
-        # starting with obj_foo, your subsequent call can include before=obj_foo in order
-        # to fetch the previous page of the list.
-        sig { returns(T.nilable(String)) }
-        attr_reader :before
-
-        sig { params(before: String).void }
-        attr_writer :before
-
-        # Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.
-        sig do
-          returns(
-            T.nilable(OpenAI::VectorStores::FileListParams::Filter::OrSymbol)
-          )
-        end
-        attr_reader :filter
-
-        sig do
-          params(
-            filter: OpenAI::VectorStores::FileListParams::Filter::OrSymbol
-          ).void
-        end
-        attr_writer :filter
-
-        # A limit on the number of objects to be returned. Limit can range between 1 and
-        # 100, and the default is 20.
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :limit
-
-        sig { params(limit: Integer).void }
-        attr_writer :limit
-
-        # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
-        # order and `desc` for descending order.
-        sig do
-          returns(
-            T.nilable(OpenAI::VectorStores::FileListParams::Order::OrSymbol)
-          )
-        end
-        attr_reader :order
-
-        sig do
-          params(
-            order: OpenAI::VectorStores::FileListParams::Order::OrSymbol
-          ).void
-        end
-        attr_writer :order
-
-        sig do
-          params(
-            after: String,
-            before: String,
-            filter: OpenAI::VectorStores::FileListParams::Filter::OrSymbol,
-            limit: Integer,
-            order: OpenAI::VectorStores::FileListParams::Order::OrSymbol,
-            request_options: OpenAI::RequestOptions::OrHash
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # A cursor for use in pagination. `after` is an object ID that defines your place
-          # in the list. For instance, if you make a list request and receive 100 objects,
-          # ending with obj_foo, your subsequent call can include after=obj_foo in order to
-          # fetch the next page of the list.
-          after: nil,
-          # A cursor for use in pagination. `before` is an object ID that defines your place
-          # in the list. For instance, if you make a list request and receive 100 objects,
-          # starting with obj_foo, your subsequent call can include before=obj_foo in order
-          # to fetch the previous page of the list.
-          before: nil,
-          # Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.
-          filter: nil,
-          # A limit on the number of objects to be returned. Limit can range between 1 and
-          # 100, and the default is 20.
-          limit: nil,
-          # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
-          # order and `desc` for descending order.
-          order: nil,
-          request_options: {}
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              after: String,
-              before: String,
-              filter: OpenAI::VectorStores::FileListParams::Filter::OrSymbol,
-              limit: Integer,
-              order: OpenAI::VectorStores::FileListParams::Order::OrSymbol,
-              request_options: OpenAI::RequestOptions
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # Filter by file status. One of `in_progress`, `completed`, `failed`, `cancelled`.
-        module Filter
-          extend OpenAI::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(Symbol, OpenAI::VectorStores::FileListParams::Filter)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          IN_PROGRESS =
-            T.let(
-              :in_progress,
-              OpenAI::VectorStores::FileListParams::Filter::TaggedSymbol
-            )
-          COMPLETED =
-            T.let(
-              :completed,
-              OpenAI::VectorStores::FileListParams::Filter::TaggedSymbol
-            )
-          FAILED =
-            T.let(
-              :failed,
-              OpenAI::VectorStores::FileListParams::Filter::TaggedSymbol
-            )
-          CANCELLED =
-            T.let(
-              :cancelled,
-              OpenAI::VectorStores::FileListParams::Filter::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                OpenAI::VectorStores::FileListParams::Filter::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
-        # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
-        # order and `desc` for descending order.
-        module Order
-          extend OpenAI::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(Symbol, OpenAI::VectorStores::FileListParams::Order)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          ASC =
-            T.let(
-              :asc,
-              OpenAI::VectorStores::FileListParams::Order::TaggedSymbol
-            )
-          DESC =
-            T.let(
-              :desc,
-              OpenAI::VectorStores::FileListParams::Order::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                OpenAI::VectorStores::FileListParams::Order::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-    end
-  end
-end

data/rbi/openai/models/vector_stores/file_retrieve_params.rbi

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

data/rbi/openai/models/vector_stores/file_update_params.rbi

@@ -1,99 +0,0 @@
-# typed: strong
-
-module OpenAI
-  module Models
-    module VectorStores
-      class FileUpdateParams < OpenAI::Internal::Type::BaseModel
-        extend OpenAI::Internal::Type::RequestParameters::Converter
-        include OpenAI::Internal::Type::RequestParameters
-
-        OrHash =
-          T.type_alias do
-            T.any(
-              OpenAI::VectorStores::FileUpdateParams,
-              OpenAI::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :vector_store_id
-
-        # 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, booleans, or numbers.
-        sig do
-          returns(
-            T.nilable(
-              T::Hash[
-                Symbol,
-                OpenAI::VectorStores::FileUpdateParams::Attribute::Variants
-              ]
-            )
-          )
-        end
-        attr_accessor :attributes
-
-        sig do
-          params(
-            vector_store_id: String,
-            attributes:
-              T.nilable(
-                T::Hash[
-                  Symbol,
-                  OpenAI::VectorStores::FileUpdateParams::Attribute::Variants
-                ]
-              ),
-            request_options: OpenAI::RequestOptions::OrHash
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          vector_store_id:,
-          # 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, booleans, or numbers.
-          attributes:,
-          request_options: {}
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              vector_store_id: String,
-              attributes:
-                T.nilable(
-                  T::Hash[
-                    Symbol,
-                    OpenAI::VectorStores::FileUpdateParams::Attribute::Variants
-                  ]
-                ),
-              request_options: OpenAI::RequestOptions
-            }
-          )
-        end
-        def to_hash
-        end
-
-        module Attribute
-          extend OpenAI::Internal::Type::Union
-
-          Variants = T.type_alias { T.any(String, Float, T::Boolean) }
-
-          sig do
-            override.returns(
-              T::Array[
-                OpenAI::VectorStores::FileUpdateParams::Attribute::Variants
-              ]
-            )
-          end
-          def self.variants
-          end
-        end
-      end
-    end
-  end
-end

data/rbi/openai/models/vector_stores/vector_store_file.rbi

@@ -1,337 +0,0 @@
-# typed: strong
-
-module OpenAI
-  module Models
-    VectorStoreFile = VectorStores::VectorStoreFile
-
-    module VectorStores
-      class VectorStoreFile < OpenAI::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              OpenAI::VectorStores::VectorStoreFile,
-              OpenAI::Internal::AnyHash
-            )
-          end
-
-        # The identifier, which can be referenced in API endpoints.
-        sig { returns(String) }
-        attr_accessor :id
-
-        # The Unix timestamp (in seconds) for when the vector store file was created.
-        sig { returns(Integer) }
-        attr_accessor :created_at
-
-        # The last error associated with this vector store file. Will be `null` if there
-        # are no errors.
-        sig do
-          returns(T.nilable(OpenAI::VectorStores::VectorStoreFile::LastError))
-        end
-        attr_reader :last_error
-
-        sig do
-          params(
-            last_error:
-              T.nilable(
-                OpenAI::VectorStores::VectorStoreFile::LastError::OrHash
-              )
-          ).void
-        end
-        attr_writer :last_error
-
-        # The object type, which is always `vector_store.file`.
-        sig { returns(Symbol) }
-        attr_accessor :object
-
-        # The status of the vector store file, which can be either `in_progress`,
-        # `completed`, `cancelled`, or `failed`. The status `completed` indicates that the
-        # vector store file is ready for use.
-        sig do
-          returns(OpenAI::VectorStores::VectorStoreFile::Status::TaggedSymbol)
-        end
-        attr_accessor :status
-
-        # The total vector store usage in bytes. Note that this may be different from the
-        # original file size.
-        sig { returns(Integer) }
-        attr_accessor :usage_bytes
-
-        # The ID of the
-        # [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
-        # that the [File](https://platform.openai.com/docs/api-reference/files) is
-        # attached to.
-        sig { returns(String) }
-        attr_accessor :vector_store_id
-
-        # 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, booleans, or numbers.
-        sig do
-          returns(
-            T.nilable(
-              T::Hash[
-                Symbol,
-                OpenAI::VectorStores::VectorStoreFile::Attribute::Variants
-              ]
-            )
-          )
-        end
-        attr_accessor :attributes
-
-        # The strategy used to chunk the file.
-        sig { returns(T.nilable(OpenAI::FileChunkingStrategy::Variants)) }
-        attr_reader :chunking_strategy
-
-        sig do
-          params(
-            chunking_strategy:
-              T.any(
-                OpenAI::StaticFileChunkingStrategyObject::OrHash,
-                OpenAI::OtherFileChunkingStrategyObject::OrHash
-              )
-          ).void
-        end
-        attr_writer :chunking_strategy
-
-        # A list of files attached to a vector store.
-        sig do
-          params(
-            id: String,
-            created_at: Integer,
-            last_error:
-              T.nilable(
-                OpenAI::VectorStores::VectorStoreFile::LastError::OrHash
-              ),
-            status: OpenAI::VectorStores::VectorStoreFile::Status::OrSymbol,
-            usage_bytes: Integer,
-            vector_store_id: String,
-            attributes:
-              T.nilable(
-                T::Hash[
-                  Symbol,
-                  OpenAI::VectorStores::VectorStoreFile::Attribute::Variants
-                ]
-              ),
-            chunking_strategy:
-              T.any(
-                OpenAI::StaticFileChunkingStrategyObject::OrHash,
-                OpenAI::OtherFileChunkingStrategyObject::OrHash
-              ),
-            object: Symbol
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The identifier, which can be referenced in API endpoints.
-          id:,
-          # The Unix timestamp (in seconds) for when the vector store file was created.
-          created_at:,
-          # The last error associated with this vector store file. Will be `null` if there
-          # are no errors.
-          last_error:,
-          # The status of the vector store file, which can be either `in_progress`,
-          # `completed`, `cancelled`, or `failed`. The status `completed` indicates that the
-          # vector store file is ready for use.
-          status:,
-          # The total vector store usage in bytes. Note that this may be different from the
-          # original file size.
-          usage_bytes:,
-          # The ID of the
-          # [vector store](https://platform.openai.com/docs/api-reference/vector-stores/object)
-          # that the [File](https://platform.openai.com/docs/api-reference/files) is
-          # attached to.
-          vector_store_id:,
-          # 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, booleans, or numbers.
-          attributes: nil,
-          # The strategy used to chunk the file.
-          chunking_strategy: nil,
-          # The object type, which is always `vector_store.file`.
-          object: :"vector_store.file"
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              id: String,
-              created_at: Integer,
-              last_error:
-                T.nilable(OpenAI::VectorStores::VectorStoreFile::LastError),
-              object: Symbol,
-              status:
-                OpenAI::VectorStores::VectorStoreFile::Status::TaggedSymbol,
-              usage_bytes: Integer,
-              vector_store_id: String,
-              attributes:
-                T.nilable(
-                  T::Hash[
-                    Symbol,
-                    OpenAI::VectorStores::VectorStoreFile::Attribute::Variants
-                  ]
-                ),
-              chunking_strategy: OpenAI::FileChunkingStrategy::Variants
-            }
-          )
-        end
-        def to_hash
-        end
-
-        class LastError < OpenAI::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                OpenAI::VectorStores::VectorStoreFile::LastError,
-                OpenAI::Internal::AnyHash
-              )
-            end
-
-          # One of `server_error` or `rate_limit_exceeded`.
-          sig do
-            returns(
-              OpenAI::VectorStores::VectorStoreFile::LastError::Code::TaggedSymbol
-            )
-          end
-          attr_accessor :code
-
-          # A human-readable description of the error.
-          sig { returns(String) }
-          attr_accessor :message
-
-          # The last error associated with this vector store file. Will be `null` if there
-          # are no errors.
-          sig do
-            params(
-              code:
-                OpenAI::VectorStores::VectorStoreFile::LastError::Code::OrSymbol,
-              message: String
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # One of `server_error` or `rate_limit_exceeded`.
-            code:,
-            # A human-readable description of the error.
-            message:
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                code:
-                  OpenAI::VectorStores::VectorStoreFile::LastError::Code::TaggedSymbol,
-                message: String
-              }
-            )
-          end
-          def to_hash
-          end
-
-          # One of `server_error` or `rate_limit_exceeded`.
-          module Code
-            extend OpenAI::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  OpenAI::VectorStores::VectorStoreFile::LastError::Code
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            SERVER_ERROR =
-              T.let(
-                :server_error,
-                OpenAI::VectorStores::VectorStoreFile::LastError::Code::TaggedSymbol
-              )
-            UNSUPPORTED_FILE =
-              T.let(
-                :unsupported_file,
-                OpenAI::VectorStores::VectorStoreFile::LastError::Code::TaggedSymbol
-              )
-            INVALID_FILE =
-              T.let(
-                :invalid_file,
-                OpenAI::VectorStores::VectorStoreFile::LastError::Code::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  OpenAI::VectorStores::VectorStoreFile::LastError::Code::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-        end
-
-        # The status of the vector store file, which can be either `in_progress`,
-        # `completed`, `cancelled`, or `failed`. The status `completed` indicates that the
-        # vector store file is ready for use.
-        module Status
-          extend OpenAI::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(Symbol, OpenAI::VectorStores::VectorStoreFile::Status)
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          IN_PROGRESS =
-            T.let(
-              :in_progress,
-              OpenAI::VectorStores::VectorStoreFile::Status::TaggedSymbol
-            )
-          COMPLETED =
-            T.let(
-              :completed,
-              OpenAI::VectorStores::VectorStoreFile::Status::TaggedSymbol
-            )
-          CANCELLED =
-            T.let(
-              :cancelled,
-              OpenAI::VectorStores::VectorStoreFile::Status::TaggedSymbol
-            )
-          FAILED =
-            T.let(
-              :failed,
-              OpenAI::VectorStores::VectorStoreFile::Status::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                OpenAI::VectorStores::VectorStoreFile::Status::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
-        module Attribute
-          extend OpenAI::Internal::Type::Union
-
-          Variants = T.type_alias { T.any(String, Float, T::Boolean) }
-
-          sig do
-            override.returns(
-              T::Array[
-                OpenAI::VectorStores::VectorStoreFile::Attribute::Variants
-              ]
-            )
-          end
-          def self.variants
-          end
-        end
-      end
-    end
-  end
-end