turbopuffer 0.1.0 → 1.3.0

data/sig/turbopuffer/models/namespace_write_params.rbs

@@ -0,0 +1,156 @@
+module Turbopuffer
+  module Models
+    type namespace_write_params =
+      {
+        namespace: String,
+        copy_from_namespace: String,
+        delete_by_filter: top,
+        delete_condition: top,
+        deletes: ::Array[Turbopuffer::Models::id],
+        distance_metric: Turbopuffer::Models::distance_metric,
+        encryption: Turbopuffer::NamespaceWriteParams::Encryption,
+        patch_columns: Turbopuffer::Columns,
+        patch_condition: top,
+        patch_rows: ::Array[Turbopuffer::Row],
+        schema: ::Hash[Symbol, Turbopuffer::Models::attribute_schema],
+        upsert_columns: Turbopuffer::Columns,
+        upsert_condition: top,
+        upsert_rows: ::Array[Turbopuffer::Row]
+      }
+      & Turbopuffer::Internal::Type::request_parameters
+
+    class NamespaceWriteParams < 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 copy_from_namespace: String?
+
+      def copy_from_namespace=: (String) -> String
+
+      attr_reader delete_by_filter: top?
+
+      def delete_by_filter=: (top) -> top
+
+      attr_reader delete_condition: top?
+
+      def delete_condition=: (top) -> top
+
+      attr_reader deletes: ::Array[Turbopuffer::Models::id]?
+
+      def deletes=: (
+        ::Array[Turbopuffer::Models::id]
+      ) -> ::Array[Turbopuffer::Models::id]
+
+      attr_reader distance_metric: Turbopuffer::Models::distance_metric?
+
+      def distance_metric=: (
+        Turbopuffer::Models::distance_metric
+      ) -> Turbopuffer::Models::distance_metric
+
+      attr_reader encryption: Turbopuffer::NamespaceWriteParams::Encryption?
+
+      def encryption=: (
+        Turbopuffer::NamespaceWriteParams::Encryption
+      ) -> Turbopuffer::NamespaceWriteParams::Encryption
+
+      attr_reader patch_columns: Turbopuffer::Columns?
+
+      def patch_columns=: (Turbopuffer::Columns) -> Turbopuffer::Columns
+
+      attr_reader patch_condition: top?
+
+      def patch_condition=: (top) -> top
+
+      attr_reader patch_rows: ::Array[Turbopuffer::Row]?
+
+      def patch_rows=: (::Array[Turbopuffer::Row]) -> ::Array[Turbopuffer::Row]
+
+      attr_reader schema: ::Hash[Symbol, Turbopuffer::Models::attribute_schema]?
+
+      def schema=: (
+        ::Hash[Symbol, Turbopuffer::Models::attribute_schema]
+      ) -> ::Hash[Symbol, Turbopuffer::Models::attribute_schema]
+
+      attr_reader upsert_columns: Turbopuffer::Columns?
+
+      def upsert_columns=: (Turbopuffer::Columns) -> Turbopuffer::Columns
+
+      attr_reader upsert_condition: top?
+
+      def upsert_condition=: (top) -> top
+
+      attr_reader upsert_rows: ::Array[Turbopuffer::Row]?
+
+      def upsert_rows=: (::Array[Turbopuffer::Row]) -> ::Array[Turbopuffer::Row]
+
+      def initialize: (
+        ?namespace: String,
+        ?copy_from_namespace: String,
+        ?delete_by_filter: top,
+        ?delete_condition: top,
+        ?deletes: ::Array[Turbopuffer::Models::id],
+        ?distance_metric: Turbopuffer::Models::distance_metric,
+        ?encryption: Turbopuffer::NamespaceWriteParams::Encryption,
+        ?patch_columns: Turbopuffer::Columns,
+        ?patch_condition: top,
+        ?patch_rows: ::Array[Turbopuffer::Row],
+        ?schema: ::Hash[Symbol, Turbopuffer::Models::attribute_schema],
+        ?upsert_columns: Turbopuffer::Columns,
+        ?upsert_condition: top,
+        ?upsert_rows: ::Array[Turbopuffer::Row],
+        ?request_options: Turbopuffer::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        namespace: String,
+        copy_from_namespace: String,
+        delete_by_filter: top,
+        delete_condition: top,
+        deletes: ::Array[Turbopuffer::Models::id],
+        distance_metric: Turbopuffer::Models::distance_metric,
+        encryption: Turbopuffer::NamespaceWriteParams::Encryption,
+        patch_columns: Turbopuffer::Columns,
+        patch_condition: top,
+        patch_rows: ::Array[Turbopuffer::Row],
+        schema: ::Hash[Symbol, Turbopuffer::Models::attribute_schema],
+        upsert_columns: Turbopuffer::Columns,
+        upsert_condition: top,
+        upsert_rows: ::Array[Turbopuffer::Row],
+        request_options: Turbopuffer::RequestOptions
+      }
+
+      type encryption =
+        { cmek: Turbopuffer::NamespaceWriteParams::Encryption::Cmek }
+
+      class Encryption < Turbopuffer::Internal::Type::BaseModel
+        attr_reader cmek: Turbopuffer::NamespaceWriteParams::Encryption::Cmek?
+
+        def cmek=: (
+          Turbopuffer::NamespaceWriteParams::Encryption::Cmek
+        ) -> Turbopuffer::NamespaceWriteParams::Encryption::Cmek
+
+        def initialize: (
+          ?cmek: Turbopuffer::NamespaceWriteParams::Encryption::Cmek
+        ) -> void
+
+        def to_hash: -> {
+          cmek: Turbopuffer::NamespaceWriteParams::Encryption::Cmek
+        }
+
+        type cmek = { key_name: String }
+
+        class Cmek < Turbopuffer::Internal::Type::BaseModel
+          attr_accessor key_name: String
+
+          def initialize: (key_name: String) -> void
+
+          def to_hash: -> { key_name: String }
+        end
+      end
+    end
+  end
+end

data/sig/turbopuffer/models/namespace_write_response.rbs

@@ -0,0 +1,56 @@
+module Turbopuffer
+  module Models
+    type namespace_write_response =
+      {
+        billing: Turbopuffer::WriteBilling,
+        message: String,
+        rows_affected: Integer,
+        status: :OK,
+        rows_deleted: Integer,
+        rows_patched: Integer,
+        rows_upserted: Integer
+      }
+
+    class NamespaceWriteResponse < Turbopuffer::Internal::Type::BaseModel
+      attr_accessor billing: Turbopuffer::WriteBilling
+
+      attr_accessor message: String
+
+      attr_accessor rows_affected: Integer
+
+      attr_accessor status: :OK
+
+      attr_reader rows_deleted: Integer?
+
+      def rows_deleted=: (Integer) -> Integer
+
+      attr_reader rows_patched: Integer?
+
+      def rows_patched=: (Integer) -> Integer
+
+      attr_reader rows_upserted: Integer?
+
+      def rows_upserted=: (Integer) -> Integer
+
+      def initialize: (
+        billing: Turbopuffer::WriteBilling,
+        message: String,
+        rows_affected: Integer,
+        ?rows_deleted: Integer,
+        ?rows_patched: Integer,
+        ?rows_upserted: Integer,
+        ?status: :OK
+      ) -> void
+
+      def to_hash: -> {
+        billing: Turbopuffer::WriteBilling,
+        message: String,
+        rows_affected: Integer,
+        status: :OK,
+        rows_deleted: Integer,
+        rows_patched: Integer,
+        rows_upserted: Integer
+      }
+    end
+  end
+end

data/sig/turbopuffer/models/query.rbs

@@ -0,0 +1,75 @@
+module Turbopuffer
+  module Models
+    type query =
+      {
+        aggregate_by: ::Hash[Symbol, top],
+        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
+      }
+
+    class Query < Turbopuffer::Internal::Type::BaseModel
+      attr_reader aggregate_by: ::Hash[Symbol, top]?
+
+      def aggregate_by=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      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
+
+      def initialize: (
+        ?aggregate_by: ::Hash[Symbol, top],
+        ?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
+      ) -> void
+
+      def to_hash: -> {
+        aggregate_by: ::Hash[Symbol, top],
+        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
+      }
+    end
+  end
+end

data/sig/turbopuffer/models/query_billing.rbs

@@ -0,0 +1,25 @@
+module Turbopuffer
+  module Models
+    type query_billing =
+      {
+        billable_logical_bytes_queried: Integer,
+        billable_logical_bytes_returned: Integer
+      }
+
+    class QueryBilling < Turbopuffer::Internal::Type::BaseModel
+      attr_accessor billable_logical_bytes_queried: Integer
+
+      attr_accessor billable_logical_bytes_returned: Integer
+
+      def initialize: (
+        billable_logical_bytes_queried: Integer,
+        billable_logical_bytes_returned: Integer
+      ) -> void
+
+      def to_hash: -> {
+        billable_logical_bytes_queried: Integer,
+        billable_logical_bytes_returned: Integer
+      }
+    end
+  end
+end

data/sig/turbopuffer/models/query_performance.rbs

@@ -0,0 +1,45 @@
+module Turbopuffer
+  module Models
+    type query_performance =
+      {
+        approx_namespace_size: Integer,
+        cache_hit_ratio: Float,
+        cache_temperature: String,
+        exhaustive_search_count: Integer,
+        query_execution_ms: Integer,
+        server_total_ms: Integer
+      }
+
+    class QueryPerformance < Turbopuffer::Internal::Type::BaseModel
+      attr_accessor approx_namespace_size: Integer
+
+      attr_accessor cache_hit_ratio: Float
+
+      attr_accessor cache_temperature: String
+
+      attr_accessor exhaustive_search_count: Integer
+
+      attr_accessor query_execution_ms: Integer
+
+      attr_accessor server_total_ms: Integer
+
+      def initialize: (
+        approx_namespace_size: Integer,
+        cache_hit_ratio: Float,
+        cache_temperature: String,
+        exhaustive_search_count: Integer,
+        query_execution_ms: Integer,
+        server_total_ms: Integer
+      ) -> void
+
+      def to_hash: -> {
+        approx_namespace_size: Integer,
+        cache_hit_ratio: Float,
+        cache_temperature: String,
+        exhaustive_search_count: Integer,
+        query_execution_ms: Integer,
+        server_total_ms: Integer
+      }
+    end
+  end
+end

data/sig/turbopuffer/models/row.rbs

@@ -0,0 +1,24 @@
+module Turbopuffer
+  module Models
+    type row =
+      { id: Turbopuffer::Models::id, vector: Turbopuffer::Models::vector }
+
+    class Row < Turbopuffer::Internal::Type::BaseModel
+      attr_accessor id: Turbopuffer::Models::id
+
+      attr_reader vector: Turbopuffer::Models::vector?
+
+      def vector=: (Turbopuffer::Models::vector) -> Turbopuffer::Models::vector
+
+      def initialize: (
+        id: Turbopuffer::Models::id,
+        ?vector: Turbopuffer::Models::vector
+      ) -> void
+
+      def to_hash: -> {
+        id: Turbopuffer::Models::id,
+        vector: Turbopuffer::Models::vector
+      }
+    end
+  end
+end

data/sig/turbopuffer/models/tokenizer.rbs

@@ -0,0 +1,16 @@
+module Turbopuffer
+  module Models
+    type tokenizer = :pre_tokenized_array | :word_v0 | :word_v1 | :word_v2
+
+    module Tokenizer
+      extend Turbopuffer::Internal::Type::Enum
+
+      PRE_TOKENIZED_ARRAY: :pre_tokenized_array
+      WORD_V0: :word_v0
+      WORD_V1: :word_v1
+      WORD_V2: :word_v2
+
+      def self?.values: -> ::Array[Turbopuffer::Models::tokenizer]
+    end
+  end
+end

data/sig/turbopuffer/models/vector.rbs

@@ -0,0 +1,13 @@
+module Turbopuffer
+  module Models
+    type vector = ::Array[Float] | String
+
+    module Vector
+      extend Turbopuffer::Internal::Type::Union
+
+      def self?.variants: -> ::Array[Turbopuffer::Models::vector]
+
+      FloatArray: Turbopuffer::Internal::Type::Converter
+    end
+  end
+end

data/sig/turbopuffer/models/vector_encoding.rbs

@@ -0,0 +1,14 @@
+module Turbopuffer
+  module Models
+    type vector_encoding = :float | :base64
+
+    module VectorEncoding
+      extend Turbopuffer::Internal::Type::Enum
+
+      FLOAT: :float
+      BASE64: :base64
+
+      def self?.values: -> ::Array[Turbopuffer::Models::vector_encoding]
+    end
+  end
+end

data/sig/turbopuffer/models/write_billing.rbs

@@ -0,0 +1,27 @@
+module Turbopuffer
+  module Models
+    type write_billing =
+      {
+        billable_logical_bytes_written: Integer,
+        query: Turbopuffer::QueryBilling
+      }
+
+    class WriteBilling < Turbopuffer::Internal::Type::BaseModel
+      attr_accessor billable_logical_bytes_written: Integer
+
+      attr_reader query: Turbopuffer::QueryBilling?
+
+      def query=: (Turbopuffer::QueryBilling) -> Turbopuffer::QueryBilling
+
+      def initialize: (
+        billable_logical_bytes_written: Integer,
+        ?query: Turbopuffer::QueryBilling
+      ) -> void
+
+      def to_hash: -> {
+        billable_logical_bytes_written: Integer,
+        query: Turbopuffer::QueryBilling
+      }
+    end
+  end
+end

data/sig/turbopuffer/models.rbs

@@ -0,0 +1,69 @@
+module Turbopuffer
+  AggregationGroup: Turbopuffer::Internal::Type::Converter
+
+  module AttributeSchema = Turbopuffer::Models::AttributeSchema
+
+  class AttributeSchemaConfig = Turbopuffer::Models::AttributeSchemaConfig
+
+  class AttributeType = Turbopuffer::Models::AttributeType
+
+  class Bm25ClauseParams = Turbopuffer::Models::Bm25ClauseParams
+
+  class ClientNamespacesParams = Turbopuffer::Models::ClientNamespacesParams
+
+  class Columns = Turbopuffer::Models::Columns
+
+  class ContainsAllTokensFilterParams = Turbopuffer::Models::ContainsAllTokensFilterParams
+
+  module DistanceMetric = Turbopuffer::Models::DistanceMetric
+
+  module FullTextSearch = Turbopuffer::Models::FullTextSearch
+
+  class FullTextSearchConfig = Turbopuffer::Models::FullTextSearchConfig
+
+  module ID = Turbopuffer::Models::ID
+
+  module IncludeAttributes = Turbopuffer::Models::IncludeAttributes
+
+  module Language = Turbopuffer::Models::Language
+
+  class NamespaceDeleteAllParams = Turbopuffer::Models::NamespaceDeleteAllParams
+
+  class NamespaceExplainQueryParams = Turbopuffer::Models::NamespaceExplainQueryParams
+
+  class NamespaceHintCacheWarmParams = Turbopuffer::Models::NamespaceHintCacheWarmParams
+
+  class NamespaceMetadata = Turbopuffer::Models::NamespaceMetadata
+
+  class NamespaceMetadataParams = Turbopuffer::Models::NamespaceMetadataParams
+
+  class NamespaceMultiQueryParams = Turbopuffer::Models::NamespaceMultiQueryParams
+
+  class NamespaceQueryParams = Turbopuffer::Models::NamespaceQueryParams
+
+  class NamespaceRecallParams = Turbopuffer::Models::NamespaceRecallParams
+
+  class NamespaceSchemaParams = Turbopuffer::Models::NamespaceSchemaParams
+
+  class NamespaceSummary = Turbopuffer::Models::NamespaceSummary
+
+  class NamespaceUpdateSchemaParams = Turbopuffer::Models::NamespaceUpdateSchemaParams
+
+  class NamespaceWriteParams = Turbopuffer::Models::NamespaceWriteParams
+
+  class Query = Turbopuffer::Models::Query
+
+  class QueryBilling = Turbopuffer::Models::QueryBilling
+
+  class QueryPerformance = Turbopuffer::Models::QueryPerformance
+
+  class Row = Turbopuffer::Models::Row
+
+  module Tokenizer = Turbopuffer::Models::Tokenizer
+
+  module Vector = Turbopuffer::Models::Vector
+
+  module VectorEncoding = Turbopuffer::Models::VectorEncoding
+
+  class WriteBilling = Turbopuffer::Models::WriteBilling
+end

data/sig/turbopuffer/namespace.rbs

@@ -0,0 +1,5 @@
+module Turbopuffer
+  class Namespace < Turbopuffer::Resources::Namespaces
+    attr_reader id: String
+  end
+end

data/sig/turbopuffer/request_options.rbs

@@ -0,0 +1,36 @@
+module Turbopuffer
+  type request_opts =
+    Turbopuffer::RequestOptions
+    | Turbopuffer::request_options
+    | ::Hash[Symbol, top]
+
+  type request_options =
+    {
+      idempotency_key: String?,
+      extra_query: ::Hash[String, (::Array[String] | String)?]?,
+      extra_headers: ::Hash[String, String?]?,
+      extra_body: top?,
+      max_retries: Integer?,
+      timeout: Float?
+    }
+
+  class RequestOptions < Turbopuffer::Internal::Type::BaseModel
+    def self.validate!: (Turbopuffer::request_opts opts) -> void
+
+    attr_accessor idempotency_key: String?
+
+    attr_accessor extra_query: ::Hash[String, (::Array[String] | String)?]?
+
+    attr_accessor extra_headers: ::Hash[String, String?]?
+
+    attr_accessor extra_body: top?
+
+    attr_accessor max_retries: Integer?
+
+    attr_accessor timeout: Float?
+
+    def initialize: (
+      ?Turbopuffer::request_options | ::Hash[Symbol, top] values
+    ) -> void
+  end
+end

data/sig/turbopuffer/resources/namespaces.rbs

@@ -0,0 +1,99 @@
+module Turbopuffer
+  module Resources
+    class Namespaces
+      def delete_all: (
+        ?namespace: String,
+        ?request_options: Turbopuffer::request_opts
+      ) -> Turbopuffer::Models::NamespaceDeleteAllResponse
+
+      def explain_query: (
+        ?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
+      ) -> Turbopuffer::Models::NamespaceExplainQueryResponse
+
+      def hint_cache_warm: (
+        ?namespace: String,
+        ?request_options: Turbopuffer::request_opts
+      ) -> Turbopuffer::Models::NamespaceHintCacheWarmResponse
+
+      def metadata: (
+        ?namespace: String,
+        ?request_options: Turbopuffer::request_opts
+      ) -> Turbopuffer::NamespaceMetadata
+
+      def multi_query: (
+        queries: ::Array[Turbopuffer::Query],
+        ?namespace: String,
+        ?consistency: Turbopuffer::NamespaceMultiQueryParams::Consistency,
+        ?vector_encoding: Turbopuffer::Models::vector_encoding,
+        ?request_options: Turbopuffer::request_opts
+      ) -> Turbopuffer::Models::NamespaceMultiQueryResponse
+
+      def query: (
+        ?namespace: String,
+        ?aggregate_by: ::Hash[Symbol, top],
+        ?consistency: Turbopuffer::NamespaceQueryParams::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
+      ) -> Turbopuffer::Models::NamespaceQueryResponse
+
+      def recall: (
+        ?namespace: String,
+        ?filters: top,
+        ?include_ground_truth: bool,
+        ?num: Integer,
+        ?queries: ::Array[Float],
+        ?top_k: Integer,
+        ?request_options: Turbopuffer::request_opts
+      ) -> Turbopuffer::Models::NamespaceRecallResponse
+
+      def schema: (
+        ?namespace: String,
+        ?request_options: Turbopuffer::request_opts
+      ) -> Turbopuffer::Models::namespace_schema_response
+
+      def update_schema: (
+        ?namespace: String,
+        ?schema: ::Hash[Symbol, Turbopuffer::Models::attribute_schema],
+        ?request_options: Turbopuffer::request_opts
+      ) -> Turbopuffer::Models::namespace_update_schema_response
+
+      def write: (
+        ?namespace: String,
+        ?copy_from_namespace: String,
+        ?delete_by_filter: top,
+        ?delete_condition: top,
+        ?deletes: ::Array[Turbopuffer::Models::id],
+        ?distance_metric: Turbopuffer::Models::distance_metric,
+        ?encryption: Turbopuffer::NamespaceWriteParams::Encryption,
+        ?patch_columns: Turbopuffer::Columns,
+        ?patch_condition: top,
+        ?patch_rows: ::Array[Turbopuffer::Row],
+        ?schema: ::Hash[Symbol, Turbopuffer::Models::attribute_schema],
+        ?upsert_columns: Turbopuffer::Columns,
+        ?upsert_condition: top,
+        ?upsert_rows: ::Array[Turbopuffer::Row],
+        ?request_options: Turbopuffer::request_opts
+      ) -> Turbopuffer::Models::NamespaceWriteResponse
+
+      def initialize: (client: Turbopuffer::Client) -> void
+    end
+  end
+end

data/sig/turbopuffer/version.rbs

@@ -0,0 +1,3 @@
+module Turbopuffer
+  VERSION: String
+end