ClovaXEmbeddings

本笔记本介绍了如何开始使用 CLOVA Studio 提供的嵌入模型。有关 ClovaXEmbeddings 功能和配置选项的详细文档，请参阅 API 参考。

概述

集成详情

提供商	包
Naver	langchain-community

设置

在使用 CLOVA Studio 提供的嵌入模型之前，您必须完成以下三个步骤。

1. 创建 NAVER Cloud Platform 账户
2. 申请使用 CLOVA Studio
3. 创建要使用的模型的 CLOVA Studio 测试应用或服务应用（请参阅此处。）
4. 颁发测试或服务 API 密钥（请参阅此处。）

凭据

使用您的 API 密钥设置 NCP_CLOVASTUDIO_API_KEY 环境变量。

• 请注意，如果您使用的是旧版 API 密钥（不以 nv-* 前缀开头），您可能需要设置另外两个密钥作为环境变量（NCP_APIGW_API_KEY 和 NCP_CLOVASTUDIO_APP_ID）。它们可以通过点击 App Request Status > Service App, Test App List > CLOVA Studio 中每个应用的 Details 按钮找到。

import getpass
import os

if not os.getenv("NCP_CLOVASTUDIO_API_KEY"):
    os.environ["NCP_CLOVASTUDIO_API_KEY"] = getpass.getpass(
        "Enter NCP CLOVA Studio API Key: "
    )

取消注释以下内容以使用旧版 API 密钥

# if not os.getenv("NCP_APIGW_API_KEY"):
#     os.environ["NCP_APIGW_API_KEY"] = getpass.getpass("Enter NCP API Gateway API Key: ")
# os.environ["NCP_CLOVASTUDIO_APP_ID"] = input("Enter NCP CLOVA Studio App ID: ")

安装

ClovaXEmbeddings 集成位于 langchain_community 包中

# install package
!pip install -U langchain-community

实例化

现在我们可以实例化我们的嵌入对象并嵌入查询或文档

• CLOVA Studio 中有几种可用的嵌入模型。请参阅此处了解更多详情。
• 请注意，您可能需要根据您的具体用例对嵌入进行归一化。

from langchain_community.embeddings import ClovaXEmbeddings

embeddings = ClovaXEmbeddings(
    model="clir-emb-dolphin"  # set with the model name of corresponding app id. Default is `clir-emb-dolphin`
)

API 参考：ClovaXEmbeddings

索引和检索

嵌入模型通常用于检索增强生成 (RAG) 流程中，既作为索引数据的一部分，也用于后续检索数据。有关更详细的说明，请参阅我们的 RAG 教程。

下面，了解如何使用我们上面初始化的 embeddings 对象来索引和检索数据。在此示例中，我们将索引和检索 InMemoryVectorStore 中的示例文档。

# Create a vector store with a sample text
from langchain_core.vectorstores import InMemoryVectorStore

text = "CLOVA Studio is an AI development tool that allows you to customize your own HyperCLOVA X models."

vectorstore = InMemoryVectorStore.from_texts(
    [text],
    embedding=embeddings,
)

# Use the vectorstore as a retriever
retriever = vectorstore.as_retriever()

# Retrieve the most similar text
retrieved_documents = retriever.invoke("What is CLOVA Studio?")

# show the retrieved document's content
retrieved_documents[0].page_content

API 参考：InMemoryVectorStore

'CLOVA Studio is an AI development tool that allows you to customize your own HyperCLOVA X models.'

直接使用

在底层，向量存储和检索器实现正在调用 embeddings.embed_documents(...) 和 embeddings.embed_query(...) 来为 from_texts 和检索 invoke 操作中使用的文本创建嵌入。

您可以直接调用这些方法来获取您自己用例的嵌入。

嵌入单个文本

您可以使用 embed_query 嵌入单个文本或文档

single_vector = embeddings.embed_query(text)
print(str(single_vector)[:100])  # Show the first 100 characters of the vector

[-0.094717406, -0.4077411, -0.5513184, 1.6024436, -1.3235079, -1.0720996, -0.44471845, 1.3665184, 0.

嵌入多个文本

您可以使用 embed_documents 嵌入多个文本

text2 = "LangChain is the framework for building context-aware reasoning applications"
two_vectors = embeddings.embed_documents([text, text2])
for vector in two_vectors:
    print(str(vector)[:100])  # Show the first 100 characters of the vector

[-0.094717406, -0.4077411, -0.5513184, 1.6024436, -1.3235079, -1.0720996, -0.44471845, 1.3665184, 0.
[-0.25525448, -0.84877056, -0.6928286, 1.5867524, -1.2930486, -0.8166254, -0.17934391, 1.4236152, 0.

附加功能

服务应用

当使用 CLOVA Studio 进行生产级应用程序时，您应该申请并使用服务应用。（请参阅此处。）

对于服务应用，您应该使用相应的服务 API 密钥，并且只能使用它进行调用。

# Update environment variables

os.environ["NCP_CLOVASTUDIO_API_KEY"] = getpass.getpass(
    "Enter NCP CLOVA Studio API Key for Service App: "
)
# Uncomment below to use a legacy API key:
os.environ["NCP_CLOVASTUDIO_APP_ID"] = input("Enter NCP CLOVA Studio Service App ID: ")

embeddings = ClovaXEmbeddings(
    service_app=True,
    model="clir-emb-dolphin",  # set with the model name of corresponding app id of your Service App
)

API 参考

有关 ClovaXEmbeddings 功能和配置选项的详细文档，请参阅 API 参考。

相关内容

• 嵌入模型概念指南
• 嵌入模型操作指南