ClovaXEmbeddings
本笔记本介绍了如何开始使用CLOVA Studio提供的嵌入模型。有关ClovaXEmbeddings功能和配置选项的详细文档，请参阅API参考。
概述
集成详情
| 提供商 | 包 |
|---|---|
| Naver | langchain-community |
设置
在使用CLOVA Studio提供的嵌入模型之前，您必须完成以下三个步骤。
- 创建NAVER Cloud Platform账户
- 申请使用 CLOVA Studio
- 创建CLOVA Studio测试应用或服务应用后查找API密钥（参见这里。）
凭证
CLOVA Studio 需要3个密钥（NCP_CLOVASTUDIO_API_KEY、NCP_APIGW_API_KEY 和 NCP_CLOVASTUDIO_APP_ID）用于嵌入。
NCP_CLOVASTUDIO_API_KEY和NCP_CLOVASTUDIO_APP_ID是为每个 serviceApp 或 testApp 颁发的NCP_APIGW_API_KEY每个账户都会发放
两个API密钥可以通过在CLOVA Studio中点击App Request Status > Service App, Test App List > ‘Details’ button for each app找到。
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: "
)
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`
# app_id="..." # set if you prefer to pass app id directly instead of using environment variables
)
索引与检索
嵌入模型通常用于检索增强生成（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
'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上线生产级应用程序时，您应该申请并使用服务应用程序。（参见这里。）
对于服务应用，会颁发相应的NCP_CLOVASTUDIO_API_KEY和NCP_CLOVASTUDIO_APP_ID，并且只能使用它们进行调用。
# Update environment variables
os.environ["NCP_CLOVASTUDIO_API_KEY"] = getpass.getpass(
"Enter NCP CLOVA Studio API Key for Service App: "
)
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
# app_id="..." # set if you prefer to pass app id directly instead of using environment variables
)
API 参考
有关ClovaXEmbeddings功能和配置选项的详细文档，请参阅API参考。