Class: Turbopuffer::Models::NamespaceRecallParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Turbopuffer::Models::NamespaceRecallParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/turbopuffer/models/namespace_recall_params.rb

Overview

See Also:

• Resources::Namespaces#recall

Instance Attribute Summary

• #filters ⇒ Object^?

  Filter by attributes.

• #include_ground_truth ⇒ Boolean^?

  Include ground truth data (query vectors and true nearest neighbors) in the response.

• #namespace ⇒ String^?
• #num ⇒ Integer^?

  The number of searches to run.

• #queries ⇒ Array<Float>^?

  Use specific query vectors for the measurement.

• #top_k ⇒ Integer^?

  Search for ‘top_k` nearest neighbors.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(namespace: nil, filters: nil, include_ground_truth: nil, num: nil, queries: nil, top_k: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see NamespaceRecallParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(namespace: nil, filters: nil, include_ground_truth: nil, num: nil, queries: nil, top_k: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Turbopuffer::Models::NamespaceRecallParams for more details.

Parameters:

• namespace (String) (defaults to: nil)
• filters (Object) (defaults to: nil) —

  Filter by attributes. Same syntax as the query endpoint.

• include_ground_truth (Boolean) (defaults to: nil) —

  Include ground truth data (query vectors and true nearest neighbors) in the resp

• num (Integer) (defaults to: nil) —

  The number of searches to run.

• queries (Array<Float>) (defaults to: nil) —

  Use specific query vectors for the measurement. If omitted, sampled from the ind

• top_k (Integer) (defaults to: nil) —

  Search for ‘top_k` nearest neighbors.

• request_options (Turbopuffer::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/turbopuffer/models/namespace_recall_params.rb', line 47

Instance Attribute Details

#filters ⇒ Object^?

Filter by attributes. Same syntax as the query endpoint.

Returns:

• (Object, nil)

# File 'lib/turbopuffer/models/namespace_recall_params.rb', line 19

optional :filters, Turbopuffer::Internal::Type::Unknown

#include_ground_truth ⇒ Boolean^?

Include ground truth data (query vectors and true nearest neighbors) in the response.

Returns:

• (Boolean, nil)

# File 'lib/turbopuffer/models/namespace_recall_params.rb', line 26

optional :include_ground_truth, Turbopuffer::Internal::Type::Boolean

#namespace ⇒ String^?

Returns:

• (String, nil)

# File 'lib/turbopuffer/models/namespace_recall_params.rb', line 13

optional :namespace, String

#num ⇒ Integer^?

The number of searches to run.

Returns:

• (Integer, nil)

# File 'lib/turbopuffer/models/namespace_recall_params.rb', line 32

optional :num, Integer

#queries ⇒ Array<Float>^?

Use specific query vectors for the measurement. If omitted, sampled from the index.

Returns:

• (Array<Float>, nil)

# File 'lib/turbopuffer/models/namespace_recall_params.rb', line 39

optional :queries, Turbopuffer::Internal::Type::ArrayOf[Float]

#top_k ⇒ Integer^?

Search for ‘top_k` nearest neighbors.

Returns:

• (Integer, nil)

# File 'lib/turbopuffer/models/namespace_recall_params.rb', line 45

optional :top_k, Integer