提示工程快速入门

提示（Prompts）指导着大语言模型（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 中添加工作区机密时，请确保机密密钥与模型提供商预期的环境变量名称匹配。

2. 创建提示

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

3. 测试提示

在 Prompts 标题下，选择模型名称旁边的齿轮图标，这将打开 Prompt Settings 窗口并定位到 Model Configuration 标签页。
设置你想要使用的模型配置。你选择的 Provider 和 Model 将决定此配置页面上可配置的参数。设置完成后，点击 Save as。
在 Inputs 框中指定你想要测试的输入变量，然后点击 Start。
要了解在 Playground 中配置提示的更多选项，请参阅配置提示设置。
测试并完善你的提示后，点击 Save 以保存供将来使用。

4. 迭代提示

LangSmith 支持基于团队的提示迭代。工作区成员可以在 Playground 中试验提示，并在准备好时将他们的更改保存为新的提交。要改进你的提示：

参考你的模型提供商提供的文档，了解提示创建的最佳实践，例如：
- OpenAI API 提示工程最佳实践
- Gemini 的提示设计简介
使用 LangSmith 中的交互式工具 Prompt Canvas 来构建和完善你的提示。在 Prompt Canvas 指南中了解更多信息。
标记特定的提交，以在你的提交历史中标记重要时刻。
1. 要创建提交，请导航到 Playground 并选择 Commit。选择要提交更改的提示，然后点击 Commit。
2. 导航到左侧菜单中的 Prompts。选择提示。在提示详情页面上，选择右上角的 Tag 来添加提交标签。

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")

# 由于提示只有一个变量，你也可以直接传入值
# 等同于 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-4.1",
    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");

// 用问题格式化提示
const formattedPrompt = await prompt.invoke({ question: "What is the color of the sky?" });

const response = await oaiClient.chat.completions.create({
    model: "gpt-4.1",
    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 的提示设计简介
使用 LangSmith 中的交互式工具 Prompt Canvas 来构建和完善你的提示。在 Prompt Canvas 指南中了解更多信息。

后续步骤

在创建提示指南中了解如何使用 Prompt Hub 存储和管理提示。
在本教程中学习如何设置 Playground 以测试多轮对话。
要了解如何针对数据集而非单个示例测试提示的性能，请参阅从 Playground 运行评估。

在 Playground 中使用 Polly 来帮助优化你的提示、生成工具和创建输出模式。

Edit this page on GitHub or file an issue.

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

Create and update prompts

Tutorials

先决条件

1. 设置工作区密钥

2. 创建提示

3. 测试提示

4. 迭代提示

1. 设置环境

2. 创建提示

3. 测试提示

后续步骤

​先决条件

​1. 设置工作区密钥

​2. 创建提示

​3. 测试提示

​4. 迭代提示

​1. 设置环境

​2. 创建提示

​3. 测试提示

​后续步骤

先决条件

1. 设置工作区密钥

2. 创建提示

3. 测试提示

4. 迭代提示

1. 设置环境

2. 创建提示

3. 测试提示

后续步骤