Class: Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Data

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

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(data: nil, meta: nil) ⇒ Object

Parameters:



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/telnyx/models/ai/knowledge/collection_retrieve_documents_response.rb', line 24

class Data < Telnyx::Internal::Type::BaseModel
  # @!attribute id
  #
  #   @return [String, nil]
  optional :id, String

  # @!attribute chunk_index
  #
  #   @return [Integer, nil]
  optional :chunk_index, Integer

  # @!attribute chunk_total
  #
  #   @return [Integer, nil]
  optional :chunk_total, Integer

  # @!attribute ingested_at
  #
  #   @return [Time, nil]
  optional :ingested_at, Time

  # @!attribute metadata
  #
  #   @return [Hash{Symbol=>Object}, nil]
  optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]

  # @!attribute organization_id
  #
  #   @return [String, nil]
  optional :organization_id, String

  # @!attribute record_created_at
  #
  #   @return [Time, nil]
  optional :record_created_at, Time

  # @!attribute record_id
  #
  #   @return [String, nil]
  optional :record_id, String

  # @!attribute record_type
  #   The source record kind this chunk came from (e.g. `voice`, `meeting_bot`,
  #   `message`).
  #
  #   @return [String, nil]
  optional :record_type, String

  # @!attribute region
  #
  #   @return [String, nil]
  optional :region, String

  # @!attribute score
  #   Relevance score (higher = more relevant) for ranked search. `0.0` for plain
  #   catalog listings (when `query` is omitted).
  #
  #   @return [Float, nil]
  optional :score, Float

  # @!attribute text
  #
  #   @return [String, nil]
  optional :text, String

  # @!attribute user_id
  #
  #   @return [String, nil]
  optional :user_id, String

  # @!method 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)
  #   Some parameter documentations has been truncated, see
  #   {Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Data} for
  #   more details.
  #
  #   @param id [String]
  #
  #   @param chunk_index [Integer]
  #
  #   @param chunk_total [Integer]
  #
  #   @param ingested_at [Time]
  #
  #   @param metadata [Hash{Symbol=>Object}]
  #
  #   @param organization_id [String]
  #
  #   @param record_created_at [Time]
  #
  #   @param record_id [String]
  #
  #   @param record_type [String] The source record kind this chunk came from (e.g. `voice`, `meeting_bot`, `messa
  #
  #   @param region [String]
  #
  #   @param score [Float] Relevance score (higher = more relevant) for ranked search. `0.0` for plain cata
  #
  #   @param text [String]
  #
  #   @param user_id [String]
end

Instance Attribute Details

#chunk_index ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :chunk_index, Integer

#chunk_total ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :chunk_total, Integer

#id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :id, String

#ingested_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


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

optional :ingested_at, Time

#metadata ⇒ Hash{Symbol=>Object}?

Parameters:

  • (::Hash[Symbol, top])

Returns:

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


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

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

#organization_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :organization_id, String

#record_created_at ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


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

optional :record_created_at, Time

#record_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

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) 


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

optional :record_type, String

#region ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

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) 


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

optional :score, Float

#text ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :text, String

#user_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :user_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {