Class: Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse::Meta

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

Overview

See Also:

  • Telnyx::Models::AI::Knowledge::CollectionRetrieveDocumentsResponse#meta

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(collection_slug: nil, page_number: nil, page_size: nil, retrieval_type: nil, searched_sources: nil, top_k: nil, total_pages: nil, total_results: nil) ⇒ Object

Parameters:

  • collection_slug (String) (defaults to: nil)
  • page_number (Integer) (defaults to: nil)
  • page_size (Integer) (defaults to: nil)
  • retrieval_type (String) (defaults to: nil)
  • searched_sources (Array<String>) (defaults to: nil)
  • top_k (Integer) (defaults to: nil)
  • total_pages (Integer) (defaults to: nil)
  • total_results (Integer) (defaults to: nil) 



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

Instance Attribute Details

#collection_slug ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :collection_slug, String

#page_number ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :page_number, Integer

#page_size ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :page_size, Integer

#retrieval_type ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :retrieval_type, String

#searched_sources ⇒ Array<String>?

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


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

optional :searched_sources, Telnyx::Internal::Type::ArrayOf[String]

#top_k ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :top_k, Integer

#total_pages ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :total_pages, Integer

#total_results ⇒ Integer?

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


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

optional :total_results, Integer

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {