langchain_huggingface.embeddings.huggingface_endpoint
.HuggingFaceEndpointEmbeddings¶
- class langchain_huggingface.embeddings.huggingface_endpoint.HuggingFaceEndpointEmbeddings[source]¶
基础类:
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。
- 参数 huggingfacehub_api_token: Optional[str] = None¶
- 参数 model: Optional[str] = None¶
要使用的模型名称。
- 参数 model_kwargs: Optional[dict] = None¶
传递给模型的键值对参数。
- 参数 repo_id: Optional[str] = None¶
Huggingfacehub仓库ID,用于向后兼容。
- 参数 task: Optional[str] = 'feature-extraction'¶
调用模型时要执行的任务。
- async aembed_documents(texts: List[str]) List[List[float]] [来源]¶
对HuggingFaceHub的嵌入端点进行异步调用,以嵌入搜索文档。
- 参数
texts (List[str]) – 要嵌入的文本列表。
- 返回
嵌入列表,每个文本一个。
- 返回类型
List[List[float]]
- async aembed_query(text: str) List[float] [来源]¶
对HuggingFaceHub的嵌入端点进行异步调用,以嵌入查询文本。
- 参数
text (str) – 要嵌入的文本。
- 返回
文本的嵌入。
- 返回类型
List[float]