Class: Telnyx::Models::AI::Collections::RetrievalSettingsWrapper

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::AI::Collections::RetrievalSettingsWrapper

Defined in:

lib/telnyx/models/ai/collections/retrieval_settings_wrapper.rb,
sig/telnyx/models/ai/collections/retrieval_settings_wrapper.rbs

Instance Attribute Summary

• #record_type ⇒ String^? readonly

  Returns the value of attribute record_type.

• #retrieval ⇒ Telnyx::Models::AI::Collections::RetrievalSettings^?

  How documents are retrieved when searching the collection.

Instance Method Summary

• #initialize(record_type: nil, retrieval: nil) ⇒ Object constructor
• #record_type ⇒ String readonly
• #to_hash ⇒ {

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(record_type: nil, retrieval: nil) ⇒ Object

Parameters:

• record_type (String) (defaults to: nil) —

  Identifies the record type. Always ai_collection_settings.

• retrieval (Telnyx::Models::AI::Collections::RetrievalSettings) (defaults to: nil) —

  How documents are retrieved when searching the collection.

# File 'lib/telnyx/models/ai/collections/retrieval_settings_wrapper.rb', line 22

Instance Attribute Details

#record_type ⇒ String^? (readonly)

Returns the value of attribute record_type.

Returns:

• (String, nil)

# File 'sig/telnyx/models/ai/collections/retrieval_settings_wrapper.rbs', line 18

def record_type
  @record_type
end

#retrieval ⇒ Telnyx::Models::AI::Collections::RetrievalSettings^?

How documents are retrieved when searching the collection.

Returns:

• (Telnyx::Models::AI::Collections::RetrievalSettings, nil)

# File 'lib/telnyx/models/ai/collections/retrieval_settings_wrapper.rb', line 12

optional :retrieval, -> { Telnyx::AI::Collections::RetrievalSettings }

Instance Method Details

#record_type= ⇒ String (readonly)

Parameters:

• (String)

Returns:

• (String)

# File 'sig/telnyx/models/ai/collections/retrieval_settings_wrapper.rbs', line 20

def record_type=: (String) -> String

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {