LangSmith 提供了一个协作界面，用于创建、测试和迭代提示词。
虽然您可以 在运行时动态获取提示词 到您的应用程序中，但您可能更倾向于将提示词同步到您自己的数据库或版本控制系统。为支持此工作流程，LangSmith 允许您通过 Webhook 接收提示词更新通知。
为什么要将提示词与 GitHub 同步？
- * **版本控制：** 在熟悉的系统中与您的应用程序代码一起对提示词进行版本管理。
- * **CI/CD Integration:** 当关键提示词发生变化时，触发自动预发布或生产部署。
前提条件
在开始之前，请确保您已完成以下设置：
- **GitHub 账户：** 一个标准的 GitHub 账户。
- **GitHub 仓库：** 创建一个新的（或选择现有的）仓库，用于存储您的 LangSmith 提示词清单。这可以是与您的应用程序代码相同的仓库，也可以是专门用于提示词的仓库。
- **GitHub 个人访问令牌 (PAT)：**
- * LangSmith Webhook 不会直接与 GitHub 交互——它们调用一个中间服务器，该服务器 *由您* create.
- * 该服务器需要 GitHub PAT 来验证身份并向您的仓库提交代码。
- * 必须包含
repo作用域（public_repo对于公共仓库已足够）。 - * Go to **GitHub > Settings > Developer settings > Personal access tokens > Tokens (classic)**.
- * 点击 **Generate new token (classic)**.
- * 为其命名（例如 "LangSmith Prompt Sync"），设置过期时间，并选择所需的作用域。
- * 点击 **Generate token** 并 **立即复制** ——它不会再被显示。
- * 安全存储令牌，并将其作为环境变量提供给您的服务器。
了解 LangSmith "提示词提交"和 Webhook
在 LangSmith 中，当您保存对提示词的更改时，您实际上是在创建一个新版本或"提示词提交"。这些提交是触发 Webhook 的对象。
Webhook 将发送包含新的 **提示词清单**.
Sample Webhook Payload
{
"prompt_id": "f33dcb51-eb17-47a5-83ca-64ac8a027a29",
"prompt_name": "My Prompt",
"commit_hash": "commit_hash_1234567890",
"created_at": "2021-01-01T00:00:00Z",
"created_by": "Jane Doe",
"manifest": {
"lc": 1,
"type": "constructor",
"id": ["langchain", "schema", "runnable", "RunnableSequence"],
"kwargs": {
"first": {
"lc": 1,
"type": "constructor",
"id": ["langchain", "prompts", "chat", "ChatPromptTemplate"],
"kwargs": {
"messages": [
{
"lc": 1,
"type": "constructor",
"id": [
"langchain_core",
"prompts",
"chat",
"SystemMessagePromptTemplate"
],
"kwargs": {
"prompt": {
"lc": 1,
"type": "constructor",
"id": [
"langchain_core",
"prompts",
"prompt",
"PromptTemplate"
],
"kwargs": {
"input_variables": [],
"template_format": "mustache",
"template": "You are a chatbot."
}
}
}
},
{
"lc": 1,
"type": "constructor",
"id": [
"langchain_core",
"prompts",
"chat",
"HumanMessagePromptTemplate"
],
"kwargs": {
"prompt": {
"lc": 1,
"type": "constructor",
"id": [
"langchain_core",
"prompts",
"prompt",
"PromptTemplate"
],
"kwargs": {
"input_variables": ["question"],
"template_format": "mustache",
"template": "{{question}}"
}
}
}
}
],
"input_variables": ["question"]
}
},
"last": {
"lc": 1,
"type": "constructor",
"id": ["langchain", "schema", "runnable", "RunnableBinding"],
"kwargs": {
"bound": {
"lc": 1,
"type": "constructor",
"id": ["langchain", "chat_models", "openai", "ChatOpenAI"],
"kwargs": {
"temperature": 1,
"top_p": 1,
"presence_penalty": 0,
"frequency_penalty": 0,
"model": "gpt-5.4-mini",
"extra_headers": {},
"openai_api_key": {
"id": ["OPENAI_API_KEY"],
"lc": 1,
"type": "secret"
}
}
},
"kwargs": {}
}
}
}
}
}
实现用于接收 Webhook 的 FastAPI 服务器
为了在提示词更新时有效处理来自 LangSmith 的 webhook 通知，需要一个中间服务器应用程序。该服务器将充当 LangSmith 发送的 HTTP POST 请求的接收器。在本指南的演示中，我们将概述创建一个简单的 FastAPI 应用程序来履行此角色。
这个可公开访问的服务器将负责：
- **接收 Webhook 请求：** 监听传入的 HTTP POST 请求。
- **解析载荷：** 从请求正文中提取并解析 JSON 格式的提示词清单。
- **提交到 GitHub：** 以编程方式在您指定的 GitHub 仓库中创建新提交，包含更新后的提示词清单。这确保了您的提示词保持版本控制，并与 LangSmith 中的更改保持同步。
对于部署，可以使用 Render.com （提供合适的免费套餐）、Vercel、Fly.io 或其他云服务提供商（AWS、GCP、Azure）来托管 FastAPI 应用程序并获取公共 URL。
服务器的核心功能将包括用于接收 webhook 的端点、用于解析清单的逻辑，以及与 GitHub API 的集成（使用个人访问令牌进行身份验证）来管理提交。
Minimal FastAPI Server Code ()
main.py
该服务器将监听来自 LangSmith 的传入 webhook，并将接收到的提示词清单提交到您的 GitHub 仓库。
from typing import Any, Dict
from fastapi import FastAPI, HTTPException, Body
from pydantic import BaseModel, Field
from pydantic_settings import BaseSettings, SettingsConfigDict
# --- Configuration ---
class AppConfig(BaseSettings):
"""
Application configuration model.
Loads settings from environment variables.
"""
GITHUB_TOKEN: str
GITHUB_REPO_OWNER: str
GITHUB_REPO_NAME: str
GITHUB_FILE_PATH: str = "prompt_manifest.json"
GITHUB_BRANCH: str = "main"
model_config = SettingsConfigDict(
env_file=".env",
env_file_encoding='utf-8',
extra='ignore'
)
settings = AppConfig()
# --- Pydantic Models ---
class WebhookPayload(BaseModel):
"""
Defines the expected structure of the incoming webhook payload.
"""
prompt_id: UUID = Field(
...,
description="The unique identifier for the prompt."
)
prompt_name: str = Field(
...,
description="The name/title of the prompt."
)
commit_hash: str = Field(
...,
description="An identifier for the commit event that triggered the webhook."
)
created_at: str = Field(
...,
description="Timestamp indicating when the event was created (ISO format preferred)."
)
created_by: str = Field(
...,
description="The name of the user who created the event."
)
manifest: Dict[str, Any] = Field(
...,
description="The main content or configuration data to be committed to GitHub."
)
# --- GitHub Helper Function ---
async def commit_manifest_to_github(payload: WebhookPayload) -> Dict[str, Any]:
"""
Helper function to commit the manifest directly to the configured branch.
"""
github_api_base_url = "https://api.github.com"
repo_file_url = (
f"{github_api_base_url}/repos/{settings.GITHUB_REPO_OWNER}/"
f"{settings.GITHUB_REPO_NAME}/contents/{settings.GITHUB_FILE_PATH}"
)
headers = {
"Authorization": f"Bearer {settings.GITHUB_TOKEN}",
"Accept": "application/vnd.github.v3+json",
"X-GitHub-Api-Version": "2022-11-28",
}
manifest_json_string = json.dumps(payload.manifest, indent=2)
content_base64 = base64.b64encode(manifest_json_string.encode('utf-8')).decode('utf-8')
commit_message = f"feat: Update {settings.GITHUB_FILE_PATH} via webhook - commit {payload.commit_hash}"
data_to_commit = {
"message": commit_message,
"content": content_base64,
"branch": settings.GITHUB_BRANCH,
}
async with httpx.AsyncClient() as client:
current_file_sha = None
try:
params_get = {"ref": settings.GITHUB_BRANCH}
response_get = await client.get(repo_file_url, headers=headers, params=params_get)
if response_get.status_code == 200:
current_file_sha = response_get.json().get("sha")
elif response_get.status_code != 404: # If not 404 (not found), it's an unexpected error
response_get.raise_for_status()
except httpx.HTTPStatusError as e:
error_detail = f"GitHub API error (GET file SHA): {e.response.status_code} - {e.response.text}"
print(f"[ERROR] {error_detail}")
raise HTTPException(status_code=e.response.status_code, detail=error_detail)
except httpx.RequestError as e:
error_detail = f"Network error connecting to GitHub (GET file SHA): {str(e)}"
print(f"[ERROR] {error_detail}")
raise HTTPException(status_code=503, detail=error_detail)
if current_file_sha:
data_to_commit["sha"] = current_file_sha
try:
response_put = await client.put(repo_file_url, headers=headers, json=data_to_commit)
response_put.raise_for_status()
return response_put.json()
except httpx.HTTPStatusError as e:
error_detail = f"GitHub API error (PUT content): {e.response.status_code} - {e.response.text}"
if e.response.status_code == 409: # Conflict
error_detail = (
f"GitHub API conflict (PUT content): {e.response.text}. "
"This might be due to an outdated SHA or branch protection rules."
)
elif e.response.status_code == 422: # Unprocessable Entity
error_detail = (
f"GitHub API Unprocessable Entity (PUT content): {e.response.text}. "
f"Ensure the branch '{settings.GITHUB_BRANCH}' exists and the payload is correctly formatted."
)
print(f"[ERROR] {error_detail}")
raise HTTPException(status_code=e.response.status_code, detail=error_detail)
except httpx.RequestError as e:
error_detail = f"Network error connecting to GitHub (PUT content): {str(e)}"
print(f"[ERROR] {error_detail}")
raise HTTPException(status_code=503, detail=error_detail)
# --- FastAPI Application ---
app = FastAPI(
title="Minimal Webhook to GitHub Commit Service",
description="Receives a webhook and commits its 'manifest' part directly to a GitHub repository.",
version="0.1.0",
)
@app.post("/webhook/commit", status_code=201, tags=["GitHub Webhooks"])
async def handle_webhook_direct_commit(payload: WebhookPayload = Body(...)):
"""
Webhook endpoint to receive events and commit DIRECTLY to the configured branch.
"""
try:
github_response = await commit_manifest_to_github(payload)
return {
"message": "Webhook received and manifest committed directly to GitHub successfully.",
"github_commit_details": github_response.get("commit", {}),
"github_content_details": github_response.get("content", {})
}
except HTTPException:
raise # Re-raise if it's an HTTPException from the helper
except Exception as e:
error_message = f"An unexpected error occurred: {str(e)}"
print(f"[ERROR] {error_message}")
raise HTTPException(status_code=500, detail="An internal server error occurred.")
@app.get("/health", status_code=200, tags=["Health"])
async def health_check():
"""
A simple health check endpoint.
"""
return {"status": "ok", "message": "Service is running."}
# To run this server (save as main.py):
# 1. Install dependencies: pip install fastapi uvicorn pydantic pydantic-settings httpx python-dotenv
# 2. Create a .env file with your GitHub token and repo details.
# 3. Run with Uvicorn: uvicorn main:app --reload
# 4. Deploy to a public platform like Render.com.
该服务器的关键方面：
- * **配置（
.env):** 它需要一个.env文件，其中包含您的GITHUB_TOKEN,GITHUB_REPO_OWNER和GITHUB_REPO_NAME。您还可以自定义GITHUB_FILE_PATH（默认：LangSmith_prompt_manifest.json）和GITHUB_BRANCH（默认：main). - * **GitHub 交互：** 该
commit_manifest_to_github函数负责获取当前文件的 SHA（用于更新）的逻辑，然后将新的清单内容提交。 - * **Webhook 端点（
/webhook/commit):** 这是您的 LangSmith webhook 将指向的 URL 路径。 - * **错误处理：** 包含了对 GitHub API 交互的基本错误处理。
**将此服务器部署到您选择的平台（例如 Render）并记下其公共 URL（例如 https://prompt-commit-webhook.onrender.com).**
在 LangSmith 中配置 webhook
一旦您的 FastAPI 服务器部署完成并获得其公共 URL，您就可以在 LangSmith 中配置 webhook：
- 导航到您的 LangSmith 工作区。
- 转到 **提示词** 部分。在这里您将看到您的提示词列表。
- 在提示词页面的右上角，点击 **+ Webhook** button.
- 系统将显示一个表单供您配置 webhook：
- * **Webhook URL：** 输入您部署的 FastAPI 服务器端点的完整公共 URL。对于我们的示例服务器，这将是
https://prompt-commit-webhook.onrender.com/webhook/commit. - * **标头（可选）：**
- * 您可以添加自定义标头，LangSmith 会在每个 webhook 请求中发送这些标头。
- **测试 Webhook：** LangSmith 提供了一个"发送测试通知"按钮。使用此按钮可以向您的服务器发送示例负载。检查您的服务器日志（例如在 Render 上），以确保它收到了请求并成功处理了请求（或调试任何问题）。
- **保存** webhook 配置。
工作流程演示
!工作流程图显示：用户在 LangSmith 中保存提示词，LangSmith 向 FastAPI 服务器发送 webhook，该服务器与 GitHub 交互以更新文件
现在，一切设置就绪，以下是整个流程：
- **修改提示词：** 用户（开发人员或非技术团队成员）在 LangSmith UI 中修改提示词并保存，创建一个新的"提示词提交"。
- **触发 Webhook：** LangSmith 检测到新的提示词提交，并触发配置好的 webhook。
- **HTTP 请求：** LangSmith 向您的 FastAPI 服务器的公共 URL 发送 HTTP POST 请求（例如
https://prompt-commit-webhook.onrender.com/webhook/commit）。请求体包含整个工作空间的 JSON 提示词清单。
- **服务器接收负载：** 您的 FastAPI 服务器端点接收该请求。
- **GitHub 提交：** 服务器解析请求体中的 JSON 清单。然后使用配置的 GitHub 个人访问令牌、仓库所有者、仓库名称、文件路径和分支来：
- * 检查清单文件是否已存在于指定分支上的仓库中，以获取其 SHA（这是更新现有文件所必需的）。
- * 使用最新的提示词清单创建新提交，无论是创建文件还是在文件已存在时更新它。提交消息将表明这是来自 LangSmith 的更新。
- **Confirmation:** 您应该会在 GitHub 仓库中看到新的提交。
您已成功将 LangSmith 提示词与 GitHub 同步！
超越简单的提交
我们的示例 FastAPI 服务器执行整个提示词清单的直接提交。然而，这只是起点。您可以扩展服务器的功能以执行更复杂的操作：
- * **细粒度提交：** 解析清单并提交对各个提示词文件的更改，如果您希望在仓库中采用更细粒度的结构。
- * **Trigger CI/CD:** Instead of (or in addition to) committing, have the server trigger a CI/CD pipeline (e.g., Jenkins, GitHub Actions, GitLab CI) to deploy a staging environment, run tests, or build new application versions.
- * **Update Databases/Caches:** 如果您的应用程序从数据库或缓存加载提示词，请直接更新这些存储。
- * **Notifications:** 通过 Slack、电子邮件或其他通信渠道发送有关提示词更改的通知。
- * **选择性处理：** 基于 LangSmith 负载中的元数据（如果有，例如哪个特定提示词被更改或由谁更改），您可以应用不同的逻辑。