Class: Telnyx::Models::AI::EmbeddingSimilaritySearchParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/telnyx/models/ai/embedding_similarity_search_params.rb

Overview

See Also:

• Resources::AI::Embeddings#similarity_search

Instance Attribute Summary

• #bucket_name ⇒ String
• #num_of_docs ⇒ Integer^?
• #query ⇒ String

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(bucket_name:, query:, num_of_docs: nil, request_options: {}) ⇒ Object constructor

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:, query:, num_of_docs: nil, request_options: {}) ⇒ Object

Parameters:

• bucket_name (String)
• query (String)
• num_of_docs (Integer) (defaults to: nil)
• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

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

Instance Attribute Details

#bucket_name ⇒ String

Returns:

• (String)

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

required :bucket_name, String

#num_of_docs ⇒ Integer^?

Returns:

• (Integer, nil)

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

optional :num_of_docs, Integer

#query ⇒ String

Returns:

• (String)

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

required :query, String