提示工程快速入门

​

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
   
   按照生成的链接在 LangSmith UI 中查看新创建的 Prompt Hub 提示词。

​

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")
   
   # 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.4",
       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 提示设计简介
• 使用 Prompt Canvas（LangSmith 中的一个交互式工具）构建和优化你的提示词。在 Prompt Canvas 指南中了解更多。