ExChromaDb (ex_chroma_db v0.1.0)
View SourceThis module provides a client for the ChromaDB API.
Summary
Functions
@spec collection_records_add( ExChromaDb.Types.collection_info(), ExChromaDb.Types.records() ) :: ExChromaDb.Types.one_result(boolean())
@spec collection_records_count(ExChromaDb.Types.collection_info()) :: ExChromaDb.Types.one_result(non_neg_integer())
@spec collection_records_delete(ExChromaDb.Types.collection_info(), %{ ids: [ExChromaDb.Types.record_id()] | nil, where: map() | nil, where_document: map() | nil }) :: ExChromaDb.Types.one_result(boolean())
@spec collection_records_delete_by_ids(ExChromaDb.Types.collection_info(), [ ExChromaDb.Types.record_id() ]) :: ExChromaDb.Types.one_result(boolean())
@spec collection_records_delete_by_metas(ExChromaDb.Types.collection_info(), map()) :: ExChromaDb.Types.one_result(boolean())
@spec collection_records_get( ExChromaDb.Types.collection_info(), %{ include: [String.t()] | nil, ids: [ExChromaDb.Types.record_id()] | nil, where: map() | nil, where_document: map() | nil }, ExChromaDb.Types.pagination() ) :: ExChromaDb.Types.one_result(ExChromaDb.Api.GetResponse.t())
@spec collection_records_query( ExChromaDb.Types.collection_info(), %{ include: [String.t()] | nil, ids: [ExChromaDb.Types.record_id()] | nil, where: map() | nil, where_document: map() | nil, query_embeddings: [ExChromaDb.Types.document_embedding()] | nil, query_texts: [String.t()] | nil, n_results: integer() | nil } ) :: ExChromaDb.Types.one_result(ExChromaDb.Api.QueryResponse.t())
@spec collection_records_update( ExChromaDb.Types.collection_info(), ExChromaDb.Types.records() ) :: ExChromaDb.Types.one_result(boolean())
@spec collection_records_upsert( ExChromaDb.Types.collection_info(), ExChromaDb.Types.records() ) :: ExChromaDb.Types.one_result(boolean())
@spec count_collections(ExChromaDb.Types.database_info()) :: ExChromaDb.Types.one_result(non_neg_integer())
@spec create_collection(ExChromaDb.Types.collection_info()) :: ExChromaDb.Types.one_result(String.t())
@spec create_database(ExChromaDb.Types.database_info()) :: ExChromaDb.Types.one_result(String.t())
@spec create_tenant(String.t()) :: ExChromaDb.Types.one_result(String.t())
@spec delete_collection(ExChromaDb.Types.collection_info()) :: ExChromaDb.Types.one_result(boolean())
@spec get_collection_info(ExChromaDb.Types.collection_info()) :: ExChromaDb.Types.one_result(ExChromaDb.Api.Collection.t())
@spec get_database(ExChromaDb.Types.database_info()) :: ExChromaDb.Types.one_result(boolean())
@spec get_or_create_collection(ExChromaDb.Types.collection_info()) :: ExChromaDb.Types.one_result(boolean())
@spec get_or_create_database(ExChromaDb.Types.database_info()) :: ExChromaDb.Types.one_result(boolean())
@spec get_or_create_tenant(String.t()) :: ExChromaDb.Types.one_result(boolean())
@spec get_tenant(String.t()) :: ExChromaDb.Types.one_result(boolean())
@spec healthcheck() :: ExChromaDb.Types.one_result(boolean())
@spec heartbeat() :: ExChromaDb.Types.one_result(non_neg_integer())
@spec list_collections( ExChromaDb.Types.database_info(), ExChromaDb.Types.pagination() ) :: ExChromaDb.Types.list_result(ExChromaDb.Api.Vec.t())
@spec list_databases(String.t(), ExChromaDb.Types.pagination()) :: ExChromaDb.Types.list_result(ExChromaDb.Api.Vec.t())
@spec reset() :: ExChromaDb.Types.one_result(boolean())
@spec version() :: ExChromaDb.Types.one_result(String.t())