`langchain_community.embeddings.huggingface_hub`.HuggingFaceHubEmbeddings¶

class langchain_community.embeddings.huggingface_hub.HuggingFaceHubEmbeddings[source]¶

基础：BaseModel，Embeddings

自版本 0.2.2 起已弃用：请使用 langchain_huggingface.HuggingFaceEndpointEmbeddings 代替。

HuggingFaceHub 嵌入模型。

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

示例

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

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

如果输入数据无法被解析为有效的模型，将引发 ValidationError。

paramhuggingfacehub_api_token: Optional[str] = None¶

parammodel: Optional[str] = None¶: 要使用的模型名称。

parammodel_kwargs: Optional[dict] = None¶: 传递给模型的关键字参数。

paramrepo_id: Optional[str] = None¶: Huggingfacehub 存储库 id，用于向后兼容。

paramtask: Optional[str] = 'feature-extraction'¶: 要调用模型的任务。

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

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

参数: texts (列表[字符串]) – 要嵌入的文本列表。
返回: 每个文本一个嵌入列表。
返回类型: 列表[列表[浮点数]]

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

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

参数: text (字符串) – 要嵌入的文本。
返回: 文本的嵌入。
返回类型: 列表[浮点数]

embed_documents(texts: List[str]) → List[List[float]][source]¶

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

参数: texts (列表[字符串]) – 要嵌入的文本列表。
返回: 每个文本一个嵌入列表。
返回类型: 列表[列表[浮点数]]

embed_query(text: str) → List[float][source]¶

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

参数: text (字符串) – 要嵌入的文本。
返回: 文本的嵌入。
返回类型: 列表[浮点数]

使用HuggingFaceHubEmbeddings的示例¶

Hugging Face

langchain_community.embeddings.huggingface_hub.HuggingFaceHubEmbeddings¶

使用HuggingFaceHubEmbeddings的示例¶

`langchain_community.embeddings.huggingface_hub`.HuggingFaceHubEmbeddings¶