`langchain_community.vectorstores.aerospike`.Aerospike¶

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

`Aerospike`向量存储。

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

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

参数:

client: Aerospike客户端。 embedding: 用于嵌入文本的Embeddings对象或可调用对象（已弃用）。 namespace: 用于存储向量的命名空间。这应该与 index_name: 在Aerospike中先前创建的索引的名称。这 vector_key: 用于元数据中向量的键。这应该与

在索引创建期间使用的键相匹配。

text_key: 用于元数据中文本的键。 id_key: 用于元数据中id的键。 set_name: 用于存储向量的默认集合名称。 distance_strategy: 用于相似性搜索的距离策略

这应该与在索引创建期间使用的距离策略相匹配。

Attributes

embeddings

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

Methods

`__init__`(client, embedding, namespace[, ...])	使用Aerospike客户端进行初始化。
`aadd_documents`(documents, **kwargs)	运行更多的文档通过嵌入并添加到向量存储中。
`aadd_texts`(texts[, metadatas])	运行更多的文本通过嵌入，并添加到向量存储中。
`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])	返回从文本和嵌入初始化的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)	使用异步方式运行相似性搜索与距离。
`convert_distance_strategy`(distance_strategy)	将Aerospikes的距离策略转换为langchains的DistanceStrategy枚举。这是一个方便的方法，允许用户传入用于创建索引的相同距离度量。
`delete`([ids, set_name])	根据向量ID或其他条件删除。
`from_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的VectorStore。
`from_texts`(texts, embedding[, metadatas, ...])	这是一个用户友好的界面，可以实现以下功能：
`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文档，以及分数。

Parameters

client (Client) –
embedding (Union[Embeddings, Callable]) –
namespace (str) –
index_name (Optional[str]) –
vector_key (str) –
text_key (str) –
id_key (str) –
set_name (Optional[str]) –
distance_strategy (Optional[Union[DistanceStrategy, VectorDistanceMetric]]) –

__init__(client: Client, embedding: Union[Embeddings, Callable], namespace: str, index_name: Optional[str] = None, vector_key: str = '_vector', text_key: str = '_text', id_key: str = '_id', set_name: Optional[str] = None, distance_strategy: Optional[Union[DistanceStrategy, VectorDistanceMetric]] = DistanceStrategy.EUCLIDEAN_DISTANCE)[source]¶

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

参数:

在索引创建期间使用的键相匹配。

text_key: 用于元数据中文本的键。 id_key: 用于元数据中id的键。 set_name: 用于存储向量的默认集合名称。 distance_strategy: 用于相似性搜索的距离策略

这应该与在索引创建期间使用的距离策略相匹配。

Parameters

client (Client) –
embedding (Union[Embeddings, Callable]) –
namespace (str) –
index_name (Optional[str]) –
vector_key (str) –
text_key (str) –
id_key (str) –
set_name (Optional[str]) –
distance_strategy (Optional[Union[DistanceStrategy, VectorDistanceMetric]]) –

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, ids: Optional[List[str]] = None, set_name: Optional[str] = None, embedding_chunk_size: int = 1000, index_name: Optional[str] = None, wait_for_index: bool = True, **kwargs: Any) → List[str][source]¶

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

参数：: texts：要添加到向量存储的字符串的可迭代对象。 metadatas：与文本相关联的元数据的可选列表。 ids：要与文本关联的可选id列表。 set_name：要将文本添加到的可选aerospike集名称。 batch_size：将文本添加到向量存储时要使用的批处理大小。 embedding_chunk_size：嵌入文本时要使用的块大小。 index_name：用于等待索引完成的可选aerospike索引名称。如果未提供，将使用默认的index_name。 wait_for_index：如果为True，则在返回之前等待所有文本被索引。需要提供index_name。默认为True。 **kwargs：要传递给客户端upsert调用的其他关键字参数。
返回：: 将文本添加到向量存储中的id列表。

Parameters

texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
ids (Optional[List[str]]) –
set_name (Optional[str]) –
embedding_chunk_size (int) –
index_name (Optional[str]) –
wait_for_index (bool) –
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_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

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

static convert_distance_strategy(distance_strategy: Union[VectorDistanceMetric, DistanceStrategy]) → DistanceStrategy[source]¶

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

Parameters: distance_strategy (Union[VectorDistanceMetric, DistanceStrategy]) –
Return type: DistanceStrategy

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

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

参数：: ids：要删除的ID列表。 **kwargs：传递给客户端删除调用的其他关键字参数。
返回：: Optional[bool]：如果删除成功则为True，否则为False，如果未实现则为None。

Parameters

ids (Optional[List[str]]) –
set_name (Optional[str]) –
kwargs (Any) –

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_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, client: Client = None, namespace: str = 'test', index_name: Optional[str] = None, ids: Optional[List[str]] = None, embeddings_chunk_size: int = 1000, client_kwargs: Optional[dict] = None, **kwargs: Any) → Aerospike[source]¶

这是一个用户友好的界面，可以实现以下功能：

嵌入文本。
将文本转换为文档。
将文档添加到提供的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

texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
client (Client) –
namespace (str) –
index_name (Optional[str]) –
ids (Optional[List[str]]) –
embeddings_chunk_size (int) –
client_kwargs (Optional[dict]) –
kwargs (Any) –

Return type

Aerospike

max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, metadata_keys: Optional[List[str]] = None, index_name: Optional[str] = None, **kwargs: Any) → List[Document][source]¶

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

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

参数：

query：要查找相似文档的文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取的文档数量以传递给MMR算法。 lambda_mult：0到1之间的数字，确定结果之间多样性的程度，

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

index_name：要搜索的索引名称。

返回：

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

Parameters

query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
metadata_keys (Optional[List[str]]) –
index_name (Optional[str]) –
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, metadata_keys: Optional[List[str]] = None, index_name: Optional[str] = None, **kwargs: Any) → List[Document][source]¶

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

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

参数：: embedding: 查找与之相似的文档的嵌入。 k: 要返回的文档数量。默认为4。 fetch_k: 要获取以传递给MMR算法的文档数量。 lambda_mult: 介于0和1之间的数字，确定结果之间多样性的程度，其中0对应最大多样性，1对应最小多样性。默认为0.5。 metadata_keys: 要与文档一起返回的元数据键列表。如果为None，则将返回所有元数据键。默认为None。 index_name: 要搜索的索引的可选名称。覆盖默认的index_name。
返回：: 通过最大边际相关性选择的文档列表。

Parameters

embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
metadata_keys (Optional[List[str]]) –
index_name (Optional[str]) –
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, metadata_keys: Optional[List[str]] = None, index_name: Optional[str] = None, **kwargs: Any) → List[Document][source]¶

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

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 metadata_keys：要与文档一起返回的元数据键列表。

如果为None，则将返回所有元数据键。默认为None。

index_name：要搜索的索引的可选名称。覆盖默认的index_name。

返回：

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

Parameters

query (str) –
k (int) –
metadata_keys (Optional[List[str]]) –
index_name (Optional[str]) –
kwargs (Any) –

Return type

List[Document]

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

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

参数：

embedding: 要查找与之相似文档的嵌入。 k: 要返回的文档数量。默认为4。 metadata_keys: 要与文档一起返回的元数据键列表。

如果为None，则将返回所有元数据键。默认为None。

index_name: 要搜索的索引名称。覆盖默认的: index_name。

kwargs: 传递给搜索方法的其他关键字参数。

返回：

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

Parameters

embedding (List[float]) –
k (int) –
metadata_keys (Optional[List[str]]) –
index_name (Optional[str]) –
kwargs (Any) –

Return type

List[Document]

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

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

参数：

embedding：要查找类似文档的嵌入。 k：要返回的文档数量。默认为4。 metadata_keys：要与文档一起返回的元数据键列表。

如果为None，则将返回所有元数据键。默认为None。

index_name：要搜索的索引名称。覆盖默认的: index_name。
kwargs：传递给客户端的其他关键字参数: vector_search方法。

返回：

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

Parameters

embedding (List[float]) –
k (int) –
metadata_keys (Optional[List[str]]) –
index_name (Optional[str]) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

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, metadata_keys: Optional[List[str]] = None, index_name: Optional[str] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

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

参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 metadata_keys：要与文档一起返回的元数据键列表。

如果为None，则将返回所有元数据键。默认为None。

index_name：要搜索的索引名称。覆盖默认的index_name。 kwargs：传递给搜索方法的其他关键字参数。

返回：

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

Parameters

query (str) –
k (int) –
metadata_keys (Optional[List[str]]) –
index_name (Optional[str]) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

langchain_community.vectorstores.aerospike.Aerospike¶

`langchain_community.vectorstores.aerospike`.Aerospike¶