openai 0.3.0 → 0.4.1

data/lib/openai/models/vector_store.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    # @see OpenAI::Resources::VectorStores#create
+    class VectorStore < OpenAI::Internal::Type::BaseModel
+      # @!attribute id
+      #   The identifier, which can be referenced in API endpoints.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   The Unix timestamp (in seconds) for when the vector store was created.
+      #
+      #   @return [Integer]
+      required :created_at, Integer
+
+      # @!attribute file_counts
+      #
+      #   @return [OpenAI::Models::VectorStore::FileCounts]
+      required :file_counts, -> { OpenAI::VectorStore::FileCounts }
+
+      # @!attribute last_active_at
+      #   The Unix timestamp (in seconds) for when the vector store was last active.
+      #
+      #   @return [Integer, nil]
+      required :last_active_at, Integer, nil?: true
+
+      # @!attribute metadata
+      #   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.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      required :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
+
+      # @!attribute name
+      #   The name of the vector store.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute object
+      #   The object type, which is always `vector_store`.
+      #
+      #   @return [Symbol, :vector_store]
+      required :object, const: :vector_store
+
+      # @!attribute status
+      #   The status of the vector store, which can be either `expired`, `in_progress`, or
+      #   `completed`. A status of `completed` indicates that the vector store is ready
+      #   for use.
+      #
+      #   @return [Symbol, OpenAI::Models::VectorStore::Status]
+      required :status, enum: -> { OpenAI::VectorStore::Status }
+
+      # @!attribute usage_bytes
+      #   The total number of bytes used by the files in the vector store.
+      #
+      #   @return [Integer]
+      required :usage_bytes, Integer
+
+      # @!attribute expires_after
+      #   The expiration policy for a vector store.
+      #
+      #   @return [OpenAI::Models::VectorStore::ExpiresAfter, nil]
+      optional :expires_after, -> { OpenAI::VectorStore::ExpiresAfter }
+
+      # @!attribute expires_at
+      #   The Unix timestamp (in seconds) for when the vector store will expire.
+      #
+      #   @return [Integer, nil]
+      optional :expires_at, Integer, nil?: true
+
+      # @!method initialize(id:, created_at:, file_counts:, last_active_at:, metadata:, name:, status:, usage_bytes:, expires_after: nil, expires_at: nil, object: :vector_store)
+      #   Some parameter documentations has been truncated, see
+      #   {OpenAI::Models::VectorStore} for more details.
+      #
+      #   A vector store is a collection of processed files can be used by the
+      #   `file_search` tool.
+      #
+      #   @param id [String] The identifier, which can be referenced in API endpoints.
+      #
+      #   @param created_at [Integer] The Unix timestamp (in seconds) for when the vector store was created.
+      #
+      #   @param file_counts [OpenAI::Models::VectorStore::FileCounts]
+      #
+      #   @param last_active_at [Integer, nil] The Unix timestamp (in seconds) for when the vector store was last active.
+      #
+      #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
+      #
+      #   @param name [String] The name of the vector store.
+      #
+      #   @param status [Symbol, OpenAI::Models::VectorStore::Status] The status of the vector store, which can be either `expired`, `in_progress`, or
+      #
+      #   @param usage_bytes [Integer] The total number of bytes used by the files in the vector store.
+      #
+      #   @param expires_after [OpenAI::Models::VectorStore::ExpiresAfter] The expiration policy for a vector store.
+      #
+      #   @param expires_at [Integer, nil] The Unix timestamp (in seconds) for when the vector store will expire.
+      #
+      #   @param object [Symbol, :vector_store] The object type, which is always `vector_store`.
+
+      # @see OpenAI::Models::VectorStore#file_counts
+      class FileCounts < OpenAI::Internal::Type::BaseModel
+        # @!attribute cancelled
+        #   The number of files that were cancelled.
+        #
+        #   @return [Integer]
+        required :cancelled, Integer
+
+        # @!attribute completed
+        #   The number of files that have been successfully processed.
+        #
+        #   @return [Integer]
+        required :completed, Integer
+
+        # @!attribute failed
+        #   The number of files that have failed to process.
+        #
+        #   @return [Integer]
+        required :failed, Integer
+
+        # @!attribute in_progress
+        #   The number of files that are currently being processed.
+        #
+        #   @return [Integer]
+        required :in_progress, Integer
+
+        # @!attribute total
+        #   The total number of files.
+        #
+        #   @return [Integer]
+        required :total, Integer
+
+        # @!method initialize(cancelled:, completed:, failed:, in_progress:, total:)
+        #   @param cancelled [Integer] The number of files that were cancelled.
+        #
+        #   @param completed [Integer] The number of files that have been successfully processed.
+        #
+        #   @param failed [Integer] The number of files that have failed to process.
+        #
+        #   @param in_progress [Integer] The number of files that are currently being processed.
+        #
+        #   @param total [Integer] The total number of files.
+      end
+
+      # The status of the vector store, which can be either `expired`, `in_progress`, or
+      # `completed`. A status of `completed` indicates that the vector store is ready
+      # for use.
+      #
+      # @see OpenAI::Models::VectorStore#status
+      module Status
+        extend OpenAI::Internal::Type::Enum
+
+        EXPIRED = :expired
+        IN_PROGRESS = :in_progress
+        COMPLETED = :completed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see OpenAI::Models::VectorStore#expires_after
+      class ExpiresAfter < OpenAI::Internal::Type::BaseModel
+        # @!attribute anchor
+        #   Anchor timestamp after which the expiration policy applies. Supported anchors:
+        #   `last_active_at`.
+        #
+        #   @return [Symbol, :last_active_at]
+        required :anchor, const: :last_active_at
+
+        # @!attribute days
+        #   The number of days after the anchor time that the vector store will expire.
+        #
+        #   @return [Integer]
+        required :days, Integer
+
+        # @!method initialize(days:, anchor: :last_active_at)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::VectorStore::ExpiresAfter} for more details.
+        #
+        #   The expiration policy for a vector store.
+        #
+        #   @param days [Integer] The number of days after the anchor time that the vector store will expire.
+        #
+        #   @param anchor [Symbol, :last_active_at] Anchor timestamp after which the expiration policy applies. Supported anchors: `
+      end
+    end
+  end
+end

data/lib/openai/models/vector_store_create_params.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    # @see OpenAI::Resources::VectorStores#create
+    class VectorStoreCreateParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      # @!attribute chunking_strategy
+      #   The chunking strategy used to chunk the file(s). If not set, will use the `auto`
+      #   strategy. Only applicable if `file_ids` is non-empty.
+      #
+      #   @return [OpenAI::Models::AutoFileChunkingStrategyParam, OpenAI::Models::StaticFileChunkingStrategyObjectParam, nil]
+      optional :chunking_strategy, union: -> { OpenAI::FileChunkingStrategyParam }
+
+      # @!attribute expires_after
+      #   The expiration policy for a vector store.
+      #
+      #   @return [OpenAI::Models::VectorStoreCreateParams::ExpiresAfter, nil]
+      optional :expires_after, -> { OpenAI::VectorStoreCreateParams::ExpiresAfter }
+
+      # @!attribute file_ids
+      #   A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
+      #   the vector store should use. Useful for tools like `file_search` that can access
+      #   files.
+      #
+      #   @return [Array<String>, nil]
+      optional :file_ids, OpenAI::Internal::Type::ArrayOf[String]
+
+      # @!attribute metadata
+      #   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.
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :metadata, OpenAI::Internal::Type::HashOf[String], nil?: true
+
+      # @!attribute name
+      #   The name of the vector store.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!method initialize(chunking_strategy: nil, expires_after: nil, file_ids: nil, metadata: nil, name: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {OpenAI::Models::VectorStoreCreateParams} for more details.
+      #
+      #   @param chunking_strategy [OpenAI::Models::AutoFileChunkingStrategyParam, OpenAI::Models::StaticFileChunkingStrategyObjectParam] The chunking strategy used to chunk the file(s). If not set, will use the `auto`
+      #
+      #   @param expires_after [OpenAI::Models::VectorStoreCreateParams::ExpiresAfter] The expiration policy for a vector store.
+      #
+      #   @param file_ids [Array<String>] A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
+      #
+      #   @param metadata [Hash{Symbol=>String}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
+      #
+      #   @param name [String] The name of the vector store.
+      #
+      #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+      class ExpiresAfter < OpenAI::Internal::Type::BaseModel
+        # @!attribute anchor
+        #   Anchor timestamp after which the expiration policy applies. Supported anchors:
+        #   `last_active_at`.
+        #
+        #   @return [Symbol, :last_active_at]
+        required :anchor, const: :last_active_at
+
+        # @!attribute days
+        #   The number of days after the anchor time that the vector store will expire.
+        #
+        #   @return [Integer]
+        required :days, Integer
+
+        # @!method initialize(days:, anchor: :last_active_at)
+        #   Some parameter documentations has been truncated, see
+        #   {OpenAI::Models::VectorStoreCreateParams::ExpiresAfter} for more details.
+        #
+        #   The expiration policy for a vector store.
+        #
+        #   @param days [Integer] The number of days after the anchor time that the vector store will expire.
+        #
+        #   @param anchor [Symbol, :last_active_at] Anchor timestamp after which the expiration policy applies. Supported anchors: `
+      end
+    end
+  end
+end

data/lib/openai/models/vector_store_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    # @see OpenAI::Resources::VectorStores#delete
+    class VectorStoreDeleteParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/openai/models/vector_store_deleted.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    # @see OpenAI::Resources::VectorStores#delete
+    class VectorStoreDeleted < OpenAI::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute deleted
+      #
+      #   @return [Boolean]
+      required :deleted, OpenAI::Internal::Type::Boolean
+
+      # @!attribute object
+      #
+      #   @return [Symbol, :"vector_store.deleted"]
+      required :object, const: :"vector_store.deleted"
+
+      # @!method initialize(id:, deleted:, object: :"vector_store.deleted")
+      #   @param id [String]
+      #   @param deleted [Boolean]
+      #   @param object [Symbol, :"vector_store.deleted"]
+    end
+  end
+end

data/lib/openai/models/vector_store_list_params.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    # @see OpenAI::Resources::VectorStores#list
+    class VectorStoreListParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      # @!attribute after
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   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.
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!attribute limit
+      #   A limit on the number of objects to be returned. Limit can range between 1 and
+      #   100, and the default is 20.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute order
+      #   Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+      #   order and `desc` for descending order.
+      #
+      #   @return [Symbol, OpenAI::Models::VectorStoreListParams::Order, nil]
+      optional :order, enum: -> { OpenAI::VectorStoreListParams::Order }
+
+      # @!method initialize(after: nil, before: nil, limit: nil, order: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {OpenAI::Models::VectorStoreListParams} for more details.
+      #
+      #   @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
+      #
+      #   @param before [String] A cursor for use in pagination. `before` is an object ID that defines your place
+      #
+      #   @param limit [Integer] A limit on the number of objects to be returned. Limit can range between 1 and 1
+      #
+      #   @param order [Symbol, OpenAI::Models::VectorStoreListParams::Order] Sort order by the `created_at` timestamp of the objects. `asc` for ascending ord
+      #
+      #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+      # 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
+
+        ASC = :asc
+        DESC = :desc
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/openai/models/vector_store_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    # @see OpenAI::Resources::VectorStores#retrieve
+    class VectorStoreRetrieveParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/openai/models/vector_store_search_params.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    # @see OpenAI::Resources::VectorStores#search
+    class VectorStoreSearchParams < OpenAI::Internal::Type::BaseModel
+      extend OpenAI::Internal::Type::RequestParameters::Converter
+      include OpenAI::Internal::Type::RequestParameters
+
+      # @!attribute query
+      #   A query string for a search
+      #
+      #   @return [String, Array<String>]
+      required :query, union: -> { OpenAI::VectorStoreSearchParams::Query }
+
+      # @!attribute filters
+      #   A filter to apply based on file attributes.
+      #
+      #   @return [OpenAI::Models::ComparisonFilter, OpenAI::Models::CompoundFilter, nil]
+      optional :filters, union: -> { OpenAI::VectorStoreSearchParams::Filters }
+
+      # @!attribute max_num_results
+      #   The maximum number of results to return. This number should be between 1 and 50
+      #   inclusive.
+      #
+      #   @return [Integer, nil]
+      optional :max_num_results, Integer
+
+      # @!attribute ranking_options
+      #   Ranking options for search.
+      #
+      #   @return [OpenAI::Models::VectorStoreSearchParams::RankingOptions, nil]
+      optional :ranking_options, -> { OpenAI::VectorStoreSearchParams::RankingOptions }
+
+      # @!attribute rewrite_query
+      #   Whether to rewrite the natural language query for vector search.
+      #
+      #   @return [Boolean, nil]
+      optional :rewrite_query, OpenAI::Internal::Type::Boolean
+
+      # @!method initialize(query:, filters: nil, max_num_results: nil, ranking_options: nil, rewrite_query: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {OpenAI::Models::VectorStoreSearchParams} for more details.
+      #
+      #   @param query [String, Array<String>] A query string for a search
+      #
+      #   @param filters [OpenAI::Models::ComparisonFilter, OpenAI::Models::CompoundFilter] A filter to apply based on file attributes.
+      #
+      #   @param max_num_results [Integer] The maximum number of results to return. This number should be between 1 and 50
+      #
+      #   @param ranking_options [OpenAI::Models::VectorStoreSearchParams::RankingOptions] Ranking options for search.
+      #
+      #   @param rewrite_query [Boolean] Whether to rewrite the natural language query for vector search.
+      #
+      #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+      # A query string for a search
+      module Query
+        extend OpenAI::Internal::Type::Union
+
+        variant String
+
+        variant -> { OpenAI::Models::VectorStoreSearchParams::Query::StringArray }
+
+        # @!method self.variants
+        #   @return [Array(String, Array<String>)]
+
+        # @type [OpenAI::Internal::Type::Converter]
+        StringArray = OpenAI::Internal::Type::ArrayOf[String]
+      end
+
+      # A filter to apply based on file attributes.
+      module Filters
+        extend OpenAI::Internal::Type::Union
+
+        # A filter used to compare a specified attribute key to a given value using a defined comparison operation.
+        variant -> { OpenAI::ComparisonFilter }
+
+        # Combine multiple filters using `and` or `or`.
+        variant -> { OpenAI::CompoundFilter }
+
+        # @!method self.variants
+        #   @return [Array(OpenAI::Models::ComparisonFilter, OpenAI::Models::CompoundFilter)]
+      end
+
+      class RankingOptions < OpenAI::Internal::Type::BaseModel
+        # @!attribute ranker
+        #
+        #   @return [Symbol, OpenAI::Models::VectorStoreSearchParams::RankingOptions::Ranker, nil]
+        optional :ranker, enum: -> { OpenAI::VectorStoreSearchParams::RankingOptions::Ranker }
+
+        # @!attribute score_threshold
+        #
+        #   @return [Float, nil]
+        optional :score_threshold, Float
+
+        # @!method initialize(ranker: nil, score_threshold: nil)
+        #   Ranking options for search.
+        #
+        #   @param ranker [Symbol, OpenAI::Models::VectorStoreSearchParams::RankingOptions::Ranker]
+        #   @param score_threshold [Float]
+
+        # @see OpenAI::Models::VectorStoreSearchParams::RankingOptions#ranker
+        module Ranker
+          extend OpenAI::Internal::Type::Enum
+
+          AUTO = :auto
+          DEFAULT_2024_11_15 = :"default-2024-11-15"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/vector_store_search_response.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    # @see OpenAI::Resources::VectorStores#search
+    class VectorStoreSearchResponse < OpenAI::Internal::Type::BaseModel
+      # @!attribute attributes
+      #   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.
+      #
+      #   @return [Hash{Symbol=>String, Float, Boolean}, nil]
+      required :attributes,
+               -> { OpenAI::Internal::Type::HashOf[union: OpenAI::Models::VectorStoreSearchResponse::Attribute] },
+               nil?: true
+
+      # @!attribute content
+      #   Content chunks from the file.
+      #
+      #   @return [Array<OpenAI::Models::VectorStoreSearchResponse::Content>]
+      required :content,
+               -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Models::VectorStoreSearchResponse::Content] }
+
+      # @!attribute file_id
+      #   The ID of the vector store file.
+      #
+      #   @return [String]
+      required :file_id, String
+
+      # @!attribute filename
+      #   The name of the vector store file.
+      #
+      #   @return [String]
+      required :filename, String
+
+      # @!attribute score
+      #   The similarity score for the result.
+      #
+      #   @return [Float]
+      required :score, Float
+
+      # @!method initialize(attributes:, content:, file_id:, filename:, score:)
+      #   Some parameter documentations has been truncated, see
+      #   {OpenAI::Models::VectorStoreSearchResponse} for more details.
+      #
+      #   @param attributes [Hash{Symbol=>String, Float, Boolean}, nil] Set of 16 key-value pairs that can be attached to an object. This can be
+      #
+      #   @param content [Array<OpenAI::Models::VectorStoreSearchResponse::Content>] Content chunks from the file.
+      #
+      #   @param file_id [String] The ID of the vector store file.
+      #
+      #   @param filename [String] The name of the vector store file.
+      #
+      #   @param score [Float] The similarity score for the result.
+
+      module Attribute
+        extend OpenAI::Internal::Type::Union
+
+        variant String
+
+        variant Float
+
+        variant OpenAI::Internal::Type::Boolean
+
+        # @!method self.variants
+        #   @return [Array(String, Float, Boolean)]
+      end
+
+      class Content < OpenAI::Internal::Type::BaseModel
+        # @!attribute text
+        #   The text content returned from search.
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!attribute type
+        #   The type of content.
+        #
+        #   @return [Symbol, OpenAI::Models::VectorStoreSearchResponse::Content::Type]
+        required :type, enum: -> { OpenAI::Models::VectorStoreSearchResponse::Content::Type }
+
+        # @!method initialize(text:, type:)
+        #   @param text [String] The text content returned from search.
+        #
+        #   @param type [Symbol, OpenAI::Models::VectorStoreSearchResponse::Content::Type] The type of content.
+
+        # The type of content.
+        #
+        # @see OpenAI::Models::VectorStoreSearchResponse::Content#type
+        module Type
+          extend OpenAI::Internal::Type::Enum
+
+          TEXT = :text
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end