Class: Turbopuffer::Models::Limit

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/turbopuffer/models/limit.rb,
sig/turbopuffer/models/limit.rbs

Defined Under Namespace

Classes: Per

Instance Attribute Summary

• #per ⇒ Turbopuffer::Models::Limit::Per^?

  Limits the number of documents with the same value for a set of attributes (the "limit key") that can appear in the results.

• #total ⇒ Integer

  Limits the total number of documents returned.

Instance Method Summary

• #initialize(total:, per: nil) ⇒ Limit constructor

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

• #to_hash ⇒ { total: Integer, per: Turbopuffer::Limit::Per }

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(total:, per: nil) ⇒ Limit

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

Limits the documents returned by a query.

Parameters:

• total (Integer) —

  Limits the total number of documents returned.

• per (Turbopuffer::Models::Limit::Per) (defaults to: nil) —

  Limits the number of documents with the same value for a set of attributes (the

• total: (Integer)
• per: (Turbopuffer::Limit::Per) (defaults to: nil)

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

Instance Attribute Details

#per ⇒ Turbopuffer::Models::Limit::Per^?

Limits the number of documents with the same value for a set of attributes (the "limit key") that can appear in the results.

Parameters:

• (Turbopuffer::Limit::Per)

Returns:

• (Turbopuffer::Models::Limit::Per, nil)

# File 'lib/turbopuffer/models/limit.rb', line 17

optional :per, -> { Turbopuffer::Limit::Per }

#total ⇒ Integer

Limits the total number of documents returned.

Parameters:

• value (Integer)

Returns:

• (Integer)

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

required :total, Integer

Instance Method Details

#to_hash ⇒ { total: Integer, per: Turbopuffer::Limit::Per }

Returns:

• ({ total: Integer, per: Turbopuffer::Limit::Per })

# File 'sig/turbopuffer/models/limit.rbs', line 14

def to_hash: -> { total: Integer, per: Turbopuffer::Limit::Per }