Embaas嵌入#

class langchain_community.embeddings.embaas.EmbaasEmbeddings[source]#

基础类:BaseModel, Embeddings

Embaas的嵌入服务。

要使用,您应该设置环境变量 EMBAAS_API_KEY 为您的API密钥,或者将其作为命名参数传递给构造函数。

示例

# initialize with default model and instruction
from langchain_community.embeddings import EmbaasEmbeddings
emb = EmbaasEmbeddings()

# initialize with custom model and instruction
from langchain_community.embeddings import EmbaasEmbeddings
emb_model = "instructor-large"
emb_inst = "Represent the Wikipedia document for retrieval"
emb = EmbaasEmbeddings(
    model=emb_model,
    instruction=emb_inst
)

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

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

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

param api_url: str = 'https://api.embaas.io/v1/embeddings/'#

embaas嵌入API的URL。

param embaas_api_key: SecretStr | None = None#

请求的最大重试次数

param instruction: str | None = None#

用于领域特定嵌入的指令。

param max_retries: int | None = 3#

请求超时时间(秒)

param model: str = 'e5-large-v2'#

用于嵌入的模型。

param timeout: int | None = 30#
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:

嵌入列表,每个文本对应一个。

Return type:

列表[列表[float]]

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

获取单个文本的嵌入。

Parameters:

文本 (str) – 要获取嵌入的文本。

Returns:

嵌入列表。

Return type:

列表[float]

classmethod validate_environment(values: Dict) Dict[来源]#

验证环境中是否存在API密钥和Python包。

Parameters:

(字典)

Return type:

字典

使用 EmbaasEmbeddings 的示例