利用 TypeScript 让 ChatGPT 稳定输出 JSON
Haiya Lv3

GPT 输出 JSON

让 GPT 输出稳定的 JSON 结构是一个常见的需求,目前稳定的方案如下:

  1. Function calling,本质上也是让 GPT 返回一个 JSON 结构,可以利用这种特性生成。
  2. JSON Mode,这是 GPT-4 最新的特性。

但 Function calling 和 JSON mode 都得做一些特殊配置,要想直接简单使用 ChatGPT 让稳定输出 JSON,一种巧妙的方式是利用 TypeScript。

假设我有这么一段信息:我的称呼是吴楷鹏,可以叫我大帅哥,出生于香港回归的那一年,生日是 3 月 13 号,喜欢上班
我希望提取其中用户名、性别、出生日期和个人介绍,最后结果输出要求的 JSON 格式,在提示词中可以这样设定,使用 interface 这样的 TypeScript 语法限定输出的 JSON 对象:

1
2
3
4
5
6
7
输出结构化 JSON 对象,符合下面 TypeScript:
interface UserInfo {
nickname?: string;
gender?: 'male' | 'female';
dataOfBirth?: string;
bio?: string;
}

TypeScript 比较灵活,普通变量 stringnumberboolean 和联合类型都能用上,并且直观、节省 token。

可以加一个输出例子(few-shot),让 JSON 输出更稳定:

1
2
3
4
5
6
这是例子:const userInfo = {
"nickname":"董小姐",
"gender": "female",
"dateOfBirth":"2001-03-07",
"bio": "家住在长沙,喜欢做饭"
}

下面是完整的提示词:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
你叫做“妙妙”,是一款叫做“妙语笔记”的智能助手,接下来你会分析下面用户的输入:
"""
我的称呼是吴楷鹏,可以叫我大帅哥,出生于香港回归的那一年,生日是 3 月 13 号,喜欢上班
"""
设定:
1. 现在是 2025.10.01 21:21,时区是 Asia/Shanghai
2. 提取昵称、性别、出生日期,剩余全部信息整理成个人介绍
3. 要求输出结构化 JSON 对象,符合下面 TypeScript:
interface UserInfo {
nickname?: string;
gender?: 'male' | 'female';
dataOfBirth?: string;
bio?: string;
}
4. 这是例子:const userInfo = {
"nickname":"董小姐",
"gender": "female",
"dateOfBirth":"2001-03-07",
"bio": "家住在长沙,喜欢做饭"
}

接下来开始分析:const userInfo=

这是 GPT4 的输出:

GPT-4

这是 GPT3.5 的输出效果

GPT-3.5

GPT 输出结果有这么几种:

  1. 直接输出完美的 JSON 内容
  2. 讲废话,包含 { … } JSON 内容
  3. 讲废话,包含 markdown 语法的 JSON 内容,这里不好展示,上图片:

GPT

Javascript 解析 JSON

第一种方式直接通过 JSON.parse 解析,第二、三种解析会失败,所以要先做正则提取,提供一个稳定提取 JSON 内容的方法:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
function getObjectFromString(str) {
let jsonStr = null;

// 尝试匹配 json object
const reg = /\{[\s\S]*\}/;
let match = str.match(reg);
if (match) {
jsonStr = match[0];
try {
return JSON5.parse(jsonStr);
} catch (error) {
match = undefined;
}
}

// 尝试匹配 ```json ```包裹中匹配
const regex = /```json\n([\s\S]*?)\n```/;
match = str.match(regex);
if (match) {
jsonStr = match[1];

try {
return JSON5.parse(jsonStr);
} catch (error) {
match = undefined;
}
}

// 直接尝试解析
try {
return JSON5.parse(jsonStr);
} catch (error) {
return null;
}
}

注意,这里我用 JSON5,原因是 GPT 生成的 JSON 格式可能比较松散不一定严格,所以用 JSON 的超集 JSON5 来解析。

Java 解析 JSON

根据上面的 Javascript 解析 JSON 的思路,可以用 Java 实现一个类似的方法:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
private JSONObject parseJson(String str) {
if (StringUtils.isBlank(str)) {
return null;
}
String jsonStr = null;

// 尝试匹配 json object
String reg = "\\{[\\s\\S]*\\}";
java.util.regex.Pattern pattern = java.util.regex.Pattern.compile(reg);
java.util.regex.Matcher matcher = pattern.matcher(str);
if (matcher.find()) {
jsonStr = matcher.group(0);
try {
return JSON.parseObject(jsonStr); // 使用 fastjson 解析 JSON, 也可以使用其他 JSON 解析库
} catch (Exception e) {
// JSON 解析失败
matcher = null;
}
}

// 尝试匹配 ```json ```包裹中的内容
String regex = "```json\\n([\\s\\S]*?)\\n```";
pattern = java.util.regex.Pattern.compile(regex);
matcher = pattern.matcher(str);
if (matcher.find()) {
jsonStr = matcher.group(1);
try {
return JSON.parseObject(jsonStr); // 使用 fastjson 解析 JSON, 也可以使用其他 JSON 解析库
} catch (Exception e) {
// JSON 解析失败
matcher = null;
}
}

// 直接尝试解析
try {
return JSON.parseObject(jsonStr); // 使用 fastjson 解析 JSON, 也可以使用其他 JSON 解析库
} catch (Exception e) {
return null; // 解析失败,返回 null
}
}

References

由 Hexo 驱动 & 主题 Keep