提示工程快速入门

提示指导着大语言模型 (LLM) 的行为。提示工程是一个过程，涉及精心设计、测试和优化你给予 LLM 的指令，以使其产生可靠且有用的响应。 LangSmith 提供了工具来创建、版本管理、测试和协作处理提示。你还会遇到一些常见概念，例如提示模板，它允许你重用结构化提示，以及变量，它允许你动态地将值（例如用户的问题）插入到提示中。在这个快速入门中，你将使用 UI 或 SDK 来创建、测试和改进提示。本快速入门将以 OpenAI 作为示例 LLM 提供商，但相同的工作流程也适用于其他提供商。

前置条件

在开始之前，请确保你已具备：

一个 LangSmith 账户：在 smith.langchain.com 注册或登录。
一个 LangSmith API 密钥：请按照创建 API 密钥指南操作。
一个 OpenAI API 密钥：从 OpenAI 控制面板生成此密钥。

选择 UI 或 SDK 工作流程的标签页：

1. 设置工作区密钥

在 LangSmith UI 中，确保你的 API 密钥已设置为工作区密钥。

导航至设置，然后进入密钥选项卡。
选择 添加密钥，输入密钥环境变量（例如，OPENAI_API_KEY 或 ANTHROPIC_API_KEY），并将你的 API 密钥作为值填入。
选择 保存密钥。

在 LangSmith UI 中添加工作区密钥时，请确保密钥名称与你的模型提供商所要求的环境变量名称一致。

如果你的提供商使用 OAuth2 client_credentials 进行认证，请改为在模型配置中设置凭据。在这种情况下，无需使用工作区密钥。请参阅 OAuth 客户端凭据。

2. 创建一个提示

在 LangSmith UI 中，导航到左侧菜单中的提示部分。
点击 + 提示来创建一个提示。
通过编辑或添加提示及输入变量来根据需要修改提示。

3. 测试一个提示

在提示标题下，选择模型名称旁边的齿轮图标，这将打开模型配置标签页下的提示设置窗口。
设置你想使用的模型配置。你选择的提供商和模型将决定此配置页面上可配置的参数。设置完成后，点击另存为。
在输入框中指定你想测试的输入变量，然后点击开始。
要了解在 Playground 中配置提示的更多选项，请参考配置提示设置。
测试并优化提示后，点击保存以将其存储供将来使用。

4. 迭代提示

LangSmith 允许基于团队进行提示迭代。工作区成员可以在 Playground 中实验提示，并在准备好时将其更改保存为新的提交。改进你的提示：

参考你的模型提供商提供的文档，了解提示创建的最佳实践，例如：
- 使用 OpenAI API 进行提示工程的最佳实践
- Gemini 的提示设计介绍
使用提示画布（Prompt Canvas）——LangSmith 中的一个交互式工具——来构建和优化你的提示。更多信息请参阅提示画布指南。
为特定提交添加标签，以标记提交历史中的重要时刻。
1. 要创建一个提交，导航到 Playground 并选择提交。选择要提交更改的提示，然后选择提交。
2. 在左侧菜单中导航到提示。选择该提示。在提示详情页，选择右上角的标签以添加提交标签。

1. 设置你的环境

在你的终端中，准备你的环境：

mkdir ls-prompt-quickstart && cd ls-prompt-quickstart
python -m venv .venv
source .venv/bin/activate
pip install -qU langsmith openai langchain_core

mkdir ls-prompt-quickstart-ts && cd ls-prompt-quickstart-ts
npm init -y
npm install langsmith openai typescript ts-node
npx tsc --init

设置你的 API 密钥：

export LANGSMITH_API_KEY='<your_api_key>'
export OPENAI_API_KEY='<your_api_key>'

2. 创建一个提示

要创建一个提示，你需要定义一个你想要的提示消息列表，然后将其推送到 LangSmith。使用特定语言的构造函数和推送方法：

Python: ChatPromptTemplate → client.push_prompt(...)
TypeScript: ChatPromptTemplate.fromMessages(...) → client.pushPrompt(...)

将以下代码添加到一个 create_prompt 文件中：

from langsmith import Client
from langchain_core.prompts import ChatPromptTemplate

client = Client()

prompt = ChatPromptTemplate([
    ("system", "You are a helpful chatbot."),
    ("user", "{question}"),
])

client.push_prompt("prompt-quickstart", object=prompt)

import { Client } from "langsmith";
import { ChatPromptTemplate } from "@langchain/core/prompts";

const client = new Client();

const prompt = ChatPromptTemplate.fromMessages([
["system", "You are a helpful chatbot."],
["user", "{question}"],
]);

await client.pushPrompt("prompt-quickstart", {
object: prompt,
});

这段代码创建了一个有序的消息列表，将其包装在 ChatPromptTemplate 中，然后通过名称将提示推送到你的工作区，以便进行版本控制和重用。

运行 create_prompt：
python create_prompt.py
npx tsx create_prompt.ts
点击结果中的链接，可以在 LangSmith UI 中查看新创建的 Prompt Hub 提示。

3. 测试一个提示

在这个步骤中，你将通过名称（"prompt-quickstart"）拉取你在步骤 2 中创建的提示，使用测试输入对其进行格式化，将其转换为 OpenAI 的聊天格式，并调用 OpenAI Chat Completions API。然后，你将通过创建新版本来迭代该提示。你工作区的成员可以打开现有提示，在 UI 中实验更改，并将这些更改作为同一提示上的新提交保存，这为整个团队保留了历史记录。

将以下内容添加到一个 test_prompt 文件中：

from langsmith import Client
from openai import OpenAI
from langchain_core.messages import convert_to_openai_messages

client = Client()
oai_client = OpenAI()

prompt = client.pull_prompt("prompt-quickstart")

# Since the prompt only has one variable you could also pass in the value directly
# Equivalent to formatted_prompt = prompt.invoke("What is the color of the sky?")
formatted_prompt = prompt.invoke({"question": "What is the color of the sky?"})

response = oai_client.chat.completions.create(
    model="gpt-5.5",
    messages=convert_to_openai_messages(formatted_prompt.messages),
)

import { OpenAI } from "openai";
import { pull } from "langchain/hub"
import { convertPromptToOpenAI } from "@langchain/openai";

const oaiClient = new OpenAI();

const prompt = await pull("prompt-quickstart");

// Format the prompt with the question
const formattedPrompt = await prompt.invoke({ question: "What is the color of the sky?" });

const response = await oaiClient.chat.completions.create({
    model: "gpt-5.5",
    messages: convertPromptToOpenAI(formattedPrompt).messages,
});

这段代码使用 pull 通过名称加载提示，获取你正在测试的提示的最新提交版本。你也可以通过传递提交哈希值 "<prompt-name>:<commit-hash>" 来指定特定提交。

运行 test_prompt：

python test_prompt.py

npx tsx test_prompt.ts

要创建提示的新版本，调用与你最初使用的相同的推送方法，使用相同的提示名称和你更新后的模板。LangSmith 会将其记录为一个新的提交并保留之前的版本。将以下代码复制到一个 iterate_prompt 文件中：

from langsmith import Client
from langchain_core.prompts import ChatPromptTemplate

client = Client()

new_prompt = ChatPromptTemplate([
    ("system", "You are a helpful chatbot. Respond in Spanish."),
    ("user", "{question}"),
])

client.push_prompt("prompt-quickstart", object=new_prompt)

import { Client } from "langsmith";
import { ChatPromptTemplate } from "@langchain/core/prompts";

const client = new Client();

const newPrompt = ChatPromptTemplate.fromMessages([
    ["system", "You are a helpful chatbot. Speak in Spanish."],
    ["user", "{question}"]
]);

await client.pushPrompt("prompt-quickstart", {
    object: newPrompt
});

运行 iterate_prompt：
python iterate_prompt.py
npx tsx iterate_prompt.ts
现在，你的提示将包含两个提交。

改进你的提示：

参考你的模型提供商提供的文档，了解提示创建的最佳实践，例如：
- 使用 OpenAI API 进行提示工程的最佳实践
- Gemini 的提示设计介绍
使用提示画布（Prompt Canvas）——LangSmith 中的一个交互式工具——来构建和优化你的提示。更多信息请参阅提示画布指南。

后续步骤

在创建提示指南中了解更多关于如何使用 Prompt Hub 存储和管理提示的信息。
学习如何设置 Playground 以在此教程中测试多轮对话。
学习如何在数据集上（而非单个示例）测试提示性能，请参考从 Playground 运行评估。

使用 Playground 中的聊天功能来帮助优化你的提示、生成工具以及创建输出模式。

Connect these docs to Claude, VSCode, and more via MCP for real-time answers.

Edit this page on GitHub or file an issue.

Prompts

Context Hub

Tutorials

前置条件

1. 设置工作区密钥

2. 创建一个提示

3. 测试一个提示

4. 迭代提示

1. 设置你的环境

2. 创建一个提示

3. 测试一个提示

后续步骤

​前置条件

​1. 设置工作区密钥

​2. 创建一个提示

​3. 测试一个提示

​4. 迭代提示

​1. 设置你的环境

​2. 创建一个提示

​3. 测试一个提示

​后续步骤

前置条件

1. 设置工作区密钥

2. 创建一个提示

3. 测试一个提示

4. 迭代提示

1. 设置你的环境

2. 创建一个提示

3. 测试一个提示

后续步骤