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

Attributes

embeddings

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

Methods

`__init__`(pod, store, vector_index, ...)
`aadd_documents`(documents, **kwargs)	运行更多的文档通过嵌入并添加到向量存储中。
`aadd_texts`(texts[, metadatas])	运行更多的文本通过嵌入，并添加到向量存储中。
`add_documents`(documents, **kwargs)	运行更多的文档通过嵌入并添加到向量存储中。
`add_texts`(texts[, metadatas])	通过嵌入将文本添加到向量存储中。参数： texts：要添加到jaguar向量存储中的文本字符串列表。 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：vector_index=向量索引名称 file_column=文件列名称
`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)	使用异步方式运行相似性搜索与距离。
`clear`()	删除jaguardb中的所有记录参数：无返回：无
`count`()	统计jaguardb中商店的记录数参数：无参数返回值：(int) 商店中记录的数量
`create`(metadata_str, text_size)	在后端数据库上创建向量存储参数： metadata_str（str）：列及其类型返回：如果成功则为True；如果不成功则为False
`delete`(zids, **kwargs)	通过零ID列表删除jaguardb中的记录参数： pod（str）：Pod的名称 ids（List[str]）：作为字符串的zid列表返回：不返回任何内容
`drop`()	删除或移除JaguarDB中的一个存储库参数：无参数返回值：无
`from_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的VectorStore。
`from_texts`(texts, embedding, url, pod, ...)	返回从文本和嵌入初始化的VectorStore。
`is_anomalous`(query, **kwargs)	检测给定文本是否在数据集中异常参数: query: 需要检测是否异常的文本返回: True 或 False
`login`([jaguar_api_key])	使用jaguar_api_key登录到jaguardb服务器，或让self._jag找到一个密钥参数: pod (str): Pod的名称 store (str): 向量存储的名称可选 jaguar_api_key (str): 用户到jaguardb服务器的API密钥返回: 如果成功则为True；如果不成功则为False
`logout`()	登出以清理资源参数：无参数返回：无
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`prt`(msg)
`run`(query[, withFile])	在JaguarDB中运行任何查询语句参数: query (str): 要在JaguarDB中运行的查询语句返回: 无效令牌返回None，或 JSON结果字符串
`search`(query, search_type, **kwargs)	返回使用指定搜索类型的查询最相似的文档。
`similarity_search`(query[, k, where, metadatas])	返回与查询最相似的Jaguar文档，以及分数。参数： query：要查找类似文档的文本。 k：要返回的文档数量。默认为5。 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文档，以及分数。参数： query：要查找类似文档的文本。 k：要返回的文档数量。默认为3。 lambda_val：混合搜索的词汇匹配参数。 where：在选择相似性中的where子句。例如，where可以是"rating > 3.0 and (state = 'NV' or state = 'CA')" args：传递给选择相似性的额外选项 kwargs：vector_index=vcol，vector_type=cosine_fraction_float 返回：与查询最相似的文档列表，以及每个文档的分数。元组列表（doc，similarity_score）： [（doc，score），（doc，score），...]

Parameters

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

Parameters

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]): 要添加到向量存储中的文档。
返回:: 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: List[str], metadatas: Optional[List[dict]] = None, **kwargs: Any) → List[str][source]¶

通过嵌入将文本添加到向量存储中。参数：

texts：要添加到jaguar向量存储中的文本字符串列表。 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：vector_index=向量索引名称
file_column=文件列名称

返回：: 将文本添加到向量存储中的ID列表。

Parameters

texts (List[str]) –
metadatas (Optional[List[dict]]) –
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]]

clear() → None[source]¶

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

Return type: None

count() → int[source]¶

统计jaguardb中商店的记录数参数：无参数返回值：(int) 商店中记录的数量

Return type: int

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

在后端数据库上创建向量存储参数：

metadata_str（str）：列及其类型

返回：: 如果成功则为True；如果不成功则为False

Parameters

metadata_str (str) –
text_size (int) –

Return type

None

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

通过零ID列表删除jaguardb中的记录参数：

pod（str）：Pod的名称 ids（List[str]）：作为字符串的zid列表

返回：: 不返回任何内容

Parameters

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

Return type

None

drop() → None[source]¶

删除或移除JaguarDB中的一个存储库参数：无参数返回值：无

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

Parameters

texts (List[str]) –
embedding (Embeddings) –
url (str) –
pod (str) –
store (str) –
vector_index (str) –
vector_type (str) –
vector_dimension (int) –
metadatas (Optional[List[dict]]) –
jaguar_api_key (Optional[str]) –
kwargs (Any) –

Return type

Jaguar

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

检测给定文本是否在数据集中异常参数:

query: 需要检测是否异常的文本

返回:: True 或 False

Parameters

query (str) –
kwargs (Any) –

Return type

bool

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

使用jaguar_api_key登录到jaguardb服务器，或让self._jag找到一个密钥参数:

pod (str): Pod的名称 store (str): 向量存储的名称可选 jaguar_api_key (str): 用户到jaguardb服务器的API密钥

返回:: 如果成功则为True；如果不成功则为False

Parameters: jaguar_api_key (Optional[str]) –
Return type: bool

logout() → None[source]¶

登出以清理资源参数：无参数返回：无

Return type: None

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

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]

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

Parameters: msg (str) –
Return type: None

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

在JaguarDB中运行任何查询语句参数:

query (str): 要在JaguarDB中运行的查询语句

返回:: 无效令牌返回None，或 JSON结果字符串

Parameters

query (str) –
withFile (bool) –

Return type

dict

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

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

query：要查找类似文档的文本。 k：要返回的文档数量。默认为5。 where：在选择相似性时的where子句。例如，where可以是”rating > 3.0 and (state = ‘NV’ or state = ‘CA’)”

返回：: 与查询最相似的文档列表

Parameters

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

Return type

List[Document]

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

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

参数：: embedding：要查找与之相似的文档的嵌入。 k：要返回的文档数量。默认为4。
返回：: 与查询向量最相似的文档列表。

Parameters

embedding (List[float]) –
k (int) –
kwargs (Any) –

Return type

List[Document]

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 = 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文档，以及分数。参数：

query：要查找类似文档的文本。 k：要返回的文档数量。默认为3。 lambda_val：混合搜索的词汇匹配参数。 where：在选择相似性中的where子句。例如，where可以是”rating > 3.0 and (state = ‘NV’ or state = ‘CA’)” args：传递给选择相似性的额外选项 kwargs：vector_index=vcol，vector_type=cosine_fraction_float

返回：: 与查询最相似的文档列表，以及每个文档的分数。元组列表（doc，similarity_score）：

[（doc，score），（doc，score），…]

Parameters

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

Return type

List[Tuple[Document, float]]

langchain_community.vectorstores.jaguar.Jaguar¶

Examples using Jaguar¶

`langchain_community.vectorstores.jaguar`.Jaguar¶