Class: Telnyx::Models::AI::CollectionRetrieveDocumentsResponse

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

Overview

See Also:

  • Telnyx::Resources::AI::Collections#retrieve_documents

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(id: nil, chunk_index: nil, chunk_total: nil, ingested_at: nil, metadata: nil, organization_id: nil, record_created_at: nil, record_id: nil, record_type: nil, region: nil, score: nil, text: nil, user_id: nil) ⇒ Object

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

Parameters:

  • id (String) (defaults to: nil)
  • chunk_index (Integer) (defaults to: nil)
  • chunk_total (Integer) (defaults to: nil)
  • ingested_at (Time) (defaults to: nil)
  • metadata (Hash{Symbol=>Object}) (defaults to: nil)
  • organization_id (String) (defaults to: nil)
  • record_created_at (Time) (defaults to: nil)
  • record_id (String) (defaults to: nil)
  • record_type (String) (defaults to: nil) —

    The source record kind this chunk came from (e.g. voice, meeting_bot, `messa

  • region (String) (defaults to: nil)
  • score (Float) (defaults to: nil) —

    Relevance score (higher = more relevant) for ranked search. 0.0 for plain cata

  • text (String) (defaults to: nil)
  • user_id (String) (defaults to: nil) 



# File 'lib/telnyx/models/ai/collection_retrieve_documents_response.rb', line 77

Instance Attribute Details

#chunk_index ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


16
 
# File 'lib/telnyx/models/ai/collection_retrieve_documents_response.rb', line 16

optional :chunk_index, Integer

#chunk_total ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :chunk_total, Integer

#id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


11
 
# File 'lib/telnyx/models/ai/collection_retrieve_documents_response.rb', line 11

optional :id, String

#ingested_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


26
 
# File 'lib/telnyx/models/ai/collection_retrieve_documents_response.rb', line 26

optional :ingested_at, Time

#metadata ⇒ Hash{Symbol=>Object}?

Parameters:

  • (::Hash[Symbol, top])

Returns:

  • (Hash{Symbol=>Object}, nil) 


31
 
# File 'lib/telnyx/models/ai/collection_retrieve_documents_response.rb', line 31

optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

#organization_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


36
 
# File 'lib/telnyx/models/ai/collection_retrieve_documents_response.rb', line 36

optional :organization_id, String

#record_created_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


41
 
# File 'lib/telnyx/models/ai/collection_retrieve_documents_response.rb', line 41

optional :record_created_at, Time

#record_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


46
 
# File 'lib/telnyx/models/ai/collection_retrieve_documents_response.rb', line 46

optional :record_id, String

#record_type ⇒ String?

The source record kind this chunk came from (e.g. voice, meeting_bot, message).

Parameters:

  • (String)

Returns:

  • (String, nil) 


53
 
# File 'lib/telnyx/models/ai/collection_retrieve_documents_response.rb', line 53

optional :record_type, String

#region ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


58
 
# File 'lib/telnyx/models/ai/collection_retrieve_documents_response.rb', line 58

optional :region, String

#score ⇒ Float?

Relevance score (higher = more relevant) for ranked search. 0.0 for plain catalog listings (when query is omitted).

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


65
 
# File 'lib/telnyx/models/ai/collection_retrieve_documents_response.rb', line 65

optional :score, Float

#text ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


70
 
# File 'lib/telnyx/models/ai/collection_retrieve_documents_response.rb', line 70

optional :text, String

#user_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


75
 
# File 'lib/telnyx/models/ai/collection_retrieve_documents_response.rb', line 75

optional :user_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


90
 
# File 'sig/telnyx/models/ai/collection_retrieve_documents_response.rbs', line 90

def to_hash: -> {