Class: Turbopuffer::Models::QueryPerformance

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/turbopuffer/models/query_performance.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

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(approx_namespace_size: , cache_hit_ratio: , cache_temperature: , exhaustive_search_count: , query_execution_ms: , server_total_ms: ) ⇒ Object

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

The performance information for a query.

Parameters:

  • approx_namespace_size (Integer) (defaults to: ) —

    the approximate number of documents in the namespace.

  • cache_hit_ratio (Float) (defaults to: ) —

    The ratio of cache hits to total cache lookups.

  • cache_temperature (String) (defaults to: ) —

    A qualitative description of the cache hit ratio (‘hot`, `warm`, or `cold`).

  • exhaustive_search_count (Integer) (defaults to: ) —

    The number of unindexed documents processed by the query.

  • query_execution_ms (Integer) (defaults to: ) —

    Request time measured on the server, excluding time spent waiting due to the nam

  • server_total_ms (Integer) (defaults to: ) —

    Request time measured on the server, including time spent waiting for other quer




# File 'lib/turbopuffer/models/query_performance.rb', line 44

Instance Attribute Details

#approx_namespace_size ⇒ Integer

the approximate number of documents in the namespace.

Returns:

  • (Integer) 


10
 
# File 'lib/turbopuffer/models/query_performance.rb', line 10

required :approx_namespace_size, Integer

#cache_hit_ratio ⇒ Float

The ratio of cache hits to total cache lookups.

Returns:

  • (Float) 


16
 
# File 'lib/turbopuffer/models/query_performance.rb', line 16

required :cache_hit_ratio, Float

#cache_temperature ⇒ String

A qualitative description of the cache hit ratio (‘hot`, `warm`, or `cold`).

Returns:

  • (String) 


22
 
# File 'lib/turbopuffer/models/query_performance.rb', line 22

required :cache_temperature, String

#exhaustive_search_count ⇒ Integer

The number of unindexed documents processed by the query.

Returns:

  • (Integer) 


28
 
# File 'lib/turbopuffer/models/query_performance.rb', line 28

required :exhaustive_search_count, Integer

#query_execution_ms ⇒ Integer

Request time measured on the server, excluding time spent waiting due to the namespace concurrency limit.

Returns:

  • (Integer) 


35
 
# File 'lib/turbopuffer/models/query_performance.rb', line 35

required :query_execution_ms, Integer

#server_total_ms ⇒ Integer

Request time measured on the server, including time spent waiting for other queries to complete if the namespace was at its concurrency limit.

Returns:

  • (Integer) 


42
 
# File 'lib/turbopuffer/models/query_performance.rb', line 42

required :server_total_ms, Integer