HuggingFace端点嵌入#

class langchain_huggingface.embeddings.huggingface_endpoint.HuggingFaceEndpointEmbeddings[来源]#

基础类:BaseModel, Embeddings

HuggingFaceHub 嵌入模型。

要使用,您应该安装huggingface_hub python包,并设置环境变量HUGGINGFACEHUB_API_TOKEN为您的API令牌,或者将其作为命名参数传递给构造函数。

示例

from langchain_huggingface import HuggingFaceEndpointEmbeddings
model = "sentence-transformers/all-mpnet-base-v2"
hf = HuggingFaceEndpointEmbeddings(
    model=model,
    task="feature-extraction",
    huggingfacehub_api_token="my-api-key",
)

通过解析和验证来自关键字参数的输入数据来创建一个新模型。

如果输入数据无法验证以形成有效模型,则引发 [ValidationError][pydantic_core.ValidationError]。

self 被显式地设为仅位置参数,以允许 self 作为字段名称。

param huggingfacehub_api_token: str | None [Optional]#
param model: str | None = None#

使用的模型名称。

param model_kwargs: dict | None = None#

传递给模型的关键字参数。

param repo_id: str | None = None#

Huggingfacehub 仓库 ID,用于向后兼容。

param task: str | None = 'feature-extraction'#

用于调用模型的任务。

async aembed_documents(texts: List[str]) List[List[float]][source]#

异步调用HuggingFaceHub的嵌入端点以进行嵌入搜索文档。

Parameters:

文本 (列表[字符串]) – 要嵌入的文本列表。

Returns:

嵌入列表,每个文本对应一个。

Return type:

列表[列表[float]]

async aembed_query(text: str) List[float][source]#

异步调用HuggingFaceHub的嵌入端点以嵌入查询文本。

Parameters:

文本 (str) – 要嵌入的文本。

Returns:

文本的嵌入。

Return type:

列表[float]

embed_documents(texts: List[str]) List[List[float]][source]#

调用HuggingFaceHub的嵌入端点以进行嵌入搜索文档。

Parameters:

文本 (列表[字符串]) – 要嵌入的文本列表。

Returns:

嵌入列表,每个文本对应一个。

Return type:

列表[列表[float]]

embed_query(text: str) List[float][source]#

调用HuggingFaceHub的嵌入端点以嵌入查询文本。

Parameters:

文本 (str) – 要嵌入的文本。

Returns:

文本的嵌入。

Return type:

列表[float]