`langchain_community.vectorstores.momento_vector_index`.MomentoVectorIndex¶

class langchain_community.vectorstores.momento_vector_index.MomentoVectorIndex(embedding: Embeddings, client: PreviewVectorIndexClient, index_name: str = 'default', distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, text_field: str = 'text', ensure_index_exists: bool = True, **kwargs: Any)[source]¶

Momento Vector Index (MVI) 向量存储。

Momento Vector Index 是一个无服务器向量索引，可用于存储和搜索向量。要使用它，您应该安装 momento python 包。

示例

from langchain_community.embeddings import OpenAIEmbeddings
from langchain_community.vectorstores import MomentoVectorIndex
from momento import (
    CredentialProvider,
    PreviewVectorIndexClient,
    VectorIndexConfigurations,
)

vectorstore = MomentoVectorIndex(
    embedding=OpenAIEmbeddings(),
    client=PreviewVectorIndexClient(
        VectorIndexConfigurations.Default.latest(),
        credential_provider=CredentialProvider.from_environment_variable(
            "MOMENTO_API_KEY"
        ),
    ),
    index_name="my-index",
)

初始化由 Momento Vector Index 支持的向量存储。

参数

embedding (Embeddings) – 要使用的 embedding 函数。
configuration (VectorIndexConfiguration) – 用于初始化 Vector Index 的配置。
credential_provider (CredentialProvider) – 用于验证 Vector Index 的凭据提供程序。
index_name (str, 可选) – 用于存储文档的索引名称。默认为 “default”。
distance_strategy (DistanceStrategy, 可选) – 要使用的距离策略。如果您选择 DistanceStrategy.EUCLIDEAN_DISTANCE，Momento 将使用欧几里得距离的平方。默认为 DistanceStrategy.COSINE。
text_field (str, 可选) – 用于存储原始文本的元数据字段名称。默认为 “text”。
ensure_index_exists (bool, 可选) – 是否确保在向索引添加文档之前索引存在。默认为 True。
client (PreviewVectorIndexClient) –
kwargs (Any) –

属性

embeddings

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

方法

`__init__`(embedding, client[, index_name, ...])	初始化由 Momento Vector Index 支持的向量存储。
`aadd_documents`(documents, **kwargs)	异步运行更多文档通过 embeddings 并添加到向量存储。
`aadd_texts`(texts[, metadatas])	异步运行更多文本通过 embeddings 并添加到向量存储。
`add_documents`(documents, **kwargs)	在向量存储中添加或更新文档。
`add_texts`(texts[, metadatas])	运行更多文本通过 embeddings 并添加到向量存储。
`adelete`([ids])	异步按向量 ID 或其他条件删除。
`afrom_documents`(documents, embedding, **kwargs)	异步返回从文档和 embeddings 初始化的 VectorStore。
`afrom_texts`(texts, embedding[, metadatas])	异步返回从文本和 embeddings 初始化 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])	异步返回与 embedding 向量最相似的文档。
`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 删除。
`from_documents`(documents, embedding, **kwargs)	返回从文档和 embeddings 初始化的 VectorStore。
`from_texts`(texts, embedding[, metadatas])	返回从文本和 embeddings 初始化的 Vector Store。
`get_by_ids`(ids, /)	按 ID 获取文档。
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`search`(query, search_type, **kwargs)	返回与查询最相似的文档，使用指定的搜索类型。
`similarity_search`(query[, k])	搜索与查询字符串相似的文档。
`similarity_search_by_vector`(embedding[, k])	搜索与查询向量相似的文档。
`similarity_search_with_relevance_scores`(query)	返回文档和相关性分数，范围在 [0, 1] 内。
`similarity_search_with_score`(query[, k])	搜索与查询字符串相似的文档。
`similarity_search_with_score_by_vector`(embedding)	搜索与查询向量相似的文档。
`streaming_upsert`(items, /, batch_size, **kwargs)
`upsert`(items, /, **kwargs)

__init__(embedding: Embeddings, client: PreviewVectorIndexClient, index_name: str = 'default', distance_strategy: DistanceStrategy = DistanceStrategy.COSINE, text_field: str = 'text', ensure_index_exists: bool = True, **kwargs: Any)[source]¶

初始化由 Momento Vector Index 支持的向量存储。

参数

embedding (Embeddings) – 要使用的 embedding 函数。
configuration (VectorIndexConfiguration) – 用于初始化 Vector Index 的配置。
credential_provider (CredentialProvider) – 用于验证 Vector Index 的凭据提供程序。
index_name (str, 可选) – 用于存储文档的索引名称。默认为 “default”。
distance_strategy (DistanceStrategy, 可选) – 要使用的距离策略。如果您选择 DistanceStrategy.EUCLIDEAN_DISTANCE，Momento 将使用欧几里得距离的平方。默认为 DistanceStrategy.COSINE。
text_field (str, 可选) – 用于存储原始文本的元数据字段名称。默认为 “text”。
ensure_index_exists (bool, 可选) – 是否确保在向索引添加文档之前索引存在。默认为 True。
client (PreviewVectorIndexClient) –
kwargs (Any) –

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

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

参数

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

返回值

添加文本的 ID 列表。

引发

ValueError – 如果 ID 数量与文档数量不匹配。

返回类型

List[str]

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

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

参数

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

返回值

将文本添加到向量存储后返回的 id 列表。

引发

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

返回类型

List[str]

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

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

参数

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

返回值

添加文本的 ID 列表。

引发

ValueError – 如果 id 数量与文档数量不匹配。

返回类型

List[str]

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

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

参数

texts (Iterable[str]) – 要添加到向量存储的字符串的可迭代对象。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。
kwargs (Any) – 其他可选参数。特别是
ids (-) – 用于文本的 ids 列表。默认为 None，在这种情况下会生成 uuids。

返回值

将文本添加到向量存储后返回的 id 列表。

返回类型

List[str]

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

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

参数

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

返回值

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

返回类型

Optional[bool]

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

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

参数

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

返回值

从文档和 embeddings 初始化的 VectorStore。

返回类型

VectorStore

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

异步返回从文本和 embeddings 初始化 VectorStore。

参数

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

返回值

从文本和嵌入初始化的向量存储。

返回类型

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]): 定义检索器应执行的搜索类型。

可以是 “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 的检索器类。

返回类型

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) – 传递给搜索方法的参数。

返回值

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

引发

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 向量最相似的文档。

参数

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 之间的浮点值，用于

过滤检索到的文档结果集

返回值

（文档，相似度分数）元组列表

返回类型

List[Tuple[Document, float]]

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

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

参数

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

返回值

（文档，相似度分数）元组列表。

返回类型

List[Tuple[Document, float]]

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

Beta

0.2.11 版本新增功能。API 可能会更改。

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

参数

items (AsyncIterable[Document]) – 要添加到向量存储的文档的可迭代对象。
batch_size (int) – 每次 upsert 批处理的大小。
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 字段，则 upsert 功能应使用该字段。如果未提供 ID，则 upsert 方法可以自由地为文档生成 ID。

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

参数

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

返回值

响应对象，其中包含已成功添加到向量存储或在向量存储中更新的 ID 列表，以及未能添加或更新的 ID 列表。

返回类型

UpsertResponse

0.2.11 版本新增功能。

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

按向量 ID 删除。

参数

ids (List[str]) – 要删除的 id 列表。
kwargs (Any) – 其他可选参数（未使用）

返回值

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

返回类型

Optional[bool]

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

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

参数

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

返回值

从文档和 embeddings 初始化的 VectorStore。

返回类型

VectorStore

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

返回从文本和 embeddings 初始化的 Vector Store。

参数

cls (Type[VST]) – 用于初始化 Vector Store 的 Vector Store 类。
texts (List[str]) – 用于初始化 Vector Store 的文本。
embedding (Embeddings) – 要使用的 embedding 函数。
metadatas (Optional[List[dict]], optional) – 与文本关联的元数据。默认为 None。
kwargs (Any) – Vector Store 特定参数。以下参数将转发到 Vector Store 构造函数，并且是必需的
index_name (-) – 用于存储文档的索引名称。默认为 “default”。
text_field (-) – 用于存储原始文本的元数据字段名称。默认为 “text”。
distance_strategy (-) – 要使用的距离策略。默认为 DistanceStrategy.COSINE。如果选择 DistanceStrategy.EUCLIDEAN_DISTANCE，Momento 将使用平方欧几里得距离。
ensure_index_exists (-) – 是否确保索引在添加文档之前存在。默认为 True。
key (此外，您可以传入客户端或API 密钥) –
client (-) – 要使用的 Momento Vector Index 客户端。
api_key (-) – 用于初始化 Vector Index 的配置。默认为 None。如果为 None，则从环境变量 MOMENTO_API_KEY 初始化配置。

返回值

从文本和: 嵌入初始化的 Momento Vector Index 向量存储。

返回类型

VST

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, **kwargs: Any) → List[Document][source]¶

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

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

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要获取以传递给 MMR 算法的文档数量。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
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, **kwargs: Any) → List[Document][source]¶

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

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

参数

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

返回值

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

返回类型

List[Document]

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

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

参数

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

返回值

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

引发

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

返回类型

List[Document]

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

搜索与查询字符串相似的文档。

参数

query (str) – 要搜索的查询字符串。
k (int, optional) – 返回的结果数量。默认为 4。
kwargs (Any) –

返回值

与查询相似的文档列表。

返回类型

List[Document]

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

搜索与查询向量相似的文档。

参数

embedding (List[float]) – 要搜索的查询向量。
k (int, optional) – 返回的结果数量。默认为 4。
kwargs (Any) –

返回值

与查询相似的文档列表。

返回类型

List[Document]

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 之间的浮点值，用于

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

返回值

（文档，相似度分数）元组列表。

返回类型

List[Tuple[Document, float]]

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

搜索与查询字符串相似的文档。

参数

query (str) – 要搜索的查询字符串。
k (int, optional) – 返回的结果数量。默认为 4。
kwargs (Any) – 向量存储特定的搜索参数。以下参数将转发到 Momento Vector Index
top_k (-) – 返回的结果数量。

返回值

形式为以下元组的列表: (Document, score)。

返回类型

List[Tuple[Document, float]]

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

搜索与查询向量相似的文档。

参数

embedding (List[float]) – 要搜索的查询向量。
k (int, optional) – 返回的结果数量。默认为 4。
kwargs (Any) – 向量存储特定的搜索参数。以下参数将转发到 Momento Vector Index
top_k (-) – 返回的结果数量。

返回值

形式为以下元组的列表: (Document, score)。

返回类型

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) – 每次 upsert 批处理的大小。
kwargs (Any) – 额外的关键字参数。kwargs 应该只包含所有文档通用的参数。（例如，索引超时，重试策略等。）kwargs 不应包含 IDs 以避免语义模糊。相反，ID 应该作为 Document 对象的一部分提供。

Yields

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

返回类型

Iterator[UpsertResponse]

0.2.11 版本新增功能。

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

Beta

0.2.11 版本新增功能。API 可能会更改。

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

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

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

参数

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

返回值

响应对象，其中包含已成功添加到向量存储或在向量存储中更新的 ID 列表，以及未能添加或更新的 ID 列表。

返回类型

UpsertResponse

0.2.11 版本新增功能。

使用 MomentoVectorIndex 的示例¶

langchain_community.vectorstores.momento_vector_index.MomentoVectorIndex¶

使用 MomentoVectorIndex 的示例¶

`langchain_community.vectorstores.momento_vector_index`.MomentoVectorIndex¶