Skip to main content

以编程方式管理提示词

您可以使用 LangSmith Python 和 TypeScript SDK 来以编程方式管理提示词。

注意

此前，此功能位于 langchainhub 包中，该包现已弃用。 未来所有功能都将位于 langsmith 包中。

安装软件包​

在 Python 中，您可以直接使用 LangSmith SDK（推荐，功能完整），或者通过 LangChain 包使用（仅限于推送和拉取提示）。

在 TypeScript 中，您必须使用 LangChain npm 包来拉取提示（它也支持推送）。对于所有其他功能，请使用 LangSmith 包。

pip install -U langsmith 
# version >= 0.1.99

配置环境变量​

如果您已经为当前工作区的 API 密钥在 LangSmith 中设置了LANGSMITH_API_KEY，您可以跳过此步骤。

否则，通过导航到 LangSmith 中的Settings > API Keys > Create API Key为您的工作区获取 API 密钥。

设置您的环境变量。

export LANGSMITH_API_KEY="lsv2_..."
术语

我们所说的“提示词”（prompts）过去被称为“仓库”（repos），因此代码中任何对“仓库”（repo）的引用都是指一个提示词。

推送提示​

要创建新提示或更新现有提示，您可以使用 push prompt 方法。

from langsmith import Client
from langchain_core.prompts import ChatPromptTemplate

client = Client()

prompt = ChatPromptTemplate.from_template("tell me a joke about {topic}")
url = client.push_prompt("joke-generator", object=prompt)
# url is a link to the prompt in the UI
print(url)

您也可以将提示词作为提示词和模型的 RunnableSequence 进行推送。 这对于存储您希望与此提示词一起使用的模型配置非常有用。 该提供商必须得到 LangSmith 工作台的认可。（请参阅此处设置：支持的提供商）

from langsmith import Client
from langchain_core.prompts import ChatPromptTemplate
from langchain_openai import ChatOpenAI

client = Client()
model = ChatOpenAI(model="gpt-4o-mini")

prompt = ChatPromptTemplate.from_template("tell me a joke about {topic}")
chain = prompt | model

client.push_prompt("joke-generator-with-model", object=chain)

获取提示​

要获取提示词，您可以使用pull prompt方法，该方法将返回一个作为 LangChain PromptTemplate的提示词。

要获取私有提示，您无需指定所有者句柄（如果您已设置，也可以指定）。

要从 LangChain Hub 获取公共提示词，您需要指定提示词作者的句柄（handle）。

from langsmith import Client
from langchain_openai import ChatOpenAI

client = Client()

prompt = client.pull_prompt("joke-generator")
model = ChatOpenAI(model="gpt-4o-mini")

chain = prompt | model
chain.invoke({"topic": "cats"})

与推送提示词类似，您也可以将提示词作为包含提示词和模型的 RunnableSequence 拉取出来。 只需在拉取提示词时指定 include_model 参数。 如果存储的提示词中已包含模型，它将以 RunnableSequence 的形式返回。 请确保您已为所使用的模型设置了正确的环境变量。

from langsmith import Client

client = Client()
chain = client.pull_prompt("joke-generator-with-model", include_model=True)
chain.invoke({"topic": "cats"})

在拉取提示词时，您还可以指定特定的提交哈希或 提示词标签 以拉取特定版本的提示词。

prompt = client.pull_prompt("joke-generator:12344e88")

要从 LangChain Hub 获取公共提示词，您需要指定该提示词作者的标识符。

prompt = client.pull_prompt("efriis/my-first-prompt")
JavaScript 用户重要提示

对于拉取提示词，如果您正在使用 Node.js 或支持动态导入的环境，我们建议使用 langchain/hub/node 入口点，因为它会自动处理与您提示词配置关联的模型的反序列化。

如果您处于非 Node 环境，\"includeModel\" 不支持非 OpenAI 模型，您应使用基础的 langchain/hub 入口点。

使用不带 LangChain 的提示词​

如果您希望将提示词存储在 LangSmith 中，但直接使用模型提供商的 API，可以使用我们的转换方法。 这些方法会将您的提示词转换为 OpenAI 或 Anthropic API 所需的负载格式。

这些转换方法依赖于 LangChain 集成包内部的逻辑，除了您选择的官方 SDK 外，您还需要安装相应的包作为依赖项。以下是一些示例：

OpenAI​

pip install -U langchain_openai
from openai import OpenAI

from langsmith.client import Client, convert_prompt_to_openai_format

# langsmith client
client = Client()

# openai client
oai_client = OpenAI()

# pull prompt and invoke to populate the variables
prompt = client.pull_prompt("joke-generator")
prompt_value = prompt.invoke({"topic": "cats"})

openai_payload = convert_prompt_to_openai_format(prompt_value)
openai_response = oai_client.chat.completions.create(**openai_payload)

Anthropic​

pip install -U langchain_anthropic
from anthropic import Anthropic

from langsmith.client import Client, convert_prompt_to_anthropic_format

# langsmith client
client = Client()
# anthropic client
anthropic_client = Anthropic()
# pull prompt and invoke to populate the variables
prompt = client.pull_prompt("joke-generator")
prompt_value = prompt.invoke({"topic": "cats"})
anthropic_payload = convert_prompt_to_anthropic_format(prompt_value)
anthropic_response = anthropic_client.messages.create(**anthropic_payload)

列出、删除和点赞提示​

您还可以使用 list prompts、delete prompt、like prompt 和 unlike prompt 方法列出、删除或点赞/取消点赞提示词。 有关这些方法的详细文档，请参阅 LangSmith SDK 客户端。

# List all prompts in my workspace
prompts = client.list_prompts()
# List my private prompts that include "joke"
prompts = client.list_prompts(query="joke", is_public=False)
# Delete a prompt
client.delete_prompt("joke-generator")
# Like a prompt
client.like_prompt("efriis/my-first-prompt")
# Unlike a prompt
client.unlike_prompt("efriis/my-first-prompt")

此页面有帮助吗？


您可以留下详细的反馈 在 GitHub 上。