turbopuffer-ruby 0.2.0.pre.alpha.1

data/rbi/turbopuffer/models/columns.rbi

@@ -0,0 +1,82 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class Columns < Turbopuffer::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Turbopuffer::Columns, Turbopuffer::Internal::AnyHash)
+        end
+
+      # The IDs of the documents.
+      sig { returns(T::Array[Turbopuffer::ID::Variants]) }
+      attr_accessor :id
+
+      # The vector embeddings of the documents.
+      sig { returns(T.nilable(Turbopuffer::Columns::Vector::Variants)) }
+      attr_reader :vector
+
+      sig { params(vector: Turbopuffer::Columns::Vector::Variants).void }
+      attr_writer :vector
+
+      # A list of documents in columnar format. Each key is a column name, mapped to an
+      # array of values for that column.
+      sig do
+        params(
+          id: T::Array[Turbopuffer::ID::Variants],
+          vector: Turbopuffer::Columns::Vector::Variants
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The IDs of the documents.
+        id:,
+        # The vector embeddings of the documents.
+        vector: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: T::Array[Turbopuffer::ID::Variants],
+            vector: Turbopuffer::Columns::Vector::Variants
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The vector embeddings of the documents.
+      module Vector
+        extend Turbopuffer::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(
+              T::Array[Turbopuffer::Vector::Variants],
+              T::Array[Float],
+              String
+            )
+          end
+
+        sig do
+          override.returns(T::Array[Turbopuffer::Columns::Vector::Variants])
+        end
+        def self.variants
+        end
+
+        VectorArray =
+          T.let(
+            Turbopuffer::Internal::Type::ArrayOf[union: Turbopuffer::Vector],
+            Turbopuffer::Internal::Type::Converter
+          )
+
+        FloatArray =
+          T.let(
+            Turbopuffer::Internal::Type::ArrayOf[Float],
+            Turbopuffer::Internal::Type::Converter
+          )
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/distance_metric.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    # A function used to calculate vector similarity.
+    module DistanceMetric
+      extend Turbopuffer::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Turbopuffer::DistanceMetric) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      # Defined as `1 - cosine_similarity` and ranges from 0 to 2. Lower is better.
+      COSINE_DISTANCE =
+        T.let(:cosine_distance, Turbopuffer::DistanceMetric::TaggedSymbol)
+
+      # Defined as `sum((x - y)^2)`. Lower is better.
+      EUCLIDEAN_SQUARED =
+        T.let(:euclidean_squared, Turbopuffer::DistanceMetric::TaggedSymbol)
+
+      sig do
+        override.returns(T::Array[Turbopuffer::DistanceMetric::TaggedSymbol])
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/full_text_search.rbi

@@ -0,0 +1,19 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    # Whether this attribute can be used as part of a BM25 full-text search. Requires
+    # the `string` or `[]string` type, and by default, BM25-enabled attributes are not
+    # filterable. You can override this by setting `filterable: true`.
+    module FullTextSearch
+      extend Turbopuffer::Internal::Type::Union
+
+      Variants =
+        T.type_alias { T.any(T::Boolean, Turbopuffer::FullTextSearchConfig) }
+
+      sig { override.returns(T::Array[Turbopuffer::FullTextSearch::Variants]) }
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/full_text_search_config.rbi

@@ -0,0 +1,116 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class FullTextSearchConfig < Turbopuffer::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Turbopuffer::FullTextSearchConfig,
+            Turbopuffer::Internal::AnyHash
+          )
+        end
+
+      # The `b` document length normalization parameter for BM25. Defaults to `0.75`.
+      sig { returns(T.nilable(Float)) }
+      attr_reader :b
+
+      sig { params(b: Float).void }
+      attr_writer :b
+
+      # Whether searching is case-sensitive. Defaults to `false` (i.e.
+      # case-insensitive).
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :case_sensitive
+
+      sig { params(case_sensitive: T::Boolean).void }
+      attr_writer :case_sensitive
+
+      # The `k1` term saturation parameter for BM25. Defaults to `1.2`.
+      sig { returns(T.nilable(Float)) }
+      attr_reader :k1
+
+      sig { params(k1: Float).void }
+      attr_writer :k1
+
+      # Describes the language of a text attribute. Defaults to `english`.
+      sig { returns(T.nilable(Turbopuffer::Language::OrSymbol)) }
+      attr_reader :language
+
+      sig { params(language: Turbopuffer::Language::OrSymbol).void }
+      attr_writer :language
+
+      # Removes common words from the text based on language. Defaults to `true` (i.e.
+      # remove common words).
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :remove_stopwords
+
+      sig { params(remove_stopwords: T::Boolean).void }
+      attr_writer :remove_stopwords
+
+      # Language-specific stemming for the text. Defaults to `false` (i.e., do not
+      # stem).
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :stemming
+
+      sig { params(stemming: T::Boolean).void }
+      attr_writer :stemming
+
+      # The tokenizer to use for full-text search on an attribute.
+      sig { returns(T.nilable(Turbopuffer::Tokenizer::OrSymbol)) }
+      attr_reader :tokenizer
+
+      sig { params(tokenizer: Turbopuffer::Tokenizer::OrSymbol).void }
+      attr_writer :tokenizer
+
+      # Configuration options for full-text search.
+      sig do
+        params(
+          b: Float,
+          case_sensitive: T::Boolean,
+          k1: Float,
+          language: Turbopuffer::Language::OrSymbol,
+          remove_stopwords: T::Boolean,
+          stemming: T::Boolean,
+          tokenizer: Turbopuffer::Tokenizer::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The `b` document length normalization parameter for BM25. Defaults to `0.75`.
+        b: nil,
+        # Whether searching is case-sensitive. Defaults to `false` (i.e.
+        # case-insensitive).
+        case_sensitive: nil,
+        # The `k1` term saturation parameter for BM25. Defaults to `1.2`.
+        k1: nil,
+        # Describes the language of a text attribute. Defaults to `english`.
+        language: nil,
+        # Removes common words from the text based on language. Defaults to `true` (i.e.
+        # remove common words).
+        remove_stopwords: nil,
+        # Language-specific stemming for the text. Defaults to `false` (i.e., do not
+        # stem).
+        stemming: nil,
+        # The tokenizer to use for full-text search on an attribute.
+        tokenizer: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            b: Float,
+            case_sensitive: T::Boolean,
+            k1: Float,
+            language: Turbopuffer::Language::OrSymbol,
+            remove_stopwords: T::Boolean,
+            stemming: T::Boolean,
+            tokenizer: Turbopuffer::Tokenizer::OrSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/id.rbi

@@ -0,0 +1,16 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    # An identifier for a document.
+    module ID
+      extend Turbopuffer::Internal::Type::Union
+
+      Variants = T.type_alias { T.any(String, Integer) }
+
+      sig { override.returns(T::Array[Turbopuffer::ID::Variants]) }
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/include_attributes.rbi

@@ -0,0 +1,24 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    # Whether to include attributes in the response.
+    module IncludeAttributes
+      extend Turbopuffer::Internal::Type::Union
+
+      Variants = T.type_alias { T.any(T::Boolean, T::Array[String]) }
+
+      sig do
+        override.returns(T::Array[Turbopuffer::IncludeAttributes::Variants])
+      end
+      def self.variants
+      end
+
+      StringArray =
+        T.let(
+          Turbopuffer::Internal::Type::ArrayOf[String],
+          Turbopuffer::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/turbopuffer/models/language.rbi

@@ -0,0 +1,36 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    # Describes the language of a text attribute. Defaults to `english`.
+    module Language
+      extend Turbopuffer::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Turbopuffer::Language) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      ARABIC = T.let(:arabic, Turbopuffer::Language::TaggedSymbol)
+      DANISH = T.let(:danish, Turbopuffer::Language::TaggedSymbol)
+      DUTCH = T.let(:dutch, Turbopuffer::Language::TaggedSymbol)
+      ENGLISH = T.let(:english, Turbopuffer::Language::TaggedSymbol)
+      FINNISH = T.let(:finnish, Turbopuffer::Language::TaggedSymbol)
+      FRENCH = T.let(:french, Turbopuffer::Language::TaggedSymbol)
+      GERMAN = T.let(:german, Turbopuffer::Language::TaggedSymbol)
+      GREEK = T.let(:greek, Turbopuffer::Language::TaggedSymbol)
+      HUNGARIAN = T.let(:hungarian, Turbopuffer::Language::TaggedSymbol)
+      ITALIAN = T.let(:italian, Turbopuffer::Language::TaggedSymbol)
+      NORWEGIAN = T.let(:norwegian, Turbopuffer::Language::TaggedSymbol)
+      PORTUGUESE = T.let(:portuguese, Turbopuffer::Language::TaggedSymbol)
+      ROMANIAN = T.let(:romanian, Turbopuffer::Language::TaggedSymbol)
+      RUSSIAN = T.let(:russian, Turbopuffer::Language::TaggedSymbol)
+      SPANISH = T.let(:spanish, Turbopuffer::Language::TaggedSymbol)
+      SWEDISH = T.let(:swedish, Turbopuffer::Language::TaggedSymbol)
+      TAMIL = T.let(:tamil, Turbopuffer::Language::TaggedSymbol)
+      TURKISH = T.let(:turkish, Turbopuffer::Language::TaggedSymbol)
+
+      sig { override.returns(T::Array[Turbopuffer::Language::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/namespace_delete_all_params.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class NamespaceDeleteAllParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Turbopuffer::NamespaceDeleteAllParams,
+            Turbopuffer::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :namespace
+
+      sig { params(namespace: String).void }
+      attr_writer :namespace
+
+      sig do
+        params(
+          namespace: String,
+          request_options: Turbopuffer::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(namespace: nil, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { namespace: String, request_options: Turbopuffer::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/namespace_delete_all_response.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class NamespaceDeleteAllResponse < Turbopuffer::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Turbopuffer::Models::NamespaceDeleteAllResponse,
+            Turbopuffer::Internal::AnyHash
+          )
+        end
+
+      # The status of the request.
+      sig { returns(Symbol) }
+      attr_accessor :status
+
+      # The response to a successful namespace deletion request.
+      sig { params(status: Symbol).returns(T.attached_class) }
+      def self.new(
+        # The status of the request.
+        status: :OK
+      )
+      end
+
+      sig { override.returns({ status: Symbol }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/namespace_hint_cache_warm_params.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class NamespaceHintCacheWarmParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Turbopuffer::NamespaceHintCacheWarmParams,
+            Turbopuffer::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :namespace
+
+      sig { params(namespace: String).void }
+      attr_writer :namespace
+
+      sig do
+        params(
+          namespace: String,
+          request_options: Turbopuffer::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(namespace: nil, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { namespace: String, request_options: Turbopuffer::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/namespace_hint_cache_warm_response.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class NamespaceHintCacheWarmResponse < Turbopuffer::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Turbopuffer::Models::NamespaceHintCacheWarmResponse,
+            Turbopuffer::Internal::AnyHash
+          )
+        end
+
+      # The status of the request.
+      sig { returns(Symbol) }
+      attr_accessor :status
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :message
+
+      sig { params(message: String).void }
+      attr_writer :message
+
+      # The response to a successful cache warm request.
+      sig { params(message: String, status: Symbol).returns(T.attached_class) }
+      def self.new(
+        message: nil,
+        # The status of the request.
+        status: :OK
+      )
+      end
+
+      sig { override.returns({ status: Symbol, message: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/namespace_metadata.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class NamespaceMetadata < Turbopuffer::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Turbopuffer::NamespaceMetadata, Turbopuffer::Internal::AnyHash)
+        end
+
+      # The approximate number of logical bytes in the namespace.
+      sig { returns(Integer) }
+      attr_accessor :approx_logical_bytes
+
+      # The timestamp when the namespace was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The schema of the namespace.
+      sig { returns(T::Hash[Symbol, Turbopuffer::AttributeSchemaConfig]) }
+      attr_accessor :schema
+
+      # Metadata about a namespace.
+      sig do
+        params(
+          approx_logical_bytes: Integer,
+          created_at: Time,
+          schema: T::Hash[Symbol, Turbopuffer::AttributeSchemaConfig::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The approximate number of logical bytes in the namespace.
+        approx_logical_bytes:,
+        # The timestamp when the namespace was created.
+        created_at:,
+        # The schema of the namespace.
+        schema:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            approx_logical_bytes: Integer,
+            created_at: Time,
+            schema: T::Hash[Symbol, Turbopuffer::AttributeSchemaConfig]
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/namespace_metadata_params.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class NamespaceMetadataParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Turbopuffer::NamespaceMetadataParams,
+            Turbopuffer::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :namespace
+
+      sig { params(namespace: String).void }
+      attr_writer :namespace
+
+      sig do
+        params(
+          namespace: String,
+          request_options: Turbopuffer::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(namespace: nil, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { namespace: String, request_options: Turbopuffer::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end