`langchain_community.vectorstores.azure_cosmos_db`.AzureCosmosDBVectorSearch¶

class langchain_community.vectorstores.azure_cosmos_db.AzureCosmosDBVectorSearch(collection: Collection[CosmosDBDocumentType], embedding: Embeddings, *, index_name: str = 'vectorSearchIndex', text_key: str = 'textContent', embedding_key: str = 'vectorContent')[source]¶

Azure Cosmos DB for MongoDB vCore 向量存储。

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

示例：: . code-block:: python

from langchain_community.vectorstores import AzureCosmosDBVectorSearch from langchain_community.embeddings.openai import OpenAIEmbeddings from pymongo import MongoClient

mongo_client = MongoClient(“<YOUR-CONNECTION-STRING>”) collection = mongo_client[“<db_name>”][“<collection_name>”] embeddings = OpenAIEmbeddings() vectorstore = AzureCosmosDBVectorSearch(collection, embeddings)

AzureCosmosDBVectorSearch的构造函数

参数:: collection: 要添加文本的MongoDB集合。 embedding: 要使用的文本嵌入模型。 index_name: Atlas Search索引的名称。 text_key: 每个文档将包含文本的MongoDB字段。 embedding_key: 每个文档将包含嵌入的MongoDB字段。

Attributes

embeddings

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

Methods

`__init__`(collection, embedding, *[, ...])	AzureCosmosDBVectorSearch的构造函数
`aadd_documents`(documents, **kwargs)	运行更多的文档通过嵌入并添加到向量存储中。
`aadd_texts`(texts[, metadatas])	运行更多的文本通过嵌入，并添加到向量存储中。
`add_documents`(documents, **kwargs)	运行更多的文档通过嵌入并添加到向量存储中。
`add_texts`(texts[, metadatas])	运行更多的文本通过嵌入，并添加到向量存储中。
`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)	使用异步方式运行相似性搜索与距离。
`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_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, ...])	使用距离进行相似性搜索。

Parameters

collection (Collection[CosmosDBDocumentType]) –
embedding (Embeddings) –
index_name (str) –
text_key (str) –
embedding_key (str) –

__init__(collection: Collection[CosmosDBDocumentType], embedding: Embeddings, *, index_name: str = 'vectorSearchIndex', text_key: str = 'textContent', embedding_key: str = 'vectorContent')[source]¶

AzureCosmosDBVectorSearch的构造函数

参数:: collection: 要添加文本的MongoDB集合。 embedding: 要使用的文本嵌入模型。 index_name: Atlas Search索引的名称。 text_key: 每个文档将包含文本的MongoDB字段。 embedding_key: 每个文档将包含嵌入的MongoDB字段。

Parameters

collection (Collection[CosmosDBDocumentType]) –
embedding (Embeddings) –
index_name (str) –
text_key (str) –
embedding_key (str) –

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

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

参数:: texts: 要添加到向量存储中的字符串的可迭代对象。 metadatas: 与文本相关的元数据的可选列表。 kwargs: 向量存储特定的参数。
返回:: 将文本添加到向量存储中的id列表。

Parameters

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

Return type

List

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

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

创建一个使用在实例构造中指定的索引名称的索引

正确设置numLists参数对于实现良好的准确性和性能非常重要。由于向量存储使用IVF作为索引策略，您应该在加载足够大的样本文档后才创建索引，以确保各个桶的质心分布相对均匀。

我们建议对于最多100万个文档，将numLists设置为documentCount/1000，对于超过100万个文档，将其设置为sqrt(documentCount)。随着数据库中项目数量的增长，您应该调整numLists的大小，以实现良好的向量搜索延迟性能。

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

参数：

kind：要创建的向量索引类型。

可能的选项包括：

vector-ivf
vector-hnsw：仅作为预览功能提供，
若要启用，请访问https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/preview-features

num_lists：这个整数是倒排文件（IVF）索引用于对向量数据进行分组的簇的数量。

我们建议将numLists设置为documentCount/1000，用于最多100万个文档，对于超过100万个文档，将其设置为sqrt(documentCount)。使用numLists值为1相当于执行蛮力搜索，性能有限

dimensions：向量相似性的维度数。

支持的最大维度数为2000

similarity：与IVF索引一起使用的相似性度量。

可能的选项包括：

CosmosDBSimilarityType.COS（余弦距离），

CosmosDBSimilarityType.L2（欧几里德距离）和

CosmosDBSimilarityType.IP（内积）。

m：每层的最大连接数（默认为16，最小值为2，最大值为100）。: 更高的m适用于具有高维度和/或高准确性要求的数据集。
ef_construction：用于构建图的动态候选列表的大小（默认为64，最小值为4，最大值为1000）。: 更高的ef_construction将导致更好的索引质量和更高的准确性，但也会增加构建索引所需的时间。 ef_construction必须至少为2 * m

返回：

描述创建的索引的对象

Parameters

num_lists (int) –
dimensions (int) –
similarity (CosmosDBSimilarityType) –
kind (str) –
m (int) –
ef_construction (int) –

Return type

dict[str, Any]

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

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

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

Parameters

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

Return type

Optional[bool]

delete_document_by_id(document_id: Optional[str] = None) → None[source]¶

通过特定的Id删除文档

参数：: document_id：文档标识符

Parameters: document_id (Optional[str]) –
Return type: None

delete_index() → None[source]¶

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

Return type: None

classmethod from_connection_string(connection_string: str, namespace: str, embedding: Embeddings, application_name: str = 'LANGCHAIN_PYTHON', **kwargs: Any) → AzureCosmosDBVectorSearch[source]¶

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

参数:: connection_string: MongoDB vCore实例的连接字符串 namespace: 命名空间（数据库.集合） embedding: 嵌入式工具 **kwargs: 动态关键字参数
返回:: 一个向量存储的实例

Parameters

connection_string (str) –
namespace (str) –
embedding (Embeddings) –
application_name (str) –
kwargs (Any) –

Return type

AzureCosmosDBVectorSearch

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

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

Parameters

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

Return type

VST

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

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

Parameters

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

Return type

AzureCosmosDBVectorSearch

get_collection() → Collection[CosmosDBDocumentType][source]¶

Return type: Collection[CosmosDBDocumentType]

get_index_name() → str[source]¶

返回索引名称

返回：: 返回索引名称

Return type: str

index_exists() → bool[source]¶

验证在实例构造期间指定的索引名称是否存在于集合中

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

Return type: bool

max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, kind: CosmosDBVectorSearchType = CosmosDBVectorSearchType.VECTOR_IVF, ef_search: int = 40, score_threshold: float = 0.0, **kwargs: Any) → List[Document][source]¶

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

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

参数：: 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) –
kind (CosmosDBVectorSearchType) –
ef_search (int) –
score_threshold (float) –
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, kind: CosmosDBVectorSearchType = CosmosDBVectorSearchType.VECTOR_IVF, ef_search: int = 40, score_threshold: float = 0.0, **kwargs: Any) → List[Document][source]¶

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

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

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

Parameters

embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
kind (CosmosDBVectorSearchType) –
ef_search (int) –
score_threshold (float) –
kwargs (Any) –

Return type

List[Document]

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, kind: CosmosDBVectorSearchType = CosmosDBVectorSearchType.VECTOR_IVF, ef_search: int = 40, score_threshold: float = 0.0, **kwargs: Any) → List[Document][source]¶

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

Parameters

query (str) –
k (int) –
kind (CosmosDBVectorSearchType) –
ef_search (int) –
score_threshold (float) –
kwargs (Any) –

Return type

List[Document]

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

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

参数：: embedding：要查找与之相似的文档的嵌入。 k：要返回的文档数量。默认为4。
返回：: 与查询向量最相似的文档列表。

Parameters

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

Return type

List[Document]

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, kind: CosmosDBVectorSearchType = CosmosDBVectorSearchType.VECTOR_IVF, ef_search: int = 40, score_threshold: float = 0.0) → List[Tuple[Document, float]][source]¶

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

Parameters

query (str) –
k (int) –
kind (CosmosDBVectorSearchType) –
ef_search (int) –
score_threshold (float) –

Return type

List[Tuple[Document, float]]

Examples using AzureCosmosDBVectorSearch¶

langchain_community.vectorstores.azure_cosmos_db.AzureCosmosDBVectorSearch¶

Examples using AzureCosmosDBVectorSearch¶

`langchain_community.vectorstores.azure_cosmos_db`.AzureCosmosDBVectorSearch¶