提示工程快速入门

​

1. 设置环境

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

   TypeScript

   mkdir ls-prompt-quickstart && cd ls-prompt-quickstart
   python -m venv .venv
   source .venv/bin/activate
   pip install -qU langsmith openai langchain_core
   
2. 设置你的 API 密钥：
   export LANGSMITH_API_KEY='<your_api_key>'
   export OPENAI_API_KEY='<your_api_key>'
   

​

2. 创建提示

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

1. 将以下代码添加到 create_prompt 文件中：
   Python

   TypeScript

   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)
   
   这将创建一个有序的消息列表，用 ChatPromptTemplate 包装它们，然后按名称将提示推送到你的 工作区 以进行版本控制和复用。
2. 运行 create_prompt：
   Python

   TypeScript

   python create_prompt.py
   

​

3. 测试提示

1. 将以下内容添加到 test_prompt 文件中：
   Python

   TypeScript

   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),
   )
   
   这将使用 pull 按名称加载你正在测试的提示的最新提交版本。你也可以通过传递提交哈希 "<prompt-name>:<commit-hash>" 来指定特定的提交。
2. 运行 test_prompt：
   Python

   TypeScript

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

   TypeScript

   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. 运行 iterate_prompt：
   Python

   TypeScript

   python iterate_prompt.py
   
   现在你的提示将包含两个提交。

• 参考你的模型提供商提供的文档，了解提示创建的最佳实践，例如：
  • OpenAI API 提示工程最佳实践
  • Gemini 的提示设计简介
• 使用 LangSmith 中的交互式工具 Prompt Canvas 来构建和完善你的提示。在 Prompt Canvas 指南 中了解更多信息。