ClovaX嵌入

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

概览

集成细节

提供者	包
Naver	langchain-naver

设置

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

1. 创建NAVER Cloud Platform账号
2. 应用 CLOVA Studio 开发
3. 创建一个使用模型的CLOVA Studio测试应用或服务应用（请参见这里）。
4. 发布测试或服务API密钥（见这里）。

Credentials

设置CLOVASTUDIO_API_KEY环境变量并输入您的API密钥。

import getpass
import os

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

安装

ClovaXEmbeddings 集成位于 langchain_naver 包中：

# install package
%pip install -qU langchain-naver

Instantiation

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

• CLOVA Studio 提供了多种嵌入模型。请参考此处了解详细信息。
• 请注意，根据您的具体用例，您可能需要对嵌入进行归一化处理。

from langchain_naver import ClovaXEmbeddings

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

索引与检索​

嵌入模型通常用于检索增强生成（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 参考:内存向量存储

'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 操作的文本生成嵌入。

您可以直接调用这些方法，以获取适用于您自身用例的嵌入（embeddings）。

嵌入单个文本​

您可以使用 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 a 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.

API 参考

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

相关

• 嵌入模型 概念指南
• 嵌入模型 使用指南