UpstashVectorStore#

class langchain_community.vectorstores.upstash.UpstashVectorStore(text_key: str = 'text', index: Index | None = None, async_index: AsyncIndex | None = None, index_url: str | None = None, index_token: str | None = None, embedding: Embeddings | bool | None = None, *, namespace: str = '')[source]#

Upstash Vector 向量存储

要使用，必须安装 upstash-vector python 包。

还需要一个Upstash Vector索引。首先创建一个新的Upstash Vector索引，并复制index_url和index_token变量。然后通过构造函数传递它们，或者设置环境变量UPSTASH_VECTOR_REST_URL和UPSTASH_VECTOR_REST_TOKEN。

示例

from langchain_openai import OpenAIEmbeddings
from langchain_community.vectorstores import UpstashVectorStore

embeddings = OpenAIEmbeddings(model="text-embedding-3-large")
vectorstore = UpstashVectorStore(
    embedding=embeddings,
    index_url="...",
    index_token="..."
)

# or

import os

os.environ["UPSTASH_VECTOR_REST_URL"] = "..."
os.environ["UPSTASH_VECTOR_REST_TOKEN"] = "..."

vectorstore = UpstashVectorStore(
    embedding=embeddings
)

UpstashVectorStore 的构造函数。

如果未提供index或index_url和index_token，构造函数将尝试使用环境变量UPSTASH_VECTOR_REST_URL`和`UPSTASH_VECTOR_REST_TOKEN创建索引。

Parameters:

text_key (str) – 用于在元数据中存储文本的键。
index (可选[Index]) – UpstashVector 索引对象。
async_index (可选[AsyncIndex]) – UpstashVector 异步索引对象，仅在异步时提供
需要的 (函数是)
index_url (可选[str]) – UpstashVector 索引的 URL。
index_token (可选[str]) – UpstashVector 索引的令牌。
embedding (可选[联合[Embeddings, 布尔]]) – 嵌入对象或布尔值。当为false时，不应用嵌入。如果为true，则使用Upstash嵌入。当使用Upstash嵌入时，文本直接发送到Upstash并在那里应用嵌入，而不是在Langchain中嵌入。
namespace (str) – 从索引中使用的命名空间。

示例

from langchain_community.vectorstores.upstash import UpstashVectorStore
from langchain_community.embeddings.openai import OpenAIEmbeddings

embeddings = OpenAIEmbeddings()
vectorstore = UpstashVectorStore(
    embedding=embeddings,
    index_url="...",
    index_token="...",
    namespace="..."
)

# With an existing index
from upstash_vector import Index

index = Index(url="...", token="...")
vectorstore = UpstashVectorStore(
    embedding=embeddings,
    index=index,
    namespace="..."
)

属性

embeddings

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

方法

`__init__`([text_key, index, async_index, ...])	UpstashVectorStore 的构造函数。
`aadd_documents`(documents[, ids, batch_size, ...])	获取文档的嵌入并将其添加到向量存储中。
`aadd_texts`(texts[, metadatas, ids, ...])	获取文本的嵌入并将其添加到向量存储中。
`add_documents`(documents[, ids, batch_size, ...])	获取文档的嵌入并将其添加到向量存储中。
`add_texts`(texts[, metadatas, ids, ...])	获取文本的嵌入并将其添加到向量存储中。
`adelete`([ids, delete_all, batch_size, namespace])	通过向量ID删除
`afrom_documents`(documents, embedding, **kwargs)	异步返回从文档和嵌入初始化的VectorStore。
`afrom_texts`(texts, embedding[, metadatas, ...])	从文本列表创建一个新的UpstashVectorStore。
`aget_by_ids`(ids, /)	异步通过ID获取文档。
`ainfo`()	获取有关索引的统计信息。
`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, filter, namespace])	返回与查询最相似的文档。
`asimilarity_search_by_vector`(embedding[, k, ...])	返回与给定嵌入最接近的文档。
`asimilarity_search_by_vector_with_score`(...)	返回其嵌入最接近给定嵌入的文本
`asimilarity_search_with_relevance_scores`(query)	异步返回文档和相关分数，范围在[0, 1]之间。
`asimilarity_search_with_score`(query[, k, ...])	检索与查询最相似的文本并将结果转换为Document对象。
`delete`([ids, delete_all, batch_size, namespace])	通过向量ID删除
`from_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的VectorStore。
`from_texts`(texts, embedding[, metadatas, ...])	从文本列表创建一个新的UpstashVectorStore。
`get_by_ids`(ids, /)	通过ID获取文档。
`info`()	获取有关索引的统计信息。
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`search`(query, search_type, **kwargs)	使用指定的搜索类型返回与查询最相似的文档。
`similarity_search`(query[, k, filter, namespace])	返回与查询最相似的文档。
`similarity_search_by_vector`(embedding[, k, ...])	返回与给定嵌入最接近的文档。
`similarity_search_by_vector_with_score`(embedding)	返回嵌入最接近给定嵌入的文本
`similarity_search_with_relevance_scores`(query)	返回文档和相关度分数，分数范围在[0, 1]之间。
`similarity_search_with_score`(query[, k, ...])	检索与查询最相似的文本并将结果转换为Document对象。

UpstashVectorStore 的构造函数。

如果未提供index或index_url和index_token，构造函数将尝试使用环境变量UPSTASH_VECTOR_REST_URL`和`UPSTASH_VECTOR_REST_TOKEN创建索引。

Parameters:

text_key (str) – 用于在元数据中存储文本的键。
index (可选[Index]) – UpstashVector 索引对象。
async_index (可选[AsyncIndex]) – UpstashVector 异步索引对象，仅在异步时提供
需要的 (函数是)
index_url (可选[str]) – UpstashVector 索引的 URL。
index_token (可选[str]) – UpstashVector 索引的令牌。
embedding (可选[联合[Embeddings, 布尔]]) – 嵌入对象或布尔值。当为false时，不应用嵌入。如果为true，则使用Upstash嵌入。当使用Upstash嵌入时，文本直接发送到Upstash并在那里应用嵌入，而不是在Langchain中嵌入。
namespace (str) – 从索引中使用的命名空间。

示例

from langchain_community.vectorstores.upstash import UpstashVectorStore
from langchain_community.embeddings.openai import OpenAIEmbeddings

embeddings = OpenAIEmbeddings()
vectorstore = UpstashVectorStore(
    embedding=embeddings,
    index_url="...",
    index_token="...",
    namespace="..."
)

# With an existing index
from upstash_vector import Index

index = Index(url="...", token="...")
vectorstore = UpstashVectorStore(
    embedding=embeddings,
    index=index,
    namespace="..."
)

async aadd_documents(documents: Iterable[Document], ids: List[str] | None = None, batch_size: int = 32, embedding_chunk_size: int = 1000, *, namespace: str | None = None, **kwargs: Any) → List[str][source]#

获取文档的嵌入并将它们添加到向量存储中。

文档以embedding_chunk_size的大小分批发送到嵌入对象。然后，嵌入以batch_size的大小分批插入到向量存储中。

Parameters:

documents (Iterable[Document]) – 要添加到向量存储中的文档的可迭代对象。
batch_size (int) – 当插入嵌入时使用的批量大小。
request. (Upstash 最多支持每个请求 1000 个向量)
embedding_batch_size – 嵌入文本时使用的块大小。
namespace (str | None) – 从索引中使用的命名空间。
ids (列表[字符串] | 无)
embedding_chunk_size (int)
kwargs (Any)

Returns:

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

Return type:

列表[str]

async aadd_texts(texts: Iterable[str], metadatas: List[dict] | None = None, ids: List[str] | None = None, batch_size: int = 32, embedding_chunk_size: int = 1000, *, namespace: str | None = None, **kwargs: Any) → List[str][source]#

获取文本的嵌入并将它们添加到向量存储中。

文本以embedding_chunk_size的大小分批发送到嵌入对象。然后，嵌入以batch_size的大小分批插入到向量存储中。

Parameters:

texts (Iterable[str]) – 要添加到向量存储中的字符串的可迭代对象。
metadatas (List[dict] | None) – 可选的与文本关联的元数据列表。
ids (List[str] | None) – 可选的id列表，用于与文本关联。
batch_size (int) – 当插入嵌入时使用的批量大小。
request. (Upstash 最多支持每个请求 1000 个向量)
embedding_batch_size – 嵌入文本时使用的块大小。
namespace (str | None) – 从索引中使用的命名空间。
embedding_chunk_size (int)
kwargs (Any)

Returns:

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

Return type:

列表[str]

add_documents(documents: List[Document], ids: List[str] | None = None, batch_size: int = 32, embedding_chunk_size: int = 1000, *, namespace: str | None = None, **kwargs: Any) → List[str][source]#

获取文档的嵌入并将它们添加到向量存储中。

文档以embedding_chunk_size的大小分批发送到嵌入对象。然后，嵌入以batch_size的大小分批插入到向量存储中。

Parameters:

documents (List[Document]) – 要添加到向量存储中的文档的可迭代对象。
batch_size (int) – 当插入嵌入时使用的批量大小。
request. (Upstash 最多支持每个请求 1000 个向量)
embedding_batch_size – 嵌入文本时使用的块大小。
namespace (str | None) – 从索引中使用的命名空间。
ids (列表[字符串] | 无)
embedding_chunk_size (int)
kwargs (Any)

Returns:

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

Return type:

列表[str]

add_texts(texts: Iterable[str], metadatas: List[dict] | None = None, ids: List[str] | None = None, batch_size: int = 32, embedding_chunk_size: int = 1000, *, namespace: str | None = None, **kwargs: Any) → List[str][source]#

获取文本的嵌入并将它们添加到向量存储中。

文本以embedding_chunk_size的大小分批发送到嵌入对象。然后，嵌入以batch_size的大小分批插入到向量存储中。

Parameters:

texts (Iterable[str]) – 要添加到向量存储中的字符串的可迭代对象。
metadatas (List[dict] | None) – 可选的与文本关联的元数据列表。
ids (List[str] | None) – 可选的id列表，用于与文本关联。
batch_size (int) – 当插入嵌入时使用的批量大小。
request. (Upstash 最多支持每个请求 1000 个向量)
embedding_batch_size – 嵌入文本时使用的块大小。
namespace (str | None) – 从索引中使用的命名空间。
embedding_chunk_size (int)
kwargs (Any)

Returns:

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

Return type:

列表[str]

async adelete(ids: List[str] | None = None, delete_all: bool | None = None, batch_size: int | None = 1000, *, namespace: str | None = None, **kwargs: Any) → None[source]#

按向量ID删除

Parameters:

ids (List[str] | None) – 要删除的ID列表。
delete_all (bool | None) – 删除索引中的所有向量。
batch_size (int | None) – 删除嵌入时使用的批量大小。
namespace (str | None) – 从索引中使用的命名空间。
request. (Upstash 最多支持每次删除 1000 条记录)
kwargs (Any)

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, embedding_chunk_size: int = 1000, batch_size: int = 32, text_key: str = 'text', index: Index | None = None, async_index: AsyncIndex | None = None, index_url: str | None = None, index_token: str | None = None, *, namespace: str = '', **kwargs: Any) → UpstashVectorStore[source]#

从文本列表创建一个新的UpstashVectorStore。

示例

Parameters:

文本 (列表[字符串])
embedding (Embeddings)
metadatas (可选[列表[字典]])
ids (可选[列表[字符串]])
embedding_chunk_size (int)
batch_size (int)
text_key (str)
index (可选[Index])
async_index (可选[AsyncIndex])
index_url (可选[str])
index_token (可选[str])
命名空间 (字符串)
kwargs (Any)

Return type:

UpstashVectorStore

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中添加。

async ainfo() → InfoResult[source]#

获取有关索引的统计信息。

Returns:

向量总数
等待索引的向量总数
索引在磁盘上的总大小（字节）
索引的维度数
为索引选择的相似度函数

Return type:

信息结果

async amax_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: str | None = None, *, namespace: str | None = None, **kwargs: Any) → List[Document][source]#

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

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

Parameters:

query (str) – 用于查找相似文档的文本。
k (int) – 返回的文档数量。默认为4。
fetch_k (int) – 要获取并传递给MMR算法的文档数量。
lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。
filter (str | None) – 可选的元数据过滤器，格式为字符串
namespace (str | None) – 从索引中使用的命名空间。
kwargs (Any)

Returns:

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

Return type:

列表[文档]

async amax_marginal_relevance_search_by_vector(embedding: List[float] | str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: str | None = None, *, namespace: str | None = None, **kwargs: Any) → List[Document][source]#

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

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

Parameters:

embedding (List[float] | str) – 用于查找相似文档的嵌入。
k (int) – 返回的文档数量。默认为4。
fetch_k (int) – 要获取并传递给MMR算法的文档数量。
lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。
filter (str | None) – 可选的元数据过滤器，格式为字符串
namespace (str | None) – 从索引中使用的命名空间。
kwargs (Any)

Returns:

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

Return type:

列表[文档]

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]

async asimilarity_search(query: str, k: int = 4, filter: str | None = None, *, namespace: str | None = None, **kwargs: Any) → List[Document][source]#

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

Parameters:

query (str) – 用于查找相似文档的文本。
k (int) – 返回的文档数量。默认为4。
filter (str | None) – 可选的元数据过滤器，格式为字符串
namespace (str | None) – 从索引中使用的命名空间。
kwargs (Any)

Returns:

与查询最相似的文档列表

Return type:

列表[文档]

async asimilarity_search_by_vector(embedding: List[float] | str, k: int = 4, filter: str | None = None, *, namespace: str | None = None, **kwargs: Any) → List[Document][来源]#

返回与给定嵌入最接近的文档。

Parameters:

embedding (List[float] | str) – 用于查找相似文档的嵌入。
k (int) – 返回的文档数量。默认为4。
filter (str | None) – 可选的元数据过滤器，格式为字符串
namespace (str | None) – 从索引中使用的命名空间。
kwargs (Any)

Returns:

与查询最相似的文档列表

Return type:

列表[文档]

async asimilarity_search_by_vector_with_score(embedding: List[float] | str, k: int = 4, filter: str | None = None, *, namespace: str | None = None, **kwargs: Any) → List[Tuple[Document, float]][source]#

返回其嵌入最接近给定嵌入的文本

Parameters:

embedding (List[float] | str)
k (整数)
filter (str | None)
命名空间 (字符串 | 无)
kwargs (Any)

Return type:

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

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(query: str, k: int = 4, filter: str | None = None, *, namespace: str | None = None, **kwargs: Any) → List[Tuple[Document, float]][来源]#

检索与查询最相似的文本并将结果转换为Document对象。

Parameters:

query (str) – 用于查找相似文档的文本。
k (int) – 返回的文档数量。默认为4。
filter (str | None) – 可选的元数据过滤器，格式为字符串
namespace (str | None) – 从索引中使用的命名空间。
kwargs (Any)

Returns:

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

Return type:

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

delete(ids: List[str] | None = None, delete_all: bool | None = None, batch_size: int | None = 1000, *, namespace: str | None = None, **kwargs: Any) → None[source]#

按向量ID删除

Parameters:

ids (List[str] | None) – 要删除的ID列表。
delete_all (bool | None) – 删除索引中的所有向量。
batch_size (int | None) – 删除嵌入时使用的批量大小。
namespace (str | None) – 从索引中使用的命名空间。
request. (Upstash 最多支持每次删除 1000 条记录)
kwargs (Any)

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, ids: List[str] | None = None, embedding_chunk_size: int = 1000, batch_size: int = 32, text_key: str = 'text', index: Index | None = None, async_index: AsyncIndex | None = None, index_url: str | None = None, index_token: str | None = None, *, namespace: str = '', **kwargs: Any) → UpstashVectorStore[来源]#

从文本列表创建一个新的UpstashVectorStore。

示例

Parameters:

文本 (列表[字符串])
embedding (Embeddings)
metadatas (可选[列表[字典]])
ids (可选[列表[字符串]])
embedding_chunk_size (int)
batch_size (int)
text_key (str)
index (可选[Index])
async_index (可选[AsyncIndex])
index_url (可选[str])
index_token (可选[str])
命名空间 (字符串)
kwargs (Any)

Return type:

UpstashVectorStore

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中添加。

info() → InfoResult[来源]#

获取有关索引的统计信息。

Returns:

向量总数
等待索引的向量总数
索引在磁盘上的总大小（字节）
索引的维度数
为索引选择的相似度函数

Return type:

信息结果

max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: str | None = None, *, namespace: str | None = None, **kwargs: Any) → List[Document][来源]#

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

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

Parameters:

query (str) – 用于查找相似文档的文本。
k (int) – 返回的文档数量。默认为4。
fetch_k (int) – 要获取并传递给MMR算法的文档数量。
lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。
filter (str | None) – 可选的元数据过滤器，格式为字符串
namespace (str | None) – 从索引中使用的命名空间。
kwargs (Any)

Returns:

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

Return type:

列表[文档]

max_marginal_relevance_search_by_vector(embedding: List[float] | str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: str | None = None, *, namespace: str | None = None, **kwargs: Any) → List[Document][来源]#

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

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

Parameters:

embedding (List[float] | str) – 用于查找相似文档的嵌入。
k (int) – 返回的文档数量。默认为4。
fetch_k (int) – 要获取并传递给MMR算法的文档数量。
lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。
filter (str | None) – 可选的元数据过滤器，格式为字符串
namespace (str | None) – 从索引中使用的命名空间。
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]

similarity_search(query: str, k: int = 4, filter: str | None = None, *, namespace: str | None = None, **kwargs: Any) → List[Document][来源]#

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

Parameters:

query (str) – 用于查找相似文档的文本。
k (int) – 返回的文档数量。默认为4。
filter (str | None) – 可选的元数据过滤器，格式为字符串
namespace (str | None) – 从索引中使用的命名空间。
kwargs (Any)

Returns:

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

Return type:

列表[文档]

similarity_search_by_vector(embedding: List[float] | str, k: int = 4, filter: str | None = None, *, namespace: str | None = None, **kwargs: Any) → List[Document][来源]#

返回与给定嵌入最接近的文档。

Parameters:

embedding (List[float] | str) – 用于查找相似文档的嵌入。
k (int) – 返回的文档数量。默认为4。
filter (str | None) – 可选的元数据过滤器，格式为字符串
namespace (str | None) – 从索引中使用的命名空间。
kwargs (Any)

Returns:

与查询最相似的文档列表

Return type:

列表[文档]

similarity_search_by_vector_with_score(embedding: List[float] | str, k: int = 4, filter: str | None = None, *, namespace: str | None = None, **kwargs: Any) → List[Tuple[Document, float]][源代码]#

返回其嵌入最接近给定嵌入的文本

Parameters:

embedding (List[float] | str)
k (整数)
filter (str | None)
命名空间 (字符串 | 无)
kwargs (Any)

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, filter: str | None = None, *, namespace: str | None = None, **kwargs: Any) → List[Tuple[Document, float]][source]#

检索与查询最相似的文本并将结果转换为Document对象。

Parameters:

query (str) – 用于查找相似文档的文本。
k (int) – 返回的文档数量。默认为4。
filter (str | None) – 可选的元数据过滤器，格式为字符串
namespace (str | None) – 从索引中使用的命名空间。
kwargs (Any)

Returns:

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

Return type:

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

使用 UpstashVectorStore 的示例

Upstash Vector