Chroma#

class langchain_chroma.vectorstores.Chroma(collection_name: str = 'langchain', embedding_function: Embeddings | None = None, persist_directory: str | None = None, client_settings: Settings | None = None, collection_metadata: Dict | None = None, client: ClientAPI | None = None, relevance_score_fn: Callable[[float], float] | None = None, create_collection_if_not_exists: bool | None = True)[source]#

Chroma vector store integration.

Setup:

Install chromadb, langchain-chroma packages:

pip install -qU chromadb langchain-chroma

Key init args — indexing params:

collection_name: str: Name of the collection.
embedding_function: Embeddings: Embedding function to use.

Key init args — client params:

client: Optional[Client]: Chroma client to use.
client_settings: Optional[chromadb.config.Settings]: Chroma client settings.
persist_directory: Optional[str]: Directory to persist the collection.

Instantiate:

from langchain_chroma import Chroma
from langchain_openai import OpenAIEmbeddings

vector_store = Chroma(
    collection_name="foo",
    embedding_function=OpenAIEmbeddings(),
    # other params...
)

Add Documents:

from langchain_core.documents import Document

document_1 = Document(page_content="foo", metadata={"baz": "bar"})
document_2 = Document(page_content="thud", metadata={"bar": "baz"})
document_3 = Document(page_content="i will be deleted :(")

documents = [document_1, document_2, document_3]
ids = ["1", "2", "3"]
vector_store.add_documents(documents=documents, ids=ids)

Update Documents:

updated_document = Document(
    page_content="qux",
    metadata={"bar": "baz"}
)

vector_store.update_documents(ids=["1"],documents=[updated_document])

Delete Documents:

vector_store.delete(ids=["3"])

Search:

results = vector_store.similarity_search(query="thud",k=1)
for doc in results:
    print(f"* {doc.page_content} [{doc.metadata}]")

* thud [{'baz': 'bar'}]

Search with filter:

results = vector_store.similarity_search(query="thud",k=1,filter={"baz": "bar"})
for doc in results:
    print(f"* {doc.page_content} [{doc.metadata}]")

* foo [{'baz': 'bar'}]

Search with score:

results = vector_store.similarity_search_with_score(query="qux",k=1)
for doc, score in results:
    print(f"* [SIM={score:3f}] {doc.page_content} [{doc.metadata}]")

* [SIM=0.000000] qux [{'bar': 'baz', 'baz': 'bar'}]

Async:

# add documents
# await vector_store.aadd_documents(documents=documents, ids=ids)

# delete documents
# await vector_store.adelete(ids=["3"])

# search
# results = vector_store.asimilarity_search(query="thud",k=1)

# search with score
results = await vector_store.asimilarity_search_with_score(query="qux",k=1)
for doc,score in results:
    print(f"* [SIM={score:3f}] {doc.page_content} [{doc.metadata}]")

* [SIM=0.335463] foo [{'baz': 'bar'}]

Use as Retriever:

retriever = vector_store.as_retriever(
    search_type="mmr",
    search_kwargs={"k": 1, "fetch_k": 2, "lambda_mult": 0.5},
)
retriever.invoke("thud")

[Document(metadata={'baz': 'bar'}, page_content='thud')]

Initialize with a Chroma client.

Parameters:

collection_name (str) – Name of the collection to create.
embedding_function (Optional[Embeddings]) – Embedding class object. Used to embed texts.
persist_directory (Optional[str]) – Directory to persist the collection.
client_settings (Optional[chromadb.config.Settings]) – Chroma client settings
collection_metadata (Optional[Dict]) – Collection configurations.
client (Optional[chromadb.ClientAPI]) – Chroma client. Documentation: https://docs.trychroma.com/reference/js-client#class:-chromaclient
relevance_score_fn (Optional[Callable[[float], float]]) – Function to calculate relevance score from distance. Used only in similarity_search_with_relevance_scores
create_collection_if_not_exists (Optional[bool]) – Whether to create collection if it doesn’t exist. Defaults to True.

Attributes

embeddings

Access the query embedding object.

Methods

`__init__`([collection_name, ...])	Initialize with a Chroma client.
`aadd_documents`(documents, **kwargs)	Async run more documents through the embeddings and add to the vectorstore.
`aadd_texts`(texts[, metadatas])	Async run more texts through the embeddings and add to the vectorstore.
`add_documents`(documents, **kwargs)	Add or update documents in the vectorstore.
`add_images`(uris[, metadatas, ids])	Run more images through the embeddings and add to the vectorstore.
`add_texts`(texts[, metadatas, ids])	Run more texts through the embeddings and add to the vectorstore.
`adelete`([ids])	Async delete by vector ID or other criteria.
`afrom_documents`(documents, embedding, **kwargs)	Async return VectorStore initialized from documents and embeddings.
`afrom_texts`(texts, embedding[, metadatas])	Async return VectorStore initialized from texts and embeddings.
`aget_by_ids`(ids, /)	Async get documents by their IDs.
`amax_marginal_relevance_search`(query[, k, ...])	Async return docs selected using the maximal marginal relevance.
`amax_marginal_relevance_search_by_vector`(...)	Async return docs selected using the maximal marginal relevance.
`as_retriever`(**kwargs)	Return VectorStoreRetriever initialized from this VectorStore.
`asearch`(query, search_type, **kwargs)	Async return docs most similar to query using a specified search type.
`asimilarity_search`(query[, k])	Async return docs most similar to query.
`asimilarity_search_by_vector`(embedding[, k])	Async return docs most similar to embedding vector.
`asimilarity_search_with_relevance_scores`(query)	Async return docs and relevance scores in the range [0, 1].
`asimilarity_search_with_score`(args, *kwargs)	Async run similarity search with distance.
`delete`([ids])	Delete by vector IDs.
`delete_collection`()	Delete the collection.
`encode_image`(uri)	Get base64 string from image URI.
`from_documents`(documents[, embedding, ids, ...])	Create a Chroma vectorstore from a list of documents.
`from_texts`(texts[, embedding, metadatas, ...])	Create a Chroma vectorstore from a raw documents.
`get`([ids, where, limit, offset, ...])	Gets the collection.
`get_by_ids`(ids, /)	Get documents by their IDs.
`max_marginal_relevance_search`(query[, k, ...])	Return docs selected using the maximal marginal relevance.
`max_marginal_relevance_search_by_vector`(...)	Return docs selected using the maximal marginal relevance.
`reset_collection`()	Resets the collection.
`search`(query, search_type, **kwargs)	Return docs most similar to query using a specified search type.
`similarity_search`(query[, k, filter])	Run similarity search with Chroma.
`similarity_search_by_image`(uri[, k, filter])	Search for similar images based on the given image URI.
`similarity_search_by_image_with_relevance_score`(uri)	Search for similar images based on the given image URI.
`similarity_search_by_vector`(embedding[, k, ...])	Return docs most similar to embedding vector.
`similarity_search_by_vector_with_relevance_scores`(...)	Return docs most similar to embedding vector and similarity score.
`similarity_search_with_relevance_scores`(query)	Return docs and relevance scores in the range [0, 1].
`similarity_search_with_score`(query[, k, ...])	Run similarity search with Chroma with distance.
`update_document`(document_id, document)	Update a document in the collection.
`update_documents`(ids, documents)	Update a document in the collection.

__init__(collection_name: str = 'langchain', embedding_function: Embeddings | None = None, persist_directory: str | None = None, client_settings: Settings | None = None, collection_metadata: Dict | None = None, client: ClientAPI | None = None, relevance_score_fn: Callable[[float], float] | None = None, create_collection_if_not_exists: bool | None = True) → None[source]#

Initialize with a Chroma client.

Parameters:

collection_name (str) – Name of the collection to create.
embedding_function (Embeddings | None) – Embedding class object. Used to embed texts.
persist_directory (str | None) – Directory to persist the collection.
client_settings (Settings | None) – Chroma client settings
collection_metadata (Dict | None) – Collection configurations.
client (ClientAPI | None) – Chroma client. Documentation: https://docs.trychroma.com/reference/js-client#class:-chromaclient
relevance_score_fn (Callable[[float], float] | None) – Function to calculate relevance score from distance. Used only in similarity_search_with_relevance_scores
create_collection_if_not_exists (bool | None) – Whether to create collection if it doesn’t exist. Defaults to True.

Return type:

None

async aadd_documents(documents: list[Document], **kwargs: Any) → list[str]#

Async run more documents through the embeddings and add to the vectorstore.

Parameters:

documents (list[Document]) – Documents to add to the vectorstore.
kwargs (Any) – Additional keyword arguments.

Returns:

List of IDs of the added texts.

Raises:

ValueError – If the number of IDs does not match the number of documents.

Return type:

list[str]

async aadd_texts(texts: Iterable[str], metadatas: list[dict] | None = None, **kwargs: Any) → list[str]#

Async run more texts through the embeddings and add to the vectorstore.

Parameters:

texts (Iterable[str]) – Iterable of strings to add to the vectorstore.
metadatas (list[dict] | None) – Optional list of metadatas associated with the texts. Default is None.
**kwargs (Any) – vectorstore specific parameters.

Returns:

List of ids from adding the texts into the vectorstore.

Raises:

ValueError – If the number of metadatas does not match the number of texts.
ValueError – If the number of ids does not match the number of texts.

Return type:

list[str]

add_documents(documents: list[Document], **kwargs: Any) → list[str]#

Add or update documents in the vectorstore.

Parameters:

documents (list[Document]) – Documents to add to the vectorstore.
kwargs (Any) – Additional keyword arguments. if kwargs contains ids and documents contain ids, the ids in the kwargs will receive precedence.

Returns:

List of IDs of the added texts.

Raises:

ValueError – If the number of ids does not match the number of documents.

Return type:

list[str]

add_images(uris: List[str], metadatas: List[dict] | None = None, ids: List[str] | None = None, **kwargs: Any) → List[str][source]#

Run more images through the embeddings and add to the vectorstore.

Parameters:

uris (List[str]) – File path to the image.
metadatas (List[dict] | None) – Optional list of metadatas. When querying, you can filter on this metadata.
ids (List[str] | None) – Optional list of IDs.
kwargs (Any) – Additional keyword arguments to pass.

Returns:

List of IDs of the added images.

Raises:

ValueError – When metadata is incorrect.

Return type:

List[str]

add_texts(texts: Iterable[str], metadatas: List[dict] | None = None, ids: List[str] | None = None, **kwargs: Any) → List[str][source]#

Run more texts through the embeddings and add to the vectorstore.

Parameters:

texts (Iterable[str]) – Texts to add to the vectorstore.
metadatas (List[dict] | None) – Optional list of metadatas. When querying, you can filter on this metadata.
ids (List[str] | None) – Optional list of IDs.
kwargs (Any) – Additional keyword arguments.

Returns:

List of IDs of the added texts.

Raises:

ValueError – When metadata is incorrect.

Return type:

List[str]

async adelete(ids: list[str] | None = None, **kwargs: Any) → bool | None#

Async delete by vector ID or other criteria.

Parameters:

ids (list[str] | None) – List of ids to delete. If None, delete all. Default is None.
**kwargs (Any) – Other keyword arguments that subclasses might use.

Returns:

True if deletion is successful, False otherwise, None if not implemented.

Return type:

Optional[bool]

async classmethod afrom_documents(documents: list[Document], embedding: Embeddings, **kwargs: Any) → VST#

Async return VectorStore initialized from documents and embeddings.

Parameters:

documents (list[Document]) – List of Documents to add to the vectorstore.
embedding (Embeddings) – Embedding function to use.
kwargs (Any) – Additional keyword arguments.

Returns:

VectorStore initialized from documents and embeddings.

Return type:

VectorStore

async classmethod afrom_texts(texts: list[str], embedding: Embeddings, metadatas: list[dict] | None = None, **kwargs: Any) → VST#

Async return VectorStore initialized from texts and embeddings.

Parameters:

texts (list[str]) – Texts to add to the vectorstore.
embedding (Embeddings) – Embedding function to use.
metadatas (list[dict] | None) – Optional list of metadatas associated with the texts. Default is None.
kwargs (Any) – Additional keyword arguments.

Returns:

VectorStore initialized from texts and embeddings.

Return type:

VectorStore

async aget_by_ids(ids: Sequence[str], /) → list[Document]#

Async get documents by their IDs.

The returned documents are expected to have the ID field set to the ID of the document in the vector store.

Fewer documents may be returned than requested if some IDs are not found or if there are duplicated IDs.

Users should not assume that the order of the returned documents matches the order of the input IDs. Instead, users should rely on the ID field of the returned documents.

This method should NOT raise exceptions if no documents are found for some IDs.

Parameters:: ids (Sequence[str]) – List of ids to retrieve.
Returns:: List of Documents.
Return type:: list[Document]

Added in version 0.2.11.

async amax_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → list[Document]#

Async return docs selected using the maximal marginal relevance.

Maximal marginal relevance optimizes for similarity to query AND diversity among selected documents.

Parameters:

query (str) – Text to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
fetch_k (int) – Number of Documents to fetch to pass to MMR algorithm. Default is 20.
lambda_mult (float) – Number between 0 and 1 that determines the degree of diversity among the results with 0 corresponding to maximum diversity and 1 to minimum diversity. Defaults to 0.5.
kwargs (Any)

Returns:

List of Documents selected by maximal marginal relevance.

Return type:

list[Document]

async amax_marginal_relevance_search_by_vector(embedding: list[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → list[Document]#

Async return docs selected using the maximal marginal relevance.

Maximal marginal relevance optimizes for similarity to query AND diversity among selected documents.

Parameters:

embedding (list[float]) – Embedding to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
fetch_k (int) – Number of Documents to fetch to pass to MMR algorithm. Default is 20.
lambda_mult (float) – Number between 0 and 1 that determines the degree of diversity among the results with 0 corresponding to maximum diversity and 1 to minimum diversity. Defaults to 0.5.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents selected by maximal marginal relevance.

Return type:

list[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever#

Return VectorStoreRetriever initialized from this VectorStore.

Parameters:

**kwargs (Any) –

Keyword arguments to pass to the search function. Can include: search_type (Optional[str]): Defines the type of search that

the Retriever should perform. Can be “similarity” (default), “mmr”, or “similarity_score_threshold”.

search_kwargs (Optional[Dict]): Keyword arguments to pass to the

search function. Can include things like:

k: Amount of documents to return (Default: 4) score_threshold: Minimum relevance threshold

for similarity_score_threshold

fetch_k: Amount of documents to pass to MMR algorithm: (Default: 20)
lambda_mult: Diversity of results returned by MMR;: 1 for minimum diversity and 0 for maximum. (Default: 0.5)

filter: Filter by document metadata

Returns:

Retriever class for VectorStore.

Return type:

VectorStoreRetriever

Examples:

# Retrieve more documents with higher diversity
# Useful if your dataset has many similar documents
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 6, 'lambda_mult': 0.25}
)

# Fetch more documents for the MMR algorithm to consider
# But only return the top 5
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 5, 'fetch_k': 50}
)

# Only retrieve documents that have a relevance score
# Above a certain threshold
docsearch.as_retriever(
    search_type="similarity_score_threshold",
    search_kwargs={'score_threshold': 0.8}
)

# Only get the single most similar document from the dataset
docsearch.as_retriever(search_kwargs={'k': 1})

# Use a filter to only retrieve documents from a specific paper
docsearch.as_retriever(
    search_kwargs={'filter': {'paper_title':'GPT-4 Technical Report'}}
)

async asearch(query: str, search_type: str, **kwargs: Any) → list[Document]#

Async return docs most similar to query using a specified search type.

Parameters:

query (str) – Input text.
search_type (str) – Type of search to perform. Can be “similarity”, “mmr”, or “similarity_score_threshold”.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents most similar to the query.

Raises:

ValueError – If search_type is not one of “similarity”, “mmr”, or “similarity_score_threshold”.

Return type:

list[Document]

async asimilarity_search(query: str, k: int = 4, **kwargs: Any) → list[Document]#

Async return docs most similar to query.

Parameters:

query (str) – Input text.
k (int) – Number of Documents to return. Defaults to 4.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents most similar to the query.

Return type:

list[Document]

async asimilarity_search_by_vector(embedding: list[float], k: int = 4, **kwargs: Any) → list[Document]#

Async return docs most similar to embedding vector.

Parameters:

embedding (list[float]) – Embedding to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents most similar to the query vector.

Return type:

list[Document]

async asimilarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → list[tuple[Document, float]]#

Async return docs and relevance scores in the range [0, 1].

0 is dissimilar, 1 is most similar.

Parameters:

query (str) – Input text.
k (int) – Number of Documents to return. Defaults to 4.
**kwargs (Any) –
kwargs to be passed to similarity search. Should include: score_threshold: Optional, a floating point value between 0 to 1 to

filter the resulting set of retrieved docs

Returns:

List of Tuples of (doc, similarity_score)

Return type:

list[tuple[Document, float]]

async asimilarity_search_with_score(*args: Any, **kwargs: Any) → list[tuple[Document, float]]#

Async run similarity search with distance.

Parameters:

*args (Any) – Arguments to pass to the search method.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Tuples of (doc, similarity_score).

Return type:

list[tuple[Document, float]]

delete(ids: List[str] | None = None, **kwargs: Any) → None[source]#

Delete by vector IDs.

Parameters:

ids (List[str] | None) – List of ids to delete.
kwargs (Any) – Additional keyword arguments.

Return type:

None

delete_collection() → None[source]#

Delete the collection.

Return type:: None

encode_image(uri: str) → str[source]#

Get base64 string from image URI.

Parameters:: uri (str)
Return type:: str

classmethod from_documents(documents: List[Document], embedding: Embeddings | None = None, ids: List[str] | None = None, collection_name: str = 'langchain', persist_directory: str | None = None, client_settings: Settings | None = None, client: ClientAPI | None = None, collection_metadata: Dict | None = None, **kwargs: Any) → Chroma[source]#

Create a Chroma vectorstore from a list of documents.

If a persist_directory is specified, the collection will be persisted there. Otherwise, the data will be ephemeral in-memory.

Parameters:

collection_name (str) – Name of the collection to create.
persist_directory (str | None) – Directory to persist the collection.
ids (List[str] | None) – List of document IDs. Defaults to None.
documents (List[Document]) – List of documents to add to the vectorstore.
embedding (Embeddings | None) – Embedding function. Defaults to None.
client_settings (Settings | None) – Chroma client settings.
client (ClientAPI | None) – Chroma client. Documentation: https://docs.trychroma.com/reference/js-client#class:-chromaclient
collection_metadata (Dict | None) – Collection configurations. Defaults to None.
kwargs (Any) – Additional keyword arguments to initialize a Chroma client.

Returns:

Chroma vectorstore.

Return type:

Chroma

classmethod from_texts(texts: List[str], embedding: Embeddings | None = None, metadatas: List[dict] | None = None, ids: List[str] | None = None, collection_name: str = 'langchain', persist_directory: str | None = None, client_settings: Settings | None = None, client: ClientAPI | None = None, collection_metadata: Dict | None = None, **kwargs: Any) → Chroma[source]#

Create a Chroma vectorstore from a raw documents.

If a persist_directory is specified, the collection will be persisted there. Otherwise, the data will be ephemeral in-memory.

Parameters:

texts (List[str]) – List of texts to add to the collection.
collection_name (str) – Name of the collection to create.
persist_directory (str | None) – Directory to persist the collection.
embedding (Embeddings | None) – Embedding function. Defaults to None.
metadatas (List[dict] | None) – List of metadatas. Defaults to None.
ids (List[str] | None) – List of document IDs. Defaults to None.
client_settings (Settings | None) – Chroma client settings.
client (ClientAPI | None) – Chroma client. Documentation: https://docs.trychroma.com/reference/js-client#class:-chromaclient
collection_metadata (Dict | None) – Collection configurations. Defaults to None.
kwargs (Any) – Additional keyword arguments to initialize a Chroma client.

Returns:

Chroma vectorstore.

Return type:

Chroma

Gets the collection.

Parameters:

ids (Optional[OneOrMany[ID]]) – The ids of the embeddings to get. Optional.
where (Optional[Where]) – A Where type dict used to filter results by. E.g. {“color” : “red”, “price”: 4.20}. Optional.
limit (Optional[int]) – The number of documents to return. Optional.
offset (Optional[int]) – The offset to start returning results from. Useful for paging results with limit. Optional.
where_document (Optional[WhereDocument]) – A WhereDocument type dict used to filter by the documents. E.g. {$contains: “hello”}. Optional.
include (Optional[List[str]]) – A list of what to include in the results. Can contain “embeddings”, “metadatas”, “documents”. Ids are always included. Defaults to [“metadatas”, “documents”]. Optional.

Returns:

A dict with the keys “ids”, “embeddings”, “metadatas”, “documents”.

Return type:

Dict[str, Any]

get_by_ids(ids: Sequence[str], /) → list[Document]#

Get documents by their IDs.

The returned documents are expected to have the ID field set to the ID of the document in the vector store.

Fewer documents may be returned than requested if some IDs are not found or if there are duplicated IDs.

Users should not assume that the order of the returned documents matches the order of the input IDs. Instead, users should rely on the ID field of the returned documents.

This method should NOT raise exceptions if no documents are found for some IDs.

Parameters:: ids (Sequence[str]) – List of ids to retrieve.
Returns:: List of Documents.
Return type:: list[Document]

Added in version 0.2.11.

max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Dict[str, str] | None = None, where_document: Dict[str, str] | None = None, **kwargs: Any) → List[Document][source]#

Return docs selected using the maximal marginal relevance.

Maximal marginal relevance optimizes for similarity to query AND diversity among selected documents.

Parameters:

query (str) – Text to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
fetch_k (int) – Number of Documents to fetch to pass to MMR algorithm.
lambda_mult (float) – Number between 0 and 1 that determines the degree of diversity among the results with 0 corresponding to maximum diversity and 1 to minimum diversity. Defaults to 0.5.
filter (Dict[str, str] | None) – Filter by metadata. Defaults to None.
where_document (Dict[str, str] | None) – dict used to filter by the documents. E.g. {$contains: {“text”: “hello”}}.
kwargs (Any) – Additional keyword arguments to pass to Chroma collection query.

Returns:

List of Documents selected by maximal marginal relevance.

Raises:

ValueError – If the embedding function is not provided.

Return type:

List[Document]

max_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: Dict[str, str] | None = None, where_document: Dict[str, str] | None = None, **kwargs: Any) → List[Document][source]#

Return docs selected using the maximal marginal relevance.

Maximal marginal relevance optimizes for similarity to query AND diversity among selected documents.

Parameters:

embedding (List[float]) – Embedding to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
fetch_k (int) – Number of Documents to fetch to pass to MMR algorithm. Defaults to 20.
lambda_mult (float) – Number between 0 and 1 that determines the degree of diversity among the results with 0 corresponding to maximum diversity and 1 to minimum diversity. Defaults to 0.5.
filter (Dict[str, str] | None) – Filter by metadata. Defaults to None.
where_document (Dict[str, str] | None) – dict used to filter by the documents. E.g. {$contains: {“text”: “hello”}}.
kwargs (Any) – Additional keyword arguments to pass to Chroma collection query.

Returns:

List of Documents selected by maximal marginal relevance.

Return type:

List[Document]

reset_collection() → None[source]#

Resets the collection.

Resets the collection by deleting the collection and recreating an empty one.

Return type:: None

search(query: str, search_type: str, **kwargs: Any) → list[Document]#

Return docs most similar to query using a specified search type.

Parameters:

query (str) – Input text
search_type (str) – Type of search to perform. Can be “similarity”, “mmr”, or “similarity_score_threshold”.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents most similar to the query.

Raises:

ValueError – If search_type is not one of “similarity”, “mmr”, or “similarity_score_threshold”.

Return type:

list[Document]

similarity_search(query: str, k: int = 4, filter: Dict[str, str] | None = None, **kwargs: Any) → List[Document][source]#

Run similarity search with Chroma.

Parameters:

query (str) – Query text to search for.
k (int) – Number of results to return. Defaults to 4.
filter (Dict[str, str] | None) – Filter by metadata. Defaults to None.
kwargs (Any) – Additional keyword arguments to pass to Chroma collection query.

Returns:

List of documents most similar to the query text.

Return type:

List[Document]

similarity_search_by_image(uri: str, k: int = 4, filter: Dict[str, str] | None = None, **kwargs: Any) → List[Document][source]#

Search for similar images based on the given image URI.

Parameters:

uri (str) – URI of the image to search for.
k (int, optional) – Number of results to return. Defaults to DEFAULT_K.
filter (Optional[Dict[str, str]], optional) – Filter by metadata.
**kwargs (Any) – Additional arguments to pass to function.

Returns:

List of Images most similar to the provided image. Each element in list is a Langchain Document Object. The page content is b64 encoded image, metadata is default or as defined by user.

Raises:

ValueError – If the embedding function does not support image embeddings.

Return type:

List[Document]

similarity_search_by_image_with_relevance_score(uri: str, k: int = 4, filter: Dict[str, str] | None = None, **kwargs: Any) → List[Tuple[Document, float]][source]#

Search for similar images based on the given image URI.

Parameters:

uri (str) – URI of the image to search for.
k (int, optional) – Number of results to return.
DEFAULT_K. (Defaults to)
filter (Optional[Dict[str, str]], optional) – Filter by metadata.
**kwargs (Any) – Additional arguments to pass to function.

Returns:

List of tuples containing documents similar to the query image and their similarity scores. 0th element in each tuple is a Langchain Document Object. The page content is b64 encoded img, metadata is default or defined by user.

Return type:

List[Tuple[Document, float]]

Raises:

ValueError – If the embedding function does not support image embeddings.

similarity_search_by_vector(embedding: List[float], k: int = 4, filter: Dict[str, str] | None = None, where_document: Dict[str, str] | None = None, **kwargs: Any) → List[Document][source]#

Return docs most similar to embedding vector.

Parameters:

embedding (List[float]) – Embedding to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
filter (Dict[str, str] | None) – Filter by metadata. Defaults to None.
where_document (Dict[str, str] | None) – dict used to filter by the documents. E.g. {$contains: {“text”: “hello”}}.
kwargs (Any) – Additional keyword arguments to pass to Chroma collection query.

Returns:

List of Documents most similar to the query vector.

Return type:

List[Document]

similarity_search_by_vector_with_relevance_scores(embedding: List[float], k: int = 4, filter: Dict[str, str] | None = None, where_document: Dict[str, str] | None = None, **kwargs: Any) → List[Tuple[Document, float]][source]#

Return docs most similar to embedding vector and similarity score.

Parameters:

embedding (List[float]) – Embedding to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
filter (Dict[str, str] | None) – Filter by metadata. Defaults to None.
where_document (Dict[str, str] | None) – dict used to filter by the documents. E.g. {$contains: {“text”: “hello”}}.
kwargs (Any) – Additional keyword arguments to pass to Chroma collection query.

Returns:

List of documents most similar to the query text and relevance score in float for each. Lower score represents more similarity.

Return type:

List[Tuple[Document, float]]

similarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → list[tuple[Document, float]]#

Return docs and relevance scores in the range [0, 1].

0 is dissimilar, 1 is most similar.

Parameters:

query (str) – Input text.
k (int) – Number of Documents to return. Defaults to 4.
**kwargs (Any) –
kwargs to be passed to similarity search. Should include: score_threshold: Optional, a floating point value between 0 to 1 to

filter the resulting set of retrieved docs.

Returns:

List of Tuples of (doc, similarity_score).

Return type:

list[tuple[Document, float]]

similarity_search_with_score(query: str, k: int = 4, filter: Dict[str, str] | None = None, where_document: Dict[str, str] | None = None, **kwargs: Any) → List[Tuple[Document, float]][source]#

Run similarity search with Chroma with distance.

Parameters:

query (str) – Query text to search for.
k (int) – Number of results to return. Defaults to 4.
filter (Dict[str, str] | None) – Filter by metadata. Defaults to None.
where_document (Dict[str, str] | None) – dict used to filter by the documents. E.g. {$contains: {“text”: “hello”}}.
kwargs (Any) – Additional keyword arguments to pass to Chroma collection query.

Returns:

List of documents most similar to the query text and distance in float for each. Lower score represents more similarity.

Return type:

List[Tuple[Document, float]]

update_document(document_id: str, document: Document) → None[source]#

Update a document in the collection.

Parameters:

document_id (str) – ID of the document to update.
document (Document) – Document to update.

Return type:

None

update_documents(ids: List[str], documents: List[Document]) → None[source]#

Update a document in the collection.

Parameters:

ids (List[str]) – List of ids of the document to update.
documents (List[Document]) – List of documents to update.

Raises:

ValueError – If the embedding function is not provided.

Return type:

None

Examples using Chroma