Class: Telnyx::Models::AI::Collections::RetrievalSettings

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/ai/collections/retrieval_settings.rb,
sig/telnyx/models/ai/collections/retrieval_settings.rbs

Defined Under Namespace

Modules: RetrievalType

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(retrieval_type: nil, top_k: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::AI::Collections::RetrievalSettings for more details.

How documents are retrieved when searching the collection.

Parameters:




# File 'lib/telnyx/models/ai/collections/retrieval_settings.rb', line 21

Instance Attribute Details

#retrieval_type ⇒ Symbol, ...

Retrieval strategy. vector runs semantic similarity search; hybrid combines vector similarity with keyword matching; keyword runs lexical (BM25) matching.

Returns:



13
 
# File 'lib/telnyx/models/ai/collections/retrieval_settings.rb', line 13

optional :retrieval_type, enum: -> { Telnyx::AI::Collections::RetrievalSettings::RetrievalType }

#top_k ⇒ Integer?

Number of top results to retrieve (1–50).

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


19
 
# File 'lib/telnyx/models/ai/collections/retrieval_settings.rb', line 19

optional :top_k, Integer

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


27
 
# File 'sig/telnyx/models/ai/collections/retrieval_settings.rbs', line 27

def to_hash: -> {