langchain_community.vectorstores.alibabacloud_opensearch.AlibabaCloudOpenSearch

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

阿里云开放搜索`Alibaba Cloud OpenSearch`向量存储。

Attributes

embeddings

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

Methods

__init__(embedding, config, **kwargs)

aadd_documents(documents, **kwargs)

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

aadd_texts(texts[, metadatas])

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

add_documents(documents, **kwargs)

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

add_texts(texts[, metadatas])

将文档插入实例中。 参数： texts: 要插入到向量存储中的文本段，不应为空。 metadatas: 元数据信息。 返回： id_list: 文档ID列表。

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)

使用异步方式运行相似性搜索与距离。

create_inverse_metadata(fields)

从字段创建元数据。

create_results(json_result)

组装文件。

create_results_with_score(json_result)

解析带有分数的返回结果。 参数： json_result：OpenSearch查询的结果。 返回： query_result_list：带有分数的结果。

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向量存储实例。

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

基于文本执行相似性检索。 参数： query: 用于检索的文本向量，不应为空。 k: 前n个。 search_filter: 附加的过滤条件。 返回： document_list: 文档列表。

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

直接使用向量执行检索。 参数： embedding: 向量。 k: 前n个。 search_filter: 附加过滤条件。 返回： document_list: 文档列表。

similarity_search_with_relevance_scores(query)

基于文本进行相似性检索并返回得分。 参数： query: 用于检索的文本向量，不应为空。 k: 前n个。 search_filter: 附加的过滤条件。 返回： document_list: 文档列表。

similarity_search_with_score(*args, **kwargs)

使用距离进行相似性搜索。
Parameters
Return type

None

__init__(embedding: Embeddings, config: AlibabaCloudOpenSearchSettings, **kwargs: Any) → None[source]
Parameters
Return type

None

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][source]

将文档插入实例中。 参数：

texts: 要插入到向量存储中的文本段，不应为空。 metadatas: 元数据信息。

返回：

id_list: 文档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
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

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

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

参数：

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]

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

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_inverse_metadata(fields: Dict[str, Any]) → Dict[str, Any][source]

从字段创建元数据。

参数：

fields：文档的字段。字段必须是一个字典。

返回：

metadata：文档的元数据。元数据必须是一个字典。

Parameters

fields (Dict[str, Any]) –

Return type

Dict[str, Any]

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

组装文件。

Parameters

json_result (Dict[str, Any]) –

Return type

List[Document]

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

解析带有分数的返回结果。 参数：

json_result：OpenSearch查询的结果。

返回：

query_result_list：带有分数的结果。

Parameters

json_result (Dict[str, 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]

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

根据它们的ID删除文档。

参数：

id_list：文档ID列表。

返回：

删除是否成功。

Parameters

id_list (List[str]) –

Return type

bool

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

根据页面内容删除文档。

参数：

texts：文档页面内容的列表。

返回值：

删除是否成功。

Parameters

texts (List[str]) –

Return type

bool

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

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

参数：

documents: 要插入向量存储的文档，不应为空。 embedding: 嵌入函数，嵌入函数。 config: 阿里巴巴OpenSearch实例配置。 ids: 指定插入文档的ID。如果留空，ID将根据文本内容自动生成。

返回：

AlibabaCloudOpenSearch: 阿里巴巴云OpenSearch向量存储实例。

Parameters
Return type

AlibabaCloudOpenSearch

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

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

参数：

texts：要插入向量存储的文本段，不应为空。 embedding：嵌入函数，嵌入函数。 config：阿里巴巴OpenSearch实例配置。 metadatas：元数据信息。

返回：

AlibabaCloudOpenSearch：阿里巴巴云OpenSearch向量存储实例。

Parameters
Return type

AlibabaCloudOpenSearch

inner_embedding_query(embedding: List[float], search_filter: Optional[Dict[str, Any]] = None, k: int = 4) → Dict[str, Any][source]
Parameters

  • embedding (List[float]) –

  • search_filter (Optional[Dict[str, Any]]) –

  • k (int) –

Return type

Dict[str, Any]

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

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

参数：

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]

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

query: 用于检索的文本向量，不应为空。 k: 前n个。 search_filter: 附加的过滤条件。

返回：

document_list: 文档列表。

Parameters

  • query (str) –

  • k (int) –

  • search_filter (Optional[Dict[str, Any]]) –

  • kwargs (Any) –

Return type

List[Document]

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

直接使用向量执行检索。 参数：

embedding: 向量。 k: 前n个。 search_filter: 附加过滤条件。

返回：

document_list: 文档列表。

Parameters

  • embedding (List[float]) –

  • k (int) –

  • search_filter (Optional[dict]) –

  • kwargs (Any) –

Return type

List[Document]

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

基于文本进行相似性检索并返回得分。 参数：

query: 用于检索的文本向量，不应为空。 k: 前n个。 search_filter: 附加的过滤条件。

返回：

document_list: 文档列表。

Parameters

  • query (str) –

  • k (int) –

  • search_filter (Optional[dict]) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

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

使用距离进行相似性搜索。

Parameters

  • args (Any) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

Examples using AlibabaCloudOpenSearch