这将帮助您开始使用 LangChain 与 Perplexity 嵌入模型。如需获取详细文档 PerplexityEmbeddings 功能和配置选项,请参阅 API 参考.
概述
集成详情
| 类 | 包 | 本地 | Py 支持 | 包下载量 | 包最新版本 |
|---|---|---|---|---|---|
PerplexityEmbeddings | langchain-perplexity | ❌ | ✅ | !PyPI - 下载量 | !PyPI - 版本 |
设置
要访问 Perplexity 嵌入模型,您需要创建一个 Perplexity 账户,获取 API 密钥,并安装 langchain-perplexity 集成包。
凭证
前往 https://www.perplexity.ai/account/api/keys 注册 Perplexity API 并生成 API 密钥。完成此操作后,设置 PPLX_API_KEY (or PERPLEXITY_API_KEY) 环境变量:
if not os.getenv("PPLX_API_KEY"):
os.environ["PPLX_API_KEY"] = getpass.getpass("Enter your Perplexity API key: ")
要启用模型调用的自动追踪功能,请设置您的 LangSmith API 密钥:
os.environ["LANGSMITH_TRACING"] = "true"
os.environ["LANGSMITH_API_KEY"] = getpass.getpass("Enter your LangSmith API key: ")
安装
LangChain Perplexity 集成位于 langchain-perplexity package:
pip install -qU langchain-perplexity
实例化
现在我们可以实例化嵌入模型对象并生成嵌入:
from langchain_perplexity import PerplexityEmbeddings
embeddings = PerplexityEmbeddings(
model="pplx-embed-v1-4b",
# api_key="...", # if you prefer to pass the key explicitly
# request_timeout=60,
# max_retries=6,
)
可用模型包括 pplx-embed-v1-4b (默认)和 pplx-embed-v1-0.6b。请参阅 Perplexity Embeddings API 参考 获取当前列表和维度。
索引和检索
嵌入模型通常用于检索增强生成(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
嵌入多个文本
您可以使用以下方式嵌入多个文本 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
异步使用
PerplexityEmbeddings 也公开了异步方法:
single_vector = await embeddings.aembed_query(text)
two_vectors = await embeddings.aembed_documents([text, text2])
API 参考
有关详细的文档,请参阅 PerplexityEmbeddings 功能和配置选项,请参阅 API 参考 以及 Perplexity Embeddings API 文档.