HuggingFace推理API嵌入#

class langchain_community.embeddings.huggingface.HuggingFaceInferenceAPIEmbeddings[source]#

基础类：BaseModel, Embeddings

使用HuggingFace API嵌入文本。

需要一个HuggingFace推理API密钥和一个模型名称。

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

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

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

param additional_headers: Dict[str, str] = {}#: 如果需要，向请求库传递额外的头信息。

param api_key: SecretStr [Required]#: 您的HuggingFace推理API的API密钥。

param api_url: str | None = None#: 自定义推理端点URL。如果为None，则使用默认的公共URL。

param model_name: str = 'sentence-transformers/all-MiniLM-L6-v2'#: 用于文本嵌入的模型名称。

async aembed_documents(texts: list[str]) → list[list[float]]#

异步嵌入搜索文档。

Parameters:: 文本 (列表[字符串]) – 要嵌入的文本列表。
Returns:: 嵌入列表。
Return type:: 列表[列表[浮点数]]

async aembed_query(text: str) → list[float]#

异步嵌入查询文本。

Parameters:: 文本 (str) – 要嵌入的文本。
Returns:: 嵌入。
Return type:: 列表[浮点数]

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

获取一系列文本的嵌入。

Parameters:

文本 (文档) – 要获取嵌入的文本列表。

Returns:

嵌入文本作为List[List[float]]，其中每个内部List[float]: 对应于单个输入文本。

Return type:

列表[列表[float]]

示例

from langchain_community.embeddings import (
    HuggingFaceInferenceAPIEmbeddings,
)

hf_embeddings = HuggingFaceInferenceAPIEmbeddings(
    api_key="your_api_key",
    model_name="sentence-transformers/all-MiniLM-l6-v2"
)
texts = ["Hello, world!", "How are you?"]
hf_embeddings.embed_documents(texts)

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

使用HuggingFace变压器模型计算查询嵌入。

Parameters:: 文本 (str) – 要嵌入的文本。
Returns:: 文本的嵌入。
Return type:: 列表[float]

使用 HuggingFaceInferenceAPIEmbeddings 的示例

Hugging Face