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）。您可以在 CLOVA Studio 中，按一下每個應用程式的 應用程式請求狀態 > 服務應用程式、測試應用程式清單 > 詳細資訊 按鈕找到它們。

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 參考。

相關內容

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