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)

Amazon OpenSearch Vector Engine 向量存储。

示例:

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

使用必要的组件进行初始化。

Attributes

embeddings

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

Methods

__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包装器，从原始文本中获取。
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(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包装器。
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)	返回与嵌入向量最相似的文档及其分数。

Parameters

• opensearch_url (str) –

• index_name (str) –

• embedding_function (Embeddings) –

• kwargs (Any) –

__init__(opensearch_url: str, index_name: str, embedding_function: Embeddings, **kwargs: Any)

使用必要的组件进行初始化。

Parameters

• opensearch_url (str) –

• index_name (str) –

• embedding_function (Embeddings) –

• kwargs (Any) –

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, ids: Optional[List[str]] = None, bulk_size: int = 500, **kwargs: Any) → List[str]

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

Parameters

• texts (Iterable[str]) –

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

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

• bulk_size (int) –

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

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

参数：

text_embeddings：要添加到向量存储中的字符串和嵌入的可迭代对。 metadatas：与文本相关联的元数据的可选列表。 ids：与文本关联的可选id列表。 bulk_size：批量API请求计数；默认值：500

返回：

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

可选参数：

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

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

Parameters

• text_embeddings (Iterable[Tuple[str, List[float]]]) –

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

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

• bulk_size (int) –

• kwargs (Any) –

Return type

List[str]

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

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

参数：

texts：要添加到向量存储的字符串的可迭代对象。 metadatas：与文本相关联的元数据的可选列表。 ids：要与文本关联的可选id列表。 bulk_size：批量API请求计数；默认值：500

返回：

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

可选参数：

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

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

Parameters

• texts (Iterable[str]) –

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

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

• bulk_size (int) –

• 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_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

异步构建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

Parameters

• embeddings (List[List[float]]) –

• texts (List[str]) –

• embedding (Embeddings) –

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

• bulk_size (int) –

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

• kwargs (Any) –

Return type

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

异步构建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

Parameters

• texts (List[str]) –

• embedding (Embeddings) –

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

• bulk_size (int) –

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

• kwargs (Any) –

Return type

OpenSearchVectorSearch

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(dimension: int, index_name: Optional[str] = '22ad5f6e4f6b4aaeb2087cb0f2137d61', **kwargs: Any) → Optional[str]

使用给定的参数创建一个新的索引。

Parameters

• dimension (int) –

• index_name (Optional[str]) –

• kwargs (Any) –

Return type

Optional[str]

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

从Opensearch索引中删除文档。

参数：

ids：要删除的文档的id列表。 refresh_indices：删除文档后是否刷新索引。默认为True。

Parameters

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

• refresh_indices (Optional[bool]) –

• kwargs (Any) –

Return type

Optional[bool]

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

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

Parameters

index_name (Optional[str]) –

Return type

Optional[bool]

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

从预向量化的嵌入构建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

Parameters

• embeddings (List[List[float]]) –

• texts (List[str]) –

• embedding (Embeddings) –

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

• bulk_size (int) –

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

• kwargs (Any) –

Return type

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

从原始文本构建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

Parameters

• texts (List[str]) –

• embedding (Embeddings) –

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

• bulk_size (int) –

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

• kwargs (Any) –

Return type

OpenSearchVectorSearch

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

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

Parameters

index_name (Optional[str]) –

Return type

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]

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

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

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。

默认为20。

lambda_mult：0到1之间的数字，确定结果之间多样性的程度，

其中0对应于最大多样性，1对应于最小多样性。 默认为0.5。

返回：

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

Parameters

• query (str) –

• k (int) –

• fetch_k (int) –

• lambda_mult (float) –

• kwargs (Any) –

Return type

list[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：要查找相似文档的嵌入。 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, score_threshold: Optional[float] = 0.0, **kwargs: Any) → List[Document]

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

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

参数：

query：要查找相似文档的文本。 k：要返回的文档数量。默认为4。 score_threshold：指定一个分数阈值，仅返回分数 高于阈值的文档。默认为0.0。

返回：

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

可选参数：

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”: {}}

Parameters

• query (str) –

• k (int) –

• score_threshold (Optional[float]) –

• kwargs (Any) –

Return type

List[Document]

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

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

Parameters

• embedding (List[float]) –

• k (int) –

• score_threshold (Optional[float]) –

• 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, score_threshold: Optional[float] = 0.0, **kwargs: Any) → List[Tuple[Document, float]]

返回与查询最相似的文档及其分数。

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

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 score_threshold：指定一个分数阈值，仅返回高于该阈值的文档。默认为0.0。

返回：

与查询最相似的文档及其分数的列表。

可选参数：

与`similarity_search`相同。

Parameters

• query (str) –

• k (int) –

• score_threshold (Optional[float]) –

• kwargs (Any) –

Return type

List[Tuple[Document, float]]

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

返回与嵌入向量最相似的文档及其分数。

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

参数：

embedding：要查找类似文档的嵌入向量。 k：要返回的文档数量。默认为4。 score_threshold：指定一个分数阈值，仅返回分数 高于阈值的文档。默认为0.0。

返回：

与查询最相似的文档及其分数的列表。

可选参数：

与`similarity_search`相同。

Parameters

• embedding (List[float]) –

• k (int) –

• score_threshold (Optional[float]) –

• kwargs (Any) –

Return type

List[Tuple[Document, float]]

Examples using OpenSearchVectorSearch

• AWS

• If using the default Docker installation, use this instantiation instead:

• OpenSearch

• This example only specifies a relevant query