AzureOpenAIEmbeddings

這將幫助您開始使用 LangChain 的 AzureOpenAI 嵌入模型。 有關 AzureOpenAIEmbeddings 功能和配置選項的詳細文件，請參閱 API 參考文件。

概述

整合細節

供應商	套件
AzureOpenAI	langchain-openai

設定

若要存取 AzureOpenAI 嵌入模型，您需要建立 Azure 帳戶、取得 API 金鑰，並安裝 langchain-openai 整合套件。

憑證

您需要部署一個 Azure OpenAI 實例。 您可以按照此指南在 Azure Portal 上部署一個版本。

執行您的實例後，請確保您擁有實例的名稱和金鑰。 您可以在 Azure Portal 的實例「金鑰和端點」部分找到金鑰。

AZURE_OPENAI_ENDPOINT=<YOUR API ENDPOINT>
AZURE_OPENAI_API_KEY=<YOUR_KEY>
AZURE_OPENAI_API_VERSION="2024-02-01"

import getpass
import os

if not os.getenv("AZURE_OPENAI_API_KEY"):
    os.environ["AZURE_OPENAI_API_KEY"] = getpass.getpass(
        "Enter your AzureOpenAI API key: "
    )

如果您想要取得模型呼叫的自動追蹤，您也可以取消註解以下程式碼，以設定您的 LangSmith API 金鑰

# os.environ["LANGCHAIN_TRACING_V2"] = "true"
# os.environ["LANGCHAIN_API_KEY"] = getpass.getpass("Enter your LangSmith API key: ")

安裝

LangChain AzureOpenAI 整合存在於 langchain-openai 套件中

%pip install -qU langchain-openai

實例化

現在我們可以實例化我們的模型物件並產生聊天完成

from langchain_openai import AzureOpenAIEmbeddings

embeddings = AzureOpenAIEmbeddings(
    model="text-embedding-3-large",
    # dimensions: Optional[int] = None, # Can specify dimensions with new text-embedding-3 models
    # azure_endpoint="https://<your-endpoint>.openai.azure.com/", If not provided, will read env variable AZURE_OPENAI_ENDPOINT
    # api_key=... # Can provide an API key directly. If missing read env variable AZURE_OPENAI_API_KEY
    # openai_api_version=..., # If not provided, will read env variable AZURE_OPENAI_API_VERSION
)

API 參考：AzureOpenAIEmbeddings

索引和檢索

嵌入模型通常用於檢索增強生成 (RAG) 流程中，作為索引數據的一部分以及稍後檢索數據的一部分。 有關更詳細的說明，請參閱我們的 RAG 教學課程。

以下是如何使用我們上面初始化的 embeddings 物件來索引和檢索資料。 在此範例中，我們將在 InMemoryVectorStore 中索引和檢索範例文件。

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

text = "LangChain is the framework for building context-aware reasoning applications"

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 LangChain?")

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

API 參考：InMemoryVectorStore

'LangChain is the framework for building context-aware reasoning applications'

直接使用

在幕後，向量儲存庫和檢索器實作正在呼叫 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.0011676070280373096, 0.007125577889382839, -0.014674457721412182, -0.034061674028635025, 0.01128

嵌入多個文字

您可以使用 embed_documents 嵌入多個文字

text2 = (
    "LangGraph is a library for building stateful, multi-actor applications with LLMs"
)
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.0011966148158535361, 0.007160289213061333, -0.014659193344414234, -0.03403077274560928, 0.011280
[-0.005595256108790636, 0.016757294535636902, -0.011055258102715015, -0.031094247475266457, -0.00363

API 參考

有關 AzureOpenAIEmbeddings 功能和配置選項的詳細文件，請參閱 API 參考文件。

相關

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