-
Notifications
You must be signed in to change notification settings - Fork 3
/
decorators.ts
200 lines (186 loc) · 6.57 KB
/
decorators.ts
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
import {
GPT_CLIENT_METADATA,
GPT_TYPE_METADATA,
GPTClientMetadata,
GPTObjectTypeMetadata,
GPTTypeMetadata,
} from './internals.js';
import { ChatGPTSession } from './session.js';
/**
* Use this decorator on a method within a ChatGPTSession subclass to enable it for function-calling.
*
* @param description - A description of the function.
* @param inputType - Input for the function should be an object instance of a custom class.
* This parameter specifies the class of the object.
*
* @see {@link gptObjectField}
*/
export function gptFunction(description: string, inputType: new () => unknown) {
return function (target: object, propertyKey: string, descriptor: PropertyDescriptor) {
const ctor = target.constructor as new () => ChatGPTSession;
if (!ctor) {
throw new Error(`@gptFunction decorator was used on '${propertyKey}' which is not a class instance method`);
}
const metadata: GPTClientMetadata = GPT_CLIENT_METADATA.get(ctor) || {
constructor: ctor,
functions: {},
};
metadata.functions[propertyKey] = {
name: propertyKey,
value: descriptor.value,
description,
inputType: GPT_TYPE_METADATA.get(inputType) as GPTObjectTypeMetadata,
};
GPT_CLIENT_METADATA.set(ctor, metadata);
};
}
/**
* Use this decorator on a property within a custom class to include it as a parameter for function-calling.
*
* @param type - Type of the field.
* Use `'string'`, `'number'`, `'boolean'` for primitive types.
* Use `['string']`, `['number']`, `['boolean']` for arrays of primitive types.
* Use a ClassName for custom types.
* Use `[ClassName]` for arrays of custom types.
* @param description - Description of the field.
* @param optional - Whether the field is optional. Default to `false`.
*/
export function gptObjectField(
type:
| 'string'
| 'number'
| 'boolean'
| { enum: string[] }
| (new () => unknown)
| ['string' | 'number' | 'boolean' | { enum: string[] } | (new () => unknown)],
description: string,
optional = false,
) {
return function (target: object, propertyKey: string) {
const ctor = target.constructor as new () => unknown;
if (!ctor) {
throw new Error(`@gptObjectField decorator was used on '${propertyKey}' which is not a class instance property`);
}
const metadata = (GPT_TYPE_METADATA.get(ctor) as GPTObjectTypeMetadata) || {
type: 'object',
fields: [],
};
if (type === 'string') {
metadata.fields.push({
name: propertyKey,
description,
type: { type: 'string' },
required: !optional,
});
} else if (type === 'number') {
metadata.fields.push({
name: propertyKey,
description,
type: { type: 'number' },
required: !optional,
});
} else if (type === 'boolean') {
metadata.fields.push({
name: propertyKey,
description,
type: { type: 'boolean' },
required: !optional,
});
} else if (Array.isArray(type)) {
const elementType = type[0];
metadata.fields.push({
name: propertyKey,
description,
type: {
type: 'array',
elementType:
elementType === 'string'
? { type: 'string' }
: elementType === 'number'
? { type: 'number' }
: elementType === 'boolean'
? { type: 'boolean' }
: typeof elementType === 'function'
? (GPT_TYPE_METADATA.get(elementType) as GPTTypeMetadata)
: { type: 'enum', values: elementType.enum },
},
required: !optional,
});
} else if (typeof type === 'function') {
metadata.fields.push({
name: propertyKey,
description,
type: GPT_TYPE_METADATA.get(type) as GPTTypeMetadata,
required: !optional,
});
} else {
metadata.fields.push({
name: propertyKey,
description,
type: { type: 'enum', values: type.enum },
required: !optional,
});
}
GPT_TYPE_METADATA.set(ctor, metadata);
};
}
/**
* Use this decorator on a string property within a custom class to include it as a parameter for function-calling.
*
* @param description - Description of the field.
* @param optional - Whether the field is optional. Default to `false`.
*/
export function gptString(description: string, optional = false) {
return gptObjectField('string', description, optional);
}
/**
* Use this decorator on a number property within a custom class to include it as a parameter for function-calling.
*
* @param description - Description of the field.
* @param optional - Whether the field is optional. Default to `false`.
*/
export function gptNumber(description: string, optional = false) {
return gptObjectField('number', description, optional);
}
/**
* Use this decorator on a boolean property within a custom class to include it as a parameter for function-calling.
*
* @param description - Description of the field.
* @param optional - Whether the field is optional. Default to `false`.
*/
export function gptBoolean(description: string, optional = false) {
return gptObjectField('boolean', description, optional);
}
/**
* Use this decorator on a custom class property within a custom class to include it as a parameter for function-calling.
*
* @param type - Type of the field.
* @param description - Description of the field.
* @param optional - Whether the field is optional. Default to `false`.
*/
export function gptObject(type: new () => unknown, description: string, optional = false) {
return gptObjectField(type, description, optional);
}
/**
* Use this decorator on a custom class property within a custom class to include it as a parameter for function-calling.
*
* @param values - Possible values of the enum.
* @param description - Description of the field.
* @param optional - Whether the field is optional. Default to `false`.
*/
export function gptEnum(values: string[], description: string, optional = false) {
return gptObjectField({ enum: values }, description, optional);
}
/**
* Use this decorator on an array of strings property within a custom class to include it as a parameter for function-calling.
*
* @param description - Description of the field.
* @param optional - Whether the field is optional. Default to `false`.
*/
export function gptArray(
type: 'string' | 'number' | 'boolean' | { enum: string[] } | (new () => unknown),
description: string,
optional = false,
) {
return gptObjectField([type], description, optional);
}