跳至主要內容

OpenAIEmbeddings

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

總覽

整合細節

供應商套件
OpenAIlangchain-openai

設定

要訪問 OpenAI 嵌入模型,您需要創建一個 OpenAI 帳戶、獲取一個 API 金鑰,並安裝 langchain-openai 整合套件。

憑證

前往 platform.openai.com 註冊 OpenAI 並生成 API 金鑰。 完成後,設置 OPENAI_API_KEY 環境變數

import getpass
import os

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

如果您想獲得模型呼叫的自動追蹤,您也可以通過取消註釋下方來設置您的 LangSmith API 金鑰

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

安裝

LangChain OpenAI 整合位於 langchain-openai 套件中

%pip install -qU langchain-openai

實例化

現在我們可以實例化我們的模型對象並生成聊天完成

from langchain_openai import OpenAIEmbeddings

embeddings = OpenAIEmbeddings(
model="text-embedding-3-large",
# With the `text-embedding-3` class
# of models, you can specify the size
# of the embeddings you want returned.
# dimensions=1024
)
API 參考:OpenAIEmbeddings

索引和檢索

嵌入模型通常用於檢索增強生成 (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
'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.019276829436421394, 0.0037708976306021214, -0.03294256329536438, 0.0037671267054975033, 0.008175

嵌入多個文本

您可以使用 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.019260549917817116, 0.0037612367887049913, -0.03291035071015358, 0.003757466096431017, 0.0082049
[-0.010181212797760963, 0.023419594392180443, -0.04215526953339577, -0.001532090245746076, -0.023573

API 參考

有關 OpenAIEmbeddings 功能和配置選項的詳細文檔,請參閱API 參考文檔


此頁面是否有幫助?