turbopuffer 0.1.0 → 1.3.0

data/sig/turbopuffer/models/namespace_multi_query_params.rbs

@@ -0,0 +1,86 @@
+module Turbopuffer
+  module Models
+    type namespace_multi_query_params =
+      {
+        namespace: String,
+        queries: ::Array[Turbopuffer::Query],
+        consistency: Turbopuffer::NamespaceMultiQueryParams::Consistency,
+        vector_encoding: Turbopuffer::Models::vector_encoding
+      }
+      & Turbopuffer::Internal::Type::request_parameters
+
+    class NamespaceMultiQueryParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      attr_reader namespace: String?
+
+      def namespace=: (String) -> String
+
+      attr_accessor queries: ::Array[Turbopuffer::Query]
+
+      attr_reader consistency: Turbopuffer::NamespaceMultiQueryParams::Consistency?
+
+      def consistency=: (
+        Turbopuffer::NamespaceMultiQueryParams::Consistency
+      ) -> Turbopuffer::NamespaceMultiQueryParams::Consistency
+
+      attr_reader vector_encoding: Turbopuffer::Models::vector_encoding?
+
+      def vector_encoding=: (
+        Turbopuffer::Models::vector_encoding
+      ) -> Turbopuffer::Models::vector_encoding
+
+      def initialize: (
+        queries: ::Array[Turbopuffer::Query],
+        ?namespace: String,
+        ?consistency: Turbopuffer::NamespaceMultiQueryParams::Consistency,
+        ?vector_encoding: Turbopuffer::Models::vector_encoding,
+        ?request_options: Turbopuffer::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        namespace: String,
+        queries: ::Array[Turbopuffer::Query],
+        consistency: Turbopuffer::NamespaceMultiQueryParams::Consistency,
+        vector_encoding: Turbopuffer::Models::vector_encoding,
+        request_options: Turbopuffer::RequestOptions
+      }
+
+      type consistency =
+        {
+          level: Turbopuffer::Models::NamespaceMultiQueryParams::Consistency::level
+        }
+
+      class Consistency < Turbopuffer::Internal::Type::BaseModel
+        attr_reader level: Turbopuffer::Models::NamespaceMultiQueryParams::Consistency::level?
+
+        def level=: (
+          Turbopuffer::Models::NamespaceMultiQueryParams::Consistency::level
+        ) -> Turbopuffer::Models::NamespaceMultiQueryParams::Consistency::level
+
+        def initialize: (
+          ?level: Turbopuffer::Models::NamespaceMultiQueryParams::Consistency::level
+        ) -> void
+
+        def to_hash: -> {
+          level: Turbopuffer::Models::NamespaceMultiQueryParams::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::NamespaceMultiQueryParams::Consistency::level]
+        end
+      end
+    end
+  end
+end

data/sig/turbopuffer/models/namespace_multi_query_response.rbs

@@ -0,0 +1,65 @@
+module Turbopuffer
+  module Models
+    type namespace_multi_query_response =
+      {
+        billing: Turbopuffer::QueryBilling,
+        performance: Turbopuffer::QueryPerformance,
+        results: ::Array[Turbopuffer::Models::NamespaceMultiQueryResponse::Result]
+      }
+
+    class NamespaceMultiQueryResponse < Turbopuffer::Internal::Type::BaseModel
+      attr_accessor billing: Turbopuffer::QueryBilling
+
+      attr_accessor performance: Turbopuffer::QueryPerformance
+
+      attr_accessor results: ::Array[Turbopuffer::Models::NamespaceMultiQueryResponse::Result]
+
+      def initialize: (
+        billing: Turbopuffer::QueryBilling,
+        performance: Turbopuffer::QueryPerformance,
+        results: ::Array[Turbopuffer::Models::NamespaceMultiQueryResponse::Result]
+      ) -> void
+
+      def to_hash: -> {
+        billing: Turbopuffer::QueryBilling,
+        performance: Turbopuffer::QueryPerformance,
+        results: ::Array[Turbopuffer::Models::NamespaceMultiQueryResponse::Result]
+      }
+
+      type result =
+        {
+          aggregation_groups: ::Array[Turbopuffer::Models::aggregation_group],
+          aggregations: ::Hash[Symbol, top],
+          rows: ::Array[Turbopuffer::Row]
+        }
+
+      class Result < Turbopuffer::Internal::Type::BaseModel
+        attr_reader aggregation_groups: ::Array[Turbopuffer::Models::aggregation_group]?
+
+        def aggregation_groups=: (
+          ::Array[Turbopuffer::Models::aggregation_group]
+        ) -> ::Array[Turbopuffer::Models::aggregation_group]
+
+        attr_reader aggregations: ::Hash[Symbol, top]?
+
+        def aggregations=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+        attr_reader rows: ::Array[Turbopuffer::Row]?
+
+        def rows=: (::Array[Turbopuffer::Row]) -> ::Array[Turbopuffer::Row]
+
+        def initialize: (
+          ?aggregation_groups: ::Array[Turbopuffer::Models::aggregation_group],
+          ?aggregations: ::Hash[Symbol, top],
+          ?rows: ::Array[Turbopuffer::Row]
+        ) -> void
+
+        def to_hash: -> {
+          aggregation_groups: ::Array[Turbopuffer::Models::aggregation_group],
+          aggregations: ::Hash[Symbol, top],
+          rows: ::Array[Turbopuffer::Row]
+        }
+      end
+    end
+  end
+end

data/sig/turbopuffer/models/namespace_query_params.rbs

@@ -0,0 +1,139 @@
+module Turbopuffer
+  module Models
+    type namespace_query_params =
+      {
+        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
+      }
+      & Turbopuffer::Internal::Type::request_parameters
+
+    class NamespaceQueryParams < 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::NamespaceQueryParams::Consistency?
+
+      def consistency=: (
+        Turbopuffer::NamespaceQueryParams::Consistency
+      ) -> Turbopuffer::NamespaceQueryParams::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::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
+      ) -> void
+
+      def to_hash: -> {
+        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::RequestOptions
+      }
+
+      type consistency =
+        { level: Turbopuffer::Models::NamespaceQueryParams::Consistency::level }
+
+      class Consistency < Turbopuffer::Internal::Type::BaseModel
+        attr_reader level: Turbopuffer::Models::NamespaceQueryParams::Consistency::level?
+
+        def level=: (
+          Turbopuffer::Models::NamespaceQueryParams::Consistency::level
+        ) -> Turbopuffer::Models::NamespaceQueryParams::Consistency::level
+
+        def initialize: (
+          ?level: Turbopuffer::Models::NamespaceQueryParams::Consistency::level
+        ) -> void
+
+        def to_hash: -> {
+          level: Turbopuffer::Models::NamespaceQueryParams::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::NamespaceQueryParams::Consistency::level]
+        end
+      end
+    end
+  end
+end

data/sig/turbopuffer/models/namespace_query_response.rbs

@@ -0,0 +1,48 @@
+module Turbopuffer
+  module Models
+    type namespace_query_response =
+      {
+        billing: Turbopuffer::QueryBilling,
+        performance: Turbopuffer::QueryPerformance,
+        aggregation_groups: ::Array[Turbopuffer::Models::aggregation_group],
+        aggregations: ::Hash[Symbol, top],
+        rows: ::Array[Turbopuffer::Row]
+      }
+
+    class NamespaceQueryResponse < Turbopuffer::Internal::Type::BaseModel
+      attr_accessor billing: Turbopuffer::QueryBilling
+
+      attr_accessor performance: Turbopuffer::QueryPerformance
+
+      attr_reader aggregation_groups: ::Array[Turbopuffer::Models::aggregation_group]?
+
+      def aggregation_groups=: (
+        ::Array[Turbopuffer::Models::aggregation_group]
+      ) -> ::Array[Turbopuffer::Models::aggregation_group]
+
+      attr_reader aggregations: ::Hash[Symbol, top]?
+
+      def aggregations=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      attr_reader rows: ::Array[Turbopuffer::Row]?
+
+      def rows=: (::Array[Turbopuffer::Row]) -> ::Array[Turbopuffer::Row]
+
+      def initialize: (
+        billing: Turbopuffer::QueryBilling,
+        performance: Turbopuffer::QueryPerformance,
+        ?aggregation_groups: ::Array[Turbopuffer::Models::aggregation_group],
+        ?aggregations: ::Hash[Symbol, top],
+        ?rows: ::Array[Turbopuffer::Row]
+      ) -> void
+
+      def to_hash: -> {
+        billing: Turbopuffer::QueryBilling,
+        performance: Turbopuffer::QueryPerformance,
+        aggregation_groups: ::Array[Turbopuffer::Models::aggregation_group],
+        aggregations: ::Hash[Symbol, top],
+        rows: ::Array[Turbopuffer::Row]
+      }
+    end
+  end
+end

data/sig/turbopuffer/models/namespace_recall_params.rbs

@@ -0,0 +1,63 @@
+module Turbopuffer
+  module Models
+    type namespace_recall_params =
+      {
+        namespace: String,
+        filters: top,
+        include_ground_truth: bool,
+        num: Integer,
+        queries: ::Array[Float],
+        top_k: Integer
+      }
+      & Turbopuffer::Internal::Type::request_parameters
+
+    class NamespaceRecallParams < 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 filters: top?
+
+      def filters=: (top) -> top
+
+      attr_reader include_ground_truth: bool?
+
+      def include_ground_truth=: (bool) -> bool
+
+      attr_reader num: Integer?
+
+      def num=: (Integer) -> Integer
+
+      attr_reader queries: ::Array[Float]?
+
+      def queries=: (::Array[Float]) -> ::Array[Float]
+
+      attr_reader top_k: Integer?
+
+      def top_k=: (Integer) -> Integer
+
+      def initialize: (
+        ?namespace: String,
+        ?filters: top,
+        ?include_ground_truth: bool,
+        ?num: Integer,
+        ?queries: ::Array[Float],
+        ?top_k: Integer,
+        ?request_options: Turbopuffer::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        namespace: String,
+        filters: top,
+        include_ground_truth: bool,
+        num: Integer,
+        queries: ::Array[Float],
+        top_k: Integer,
+        request_options: Turbopuffer::RequestOptions
+      }
+    end
+  end
+end

data/sig/turbopuffer/models/namespace_recall_response.rbs

@@ -0,0 +1,61 @@
+module Turbopuffer
+  module Models
+    type namespace_recall_response =
+      {
+        avg_ann_count: Float,
+        avg_exhaustive_count: Float,
+        avg_recall: Float,
+        ground_truth: ::Array[Turbopuffer::Models::NamespaceRecallResponse::GroundTruth]
+      }
+
+    class NamespaceRecallResponse < Turbopuffer::Internal::Type::BaseModel
+      attr_accessor avg_ann_count: Float
+
+      attr_accessor avg_exhaustive_count: Float
+
+      attr_accessor avg_recall: Float
+
+      attr_reader ground_truth: ::Array[Turbopuffer::Models::NamespaceRecallResponse::GroundTruth]?
+
+      def ground_truth=: (
+        ::Array[Turbopuffer::Models::NamespaceRecallResponse::GroundTruth]
+      ) -> ::Array[Turbopuffer::Models::NamespaceRecallResponse::GroundTruth]
+
+      def initialize: (
+        avg_ann_count: Float,
+        avg_exhaustive_count: Float,
+        avg_recall: Float,
+        ?ground_truth: ::Array[Turbopuffer::Models::NamespaceRecallResponse::GroundTruth]
+      ) -> void
+
+      def to_hash: -> {
+        avg_ann_count: Float,
+        avg_exhaustive_count: Float,
+        avg_recall: Float,
+        ground_truth: ::Array[Turbopuffer::Models::NamespaceRecallResponse::GroundTruth]
+      }
+
+      type ground_truth =
+        {
+          nearest_neighbors: ::Array[Turbopuffer::Row],
+          query_vector: ::Array[Float]
+        }
+
+      class GroundTruth < Turbopuffer::Internal::Type::BaseModel
+        attr_accessor nearest_neighbors: ::Array[Turbopuffer::Row]
+
+        attr_accessor query_vector: ::Array[Float]
+
+        def initialize: (
+          nearest_neighbors: ::Array[Turbopuffer::Row],
+          query_vector: ::Array[Float]
+        ) -> void
+
+        def to_hash: -> {
+          nearest_neighbors: ::Array[Turbopuffer::Row],
+          query_vector: ::Array[Float]
+        }
+      end
+    end
+  end
+end

data/sig/turbopuffer/models/namespace_schema_params.rbs

@@ -0,0 +1,25 @@
+module Turbopuffer
+  module Models
+    type namespace_schema_params =
+      { namespace: String } & Turbopuffer::Internal::Type::request_parameters
+
+    class NamespaceSchemaParams < 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_schema_response.rbs

@@ -0,0 +1,8 @@
+module Turbopuffer
+  module Models
+    type namespace_schema_response =
+      ::Hash[Symbol, Turbopuffer::AttributeSchemaConfig]
+
+    NamespaceSchemaResponse: Turbopuffer::Internal::Type::Converter
+  end
+end

data/sig/turbopuffer/models/namespace_summary.rbs

@@ -0,0 +1,13 @@
+module Turbopuffer
+  module Models
+    type namespace_summary = { id: String }
+
+    class NamespaceSummary < Turbopuffer::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      def initialize: (id: String) -> void
+
+      def to_hash: -> { id: String }
+    end
+  end
+end

data/sig/turbopuffer/models/namespace_update_schema_params.rbs

@@ -0,0 +1,37 @@
+module Turbopuffer
+  module Models
+    type namespace_update_schema_params =
+      {
+        namespace: String,
+        schema: ::Hash[Symbol, Turbopuffer::Models::attribute_schema]
+      }
+      & Turbopuffer::Internal::Type::request_parameters
+
+    class NamespaceUpdateSchemaParams < 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 schema: ::Hash[Symbol, Turbopuffer::Models::attribute_schema]?
+
+      def schema=: (
+        ::Hash[Symbol, Turbopuffer::Models::attribute_schema]
+      ) -> ::Hash[Symbol, Turbopuffer::Models::attribute_schema]
+
+      def initialize: (
+        ?namespace: String,
+        ?schema: ::Hash[Symbol, Turbopuffer::Models::attribute_schema],
+        ?request_options: Turbopuffer::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        namespace: String,
+        schema: ::Hash[Symbol, Turbopuffer::Models::attribute_schema],
+        request_options: Turbopuffer::RequestOptions
+      }
+    end
+  end
+end

data/sig/turbopuffer/models/namespace_update_schema_response.rbs

@@ -0,0 +1,8 @@
+module Turbopuffer
+  module Models
+    type namespace_update_schema_response =
+      ::Hash[Symbol, Turbopuffer::AttributeSchemaConfig]
+
+    NamespaceUpdateSchemaResponse: Turbopuffer::Internal::Type::Converter
+  end
+end