turbopuffer 0.1.0 → 1.3.0

data/sig/turbopuffer/models/attribute_schema.rbs

@@ -0,0 +1,11 @@
+module Turbopuffer
+  module Models
+    type attribute_schema = String | Turbopuffer::AttributeSchemaConfig
+
+    module AttributeSchema
+      extend Turbopuffer::Internal::Type::Union
+
+      def self?.variants: -> ::Array[Turbopuffer::Models::attribute_schema]
+    end
+  end
+end

data/sig/turbopuffer/models/attribute_schema_config.rbs

@@ -0,0 +1,52 @@
+module Turbopuffer
+  module Models
+    type attribute_schema_config =
+      {
+        ann: bool,
+        filterable: bool,
+        full_text_search: Turbopuffer::Models::full_text_search,
+        regex: bool,
+        type: String
+      }
+
+    class AttributeSchemaConfig < Turbopuffer::Internal::Type::BaseModel
+      attr_reader ann: bool?
+
+      def ann=: (bool) -> bool
+
+      attr_reader filterable: bool?
+
+      def filterable=: (bool) -> bool
+
+      attr_reader full_text_search: Turbopuffer::Models::full_text_search?
+
+      def full_text_search=: (
+        Turbopuffer::Models::full_text_search
+      ) -> Turbopuffer::Models::full_text_search
+
+      attr_reader regex: bool?
+
+      def regex=: (bool) -> bool
+
+      attr_reader type: String?
+
+      def type=: (String) -> String
+
+      def initialize: (
+        ?ann: bool,
+        ?filterable: bool,
+        ?full_text_search: Turbopuffer::Models::full_text_search,
+        ?regex: bool,
+        ?type: String
+      ) -> void
+
+      def to_hash: -> {
+        ann: bool,
+        filterable: bool,
+        full_text_search: Turbopuffer::Models::full_text_search,
+        regex: bool,
+        type: String
+      }
+    end
+  end
+end

data/sig/turbopuffer/models/attribute_type.rbs

@@ -0,0 +1,5 @@
+module Turbopuffer
+  module Models
+    class AttributeType = String
+  end
+end

data/sig/turbopuffer/models/bm25_clause_params.rbs

@@ -0,0 +1,15 @@
+module Turbopuffer
+  module Models
+    type bm25_clause_params = { last_as_prefix: bool }
+
+    class Bm25ClauseParams < Turbopuffer::Internal::Type::BaseModel
+      attr_reader last_as_prefix: bool?
+
+      def last_as_prefix=: (bool) -> bool
+
+      def initialize: (?last_as_prefix: bool) -> void
+
+      def to_hash: -> { last_as_prefix: bool }
+    end
+  end
+end

data/sig/turbopuffer/models/client_namespaces_params.rbs

@@ -0,0 +1,38 @@
+module Turbopuffer
+  module Models
+    type client_namespaces_params =
+      { cursor: String, page_size: Integer, prefix: String }
+      & Turbopuffer::Internal::Type::request_parameters
+
+    class ClientNamespacesParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      attr_reader cursor: String?
+
+      def cursor=: (String) -> String
+
+      attr_reader page_size: Integer?
+
+      def page_size=: (Integer) -> Integer
+
+      attr_reader prefix: String?
+
+      def prefix=: (String) -> String
+
+      def initialize: (
+        ?cursor: String,
+        ?page_size: Integer,
+        ?prefix: String,
+        ?request_options: Turbopuffer::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        cursor: String,
+        page_size: Integer,
+        prefix: String,
+        request_options: Turbopuffer::RequestOptions
+      }
+    end
+  end
+end

data/sig/turbopuffer/models/columns.rbs

@@ -0,0 +1,42 @@
+module Turbopuffer
+  module Models
+    type columns =
+      {
+        id: ::Array[Turbopuffer::Models::id],
+        vector: Turbopuffer::Models::Columns::vector
+      }
+
+    class Columns < Turbopuffer::Internal::Type::BaseModel
+      attr_accessor id: ::Array[Turbopuffer::Models::id]
+
+      attr_reader vector: Turbopuffer::Models::Columns::vector?
+
+      def vector=: (
+        Turbopuffer::Models::Columns::vector
+      ) -> Turbopuffer::Models::Columns::vector
+
+      def initialize: (
+        id: ::Array[Turbopuffer::Models::id],
+        ?vector: Turbopuffer::Models::Columns::vector
+      ) -> void
+
+      def to_hash: -> {
+        id: ::Array[Turbopuffer::Models::id],
+        vector: Turbopuffer::Models::Columns::vector
+      }
+
+      type vector =
+        ::Array[Turbopuffer::Models::vector] | ::Array[Float] | String
+
+      module Vector
+        extend Turbopuffer::Internal::Type::Union
+
+        def self?.variants: -> ::Array[Turbopuffer::Models::Columns::vector]
+
+        VectorArray: Turbopuffer::Internal::Type::Converter
+
+        FloatArray: Turbopuffer::Internal::Type::Converter
+      end
+    end
+  end
+end

data/sig/turbopuffer/models/contains_all_tokens_filter_params.rbs

@@ -0,0 +1,15 @@
+module Turbopuffer
+  module Models
+    type contains_all_tokens_filter_params = { last_as_prefix: bool }
+
+    class ContainsAllTokensFilterParams < Turbopuffer::Internal::Type::BaseModel
+      attr_reader last_as_prefix: bool?
+
+      def last_as_prefix=: (bool) -> bool
+
+      def initialize: (?last_as_prefix: bool) -> void
+
+      def to_hash: -> { last_as_prefix: bool }
+    end
+  end
+end

data/sig/turbopuffer/models/distance_metric.rbs

@@ -0,0 +1,17 @@
+module Turbopuffer
+  module Models
+    type distance_metric = :cosine_distance | :euclidean_squared
+
+    module DistanceMetric
+      extend Turbopuffer::Internal::Type::Enum
+
+      # Defined as `1 - cosine_similarity` and ranges from 0 to 2. Lower is better.
+      COSINE_DISTANCE: :cosine_distance
+
+      # Defined as `sum((x - y)^2)`. Lower is better.
+      EUCLIDEAN_SQUARED: :euclidean_squared
+
+      def self?.values: -> ::Array[Turbopuffer::Models::distance_metric]
+    end
+  end
+end

data/sig/turbopuffer/models/full_text_search.rbs

@@ -0,0 +1,11 @@
+module Turbopuffer
+  module Models
+    type full_text_search = bool | Turbopuffer::FullTextSearchConfig
+
+    module FullTextSearch
+      extend Turbopuffer::Internal::Type::Union
+
+      def self?.variants: -> ::Array[Turbopuffer::Models::full_text_search]
+    end
+  end
+end

data/sig/turbopuffer/models/full_text_search_config.rbs

@@ -0,0 +1,75 @@
+module Turbopuffer
+  module Models
+    type full_text_search_config =
+      {
+        b: Float,
+        case_sensitive: bool,
+        :k1 => Float,
+        language: Turbopuffer::Models::language,
+        max_token_length: Integer,
+        remove_stopwords: bool,
+        stemming: bool,
+        tokenizer: Turbopuffer::Models::tokenizer
+      }
+
+    class FullTextSearchConfig < Turbopuffer::Internal::Type::BaseModel
+      attr_reader b: Float?
+
+      def b=: (Float) -> Float
+
+      attr_reader case_sensitive: bool?
+
+      def case_sensitive=: (bool) -> bool
+
+      attr_reader k1: Float?
+
+      def k1=: (Float) -> Float
+
+      attr_reader language: Turbopuffer::Models::language?
+
+      def language=: (
+        Turbopuffer::Models::language
+      ) -> Turbopuffer::Models::language
+
+      attr_reader max_token_length: Integer?
+
+      def max_token_length=: (Integer) -> Integer
+
+      attr_reader remove_stopwords: bool?
+
+      def remove_stopwords=: (bool) -> bool
+
+      attr_reader stemming: bool?
+
+      def stemming=: (bool) -> bool
+
+      attr_reader tokenizer: Turbopuffer::Models::tokenizer?
+
+      def tokenizer=: (
+        Turbopuffer::Models::tokenizer
+      ) -> Turbopuffer::Models::tokenizer
+
+      def initialize: (
+        ?b: Float,
+        ?case_sensitive: bool,
+        ?k1: Float,
+        ?language: Turbopuffer::Models::language,
+        ?max_token_length: Integer,
+        ?remove_stopwords: bool,
+        ?stemming: bool,
+        ?tokenizer: Turbopuffer::Models::tokenizer
+      ) -> void
+
+      def to_hash: -> {
+        b: Float,
+        case_sensitive: bool,
+        :k1 => Float,
+        language: Turbopuffer::Models::language,
+        max_token_length: Integer,
+        remove_stopwords: bool,
+        stemming: bool,
+        tokenizer: Turbopuffer::Models::tokenizer
+      }
+    end
+  end
+end

data/sig/turbopuffer/models/id.rbs

@@ -0,0 +1,11 @@
+module Turbopuffer
+  module Models
+    type id = String | Integer
+
+    module ID
+      extend Turbopuffer::Internal::Type::Union
+
+      def self?.variants: -> ::Array[Turbopuffer::Models::id]
+    end
+  end
+end

data/sig/turbopuffer/models/include_attributes.rbs

@@ -0,0 +1,13 @@
+module Turbopuffer
+  module Models
+    type include_attributes = bool | ::Array[String]
+
+    module IncludeAttributes
+      extend Turbopuffer::Internal::Type::Union
+
+      def self?.variants: -> ::Array[Turbopuffer::Models::include_attributes]
+
+      StringArray: Turbopuffer::Internal::Type::Converter
+    end
+  end
+end

data/sig/turbopuffer/models/language.rbs

@@ -0,0 +1,48 @@
+module Turbopuffer
+  module Models
+    type language =
+      :arabic
+      | :danish
+      | :dutch
+      | :english
+      | :finnish
+      | :french
+      | :german
+      | :greek
+      | :hungarian
+      | :italian
+      | :norwegian
+      | :portuguese
+      | :romanian
+      | :russian
+      | :spanish
+      | :swedish
+      | :tamil
+      | :turkish
+
+    module Language
+      extend Turbopuffer::Internal::Type::Enum
+
+      ARABIC: :arabic
+      DANISH: :danish
+      DUTCH: :dutch
+      ENGLISH: :english
+      FINNISH: :finnish
+      FRENCH: :french
+      GERMAN: :german
+      GREEK: :greek
+      HUNGARIAN: :hungarian
+      ITALIAN: :italian
+      NORWEGIAN: :norwegian
+      PORTUGUESE: :portuguese
+      ROMANIAN: :romanian
+      RUSSIAN: :russian
+      SPANISH: :spanish
+      SWEDISH: :swedish
+      TAMIL: :tamil
+      TURKISH: :turkish
+
+      def self?.values: -> ::Array[Turbopuffer::Models::language]
+    end
+  end
+end

data/sig/turbopuffer/models/namespace_delete_all_params.rbs

@@ -0,0 +1,25 @@
+module Turbopuffer
+  module Models
+    type namespace_delete_all_params =
+      { namespace: String } & Turbopuffer::Internal::Type::request_parameters
+
+    class NamespaceDeleteAllParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      attr_reader namespace: String?
+
+      def namespace=: (String) -> String
+
+      def initialize: (
+        ?namespace: String,
+        ?request_options: Turbopuffer::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        namespace: String,
+        request_options: Turbopuffer::RequestOptions
+      }
+    end
+  end
+end

data/sig/turbopuffer/models/namespace_delete_all_response.rbs

@@ -0,0 +1,13 @@
+module Turbopuffer
+  module Models
+    type namespace_delete_all_response = { status: :OK }
+
+    class NamespaceDeleteAllResponse < Turbopuffer::Internal::Type::BaseModel
+      attr_accessor status: :OK
+
+      def initialize: (?status: :OK) -> void
+
+      def to_hash: -> { status: :OK }
+    end
+  end
+end

data/sig/turbopuffer/models/namespace_explain_query_params.rbs

@@ -0,0 +1,141 @@
+module Turbopuffer
+  module Models
+    type namespace_explain_query_params =
+      {
+        namespace: String,
+        aggregate_by: ::Hash[Symbol, top],
+        consistency: Turbopuffer::NamespaceExplainQueryParams::Consistency,
+        distance_metric: Turbopuffer::Models::distance_metric,
+        exclude_attributes: ::Array[String],
+        filters: top,
+        group_by: ::Array[String],
+        include_attributes: Turbopuffer::Models::include_attributes,
+        rank_by: top,
+        top_k: Integer,
+        vector_encoding: Turbopuffer::Models::vector_encoding
+      }
+      & Turbopuffer::Internal::Type::request_parameters
+
+    class NamespaceExplainQueryParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      attr_reader namespace: String?
+
+      def namespace=: (String) -> String
+
+      attr_reader aggregate_by: ::Hash[Symbol, top]?
+
+      def aggregate_by=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      attr_reader consistency: Turbopuffer::NamespaceExplainQueryParams::Consistency?
+
+      def consistency=: (
+        Turbopuffer::NamespaceExplainQueryParams::Consistency
+      ) -> Turbopuffer::NamespaceExplainQueryParams::Consistency
+
+      attr_reader distance_metric: Turbopuffer::Models::distance_metric?
+
+      def distance_metric=: (
+        Turbopuffer::Models::distance_metric
+      ) -> Turbopuffer::Models::distance_metric
+
+      attr_reader exclude_attributes: ::Array[String]?
+
+      def exclude_attributes=: (::Array[String]) -> ::Array[String]
+
+      attr_reader filters: top?
+
+      def filters=: (top) -> top
+
+      attr_reader group_by: ::Array[String]?
+
+      def group_by=: (::Array[String]) -> ::Array[String]
+
+      attr_reader include_attributes: Turbopuffer::Models::include_attributes?
+
+      def include_attributes=: (
+        Turbopuffer::Models::include_attributes
+      ) -> Turbopuffer::Models::include_attributes
+
+      attr_reader rank_by: top?
+
+      def rank_by=: (top) -> top
+
+      attr_reader top_k: Integer?
+
+      def top_k=: (Integer) -> Integer
+
+      attr_reader vector_encoding: Turbopuffer::Models::vector_encoding?
+
+      def vector_encoding=: (
+        Turbopuffer::Models::vector_encoding
+      ) -> Turbopuffer::Models::vector_encoding
+
+      def initialize: (
+        ?namespace: String,
+        ?aggregate_by: ::Hash[Symbol, top],
+        ?consistency: Turbopuffer::NamespaceExplainQueryParams::Consistency,
+        ?distance_metric: Turbopuffer::Models::distance_metric,
+        ?exclude_attributes: ::Array[String],
+        ?filters: top,
+        ?group_by: ::Array[String],
+        ?include_attributes: Turbopuffer::Models::include_attributes,
+        ?rank_by: top,
+        ?top_k: Integer,
+        ?vector_encoding: Turbopuffer::Models::vector_encoding,
+        ?request_options: Turbopuffer::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        namespace: String,
+        aggregate_by: ::Hash[Symbol, top],
+        consistency: Turbopuffer::NamespaceExplainQueryParams::Consistency,
+        distance_metric: Turbopuffer::Models::distance_metric,
+        exclude_attributes: ::Array[String],
+        filters: top,
+        group_by: ::Array[String],
+        include_attributes: Turbopuffer::Models::include_attributes,
+        rank_by: top,
+        top_k: Integer,
+        vector_encoding: Turbopuffer::Models::vector_encoding,
+        request_options: Turbopuffer::RequestOptions
+      }
+
+      type consistency =
+        {
+          level: Turbopuffer::Models::NamespaceExplainQueryParams::Consistency::level
+        }
+
+      class Consistency < Turbopuffer::Internal::Type::BaseModel
+        attr_reader level: Turbopuffer::Models::NamespaceExplainQueryParams::Consistency::level?
+
+        def level=: (
+          Turbopuffer::Models::NamespaceExplainQueryParams::Consistency::level
+        ) -> Turbopuffer::Models::NamespaceExplainQueryParams::Consistency::level
+
+        def initialize: (
+          ?level: Turbopuffer::Models::NamespaceExplainQueryParams::Consistency::level
+        ) -> void
+
+        def to_hash: -> {
+          level: Turbopuffer::Models::NamespaceExplainQueryParams::Consistency::level
+        }
+
+        type level = :strong | :eventual
+
+        module Level
+          extend Turbopuffer::Internal::Type::Enum
+
+          # Strong consistency. Requires a round-trip to object storage to fetch the latest writes.
+          STRONG: :strong
+
+          # Eventual consistency. Does not require a round-trip to object storage, but may not see the latest writes.
+          EVENTUAL: :eventual
+
+          def self?.values: -> ::Array[Turbopuffer::Models::NamespaceExplainQueryParams::Consistency::level]
+        end
+      end
+    end
+  end
+end

data/sig/turbopuffer/models/namespace_explain_query_response.rbs

@@ -0,0 +1,15 @@
+module Turbopuffer
+  module Models
+    type namespace_explain_query_response = { plan_text: String }
+
+    class NamespaceExplainQueryResponse < Turbopuffer::Internal::Type::BaseModel
+      attr_reader plan_text: String?
+
+      def plan_text=: (String) -> String
+
+      def initialize: (?plan_text: String) -> void
+
+      def to_hash: -> { plan_text: String }
+    end
+  end
+end

data/sig/turbopuffer/models/namespace_hint_cache_warm_params.rbs

@@ -0,0 +1,25 @@
+module Turbopuffer
+  module Models
+    type namespace_hint_cache_warm_params =
+      { namespace: String } & Turbopuffer::Internal::Type::request_parameters
+
+    class NamespaceHintCacheWarmParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      attr_reader namespace: String?
+
+      def namespace=: (String) -> String
+
+      def initialize: (
+        ?namespace: String,
+        ?request_options: Turbopuffer::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        namespace: String,
+        request_options: Turbopuffer::RequestOptions
+      }
+    end
+  end
+end

data/sig/turbopuffer/models/namespace_hint_cache_warm_response.rbs

@@ -0,0 +1,18 @@
+module Turbopuffer
+  module Models
+    type namespace_hint_cache_warm_response =
+      { status: :ACCEPTED, message: String }
+
+    class NamespaceHintCacheWarmResponse < Turbopuffer::Internal::Type::BaseModel
+      attr_accessor status: :ACCEPTED
+
+      attr_reader message: String?
+
+      def message=: (String) -> String
+
+      def initialize: (?message: String, ?status: :ACCEPTED) -> void
+
+      def to_hash: -> { status: :ACCEPTED, message: String }
+    end
+  end
+end

data/sig/turbopuffer/models/namespace_metadata.rbs

@@ -0,0 +1,35 @@
+module Turbopuffer
+  module Models
+    type namespace_metadata =
+      {
+        approx_logical_bytes: Integer,
+        approx_row_count: Integer,
+        created_at: Time,
+        schema: ::Hash[Symbol, Turbopuffer::AttributeSchemaConfig]
+      }
+
+    class NamespaceMetadata < Turbopuffer::Internal::Type::BaseModel
+      attr_accessor approx_logical_bytes: Integer
+
+      attr_accessor approx_row_count: Integer
+
+      attr_accessor created_at: Time
+
+      attr_accessor schema: ::Hash[Symbol, Turbopuffer::AttributeSchemaConfig]
+
+      def initialize: (
+        approx_logical_bytes: Integer,
+        approx_row_count: Integer,
+        created_at: Time,
+        schema: ::Hash[Symbol, Turbopuffer::AttributeSchemaConfig]
+      ) -> void
+
+      def to_hash: -> {
+        approx_logical_bytes: Integer,
+        approx_row_count: Integer,
+        created_at: Time,
+        schema: ::Hash[Symbol, Turbopuffer::AttributeSchemaConfig]
+      }
+    end
+  end
+end

data/sig/turbopuffer/models/namespace_metadata_params.rbs

@@ -0,0 +1,25 @@
+module Turbopuffer
+  module Models
+    type namespace_metadata_params =
+      { namespace: String } & Turbopuffer::Internal::Type::request_parameters
+
+    class NamespaceMetadataParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      attr_reader namespace: String?
+
+      def namespace=: (String) -> String
+
+      def initialize: (
+        ?namespace: String,
+        ?request_options: Turbopuffer::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        namespace: String,
+        request_options: Turbopuffer::RequestOptions
+      }
+    end
+  end
+end