# frozen_string_literal: true

module Turbopuffer
  module Models
    # @see Turbopuffer::Resources::Namespaces#recall
    class NamespaceRecallParams < Turbopuffer::Internal::Type::BaseModel
      extend Turbopuffer::Internal::Type::RequestParameters::Converter
      include Turbopuffer::Internal::Type::RequestParameters

      # @!attribute namespace
      #
      #   @return [String, nil]
      optional :namespace, String

      # @!attribute filters
      #   Filter by attributes. Same syntax as the query endpoint.
      #
      #   @return [Object, nil]
      optional :filters, Turbopuffer::Internal::Type::Unknown

      # @!attribute num
      #   The number of searches to run.
      #
      #   @return [Integer, nil]
      optional :num, Integer

      # @!attribute queries
      #   Use specific query vectors for the measurement. If omitted, sampled from the
      #   index.
      #
      #   @return [Array<Float>, nil]
      optional :queries, Turbopuffer::Internal::Type::ArrayOf[Float]

      # @!attribute top_k
      #   Search for `top_k` nearest neighbors.
      #
      #   @return [Integer, nil]
      optional :top_k, Integer

      # @!method initialize(namespace: nil, filters: nil, num: nil, queries: nil, top_k: nil, request_options: {})
      #   Some parameter documentations has been truncated, see
      #   {Turbopuffer::Models::NamespaceRecallParams} for more details.
      #
      #   @param namespace [String]
      #
      #   @param filters [Object] Filter by attributes. Same syntax as the query endpoint.
      #
      #   @param num [Integer] The number of searches to run.
      #
      #   @param queries [Array<Float>] Use specific query vectors for the measurement. If omitted, sampled from the ind
      #
      #   @param top_k [Integer] Search for `top_k` nearest neighbors.
      #
      #   @param request_options [Turbopuffer::RequestOptions, Hash{Symbol=>Object}]
    end
  end
end