AzureCosmosDB向量搜索#

class langchain_community.vectorstores.azure_cosmos_db.AzureCosmosDBVectorSearch(collection: Collection, embedding: Embeddings, *, index_name: str = 'vectorSearchIndex', text_key: str = 'textContent', embedding_key: str = 'vectorContent', application_name: str = 'LangChain-CDBMongoVCore-VectorStore-Python')[source]#

Azure Cosmos DB for MongoDB vCore 向量存储。

要使用，你应该具备以下条件： - 已安装 pymongo python 包 - 拥有与 MongoDB VCore 集群关联的连接字符串

示例

. code-block:: python

从 langchain_community.vectorstores 导入 AzureCosmosDBVectorSearch 从 langchain_community.embeddings.openai 导入 OpenAIEmbeddings 从 pymongo 导入 MongoClient

mongo_client = MongoClient(“”) collection = mongo_client[“”][“”] embeddings = OpenAIEmbeddings() vectorstore = AzureCosmosDBVectorSearch(collection, embeddings)

AzureCosmosDBVectorSearch 的构造函数

Parameters:

collection (Collection) – 要添加文本的MongoDB集合。
embedding (Embeddings) – 使用的文本嵌入模型。
index_name (str) – Atlas Search 索引的名称。
text_key (str) – MongoDB字段，将包含每个文档的文本。
embedding_key (str) – MongoDB字段，将包含每个文档的嵌入。
application_name (str)

属性

embeddings

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

方法

`__init__`(collection, embedding, *[, ...])	AzureCosmosDBVectorSearch 的构造函数
`aadd_documents`(documents, **kwargs)	异步运行更多文档通过嵌入并添加到向量存储中。
`aadd_texts`(texts[, metadatas, ids])	异步运行更多文本通过嵌入并添加到向量存储中。
`add_documents`(documents, **kwargs)	在向量存储中添加或更新文档。
`add_texts`(texts[, metadatas])	通过嵌入运行更多文本并将其添加到向量存储中。
`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)	异步运行带距离的相似性搜索。
`create_filter_index`(property_to_filter, ...)
`create_index`([num_lists, dimensions, ...])	使用指定的索引名称创建索引
`delete`([ids])	通过向量ID或其他条件删除。
`delete_document_by_id`([document_id])	通过ID删除特定文档
`delete_index`()	如果存在，删除实例构建期间指定的索引
`from_connection_string`(connection_string, ...)	从连接字符串创建 AzureCosmosDBVectorSearch 的实例
`from_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的VectorStore。
`from_texts`(texts, embedding[, metadatas, ...])	返回从文本和嵌入初始化的VectorStore。
`get_by_ids`(ids, /)	通过ID获取文档。
`get_collection`()
`get_index_name`()	返回索引名称
`index_exists`()	验证实例期间指定的索引名称是否存在
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`search`(query, search_type, **kwargs)	使用指定的搜索类型返回与查询最相似的文档。
`similarity_search`(query[, k, kind, ...])	返回与查询最相似的文档。
`similarity_search_by_vector`(embedding[, k])	返回与嵌入向量最相似的文档。
`similarity_search_with_relevance_scores`(query)	返回文档和相关度分数，分数范围在[0, 1]之间。
`similarity_search_with_score`(query[, k, ...])	运行带距离的相似性搜索。

__init__(collection: Collection, embedding: Embeddings, *, index_name: str = 'vectorSearchIndex', text_key: str = 'textContent', embedding_key: str = 'vectorContent', application_name: str = 'LangChain-CDBMongoVCore-VectorStore-Python')[source]#

AzureCosmosDBVectorSearch 的构造函数

Parameters:

collection (Collection) – 要添加文本的MongoDB集合。
embedding (Embeddings) – 使用的文本嵌入模型。
index_name (str) – Atlas Search 索引的名称。
text_key (str) – MongoDB字段，将包含每个文档的文本。
embedding_key (str) – MongoDB字段，将包含每个文档的嵌入。
application_name (str)

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_texts(texts: Iterable[str], metadatas: List[Dict[str, Any]] | None = None, **kwargs: Any) → List[source]#

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

Parameters:

texts (Iterable[str]) – 要添加到向量存储中的字符串的可迭代对象。
metadatas (List[Dict[str, Any]] | None) – 可选的与文本关联的元数据列表。
ids – 与文本关联的可选ID列表。
**kwargs (Any) – 向量存储特定参数。其中一个 kwargs 应该是 ids，这是一个与文本相关联的 ID 列表。

Returns:

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

Raises:

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

Return type:

列表

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, 浮点数]]

create_filter_index(property_to_filter: str, index_name: str) → dict[str, Any][source]#

Parameters:

property_to_filter (str)
index_name (str)

Return type:

字典[str, 任意]

create_index(num_lists: int = 100, dimensions: int = 1536, similarity: CosmosDBSimilarityType = CosmosDBSimilarityType.COS, kind: str = 'vector-ivf', m: int = 16, ef_construction: int = 64, max_degree: int = 32, l_build: int = 50) → dict[str, Any][source]#

Creates an index using the index name specified at

实例构造

Setting the numLists parameter correctly is important for achieving

良好的准确性和性能。由于向量存储使用IVF作为索引策略，您应该仅在加载了足够大的样本文档后创建索引，以确保各个桶的质心分布均匀。

We recommend that numLists is set to documentCount/1000 for up

对于100万份文档以及超过100万份文档的sqrt(documentCount)。随着数据库中项目数量的增加，您应该调整numLists使其更大以实现向量搜索的良好延迟性能。

如果您正在尝试一个新场景或创建一个小型演示，您可以从将numLists设置为1开始，以对所有向量执行暴力搜索。这应该会为您提供向量搜索中最准确的结果，但请注意，搜索速度和延迟将会很慢。在初始设置之后，您应该根据上述指导调整numLists参数。

Parameters:

kind (str) –
要创建的向量索引类型。可能的选项有：
- vector-ivf
- vector-hnsw: 仅作为预览功能提供，
  要启用请访问 https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/preview-features
- vector-diskann: 仅作为预览功能提供
num_lists (int) – 这个整数是倒排文件（IVF）索引用于分组向量数据的簇的数量。我们建议对于最多100万份文档，numLists设置为documentCount/1000，对于超过100万份文档，设置为sqrt(documentCount)。使用numLists值为1类似于执行暴力搜索，其性能有限。
dimensions (int) – 向量相似度的维度数。支持的最大维度数为2000
similarity (CosmosDBSimilarityType) –
与IVF索引一起使用的相似性度量。
可能的选项有：
- CosmosDBSimilarityType.COS (余弦距离),
- CosmosDBSimilarityType.L2 (欧几里得距离), 和
- CosmosDBSimilarityType.IP (内积).
m (int) – 每层的最大连接数（默认为16，最小值为2，最大值为100）。较高的m值适用于具有高维度和/或高精度要求的数据集。
ef_construction (int) – 用于构建图的动态候选列表的大小（默认为64，最小值为4，最大值为1000）。较高的ef_construction将导致更好的索引质量和更高的准确性，但也会增加构建索引所需的时间。ef_construction必须至少为2 * m
max_degree (int) – 最大邻居数。默认值为32，范围从20到2048。目前仅vector-diskann搜索支持此功能。
l_build (int) – 用于索引构建的l值。默认值为50，范围从10到500。目前仅支持vector-diskann搜索。

Returns:

描述创建的索引的对象

Return type:

字典[str, 任意]

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

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

Parameters:

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

Returns:

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

Return type:

可选[布尔]

delete_document_by_id(document_id: str | None = None) → None[source]#

通过ID删除特定文档

Parameters:: document_id (str | None) – 文档标识符
Return type:: 无

delete_index() → None[来源]#

如果存在，删除实例构造期间指定的索引

Return type:: 无

classmethod from_connection_string(connection_string: str, namespace: str, embedding: Embeddings, application_name: str = 'LangChain-CDBMongoVCore-VectorStore-Python', **kwargs: Any) → AzureCosmosDBVectorSearch[来源]#

从连接字符串创建 AzureCosmosDBVectorSearch 的实例

Parameters:

connection_string (str) – MongoDB vCore 实例的连接字符串
namespace (str) – 命名空间 (数据库.集合)
embedding (Embeddings) – 嵌入工具
application_name (str) – 用于遥测的用户代理
**kwargs (Any) – 动态关键字参数

Returns:

向量存储的一个实例

Return type:

AzureCosmosDBVectorSearch

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

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

Parameters:

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

Returns:

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

Return type:

VectorStore

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: List[dict] | None = None, collection: Collection | None = None, **kwargs: Any) → AzureCosmosDBVectorSearch[source]#

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

Parameters:

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

Returns:

VectorStore 从文本和嵌入初始化。

Return type:

VectorStore

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.11中添加。

get_collection() → Collection[source]#

Return type:: 集合

get_index_name() → str[source]#

返回索引名称

Returns:: 返回索引名称
Return type:: 字符串

index_exists() → bool[source]#

Verifies if the specified index name during instance: 集合上存在构造

Returns:

成功时返回True，如果不存在这样的索引则返回False: 在集合上

Return type:

布尔

max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, kind: CosmosDBVectorSearchType = CosmosDBVectorSearchType.VECTOR_IVF, pre_filter: Dict | None = None, ef_search: int = 40, score_threshold: float = 0.0, l_search: int = 40, with_embedding: bool = False, **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) – 传递给搜索方法的参数。
kind (CosmosDBVectorSearchType)
pre_filter (Dict | None)
ef_search (int)
score_threshold (float)
l_search (int)
with_embedding (bool)
**kwargs

Returns:

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

Return type:

列表[文档]

max_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, kind: CosmosDBVectorSearchType = CosmosDBVectorSearchType.VECTOR_IVF, pre_filter: Dict | None = None, ef_search: int = 40, score_threshold: float = 0.0, l_search: int = 40, with_embedding: bool = False, **kwargs: Any) → List[Document][source]#

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

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

Parameters:

embedding (List[float]) – 用于查找相似文档的嵌入。
k (int) – 返回的文档数量。默认为4。
fetch_k (int) – 要传递给MMR算法的文档数量。默认值为20。
lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。
**kwargs (Any) – 传递给搜索方法的参数。
kind (CosmosDBVectorSearchType)
pre_filter (Dict | None)
ef_search (int)
score_threshold (float)
l_search (int)
with_embedding (bool)
**kwargs

Returns:

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

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, kind: CosmosDBVectorSearchType = CosmosDBVectorSearchType.VECTOR_IVF, pre_filter: Dict | None = None, ef_search: int = 40, score_threshold: float = 0.0, l_search: int = 40, with_embedding: bool = False, **kwargs: Any) → List[Document][来源]#

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

Parameters:

query (str) – 输入文本。
k (int) – 返回的文档数量。默认为4。
**kwargs (Any) – 传递给搜索方法的参数。
kind (CosmosDBVectorSearchType)
pre_filter (Dict | None)
ef_search (int)
score_threshold (float)
l_search (int)
with_embedding (bool)
**kwargs

Returns:

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

Return type:

列表[文档]

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

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, kind: CosmosDBVectorSearchType = CosmosDBVectorSearchType.VECTOR_IVF, pre_filter: Dict | None = None, ef_search: int = 40, score_threshold: float = 0.0, l_search: int = 40, with_embedding: bool = False) → List[Tuple[Document, float]][来源]#

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

Parameters:

*args – 传递给搜索方法的参数。
**kwargs – 传递给搜索方法的参数。
query (str)
k (整数)
kind (CosmosDBVectorSearchType)
pre_filter (Dict | None)
ef_search (int)
score_threshold (float)
l_search (int)
with_embedding (bool)

Returns:

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

Return type:

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

使用 AzureCosmosDBVectorSearch 的示例