OpenAIEmbeddings
这将帮助您开始使用LangChain的OpenAI嵌入模型。有关OpenAIEmbeddings
功能和配置选项的详细文档,请参阅API参考。
概述
集成详情
提供商 | 包 |
---|---|
OpenAI | langchain-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 Reference: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
API Reference: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.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参考。