langchain_community.vectorstores.alibabacloud_opensearch.AlibabaCloudOpenSearch

class langchain_community.vectorstores.alibabacloud_opensearch.AlibabaCloudOpenSearch(embedding: Embeddings, config: AlibabaCloudOpenSearchSettings, **kwargs: Any)[source]

阿里云 OpenSearch 向量存储。

属性

embeddings

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

方法

__init__(embedding, config, **kwargs)

aadd_documents(documents, **kwargs)

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

aadd_texts(texts[, metadatas])

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

add_documents(documents, **kwargs)

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

add_texts(texts[, metadatas])

将文档插入到实例中。 :param texts: 要插入到向量存储中的文本段,不能为空。 :param metadatas: 元数据信息。

adelete([ids])

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

afrom_documents(documents, embedding, **kwargs)

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

afrom_texts(texts, embedding[, metadatas])

异步返回从文本和嵌入初始化的 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])

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

asimilarity_search_with_relevance_scores(query)

异步返回范围在 [0, 1] 内的文档和相关性得分。

asimilarity_search_with_score(*args, **kwargs)

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

astreaming_upsert(items, /, batch_size, **kwargs)

aupsert(items, /, **kwargs)

create_inverse_metadata(fields)

从字段创建元数据。

create_results(json_result)

组装文档。

create_results_with_score(json_result)

解析返回的带分数的結果。

delete([ids])

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

delete_documents_with_document_id(id_list)

根据文档 ID 删除文档。

delete_documents_with_texts(texts)

根据页面内容删除文档。

from_documents(documents, embedding[, config])

创建阿里云 OpenSearch 向量存储实例。

from_texts(texts, embedding[, metadatas, config])

创建阿里云 OpenSearch 向量存储实例。

get_by_ids(ids, /)

通过 ID 获取文档。

inner_embedding_query(embedding[, ...])

max_marginal_relevance_search(query[, k, ...])

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

max_marginal_relevance_search_by_vector(...)

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

search(query, search_type, **kwargs)

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

similarity_search(query[, k, search_filter])

基于文本执行相似性检索。

similarity_search_by_vector(embedding[, k, ...])

直接使用向量执行检索。

similarity_search_with_relevance_scores(query)

基于文本执行带分数的相似性检索。

similarity_search_with_score(*args, **kwargs)

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

streaming_upsert(items, /, batch_size, **kwargs)

upsert(items, /, **kwargs)

参数
__init__(embedding: Embeddings, config: AlibabaCloudOpenSearchSettings, **kwargs: Any) None[source]
参数
返回类型

None

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

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

参数
  • documents (List[Document]) – 要添加到向量存储的文档列表。

  • kwargs (Any) – 额外的关键字参数。

返回

添加的文本的 ID 列表。

Raises

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

返回类型

List[str]

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

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

参数
  • texts (Iterable[str]) – 要添加到向量存储的字符串的可迭代对象。

  • metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。默认为 None。

  • **kwargs (Any) – 向量存储特定的参数。

返回

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

Raises
  • 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 列表。

Raises

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

返回类型

List[str]

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

将文档插入到实例中。 :param texts: 要插入到向量存储中的文本段,

不应为空。

参数
  • metadatas (Optional[List[dict]]) – 元数据信息。

  • texts (Iterable[str]) –

  • kwargs (Any) –

返回

文档 ID 列表。

返回类型

id_list

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

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

参数
  • ids (Optional[List[str]]) – 要删除的 ID 列表。如果为 None,则删除所有。默认为 None。

  • **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。

返回类型

VectorStore

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

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

参数
  • texts (List[str]) – 要添加到向量存储的文本列表。

  • embedding (Embeddings) – 要使用的嵌入函数。

  • metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。默认为 None。

  • kwargs (Any) – 额外的关键字参数。

返回

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

返回类型

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 版本中的新功能。

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

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

参数
  • 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]): 定义 Retriever 应执行的搜索类型。

可以是 “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 的 Retriever 类。

返回类型

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

返回

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

Raises

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

返回类型

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

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

参数
  • items (AsyncIterable[Document]) – 要添加到向量存储的文档的可迭代对象。

  • batch_size (int) – 每次 upsert 的批次大小。

  • kwargs (Any) – 附加关键字参数。kwargs 应仅包含所有文档通用的参数。(例如,索引超时,重试策略等)kwargs 不应包含 ids 以避免语义不明确。相反,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 版本中的新功能。

create_inverse_metadata(fields: Dict[str, Any]) Dict[str, Any][source]

从字段创建元数据。

参数

fields (Dict[str, Any]) – 文档的字段。字段必须是 dict。

返回

文档的元数据。元数据必须是 dict。

返回类型

metadata

create_results(json_result: Dict[str, Any]) List[Document][source]

组装文档。

参数

json_result (Dict[str, Any]) –

返回类型

List[Document]

create_results_with_score(json_result: Dict[str, Any]) List[Tuple[Document, float]][source]

解析返回的带分数的 results。 :param json_result: 来自 OpenSearch 查询的结果。

返回

带分数的结果。

返回类型

query_result_list

参数

json_result (Dict[str, Any]) –

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

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

参数
  • ids (Optional[List[str]]) – 要删除的 ID 列表。如果为 None,则删除所有。默认为 None。

  • **kwargs (Any) – 子类可能使用的其他关键字参数。

返回

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

返回类型

Optional[bool]

delete_documents_with_document_id(id_list: List[str]) bool[source]

根据文档 ID 删除文档。

参数

id_list (List[str]) – 文档 ID 列表。

返回

删除是否成功。

返回类型

bool

delete_documents_with_texts(texts: List[str]) bool[source]

根据页面内容删除文档。

参数

texts (List[str]) – 文档页面内容列表。

返回

删除是否成功。

返回类型

bool

classmethod from_documents(documents: List[Document], embedding: Embeddings, config: Optional[AlibabaCloudOpenSearchSettings] = None, **kwargs: Any) AlibabaCloudOpenSearch[source]

创建阿里云 OpenSearch 向量存储实例。

参数
  • documents (List[Document]) – 要插入到向量存储中的文档,不能为空。

  • embedding (Embeddings) – 嵌入函数,嵌入函数。

  • config (Optional[AlibabaCloudOpenSearchSettings]) – 阿里云 OpenSearch 实例配置。

  • ids – 指定插入文档的 ID。如果留空,则将根据文本内容自动生成 ID。

  • kwargs (Any) –

返回

阿里云 opensearch 向量存储实例。

返回类型

AlibabaCloudOpenSearch

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, config: Optional[AlibabaCloudOpenSearchSettings] = None, **kwargs: Any) AlibabaCloudOpenSearch[source]

创建阿里云 OpenSearch 向量存储实例。

参数
  • texts (List[str]) – 要插入到向量存储中的文本段,不能为空。

  • embedding (Embeddings) – 嵌入函数,嵌入函数。

  • config (Optional[AlibabaCloudOpenSearchSettings]) – 阿里云 OpenSearch 实例配置。

  • metadatas (Optional[List[dict]]) – 元数据信息。

  • kwargs (Any) –

返回

阿里云 opensearch 向量存储实例。

返回类型

AlibabaCloudOpenSearch

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 版本中的新功能。

inner_embedding_query(embedding: List[float], search_filter: Optional[Dict[str, Any]] = None, k: int = 4) Dict[str, Any][source]
参数
  • embedding (List[float]) – 嵌入向量

  • search_filter (Optional[Dict[str, Any]]) – 搜索过滤器(可选)

  • k (int) – 返回结果数量

返回类型

Dict[str, Any]

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

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

参数
  • query (str) – 用于查找相似文档的文本。

  • k (int) – 返回的文档数量。默认为 4。

  • fetch_k (int) – 用于传递给 MMR 算法的文档数量。默认为 20。

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

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

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

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

返回

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

Raises

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

返回类型

List[Document]

基于文本执行相似性检索。 :param query: 将文本向量化以进行检索,不应为空。 :param k: 返回前 n 个结果。 :param search_filter: 附加过滤条件。

返回

文档列表。

返回类型

document_list

参数
  • query (str) –

  • k (int) – 返回结果数量

  • search_filter (Optional[Dict[str, Any]]) – 搜索过滤器(可选)

  • kwargs (Any) –

similarity_search_by_vector(embedding: List[float], k: int = 4, search_filter: Optional[dict] = None, **kwargs: Any) List[Document][source]

直接使用向量执行检索。 :param embedding: 向量。 :param k: 返回前 n 个结果。 :param search_filter: 附加过滤条件。

返回

文档列表。

返回类型

document_list

参数
  • embedding (List[float]) – 嵌入向量

  • k (int) – 返回结果数量

  • search_filter (Optional[dict]) –

  • kwargs (Any) –

similarity_search_with_relevance_scores(query: str, k: int = 4, search_filter: Optional[dict] = None, **kwargs: Any) List[Tuple[Document, float]][source]

基于文本执行相似性检索并返回评分。 :param query: 将文本向量化以进行检索,不应为空。 :param k: 返回前 n 个结果。 :param search_filter: 附加过滤条件。

返回

文档列表。

返回类型

document_list

参数
  • query (str) –

  • k (int) – 返回结果数量

  • search_filter (Optional[dict]) –

  • kwargs (Any) –

similarity_search_with_score(*args: Any, **kwargs: Any) List[Tuple[Document, float]]

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

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

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

返回

(文档,相似度分数)元组的列表。

返回类型

List[Tuple[Document, float]]

streaming_upsert(items: Iterable[Document], /, batch_size: int, **kwargs: Any) Iterator[UpsertResponse]

Beta

在 0.2.11 版本中添加。API 可能会发生变化。

以流式方式更新文档。

参数
  • items (Iterable[Document]) – 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 版本中的新功能。

AlibabaCloudOpenSearch 使用示例