langchain_community.vectorstores.clarifai.Clarifai

class langchain_community.vectorstores.clarifai.Clarifai(user_id: Optional[str] = None, app_id: Optional[str] = None, number_of_docs: Optional[int] = 4, pat: Optional[str] = None, token: Optional[str] = None, api_base: Optional[str] = 'https://api.clarifai.com')[source]

`Clarifai AI`向量存储。

要使用，您应该已安装``clarifai`` python SDK包。

示例:
from langchain_community.vectorstores import Clarifai

clarifai_vector_db = Clarifai(
        user_id=USER_ID,
        app_id=APP_ID,
        number_of_docs=NUMBER_OF_DOCS,
        )

使用Clarifai客户端进行初始化。

参数:

user_id（可选[str]，可选）：用户ID。默认为None。 app_id（可选[str]，可选）：应用程序ID。默认为None。 pat（可选[str]，可选）：个人访问令牌。默认为None。 token（可选[str]，可选）：会话令牌。默认为None。 number_of_docs（可选[int]，可选）：在向量搜索期间返回的文档数量。默认为None。 api_base（可选[str]，可选）：API基础。默认为None。

引发:

ValueError: 如果未提供用户ID、应用程序ID或个人访问令牌。

Attributes

embeddings

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

Methods

__init__([user_id, app_id, number_of_docs, ...])

使用Clarifai客户端进行初始化。

aadd_documents(documents, **kwargs)

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

aadd_texts(texts[, metadatas])

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

add_documents(documents, **kwargs)

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

add_texts(texts[, metadatas, ids])

将文本添加到Clarifai向量存储中。这将把文本推送到Clarifai应用程序。 应用程序使用一个基本工作流程，为每个文本创建和存储嵌入。 确保您正在使用与文本兼容的基本工作流程（例如语言理解）。

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

from_documents(documents[, embedding, ...])

从文档列表中创建一个Clarifai向量存储。

from_texts(texts[, embedding, metadatas, ...])

从文本列表创建一个Clarifai向量存储。

max_marginal_relevance_search(query[, k, ...])

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

max_marginal_relevance_search_by_vector(...)

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

search(query, search_type, **kwargs)

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

similarity_search(query[, k])

运行使用Clarifai进行相似性搜索。

similarity_search_by_vector(embedding[, k])

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

similarity_search_with_relevance_scores(query)

返回文档和相关性得分在[0, 1]范围内。

similarity_search_with_score(query[, k, filters])

使用Clarifai运行带有分数的相似性搜索。
Parameters

  • user_id (Optional[str]) –

  • app_id (Optional[str]) –

  • number_of_docs (Optional[int]) –

  • pat (Optional[str]) –

  • token (Optional[str]) –

  • api_base (Optional[str]) –

Return type

None

__init__(user_id: Optional[str] = None, app_id: Optional[str] = None, number_of_docs: Optional[int] = 4, pat: Optional[str] = None, token: Optional[str] = None, api_base: Optional[str] = 'https://api.clarifai.com') → None[source]

使用Clarifai客户端进行初始化。

参数:

user_id（可选[str]，可选）：用户ID。默认为None。 app_id（可选[str]，可选）：应用程序ID。默认为None。 pat（可选[str]，可选）：个人访问令牌。默认为None。 token（可选[str]，可选）：会话令牌。默认为None。 number_of_docs（可选[int]，可选）：在向量搜索期间返回的文档数量。默认为None。 api_base（可选[str]，可选）：API基础。默认为None。

引发:

ValueError: 如果未提供用户ID、应用程序ID或个人访问令牌。

Parameters

  • user_id (Optional[str]) –

  • app_id (Optional[str]) –

  • number_of_docs (Optional[int]) –

  • pat (Optional[str]) –

  • token (Optional[str]) –

  • api_base (Optional[str]) –

Return type

None

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, **kwargs: Any) → List[str][source]

将文本添加到Clarifai向量存储中。这将把文本推送到Clarifai应用程序。 应用程序使用一个基本工作流程，为每个文本创建和存储嵌入。 确保您正在使用与文本兼容的基本工作流程（例如语言理解）。

参数：

texts（Iterable[str]）：要添加到向量存储中的文本。 metadatas（Optional[List[dict]，optional）：元数据的可选列表。 ids（Optional[List[str]，optional）：ID的可选列表。

Parameters

  • texts (Iterable[str]) –

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

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

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

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

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

参数：

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]

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

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]

classmethod from_documents(documents: List[Document], embedding: Optional[Embeddings] = None, user_id: Optional[str] = None, app_id: Optional[str] = None, number_of_docs: Optional[int] = None, pat: Optional[str] = None, token: Optional[str] = None, **kwargs: Any) → Clarifai[source]

从文档列表中创建一个Clarifai向量存储。

参数:

user_id (str): 用户ID。 app_id (str): 应用程序ID。 documents (List[Document]): 要添加的文档列表。 number_of_docs (Optional[int]): 在向量搜索期间要返回的文档数量。默认为None。 pat (Optional[str], optional): 个人访问令牌。默认为None。 token (Optional[str], optional): 会话令牌。默认为None。 **kwargs: 要传递给搜索的其他关键字参数。

返回:

Clarifai: Clarifai向量存储。

Parameters

  • documents (List[Document]) –

  • embedding (Optional[Embeddings]) –

  • user_id (Optional[str]) –

  • app_id (Optional[str]) –

  • number_of_docs (Optional[int]) –

  • pat (Optional[str]) –

  • token (Optional[str]) –

  • kwargs (Any) –

Return type

Clarifai

classmethod from_texts(texts: List[str], embedding: Optional[Embeddings] = None, metadatas: Optional[List[dict]] = None, user_id: Optional[str] = None, app_id: Optional[str] = None, number_of_docs: Optional[int] = None, pat: Optional[str] = None, token: Optional[str] = None, **kwargs: Any) → Clarifai[source]

从文本列表创建一个Clarifai向量存储。

参数:

user_id (str): 用户ID。 app_id (str): 应用程序ID。 texts (List[str]): 要添加的文本列表。 number_of_docs (Optional[int]): 在向量搜索期间返回的文档数量。默认为None。 pat (Optional[str], optional): 个人访问令牌。默认为None。 token (Optional[str], optional): 会话令牌。默认为None。 metadatas (Optional[List[dict]]): 元数据的可选列表。默认为None。 **kwargs: 要传递给搜索的其他关键字参数。

返回:

Clarifai: Clarifai向量存储。

Parameters

  • texts (List[str]) –

  • embedding (Optional[Embeddings]) –

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

  • user_id (Optional[str]) –

  • app_id (Optional[str]) –

  • number_of_docs (Optional[int]) –

  • pat (Optional[str]) –

  • token (Optional[str]) –

  • kwargs (Any) –

Return type

Clarifai

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

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

参数：

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]

search(query: str, search_type: str, **kwargs: Any) → List[Document]

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

Parameters

  • query (str) –

  • search_type (str) –

  • kwargs (Any) –

Return type

List[Document]

运行使用Clarifai进行相似性搜索。

参数：

query: 要查找与之相似的文档的文本。 k: 要返回的文档数量。 如果未设置，将使用_number_of_docs。默认为None。

返回：

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

Parameters

  • query (str) –

  • k (Optional[int]) –

  • 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: Optional[int] = None, filters: Optional[dict] = None, **kwargs: Any) → List[Tuple[Document, float]][source]

使用Clarifai运行带有分数的相似性搜索。

参数：

query (str): 要搜索的查询文本。 k (Optional[int]): 要返回的结果数量。如果未设置， 它将取_number_of_docs。默认为None。 filter (Optional[Dict[str, str]]): 按元数据过滤。 默认为None。

返回：

List[Document]: 与查询文本最相似的文档列表。

Parameters

  • query (str) –

  • k (Optional[int]) –

  • filters (Optional[dict]) –

  • kwargs (Any) –

Return type

List[Tuple[Document, float]]

Examples using Clarifai