Class: Telnyx::Models::AI::CollectionCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::AI::CollectionCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/ai/collection_create_params.rb,
sig/telnyx/models/ai/collection_create_params.rbs

Overview

See Also:

• Telnyx::Resources::AI::Collections#create

Instance Attribute Summary

• #description ⇒ String^?

  Optional description.

• #name ⇒ String

  Human-readable collection name.

• #settings ⇒ Telnyx::Models::AI::Collections::RetrievalSettingsWrapper^?

  Optional retrieval settings.

• #slug ⇒ String^?

  Optional slug (unique per organization).

• #sources ⇒ Array<Telnyx::Models::AI::Collections::SourceRequest>^?

  Optional sources to attach at creation time.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(name:, description: nil, settings: nil, slug: nil, sources: nil, request_options: {}) ⇒ Object constructor
• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(name:, description: nil, settings: nil, slug: nil, sources: nil, request_options: {}) ⇒ Object

Parameters:

• name (String) —

  Human-readable collection name.

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

  Optional description.

• settings (Telnyx::Models::AI::Collections::RetrievalSettingsWrapper) (defaults to: nil) —

  Optional retrieval settings.

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

  Optional slug (unique per organization). Derived from name when omitted.

• sources (Array<Telnyx::Models::AI::Collections::SourceRequest>) (defaults to: nil) —

  Optional sources to attach at creation time.

• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

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

Instance Attribute Details

#description ⇒ String^?

Optional description.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :description, String

#name ⇒ String

Human-readable collection name.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/telnyx/models/ai/collection_create_params.rb', line 15

required :name, String

#settings ⇒ Telnyx::Models::AI::Collections::RetrievalSettingsWrapper^?

Optional retrieval settings.

Returns:

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

# File 'lib/telnyx/models/ai/collection_create_params.rb', line 27

optional :settings, -> { Telnyx::AI::Collections::RetrievalSettingsWrapper }

#slug ⇒ String^?

Optional slug (unique per organization). Derived from name when omitted.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :slug, String

#sources ⇒ Array<Telnyx::Models::AI::Collections::SourceRequest>^?

Optional sources to attach at creation time.

Returns:

• (Array<Telnyx::Models::AI::Collections::SourceRequest>, nil)

# File 'lib/telnyx/models/ai/collection_create_params.rb', line 39

optional :sources, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Collections::SourceRequest] }

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/ai/collection_create_params.rbs', line 49

def to_hash: -> {