Vectara#

class langchain_community.vectorstores.vectara.Vectara(vectara_customer_id: str | None = None, vectara_corpus_id: str | None = None, vectara_api_key: str | None = None, vectara_api_timeout: int = 120, source: str = 'langchain')[来源]#

Vectara API 向量存储。

示例

from langchain_community.vectorstores import Vectara

vectorstore = Vectara(
    vectara_customer_id=vectara_customer_id,
    vectara_corpus_id=vectara_corpus_id,
    vectara_api_key=vectara_api_key
)

使用Vectara API进行初始化。

属性

embeddings

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

方法

__init__([vectara_customer_id, ...])

使用 Vectara API 进行初始化。

aadd_documents(documents, **kwargs)

异步运行更多文档通过嵌入并添加到向量存储中。

aadd_texts(texts[, metadatas, ids])

异步运行更多文本通过嵌入并添加到向量存储中。

add_documents(documents, **kwargs)

在向量存储中添加或更新文档。

add_files(files_list[, metadatas])

Vectara 提供了一种通过我们的 API 直接添加文档的方式，其中预处理和分块在内部以最佳方式完成。此方法提供了一种在 LangChain 中使用该 API 的方式

add_texts(texts[, metadatas, doc_metadata])

通过嵌入运行更多文本并将其添加到向量存储中。

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, ...])

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

amax_marginal_relevance_search_by_vector(...)

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

as_chat(config)

返回一个用于聊天的Vectara RAG可运行对象。

as_rag(config)

返回一个Vectara RAG可运行对象。

as_retriever(**kwargs)

返回一个检索器对象。

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或其他条件删除。

from_documents(documents, embedding, **kwargs)

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

from_files(files[, embedding, metadatas])

从原始文档构建Vectara包装器。

from_texts(texts[, embedding, metadatas])

从原始文档构建Vectara包装器。

get_by_ids(ids, /)

通过ID获取文档。

max_marginal_relevance_search(query[, ...])

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

max_marginal_relevance_search_by_vector(...)

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

search(query, search_type, **kwargs)

使用指定的搜索类型返回与查询最相似的文档。

similarity_search(query, **kwargs)

返回与查询最相似的Vectara文档，并附带分数。

similarity_search_by_vector(embedding[, k])

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

similarity_search_with_relevance_scores(query)

返回文档和相关度分数，分数范围在[0, 1]之间。

similarity_search_with_score(query, **kwargs)

返回与查询最相似的Vectara文档及其分数。

vectara_query(query, config, **kwargs)

运行一个Vectara查询
Parameters:

  • vectara_customer_id (可选[str])

  • vectara_corpus_id (可选[str])

  • vectara_api_key (可选[str])

  • vectara_api_timeout (int)

  • source (str)

__init__(vectara_customer_id: str | None = None, vectara_corpus_id: str | None = None, vectara_api_key: str | None = None, vectara_api_timeout: int = 120, source: str = 'langchain')[source]#

使用Vectara API进行初始化。

Parameters:

  • vectara_customer_id (str | None)

  • vectara_corpus_id (str | None)

  • vectara_api_key (str | None)

  • vectara_api_timeout (int)

  • source (str)

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_files(files_list: Iterable[str], metadatas: List[dict] | None = None, **kwargs: Any) → List[str][source]#

Vectara 提供了一种通过我们的 API 直接添加文档的方式，其中预处理和分块在内部以最佳方式进行。此方法提供了一种在 LangChain 中使用该 API 的方式。

Parameters:

  • files_list (Iterable[str]) – 字符串的可迭代对象，每个字符串代表一个本地文件路径。 文件可以是文本、HTML、PDF、markdown、doc/docx、ppt/pptx等。 完整列表请参阅API文档

  • metadatas (List[dict] | None) – 可选的与每个文件关联的元数据列表

  • kwargs (Any)

Returns:

与每个索引文件关联的ID列表

Return type:

列表[str]

add_texts(texts: Iterable[str], metadatas: List[dict] | None = None, doc_metadata: dict | None = None, **kwargs: Any) → List[str][来源]#

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

Parameters:

  • texts (Iterable[str]) – 要添加到向量存储中的字符串的可迭代对象。

  • metadatas (List[dict] | None) – 可选的与文本关联的元数据列表。

  • doc_metadata (dict | None) – 文档的可选元数据

  • kwargs (Any)

Return type:

列表[str]

此函数将Vectara语料库中的所有输入文本字符串索引为单个Vectara文档，其中每个输入文本被视为一个“部分”，并且元数据与每个部分相关联。 如果提供了‘doc_metadata’，则它与Vectara文档相关联。

Returns:

添加的文档的文档ID

Parameters:

  • texts (可迭代对象[字符串])

  • metadatas (列表[字典] | 无)

  • doc_metadata (dict | None)

  • kwargs (Any)

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:

VectorStore

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:

VectorStore

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

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

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

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_chat(config: VectaraQueryConfig) → VectaraRAG[来源]#

返回一个用于聊天的Vectara RAG可运行对象。

Parameters:

config (VectaraQueryConfig)

Return type:

VectaraRAG

as_rag(config: VectaraQueryConfig) → VectaraRAG[source]#

返回一个Vectara RAG可运行对象。

Parameters:

config (VectaraQueryConfig)

Return type:

VectaraRAG

as_retriever(**kwargs: Any) → VectaraRetriever[source]#

返回一个检索器对象。

Parameters:

kwargs (任意)

Return type:

VectaraRetriever

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]

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

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, 浮点数]]

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

根据向量ID或其他条件删除。 :param ids: 要删除的ID列表。

Returns:

如果删除成功则为真， 否则为假，如果未实现则为无。

Return type:

可选[布尔]

Parameters:

  • ids (列表[字符串] | 无)

  • kwargs (Any)

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_files(files: List[str], embedding: Embeddings | None = None, metadatas: List[dict] | None = None, **kwargs: Any) → Vectara[source]#

从原始文档构建Vectara包装器。 这是为了快速入门的一种方式。 .. rubric:: 示例

from langchain_community.vectorstores import Vectara
vectara = Vectara.from_files(
    files_list,
    vectara_customer_id=customer_id,
    vectara_corpus_id=corpus_id,
    vectara_api_key=api_key,
)
Parameters:

  • 文件 (列表[字符串])

  • embedding (Embeddings | None)

  • metadatas (列表[字典] | 无)

  • kwargs (Any)

Return type:

Vectara

classmethod from_texts(texts: List[str], embedding: Embeddings | None = None, metadatas: List[dict] | None = None, **kwargs: Any) → Vectara[source]#

从原始文档构建Vectara包装器。 这是为了快速入门的一种方式。 .. rubric:: 示例

from langchain_community.vectorstores import Vectara
vectara = Vectara.from_texts(
    texts,
    vectara_customer_id=customer_id,
    vectara_corpus_id=corpus_id,
    vectara_api_key=api_key,
)
Parameters:

  • 文本 (列表[字符串])

  • embedding (Embeddings | None)

  • metadatas (列表[字典] | 无)

  • kwargs (Any)

Return type:

Vectara

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

返回使用最大边际相关性选择的文档。 最大边际相关性优化了与查询的相似性以及所选文档之间的多样性。

Parameters:

  • query (str) – 用于查找相似文档的文本。

  • k – 返回的文档数量。默认为5。

  • fetch_k (int) – 要传递给MMR算法的文档数量。默认值为50

  • lambda_mult (float) – 介于0和1之间的数字，决定了结果之间的多样性程度，0对应最大多样性，1对应最小多样性。默认值为0.5。

  • kwargs (Any) – VectaraQueryConfig 中的任何其他查询变量

Returns:

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

Return type:

列表[文档]

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]

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]

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

Parameters:

  • query (str) – 用于查找相似文档的文本。

  • VectaraQueryConfig (任何其他查询变量)

  • kwargs (Any)

Returns:

与查询最相似的文档列表

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

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

Parameters:

  • query (str) – 用于查找相似文档的文本。

  • k – 返回的文档数量。默认为10。

  • like (VectaraQueryConfig 中的任何其他查询变量)

  • lambda_val (-) – 混合搜索的词汇匹配参数。

  • filter (-) – 过滤字符串

  • score_threshold (-) – 结果的最小分数阈值。

  • n_sentence_before (-) – 匹配段之前的句子数量

  • n_sentence_after (-) – 匹配段落后面的句子数量

  • rerank_config (-) – Reranking的可选配置 (参见 RerankConfig 数据类)

  • summary_config (-) – 摘要的可选配置 （参见 SummaryConfig 数据类）

  • kwargs (Any)

Returns:

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

Return type:

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

vectara_query(query: str, config: VectaraQueryConfig, **kwargs: Any) → List[Tuple[Document, float]][来源]#

运行一个Vectara查询

Parameters:

  • query (str) – 用于查找相似文档的文本。

  • config (VectaraQueryConfig) – VectaraQueryConfig 对象

  • kwargs (Any)

Returns:

与给定查询匹配的k个文档列表 如果启用了摘要，最后一个文档是带有'summary'=True的摘要文本

Return type:

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

使用 Vectara 的示例