`langchain_community.vectorstores.chroma`.Chroma¶

class langchain_community.vectorstores.chroma.Chroma(collection_name: str = 'langchain', embedding_function: Optional[Embeddings] = None, persist_directory: Optional[str] = None, client_settings: Optional[chromadb.config.Settings] = None, collection_metadata: Optional[Dict] = None, client: Optional[chromadb.Client] = None, relevance_score_fn: Optional[Callable[[float], float]] = None)[source]¶

ChromaDB 向量存储。

要使用，您应该已经安装了 chromadb python 包。

示例:

from langchain_community.vectorstores import Chroma
from langchain_community.embeddings.openai import OpenAIEmbeddings

embeddings = OpenAIEmbeddings()
vectorstore = Chroma("langchain_store", embeddings)

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

Attributes

embeddings

如果可用，访问查询嵌入对象。

Methods

`__init__`([collection_name, ...])	使用Chroma客户端进行初始化。
`aadd_documents`(documents, **kwargs)	运行更多的文档通过嵌入并添加到向量存储中。
`aadd_texts`(texts[, metadatas])	运行更多的文本通过嵌入，并添加到向量存储中。
`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])	返回从文本和嵌入初始化的VectorStore。
`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, ...])	获取集合。
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。最大边际相关性优化了与查询的相似性和所选文档之间的多样性。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。最大边际相关性优化了与查询的相似性和所选文档之间的多样性。
`persist`()	[Deprecated] 持久化集合。
`search`(query, search_type, **kwargs)	返回使用指定搜索类型的查询最相似的文档。
`similarity_search`(query[, k, filter])	使用Chroma运行相似性搜索。
`similarity_search_by_vector`(embedding[, k, ...])	返回与嵌入向量最相似的文档。参数： embedding（List[float]）：要查找相似文档的嵌入。 k（int）：要返回的文档数量。默认为4。 filter（Optional[Dict[str, str]]）：按元数据过滤。默认为None。返回：与查询向量最相似的文档列表。
`similarity_search_by_vector_with_relevance_scores`(...)	返回与嵌入向量和相似度分数最相似的文档。
`similarity_search_with_relevance_scores`(query)	返回文档和相关性得分在[0, 1]范围内。
`similarity_search_with_score`(query[, k, ...])	运行使用Chroma和距离进行相似性搜索。
`update_document`(document_id, document)	更新集合中的文档。
`update_documents`(ids, documents)	更新集合中的文档。

Parameters

collection_name (str) –
embedding_function (Optional[Embeddings]) –
persist_directory (Optional[str]) –
client_settings (Optional[chromadb.config.Settings]) –
collection_metadata (Optional[Dict]) –
client (Optional[chromadb.Client]) –
relevance_score_fn (Optional[Callable[[float], float]]) –

Return type

None

__init__(collection_name: str = 'langchain', embedding_function: Optional[Embeddings] = None, persist_directory: Optional[str] = None, client_settings: Optional[chromadb.config.Settings] = None, collection_metadata: Optional[Dict] = None, client: Optional[chromadb.Client] = None, relevance_score_fn: Optional[Callable[[float], float]] = None) → None[source]¶

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

Parameters

collection_name (str) –
embedding_function (Optional[Embeddings]) –
persist_directory (Optional[str]) –
client_settings (Optional[chromadb.config.Settings]) –
collection_metadata (Optional[Dict]) –
client (Optional[chromadb.Client]) –
relevance_score_fn (Optional[Callable[[float], float]]) –

Return type

None

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

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

参数:: documents (List[Document]): 要添加到向量存储中的文档。
返回:: List[str]: 添加的文本的ID列表。

Parameters

documents (List[Document]) –
kwargs (Any) –

Return type

List[str]

async aadd_texts(texts: Iterable[str], metadatas: Optional[List[dict]] = None, **kwargs: Any) → List[str]¶

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

Parameters

texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
kwargs (Any) –

Return type

List[str]

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

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

参数:: documents (List[Document]): 要添加到向量存储中的文档。
返回:: List[str]: 添加的文本的ID列表。

Parameters

documents (List[Document]) –
kwargs (Any) –

Return type

List[str]

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

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

参数：: uris List[str]: 图像的文件路径。 metadatas (Optional[List[dict]], optional): 可选的元数据列表。 ids (Optional[List[str]], optional): 可选的ID列表。
返回：: List[str]: 添加的图像的ID列表。

Parameters

uris (List[str]) –
metadatas (Optional[List[dict]]) –
ids (Optional[List[str]]) –
kwargs (Any) –

Return type

List[str]

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

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

参数：: texts (Iterable[str]): 要添加到向量存储的文本。 metadatas (Optional[List[dict]], optional): 元数据的可选列表。 ids (Optional[List[str]], optional): 可选的ID列表。
返回：: List[str]: 添加文本的ID列表。

Parameters

texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
ids (Optional[List[str]]) –
kwargs (Any) –

Return type

List[str]

async adelete(ids: Optional[List[str]] = None, **kwargs: Any) → Optional[bool]¶

根据向量ID或其他条件进行删除。

参数：: ids：要删除的ID列表。 **kwargs：子类可能使用的其他关键字参数。
返回：: Optional[bool]：如果删除成功则为True，否则为False，如果未实现则为None。

Parameters

ids (Optional[List[str]]) –
kwargs (Any) –

Return type

Optional[bool]

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

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

Parameters

documents (List[Document]) –
embedding (Embeddings) –
kwargs (Any) –

Return type

VST

async classmethod afrom_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, **kwargs: Any) → VST¶

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

Parameters

texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
kwargs (Any) –

Return type

VST

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

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

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

参数：: query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：0到1之间的数字，确定结果之间多样性的程度，0对应最大多样性，1对应最小多样性。默认为0.5。
返回：: 由最大边际相关性选择的文档列表。

Parameters

query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
kwargs (Any) –

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

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

Parameters

embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
kwargs (Any) –

Return type

List[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever¶

返回从此VectorStore初始化的VectorStoreRetriever。

参数：

search_type（可选[str]）：定义Retriever应执行的搜索类型。: 可以是”similarity”（默认值）、”mmr”或”similarity_score_threshold”。
search_kwargs（可选[Dict]）：传递给搜索函数的关键字参数。可以包括：: k：要返回的文档数量（默认值：4） score_threshold：用于similarity_score_threshold的最小相关性阈值 fetch_k：传递给MMR算法的文档数量（默认值：20） lambda_mult：MMR返回结果的多样性；1表示最小多样性，0表示最大多样性（默认值：0.5） filter：按文档元数据筛选

返回：

VectorStoreRetriever：VectorStore的Retriever类。

示例：

# 检索更多具有更高多样性的文档
# 如果数据集中有许多相似的文档，则很有用
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 6, 'lambda_mult': 0.25}
)

# 为MMR算法考虑更多文档
# 但只返回前5个
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 5, 'fetch_k': 50}
)

# 仅检索具有特定阈值以上相关性分数的文档
docsearch.as_retriever(
    search_type="similarity_score_threshold",
    search_kwargs={'score_threshold': 0.8}
)

# 仅从数据集中获取最相似的单个文档
docsearch.as_retriever(search_kwargs={'k': 1})

# 使用筛选器仅从特定论文中检索文档
docsearch.as_retriever(
    search_kwargs={'filter': {'paper_title':'GPT-4 Technical Report'}}
)

Parameters: kwargs (Any) –
Return type: VectorStoreRetriever

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

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

Parameters

query (str) –
search_type (str) –
kwargs (Any) –

Return type

List[Document]

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

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

Parameters

query (str) –
k (int) –
kwargs (Any) –

Return type

List[Document]

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

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

Parameters

embedding (List[float]) –
k (int) –
kwargs (Any) –

Return type

List[Document]

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

返回文档和相关性分数在范围[0, 1]内，异步执行。

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

参数：: query：输入文本 k：要返回的文档数量。默认为4。 **kwargs：要传递给相似性搜索的kwargs。应包括：

score_threshold：可选，介于0到1之间的浮点值，用于过滤检索到的文档集
返回：: 元组列表（doc，相似度分数）的列表

Parameters

query (str) –
k (int) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

async asimilarity_search_with_score(*args: Any, **kwargs: Any) → List[Tuple[Document, float]]¶

使用异步方式运行相似性搜索与距离。

Parameters

args (Any) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

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

根据向量ID删除。

参数：: ids：要删除的ID列表。

Parameters

ids (Optional[List[str]]) –
kwargs (Any) –

Return type

None

delete_collection() → None[source]¶

删除集合。

Return type: None

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

从图像URI获取base64字符串。

Parameters: uri (str) –
Return type: str

classmethod from_documents(documents: List[Document], embedding: Optional[Embeddings] = None, ids: Optional[List[str]] = None, collection_name: str = 'langchain', persist_directory: Optional[str] = None, client_settings: Optional[chromadb.config.Settings] = None, client: Optional[chromadb.Client] = None, collection_metadata: Optional[Dict] = None, **kwargs: Any) → Chroma[source]¶

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

如果指定了persist_directory，则集合将被持久化存储在那里。否则，数据将在内存中是临时的。

参数:: collection_name (str): 要创建的集合的名称。 persist_directory (Optional[str]): 持久化存储集合的目录。 ids (Optional[List[str]]): 文档ID列表。默认为None。 documents (List[Document]): 要添加到向量存储的文档列表。 embedding (Optional[Embeddings]): 嵌入函数。默认为None。 client_settings (Optional[chromadb.config.Settings]): Chroma客户端设置。 collection_metadata (Optional[Dict]): 集合配置。默认为None。
返回:: Chroma: Chroma向量存储。

Parameters

documents (List[Document]) –
embedding (Optional[Embeddings]) –
ids (Optional[List[str]]) –
collection_name (str) –
persist_directory (Optional[str]) –
client_settings (Optional[chromadb.config.Settings]) –
client (Optional[chromadb.Client]) –
collection_metadata (Optional[Dict]) –
kwargs (Any) –

Return type

Chroma

classmethod from_texts(texts: List[str], embedding: Optional[Embeddings] = None, metadatas: Optional[List[dict]] = None, ids: Optional[List[str]] = None, collection_name: str = 'langchain', persist_directory: Optional[str] = None, client_settings: Optional[chromadb.config.Settings] = None, client: Optional[chromadb.Client] = None, collection_metadata: Optional[Dict] = None, **kwargs: Any) → Chroma[source]¶

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

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

参数:: texts (List[str]): 要添加到集合中的文本列表。 collection_name (str): 要创建的集合的名称。 persist_directory (Optional[str]): 持久化集合的目录。 embedding (Optional[Embeddings]): 嵌入函数。默认为None。 metadatas (Optional[List[dict]]): 元数据列表。默认为None。 ids (Optional[List[str]]): 文档ID列表。默认为None。 client_settings (Optional[chromadb.config.Settings]): Chroma客户端设置。 collection_metadata (Optional[Dict]): 集合配置。默认为None。
返回:: Chroma: Chroma向量存储。

Parameters

texts (List[str]) –
embedding (Optional[Embeddings]) –
metadatas (Optional[List[dict]]) –
ids (Optional[List[str]]) –
collection_name (str) –
persist_directory (Optional[str]) –
client_settings (Optional[chromadb.config.Settings]) –
client (Optional[chromadb.Client]) –
collection_metadata (Optional[Dict]) –
kwargs (Any) –

Return type

Chroma

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

获取集合。

参数：

ids：要获取的嵌入的ids。可选。 where：用于过滤结果的Where类型字典。

例如 {“color” : “red”, “price”: 4.20}。可选。

limit：要返回的文档数量。可选。 offset：从哪里开始返回结果的偏移量。

用于分页结果与限制。可选。

where_document：用于按文档过滤的WhereDocument类型字典。: 例如 {$contains: “hello”}。可选。
include：要包含在结果中的内容列表。: 可包含 “embeddings”, “metadatas”, “documents”。 ids始终包含在内。默认为 [“metadatas”, “documents”]。可选。

Parameters

ids (Optional[OneOrMany[ID]]) –
where (Optional[Where]) –
limit (Optional[int]) –
offset (Optional[int]) –
where_document (Optional[WhereDocument]) –
include (Optional[List[str]]) –

Return type

Dict[str, Any]

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

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

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：介于0和1之间的数字，确定结果之间多样性的程度，

其中0对应于最大多样性，1对应于最小多样性。默认为0.5。

filter（可选[Dict[str，str]]）：按元数据筛选。默认为None。

返回：

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

Parameters

query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
filter (Optional[Dict[str, str]]) –
where_document (Optional[Dict[str, str]]) –
kwargs (Any) –

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: Optional[Dict[str, str]] = None, where_document: Optional[Dict[str, str]] = None, **kwargs: Any) → List[Document][source]¶

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

参数：

embedding: 查找与之相似文档的嵌入。 k: 要返回的文档数量。默认为4。 fetch_k: 要获取的文档数量，以传递给MMR算法。 lambda_mult: 介于0和1之间的数字，确定结果之间多样性的程度，

其中0对应于最大多样性，1对应于最小多样性。默认为0.5。

filter (Optional[Dict[str, str]]): 按元数据过滤。默认为None。

返回：

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

Parameters

embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
filter (Optional[Dict[str, str]]) –
where_document (Optional[Dict[str, str]]) –
kwargs (Any) –

Return type

List[Document]

persist() → None[source]¶

[Deprecated] 持久化集合。

这可以用来显式地将数据持久化到磁盘。当对象被销毁时，它也会被自动调用。

自Chroma 0.4.x以来，不再支持手动持久化方法，因为文档会自动持久化。

Notes

Deprecated since version langchain-community==0.1.17: Since Chroma 0.4.x the manual persistence method is no longer supported as docs are automatically persisted.

Return type: None

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

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

Parameters

query (str) –
search_type (str) –
kwargs (Any) –

Return type

List[Document]

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

使用Chroma运行相似性搜索。

参数：: query (str): 要搜索的查询文本。 k (int): 要返回的结果数量。默认为4。 filter (Optional[Dict[str, str]]): 按元数据过滤。默认为None。
返回：: List[Document]: 与查询文本最相似的文档列表。

Parameters

query (str) –
k (int) –
filter (Optional[Dict[str, str]]) –
kwargs (Any) –

Return type

List[Document]

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

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

embedding（List[float]）：要查找相似文档的嵌入。 k（int）：要返回的文档数量。默认为4。 filter（Optional[Dict[str, str]]）：按元数据过滤。默认为None。

返回：: 与查询向量最相似的文档列表。

Parameters

embedding (List[float]) –
k (int) –
filter (Optional[Dict[str, str]]) –
where_document (Optional[Dict[str, str]]) –
kwargs (Any) –

Return type

List[Document]

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

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

参数：: embedding（List[float]）：要查找相似文档的嵌入。 k（int）：要返回的文档数量。默认为4。 filter（Optional[Dict[str, str]）：按元数据过滤。默认为None。
返回：: List[Tuple[Document, float]]：与查询文本最相似的文档列表，每个文档对应的余弦距离浮点数。较低的分数表示更相似。

Parameters

embedding (List[float]) –
k (int) –
filter (Optional[Dict[str, str]]) –
where_document (Optional[Dict[str, str]]) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

similarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]]¶

返回文档和相关性得分在[0, 1]范围内。

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

参数：: query：输入文本 k：要返回的文档数量。默认为4。 **kwargs：要传递给相似性搜索的kwargs。应包括：

score_threshold：可选，介于0到1之间的浮点值，用于过滤检索到的文档集
返回：: 元组列表（doc，相似性得分）

Parameters

query (str) –
k (int) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

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

运行使用Chroma和距离进行相似性搜索。

参数:: query (str): 要搜索的查询文本。 k (int): 要返回的结果数量。默认为4。 filter (Optional[Dict[str, str]]): 按元数据进行过滤。默认为None。
返回:: List[Tuple[Document, float]]: 与查询文本最相似的文档列表，每个文档对应的余弦距离值为浮点数。较低的分数表示更相似。

Parameters

query (str) –
k (int) –
filter (Optional[Dict[str, str]]) –
where_document (Optional[Dict[str, str]]) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

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

更新集合中的文档。

参数:: document_id (str): 需要更新的文档的ID。 document (Document): 需要更新的文档。

Parameters

document_id (str) –
document (Document) –

Return type

None

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

更新集合中的文档。

参数：: ids（List[str]）：要更新的文档的id列表。 documents（List[Document]）：要更新的文档列表。

Parameters

ids (List[str]) –
documents (List[Document]) –

Return type

None

langchain_community.vectorstores.chroma.Chroma¶

Examples using Chroma¶

`langchain_community.vectorstores.chroma`.Chroma¶