美洲虎#
- class langchain_community.vectorstores.jaguar.Jaguar(pod: str, store: str, vector_index: str, vector_type: str, vector_dimension: int, url: str, embedding: Embeddings)[来源]#
Jaguar API 向量存储。
参见 http://www.jaguardb.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, ids])异步运行更多文本通过嵌入并添加到向量存储中。
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=name_of_vector_index file_column=name_of_file_column.
adelete
([ids])异步删除通过向量ID或其他条件。
afrom_documents
(documents, embedding, **kwargs)异步返回从文档和嵌入初始化的VectorStore。
afrom_texts
(texts, embedding[, metadatas, ids])异步返回从文本和嵌入初始化的VectorStore。
aget_by_ids
(ids, /)通过ID异步获取文档。
amax_marginal_relevance_search
(query[, k, ...])异步返回使用最大边际相关性选择的文档。
异步返回使用最大边际相关性选择的文档。
as_retriever
(**kwargs)返回从此VectorStore初始化的VectorStoreRetriever。
asearch
(query, search_type, **kwargs)异步返回与查询最相似的文档,使用指定的搜索类型。
asimilarity_search
(query[, k])异步返回与查询最相似的文档。
asimilarity_search_by_vector
(embedding[, k])异步返回与嵌入向量最相似的文档。
异步返回文档和相关分数,范围在[0, 1]之间。
asimilarity_search_with_score
(*args, **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中删除或移除一个存储 参数:无 返回值:无
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, ...])返回使用最大边际相关性选择的文档。
返回使用最大边际相关性选择的文档。
prt
(msg)run
(query[, withFile])在jaguardb中运行任何查询语句 :param query: 要执行的查询语句 :type query: str
search
(query, search_type, **kwargs)使用指定的搜索类型返回与查询最相似的文档。
similarity_search
(query[, k, where, metadatas])返回与查询最相似的Jaguar文档,以及分数。 :param query: 要查找相似文档的文本。 :param k: 要返回的文档数量。默认为5。 :param where: 在select similarity中的where子句。例如,一个where子句可以是 "rating > 3.0 and (state = 'NV' or state = 'CA')"。
similarity_search_by_vector
(embedding[, k])返回与嵌入向量最相似的文档。
返回文档和相关分数,分数范围在[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。
- 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] #
通过嵌入异步运行更多文档并将其添加到向量存储中。
- Parameters:
documents (list[Document]) – 要添加到向量存储中的文档。
kwargs (Any) – 额外的关键字参数。
- Returns:
已添加文本的ID列表。
- Raises:
ValueError – 如果ID的数量与文档的数量不匹配。
- Return type:
列表[字符串]
- async aadd_texts(texts: Iterable[str], metadatas: list[dict] | None = None, *, ids: list[str] | None = None, **kwargs: Any) list[str] #
异步运行更多文本通过嵌入并添加到向量存储中。
- Parameters:
texts (Iterable[str]) – 要添加到向量存储中的字符串的可迭代对象。
metadatas (list[dict] | None) – 可选的与文本关联的元数据列表。默认值为 None。
ids (list[str] | None) – 可选的列表
**kwargs (Any) – 向量存储特定参数。
- Returns:
将文本添加到向量存储中后的ID列表。
- Raises:
ValueError – 如果元数据的数量与文本的数量不匹配。
ValueError – 如果id的数量与文本的数量不匹配。
- Return type:
列表[字符串]
- add_documents(documents: list[Document], **kwargs: Any) list[str] #
在向量存储中添加或更新文档。
- Parameters:
documents (list[Document]) – 要添加到向量存储中的文档。
kwargs (Any) – 额外的关键字参数。 如果 kwargs 包含 ids 并且 documents 也包含 ids, kwargs 中的 ids 将优先。
- Returns:
已添加文本的ID列表。
- Raises:
ValueError – 如果id的数量与文档的数量不匹配。
- Return type:
列表[字符串]
- add_texts(texts: List[str], metadatas: List[dict] | None = None, **kwargs: Any) List[str] [来源]#
通过嵌入添加文本并将其添加到向量存储中。 :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” }]
- Parameters:
kwargs (Any) – vector_index=name_of_vector_index file_column=name_of_file_column
文本 (列表[字符串])
metadatas (列表[字典] | 无)
- Returns:
将文本添加到向量存储中的ID列表
- Return type:
列表[str]
- async adelete(ids: list[str] | None = None, **kwargs: Any) bool | None #
通过向量ID或其他条件异步删除。
- Parameters:
ids (list[str] | None) – 要删除的id列表。如果为None,则删除所有。默认值为None。
**kwargs (Any) – 子类可能使用的其他关键字参数。
- Returns:
如果删除成功则为真, 否则为假,如果未实现则为无。
- 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:
- async classmethod afrom_texts(texts: list[str], embedding: Embeddings, metadatas: list[dict] | None = None, *, ids: list[str] | None = None, **kwargs: Any) VST #
异步返回从文本和嵌入初始化的VectorStore。
- Parameters:
texts (list[str]) – 要添加到向量存储中的文本。
embedding (Embeddings) – 使用的嵌入函数。
metadatas (list[dict] | None) – 可选的与文本关联的元数据列表。默认值为 None。
ids (list[str] | None) – 可选的与文本关联的ID列表。
kwargs (Any) – 额外的关键字参数。
- Returns:
VectorStore 从文本和嵌入初始化。
- Return type:
- 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 amax_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) list[Document] #
异步返回使用最大边际相关性选择的文档。
最大边际相关性优化了与查询的相似性和所选文档之间的多样性。
- Parameters:
query (str) – 用于查找相似文档的文本。
k (int) – 返回的文档数量。默认为4。
fetch_k (int) – 要传递给MMR算法的文档数量。 默认值为20。
lambda_mult (float) – 介于0和1之间的数字,决定了结果之间的多样性程度,0对应最大多样性,1对应最小多样性。默认值为0.5。
kwargs (Any)
- Returns:
通过最大边际相关性选择的文档列表。
- Return type:
列表[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) – 返回的文档数量。默认为4。
fetch_k (int) – 要传递给MMR算法的文档数量。 默认值为20。
lambda_mult (float) – 介于0和1之间的数字,决定了结果之间的多样性程度,0对应最大多样性,1对应最小多样性。默认值为0.5。
**kwargs (Any) – 传递给搜索方法的参数。
- Returns:
通过最大边际相关性选择的文档列表。
- Return type:
列表[Document]
- 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:
示例:
# 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, **kwargs: Any) list[Document] #
异步返回与查询最相似的文档。
- Parameters:
query (str) – 输入文本。
k (int) – 返回的文档数量。默认为4。
**kwargs (Any) – 传递给搜索方法的参数。
- Returns:
与查询最相似的文档列表。
- Return type:
列表[Document]
- async asimilarity_search_by_vector(embedding: list[float], k: int = 4, **kwargs: Any) list[Document] #
异步返回与嵌入向量最相似的文档。
- Parameters:
embedding (list[float]) – 用于查找相似文档的嵌入。
k (int) – 返回的文档数量。默认为4。
**kwargs (Any) – 传递给搜索方法的参数。
- Returns:
与查询向量最相似的文档列表。
- Return type:
列表[Document]
- 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(*args: Any, **kwargs: Any) list[tuple[Document, float]] #
异步运行带有距离的相似性搜索。
- Parameters:
*args (Any) – 传递给搜索方法的参数。
**kwargs (Any) – 传递给搜索方法的参数。
- Returns:
(文档, 相似度分数) 的元组列表。
- Return type:
列表[元组[Document, 浮点数]]
- create(metadata_str: str, text_size: int) None [来源]#
在后端数据库上创建向量存储 :param metadata_str: 列及其类型 :type metadata_str: str
- Returns:
如果成功则为真;如果不成功则为假
- Parameters:
metadata_str (str)
text_size (int)
- Return type:
无
- delete(zids: List[str], **kwargs: Any) None [source]#
通过零ID列表删除jaguardb中的记录 :param pod: Pod的名称 :type pod: str :param ids: 作为字符串的zid列表 :type ids: List[str]
- Returns:
不要返回任何内容
- Parameters:
zids (列表[字符串])
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:
- classmethod from_texts(texts: List[str], embedding: Embeddings, url: str, pod: str, store: str, vector_index: str, vector_type: str, vector_dimension: int, metadatas: List[dict] | None = None, jaguar_api_key: str | None = '', **kwargs: Any) Jaguar [来源]#
返回从文本和嵌入初始化的VectorStore。
- Parameters:
texts (List[str]) – 要添加到向量存储中的文本。
embedding (Embeddings) – 使用的嵌入函数。
metadatas (List[dict] | None) – 可选的与文本关联的元数据列表。默认值为 None。
ids – 与文本关联的可选ID列表。
kwargs (Any) – 额外的关键字参数。
url (str)
pod (str)
store (str)
vector_index (str)
vector_type (str)
vector_dimension (int)
jaguar_api_key (str | None)
- Returns:
VectorStore 从文本和嵌入初始化。
- Return type:
- 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中添加。
- is_anomalous(query: str, **kwargs: Any) bool [source]#
检测给定文本是否与数据集中的异常 :param query: 要检测是否为异常的文本
- Returns:
真或假
- Parameters:
query (str)
kwargs (Any)
- Return type:
布尔
- login(jaguar_api_key: str | None = '') 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
- Returns:
如果成功则为真;如果不成功则为假
- Parameters:
jaguar_api_key (str | None)
- Return type:
布尔
- max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) list[Document] #
返回使用最大边际相关性选择的文档。
最大边际相关性优化了与查询的相似性和所选文档之间的多样性。
- Parameters:
query (str) – 用于查找相似文档的文本。
k (int) – 返回的文档数量。默认为4。
fetch_k (int) – 要传递给MMR算法的文档数量。 默认值为20。
lambda_mult (float) – 介于0和1之间的数字,决定了结果之间的多样性程度,0对应最大多样性,1对应最小多样性。默认值为0.5。
**kwargs (Any) – 传递给搜索方法的参数。
- Returns:
通过最大边际相关性选择的文档列表。
- Return type:
列表[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] #
返回使用最大边际相关性选择的文档。
最大边际相关性优化了与查询的相似性和所选文档之间的多样性。
- Parameters:
embedding (list[float]) – 用于查找相似文档的嵌入。
k (int) – 返回的文档数量。默认为4。
fetch_k (int) – 要传递给MMR算法的文档数量。 默认值为20。
lambda_mult (float) – 介于0和1之间的数字,决定了结果之间的多样性程度,0对应最大多样性,1对应最小多样性。默认值为0.5。
**kwargs (Any) – 传递给搜索方法的参数。
- Returns:
通过最大边际相关性选择的文档列表。
- Return type:
列表[Document]
- run(query: str, withFile: bool = False) dict [来源]#
在jaguardb中运行任何查询语句 :param query: 要执行的jaguardb查询语句 :type query: str
- Returns:
无效令牌为None,或 json结果字符串
- Parameters:
query (str)
withFile (bool)
- 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 = 3, where: str | None = None, metadatas: List[str] | None = None, **kwargs: Any) List[Document] [source]#
返回与查询最相似的Jaguar文档,以及分数。 :param query: 要查找相似文档的文本。 :param k: 要返回的文档数量。默认为5。 :param where: 选择相似性时的where子句。例如a
其中可以是“rating > 3.0 且 (state = ‘NV’ 或 state = ‘CA’)”
- Returns:
与查询最相似的文档列表
- Parameters:
query (str)
k (整数)
where (str | None)
metadatas (列表[字符串] | 无)
kwargs (Any)
- Return type:
列表[文档]
- similarity_search_by_vector(embedding: list[float], k: int = 4, **kwargs: Any) list[Document] #
返回与嵌入向量最相似的文档。
- Parameters:
embedding (list[float]) – 用于查找相似文档的嵌入。
k (int) – 返回的文档数量。默认为4。
**kwargs (Any) – 传递给搜索方法的参数。
- Returns:
与查询向量最相似的文档列表。
- Return type:
列表[Document]
- 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 = 3, fetch_k: int = -1, where: str | None = None, args: str | None = None, metadatas: List[str] | None = None, **kwargs: Any) List[Tuple[Document, float]] [source]#
返回与查询最相似的Jaguar文档,以及分数。 :param query: 要查找相似文档的文本。 :param k: 要返回的文档数量。默认为3。 :param lambda_val: 混合搜索的词汇匹配参数。 :param where: 选择相似性时的where子句。例如a
其中可以是“rating > 3.0 且 (state = ‘NV’ 或 state = ‘CA’)”
- Parameters:
args (str | None) – 传递给选择相似性的额外选项
kwargs (Any) – vector_index=vcol, vector_type=cosine_fraction_float
query (str)
k (整数)
fetch_k (int)
where (str | None)
metadatas (列表[字符串] | 无)
- Returns:
与查询最相似的文档列表及每个文档的得分。 文档与相似度得分的元组列表:
[ (doc, score), (doc, score), …]
- Return type:
列表[元组[文档, 浮点数]]
使用Jaguar的示例