langchain_community.embeddings.clova.ClovaEmbeddings

class langchain_community(embeddings.clova.ClovaEmbeddings[source]

基础:BaseModelEmbeddings

Clova的嵌入服务。

要使用此服务,

您需要设置以下环境变量,使用API令牌和应用程序ID,或者将它们作为命名参数传递给构造函数

  • CLOVA_EMB_API_KEY:访问Clova嵌入服务的API令牌。

  • CLOVA_EMB_APIGW_API_KEY:增强安全的API网关密钥。

  • CLOVA_EMB_APP_ID:用于识别您的应用程序的应用程序ID。

示例

from langchain_community.embeddings import ClovaEmbeddings
embeddings = ClovaEmbeddings(
    clova_emb_api_key='your_clova_emb_api_key',
    clova_emb_apigw_api_key='your_clova_emb_apigw_api_key',
    app_id='your_app_id'
)

query_text = "This is a test query."
query_result = embeddings.embed_query(query_text)

document_text = "This is a test document."
document_result = embeddings.embed_documents([document_text])

通过解析和验证从关键词参数中获取的输入数据来创建一个新的模型。

如果输入数据无法解析为有效模型,将引发ValidationError。

参数 app_id: Optional[SecretStr] = None

用于识别您的应用程序的应用程序ID。

约束条件
  • 类型 = 字符串

  • 只写 = True

  • 格式 = 密码

参数 clova_emb_api_key: Optional[SecretStr] = None

访问Clova嵌入服务的API令牌。

约束条件
  • 类型 = 字符串

  • 只写 = True

  • 格式 = 密码

参数 clova_emb_apigw_api_key: Optional[SecretStr] = None

增强安全的API网关密钥。

约束条件
  • 类型 = 字符串

  • 只写 = True

  • 格式 = 密码

参数 endpoint_url: str = 'https://clovastudio.apigw.ntruss.com/testapp/v1/api-tools/embedding'

要使用的端点URL。

参数 model: str = 'clir-emb-dolphin'

要使用的嵌入模型名称。

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

异步嵌入搜索文档。

参数

texts (List[str]) – 要嵌入的文字列表。

返回

嵌入列表。

返回类型

List[List[float]]

async aembed_query(text: str) List[float]

异步嵌入查询文本。

参数

text (str) – 要嵌入的文本。

返回

嵌入。

返回类型

List[float]

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

嵌入一系列文本并返回其嵌入向量。

参数

texts (List[str]) – 要嵌入的文本列表。

返回

每个文本的嵌入向量列表。

返回类型

List[List[float]]

embed_query(text: str) List[float]

嵌入单个查询文本并返回其嵌入向量。

参数

text (str) – 要嵌入的文本。

返回

文本的嵌入向量。

返回类型

List[float]

使用 ClovaEmbeddings 的示例