提示工程快速入门

提示引导大型语言模型（LLM）的行为。提示工程 是一个创建、测试和优化您提供给 LLM 指令的过程，以便它产生可靠且有用的响应。

LangSmith 提供了创建、版本控制、测试和协作编写提示的工具。您还会遇到一些常见概念，如 提示模板，它允许您重复使用结构化提示，以及 变量，它允许您将值（例如用户的问题）动态插入到提示中。

在这个快速入门教程中，您将使用UI或SDK创建、测试和改进提示。本快速入门教程将以OpenAI作为示例LLM提供商，但相同的流程也适用于其他提供商。

如果您更喜欢观看关于如何开始提示工程的视频，请参考快速入门视频指南。

前提条件

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

• LangSmith账户：在smith.langchain.com注册或登录。
• LangSmith API密钥：遵循创建API密钥指南。
• OpenAI API密钥：从OpenAI仪表板生成此密钥。

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

用户界面

1. 设置工作区密钥

2. 创建提示

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

3. 测试一个提示

1. 在提示标题下，选择模型名称旁边的齿轮 图标，这将启动提示设置窗口，位于模型配置选项卡上。
2. 设置您想使用的模型配置。您选择的提供者和模型将决定此配置页面上可配置的参数。设置完成后，点击另存为。

在输入框中指定您要测试的输入变量，然后点击开始。

要了解在Playground中配置提示符的更多选项，请参阅配置提示符设置。

在测试和优化您的提示后，点击保存以将其存储以供将来使用。

4. 在提示上迭代

LangSmith 允许基于团队的提示迭代。工作区 成员可以在游乐场中尝试提示，并在准备好时将其更改保存为新的 提交。

为了提升您的提示：

• 参考您模型提供商提供的文档，了解提示创建的最佳实践，例如：
  • 使用 OpenAI API 的提示工程最佳实践
  • Gemini 的提示设计入门
• 使用 LangSmith 中的提示画布构建和优化您的提示——这是一个交互式工具。更多了解请参阅提示画布指南。
• 标记特定的提交以标记提交历史中的重要时刻。
  1. 要创建提交，导航到 Playground 并选择 Commit。选择要提交更改的提示，然后 Commit。
  2. 导航到左侧菜单中的 Prompts。选择提示。一旦进入提示的详细页面，切换到 Commits 选项卡。找到标签图标 以 添加提交标签。

SDK

1. 设置您的环境

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

Python

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

1. Set your API keys:

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

2. Create a prompt

To create a prompt, you’ll define a list of messages that you want in your prompt and then push to LangSmith.

Use the language-specific constructor and push method:

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

1. Add the following code to a create_prompt file:

   Python

   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)
   

   This creates an ordered list of messages, wraps them in ChatPromptTemplate, and then pushes the prompt by name to your workspace for versioning and reuse.

2. Run create_prompt:

   Python

   python create_prompt.py
   

Follow the resulting link to view the newly created Prompt Hub prompt in the LangSmith UI.

3. Test a prompt

In this step, you’ll pull the prompt you created in step 2 by name ("prompt-quickstart"), format it with a test input, convert it to OpenAI’s chat format, and call the OpenAI Chat Completions API.

Then, you’ll iterate on the prompt by creating a new version. Members of your workspace can open an existing prompt, experiment with changes in the UI, and save those changes as a new commit on the same prompt, which preserves history for the whole team.

1. Add the following to a test_prompt file:

   Python

   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-4o",
       messages=convert_to_openai_messages(formatted_prompt.messages),
   )
   

   This loads the prompt by name using pull for the latest committed version of the prompt that you’re testing. You can also specify a specific commit by passing the commit hash "<prompt-name>:<commit-hash>"

2. Run test_prompt :

   Python

   python test_prompt.py
   

3. To create a new version of a prompt, call the same push method you used initially with the same prompt name and your updated template. LangSmith will record it as a new commit and preserve prior versions.

   Copy the following code to an iterate_prompt file:

   Python

   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)
   

4. Run iterate_prompt :

   Python

   python iterate_prompt.py
   

现在您的提示将包含两个提交。

为了提升您的提示：

• 参考您模型提供商提供的文档，了解提示创建的最佳实践，例如：
  • 使用 OpenAI API 的提示工程最佳实践
  • Gemini 的提示设计入门
• 使用 LangSmith 中的提示画布构建和优化您的提示——一个交互式工具。更多了解请参阅提示画布指南。

下一步

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

视频指南

---

在GitHub上编辑此页面的源代码.

通过MCP将这些文档编程连接到Claude、VSCode等，以获取实时答案。