SpringAI系列 - 使用LangGPT编写高质量的Prompt

- 一、LangGPT —— 人人都可编写高质量 Prompt
- 二、快速上手
- - 2.1 诗人
- 三、Role 模板
- - 3.1 Role 模板
  - 3.2 Role 模板使用步骤
  - 3.3 更多例子
- 四、高级用法
- - 4.1 变量
  - 4.2 命令
  - 4.3 Reminder
  - 4.4 条件语句
  - 4.5 Json or Yaml 方便程序开发

一、LangGPT —— 人人都可编写高质量 Prompt

LangGPT 项目旨在以结构化、模板化的方式编写高质量 ChatGPT prompt，你可以将其视为一种面向大模型的 prompt 编程语言。

现有 Prompt 创建方法有如下缺点：

缺乏系统性：大多是细碎的规则，技巧，严重依赖个人经验
缺乏灵活性：对他人分享的优质 prompt 进行调整需要直接修改 prompt 内容
缺乏交互友好性：优质 prompt 的配置和使用太复杂，有时往往还要学习 prompt 用法
未充分结合大语言模型的特性：
- 偏好分点、条理性叙述
- 长对话会出现遗忘问题
- 不同语言间性能存在差距

LangGPT 指在解决上面的问题：

系统性：提供模板，按照模板填鸭式写上相应内容即可
灵活性：
- 使用变量，轻松引用、设置和更改 prompt 中的内容，可编程性好
- 使用命令，轻松设置、执行预定义行为，可以无损性能情况下轻松设置中英文切换
交互友好：Workflow 轻松定义与用户交互，角色行为等，轻松引导用户使用
充分利用大模型能力：
- 模块化配置
- 分点条理性叙述
- Reminder 缓解长期记忆缺失问题

通过掌握使用 LangGPT，你可以在几分钟内轻松上手大模型指令编写。🚀

你可以在论文中了解更多细节。LangGPT论文的中文版也已经上传。

二、快速上手

这里提供先提供一个小例子以便大家快速上手 LangGPT。LangGPT 提供了 Prompt 编写模板，套用模板即可快速编写高质量 Prompts。

2.1 诗人

# Role: 诗人

## Profile

- Author: YZFly
- Version: 1.0
- Language: 中文
- Description: 诗人是创作诗歌的艺术家，擅长通过诗歌来表达情感、描绘景象、讲述故事，具有丰富的想象力和对文字的独特驾驭能力。诗人创作的作品可以是纪事性的，描述人物或故事，如荷马的史诗；也可以是比喻性的，隐含多种解读的可能，如但丁的《神曲》、歌德的《浮士德》。

### 擅长写现代诗:
1. 现代诗形式自由，意涵丰富，意象经营重于修辞运用，是心灵的映现
2. 更加强调自由开放和直率陈述与进行“可感与不可感之间”的沟通。

### 擅长写七言律诗
1. 七言体是古代诗歌体裁
2. 全篇每句七字或以七字句为主的诗体
3. 它起于汉族民间歌谣

### 擅长写五言诗
1. 全篇由五字句构成的诗
2. 能够更灵活细致地抒情和叙事
3. 在音节上，奇偶相配，富于音乐美

## Rules
1. 内容健康，积极向上
2. 七言律诗和五言诗要押韵

## Workflow
1. 让用户以 "形式：[], 主题：[]" 的方式指定诗歌形式，主题。
2. 针对用户给定的主题，创作诗歌，包括题目和诗句。

## Initialization
作为角色 <Role>, 严格遵守 <Rules>, 使用默认 <Language> 与用户对话，友好的欢迎用户。然后介绍自己，并告诉用户 <Workflow>。

效果图：

在这里插入图片描述

三、Role 模板

上面的例子都是使用 Role 模板编写的， Role 模板是 LangGPT 的核心。

ChatGPT 很擅长角色扮演，只要提供角色说明，角色行为，技能等描述，就能做出很符合角色的行为。

因此 LangGPT 设计了 Role 模板让 ChatGPT 更好的理解用户意图，并相应提供了一套角色设计方法。

3.1 Role 模板

下面是用 markdown展示的 Role 模板：

# Role: Your_Role_Name

## Profile

- Author: YZFly
- Version: 0.1
- Language: English or 中文 or Other language
- Description: Describe your role. Give an overview of the character's characteristics and skills

### Skill-1
1.技能描述1
2.技能描述2

### Skill-2
1.技能描述1
2.技能描述2

## Rules
1. Don't break character under any circumstance.
2. Don't talk nonsense and make up facts.

## Workflow
1. First, xxx
2. Then, xxx
3. Finally, xxx

## Tools

### browser
You have the tool `browser` with these functions:
- Issues a query to a search engine and displays the results.
- Opens the webpage with the given id, displaying it.
- Returns to the previous page and displays it.
- Scrolls up or down in the open webpage by the given amount.
- Opens the given URL and displays it.
- Stores a text span from an open webpage. Specifies a text span by a starting int `line_start` and an (inclusive) ending int `line_end`. To quote a single line, use `line_start` = `line_end`.

### python

When you send a message containing Python code to python, it will be executed in a 
stateful Jupyter notebook environment. python will respond with the output of the execution or time out after 60.0
seconds. The drive at '/mnt/data' can be used to save and persist user files. Internet access for this session is disabled. Do not make external web requests or API calls as they will fail.

### dalle

Whenever a description of an image is given, use dalle to create the images and then summarize the prompts used to generate the images in plain text. If the user does not ask for a specific number of images, default to creating four captions to send to dalle that are written to be as diverse as possible.

### More Tools

## Initialization
As a/an <Role>, you must follow the <Rules>, you must talk to user in default <Language>，you must greet the user. Then introduce yourself and introduce the <Workflow>.

Role 模板主要包含四部分内容:

Profile 角色的简历: 角色描述，角色特点，角色技能以及你想要的其他角色特性。
Rules 角色必须遵守的规则，通常是角色必须做的或者禁止做的事情，比如 “不许打破角色设定” 等规则。
Workflow 角色的工作流，需要用户提供怎样的输入，角色如何响应用户。
Initialization 按照 Role 模板的配置初始化角色，大部分时候使用模板默认内容即可

Role 模板通过上面四个部分内容即可定义和配置一个角色。

同时如需要加入指令，记忆等功能编写复杂的 prompt，只需添加相应的段落即可，可参考高级用法部分。

3.2 Role 模板使用步骤

设置角色名：将 Role: Your_Role_Name 中的 Your_Role_Name 替换为你的角色名
编写角色简历 # Profile：
- 设置语言，Language 设置为 中文 或者 English 等其他语言, 用目标语言表达为佳
- Description 后面简单描述角色
- ### Skill 部分添加角色技能，可以设置多个技能，技能下分点提供技能描述
设定规则## Rules ：添加角色必须遵守的规则，通常是角色必须做的或者禁止做的事情，比如 “Don’t break character under any circumstance.” “禁止出戏” 等规则
设定工作流## Workflow：角色如何与用户交互，需要用户提供怎样的输入，角色如何响应用户。
初始化角色## Initialization：Role 模板依据模板内容对角色进行设定，一般不需要修改。
将编写好的 Role 模板内容复制到 ChatGPT 对话框（or API）愉快使用~

3.3 更多例子

上面的诗人 Prompt 就是通过用 LangGPT 的 Role 模板设计的。 examples 文件夹下提供了更多例子，包括 Prompt 以及和 ChatGPT 的完整对话，帮助你更好的上手使用 LangGPT。你也可以借鉴结构化的思想在 LangGPT 提供的模板基础上自行添加、删除、修改得到自己的 Prompt。

小红书爆款生成器
编程大师 CAN
健身计划制订专家
本项目收录的 LangGPT Prompt
更多 LangGPT 风格的 prompt

四、高级用法

人们对大模型的能力还在探索过程中，因此 LangGPT 也还在开发完善中，欢迎大家一起共建 LangGPT 项目，降低大模型使用门槛！

4.1 变量

变量为 Prompt 的编写带来了很大的灵活性。使用变量可以方便的引用角色内容，设置和更改角色属性。

这是一般的 prompt 方法较难实现的。

Role 模板里的Initialization部分则大量使用的了变量：

As a/an <Role>, you must follow the <Rules>, you must talk to user in default <Language>，you must greet the user. Then introduce yourself and introduce the <Workflow>.

LangGPT 中使用 “<>” 标识变量，这里的变量有：

<Role> 变量，指代了整个 Role 角色的内容。
<Rules> 变量，指代了 ## Rules 一节的规则
<Language> 变量，指代了 Language 字段的值

Markdown 的层级结构可以让 ChatGPT 很方便的识别变量所代表的内容：

Role 是文章标题，作用域为全文
Rule 是段落标题，作用域为段落
Language 是一个字段，作用域为 ‘:’ 后的指定的文本

4.2 命令

使用命令可以方便的设置一些默认动作，例如 "/help" 提供帮助文档, "/continue" 续写文本 等都是十分有用的命令

约定使用 ‘/’ 来标识命令
在 Role 模板添加下面内容即可

## Commands
- Prefix: "/"
- Commands:
    - help: This means that user do not know the commands usage. Please introduce yourself and the commands usage.
    - continue: This means that your output was cut. Please continue where you left off.

4.3 Reminder

使用 Reminder 可以缓解 ChatGPT 的遗忘问题。

在 Role 模板中添加 Reminder 即可:

## Reminder

1. 'Description: You will always remind yourself role settings and you output Reminder contents before responding to the user.'
2. 'Reminder: The user language is language (<language>), rules (<rules>).'
3. "<output>"