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

Deprecated since version 0.2.9: 请使用 langchain_chroma.Chroma 代替。

ChromaDB 向量存储。

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

示例

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

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

使用 Chroma 客户端初始化。

属性

embeddings

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

方法

`__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。
`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)	异步运行带距离的相似性搜索。
`astreaming_upsert`(items, /, batch_size, **kwargs)
`aupsert`(items, /, **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`(...)	返回使用最大边际相关性选择的文档。
`持久化`()	Deprecated since version langchain-community==0.1.17: 由于 Chroma 0.4.x 版本起，手动持久化方法不再支持，因为文档会自动持久化。
`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 运行带距离的相似性搜索。
`streaming_upsert`(items, /, batch_size, **kwargs)
`update_document`(document_id, document)	更新集合中的一个文档。
`update_documents`(ids, documents)	更新集合中的一个文档。
`upsert`(items, /, **kwargs)

参数

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

__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 客户端初始化。

参数

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

返回类型

None

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

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

参数

documents (List[Document]) – 要添加到向量存储的文档列表。
kwargs (Any) – 附加的关键字参数。

返回

添加文本的 ID 列表。

Raises

ValueError – 如果 ID 数量与文档数量不匹配，则抛出此异常。

返回类型

List[str]

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

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

参数

texts (Iterable[str]) – 要添加到向量存储的字符串迭代器。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。默认为 None。
**kwargs (Any) – 向量存储特定的参数。

返回

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

Raises

ValueError – 如果元数据数量与文本数量不匹配，则抛出此异常。
ValueError – 如果 ID 数量与文本数量不匹配，则抛出此异常。

返回类型

List[str]

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

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

参数

documents (List[Document]) – 要添加到向量存储的文档列表。
kwargs (Any) – 附加的关键字参数。如果 kwargs 包含 ids 且文档包含 ids，则 kwargs 中的 ids 将优先。

返回

添加文本的 ID 列表。

Raises

ValueError – 如果 ID 数量与文档数量不匹配，则抛出此异常。

返回类型

List[str]

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

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

参数

List[str] (uris) – 图像的文件路径。
metadatas (Optional[List[dict]], optional) – 可选的元数据列表。
ids (Optional[List[str]], optional) – 可选的 ID 列表。
uris (List[str]) –
kwargs (Any) –

返回

添加图像的 ID 列表。

返回类型

List[str]

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

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

参数

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

返回

添加文本的 ID 列表。

返回类型

List[str]

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

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

参数

ids (Optional[List[str]]) – 要删除的 ID 列表。如果为 None，则删除所有。默认为 None。
**kwargs (Any) – 子类可能使用的其他关键字参数。

返回

如果删除成功，则为 True，否则为 False，如果未实现，则为 None。

返回类型

Optional[bool]

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

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

参数

documents (List[Document]) – 要添加到向量存储的文档列表。
embedding (Embeddings) – 要使用的嵌入函数。
kwargs (Any) – 附加的关键字参数。

返回

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

返回类型

VectorStore

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

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

参数

texts (List[str]) – 要添加到向量存储的文本。
embedding (Embeddings) – 要使用的嵌入函数。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。默认为 None。
kwargs (Any) – 附加的关键字参数。

返回

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

返回类型

VectorStore

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

异步通过 ID 获取文档。

返回的文档应将其 ID 字段设置为向量存储中文档的 ID。

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

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

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

参数: ids (Sequence[str]) – 要检索的 ID 列表。
返回: 文档列表。
返回类型: List[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]¶

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

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

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要提取并传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
kwargs (Any) –

返回

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

返回类型

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

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

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

参数

embedding (List[float]) – 用于查找相似文档的嵌入。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要提取并传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
**kwargs (Any) – 传递给搜索方法的参数。

返回

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

返回类型

List[Document]

as_retriever(**kwargs: Any) → VectorStoreRetriever¶

返回从该 VectorStore 初始化的 VectorStoreRetriever。

参数

**kwargs (Any) –

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

Retriever 应执行的搜索类型。可以是 “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: 按文档元数据过滤

返回

VectorStore 的 Retriever 类。

返回类型

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

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

参数

query (str) – 输入文本。
search_type (str) – 要执行的搜索类型。可以是 “similarity”、“mmr” 或 “similarity_score_threshold”。
**kwargs (Any) – 传递给搜索方法的参数。

返回

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

Raises

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

返回类型

List[Document]

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

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

参数

query (str) – 输入文本。
k (int) – 要返回的文档数量。默认为 4。
**kwargs (Any) – 传递给搜索方法的参数。

返回

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

返回类型

List[Document]

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

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

参数

embedding (List[float]) – 用于查找相似文档的嵌入。
k (int) – 要返回的文档数量。默认为 4。
**kwargs (Any) – 传递给搜索方法的参数。

返回

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

返回类型

List[Document]

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

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

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

参数

query (str) – 输入文本。
k (int) – 要返回的文档数量。默认为 4。
**kwargs (Any) –
要传递给相似度搜索的 kwargs。应包括：score_threshold：可选，介于 0 到 1 之间的浮点值，用于

过滤检索到的文档结果集

返回

（doc, similarity_score）元组列表

返回类型

List[Tuple[Document, float]]

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

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

参数

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

返回

（doc, similarity_score）元组列表。

返回类型

List[Tuple[Document, float]]

astreaming_upsert(items: AsyncIterable[Document], /, batch_size: int, **kwargs: Any) → AsyncIterator[UpsertResponse]¶

Beta

0.2.11 版本新增功能。API 可能会发生变化。

以流式方式更新文档。streaming_upsert 的异步版本。

参数

items (AsyncIterable[Document]) – 要添加到向量存储的文档的可迭代对象。
batch_size (int) – 每次更新批次的大小。
kwargs (Any) – 附加关键字参数。kwargs 应仅包含所有文档通用的参数。（例如，索引的超时时间、重试策略等）kwargs 不应包含 id，以避免语义模糊。相反，ID 应作为 Document 对象的一部分提供。

Yields

UpsertResponse – 响应对象，其中包含向量存储中成功添加或更新的 ID 列表以及添加或更新失败的 ID 列表。

返回类型

AsyncIterator[UpsertResponse]

0.2.11 版本新增功能。

async aupsert(items: Sequence[Document], /, **kwargs: Any) → UpsertResponse¶

Beta

0.2.11 版本新增功能。API 可能会发生变化。

在向量存储中添加或更新文档。upsert 的异步版本。

如果提供了 Document 对象的 ID 字段，则更新功能应使用该字段。如果未提供 ID，则更新方法可以自由地为文档生成 ID。

当指定了 ID 且文档已存在于向量存储中时，更新方法应使用新数据更新文档。如果文档不存在，则更新方法应将文档添加到向量存储中。

参数

items (Sequence[Document]) – 要添加到向量存储的文档序列。
kwargs (Any) – 附加的关键字参数。

返回

一个响应对象，其中包含向量存储中成功添加或更新的 ID 列表以及添加或更新失败的 ID 列表。

返回类型

UpsertResponse

0.2.11 版本新增功能。

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

通过向量 ID 删除。

参数

ids (Optional[List[str]]) – 要删除的 ID 列表。
kwargs (Any) –

返回类型

None

delete_collection() → None[source]¶

删除集合。

返回类型: None

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

从图像 URI 获取 base64 字符串。

参数: uri (str) –
返回类型: 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。
client (Optional[chromadb.Client]) –
kwargs (Any) –

返回

Chroma 向量存储。

返回类型

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。
client (Optional[chromadb.Client]) –
kwargs (Any) –

返回

Chroma 向量存储。

返回类型

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 (Optional[OneOrMany[ID]]) – 获取嵌入的ID。可选参数。
where (Optional[Where]) – Where 类型字典，用于按结果进行过滤。例如：{“color” : “red”, “price”: 4.20}。可选参数。
limit (Optional[int]) – 返回的文档数量。可选参数。
offset (Optional[int]) – 从哪个偏移量开始返回结果。用于使用 limit 进行结果分页。可选参数。
where_document (Optional[WhereDocument]) – WhereDocument 类型字典，用于按文档进行过滤。例如：{$contains: “hello”}。可选参数。
include (Optional[List[str]]) – 结果中包含内容的列表。可以包含 “embeddings”、 “metadatas”、 “documents”。始终包含 ID。默认为 [“metadatas”, “documents”]。可选参数。

返回类型

Dict[str, Any]

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

通过 ID 获取文档。

返回的文档应将其 ID 字段设置为向量存储中文档的 ID。

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

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

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

参数: ids (Sequence[str]) – 要检索的 ID 列表。
返回: 文档列表。
返回类型: List[Document]

0.2.11 版本新增功能。

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 (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要获取并传递给 MMR 算法的文档数量。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
filter (Optional[Dict[str, str]]) – 按元数据过滤。默认为 None。
where_document (Optional[Dict[str, str]]) –
kwargs (Any) –

返回

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

返回类型

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 (List[float]) – 用于查找相似文档的嵌入。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要获取并传递给 MMR 算法的文档数量。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
filter (Optional[Dict[str, str]]) – 按元数据过滤。默认为 None。
where_document (Optional[Dict[str, str]]) –
kwargs (Any) –

返回

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

返回类型

List[Document]

persist() → None[source]¶

Deprecated since version langchain-community==0.1.17: 由于 Chroma 0.4.x 版本起，手动持久化方法不再支持，因为文档会自动持久化。

持久化集合。

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

由于 Chroma 0.4.x 版本起，不再支持手动持久化方法，因为文档会自动持久化。

返回类型: None

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

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

参数

query (str) – 输入文本
search_type (str) – 要执行的搜索类型。可以是 “similarity”、“mmr” 或 “similarity_score_threshold”。
**kwargs (Any) – 传递给搜索方法的参数。

返回

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

Raises

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

返回类型

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。
kwargs (Any) –

返回

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

返回类型

List[Document]

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

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

参数

uri (str) – 要搜索的图像的 URI。
k (int, optional) – 返回的结果数量。默认为 DEFAULT_K。
filter (Optional[Dict[str, str]], optional) – 按元数据过滤。
**kwargs (Any) – 传递给函数的其他参数。

返回

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

Raises

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

返回类型

List[Document]

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

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

参数

uri (str) – 要搜索的图像的 URI。
k (int, optional) – 返回的结果数量。
DEFAULT_K. (默认为) –
filter (Optional[Dict[str, str]], optional) – 按元数据过滤。
**kwargs (Any) – 传递给函数的其他参数。

返回

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

返回类型

List[Tuple[Document, float]]

Raises

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

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

返回与嵌入向量最相似的文档。 :param embedding: 用于查找相似文档的嵌入向量。 :type embedding: List[float] :param k: 返回的文档数量。默认为 4。 :type k: int :param filter: 按元数据过滤。默认为 None。 :type filter: Optional[Dict[str, str]]

返回

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

参数

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

返回类型

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。
where_document (Optional[Dict[str, str]]) –
kwargs (Any) –

返回

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

返回类型

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 (str) – 输入文本。
k (int) – 要返回的文档数量。默认为 4。
**kwargs (Any) –
要传递给相似度搜索的 kwargs。应包括：score_threshold：可选，介于 0 到 1 之间的浮点值，用于

过滤检索到的文档结果集。

返回

（doc, similarity_score）元组列表。

返回类型

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。
where_document (Optional[Dict[str, str]]) –
kwargs (Any) –

返回

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

返回类型

List[Tuple[Document, float]]

streaming_upsert(items: Iterable[Document], /, batch_size: int, **kwargs: Any) → Iterator[UpsertResponse]¶

Beta

0.2.11 版本新增功能。API 可能会发生变化。

以流式方式更新文档。

参数

items (Iterable[Document]) – 要添加到向量存储的可迭代文档。
batch_size (int) – 每次更新批次的大小。
kwargs (Any) – 附加关键字参数。 kwargs 应仅包含所有文档通用的参数。（例如，索引超时，重试策略等） kwargs 不应包含 ID，以避免语义不明确。而是应将 ID 作为 Document 对象的一部分提供。

Yields

UpsertResponse – 响应对象，其中包含向量存储中成功添加或更新的 ID 列表以及添加或更新失败的 ID 列表。

返回类型

Iterator[UpsertResponse]

0.2.11 版本新增功能。

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

更新集合中的一个文档。

参数

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

返回类型

None

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

更新集合中的一个文档。

参数

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

返回类型

None

upsert(items: Sequence[Document], /, **kwargs: Any) → UpsertResponse¶

Beta

0.2.11 版本新增功能。API 可能会发生变化。

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

如果提供了 Document 对象的 ID 字段，则更新功能应使用该字段。如果未提供 ID，则更新方法可以自由地为文档生成 ID。

当指定了 ID 且文档已存在于向量存储中时，更新方法应使用新数据更新文档。如果文档不存在，则更新方法应将文档添加到向量存储中。

参数

items (Sequence[Document]) – 要添加到向量存储的文档序列。
kwargs (Any) – 附加的关键字参数。

返回

一个响应对象，其中包含向量存储中成功添加或更新的 ID 列表以及添加或更新失败的 ID 列表。

返回类型

UpsertResponse

0.2.11 版本新增功能。

langchain_community.vectorstores.chroma.Chroma¶

使用 Chroma 的示例¶

`langchain_community.vectorstores.chroma`.Chroma¶