Dspy
DSPy:声明式 LM 程序、自动优化提示词、RAG。
技能元数据
| Source | 可选 — 使用 hermes skills install official/mlops/dspy 安装 |
| Path | optional-skills/mlops\research\dspy |
| Version | 1.0.0 |
| Author | Orchestra Research |
| License | MIT |
| Dependencies | dspy、openai、anthropic |
| Platforms | linux、macos、windows |
| Tags | Prompt Engineering、DSPy、Declarative Programming、RAG、Agents、Prompt Optimization、LM Programming、Stanford NLP、Automatic Optimization、Modular AI |
参考:完整 SKILL.md
信息
以下是 Hermes 在触发此技能时加载的完整技能定义。这是技能激活时智能体看到的指令内容。
DSPy:声明式语言模型编程
何时使用此技能
在以下情况使用 DSPy:
- 构建复杂 AI 系统,包含多个组件和工作流
- 以声明式方式对 LM 编程,而非手动编写提示词
- 使用数据驱动方法自动优化提示词
- 创建模块化 AI 流水线,易于维护且可移植
- 使用优化器系统性地改进模型输出
- 构建更可靠的 RAG 系统、智能体或分类器
GitHub 星标:22,000+ | 创建者:Stanford NLP
安装
# 稳定版本
pip install dspy
# 最新开发版本
pip install git+https://github.com/stanfordnlp/dspy.git
# 搭配特定 LM 服务商
pip install dspy[openai] # OpenAI
pip install dspy[anthropic] # Anthropic Claude
pip install dspy[all] # 所有服务商
快速开始
基础示例:问答
import dspy
# 配置你的语言模型
lm = dspy.Claude(model="claude-sonnet-4-5-20250929")
dspy.settings.configure(lm=lm)
# 定义一个签名(输入 → 输出)
class QA(dspy.Signature):
"""用简短的事实性答案回答问题。"""
question = dspy.InputField()
answer = dspy.OutputField(desc="通常为 1 到 5 个词")
# 创建一个模块
qa = dspy.Predict(QA)
# 使用它
response = qa(question="What is the capital of France?")
print(response.answer) # "Paris"
思维链推理
import dspy
lm = dspy.Claude(model="claude-sonnet-4-5-20250929")
dspy.settings.configure(lm=lm)
# 使用 ChainOfThought 以获得更好的推理效果
class MathProblem(dspy.Signature):
"""解决数学应用题。"""
problem = dspy.InputField()
answer = dspy.OutputField(desc="数值答案")
# ChainOfThought 会自动生成推理步骤
cot = dspy.ChainOfThought(MathProblem)
response = cot(problem="If John has 5 apples and gives 2 to Mary, how many does he have?")
print(response.rationale) # 显示推理步骤
print(response.answer) # "3"
核心概念
1. 签名(Signatures)
签名定义 AI 任务的结构(输入 → 输出):
# 内联签名(简单)
qa = dspy.Predict("question -> answer")
# 类签名(详细)
class Summarize(dspy.Signature):
"""将文本总结为关键要点。"""
text = dspy.InputField()
summary = dspy.OutputField(desc="要点列表,3-5 条")
summarizer = dspy.ChainOfThought(Summarize)
何时使用哪种方式:
- 内联:快速原型搭建、简单任务
- 类:复杂任务、类型提示、更好的文档
2. 模块(Modules)
模块是可将输入转换为输出的可复用组件:
dspy.Predict
基础预测模块:
predictor = dspy.Predict("context, question -> answer")
result = predictor(context="Paris is the capital of France",
question="What is the capital?")
dspy.ChainOfThought
在回答之前生成推理步骤:
cot = dspy.ChainOfThought("question -> answer")
result = cot(question="Why is the sky blue?")
print(result.rationale) # Reasoning steps(推理步骤)
print(result.answer) # Final answer(最终答案)
dspy.ReAct
类智能体的工具化推理:
from dspy.predict import ReAct
class SearchQA(dspy.Signature):
"""Answer questions using search."""
question = dspy.InputField()
answer = dspy.OutputField()
def search_tool(query: str) -> str:
"""Search Wikipedia."""
# Your search implementation
return results
react = ReAct(SearchQA, tools=[search_tool])
result = react(question="When was Python created?")
dspy.ProgramOfThought
生成并执行用于推理的代码:
pot = dspy.ProgramOfThought("question -> answer")
result = pot(question="What is 15% of 240?")
# Generates: answer = 240 * 0.15
3. 优化器
优化器利用训练数据自动改进你的模块:
BootstrapFewShot
从示例中学习:
from dspy.teleprompt import BootstrapFewShot
# Training data
trainset = [
dspy.Example(question="What is 2+2?", answer="4").with_inputs("question"),
dspy.Example(question="What is 3+5?", answer="8").with_inputs("question"),
]
# Define metric
def validate_answer(example, pred, trace=None):
return example.answer == pred.answer
# Optimize
optimizer = BootstrapFewShot(metric=validate_answer, max_bootstrapped_demos=3)
optimized_qa = optimizer.compile(qa, trainset=trainset)
# Now optimized_qa performs better!
MIPRO (Most Important Prompt Optimization)
迭代改进提示词:
from dspy.teleprompt import MIPRO
optimizer = MIPRO(
metric=validate_answer,
num_candidates=10,
init_temperature=1.0
)
optimized_cot = optimizer.compile(
cot,
trainset=trainset,
num_trials=100
)
BootstrapFinetune
创建用于模型微调的数据集:
from dspy.teleprompt import BootstrapFinetune
optimizer = BootstrapFinetune(metric=validate_answer)
optimized_module = optimizer.compile(qa, trainset=trainset)
# Exports training data for fine-tuning
4. 构建复杂系统
多阶段流水线
import dspy
class MultiHopQA(dspy.Module):
def __init__(self):
super().__init__()
self.retrieve = dspy.Retrieve(k=3)
self.generate_query = dspy.ChainOfThought("question -> search_query")
self.generate_answer = dspy.ChainOfThought("context, question -> answer")
def forward(self, question):
# Stage 1: Generate search query
search_query = self.generate_query(question=question).search_query
# Stage 2: Retrieve context
passages = self.retrieve(search_query).passages
context = "\n".join(passages)
# Stage 3: Generate answer
answer = self.generate_answer(context=context, question=question).answer
return dspy.Prediction(answer=answer, context=context)
# Use the pipeline
qa_system = MultiHopQA()
result = qa_system(question="Who wrote the book that inspired the movie Blade Runner?")
带优化的 RAG 系统
import dspy
from dspy.retrieve.chromadb_rm import ChromadbRM
# Configure retriever
retriever = ChromadbRM(
collection_name="documents",
persist_directory="./chroma_db"
)
class RAG(dspy.Module):
def __init__(self, num_passages=3):
super().__init__()
self.retrieve = dspy.Retrieve(k=num_passages)
self.generate = dspy.ChainOfThought("context, question -> answer")
def forward(self, question):
context = self.retrieve(question).passages
return self.generate(context=context, question=question)
# Create and optimize
rag = RAG()
# Optimize with training data
from dspy.teleprompt import BootstrapFewShot
optimizer = BootstrapFewShot(metric=validate_answer)
optimized_rag = optimizer.compile(rag, trainset=trainset)
LM 服务商配置
Anthropic Claude
import dspy
lm = dspy.Claude(
model="claude-sonnet-4-5-20250929",
api_key="your-api-key", # 或设置 ANTHROPIC_API_KEY 环境变量
max_tokens=1000,
temperature=0.7
)
dspy.settings.configure(lm=lm)
OpenAI
lm = dspy.OpenAI(
model="gpt-4",
api_key="your-api-key",
max_tokens=1000
)
dspy.settings.configure(lm=lm)
本地模型(Ollama)
lm = dspy.OllamaLocal(
model="llama3.1",
base_url="http://localhost:11434"
)
dspy.settings.configure(lm=lm)
多模型
# 不同任务使用不同模型
cheap_lm = dspy.OpenAI(model="gpt-3.5-turbo")
strong_lm = dspy.Claude(model="claude-sonnet-4-5-20250929")
# 检索用便宜模型,推理用强模型
with dspy.settings.context(lm=cheap_lm):
context = retriever(question)
with dspy.settings.context(lm=strong_lm):
answer = generator(context=context, question=question)
常见模式
模式 1:结构化输出
from pydantic import BaseModel, Field
class PersonInfo(BaseModel):
name: str = Field(description="Full name")
age: int = Field(description="Age in years")
occupation: str = Field(description="Current job")
class ExtractPerson(dspy.Signature):
"""Extract person information from text."""
text = dspy.InputField()
person: PersonInfo = dspy.OutputField()
extractor = dspy.TypedPredictor(ExtractPerson)
result = extractor(text="John Doe is a 35-year-old software engineer.")
print(result.person.name) # "John Doe"
print(result.person.age) # 35
模式 2:断言驱动的优化
import dspy
from dspy.primitives.assertions import assert_transform_module, backtrack_handler
class MathQA(dspy.Module):
def __init__(self):
super().__init__()
self.solve = dspy.ChainOfThought("problem -> solution: float")
def forward(self, problem):
solution = self.solve(problem=problem).solution
# 断言解为数值
dspy.Assert(
isinstance(float(solution), float),
"Solution must be a number",
backtrack=backtrack_handler
)
return dspy.Prediction(solution=solution)
模式 3:自洽性
import dspy
from collections import Counter
class ConsistentQA(dspy.Module):
def __init__(self, num_samples=5):
super().__init__()
self.qa = dspy.ChainOfThought("question -> answer")
self.num_samples = num_samples
def forward(self, question):
# 生成多个答案
answers = []
for _ in range(self.num_samples):
result = self.qa(question=question)
answers.append(result.answer)
# 返回最常见的答案
most_common = Counter(answers).most_common(1)[0][0]
return dspy.Prediction(answer=most_common)
模式 4:带重排序的检索
class RerankedRAG(dspy.Module):
def __init__(self):
super().__init__()
self.retrieve = dspy.Retrieve(k=10)
self.rerank = dspy.Predict("question, passage -> relevance_score: float")
self.answer = dspy.ChainOfThought("context, question -> answer")
def forward(self, question):
# 检索候选项
passages = self.retrieve(question).passages
# 对段落重排序
scored = []
for passage in passages:
score = float(self.rerank(question=question, passage=passage).relevance_score)
scored.append((score, passage))
# 取前 3 个
top_passages = [p for _, p in sorted(scored, reverse=True)[:3]]
context = "\n\n".join(top_passages)
# 生成答案
return self.answer(context=context, question=question)
评估与指标
自定义指标
def exact_match(example, pred, trace=None):
"""Exact match metric."""
return example.answer.lower() == pred.answer.lower()
def f1_score(example, pred, trace=None):
"""F1 score for text overlap."""
pred_tokens = set(pred.answer.lower().split())
gold_tokens = set(example.answer.lower().split())
if not pred_tokens:
return 0.0
precision = len(pred_tokens & gold_tokens) / len(pred_tokens)
recall = len(pred_tokens & gold_tokens) / len(gold_tokens)
if precision + recall == 0:
return 0.0
return 2 * (precision * recall) / (precision + recall)
评估
from dspy.evaluate import Evaluate
# 创建评估器
evaluator = Evaluate(
devset=testset,
metric=exact_match,
num_threads=4,
display_progress=True
)
# 评估模型
score = evaluator(qa_system)
print(f"Accuracy: {score}")
# 比较优化前后
score_before = evaluator(qa)
score_after = evaluator(optimized_qa)
print(f"Improvement: {score_after - score_before:.2%}")
最佳实践
1. 从简入手,逐步迭代
# 从 Predict 开始
qa = dspy.Predict("question -> answer")
# 如有需要,加入推理
qa = dspy.ChainOfThought("question -> answer")
# 有数据后再进行优化
optimized_qa = optimizer.compile(qa, trainset=data)
2. 使用描述性签名
# ❌ 差:含糊
class Task(dspy.Signature):
input = dspy.InputField()
output = dspy.OutputField()
# ✅ 好:描述清晰
class SummarizeArticle(dspy.Signature):
"""Summarize news articles into 3-5 key points."""
article = dspy.InputField(desc="full article text")
summary = dspy.OutputField(desc="bullet points, 3-5 items")
3. 使用有代表性的数据进行优化
# 创建多样化的训练样例
trainset = [
dspy.Example(question="factual", answer="...).with_inputs("question"),
dspy.Example(question="reasoning", answer="...").with_inputs("question"),
dspy.Example(question="calculation", answer="...").with_inputs("question"),
]
# 使用验证集计算指标
def metric(example, pred, trace=None):
return example.answer in pred.answer
4. 保存并加载优化后的模型
# 保存
optimized_qa.save("models/qa_v1.json")
# 加载
loaded_qa = dspy.ChainOfThought("question -> answer")
loaded_qa.load("models/qa_v1.json")
5. 监控与调试
# 启用追踪
dspy.settings.configure(lm=lm, trace=[])
# 运行预测
result = qa(question="...")
# 检查追踪记录
for call in dspy.settings.trace:
print(f"Prompt: {call['prompt']}")
print(f"Response: {call['response']}")
与其他方法对比
| 特性 | 手动提示工程 | LangChain | DSPy |
|---|---|---|---|
| 提示工程 | 手动 | 手动 | 自动 |
| 优化 | 反复试错 | 无 | 数据驱动 |
| 模块化 | 低 | 中 | 高 |
| 类型安全 | 无 | 有限 | 有(签名) |
| 可移植性 | 低 | 中 | 高 |
| 学习曲线 | 低 | 中 | 中高 |
何时选择 DSPy:
- 你有训练数据或能够生成数据
- 你需要系统性地改进提示
- 你在构建复杂的多阶段系统
- 你希望跨不同 LM 进行优化
何时选择替代方案:
- 快速原型(手动提示工程)
- 与现有工具搭配的简单链(LangChain)
- 需要自定义优化逻辑
资源
- 文档:https://dspy.ai
- GitHub:https://github.com/stanfordnlp/dspy(22k+ stars)
- Discord:https://discord.gg/XCGy2WDCQB
- Twitter:@DSPyOSS
- 论文:"DSPy: Compiling Declarative Language Model Calls into Self-Improving Pipelines"
另见
references/modules.md- 详细模块指南(Predict、ChainOfThought、ReAct、ProgramOfThought)references/optimizers.md- 优化算法(BootstrapFewShot、MIPRO、BootstrapFinetune)references/examples.md- 真实案例(RAG、agents、classifiers)