色度

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)

Chroma向量存储集成。

Setup:

安装 chromadb, langchain-chroma 包：

pip install -qU chromadb langchain-chroma

Key init args — indexing params:

collection_name: str

集合的名称。

embedding_function: Embeddings

使用的嵌入函数。

Key init args — client params:

client: Optional[Client]

使用的Chroma客户端。

client_settings: Optional[chromadb.config.Settings]

Chroma 客户端设置。

persist_directory: Optional[str]

用于持久化集合的目录。

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')]

使用Chroma客户端进行初始化。

Parameters:

• collection_name (str) – 要创建的集合的名称。

• embedding_function (可选[Embeddings]) – 嵌入类对象。用于嵌入文本。

• persist_directory (可选[str]) – 用于持久化集合的目录。

• client_settings (Optional[chromadb.config.Settings]) – Chroma 客户端设置

• collection_metadata (可选[字典]) – 集合配置。

• client (可选[chromadb.ClientAPI]) – Chroma 客户端。文档： https://docs.trychroma.com/reference/js-client#class:-chromaclient

• relevance_score_fn (可选[Callable[[float], float]]) – 用于根据距离计算相关性得分的函数。 仅在similarity_search_with_relevance_scores中使用

• create_collection_if_not_exists (Optional[bool]) – 如果集合不存在，是否创建集合。默认为 True。

属性

embeddings

访问查询嵌入对象。

方法

__init__([collection_name, ...])	使用Chroma客户端进行初始化。
aadd_documents(documents, **kwargs)	异步运行更多文档通过嵌入并添加到向量存储中。
aadd_texts(texts[, metadatas, ids])	异步运行更多文本通过嵌入并添加到向量存储中。
add_documents(documents, **kwargs)	在向量存储中添加或更新文档。
add_images(uris[, metadatas, ids])	通过嵌入运行更多图像并将其添加到向量存储中。
add_texts(texts[, metadatas, ids])	通过嵌入运行更多文本并将其添加到向量存储中。
adelete([ids])	异步删除通过向量ID或其他条件。
afrom_documents(documents, embedding, **kwargs)	异步返回从文档和嵌入初始化的VectorStore。
afrom_texts(texts, embedding[, metadatas, ids])	异步返回从文本和嵌入初始化的VectorStore。
aget_by_ids(ids, /)	异步通过ID获取文档。
amax_marginal_relevance_search(query[, k, ...])	异步返回使用最大边际相关性选择的文档。
amax_marginal_relevance_search_by_vector(...)	异步返回使用最大边际相关性选择的文档。
as_retriever(**kwargs)	返回从此VectorStore初始化的VectorStoreRetriever。
asearch(query, search_type, **kwargs)	异步返回与查询最相似的文档，使用指定的搜索类型。
asimilarity_search(query[, k])	异步返回与查询最相似的文档。
asimilarity_search_by_vector(embedding[, k])	异步返回与嵌入向量最相似的文档。
asimilarity_search_with_relevance_scores(query)	异步返回文档和相关度分数，范围在[0, 1]之间。
asimilarity_search_with_score(*args, **kwargs)	异步运行带距离的相似性搜索。
delete([ids])	通过向量ID删除。
delete_collection()	删除集合。
encode_image(uri)	从图像URI获取base64字符串。
from_documents(documents[, embedding, ids, ...])	从文档列表创建一个Chroma向量存储。
from_texts(texts[, embedding, metadatas, ...])	从原始文档创建一个Chroma向量存储。
get([ids, where, limit, offset, ...])	获取集合。
get_by_ids(ids, /)	通过ID获取文档。
max_marginal_relevance_search(query[, k, ...])	返回使用最大边际相关性选择的文档。
max_marginal_relevance_search_by_vector(...)	返回使用最大边际相关性选择的文档。
reset_collection()	重置集合。
search(query, search_type, **kwargs)	使用指定的搜索类型返回与查询最相似的文档。
similarity_search(query[, k, filter])	使用Chroma进行相似性搜索。
similarity_search_by_image(uri[, k, filter])	根据给定的图像URI搜索相似的图像。
similarity_search_by_image_with_relevance_score(uri)	根据给定的图像URI搜索相似的图像。
similarity_search_by_vector(embedding[, k, ...])	返回与嵌入向量最相似的文档。
similarity_search_by_vector_with_relevance_scores(...)	返回与嵌入向量最相似的文档及其相似度分数。
similarity_search_with_relevance_scores(query)	返回文档和相关度分数，范围在[0, 1]之间。
similarity_search_with_score(query[, k, ...])	使用Chroma进行带距离的相似性搜索。
similarity_search_with_vectors(query[, k, ...])	使用Chroma进行向量相似性搜索。
update_document(document_id, document)	更新集合中的文档。
update_documents(ids, documents)	更新集合中的文档。

__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

使用Chroma客户端进行初始化。

Parameters:

• collection_name (str) – 要创建的集合的名称。

• embedding_function (Embeddings | None) – 嵌入类对象。用于嵌入文本。

• persist_directory (str | None) – 用于持久化集合的目录。

• client_settings (Settings | None) – Chroma 客户端设置

• collection_metadata (Dict | None) – 集合配置。

• client (ClientAPI | None) – Chroma 客户端。文档： https://docs.trychroma.com/reference/js-client#class:-chromaclient

• relevance_score_fn (Callable[[float], float] | None) – 用于从距离计算相关性得分的函数。 仅在similarity_search_with_relevance_scores中使用

• create_collection_if_not_exists (bool | None) – 如果集合不存在，是否创建集合。默认为 True。

Return type:

无

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

通过嵌入异步运行更多文档并将其添加到向量存储中。

Parameters:

• documents (list[Document]) – 要添加到向量存储中的文档。

• kwargs (Any) – 额外的关键字参数。

Returns:

已添加文本的ID列表。

Raises:

ValueError – 如果ID的数量与文档的数量不匹配。

Return type:

列表[字符串]

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

异步运行更多文本通过嵌入并添加到向量存储中。

Parameters:

• texts (Iterable[str]) – 要添加到向量存储中的字符串的可迭代对象。

• metadatas (list[dict] | None) – 可选的与文本关联的元数据列表。默认值为 None。

• ids (list[str] | None) – 可选的列表

• **kwargs (Any) – 向量存储特定参数。

Returns:

将文本添加到向量存储中后的ID列表。

Raises:

• ValueError – 如果元数据的数量与文本的数量不匹配。

• ValueError – 如果id的数量与文本的数量不匹配。

Return type:

列表[字符串]

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

在向量存储中添加或更新文档。

Parameters:

• documents (list[Document]) – 要添加到向量存储中的文档。

• kwargs (Any) – 额外的关键字参数。 如果 kwargs 包含 ids 并且 documents 也包含 ids， kwargs 中的 ids 将优先。

Returns:

已添加文本的ID列表。

Raises:

ValueError – 如果id的数量与文档的数量不匹配。

Return type:

列表[字符串]

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

通过嵌入运行更多图像并添加到向量存储中。

Parameters:

• uris (List[str]) – 图像的路径。

• metadatas (List[dict] | None) – 可选的元数据列表。 在查询时，您可以基于此元数据进行过滤。

• ids (List[str] | None) – 可选的ID列表。

• kwargs (Any) – 传递的额外关键字参数。

Returns:

添加图像的ID列表。

Raises:

ValueError – 当元数据不正确时。

Return type:

列表[str]

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

通过嵌入运行更多文本并添加到向量存储中。

Parameters:

• texts (Iterable[str]) – 要添加到向量存储中的文本。

• metadatas (List[dict] | None) – 可选的元数据列表。 在查询时，您可以基于此元数据进行过滤。

• ids (List[str] | None) – 可选的ID列表。

• kwargs (Any) – 额外的关键字参数。

Returns:

已添加文本的ID列表。

Raises:

ValueError – 当元数据不正确时。

Return type:

列表[str]

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

通过向量ID或其他条件异步删除。

Parameters:

• ids (list[str] | None) – 要删除的id列表。如果为None，则删除所有。默认值为None。

• **kwargs (Any) – 子类可能使用的其他关键字参数。

Returns:

如果删除成功则为真， 否则为假，如果未实现则为无。

Return type:

可选[布尔]

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

异步返回从文档和嵌入初始化的VectorStore。

Parameters:

• documents (list[Document]) – 要添加到向量存储中的文档列表。

• embedding (Embeddings) – 使用的嵌入函数。

• kwargs (Any) – 额外的关键字参数。

Returns:

从文档和嵌入初始化的VectorStore。

Return type:

VectorStore

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

异步返回从文本和嵌入初始化的VectorStore。

Parameters:

• texts (list[str]) – 要添加到向量存储中的文本。

• embedding (Embeddings) – 使用的嵌入函数。

• metadatas (list[dict] | None) – 可选的与文本关联的元数据列表。默认值为 None。

• ids (list[str] | None) – 可选的与文本关联的ID列表。

• kwargs (Any) – 额外的关键字参数。

Returns:

VectorStore 从文本和嵌入初始化。

Return type:

VectorStore

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

通过ID异步获取文档。

返回的文档预计将具有ID字段，该字段设置为向量存储中文档的ID。

如果某些ID未找到或存在重复的ID，返回的文档数量可能少于请求的数量。

用户不应假设返回文档的顺序与输入ID的顺序相匹配。相反，用户应依赖返回文档的ID字段。

如果没有找到某些ID的文档，此方法不应引发异常。

Parameters:

ids (Sequence[str]) – 要检索的ID列表。

Returns:

文档列表。

Return type:

列表[Document]

在版本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]

异步返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

Parameters:

• query (str) – 用于查找相似文档的文本。

• k (int) – 返回的文档数量。默认为4。

• fetch_k (int) – 要传递给MMR算法的文档数量。 默认值为20。

• lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

• kwargs (Any)

Returns:

通过最大边际相关性选择的文档列表。

Return type:

列表[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]

异步返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

Parameters:

• embedding (list[float]) – 用于查找相似文档的嵌入。

• k (int) – 返回的文档数量。默认为4。

• fetch_k (int) – 要传递给MMR算法的文档数量。 默认值为20。

• lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

• **kwargs (Any) – 传递给搜索方法的参数。

Returns:

通过最大边际相关性选择的文档列表。

Return type:

列表[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever

返回从此VectorStore初始化的VectorStoreRetriever。

Parameters:

**kwargs (Any) –

传递给搜索函数的关键字参数。 可以包括： search_type (Optional[str]): 定义检索器应执行的搜索类型。 可以是“similarity”（默认）、“mmr”或“similarity_score_threshold”。

检索器应执行的搜索类型。 可以是“similarity”（默认）、“mmr”或“similarity_score_threshold”。

search_kwargs (Optional[Dict]): 传递给搜索函数的关键字参数。

可以包括以下内容：

k: 返回的文档数量（默认：4） score_threshold: 最小相关性阈值

用于similarity_score_threshold

fetch_k: 传递给MMR算法的文档数量

（默认：20）

lambda_mult: MMR返回结果的多样性；

1表示最小多样性，0表示最大多样性。（默认：0.5）

filter: 按文档元数据过滤

Returns:

VectorStore的检索器类。

Return type:

VectorStoreRetriever

示例：

# 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]

异步返回与查询最相似的文档，使用指定的搜索类型。

Parameters:

• query (str) – 输入文本。

• search_type (str) – 要执行的搜索类型。可以是“similarity”、“mmr”或“similarity_score_threshold”。

• **kwargs (Any) – 传递给搜索方法的参数。

Returns:

与查询最相似的文档列表。

Raises:

ValueError – 如果 search_type 不是 “similarity”、“mmr” 或 “similarity_score_threshold” 之一。

Return type:

列表[Document]

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

异步返回与查询最相似的文档。

Parameters:

• query (str) – 输入文本。

• k (int) – 返回的文档数量。默认为4。

• **kwargs (Any) – 传递给搜索方法的参数。

Returns:

与查询最相似的文档列表。

Return type:

列表[Document]

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

异步返回与嵌入向量最相似的文档。

Parameters:

• embedding (list[float]) – 用于查找相似文档的嵌入。

• k (int) – 返回的文档数量。默认为4。

• **kwargs (Any) – 传递给搜索方法的参数。

Returns:

与查询向量最相似的文档列表。

Return type:

列表[Document]

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

异步返回文档和相关度分数，范围在[0, 1]之间。

0 表示不相似，1 表示最相似。

Parameters:

• query (str) – 输入文本。

• k (int) – 返回的文档数量。默认为4。

• **kwargs (Any) –

  传递给相似性搜索的kwargs。应包括： score_threshold: 可选，一个介于0到1之间的浮点值

  过滤检索到的文档集

Returns:

（文档，相似度分数）的元组列表

Return type:

列表[元组[Document, 浮点数]]

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

异步运行带有距离的相似性搜索。

Parameters:

• *args (Any) – 传递给搜索方法的参数。

• **kwargs (Any) – 传递给搜索方法的参数。

Returns:

(文档, 相似度分数) 的元组列表。

Return type:

列表[元组[Document, 浮点数]]

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

通过向量ID删除。

Parameters:

• ids (List[str] | None) – 要删除的ID列表。

• kwargs (Any) – 额外的关键字参数。

Return type:

无

delete_collection() → None

删除集合。

Return type:

无

encode_image(uri: str) → str

从图像URI获取base64字符串。

Parameters:

uri (str)

Return type:

字符串

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

从文档列表创建一个Chroma向量存储。

如果指定了persist_directory，集合将持久化到该目录。 否则，数据将在内存中是临时的。

Parameters:

• collection_name (str) – 要创建的集合的名称。

• persist_directory (str | None) – 用于持久化集合的目录。

• ids (List[str] | None) – 文档ID列表。默认为None。

• documents (List[Document]) – 要添加到向量存储中的文档列表。

• embedding (Embeddings | None) – 嵌入函数。默认为 None。

• client_settings (Settings | None) – Chroma 客户端设置。

• client (ClientAPI | None) – Chroma 客户端。文档： https://docs.trychroma.com/reference/js-client#class:-chromaclient

• collection_metadata (Dict | None) – 集合配置。默认为 None。

• kwargs (Any) – 用于初始化 Chroma 客户端的额外关键字参数。

Returns:

Chroma向量存储。

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

从原始文档创建一个Chroma向量存储。

如果指定了persist_directory，集合将持久化到该目录。 否则，数据将在内存中是临时的。

Parameters:

• texts (List[str]) – 要添加到集合中的文本列表。

• collection_name (str) – 要创建的集合的名称。

• persist_directory (str | None) – 用于持久化集合的目录。

• embedding (Embeddings | None) – 嵌入函数。默认为 None。

• metadatas (List[dict] | None) – 元数据列表。默认为 None。

• ids (List[str] | None) – 文档ID列表。默认为None。

• client_settings (Settings | None) – Chroma 客户端设置。

• client (ClientAPI | None) – Chroma 客户端。文档： https://docs.trychroma.com/reference/js-client#class:-chromaclient

• collection_metadata (Dict | None) – 集合配置。默认为 None。

• kwargs (Any) – 用于初始化 Chroma 客户端的额外关键字参数。

Returns:

Chroma向量存储。

Return type:

Chroma

get(ids: OneOrMany[ID] | None = None, where: Where | None = None, limit: int | None = None, offset: int | None = None, where_document: WhereDocument | None = None, include: List[str] | None = None) → Dict[str, Any]

获取集合。

Parameters:

• ids (可选[一个或多个[ID]]) – 要获取的嵌入的ID。可选。

• where (可选[Where]) – 用于通过过滤结果的Where类型字典。 例如 {“$and”: [{“color”: “red”}, {“price”: 4.20}]} 可选。

• limit (可选[int]) – 返回的文档数量。可选。

• offset (可选[int]) – 开始返回结果的偏移量。 用于分页结果时与limit一起使用。可选。

• where_document (可选[WhereDocument]) – 用于通过文档进行过滤的WhereDocument类型字典。 例如 {$contains: “hello”}。可选。

• include (可选[列表[字符串]]) – 结果中包含的内容列表。 可以包含 “embeddings”, “metadatas”, “documents”。 Ids 总是包含在内。 默认为 [“metadatas”, “documents”]。可选。

Returns:

一个包含键“ids”、“embeddings”、“metadatas”、“documents”的字典。

Return type:

Dict[str, Any]

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

通过ID获取文档。

返回的文档预计将具有ID字段，该字段设置为向量存储中文档的ID。

如果某些ID未找到或存在重复的ID，返回的文档数量可能少于请求的数量。

用户不应假设返回文档的顺序与输入ID的顺序相匹配。相反，用户应依赖返回文档的ID字段。

如果没有找到某些ID的文档，此方法不应引发异常。

Parameters:

ids (Sequence[str]) – 要检索的ID列表。

Returns:

文档列表。

Return type:

列表[Document]

在版本0.2.1中添加。

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]

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

Parameters:

• query (str) – 用于查找相似文档的文本。

• k (int) – 返回的文档数量。默认为4。

• fetch_k (int) – 要获取并传递给MMR算法的文档数量。

• lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

• filter (Dict[str, str] | None) – 通过元数据进行过滤。默认为 None。

• where_document (Dict[str, str] | None) – 用于通过文档进行过滤的字典。 例如 {$contains: {“text”: “hello”}}.

• kwargs (Any) – 传递给 Chroma 集合查询的额外关键字参数。

Returns:

通过最大边际相关性选择的文档列表。

Raises:

ValueError – 如果未提供嵌入函数。

Return type:

列表[文档]

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]

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

Parameters:

• embedding (List[float]) – 用于查找相似文档的嵌入。

• k (int) – 返回的文档数量。默认为4。

• fetch_k (int) – 要获取并传递给MMR算法的文档数量。默认为20。

• lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

• filter (Dict[str, str] | None) – 通过元数据进行过滤。默认为 None。

• where_document (Dict[str, str] | None) – 用于通过文档进行过滤的字典。 例如 {$contains: {“text”: “hello”}}.

• kwargs (Any) – 传递给 Chroma 集合查询的额外关键字参数。

Returns:

通过最大边际相关性选择的文档列表。

Return type:

列表[文档]

reset_collection() → None

重置集合。

通过删除集合并重新创建一个空集合来重置集合。

Return type:

无

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

使用指定的搜索类型返回与查询最相似的文档。

Parameters:

• query (str) – 输入文本

• search_type (str) – 要执行的搜索类型。可以是“similarity”、“mmr”或“similarity_score_threshold”。

• **kwargs (Any) – 传递给搜索方法的参数。

Returns:

与查询最相似的文档列表。

Raises:

ValueError – 如果 search_type 不是 “similarity”、“mmr” 或 “similarity_score_threshold” 之一。

Return type:

列表[Document]

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

使用Chroma运行相似性搜索。

Parameters:

• query (str) – 要搜索的查询文本。

• k (int) – 返回的结果数量。默认为4。

• filter (Dict[str, str] | None) – 通过元数据进行过滤。默认为 None。

• kwargs (Any) – 传递给 Chroma 集合查询的额外关键字参数。

Returns:

与查询文本最相似的文档列表。

Return type:

列表[文档]

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

根据给定的图像URI搜索相似的图像。

Parameters:

• uri (str) – 要搜索的图像的URI。

• k (int, optional) – 返回的结果数量。默认为 DEFAULT_K。

• filter (可选[Dict[str, str]], 可选) – 通过元数据进行过滤。

• **kwargs (Any) – 传递给函数的额外参数。

Returns:

与提供的图像最相似的图像列表。 列表中的每个元素都是一个Langchain文档对象。 页面内容是b64编码的图像，元数据是默认的或 由用户定义。

Raises:

ValueError – 如果嵌入函数不支持图像嵌入。

Return type:

列表[文档]

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

根据给定的图像URI搜索相似的图像。

Parameters:

• uri (str) – 要搜索的图像的URI。

• k (int, optional) – 返回的结果数量。

• DEFAULT_K. (默认值为)

• filter (可选[Dict[str, str]], 可选) – 通过元数据进行过滤。

• **kwargs (Any) – 传递给函数的额外参数。

Returns:

包含与查询图像相似的文档及其相似度分数的元组列表。 每个元组中的第0个元素是一个Langchain文档对象。 页面内容是b64编码的图像，元数据是默认的或由用户定义的。

Return type:

列表[元组[Document, 浮点数]]

Raises:

ValueError – 如果嵌入函数不支持图像嵌入。

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]

返回与嵌入向量最相似的文档。

Parameters:

• embedding (List[float]) – 用于查找相似文档的嵌入。

• k (int) – 返回的文档数量。默认为4。

• filter (Dict[str, str] | None) – 通过元数据进行过滤。默认为 None。

• where_document (Dict[str, str] | None) – 用于通过文档进行过滤的字典。 例如 {$contains: {“text”: “hello”}}.

• kwargs (Any) – 传递给 Chroma 集合查询的额外关键字参数。

Returns:

与查询向量最相似的文档列表。

Return type:

列表[文档]

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]]

返回与嵌入向量最相似的文档和相似度分数。

Parameters:

• embedding (List[float]) – 用于查找相似文档的嵌入。

• k (int) – 返回的文档数量。默认为4。

• filter (Dict[str, str] | None) – 通过元数据进行过滤。默认为 None。

• where_document (Dict[str, str] | None) – 用于通过文档进行过滤的字典。 例如 {$contains: {“text”: “hello”}}.

• kwargs (Any) – 传递给 Chroma 集合查询的额外关键字参数。

Returns:

与查询文本最相似的文档列表以及每个文档的相关性评分（浮点数）。分数越低表示相似度越高。

Return type:

列表[元组[文档, 浮点数]]

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

返回文档和相关度分数，范围在[0, 1]之间。

0 表示不相似，1 表示最相似。

Parameters:

• query (str) – 输入文本。

• k (int) – 返回的文档数量。默认为4。

• **kwargs (Any) –

  传递给相似性搜索的kwargs。应包括： score_threshold: 可选，一个介于0到1之间的浮点值

  用于过滤检索到的文档集。

Returns:

(文档, 相似度分数) 的元组列表。

Return type:

列表[元组[Document, 浮点数]]

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]]

使用Chroma进行带距离的相似性搜索。

Parameters:

• query (str) – 要搜索的查询文本。

• k (int) – 返回的结果数量。默认为4。

• filter (Dict[str, str] | None) – 通过元数据进行过滤。默认为 None。

• where_document (Dict[str, str] | None) – 用于通过文档进行过滤的字典。 例如 {$contains: {“text”: “hello”}}.

• kwargs (Any) – 传递给 Chroma 集合查询的额外关键字参数。

Returns:

与查询文本最相似的文档列表以及每个文档的浮点距离。分数越低表示相似度越高。

Return type:

列表[元组[文档, 浮点数]]

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

使用Chroma进行向量相似性搜索。

Parameters:

• query (str) – 要搜索的查询文本。

• k (int) – 返回的结果数量。默认为4。

• filter (Dict[str, str] | None) – 通过元数据进行过滤。默认为 None。

• where_document (Dict[str, str] | None) – 用于通过文档进行过滤的字典。 例如 {$contains: {“text”: “hello”}}.

• kwargs (Any) – 传递给 Chroma 集合查询的额外关键字参数。

Returns:

与查询文本最相似的文档列表以及每个文档的嵌入向量。

Return type:

列表[元组[文档, ndarray]]

update_document(document_id: str, document: Document) → None

更新集合中的文档。

Parameters:

• document_id (str) – 要更新的文档的ID。

• document (Document) – 要更新的文档。

Return type:

无

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

更新集合中的文档。

Parameters:

• ids (List[str]) – 要更新的文档的ID列表。

• documents (List[Document]) – 要更新的文档列表。

Raises:

ValueError – 如果未提供嵌入函数。

Return type:

无

使用 Chroma 的示例

• 构建一个本地RAG应用程序

• 构建一个PDF摄取和问答系统

• 构建一个查询分析系统

• 构建一个检索增强生成（RAG）应用

• Chroma

• Confident

• 对话式RAG

• Docugami

• Google Cloud Vertex AI 重排器

• 在进行查询分析时如何处理高基数分类变量

• 如何添加聊天记录

• 如何为聊天机器人添加检索功能

• 如何创建和查询向量存储

• 如何进行“自查询”检索

• 如何让你的RAG应用程序返回来源

• 如何处理未生成查询的情况

• 在进行查询分析时如何处理多个查询

• 在进行查询分析时如何处理多个检索器

• 如何重新排序检索结果以减轻“中间丢失”效应

• 如何为每个文档使用多个向量进行检索

• 如何通过相似性选择示例

• 如何从您的RAG应用程序流式传输结果

• 如何使用少量示例

• 如何在聊天模型中使用少量示例

• 如何使用MultiQueryRetriever

• 如何使用父文档检索器

• 图像字幕

• LOTR (合并检索器)

• Psychic

• RePhraseQuery

• 向量存储和检索器