Clova嵌入#

class langchain_community.embeddings.clova.ClovaEmbeddings[source]#

基础类：BaseModel, Embeddings

自版本0.3.4起已弃用：请改用:class:`~langchain_community.ClovaXEmbeddings`。在langchain-community==1.0.0之前不会移除。

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][pydantic_core.ValidationError]。

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

param app_id: SecretStr | None = None#: 用于识别您的应用程序的应用程序ID。

param clova_emb_api_key: SecretStr | None = None#: 用于访问Clova嵌入服务的API密钥。

param clova_emb_apigw_api_key: SecretStr | None = None#: 用于增强安全性的API网关密钥。

param endpoint_url: str = 'https://clovastudio.apigw.ntruss.com/testapp/v1/api-tools/embedding'#: 使用的端点URL。

param model: str = 'clir-emb-dolphin'#: 使用的嵌入模型名称。

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][来源]#

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

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

使用 ClovaEmbeddings 的示例

Clova Embeddings