langchain_community.vectorstores.rocksetdb.Rockset

class langchain_community.vectorstores.rocksetdb.Rockset(client: Any, embeddings: Embeddings, collection_name: str, text_key: str, embedding_key: str, workspace: str = 'commons')

Rockset 向量存储。

要使用，您应该已安装 rockset python 包。请注意，要使用此功能，所使用的集合必须已经存在于您的 Rockset 实例中。 您还必须确保使用 Rockset 导入转换来在用于存储集合中的 embedding_key 的列上应用 VECTOR_ENFORCE。 请参阅：https://rockset.com/blog/introducing-vector-search-on-rockset/ 了解更多详细信息

以下所有内容都假定使用 commons Rockset 工作区。

示例：

from langchain_community.vectorstores import Rockset
from langchain_community.embeddings.openai import OpenAIEmbeddings
import rockset

# 确保使用正确的主机（区域）来连接您的 Rockset 实例
# 并且 APIKEY 具有对集合的读写访问权限。

rs = rockset.RocksetClient(host=rockset.Regions.use1a1, api_key="***")
collection_name = "langchain_demo"
embeddings = OpenAIEmbeddings()
vectorstore = Rockset(rs, collection_name, embeddings,
    "description", "description_embedding")

使用Rockset客户端进行初始化。 参数：

client: Rockset客户端对象 collection: Rockset集合，用于插入文档/查询 embeddings: Langchain Embeddings对象，用于生成给定文本的嵌入 text_key: 用于存储文本的Rockset集合中的列 embedding_key: 用于存储嵌入的Rockset集合中的列。

注意：我们必须通过Rockset摄取转换在此列上应用`VECTOR_ENFORCE()`。

Attributes

embeddings

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

Methods

__init__(client, embeddings, ...[, workspace])	使用Rockset客户端进行初始化。 参数： client: Rockset客户端对象 collection: Rockset集合，用于插入文档/查询 embeddings: Langchain Embeddings对象，用于生成给定文本的嵌入 text_key: 用于存储文本的Rockset集合中的列 embedding_key: 用于存储嵌入的Rockset集合中的列。 注意：我们必须通过Rockset摄取转换在此列上应用`VECTOR_ENFORCE()`。
aadd_documents(documents, **kwargs)	运行更多的文档通过嵌入并添加到向量存储中。
aadd_texts(texts[, metadatas])	运行更多的文本通过嵌入，并添加到向量存储中。
add_documents(documents, **kwargs)	运行更多的文档通过嵌入并添加到向量存储中。
add_texts(texts[, metadatas, ids, batch_size])	运行更多文本通过嵌入并添加到向量存储库
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)	使用异步方式运行相似性搜索与距离。
delete([ids])	根据向量ID或其他条件进行删除。
delete_texts(ids)	从Rockset集合中删除一个文档列表
from_documents(documents, embedding, **kwargs)	返回从文档和嵌入初始化的VectorStore。
from_texts(texts, embedding[, metadatas, ...])	使用现有文本创建Rockset包装器。 这旨在作为一个更快的入门方式。
max_marginal_relevance_search(query[, k, ...])	返回使用最大边际相关性选择的文档。
max_marginal_relevance_search_by_vector(...)	返回使用最大边际相关性选择的文档。
search(query, search_type, **kwargs)	返回使用指定搜索类型的查询最相似的文档。
similarity_search(query[, k, distance_func, ...])	与`similarity_search_with_relevance_scores`相同，但不返回分数。
similarity_search_by_vector(embedding[, k, ...])	接受一个查询嵌入（向量），并返回具有相似嵌入的文档。
similarity_search_by_vector_with_relevance_scores(...)	接受一个查询嵌入（向量），并返回具有相似嵌入的文档以及它们的相关性分数。
similarity_search_with_relevance_scores(query)	使用Rockset执行相似性搜索
similarity_search_with_score(*args, **kwargs)	使用距离进行相似性搜索。

Parameters

• client (Any) –

• embeddings (Embeddings) –

• collection_name (str) –

• text_key (str) –

• embedding_key (str) –

• workspace (str) –

__init__(client: Any, embeddings: Embeddings, collection_name: str, text_key: str, embedding_key: str, workspace: str = 'commons')

使用Rockset客户端进行初始化。 参数：

client: Rockset客户端对象 collection: Rockset集合，用于插入文档/查询 embeddings: Langchain Embeddings对象，用于生成给定文本的嵌入 text_key: 用于存储文本的Rockset集合中的列 embedding_key: 用于存储嵌入的Rockset集合中的列。

注意：我们必须通过Rockset摄取转换在此列上应用`VECTOR_ENFORCE()`。

Parameters

• client (Any) –

• embeddings (Embeddings) –

• collection_name (str) –

• text_key (str) –

• embedding_key (str) –

• workspace (str) –

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, batch_size: int = 32, **kwargs: Any) → List[str]

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

参数：

texts：要添加到向量存储库的字符串的可迭代对象。 metadatas：与文本相关联的元数据的可选列表。 ids：与文本关联的可选id列表。 batch_size：将文档分批发送到rockset。

返回：

将文本添加到向量存储库中的id列表。

Parameters

• texts (Iterable[str]) –

• metadatas (Optional[List[dict]]) –

• ids (Optional[List[str]]) –

• batch_size (int) –

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

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_texts(ids: List[str]) → None

从Rockset集合中删除一个文档列表

Parameters

ids (List[str]) –

Return type

None

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: Any = None, collection_name: str = '', text_key: str = '', embedding_key: str = '', ids: Optional[List[str]] = None, batch_size: int = 32, **kwargs: Any) → Rockset

使用现有文本创建Rockset包装器。 这旨在作为一个更快的入门方式。

Parameters

• texts (List[str]) –

• embedding (Embeddings) –

• metadatas (Optional[List[dict]]) –

• client (Any) –

• collection_name (str) –

• text_key (str) –

• embedding_key (str) –

• ids (Optional[List[str]]) –

• batch_size (int) –

• kwargs (Any) –

Return type

Rockset

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

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

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

参数：

query: 要查找类似文档的文本。 k: 要返回的文档数量。默认为4。 fetch_k: 要获取以传递给MMR算法的文档数量。 distance_func（DistanceFunction）：如何计算Rockset中两个向量之间的距离。 lambda_mult: 0到1之间的数字，确定结果之间多样性的程度，0对应最大多样性，1对应最小多样性。默认为0.5。 where_str: sql查询的where子句

返回：

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

Parameters

• query (str) –

• k (int) –

• fetch_k (int) –

• lambda_mult (float) –

• where_str (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, **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]

similarity_search(query: str, k: int = 4, distance_func: DistanceFunction = DistanceFunction.COSINE_SIM, where_str: Optional[str] = None, **kwargs: Any) → List[Document]

与`similarity_search_with_relevance_scores`相同，但不返回分数。

Parameters

• query (str) –

• k (int) –

• distance_func (DistanceFunction) –

• where_str (Optional[str]) –

• kwargs (Any) –

Return type

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, distance_func: DistanceFunction = DistanceFunction.COSINE_SIM, where_str: Optional[str] = None, **kwargs: Any) → List[Document]

接受一个查询嵌入（向量），并返回具有相似嵌入的文档。

Parameters

• embedding (List[float]) –

• k (int) –

• distance_func (DistanceFunction) –

• where_str (Optional[str]) –

• kwargs (Any) –

Return type

List[Document]

similarity_search_by_vector_with_relevance_scores(embedding: List[float], k: int = 4, distance_func: DistanceFunction = DistanceFunction.COSINE_SIM, where_str: Optional[str] = None, **kwargs: Any) → List[Tuple[Document, float]]

接受一个查询嵌入（向量），并返回具有相似嵌入的文档以及它们的相关性分数。

Parameters

• embedding (List[float]) –

• k (int) –

• distance_func (DistanceFunction) –

• where_str (Optional[str]) –

• kwargs (Any) –

Return type

List[Tuple[Document, float]]

similarity_search_with_relevance_scores(query: str, k: int = 4, distance_func: DistanceFunction = DistanceFunction.COSINE_SIM, where_str: Optional[str] = None, **kwargs: Any) → List[Tuple[Document, float]]

使用Rockset执行相似性搜索

参数:

query (str): 要查找与之相似文档的文本。 distance_func (DistanceFunction): 在Rockset中计算两个向量之间距离的方法。 k (int, optional): 要检索的前K个相邻项。默认为4。 where_str (Optional[str], optional): 作为SQL“where”条件字符串提供的元数据过滤器。默认为None。

例如 “price<=70.0 AND brand=’Nintendo’”

注意: 请不要让最终用户填写此内容，并始终注意SQL注入。

返回:

List[Tuple[Document, float]]: 具有其相关性分数的文档列表

Parameters

• query (str) –

• k (int) –

• distance_func (DistanceFunction) –

• where_str (Optional[str]) –

• 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 Rockset

• Rockset

• output length: 4