`langchain_community.vectorstores.jaguar`.Jaguar¶

class langchain_community.vectorstores.jaguar.Jaguar(pod: str, store: str, vector_index: str, vector_type: str, vector_dimension: int, url: str, embedding: Embeddings)[source]¶

Jaguar API 向量存储。

参见 http://www.jaguardb.com 参见 http://github.com/fserv/jaguar-sdk

示例

from langchain_community.vectorstores.jaguar import Jaguar

vectorstore = Jaguar(
    pod = 'vdb',
    store = 'mystore',
    vector_index = 'v',
    vector_type = 'cosine_fraction_float',
    vector_dimension = 1536,
    url='http://192.168.8.88:8080/fwww/',
    embedding=openai_model
)

属性

embeddings

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

方法

`__init__`(pod, store, vector_index, ...)
`aadd_documents`(documents, **kwargs)	异步地通过嵌入运行更多文档并添加到向量存储。
`aadd_texts`(texts[, metadatas])	异步地通过嵌入运行更多文本并添加到向量存储。
`add_documents`(documents, **kwargs)	在向量存储中添加或更新文档。
`add_texts`(texts[, metadatas])	通过嵌入添加文本并添加到向量存储。 :param texts: 要添加到 jaguar 向量存储的文本字符串列表。 :param metadatas: 与文本关联的可选元数据列表。 [{"m1": "v11", "m2": "v12", "m3": "v13", "filecol": "path_file1.jpg" }, {"m1": "v21", "m2": "v22", "m3": "v23", "filecol": "path_file2.jpg" }, {"m1": "v31", "m2": "v32", "m3": "v33", "filecol": "path_file3.jpg" }, {"m1": "v41", "m2": "v42", "m3": "v43", "filecol": "path_file4.jpg" }] :param kwargs: vector_index=向量索引的名称 file_column=文件列的名称。
`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)
`clear`()	删除 jaguardb 中的所有记录参数：无参数返回：无
`count`()	计算 jaguardb 中存储的记录参数：无参数返回：(int) pod 存储中的记录数
`create`(metadata_str, text_size)	在后端数据库上创建向量存储 :param metadata_str: 列及其类型 :type metadata_str: str
`delete`(zids, **kwargs)	通过零 ID 列表删除 jaguardb 中的记录 :param pod: Pod 的名称 :type pod: str :param ids: zid 字符串列表 :type ids: List[str]
`drop`()	在 jaguardb 中删除或移除存储 Args: 无参数 Returns: 无
`from_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的 VectorStore。
`from_texts`(texts, embedding, url, pod, ...)	返回从文本和嵌入初始化的 VectorStore。
`get_by_ids`(ids, /)	通过 ID 获取文档。
`is_anomalous`(query, **kwargs)	检测给定文本是否与数据集异常 :param query: 要检测是否异常的文本
`login`([jaguar_api_key])	使用 jaguar_api_key 登录到 jaguardb 服务器，或让 self._jag 查找密钥 :param pod: Pod 的名称 :type pod: str :param store: 向量存储的名称 :type store: str :param optional jaguar_api_key: 用户访问 jaguardb 服务器的 API 密钥 :type optional jaguar_api_key: str
`logout`()	注销以清理资源参数：无参数返回：无
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`prt`(msg)
`run`(query[, withFile])	在 jaguardb 中运行任何查询语句 :param query: 发送到 jaguardb 的查询语句 :type query: str
`search`(query, search_type, **kwargs)	返回使用指定搜索类型与查询最相似的文档。
`similarity_search`(query[, k, where, metadatas])	返回与查询最相似的 Jaguar 文档，以及评分。 :param query: 用于查找相似文档的文本。 :param k: 要返回的文档数量。默认为 5。 :param where: 选择相似性时的 where 子句。例如，where 可以是 "rating > 3.0 and (state = 'NV' or state = 'CA')"。
`similarity_search_by_vector`(embedding[, k])	返回与嵌入向量最相似的文档。
`similarity_search_with_relevance_scores`(query)	返回范围在 [0, 1] 内的文档和相关性评分。
`similarity_search_with_score`(query[, k, ...])	返回与查询最相似的 Jaguar 文档，以及评分。 :param query: 用于查找相似文档的文本。 :param k: 要返回的文档数量。默认为 3。 :param lambda_val: 用于混合搜索的词法匹配参数。 :param where: 选择相似性时的 where 子句。例如，where 可以是 "rating > 3.0 and (state = 'NV' or state = 'CA')" :param args: 传递给选择相似性的额外选项 :param kwargs: vector_index=vcol, vector_type=cosine_fraction_float。
`streaming_upsert`(items, /, batch_size, **kwargs)
`upsert`(items, /, **kwargs)

参数

pod (str) –
store (str) –
vector_index (str) –
vector_type (str) –
vector_dimension (int) –
url (str) –
embedding (Embeddings) –

__init__(pod: str, store: str, vector_index: str, vector_type: str, vector_dimension: int, url: str, embedding: Embeddings)[source]¶

参数

pod (str) –
store (str) –
vector_index (str) –
vector_type (str) –
vector_dimension (int) –
url (str) –
embedding (Embeddings) –

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: List[str], metadatas: Optional[List[dict]] = None, **kwargs: Any) → List[str][source]¶

通过嵌入添加文本并添加到向量存储。 :param texts: 要添加到 jaguar 向量存储的文本字符串列表。 :param metadatas: 与文本关联的可选元数据列表。

[{“m1”: “v11”, “m2”: “v12”, “m3”: “v13”, “filecol”: “path_file1.jpg” },
{“m1”: “v21”, “m2”: “v22”, “m3”: “v23”, “filecol”: “path_file2.jpg” }, {“m1”: “v31”, “m2”: “v32”, “m3”: “v33”, “filecol”: “path_file3.jpg” }, {“m1”: “v41”, “m2”: “v42”, “m3”: “v43”, “filecol”: “path_file4.jpg” }]

参数

kwargs (Any) – vector_index=向量索引的名称 file_column=文件列的名称
texts (List[str]) –
metadatas (Optional[List[dict]]) –

返回

从将文本添加到向量存储中获取的 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]): 定义检索器应执行的搜索类型。

可以是 “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: 按文档元数据过滤

返回

VectorStore 的检索器类。

返回类型

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 之间的浮点值，用于

过滤检索到的文档结果集

返回

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

返回类型

List[Tuple[Document, float]]

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

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

参数

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

返回

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

返回类型

List[Tuple[Document, float]]

astreaming_upsert(items: AsyncIterable[Document], /, batch_size: int, **kwargs: Any) → AsyncIterator[UpsertResponse]¶

Beta 版本

在 0.2.11 版本中添加。API 可能会发生变化。

以流式方式更新文档。streaming_upsert 的异步版本。

参数

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

clear() → None[source]¶

删除 jaguardb 中的所有记录参数：无参数返回：无

返回类型: None

count() → int[source]¶

计算 jaguardb 中存储的记录参数：无参数返回：(int) pod 存储中的记录数

返回类型: int

create(metadata_str: str, text_size: int) → None[source]¶

在后端数据库上创建向量存储 :param metadata_str: 列及其类型 :type metadata_str: str

返回

成功返回 True；不成功返回 False

参数

metadata_str (str) –
text_size (int) –

返回类型

None

delete(zids: List[str], **kwargs: Any) → None[source]¶

通过零 ID 列表删除 jaguardb 中的记录 :param pod: Pod 的名称 :type pod: str :param ids: zid 字符串列表 :type ids: List[str]

返回

不返回任何内容

参数

zids (List[str]) –
kwargs (Any) –

返回类型

None

drop() → None[source]¶

在 jaguardb 中删除或移除存储 Args: 无参数 Returns: 无

返回类型: None

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, url: str, pod: str, store: str, vector_index: str, vector_type: str, vector_dimension: int, metadatas: Optional[List[dict]] = None, jaguar_api_key: Optional[str] = '', **kwargs: Any) → Jaguar[source]¶

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

参数

texts (List[str]) – 要添加到向量存储的文本列表。
embedding (Embeddings) – 要使用的嵌入函数。
metadatas (Optional[List[dict]]) – 与文本关联的可选元数据列表。默认为 None。
kwargs (Any) – 附加关键字参数。
url (str) –
pod (str) –
store (str) –
vector_index (str) –
vector_type (str) –
vector_dimension (int) –
jaguar_api_key (Optional[str]) –

返回

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

返回类型

VectorStore

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

is_anomalous(query: str, **kwargs: Any) → bool[source]¶

检测给定文本是否与数据集异常 :param query: 要检测是否异常的文本

返回

True 或 False

参数

query (str) –
kwargs (Any) –

返回类型

bool

login(jaguar_api_key: Optional[str] = '') → bool[source]¶

使用 jaguar_api_key 登录到 jaguardb 服务器，或让 self._jag 查找密钥 :param pod: Pod 的名称 :type pod: str :param store: 向量存储的名称 :type store: str :param optional jaguar_api_key: 用户访问 jaguardb 服务器的 API 密钥 :type optional jaguar_api_key: str

返回: 成功返回 True；不成功返回 False
参数: jaguar_api_key (Optional[str]) –
返回类型: bool

logout() → None[source]¶

注销以清理资源参数：无参数返回：无

返回类型: None

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

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 (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 返回的文档数量。默认为 4。
fetch_k (int) – 获取并传递给 MMR 算法的文档数量。默认为 20。
lambda_mult (float) – 介于 0 和 1 之间的数字，用于确定结果之间多样性的程度，其中 0 对应于最大多样性，1 对应于最小多样性。默认为 0.5。
**kwargs (Any) – 传递给搜索方法的参数。

返回

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

返回类型

List[Document]

prt(msg: str) → None[source]¶

参数: msg (str) –
返回类型: None

run(query: str, withFile: bool = False) → dict[source]¶

在 jaguardb 中运行任何查询语句 :param query: 发送到 jaguardb 的查询语句 :type query: str

返回

无效令牌返回 None，否则返回 json 结果字符串

参数

query (str) –
withFile (bool) –

返回类型

dict

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 = 3, where: Optional[str] = None, metadatas: Optional[List[str]] = None, **kwargs: Any) → List[Document][source]¶

返回与查询最相似的 Jaguar 文档，以及它们的分数。:param query: 用于查找相似文档的文本。:param k: 返回文档的数量。默认为 5。:param where: 用于选择相似性的 where 子句。例如

where 可以是 “rating > 3.0 and (state = ‘NV’ or state = ‘CA’)”

返回

与查询最相似的文档列表

参数

query (str) –
k (int) –
where (Optional[str]) –
metadatas (Optional[List[str]]) –
kwargs (Any) –

返回类型

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, **kwargs: Any) → List[Document]¶

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

参数

embedding (List[float]) – 用于查找相似文档的嵌入向量。
k (int) – 返回的文档数量。默认为 4。
**kwargs (Any) – 传递给搜索方法的参数。

返回

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

返回类型

List[Document]

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 之间的浮点值，用于

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

返回

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

返回类型

List[Tuple[Document, float]]

similarity_search_with_score(query: str, k: int = 3, fetch_k: int = -1, where: Optional[str] = None, args: Optional[str] = None, metadatas: Optional[List[str]] = None, **kwargs: Any) → List[Tuple[Document, float]][source]¶

返回与查询最相似的 Jaguar 文档，以及它们的分数。:param query: 用于查找相似文档的文本。:param k: 返回文档的数量。默认为 3。:param lambda_val: 用于混合搜索的词汇匹配参数。:param where: 用于选择相似性的 where 子句。例如

where 可以是 “rating > 3.0 and (state = ‘NV’ or state = ‘CA’)”

参数

args (Optional[str]) – 传递给 select similarity 的额外选项
kwargs (Any) – vector_index=vcol, vector_type=cosine_fraction_float
query (str) –
k (int) –
fetch_k (int) –
where (Optional[str]) –
metadatas (Optional[List[str]]) –

返回

与查询最相似的文档列表，以及每个文档的分数。元组列表 (doc, similarity_score)

[ (doc, score), (doc, score), …]

返回类型

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) – 每次更新批次的大小。
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 版本新增。

langchain_community.vectorstores.jaguar.Jaguar¶

使用 Jaguar 的示例¶

`langchain_community.vectorstores.jaguar`.Jaguar¶