`langchain_community.embeddings.huggingface`.HuggingFaceBgeEmbeddings¶

class langchain_community.embeddings.huggingface.HuggingFaceBgeEmbeddings[source]¶

基础：BaseModel，Embeddings

HuggingFace的sentence_transformers嵌入模型。

使用时，您应该安装好了sentence_transformers Python包。要使用Nomic，请确保sentence_transformers的版本 >= 2.3.0。

Bge 示例

from langchain_community.embeddings import HuggingFaceBgeEmbeddings

model_name = "BAAI/bge-large-en"
model_kwargs = {'device': 'cpu'}
encode_kwargs = {'normalize_embeddings': True}
hf = HuggingFaceBgeEmbeddings(
    model_name=model_name,
    model_kwargs=model_kwargs,
    encode_kwargs=encode_kwargs
)

Nomic 示例

from langchain_community.embeddings import HuggingFaceBgeEmbeddings

model_name = "nomic-ai/nomic-embed-text-v1"
model_kwargs = {
    'device': 'cpu',
    'trust_remote_code':True
    }
encode_kwargs = {'normalize_embeddings': True}
hf = HuggingFaceBgeEmbeddings(
    model_name=model_name,
    model_kwargs=model_kwargs,
    encode_kwargs=encode_kwargs,
    query_instruction = "search_query:",
    embed_instruction = "search_document:"
)

初始化 sentence_transformer。

param cache_folder: Optional[str] = None¶: 存储模型的路径。也可以通过SETENTENCE.Transformers.EXT环境变量设置。

param embed_instruction: str = ''¶: 用于嵌入文档的指令。

param encode_kwargs: Dict[str, Any] [Optional]¶: 调用模型的encode方法时传递的键值对。

param model_kwargs: Dict[str, Any] [Optional]¶: 传递给模型的键值对。

param model_name: str = 'BAAI/bge-large-en'¶: 要使用的模型名称。

param query_instruction: str = 'Represent this question for searching relevant passages: '¶: 用于嵌入查询的指令。

param show_progress: bool = False¶: 是否显示进度条。

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

异步嵌入文档搜索。

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

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

异步嵌入查询文本。

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

embed_documents(texts: List[str]) → List[List[float]][源代码]¶

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

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

embed_query(text: str) → List[float][源代码]¶

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

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

示例使用 HuggingFaceBgeEmbeddings¶

langchain_community.embeddings.huggingface.HuggingFaceBgeEmbeddings¶

示例使用 HuggingFaceBgeEmbeddings¶

`langchain_community.embeddings.huggingface`.HuggingFaceBgeEmbeddings¶