Class: Telnyx::Models::AI::EmbeddingCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

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

Overview

See Also:

• Telnyx::Resources::AI::Embeddings#create

Defined Under Namespace

Modules: EmbeddingModel, Loader

Instance Attribute Summary

• #bucket_name ⇒ String
• #document_chunk_overlap_size ⇒ Integer^?
• #document_chunk_size ⇒ Integer^?
• #embedding_model ⇒ Symbol, ...

  Supported models to vectorize and embed documents.

• #idempotency_key ⇒ String^?
• #loader ⇒ Symbol, ...

  Supported types of custom document loaders for embeddings.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(bucket_name:, document_chunk_overlap_size: nil, document_chunk_size: nil, embedding_model: nil, loader: nil, idempotency_key: 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(bucket_name:, document_chunk_overlap_size: nil, document_chunk_size: nil, embedding_model: nil, loader: nil, idempotency_key: nil, request_options: {}) ⇒ Object

Parameters:

• bucket_name (String)
• document_chunk_overlap_size (Integer) (defaults to: nil)
• document_chunk_size (Integer) (defaults to: nil)
• embedding_model (Symbol, Telnyx::Models::AI::EmbeddingCreateParams::EmbeddingModel) (defaults to: nil) —

  Supported models to vectorize and embed documents.

• loader (Symbol, Telnyx::Models::AI::EmbeddingCreateParams::Loader) (defaults to: nil) —

  Supported types of custom document loaders for embeddings.

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

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

Instance Attribute Details

#bucket_name ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/telnyx/models/ai/embedding_create_params.rb', line 14

required :bucket_name, String

#document_chunk_overlap_size ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/ai/embedding_create_params.rb', line 19

optional :document_chunk_overlap_size, Integer

#document_chunk_size ⇒ Integer^?

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/ai/embedding_create_params.rb', line 24

optional :document_chunk_size, Integer

#embedding_model ⇒ Symbol, ...

Supported models to vectorize and embed documents.

Returns:

• (Symbol, Telnyx::Models::AI::EmbeddingCreateParams::EmbeddingModel, nil)

# File 'lib/telnyx/models/ai/embedding_create_params.rb', line 30

optional :embedding_model, enum: -> { Telnyx::AI::EmbeddingCreateParams::EmbeddingModel }

#idempotency_key ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :idempotency_key, String

#loader ⇒ Symbol, ...

Supported types of custom document loaders for embeddings.

Returns:

• (Symbol, Telnyx::Models::AI::EmbeddingCreateParams::Loader, nil)

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

optional :loader, enum: -> { Telnyx::AI::EmbeddingCreateParams::Loader }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/ai/embedding_create_params.rbs', line 55

def to_hash: -> {