langchain_community.vectorstores.matching_engine.MatchingEngine

class langchain_community.vectorstores.matching_engine.MatchingEngine(project_id: str, index: MatchingEngineIndex, endpoint: MatchingEngineIndexEndpoint, embedding: Embeddings, gcs_client: storage.Client, gcs_bucket_name: str, credentials: Optional[Credentials] = None, *, document_id_key: Optional[str] = None)

[Deprecated] `Google Vertex AI Vector Search`（之前称为Matching Engine）向量存储。

虽然嵌入式文档存储在Matching Engine中，但嵌入式文档将存储在GCS中。

使用此模块的先决条件是存在索引和相应的端点。

请参阅docs/integrations/vectorstores/google_vertex_ai_vector_search.ipynb中的用法。

请注意，此实现主要用于阅读，如果您计划进行实时实现。虽然阅读是实时操作，但更新索引需要接近一小时。

Notes

Deprecated since version 0.0.12.

Google Vertex AI Vector Search（之前称为Matching Engine）的向量存储实现。

虽然嵌入式文档存储在Matching Engine中，但嵌入式文档将存储在GCS中。

使用此模块的先决条件是存在一个现有的索引和相应的端点。

查看使用方法 docs/integrations/vectorstores/google_vertex_ai_vector_search.ipynb。

请注意，此实现主要用于阅读，如果您计划进行实时实现。虽然阅读是实时操作，但更新索引需要接近一小时。

属性：

project_id：GCS项目ID。 index：创建的索引类。请参见

~:func:MatchingEngine.from_components。

endpoint：创建的端点类。请参见

~:func:MatchingEngine.from_components。

embedding：将用于嵌入发送的文本的:class:Embeddings。如果未发送任何内容，则将使用多语言Tensorflow通用句子编码器。 gcs_client：GCS客户端。 gcs_bucket_name：GCS存储桶名称。 credentials（可选）：创建的GCP凭据。 document_id_key（可选）：在文档元数据中存储文档ID的键。如果为None，则文档ID将不会在文档元数据中返回。

Attributes

embeddings

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

Methods

__init__(project_id, index, endpoint, ...[, ...])	Google Vertex AI Vector Search（之前称为Matching Engine）的向量存储实现。
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)	使用异步方式运行相似性搜索与距离。
delete([ids])	根据向量ID或其他条件进行删除。
from_components(project_id, region, ...[, ...])	将对象创建从构造函数中移出。
from_documents(documents, embedding, **kwargs)	返回从文档和嵌入初始化的VectorStore。
from_texts(texts, embedding[, metadatas])	使用组件而不是从中导入。
max_marginal_relevance_search(query[, k, ...])	返回使用最大边际相关性选择的文档。
max_marginal_relevance_search_by_vector(...)	返回使用最大边际相关性选择的文档。
search(query, search_type, **kwargs)	返回使用指定搜索类型的查询最相似的文档。
similarity_search(query[, k, filter])	返回与查询最相似的文档。
similarity_search_by_vector(embedding[, k, ...])	返回与嵌入最相似的文档。
similarity_search_by_vector_with_score(embedding)	返回与嵌入最相似的文档及它们的余弦距离。
similarity_search_with_relevance_scores(query)	返回文档和相关性得分在[0, 1]范围内。
similarity_search_with_score(query[, k, filter])	返回与查询最相似的文档及其与查询之间的余弦距离。

Parameters

• project_id (str) –

• index (MatchingEngineIndex) –

• endpoint (MatchingEngineIndexEndpoint) –

• embedding (Embeddings) –

• gcs_client (storage.Client) –

• gcs_bucket_name (str) –

• credentials (Optional[Credentials]) –

• document_id_key (Optional[str]) –

__init__(project_id: str, index: MatchingEngineIndex, endpoint: MatchingEngineIndexEndpoint, embedding: Embeddings, gcs_client: storage.Client, gcs_bucket_name: str, credentials: Optional[Credentials] = None, *, document_id_key: Optional[str] = None)

Google Vertex AI Vector Search（之前称为Matching Engine）的向量存储实现。

虽然嵌入式文档存储在Matching Engine中，但嵌入式文档将存储在GCS中。

使用此模块的先决条件是存在一个现有的索引和相应的端点。

查看使用方法 docs/integrations/vectorstores/google_vertex_ai_vector_search.ipynb。

请注意，此实现主要用于阅读，如果您计划进行实时实现。虽然阅读是实时操作，但更新索引需要接近一小时。

属性：

project_id：GCS项目ID。 index：创建的索引类。请参见

~:func:MatchingEngine.from_components。

endpoint：创建的端点类。请参见

~:func:MatchingEngine.from_components。

embedding：将用于嵌入发送的文本的:class:Embeddings。如果未发送任何内容，则将使用多语言Tensorflow通用句子编码器。 gcs_client：GCS客户端。 gcs_bucket_name：GCS存储桶名称。 credentials（可选）：创建的GCP凭据。 document_id_key（可选）：在文档元数据中存储文档ID的键。如果为None，则文档ID将不会在文档元数据中返回。

Parameters

• project_id (str) –

• index (MatchingEngineIndex) –

• endpoint (MatchingEngineIndexEndpoint) –

• embedding (Embeddings) –

• gcs_client (storage.Client) –

• gcs_bucket_name (str) –

• credentials (Optional[Credentials]) –

• document_id_key (Optional[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]] = None, **kwargs: Any) → List[str]

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

参数：

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

返回：

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

Parameters

• texts (Iterable[str]) –

• metadatas (Optional[List[dict]]) –

• 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) → Optional[bool]

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

参数：

ids：要删除的ID列表。 **kwargs：子类可能使用的其他关键字参数。

返回：

Optional[bool]：如果删除成功则为True，否则为False，如果未实现则为None。

Parameters

• ids (Optional[List[str]]) –

• kwargs (Any) –

Return type

Optional[bool]

classmethod from_components(project_id: str, region: str, gcs_bucket_name: str, index_id: str, endpoint_id: str, credentials_path: Optional[str] = None, embedding: Optional[Embeddings] = None, **kwargs: Any) → MatchingEngine

将对象创建从构造函数中移出。

参数:

project_id: GCP项目ID。 region: 进行API调用的默认位置。必须与GCS存储桶的位置相同，并且必须是区域性的。 gcs_bucket_name: 存储向量以便创建索引的位置。 index_id: 创建的索引的ID。 endpoint_id: 创建的端点的ID。 credentials_path: （可选）本地文件系统上Google凭据的路径。 embedding: 将用于嵌入文本的Embeddings类。 kwargs: 传递给MatchingEngine.__init__()的额外关键字参数。

返回:

配置好的MatchingEngine，其中包含添加到索引的文本。

Parameters

• project_id (str) –

• region (str) –

• gcs_bucket_name (str) –

• index_id (str) –

• endpoint_id (str) –

• credentials_path (Optional[str]) –

• embedding (Optional[Embeddings]) –

• kwargs (Any) –

Return type

MatchingEngine

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, **kwargs: Any) → MatchingEngine

使用组件而不是从中导入。

Parameters

• texts (List[str]) –

• embedding (Embeddings) –

• metadatas (Optional[List[dict]]) –

• kwargs (Any) –

Return type

MatchingEngine

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

max_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：要查找相似文档的嵌入。 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) –

• 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, filter: Optional[List[Namespace]] = None, **kwargs: Any) → List[Document]

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

参数:

query: 将用于搜索相似文档的字符串。 k: 将被检索的邻居数量。 filter: 可选。用于过滤匹配结果的Namespaces列表。

例如: [Namespace(“color”, [“red”], []), Namespace(“shape”, [], [“squared”])] 将匹配满足”红色”但不包括”正方形形状”的数据点。请参考 https://cloud.google.com/vertex-ai/docs/matching-engine/filtering#json 获取更多详细信息。

返回:

一个包含k个匹配文档的列表。

Parameters

• query (str) –

• k (int) –

• filter (Optional[List[Namespace]]) –

• kwargs (Any) –

Return type

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, filter: Optional[List[Namespace]] = None, **kwargs: Any) → List[Document]

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

参数：

embedding：要查找相似文档的嵌入。 k：将被检索的邻居数量。 过滤器：可选。用于过滤匹配结果的Namespaces列表。

例如： [Namespace(“color”, [“red”], []), Namespace(“shape”, [], [“squared”])] 将匹配满足“红色颜色”但不包括“正方形形状”的数据点。请参考 https://cloud.google.com/vertex-ai/docs/matching-engine/filtering#json 了解更多详细信息。

返回：

一个包含k个匹配文档的列表。

Parameters

• embedding (List[float]) –

• k (int) –

• filter (Optional[List[Namespace]]) –

• kwargs (Any) –

Return type

List[Document]

similarity_search_by_vector_with_score(embedding: List[float], k: int = 4, filter: Optional[List[Namespace]] = None) → List[Tuple[Document, float]]

返回与嵌入最相似的文档及它们的余弦距离。

参数:

embedding: 要查找相似文档的嵌入。 k: 要返回的文档数量。默认为4。 filter: 可选。用于过滤匹配结果的命名空间列表。

例如: [Namespace(“color”, [“red”], []), Namespace(“shape”, [], [“squared”])] 将匹配满足”红色颜色”但不包括”正方形形状”的数据点。请参考 https://cloud.google.com/vertex-ai/docs/matching-engine/filtering#json 获取更多详细信息。

返回:

List[Tuple[Document, float]]: 最相似于查询文本的文档列表，以及每个文档的余弦距离。 较低的分数表示更相似。

Parameters

• embedding (List[float]) –

• k (int) –

• filter (Optional[List[Namespace]]) –

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[List[Namespace]] = None) → List[Tuple[Document, float]]

返回与查询最相似的文档及其与查询之间的余弦距离。

参数：

query：要查找类似文档的字符串查询。 k：要返回的文档数量。默认为4。 filter：可选。用于过滤匹配结果的命名空间列表。

例如： [Namespace(“color”, [“red”], []), Namespace(“shape”, [], [“squared”])] 将匹配满足”红色颜色”但不包括”正方形形状”的数据点。请参考 https://cloud.google.com/vertex-ai/docs/matching-engine/filtering#json 了解更多详细信息。

返回：

List[Tuple[Document, float]]：与查询文本最相似的文档列表，以及每个文档的余弦距离。 较低的分数表示更相似。

Parameters

• query (str) –

• k (int) –

• filter (Optional[List[Namespace]]) –

Return type

List[Tuple[Document, float]]

Examples using MatchingEngine

• Google