langchain_huggingface.embeddings.huggingface.HuggingFaceEmbeddings

class langchain_huggingface.embeddings.huggingface.HuggingFaceEmbeddings[source]

基础：BaseModel，Embeddings

HuggingFace 的句子转换器嵌入模型。

要使用，您应该已安装 sentence_transformers Python 扩展包。

示例

from langchain_huggingface import HuggingFaceEmbeddings

model_name = "sentence-transformers/all-mpnet-base-v2"
model_kwargs = {'device': 'cpu'}
encode_kwargs = {'normalize_embeddings': False}
hf = HuggingFaceEmbeddings(
    model_name=model_name,
    model_kwargs=model_kwargs,
    encode_kwargs=encode_kwargs
)

初始化句子转换器。

param cache_folder: Optional[str] = None

存储模型的路径。也可以通过 SENTENCE_TRANSFORMERS_HOME 环境变量来设置。

param encode_kwargs: Dict[str, Any] [Optional]

调用 Sentence Transformer 模型的 encode 方法时要传递的键值参数，例如 prompt_name、prompt、batch_size、precision、normalize_embeddings 等。也请参见 Sentence Transformer 文档：[https://sbert.net/docs/package_reference/SentenceTransformer.html#sentence_transformers.SentenceTransformer.encode](https://sbert.net/docs/package_reference/SentenceTransformer.html#sentence_transformers.SentenceTransformer.encode)

param model_kwargs: Dict[str, Any] [Optional]

传递给 Sentence Transformer 模型的键值参数，例如 device、prompts、default_prompt_name、revision、trust_remote_code 或 token。也请参见 Sentence Transformer 文档：[https://sbert.net/docs/package_reference/SentenceTransformer.html#sentence_transformers.SentenceTransformer](https://sbert.net/docs/package_reference/SentenceTransformer.html#sentence_transformers.SentenceTransformer)

param model_name: str = 'sentence-transformers/all-mpnet-base-v2'

要使用的模型名称。

param multi_process: bool = False

在多个 GPU 上运行 encode()。

param show_progress: bool = False

是否显示进度条。

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

异步嵌入搜索文档。

参数

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

返回

嵌入列表。

返回类型

列表[列表[浮点数]]

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

异步嵌入查询文本。

参数

text (字符串) – 要嵌入的文本。

返回

嵌入。

返回类型

列表[浮点数]

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

使用 HuggingFace Transformer 模型计算文档嵌入。

参数

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

返回

为每个文本生成一个嵌入列表。

返回类型

列表[列表[浮点数]]

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

使用 HuggingFace Transformer 模型计算查询嵌入。

参数

text (字符串) – 要嵌入的文本。

返回

文本的嵌入。

返回类型

列表[浮点数]

使用 HuggingFaceEmbeddings 的示例