Skip to main content
Open In Colab在 GitHub 上打开

ClovaXEmbeddings

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

概述

集成详细信息

提供商包
Naverlangchain-naver

设置

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

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

凭据

将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

实例

现在我们可以实例化我们的 embeddings 对象和 embed 查询或文档：

  • 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 参考：InMemoryVectorStore
'CLOVA Studio is an AI development tool that allows you to customize your own HyperCLOVA X models.'

直接使用

在后台，vectorstore 和 retriever 实现正在调用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 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 参考。