Aerospike#

class langchain_community.vectorstores.aerospike.Aerospike(client: Client, embedding: Embeddings | Callable, namespace: str, index_name: str | None = None, vector_key: str = '_vector', text_key: str = '_text', id_key: str = '_id', set_name: str | None = None, distance_strategy: DistanceStrategy | VectorDistanceMetric | None = DistanceStrategy.EUCLIDEAN_DISTANCE)[source]#

Aerospike 向量存储。

要使用,您应该安装aerospike_vector_search python包。

使用Aerospike客户端进行初始化。

Parameters:
  • client (Client) – Aerospike 客户端。

  • embedding (Union[Embeddings, Callable]) – 用于嵌入文本的Embeddings对象或Callable(已弃用)。

  • namespace (str) – 用于存储向量的命名空间。这应该匹配

  • index_name (可选[str]) – 之前在Aerospike中创建的索引的名称。此

  • vector_key (str) – 用于元数据中向量的键。这应该与索引创建时使用的键匹配。

  • text_key (str) – 用于元数据中文本的键。

  • id_key (str) – 用于元数据中id的键。

  • set_name (可选[str]) – 用于存储向量的默认集合名称。

  • distance_strategy (Optional[Union[DistanceStrategy, VectorDistanceMetric]]) – 用于相似性搜索的距离策略 这应该与索引创建期间使用的距离策略相匹配。

属性

embeddings

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

方法

__init__(client, embedding, namespace[, ...])

使用Aerospike客户端进行初始化。

aadd_documents(documents, **kwargs)

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

aadd_texts(texts[, metadatas, ids])

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

add_documents(documents, **kwargs)

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

add_texts(texts[, metadatas, ids, set_name, ...])

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

adelete([ids])

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

afrom_documents(documents, embedding, **kwargs)

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

afrom_texts(texts, embedding[, metadatas, ids])

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

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

convert_distance_strategy(distance_strategy)

将Aerospike的距离策略转换为langchain的DistanceStrategy枚举。

delete([ids, set_name])

根据向量ID或其他条件删除。

from_documents(documents, embedding, **kwargs)

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

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

这是一个用户友好的界面:

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, metadata_keys, ...])

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

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

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

similarity_search_by_vector_with_score(embedding)

返回与嵌入最相似的Aerospike文档,以及分数。

similarity_search_with_relevance_scores(query)

返回文档和相关分数,分数范围在[0, 1]之间。

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

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

__init__(client: Client, embedding: Embeddings | Callable, namespace: str, index_name: str | None = None, vector_key: str = '_vector', text_key: str = '_text', id_key: str = '_id', set_name: str | None = None, distance_strategy: DistanceStrategy | VectorDistanceMetric | None = DistanceStrategy.EUCLIDEAN_DISTANCE)[来源]#

使用Aerospike客户端进行初始化。

Parameters:
  • client (Client) – Aerospike 客户端。

  • embedding (Union[Embeddings, Callable]) – 用于嵌入文本的Embeddings对象或Callable(已弃用)。

  • namespace (str) – 用于存储向量的命名空间。这应该匹配

  • index_name (可选[str]) – 之前在Aerospike中创建的索引的名称。此

  • vector_key (str) – 用于元数据中向量的键。这应该与索引创建时使用的键匹配。

  • text_key (str) – 用于元数据中文本的键。

  • id_key (str) – 用于元数据中id的键。

  • set_name (可选[str]) – 用于存储向量的默认集合名称。

  • distance_strategy (Optional[Union[DistanceStrategy, VectorDistanceMetric]]) – 用于相似性搜索的距离策略 这应该与索引创建期间使用的距离策略相匹配。

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

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

Parameters:
  • documents (list[Document]) – 要添加到向量存储中的文档。

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

Returns:

已添加文本的ID列表。

Raises:

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

Return type:

列表[字符串]

async aadd_texts(texts: Iterable[str], metadatas: list[dict] | None = None, *, ids: list[str] | None = None, **kwargs: Any) list[str]#

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

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

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

  • ids (list[str] | None) – 可选的列表

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

Returns:

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

Raises:
  • ValueError – 如果元数据的数量与文本的数量不匹配。

  • ValueError – 如果id的数量与文本的数量不匹配。

Return type:

列表[字符串]

add_documents(documents: list[Document], **kwargs: Any) list[str]#

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

Parameters:
  • documents (list[Document]) – 要添加到向量存储中的文档。

  • kwargs (Any) – 额外的关键字参数。 如果 kwargs 包含 ids 并且 documents 也包含 ids, kwargs 中的 ids 将优先。

Returns:

已添加文本的ID列表。

Raises:

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

Return type:

列表[字符串]

add_texts(texts: Iterable[str], metadatas: List[dict] | None = None, ids: List[str] | None = None, set_name: str | None = None, embedding_chunk_size: int = 1000, index_name: str | None = None, wait_for_index: bool = True, **kwargs: Any) List[str][source]#

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

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

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

  • ids (List[str] | None) – 可选的id列表,用于与文本关联。

  • set_name (str | None) – 可选的Aerospike集合名称,用于添加文本。

  • batch_size – 将文本添加到向量存储时使用的批量大小。

  • embedding_chunk_size (int) – 嵌入文本时使用的块大小。

  • index_name (str | None) – 可选的aerospike索引名称,用于等待索引完成。如果未提供,将使用默认的index_name。

  • wait_for_index (bool) – 如果为True,则在返回前等待所有文本被索引。需要提供index_name。默认为True。

  • kwargs (Any) – 传递给客户端upsert调用的额外关键字参数。

Returns:

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

Return type:

列表[str]

async adelete(ids: list[str] | None = None, **kwargs: Any) bool | None#

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

Parameters:
  • ids (list[str] | None) – 要删除的id列表。如果为None,则删除所有。默认值为None。

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

Returns:

如果删除成功则为真, 否则为假,如果未实现则为无。

Return type:

可选[布尔]

async classmethod afrom_documents(documents: list[Document], embedding: Embeddings, **kwargs: Any) VST#

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

Parameters:
  • documents (list[Document]) – 要添加到向量存储中的文档列表。

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

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

Returns:

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

Return type:

VectorStore

async classmethod afrom_texts(texts: list[str], embedding: Embeddings, metadatas: list[dict] | None = None, *, ids: list[str] | None = None, **kwargs: Any) VST#

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

Parameters:
  • texts (list[str]) – 要添加到向量存储中的文本。

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

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

  • ids (list[str] | None) – 可选的与文本关联的ID列表。

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

Returns:

VectorStore 从文本和嵌入初始化。

Return type:

VectorStore

async aget_by_ids(ids: Sequence[str], /) list[Document]#

通过ID异步获取文档。

返回的文档预计将具有ID字段,该字段设置为向量存储中文档的ID。

如果某些ID未找到或存在重复的ID,返回的文档数量可能少于请求的数量。

用户不应假设返回文档的顺序与输入ID的顺序相匹配。相反,用户应依赖返回文档的ID字段。

如果没有找到某些ID的文档,此方法不应引发异常。

Parameters:

ids (Sequence[str]) – 要检索的ID列表。

Returns:

文档列表。

Return type:

列表[Document]

在版本0.2.11中添加。

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

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

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

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

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

  • lambda_mult (float) – 介于0和1之间的数字,决定了结果之间的多样性程度,0对应最大多样性,1对应最小多样性。默认值为0.5。

  • kwargs (Any)

Returns:

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

Return type:

列表[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) – 返回的文档数量。默认为4。

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

  • lambda_mult (float) – 介于0和1之间的数字,决定了结果之间的多样性程度,0对应最大多样性,1对应最小多样性。默认值为0.5。

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

Returns:

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

Return type:

列表[Document]

as_retriever(**kwargs: Any) VectorStoreRetriever#

返回从此VectorStore初始化的VectorStoreRetriever。

Parameters:

**kwargs (Any) –

传递给搜索函数的关键字参数。 可以包括: search_type (Optional[str]): 定义检索器应执行的搜索类型。 可以是“similarity”(默认)、“mmr”或“similarity_score_threshold”。

检索器应执行的搜索类型。 可以是“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: 按文档元数据过滤

Returns:

VectorStore的检索器类。

Return type:

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

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

Parameters:
  • query (str) – 输入文本。

  • search_type (str) – 要执行的搜索类型。可以是“similarity”、“mmr”或“similarity_score_threshold”。

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

Returns:

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

Raises:

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

Return type:

列表[Document]

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

Parameters:
  • query (str) – 输入文本。

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

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

Returns:

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

Return type:

列表[Document]

async asimilarity_search_by_vector(embedding: list[float], k: int = 4, **kwargs: Any) list[Document]#

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

Parameters:
  • embedding (list[float]) – 用于查找相似文档的嵌入。

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

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

Returns:

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

Return type:

列表[Document]

async asimilarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) list[tuple[Document, float]]#

异步返回文档和相关度分数,范围在[0, 1]之间。

0 表示不相似,1 表示最相似。

Parameters:
  • query (str) – 输入文本。

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

  • **kwargs (Any) –

    传递给相似性搜索的kwargs。应包括: score_threshold: 可选,一个介于0到1之间的浮点值

    过滤检索到的文档集

Returns:

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

Return type:

列表[元组[Document, 浮点数]]

async asimilarity_search_with_score(*args: Any, **kwargs: Any) list[tuple[Document, float]]#

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

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

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

Returns:

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

Return type:

列表[元组[Document, 浮点数]]

static convert_distance_strategy(distance_strategy: VectorDistanceMetric | DistanceStrategy) DistanceStrategy[source]#

将Aerospikes的距离策略转换为langchains的DistanceStrategy枚举。这是一个方便的方法,允许用户传入用于创建索引的相同距离度量。

Parameters:

distance_strategy (联合[VectorDistanceMetric, DistanceStrategy])

Return type:

DistanceStrategy

delete(ids: List[str] | None = None, set_name: str | None = None, **kwargs: Any) bool | None[来源]#

根据向量ID或其他条件删除。

Parameters:
  • ids (List[str] | None) – 要删除的ID列表。

  • **kwargs (Any) – 传递给客户端删除调用的其他关键字参数。

  • set_name (str | None)

  • **kwargs

Returns:

如果删除成功则为真, 否则为假,如果未实现则为无。

Return type:

可选[布尔]

classmethod from_documents(documents: list[Document], embedding: Embeddings, **kwargs: Any) VST#

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

Parameters:
  • documents (list[Document]) – 要添加到向量存储中的文档列表。

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

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

Returns:

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

Return type:

VectorStore

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: List[dict] | None = None, client: Client = None, namespace: str = 'test', index_name: str | None = None, ids: List[str] | None = None, embeddings_chunk_size: int = 1000, client_kwargs: dict | None = None, **kwargs: Any) Aerospike[source]#
This is a user friendly interface that:
  1. 嵌入文本。

  2. 将文本转换为文档。

  3. 将文档添加到提供的Aerospike索引中

这是快速入门的一种方式。

示例

from langchain_community.vectorstores import Aerospike
from langchain_openai import OpenAIEmbeddings
from aerospike_vector_search import Client, HostPort

client = Client(seeds=HostPort(host="localhost", port=5000))
aerospike = Aerospike.from_texts(
    ["foo", "bar", "baz"],
    embedder,
    client,
    "namespace",
    index_name="index",
    vector_key="vector",
    distance_strategy=MODEL_DISTANCE_CALC,
)
Parameters:
  • 文本 (列表[字符串])

  • embedding (Embeddings)

  • metadatas (可选[列表[字典]])

  • client (Client)

  • 命名空间 (字符串)

  • index_name (可选[str])

  • ids (可选[列表[字符串]])

  • embeddings_chunk_size (int)

  • client_kwargs (可选[字典])

  • kwargs (Any)

Return type:

Aerospike

get_by_ids(ids: Sequence[str], /) list[Document]#

通过ID获取文档。

返回的文档预计将具有ID字段,该字段设置为向量存储中文档的ID。

如果某些ID未找到或存在重复的ID,返回的文档数量可能少于请求的数量。

用户不应假设返回文档的顺序与输入ID的顺序相匹配。相反,用户应依赖返回文档的ID字段。

如果没有找到某些ID的文档,此方法不应引发异常。

Parameters:

ids (Sequence[str]) – 要检索的ID列表。

Returns:

文档列表。

Return type:

列表[Document]

在版本0.2.11中添加。

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

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

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

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

  • fetch_k (int) – 要获取并传递给MMR算法的文档数量。

  • lambda_mult (float) – 介于0和1之间的数字,决定了结果之间的多样性程度,0对应最大多样性,1对应最小多样性。默认值为0.5。

  • index_name (str | None) – 要搜索的索引名称。

  • metadata_keys (列表[字符串] | )

  • kwargs (Any)

Returns:

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

Return type:

列表[文档]

max_marginal_relevance_search_by_vector(embedding: List[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, metadata_keys: List[str] | None = None, index_name: str | None = None, **kwargs: Any) List[Document][source]#

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

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

Parameters:
  • embedding (List[float]) – 用于查找相似文档的嵌入。

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

  • fetch_k (int) – 要获取并传递给MMR算法的文档数量。

  • lambda_mult (float) – 介于0和1之间的数字,决定了结果之间的多样性程度,0对应最大多样性,1对应最小多样性。默认值为0.5。

  • metadata_keys (List[str] | None) – 返回文档时要包含的元数据键列表。 如果为None,则返回所有元数据键。默认为None。

  • index_name (str | None) – 可选的索引名称,用于搜索。覆盖默认的index_name。

  • kwargs (Any)

Returns:

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

Return type:

列表[文档]

search(query: str, search_type: str, **kwargs: Any) list[Document]#

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

Parameters:
  • query (str) – 输入文本

  • search_type (str) – 要执行的搜索类型。可以是“similarity”、“mmr”或“similarity_score_threshold”。

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

Returns:

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

Raises:

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

Return type:

列表[Document]

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

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

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

  • metadata_keys (List[str] | None) – 返回文档时要包含的元数据键列表。 如果为None,则返回所有元数据键。默认为None。

  • index_name (str | None) – 可选的索引名称用于搜索。覆盖默认的index_name。

  • kwargs (Any)

Returns:

与查询最相似的文档列表及每个文档的得分

Return type:

列表[文档]

similarity_search_by_vector(embedding: List[float], k: int = 4, metadata_keys: List[str] | None = None, index_name: str | None = None, **kwargs: Any) List[Document][source]#

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

Parameters:
  • embedding (List[float]) – 用于查找相似文档的嵌入。

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

  • metadata_keys (List[str] | None) – 返回文档时要包含的元数据键列表。 如果为None,则返回所有元数据键。默认为None。

  • index_name (str | None) – 要搜索的索引名称。覆盖默认的 index_name。

  • kwargs (Any) – 传递给搜索方法的额外关键字参数。

Returns:

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

Return type:

列表[文档]

similarity_search_by_vector_with_score(embedding: List[float], k: int = 4, metadata_keys: List[str] | None = None, index_name: str | None = None, **kwargs: Any) List[Tuple[Document, float]][source]#

返回与嵌入最相似的aerospike文档,以及分数。

Parameters:
  • embedding (List[float]) – 用于查找相似文档的嵌入。

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

  • metadata_keys (List[str] | None) – 返回文档时要包含的元数据键列表。 如果为None,则返回所有元数据键。默认为None。

  • index_name (str | None) – 要搜索的索引名称。覆盖默认的 index_name。

  • kwargs (Any) – 传递给客户端向量搜索方法的额外关键字参数。

Returns:

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

Return type:

列表[元组[文档, 浮点数]]

similarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) list[tuple[Document, float]]#

返回文档和相关度分数,范围在[0, 1]之间。

0 表示不相似,1 表示最相似。

Parameters:
  • query (str) – 输入文本。

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

  • **kwargs (Any) –

    传递给相似性搜索的kwargs。应包括: score_threshold: 可选,一个介于0到1之间的浮点值

    用于过滤检索到的文档集。

Returns:

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

Return type:

列表[元组[Document, 浮点数]]

similarity_search_with_score(query: str, k: int = 4, metadata_keys: List[str] | None = None, index_name: str | None = None, **kwargs: Any) List[Tuple[Document, float]][source]#

返回与查询最相似的aerospike文档,以及分数。

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

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

  • metadata_keys (List[str] | None) – 返回文档时要包含的元数据键列表。 如果为None,则返回所有元数据键。默认为None。

  • index_name (str | None) – 要搜索的索引名称。覆盖默认的 index_name。

  • kwargs (Any) – 传递给搜索方法的额外关键字参数。

Returns:

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

Return type:

列表[元组[文档, 浮点数]]

使用Aerospike的示例