`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 (Client) – Aerospike 客户端。
embedding (Union[Embeddings, Callable]) – 嵌入对象或可调用对象（已弃用）以嵌入文本。
namespace (str) – 用于存储向量的命名空间。这应该匹配
index_name (Optional[str]) – 先前在 Aerospike 中创建的索引名称。此
vector_key (str) – 用于元数据中向量的键。这应该与索引创建期间使用的键匹配。
text_key (str) – 用于元数据中文本的键。
id_key (str) – 用于元数据中 ID 的键。
set_name (Optional[str]) – 用于存储向量的默认集合名称。
distance_strategy (Optional[Union[DistanceStrategy, VectorDistanceMetric]]) – 用于相似性搜索的距离策略。这应该与索引创建期间使用的距离策略匹配。

属性

embeddings

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

方法

`__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。
`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)
`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 文档，以及分数。
`streaming_upsert`(items, /, batch_size, **kwargs)
`upsert`(items, /, **kwargs)

__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 客户端初始化。

参数

client (Client) – Aerospike 客户端。
embedding (Union[Embeddings, Callable]) – 嵌入对象或可调用对象（已弃用）以嵌入文本。
namespace (str) – 用于存储向量的命名空间。这应该匹配
index_name (Optional[str]) – 先前在 Aerospike 中创建的索引名称。此
vector_key (str) – 用于元数据中向量的键。这应该与索引创建期间使用的键匹配。
text_key (str) – 用于元数据中文本的键。
id_key (str) – 用于元数据中 ID 的键。
set_name (Optional[str]) – 用于存储向量的默认集合名称。
distance_strategy (Optional[Union[DistanceStrategy, VectorDistanceMetric]]) – 用于相似性搜索的距离策略。这应该与索引创建期间使用的距离策略匹配。

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

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

参数

documents (List[Document]) – 要添加到向量存储的文档。
kwargs (Any) – 附加关键字参数。

返回

添加文本的 ID 列表。

引发

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

引发

ValueError – 如果元数据数量与文本数量不匹配。
ValueError – 如果 ID 数量与文本数量不匹配。

返回类型

List[str]

add_documents(documents: List[Document], **kwargs: Any) → List[str]¶

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

参数

documents (List[Document]) – 要添加到向量存储的文档。
kwargs (Any) – 附加关键字参数。如果 kwargs 包含 ids 并且文档包含 ids，则 kwargs 中的 ids 将优先。

返回

添加文本的 ID 列表。

引发

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

返回类型

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 (Iterable[str]) – 要添加到向量存储的字符串迭代器。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。
ids (Optional[List[str]]) – 与文本关联的可选 ID 列表。
set_name (Optional[str]) – 用于添加文本的可选 aerospike 集合名称。
batch_size – 将文本添加到向量存储时使用的批处理大小。
embedding_chunk_size (int) – 嵌入文本时使用的块大小。
index_name (Optional[str]) – 用于等待索引完成的可选 aerospike 索引名称。如果未提供，将使用默认的 index_name。
wait_for_index (bool) – 如果为 True，则在返回之前等待所有文本被索引。需要提供 index_name。默认为 True。
kwargs (Any) – 要传递给客户端 upsert 调用的其他关键字参数。

返回

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

返回类型

List[str]

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[str], 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 版本新增。

async amax_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → List[Document]¶

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

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

参数

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”。

the Retriever should perform. Can be “similarity” (default), “mmr”, or “similarity_score_threshold”.

search_kwargs (Optional[Dict]): 传递给搜索函数的关键字参数。

search function. Can include things like

k: 要返回的文档数量 (默认: 4) score_threshold: similarity_score_threshold 的最小相关性阈值

for similarity_score_threshold

fetch_k: 要传递给 MMR 算法的文档数量: (Default: 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) – 传递给搜索方法的参数。

返回

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

引发

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

返回类型

List[Document]

async asimilarity_search(query: str, k: int = 4, **kwargs: Any) → 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 之间的浮点值，用于

filter the resulting set of retrieved docs

返回

过滤检索到的文档结果集

返回类型

文档和相似性得分的元组列表

async asimilarity_search_with_score(*args: Any, **kwargs: Any) → List[Tuple[Document, float]]¶

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

参数

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

返回

文档和相似性得分的元组列表。

返回类型

文档和相似性得分的元组列表

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 不应包含 ID 以避免语义模糊。相反，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 版本新增。

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

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

参数: distance_strategy (Union[VectorDistanceMetric, DistanceStrategy]) –
返回类型: DistanceStrategy

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

按向量 ID 或其他条件删除。

参数

ids (Optional[List[str]]) – 要删除的 ID 列表。
**kwargs (Any) – 传递给客户端删除调用的其他关键字参数。
set_name (Optional[str]) –
**kwargs –

返回

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

返回类型

Optional[bool]

classmethod from_documents(documents: List[Document], embedding: Embeddings, **kwargs: Any) → VST¶

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

参数

documents (List[Document]) – 要添加到向量存储的文档列表。
embedding (Embeddings) – 要使用的嵌入函数。
kwargs (Any) – 附加关键字参数。

返回

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

返回类型

VectorStore

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

参数

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

返回类型

Aerospike

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 版本新增。

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 (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 用于 MMR 算法的文档数量。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，0 表示最大多样性，1 表示最小多样性。默认为 0.5。
index_name (Optional[str]) – 要搜索的索引名称。
metadata_keys (Optional[List[str]]) –
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, metadata_keys: Optional[List[str]] = None, index_name: Optional[str] = None, **kwargs: Any) → List[Document][source]¶

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

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

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
fetch_k (int) – 用于 MMR 算法的文档数量。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，0 表示最大多样性，1 表示最小多样性。默认为 0.5。
metadata_keys (Optional[List[str]]) – 要随文档返回的元数据键列表。如果为 None，则返回所有元数据键。默认为 None。
index_name (Optional[str]) – 可选的要搜索的索引名称。覆盖默认的 index_name。
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) – 传递给搜索方法的参数。

返回

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

引发

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

返回类型

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 (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
metadata_keys (Optional[List[str]]) – 要随文档返回的元数据键列表。如果为 None，则返回所有元数据键。默认为 None。
index_name (Optional[str]) – 可选的要搜索的索引名称。覆盖默认的 index_name。
kwargs (Any) –

返回

与查询最相似的文档列表

返回类型

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 (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
metadata_keys (Optional[List[str]]) – 要随文档返回的元数据键列表。如果为 None，则返回所有元数据键。默认为 None。
index_name (Optional[str]) – 要搜索的索引名称。覆盖默认的 index_name。
kwargs (Any) – 传递给 search 方法的附加关键字参数。

返回

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

返回类型

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 (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 要返回的文档数量。默认为 4。
metadata_keys (Optional[List[str]]) – 要随文档返回的元数据键列表。如果为 None，则返回所有元数据键。默认为 None。
index_name (Optional[str]) – 要搜索的索引名称。覆盖默认的 index_name。
kwargs (Any) – 传递给客户端 vector_search 方法的附加关键字参数。

返回

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

返回类型

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 (str) – 输入文本。
k (int) – 要返回的文档数量。默认为 4。
**kwargs (Any) –
传递给相似性搜索的 kwargs。应包括： score_threshold: 可选，介于 0 到 1 之间的浮点值，用于

过滤检索到的文档结果集。

返回

文档和相似性得分的元组列表。

返回类型

文档和相似性得分的元组列表

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 (str) – 用于查找相似文档的文本。
k (int) – 要返回的文档数量。默认为 4。
metadata_keys (Optional[List[str]]) – 要随文档返回的元数据键列表。如果为 None，则返回所有元数据键。默认为 None。
index_name (Optional[str]) – 要搜索的索引名称。覆盖默认的 index_name。
kwargs (Any) – 传递给 search 方法的附加关键字参数。

返回

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

返回类型

List[Tuple[Document, float]]

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

Beta

在 0.2.11 中添加。API 可能会更改。

以流式方式更新文档。

参数

items (Iterable[Document]) – 要添加到向量存储的文档的可迭代对象。
batch_size (int) – 每次 upsert 的批处理大小。
kwargs (Any) – 附加关键字参数。kwargs 应仅包含所有文档通用的参数。（例如，索引超时、重试策略等）kwargs 不应包含 ID 以避免语义模糊。相反，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 版本新增。

Aerospike 使用示例¶

Aerospike

langchain_community.vectorstores.aerospike.Aerospike¶

Aerospike 使用示例¶

`langchain_community.vectorstores.aerospike`.Aerospike¶