`langchain_community.vectorstores.opensearch_vector_search`.OpenSearchVectorSearch¶

class langchain_community.vectorstores.opensearch_vector_search.OpenSearchVectorSearch(opensearch_url: str, index_name: str, embedding_function: Embeddings, **kwargs: Any)[source]¶

Amazon OpenSearch 向量引擎向量存储。

示例

from langchain_community.vectorstores import OpenSearchVectorSearch
opensearch_vector_search = OpenSearchVectorSearch(
    "http://localhost:9200",
    "embeddings",
    embedding_function
)

使用必要的组件初始化。

属性

embeddings

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

方法

`__init__`(opensearch_url, index_name, ...)	使用必要的组件初始化。
`aadd_documents`(documents, **kwargs)	异步地通过嵌入运行更多文档并添加到向量存储。
`aadd_texts`(texts[, metadatas, ids, bulk_size])	异步地通过嵌入运行更多文本并添加到向量存储。
`add_documents`(documents, **kwargs)	在向量存储中添加或更新文档。
`add_embeddings`(text_embeddings[, metadatas, ...])	将给定的文本和嵌入添加到向量存储。
`add_texts`(texts[, metadatas, ids, bulk_size])	通过嵌入运行更多文本并添加到向量存储。
`adelete`([ids])	异步地通过向量 ID 或其他条件删除。
`afrom_documents`(documents, embedding, **kwargs)	异步地从文档和嵌入初始化并返回 VectorStore。
`afrom_embeddings`(embeddings, texts, embedding)	异步地从预向量化的嵌入构造 OpenSearchVectorSearch 包装器。
`afrom_texts`(texts, embedding[, metadatas, ...])	异步地从原始文本构造 OpenSearchVectorSearch 包装器。
`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)
`create_index`(dimension[, index_name])	使用给定参数创建新索引
`delete`([ids, refresh_indices])	从 Opensearch 索引中删除文档。
`delete_index`([index_name])	从向量存储中删除给定的索引。
`from_documents`(documents, embedding, **kwargs)	从文档和嵌入初始化并返回 VectorStore。
`from_embeddings`(embeddings, texts, embedding)	从预向量化的嵌入构造 OpenSearchVectorSearch 包装器。
`from_texts`(texts, embedding[, metadatas, ...])	从原始文本构造 OpenSearchVectorSearch 包装器。
`get_by_ids`(ids, /)	通过 ID 获取文档。
`index_exists`([index_name])	如果给定索引存在于向量存储中，则返回 True，否则返回 False。
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`search`(query, search_type, **kwargs)	使用指定的搜索类型返回与查询最相似的文档。
`similarity_search`(query[, k, score_threshold])	返回与查询最相似的文档。
`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)

参数

opensearch_url (str) –
index_name (str) –
embedding_function (Embeddings) –
kwargs (Any) –

__init__(opensearch_url: str, index_name: str, embedding_function: Embeddings, **kwargs: Any)[source]¶

使用必要的组件初始化。

参数

opensearch_url (str) –
index_name (str) –
embedding_function (Embeddings) –
kwargs (Any) –

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

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

参数

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

返回

添加的文本的 ID 列表。

引发

ValueError – 如果 ID 数量与文档数量不匹配，则引发此错误。

返回类型

List[str]

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

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

参数

texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
ids (Optional[List[str]]) –
bulk_size (int) –
kwargs (Any) –

返回类型

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 的数量与文档的数量不匹配，则引发 ValueError。

返回类型

List[str]

add_embeddings(text_embeddings: Iterable[Tuple[str, List[float]]], metadatas: Optional[List[dict]] = None, ids: Optional[List[str]] = None, bulk_size: int = 500, **kwargs: Any) → List[str][source]¶

将给定的文本和嵌入添加到向量存储。

参数

text_embeddings (Iterable[Tuple[str, List[float]]]) – 要添加到向量存储的字符串和嵌入的可迭代对。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。
ids (Optional[List[str]]) – 与文本关联的可选 ID 列表。
bulk_size (int) – 批量 API 请求计数；默认值：500
kwargs (Any) –

返回

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

返回类型

List[str]

可选参数

vector_field: 存储嵌入的文档字段。默认为 “vector_field”。

text_field: 存储文档文本的文档字段。默认为 “text”。

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

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

参数

texts (Iterable[str]) – 要添加到向量存储的字符串的可迭代对象。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。
ids (Optional[List[str]]) – 与文本关联的可选 ID 列表。
bulk_size (int) – 批量 API 请求计数；默认值：500
kwargs (Any) –

返回

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

返回类型

List[str]

可选参数

vector_field: 存储嵌入的文档字段。默认为 “vector_field”。

text_field: 存储文档文本的文档字段。默认为 “text”。

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

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

参数

ids (Optional[List[str]]) – 要删除的id列表。
**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

async classmethod afrom_embeddings(embeddings: List[List[float]], texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, bulk_size: int = 500, ids: Optional[List[str]] = None, **kwargs: Any) → OpenSearchVectorSearch[source]¶

异步地从预向量化的嵌入构造 OpenSearchVectorSearch 包装器。

示例

from langchain_community.vectorstores import OpenSearchVectorSearch
from langchain_community.embeddings import OpenAIEmbeddings
embedder = OpenAIEmbeddings()
embeddings = await embedder.aembed_documents(["foo", "bar"])
opensearch_vector_search =
    await OpenSearchVectorSearch.afrom_embeddings(
        embeddings,
        texts,
        embedder,
        opensearch_url="http://localhost:9200"
)

OpenSearch 默认支持由 nmslib、faiss 和 lucene 引擎驱动的近似搜索，推荐用于大型数据集。也支持通过脚本评分和 Painless 脚本进行暴力搜索。

可选参数

vector_field: 存储嵌入的文档字段。默认为 “vector_field”。

text_field: 存储文档文本的文档字段。默认为 “text”。

近似搜索的可选关键字参数

engine: “nmslib”, “faiss”, “lucene”; 默认值: “nmslib”

space_type: “l2”, “l1”, “cosinesimil”, “linf”, “innerproduct”; 默认值: “l2”

ef_search: k-NN 搜索期间使用的动态列表的大小。值越高，搜索越准确，但速度越慢；默认值: 512

ef_construction: k-NN 图创建期间使用的动态列表的大小。值越高，图越准确，但索引速度越慢；默认值: 512

m: 为每个新元素创建的双向链接数。对内存消耗影响很大。介于 2 和 100 之间；默认值: 16

脚本评分或 Painless 脚本的关键字参数

is_appx_search: False

参数

embeddings (List[List[float]]) –
texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
bulk_size (int) –
ids (Optional[List[str]]) –
kwargs (Any) –

返回类型

OpenSearchVectorSearch

async classmethod afrom_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, bulk_size: int = 500, ids: Optional[List[str]] = None, **kwargs: Any) → OpenSearchVectorSearch[source]¶

异步地从原始文本构造 OpenSearchVectorSearch 包装器。

示例

from langchain_community.vectorstores import OpenSearchVectorSearch
from langchain_community.embeddings import OpenAIEmbeddings
embeddings = OpenAIEmbeddings()
opensearch_vector_search = await OpenSearchVectorSearch.afrom_texts(
    texts,
    embeddings,
    opensearch_url="http://localhost:9200"
)

OpenSearch 默认支持由 nmslib、faiss 和 lucene 引擎驱动的近似搜索，推荐用于大型数据集。也支持通过脚本评分和 Painless 脚本进行暴力搜索。

可选参数

vector_field: 存储嵌入的文档字段。默认为 “vector_field”。

text_field: 存储文档文本的文档字段。默认为 “text”。

近似搜索的可选关键字参数

engine: “nmslib”, “faiss”, “lucene”; 默认值: “nmslib”

space_type: “l2”, “l1”, “cosinesimil”, “linf”, “innerproduct”; 默认值: “l2”

ef_search: k-NN 搜索期间使用的动态列表的大小。值越高，搜索越准确，但速度越慢；默认值: 512

ef_construction: k-NN 图创建期间使用的动态列表的大小。值越高，图越准确，但索引速度越慢；默认值: 512

m: 为每个新元素创建的双向链接数。对内存消耗影响很大。介于 2 和 100 之间；默认值: 16

脚本评分或 Painless 脚本的关键字参数

is_appx_search: False

参数

texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
bulk_size (int) –
ids (Optional[List[str]]) –
kwargs (Any) –

返回类型

OpenSearchVectorSearch

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 (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 可能会发生变化。

以流式方式更新文档。 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 版本中新增。

create_index(dimension: int, index_name: Optional[str] = '26951c259a8b4e7b9282a3070d2432ad', **kwargs: Any) → Optional[str][source]¶

使用给定参数创建新索引

参数

dimension (int) – 维度 (整数)
index_name (Optional[str]) – 索引名称 (可选的[字符串])
kwargs (Any) –

返回类型

Optional[str] - 可选的[字符串]

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

从 Opensearch 索引中删除文档。

参数

ids (Optional[List[str]]) – 要删除的文档 ID 列表。
refresh_indices (Optional[bool]) – 是否在删除文档后刷新索引。默认为 True。
kwargs (Any) –

返回类型

Optional[bool] - 可选的[布尔值]

delete_index(index_name: Optional[str] = None) → Optional[bool][source]¶

从向量存储中删除给定的索引。

参数: index_name (Optional[str]) – 索引名称 (可选的[字符串])
返回类型: Optional[bool] - 可选的[布尔值]

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

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

参数

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

返回

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

返回类型

VectorStore

classmethod from_embeddings(embeddings: List[List[float]], texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, bulk_size: int = 500, ids: Optional[List[str]] = None, **kwargs: Any) → OpenSearchVectorSearch[source]¶

从预向量化的嵌入构造 OpenSearchVectorSearch 包装器。

示例

from langchain_community.vectorstores import OpenSearchVectorSearch
from langchain_community.embeddings import OpenAIEmbeddings
embedder = OpenAIEmbeddings()
embeddings = embedder.embed_documents(["foo", "bar"])
opensearch_vector_search = OpenSearchVectorSearch.from_embeddings(
    embeddings,
    texts,
    embedder,
    opensearch_url="http://localhost:9200"
)

OpenSearch 默认支持由 nmslib、faiss 和 lucene 引擎驱动的近似搜索，推荐用于大型数据集。也支持通过脚本评分和 Painless 脚本进行暴力搜索。

可选参数

vector_field: 存储嵌入的文档字段。默认为 “vector_field”。

text_field: 存储文档文本的文档字段。默认为 “text”。

近似搜索的可选关键字参数

engine: “nmslib”, “faiss”, “lucene”; 默认值: “nmslib”

space_type: “l2”, “l1”, “cosinesimil”, “linf”, “innerproduct”; 默认值: “l2”

ef_search: k-NN 搜索期间使用的动态列表的大小。值越高，搜索越准确，但速度越慢；默认值: 512

ef_construction: k-NN 图创建期间使用的动态列表的大小。值越高，图越准确，但索引速度越慢；默认值: 512

m: 为每个新元素创建的双向链接数。对内存消耗影响很大。介于 2 和 100 之间；默认值: 16

脚本评分或 Painless 脚本的关键字参数

is_appx_search: False

参数

embeddings (List[List[float]]) –
texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
bulk_size (int) –
ids (Optional[List[str]]) –
kwargs (Any) –

返回类型

OpenSearchVectorSearch

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

从原始文本构造 OpenSearchVectorSearch 包装器。

示例

from langchain_community.vectorstores import OpenSearchVectorSearch
from langchain_community.embeddings import OpenAIEmbeddings
embeddings = OpenAIEmbeddings()
opensearch_vector_search = OpenSearchVectorSearch.from_texts(
    texts,
    embeddings,
    opensearch_url="http://localhost:9200"
)

OpenSearch 默认支持由 nmslib、faiss 和 lucene 引擎驱动的近似搜索，推荐用于大型数据集。也支持通过脚本评分和 Painless 脚本进行暴力搜索。

可选参数

vector_field: 存储嵌入的文档字段。默认为 “vector_field”。

text_field: 存储文档文本的文档字段。默认为 “text”。

近似搜索的可选关键字参数

engine: “nmslib”, “faiss”, “lucene”; 默认值: “nmslib”

space_type: “l2”, “l1”, “cosinesimil”, “linf”, “innerproduct”; 默认值: “l2”

ef_search: k-NN 搜索期间使用的动态列表的大小。值越高，搜索越准确，但速度越慢；默认值: 512

ef_construction: k-NN 图创建期间使用的动态列表的大小。值越高，图越准确，但索引速度越慢；默认值: 512

m: 为每个新元素创建的双向链接数。对内存消耗影响很大。介于 2 和 100 之间；默认值: 16

脚本评分或 Painless 脚本的关键字参数

is_appx_search: False

参数

texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
bulk_size (int) –
ids (Optional[List[str]]) –
kwargs (Any) –

返回类型

OpenSearchVectorSearch

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 版本中新增。

index_exists(index_name: Optional[str] = None) → Optional[bool][source]¶

如果给定索引存在于向量存储中，则返回 True，否则返回 False。

参数: index_name (Optional[str]) – 索引名称 (可选的[字符串])
返回类型: Optional[bool] - 可选的[布尔值]

max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → list[langchain_core.documents.base.Document][source]¶

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

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

参数

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

返回

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

返回类型

list[langchain_core.documents.base.Document] - 列表[langchain_core.documents.base.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 (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 要获取并传递给 MMR 算法的文档数量。默认为 20。
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, score_threshold: Optional[float] = 0.0, **kwargs: Any) → List[Document][source]¶

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

默认情况下，支持近似搜索。也支持脚本评分和无痛脚本。

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
score_threshold (Optional[float]) – 指定一个分数阈值，仅返回得分高于阈值的文档
0.0. (above the threshold. Defaults to) – 0.0。（高于阈值。默认为）
kwargs (Any) –

返回

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

返回类型

List[Document] - 列表[Document]

可选参数

vector_field: 存储嵌入的文档字段。默认为 “vector_field”。

text_field: 存储文档文本的文档字段。默认为 “text”。

metadata_field: 存储元数据的文档字段。默认为“metadata”。可以设置为特殊值“*”以包含整个文档。

近似搜索的可选参数

search_type：“approximate_search”；默认值：“approximate_search”

boolean_filter：布尔过滤器是一个后置过滤器，由包含 k-NN 查询和过滤器的布尔查询组成。

subquery_clause：knn 向量字段上的查询子句；默认值：“must”

lucene_filter：Lucene 算法决定是执行带有预过滤的精确 k-NN 搜索，还是执行带有修改后的后过滤的近似搜索。（已弃用，请使用 efficient_filter）

efficient_filter：Lucene 引擎或 Faiss 引擎决定是执行带有预过滤的精确 k-NN 搜索，还是执行带有修改后的后过滤的近似搜索。

脚本评分搜索的可选参数

search_type：“script_scoring”；默认值：“approximate_search”

space_type：“l2”、“l1”、“linf”、“cosinesimil”、“innerproduct”、“hammingbit”；默认值：“l2”

pre_filter：用于在识别最近邻居之前预过滤文档的 script_score 查询；默认值：{“match_all”: {}}

无痛脚本搜索的可选参数

search_type：“painless_scripting”；默认值：“approximate_search”

space_type：“l2Squared”、“l1Norm”、“cosineSimilarity”；默认值：“l2Squared”

pre_filter：用于在识别最近邻居之前预过滤文档的 script_score 查询；默认值：{“match_all”: {}}

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

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

参数

embedding (List[float]) – 嵌入向量
k (int) –
score_threshold (Optional[float]) –
kwargs (Any) –

返回类型

List[Document] - 列表[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 之间的浮点值，用于

filter the resulting set of retrieved docs.

返回

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

返回类型

List[Tuple[Document, float]]

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

Return docs and it’s scores most similar to query.

默认情况下，支持近似搜索。也支持脚本评分和无痛脚本。

参数

query (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
score_threshold (Optional[float]) – 指定一个分数阈值，仅返回得分高于阈值的文档
0.0. (above the threshold. Defaults to) – 0.0。（高于阈值。默认为）
kwargs (Any) –

返回

List of Documents along with its scores most similar to the query.

返回类型

List[Tuple[Document, float]] - 列表[元组[Document, 浮点数]]

可选参数: same as similarity_search - 与 similarity_search 相同

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

Return docs and it’s scores most similar to the embedding vector.

默认情况下，支持近似搜索。也支持脚本评分和无痛脚本。

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
score_threshold (Optional[float]) – 指定一个分数阈值，仅返回得分高于阈值的文档
0.0. (above the threshold. Defaults to) – 0.0。（高于阈值。默认为）
kwargs (Any) –

返回

List of Documents along with its scores most similar to the query.

返回类型

List[Tuple[Document, float]] - 列表[元组[Document, 浮点数]]

可选参数: same as similarity_search - 与 similarity_search 相同

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] - 迭代器[UpsertResponse]

0.2.11 版本中新增。

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 版本中新增。

Examples using OpenSearchVectorSearch¶ - 使用 OpenSearchVectorSearch 的示例¶

langchain_community.vectorstores.opensearch_vector_search.OpenSearchVectorSearch¶

Examples using OpenSearchVectorSearch¶ - 使用 OpenSearchVectorSearch 的示例¶

`langchain_community.vectorstores.opensearch_vector_search`.OpenSearchVectorSearch¶