AzureOpenAIEmbeddings

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

概觀

整合詳細資訊

供應商	套件
AzureOpenAI	langchain-openai

設定

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

憑證

您需要部署 Azure OpenAI 執行個體。您可以依照本指南，在 Azure 入口網站上部署版本。

執行個體執行後，請確認您有執行個體的名稱和金鑰。您可以在 Azure 入口網站的執行個體「金鑰和端點」區段中找到金鑰。

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["LANGSMITH_TRACING"] = "true"
# os.environ["LANGSMITH_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 參考。

相關內容

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