EncoderType Objects
EncoderInfo Objects
RouteChoice Objects
Message Objects
to_openai
to_cohere
to_llamacpp
to_mistral
to_voyage
to_jina
__str__
ConfigParameter Objects
to_pinecone
dimensions
(int
): The dimensions of the Pinecone index.
dict
: A Pinecone-compatible configuration parameter.
Utterance Objects
from_tuple
tuple_obj
(Tuple
): A tuple containing route, utterance, function schemas and metadata.
Utterance
: An Utterance object.
to_tuple
Tuple
: A tuple containing (route, utterance, function schemas, metadata).
to_str
include_metadata
(bool
): Whether to include metadata in the string.
str
: A string representation of the Utterance object.
SyncMode Objects
UtteranceDiff Objects
from_utterances
local_utterances
(List[Utterance]
): A list of Utterance objects.remote_utterances
(List[Utterance]
): A list of Utterance objects.
to_utterance_str
include_metadata
(bool
): Whether to include metadata in the string.
List[str]
: A list of diff strings.
get_tag
diff_tag
(str
): The diff tag to filter by. Must be one of ”+”, ”-”, or ” ”.
List[Utterance]
: A list of Utterance objects.
get_sync_strategy
sync_mode
(str
): The mode to sync the routes with the remote index.
dict
: A dictionary describing the synchronization strategy.
Metric Objects
SparseEmbedding Objects
from_compact_array
array
(np.ndarray
): A compact array.
SparseEmbedding
: A SparseEmbedding object.
from_vector
vector
(np.ndarray
): A sparse vector.
SparseEmbedding
: A SparseEmbedding object.
from_aurelio
embedding
(BM25SparseEmbedding
): An AurelioSparseEmbedding object.
SparseEmbedding
: A SparseEmbedding object.
from_dict
sparse_dict
(dict
): A dictionary of sparse values.
SparseEmbedding
: A SparseEmbedding object.
from_pinecone_dict
sparse_dict
(dict
): A Pinecone dictionary.
SparseEmbedding
: A SparseEmbedding object.
to_dict
dict
: A dictionary of sparse values.
to_pinecone
dict
: A Pinecone dictionary.
items
list
: A list of (index, value) tuples.