turbopuffer 0.1.0 → 1.3.0

data/rbi/turbopuffer/models/namespace_explain_query_params.rbi

@@ -0,0 +1,273 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class NamespaceExplainQueryParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Turbopuffer::NamespaceExplainQueryParams,
+            Turbopuffer::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :namespace
+
+      sig { params(namespace: String).void }
+      attr_writer :namespace
+
+      # Aggregations to compute over all documents in the namespace that match the
+      # filters.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_reader :aggregate_by
+
+      sig { params(aggregate_by: T::Hash[Symbol, T.anything]).void }
+      attr_writer :aggregate_by
+
+      # The consistency level for a query.
+      sig do
+        returns(
+          T.nilable(Turbopuffer::NamespaceExplainQueryParams::Consistency)
+        )
+      end
+      attr_reader :consistency
+
+      sig do
+        params(
+          consistency:
+            Turbopuffer::NamespaceExplainQueryParams::Consistency::OrHash
+        ).void
+      end
+      attr_writer :consistency
+
+      # A function used to calculate vector similarity.
+      sig { returns(T.nilable(Turbopuffer::DistanceMetric::OrSymbol)) }
+      attr_reader :distance_metric
+
+      sig do
+        params(distance_metric: Turbopuffer::DistanceMetric::OrSymbol).void
+      end
+      attr_writer :distance_metric
+
+      # List of attribute names to exclude from the response. All other attributes will
+      # be included in the response.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :exclude_attributes
+
+      sig { params(exclude_attributes: T::Array[String]).void }
+      attr_writer :exclude_attributes
+
+      # Exact filters for attributes to refine search results for. Think of it as a SQL
+      # WHERE clause.
+      sig { returns(T.nilable(T.anything)) }
+      attr_reader :filters
+
+      sig { params(filters: T.anything).void }
+      attr_writer :filters
+
+      # Groups documents by the specified attributes (the "group key") before computing
+      # aggregates. Aggregates are computed separately for each group.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :group_by
+
+      sig { params(group_by: T::Array[String]).void }
+      attr_writer :group_by
+
+      # Whether to include attributes in the response.
+      sig { returns(T.nilable(Turbopuffer::IncludeAttributes::Variants)) }
+      attr_reader :include_attributes
+
+      sig do
+        params(
+          include_attributes: Turbopuffer::IncludeAttributes::Variants
+        ).void
+      end
+      attr_writer :include_attributes
+
+      # How to rank the documents in the namespace.
+      sig { returns(T.nilable(T.anything)) }
+      attr_reader :rank_by
+
+      sig { params(rank_by: T.anything).void }
+      attr_writer :rank_by
+
+      # The number of results to return.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :top_k
+
+      sig { params(top_k: Integer).void }
+      attr_writer :top_k
+
+      # The encoding to use for vectors in the response.
+      sig { returns(T.nilable(Turbopuffer::VectorEncoding::OrSymbol)) }
+      attr_reader :vector_encoding
+
+      sig do
+        params(vector_encoding: Turbopuffer::VectorEncoding::OrSymbol).void
+      end
+      attr_writer :vector_encoding
+
+      sig do
+        params(
+          namespace: String,
+          aggregate_by: T::Hash[Symbol, T.anything],
+          consistency:
+            Turbopuffer::NamespaceExplainQueryParams::Consistency::OrHash,
+          distance_metric: Turbopuffer::DistanceMetric::OrSymbol,
+          exclude_attributes: T::Array[String],
+          filters: T.anything,
+          group_by: T::Array[String],
+          include_attributes: Turbopuffer::IncludeAttributes::Variants,
+          rank_by: T.anything,
+          top_k: Integer,
+          vector_encoding: Turbopuffer::VectorEncoding::OrSymbol,
+          request_options: Turbopuffer::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        namespace: nil,
+        # Aggregations to compute over all documents in the namespace that match the
+        # filters.
+        aggregate_by: nil,
+        # The consistency level for a query.
+        consistency: nil,
+        # A function used to calculate vector similarity.
+        distance_metric: nil,
+        # List of attribute names to exclude from the response. All other attributes will
+        # be included in the response.
+        exclude_attributes: nil,
+        # Exact filters for attributes to refine search results for. Think of it as a SQL
+        # WHERE clause.
+        filters: nil,
+        # Groups documents by the specified attributes (the "group key") before computing
+        # aggregates. Aggregates are computed separately for each group.
+        group_by: nil,
+        # Whether to include attributes in the response.
+        include_attributes: nil,
+        # How to rank the documents in the namespace.
+        rank_by: nil,
+        # The number of results to return.
+        top_k: nil,
+        # The encoding to use for vectors in the response.
+        vector_encoding: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            namespace: String,
+            aggregate_by: T::Hash[Symbol, T.anything],
+            consistency: Turbopuffer::NamespaceExplainQueryParams::Consistency,
+            distance_metric: Turbopuffer::DistanceMetric::OrSymbol,
+            exclude_attributes: T::Array[String],
+            filters: T.anything,
+            group_by: T::Array[String],
+            include_attributes: Turbopuffer::IncludeAttributes::Variants,
+            rank_by: T.anything,
+            top_k: Integer,
+            vector_encoding: Turbopuffer::VectorEncoding::OrSymbol,
+            request_options: Turbopuffer::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Consistency < Turbopuffer::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Turbopuffer::NamespaceExplainQueryParams::Consistency,
+              Turbopuffer::Internal::AnyHash
+            )
+          end
+
+        # The query's consistency level.
+        sig do
+          returns(
+            T.nilable(
+              Turbopuffer::NamespaceExplainQueryParams::Consistency::Level::OrSymbol
+            )
+          )
+        end
+        attr_reader :level
+
+        sig do
+          params(
+            level:
+              Turbopuffer::NamespaceExplainQueryParams::Consistency::Level::OrSymbol
+          ).void
+        end
+        attr_writer :level
+
+        # The consistency level for a query.
+        sig do
+          params(
+            level:
+              Turbopuffer::NamespaceExplainQueryParams::Consistency::Level::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The query's consistency level.
+          level: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              level:
+                Turbopuffer::NamespaceExplainQueryParams::Consistency::Level::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The query's consistency level.
+        module Level
+          extend Turbopuffer::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Turbopuffer::NamespaceExplainQueryParams::Consistency::Level
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # Strong consistency. Requires a round-trip to object storage to fetch the latest writes.
+          STRONG =
+            T.let(
+              :strong,
+              Turbopuffer::NamespaceExplainQueryParams::Consistency::Level::TaggedSymbol
+            )
+
+          # Eventual consistency. Does not require a round-trip to object storage, but may not see the latest writes.
+          EVENTUAL =
+            T.let(
+              :eventual,
+              Turbopuffer::NamespaceExplainQueryParams::Consistency::Level::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Turbopuffer::NamespaceExplainQueryParams::Consistency::Level::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/namespace_explain_query_response.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class NamespaceExplainQueryResponse < Turbopuffer::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Turbopuffer::Models::NamespaceExplainQueryResponse,
+            Turbopuffer::Internal::AnyHash
+          )
+        end
+
+      # The textual representation of the query plan.
+      sig { returns(T.nilable(String)) }
+      attr_reader :plan_text
+
+      sig { params(plan_text: String).void }
+      attr_writer :plan_text
+
+      # The response to a successful query explain.
+      sig { params(plan_text: String).returns(T.attached_class) }
+      def self.new(
+        # The textual representation of the query plan.
+        plan_text: nil
+      )
+      end
+
+      sig { override.returns({ plan_text: String }) }
+      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: :ACCEPTED
+      )
+      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,62 @@
+# 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 approximate number of rows in the namespace.
+      sig { returns(Integer) }
+      attr_accessor :approx_row_count
+
+      # 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,
+          approx_row_count: 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 approximate number of rows in the namespace.
+        approx_row_count:,
+        # The timestamp when the namespace was created.
+        created_at:,
+        # The schema of the namespace.
+        schema:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            approx_logical_bytes: Integer,
+            approx_row_count: 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

data/rbi/turbopuffer/models/namespace_multi_query_params.rbi

@@ -0,0 +1,175 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class NamespaceMultiQueryParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Turbopuffer::NamespaceMultiQueryParams,
+            Turbopuffer::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :namespace
+
+      sig { params(namespace: String).void }
+      attr_writer :namespace
+
+      sig { returns(T::Array[Turbopuffer::Query]) }
+      attr_accessor :queries
+
+      # The consistency level for a query.
+      sig do
+        returns(T.nilable(Turbopuffer::NamespaceMultiQueryParams::Consistency))
+      end
+      attr_reader :consistency
+
+      sig do
+        params(
+          consistency:
+            Turbopuffer::NamespaceMultiQueryParams::Consistency::OrHash
+        ).void
+      end
+      attr_writer :consistency
+
+      # The encoding to use for vectors in the response.
+      sig { returns(T.nilable(Turbopuffer::VectorEncoding::OrSymbol)) }
+      attr_reader :vector_encoding
+
+      sig do
+        params(vector_encoding: Turbopuffer::VectorEncoding::OrSymbol).void
+      end
+      attr_writer :vector_encoding
+
+      sig do
+        params(
+          queries: T::Array[Turbopuffer::Query::OrHash],
+          namespace: String,
+          consistency:
+            Turbopuffer::NamespaceMultiQueryParams::Consistency::OrHash,
+          vector_encoding: Turbopuffer::VectorEncoding::OrSymbol,
+          request_options: Turbopuffer::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        queries:,
+        namespace: nil,
+        # The consistency level for a query.
+        consistency: nil,
+        # The encoding to use for vectors in the response.
+        vector_encoding: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            namespace: String,
+            queries: T::Array[Turbopuffer::Query],
+            consistency: Turbopuffer::NamespaceMultiQueryParams::Consistency,
+            vector_encoding: Turbopuffer::VectorEncoding::OrSymbol,
+            request_options: Turbopuffer::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Consistency < Turbopuffer::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Turbopuffer::NamespaceMultiQueryParams::Consistency,
+              Turbopuffer::Internal::AnyHash
+            )
+          end
+
+        # The query's consistency level.
+        sig do
+          returns(
+            T.nilable(
+              Turbopuffer::NamespaceMultiQueryParams::Consistency::Level::OrSymbol
+            )
+          )
+        end
+        attr_reader :level
+
+        sig do
+          params(
+            level:
+              Turbopuffer::NamespaceMultiQueryParams::Consistency::Level::OrSymbol
+          ).void
+        end
+        attr_writer :level
+
+        # The consistency level for a query.
+        sig do
+          params(
+            level:
+              Turbopuffer::NamespaceMultiQueryParams::Consistency::Level::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The query's consistency level.
+          level: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              level:
+                Turbopuffer::NamespaceMultiQueryParams::Consistency::Level::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The query's consistency level.
+        module Level
+          extend Turbopuffer::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Turbopuffer::NamespaceMultiQueryParams::Consistency::Level
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # Strong consistency. Requires a round-trip to object storage to fetch the latest writes.
+          STRONG =
+            T.let(
+              :strong,
+              Turbopuffer::NamespaceMultiQueryParams::Consistency::Level::TaggedSymbol
+            )
+
+          # Eventual consistency. Does not require a round-trip to object storage, but may not see the latest writes.
+          EVENTUAL =
+            T.let(
+              :eventual,
+              Turbopuffer::NamespaceMultiQueryParams::Consistency::Level::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Turbopuffer::NamespaceMultiQueryParams::Consistency::Level::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end