OpenVINOBgeEmbeddings#

class langchain_community.embeddings.openvino.OpenVINOBgeEmbeddings[source]#

基础类：OpenVINOEmbeddings

OpenVNO BGE 嵌入模型。

Bge Example:

from langchain_community.embeddings import OpenVINOBgeEmbeddings

model_name = "BAAI/bge-large-en-v1.5"
model_kwargs = {'device': 'CPU'}
encode_kwargs = {'normalize_embeddings': True}
ov = OpenVINOBgeEmbeddings(
    model_name_or_path=model_name,
    model_kwargs=model_kwargs,
    encode_kwargs=encode_kwargs
)

初始化 sentence_transformer。

param embed_instruction: str = ''#: 用于嵌入文档的说明。

param encode_kwargs: Dict[str, Any] [Optional]#: 调用模型的encode方法时要传递的关键字参数。

param model_kwargs: Dict[str, Any] [Optional]#: 传递给模型的关键字参数。

param model_name_or_path: str [Required]#: HuggingFace 模型 ID。

param ov_model: Any = None#: OpenVINO 模型对象。

param query_instruction: str = 'Represent this question for searching relevant passages: '#: 用于嵌入查询的说明。

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

param tokenizer: Any = None#: 嵌入模型的分词器。

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]#

使用HuggingFace变压器模型计算文档嵌入。

Parameters:: 文本 (列表[字符串]) – 要嵌入的文本列表。
Returns:: 嵌入列表，每个文本对应一个。
Return type:: 列表[列表[float]]

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

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

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

encode(sentences: Any, batch_size: int = 4, show_progress_bar: bool = False, convert_to_numpy: bool = True, convert_to_tensor: bool = False, mean_pooling: bool = False, normalize_embeddings: bool = True) → Any#

计算句子嵌入。

Parameters:

sentences (任何) – 要嵌入的句子。
batch_size (int) – 用于计算的批量大小。
show_progress_bar (bool) – 是否输出进度条。
convert_to_numpy (bool) – 输出是否应为numpy向量的列表。
convert_to_tensor (bool) – 输出是否应该是一个大的张量。
mean_pooling (bool) – 是否对返回的向量进行池化。
normalize_embeddings (bool) – 是否对返回的向量进行归一化。

Returns:

默认情况下，一个形状为 [num_inputs, output_dimension] 的二维 numpy 数组。

Return type:

任何

save_model(model_path: str) → bool#

Parameters:: model_path (str)
Return type:: 布尔

使用 OpenVINOBgeEmbeddings 的示例

OpenVINO