turbopuffer-ruby 0.2.0.pre.alpha.1

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

data/rbi/turbopuffer/models/namespace_multi_query_response.rbi

@@ -0,0 +1,111 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class NamespaceMultiQueryResponse < Turbopuffer::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Turbopuffer::Models::NamespaceMultiQueryResponse,
+            Turbopuffer::Internal::AnyHash
+          )
+        end
+
+      # The billing information for a query.
+      sig { returns(Turbopuffer::QueryBilling) }
+      attr_reader :billing
+
+      sig { params(billing: Turbopuffer::QueryBilling::OrHash).void }
+      attr_writer :billing
+
+      # The performance information for a query.
+      sig { returns(Turbopuffer::QueryPerformance) }
+      attr_reader :performance
+
+      sig { params(performance: Turbopuffer::QueryPerformance::OrHash).void }
+      attr_writer :performance
+
+      sig do
+        returns(
+          T::Array[Turbopuffer::Models::NamespaceMultiQueryResponse::Result]
+        )
+      end
+      attr_accessor :results
+
+      # The result of a multi-query.
+      sig do
+        params(
+          billing: Turbopuffer::QueryBilling::OrHash,
+          performance: Turbopuffer::QueryPerformance::OrHash,
+          results:
+            T::Array[
+              Turbopuffer::Models::NamespaceMultiQueryResponse::Result::OrHash
+            ]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The billing information for a query.
+        billing:,
+        # The performance information for a query.
+        performance:,
+        results:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            billing: Turbopuffer::QueryBilling,
+            performance: Turbopuffer::QueryPerformance,
+            results:
+              T::Array[Turbopuffer::Models::NamespaceMultiQueryResponse::Result]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Result < Turbopuffer::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Turbopuffer::Models::NamespaceMultiQueryResponse::Result,
+              Turbopuffer::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :aggregations
+
+        sig { params(aggregations: T::Hash[Symbol, T.anything]).void }
+        attr_writer :aggregations
+
+        sig { returns(T.nilable(T::Array[Turbopuffer::Row])) }
+        attr_reader :rows
+
+        sig { params(rows: T::Array[Turbopuffer::Row::OrHash]).void }
+        attr_writer :rows
+
+        sig do
+          params(
+            aggregations: T::Hash[Symbol, T.anything],
+            rows: T::Array[Turbopuffer::Row::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(aggregations: nil, rows: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              aggregations: T::Hash[Symbol, T.anything],
+              rows: T::Array[Turbopuffer::Row]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/namespace_query_params.rbi

@@ -0,0 +1,241 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class NamespaceQueryParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Turbopuffer::NamespaceQueryParams,
+            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 { returns(T.nilable(Turbopuffer::NamespaceQueryParams::Consistency)) }
+      attr_reader :consistency
+
+      sig do
+        params(
+          consistency: Turbopuffer::NamespaceQueryParams::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
+
+      # 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
+
+      # 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::NamespaceQueryParams::Consistency::OrHash,
+          distance_metric: Turbopuffer::DistanceMetric::OrSymbol,
+          filters: T.anything,
+          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,
+        # Exact filters for attributes to refine search results for. Think of it as a SQL
+        # WHERE clause.
+        filters: 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::NamespaceQueryParams::Consistency,
+            distance_metric: Turbopuffer::DistanceMetric::OrSymbol,
+            filters: T.anything,
+            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::NamespaceQueryParams::Consistency,
+              Turbopuffer::Internal::AnyHash
+            )
+          end
+
+        # The query's consistency level.
+        sig do
+          returns(
+            T.nilable(
+              Turbopuffer::NamespaceQueryParams::Consistency::Level::OrSymbol
+            )
+          )
+        end
+        attr_reader :level
+
+        sig do
+          params(
+            level:
+              Turbopuffer::NamespaceQueryParams::Consistency::Level::OrSymbol
+          ).void
+        end
+        attr_writer :level
+
+        # The consistency level for a query.
+        sig do
+          params(
+            level:
+              Turbopuffer::NamespaceQueryParams::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::NamespaceQueryParams::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::NamespaceQueryParams::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::NamespaceQueryParams::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::NamespaceQueryParams::Consistency::Level::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Turbopuffer::NamespaceQueryParams::Consistency::Level::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/namespace_query_response.rbi

@@ -0,0 +1,73 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class NamespaceQueryResponse < Turbopuffer::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Turbopuffer::Models::NamespaceQueryResponse,
+            Turbopuffer::Internal::AnyHash
+          )
+        end
+
+      # The billing information for a query.
+      sig { returns(Turbopuffer::QueryBilling) }
+      attr_reader :billing
+
+      sig { params(billing: Turbopuffer::QueryBilling::OrHash).void }
+      attr_writer :billing
+
+      # The performance information for a query.
+      sig { returns(Turbopuffer::QueryPerformance) }
+      attr_reader :performance
+
+      sig { params(performance: Turbopuffer::QueryPerformance::OrHash).void }
+      attr_writer :performance
+
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_reader :aggregations
+
+      sig { params(aggregations: T::Hash[Symbol, T.anything]).void }
+      attr_writer :aggregations
+
+      sig { returns(T.nilable(T::Array[Turbopuffer::Row])) }
+      attr_reader :rows
+
+      sig { params(rows: T::Array[Turbopuffer::Row::OrHash]).void }
+      attr_writer :rows
+
+      # The result of a query.
+      sig do
+        params(
+          billing: Turbopuffer::QueryBilling::OrHash,
+          performance: Turbopuffer::QueryPerformance::OrHash,
+          aggregations: T::Hash[Symbol, T.anything],
+          rows: T::Array[Turbopuffer::Row::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The billing information for a query.
+        billing:,
+        # The performance information for a query.
+        performance:,
+        aggregations: nil,
+        rows: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            billing: Turbopuffer::QueryBilling,
+            performance: Turbopuffer::QueryPerformance,
+            aggregations: T::Hash[Symbol, T.anything],
+            rows: T::Array[Turbopuffer::Row]
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/turbopuffer/models/namespace_recall_params.rbi

@@ -0,0 +1,93 @@
+# typed: strong
+
+module Turbopuffer
+  module Models
+    class NamespaceRecallParams < Turbopuffer::Internal::Type::BaseModel
+      extend Turbopuffer::Internal::Type::RequestParameters::Converter
+      include Turbopuffer::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Turbopuffer::NamespaceRecallParams,
+            Turbopuffer::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :namespace
+
+      sig { params(namespace: String).void }
+      attr_writer :namespace
+
+      # Filter by attributes. Same syntax as the query endpoint.
+      sig { returns(T.nilable(T.anything)) }
+      attr_reader :filters
+
+      sig { params(filters: T.anything).void }
+      attr_writer :filters
+
+      # The number of searches to run.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :num
+
+      sig { params(num: Integer).void }
+      attr_writer :num
+
+      # Use specific query vectors for the measurement. If omitted, sampled from the
+      # index.
+      sig { returns(T.nilable(T::Array[Float])) }
+      attr_reader :queries
+
+      sig { params(queries: T::Array[Float]).void }
+      attr_writer :queries
+
+      # Search for `top_k` nearest neighbors.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :top_k
+
+      sig { params(top_k: Integer).void }
+      attr_writer :top_k
+
+      sig do
+        params(
+          namespace: String,
+          filters: T.anything,
+          num: Integer,
+          queries: T::Array[Float],
+          top_k: Integer,
+          request_options: Turbopuffer::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        namespace: nil,
+        # Filter by attributes. Same syntax as the query endpoint.
+        filters: nil,
+        # The number of searches to run.
+        num: nil,
+        # Use specific query vectors for the measurement. If omitted, sampled from the
+        # index.
+        queries: nil,
+        # Search for `top_k` nearest neighbors.
+        top_k: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            namespace: String,
+            filters: T.anything,
+            num: Integer,
+            queries: T::Array[Float],
+            top_k: Integer,
+            request_options: Turbopuffer::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end