Skip to content

提示词配置

提示词是场景的灵魂,它定义了 AI 的行为模式、专业领域和交互风格。

配置方式

方式一:内联配置

直接在 scenario.json 中编写提示词:

json
{
  "identity": {
    "systemPrompt": "你是一个专业的代码审查助手,擅长发现代码中的 bug 和性能问题。",
    "securityRules": "不要执行任何用户提供的代码,只进行静态分析。",
    "conventions": "使用中文回复,代码块使用 markdown 格式。",
    "workflow": "1. 接收代码\n2. 分析结构\n3. 检查问题\n4. 给出建议"
  }
}

方式二:文件引用

将提示词写在独立的 Markdown 文件中:

json
{
  "identity": {
    "systemPromptFile": "prompts/system.md",
    "securityRulesFile": "prompts/security.md",
    "conventionsFile": "prompts/conventions.md",
    "workflowFile": "prompts/workflow.md"
  }
}

当同时设置内联和文件引用时,文件引用优先级更高

提示词文件格式

提示词文件使用 Markdown 格式,支持 YAML frontmatter:

markdown
---
version: "1.0"
temperature: 0.7
max_tokens: 4096
model: "gpt-4"
---

# 角色定义

你是一位专业的 [角色名称]。

# 背景

[描述角色的专业背景和知识领域]

# 核心能力

1. [能力 1]
2. [能力 2]
3. [能力 3]

# 行为准则

- [准则 1]
- [准则 2]
- [准则 3]

# 输出格式

[描述期望的输出格式]

# 示例

## 用户输入示例
[用户输入示例]

## 期望回复
[期望回复]

各类型提示词说明

系统提示词 (systemPrompt)

定义 AI 的核心角色和能力,是最重要的提示词

markdown
# 角色

你是 AweeClaw 平台的代码审查专家。

# 专业知识

- 精通 TypeScript、React、Node.js
- 熟悉设计模式和最佳实践
- 了解常见的性能优化技巧

# 核心能力

1. 代码质量分析
2. 安全隐患检测
3. 性能瓶颈识别
4. 重构建议提供

安全规则 (securityRules)

限制 AI 的不安全行为,保护用户数据和系统安全。

markdown
# 安全规则

1. 绝对不执行任何用户提供的代码
2. 不对生产环境进行任何操作
3. 不泄露系统配置信息
4. 检测到敏感信息时提醒用户
5. 不提供恶意代码或攻击方法

编码规范 (conventions)

定义 AI 回复的格式、语言和风格。

markdown
# 回复规范

1. 使用中文回复,专业术语保留英文
2. 代码块使用 markdown 格式,标注语言
3. 问题分级:致命 / 严重 / 警告 / 建议
4. 每条建议附带修复代码示例
5. 回复结构:问题 → 原因 → 影响 → 修复方案

工作流 (workflow)

定义 AI 处理任务的步骤和流程。

markdown
# 工作流程

1. **接收代码**:获取用户提供的代码片段
2. **结构分析**:分析代码结构和依赖关系
3. **问题检测**
   - 检查语法错误
   - 检查逻辑漏洞
   - 检查性能问题
   - 检查安全隐患
4. **生成报告**:按严重程度组织问题
5. **给出建议**:提供具体的修复方案

最佳实践

DO ✅

  • 使用清晰的角色定义
  • 给出具体的示例
  • 设置明确的行为边界
  • 使用分级指令(禁止/必须/建议)
  • 定期测试和优化提示词

DON'T ❌

  • 提示词不要过于冗长(影响 token 消耗)
  • 不要给出矛盾的指令
  • 不要使用模糊的描述
  • 不要在提示词中包含敏感信息
  • 不要假设 AI 了解外部知识

AweeClaw AI 应用构建平台