Skip to content

Commit 5b68409

Browse files
thedadamsthedadams
committed
chore: rename Client to GPTScript
This change also defaults to the SDK server selecting a random available port.
1 parent 9cdc6e2 commit 5b68409

File tree

3 files changed

+129
-118
lines changed

3 files changed

+129
-118
lines changed

‎README.md

+34-34
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,12 @@ npm exec -c "gptscript https://get.gptscript.ai/echo.gpt --input 'Hello, World!'
2929

3030
You will see "Hello, World!" in the output of the command.
3131

32-
## Client
32+
## GPTScript
3333

34-
The client allows the caller to run gptscript files, tools, and other operations (see below). There are currently no
35-
options for this singleton client, so `new gptscript.Client()` is all you need. Although, the intention is that a
36-
single client is all you need for the life of your application, you should call `close()` on the client when you are
37-
done.
34+
The GPTScript instance allows the caller to run gptscript files, tools, and other operations (see below). There are
35+
currently no options for this class, so `new gptscript.GPTScript()` is all you need. Although, the intention is that a
36+
single instance is all you need for the life of your application, you should call `close()` on the instance when you
37+
are done.
3838

3939
## Options
4040

@@ -64,10 +64,10 @@ Lists all the available built-in tools.
6464
const gptscript = require('@gptscript-ai/gptscript');
6565

6666
async function listTools() {
67-
const client = new gptscript.Client();
68-
const tools = await client.listTools();
67+
const g = new gptscript.GPTScript();
68+
const tools = await g.listTools();
6969
console.log(tools);
70-
client.close()
70+
g.close();
7171
}
7272
```
7373

@@ -82,13 +82,13 @@ const gptscript = require('@gptscript-ai/gptscript');
8282

8383
async function listModels() {
8484
let models = [];
85-
const client = new gptscript.Client();
85+
const g = new gptscript.GPTScript();
8686
try {
87-
models = await client.listModels();
87+
models = await g.listModels();
8888
} catch (error) {
8989
console.error(error);
9090
}
91-
client.close()
91+
g.close();
9292
}
9393
```
9494

@@ -102,13 +102,13 @@ Get the first of the current `gptscript` binary being used for the calls.
102102
const gptscript = require('@gptscript-ai/gptscript');
103103

104104
async function version() {
105-
const client = new gptscript.Client();
105+
const g = new gptscript.GPTScript();
106106
try {
107-
console.log(await client.version());
107+
console.log(await g.version());
108108
} catch (error) {
109109
console.error(error);
110110
}
111-
client.close()
111+
g.close();
112112
}
113113
```
114114

@@ -124,14 +124,14 @@ const t = {
124124
instructions: "Who was the president of the united states in 1928?"
125125
};
126126

127-
const client = new gptscript.Client();
127+
const g = new gptscript.GPTScript();
128128
try {
129-
const run = await client.evaluate(t);
129+
const run = await g.evaluate(t);
130130
console.log(await run.text());
131131
} catch (error) {
132132
console.error(error);
133133
}
134-
client.close();
134+
g.close();
135135
```
136136

137137
### run
@@ -147,14 +147,14 @@ const opts = {
147147
};
148148

149149
async function execFile() {
150-
const client = new gptscript.Client();
150+
const g = new gptscript.GPTScript();
151151
try {
152-
const run = await client.run('./hello.gpt', opts);
152+
const run = await g.run('./hello.gpt', opts);
153153
console.log(await run.text());
154154
} catch (e) {
155155
console.error(e);
156156
}
157-
client.close();
157+
g.close();
158158
}
159159
```
160160

@@ -175,9 +175,9 @@ const opts = {
175175
};
176176

177177
async function streamExecFileWithEvents() {
178-
const client = new gptscript.Client();
178+
const g = new gptscript.GPTScript();
179179
try {
180-
const run = await client.run('./test.gpt', opts);
180+
const run = await g.run('./test.gpt', opts);
181181

182182
run.on(gptscript.RunEventType.Event, data => {
183183
console.log(`event: ${JSON.stringify(data)}`);
@@ -187,7 +187,7 @@ async function streamExecFileWithEvents() {
187187
} catch (e) {
188188
console.error(e);
189189
}
190-
client.close();
190+
g.close();
191191
}
192192
```
193193

@@ -206,15 +206,15 @@ const opts = {
206206
};
207207

208208
async function streamExecFileWithEvents() {
209-
const client = new gptscript.Client();
209+
const g = new gptscript.GPTScript();
210210
try {
211-
const run = await client.run('./test.gpt', opts);
211+
const run = await g.run('./test.gpt', opts);
212212

213213
run.on(gptscript.RunEventType.CallConfirm, async (data: gptscript.CallFrame) => {
214214
// data.Tool has the information for the command being run.
215215
// data.Input has the input for this command
216216

217-
await client.confirm({
217+
await g.confirm({
218218
id: data.id,
219219
accept: true, // false if the command should not be run
220220
message: "", // Explain the denial (ignored if accept is true)
@@ -225,7 +225,7 @@ async function streamExecFileWithEvents() {
225225
} catch (e) {
226226
console.error(e);
227227
}
228-
client.close();
228+
g.close();
229229
}
230230
```
231231

@@ -245,14 +245,14 @@ const opts = {
245245
};
246246

247247
async function streamExecFileWithEvents() {
248-
const client = new gptscript.Client();
248+
const g = new gptscript.GPTScript();
249249
try {
250-
const run = await client.run('./test.gpt', opts);
250+
const run = await g.run('./test.gpt', opts);
251251

252252
run.on(gptscript.RunEventType.Prompt, async (data: gptscript.PromptFrame) => {
253253
// data will have the information for what the gptscript is prompting.
254254

255-
await client.promptResponse({
255+
await g.promptResponse({
256256
id: data.id,
257257
// response is a map of fields to values
258258
responses: {[data.fields[0]]: "Some Value"}
@@ -263,7 +263,7 @@ async function streamExecFileWithEvents() {
263263
} catch (e) {
264264
console.error(e);
265265
}
266-
client.close();
266+
g.close();
267267
}
268268
```
269269

@@ -292,8 +292,8 @@ const t = {
292292
};
293293

294294
async function streamExecFileWithEvents() {
295-
const client = new gptscript.Client();
296-
let run = await client.evaluate(t, opts);
295+
const g = new gptscript.GPTScript();
296+
let run = await g.evaluate(t, opts);
297297
try {
298298
// Wait for the initial run to complete.
299299
await run.text();
@@ -312,7 +312,7 @@ async function streamExecFileWithEvents() {
312312
console.error(e);
313313
}
314314

315-
client.close();
315+
g.close();
316316

317317
// The state here should either be RunState.Finished (on success) or RunState.Error (on error).
318318
console.log(run.state)

‎src/gptscript.ts

+58-47
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import http from "http"
22
import path from "path"
33
import child_process from "child_process"
44
import {fileURLToPath} from "url"
5+
import net from "net"
56

67
export interface RunOpts {
78
input?: string
@@ -31,35 +32,45 @@ export enum RunEventType {
3132
Prompt = "prompt"
3233
}
3334

34-
let serverProcess: child_process.ChildProcess
35-
let clientCount: number = 0
35+
export class GPTScript {
36+
private static serverURL: string = ""
37+
private static serverProcess: child_process.ChildProcess
38+
private static instanceCount: number = 0
3639

37-
export class Client {
38-
private readonly gptscriptURL: string
39-
private clientReady: boolean
4040

41-
constructor() {
42-
this.clientReady = false
43-
this.gptscriptURL = "http://" + (process.env.GPTSCRIPT_URL || "127.0.0.1:9090")
44-
clientCount++
45-
if (clientCount === 1 && process.env.GPTSCRIPT_DISABLE_SERVER !== "true") {
46-
serverProcess = child_process.spawn(getCmdPath(), ["--listen-address", this.gptscriptURL.replace("http://", "").replace("https://", ""), "sdkserver"], {
47-
env: process.env,
48-
stdio: ["pipe"]
49-
})
41+
private ready: boolean
5042

51-
process.on("exit", (code) => {
52-
serverProcess.stdin?.end()
53-
serverProcess.kill(code)
54-
})
43+
constructor() {
44+
this.ready = false
45+
GPTScript.instanceCount++
46+
if (GPTScript.instanceCount === 1 && process.env.GPTSCRIPT_DISABLE_SERVER !== "true") {
47+
GPTScript.serverURL = process.env.GPTSCRIPT_URL || "http://127.0.0.1:0"
48+
const u = new URL(GPTScript.serverURL)
49+
if (u.port === "0") {
50+
const srv = net.createServer()
51+
const s = srv.listen(0, () => {
52+
GPTScript.serverURL = "http://" + u.hostname + ":" + String((s.address() as net.AddressInfo).port)
53+
srv.close()
54+
55+
GPTScript.serverProcess = child_process.spawn(getCmdPath(), ["--listen-address", GPTScript.serverURL.replace("http://", ""), "sdkserver"], {
56+
env: process.env,
57+
stdio: ["pipe"]
58+
})
59+
60+
process.on("exit", (code) => {
61+
GPTScript.serverProcess.stdin?.end()
62+
GPTScript.serverProcess.kill(code)
63+
})
64+
})
65+
}
5566
}
5667
}
5768

5869
close(): void {
59-
clientCount--
60-
if (clientCount === 0 && serverProcess) {
61-
serverProcess.kill("SIGTERM")
62-
serverProcess.stdin?.end()
70+
GPTScript.instanceCount--
71+
if (GPTScript.instanceCount === 0 && GPTScript.serverProcess) {
72+
GPTScript.serverProcess.kill("SIGTERM")
73+
GPTScript.serverProcess.stdin?.end()
6374
}
6475
}
6576

@@ -76,10 +87,10 @@ export class Client {
7687
}
7788

7889
async runBasicCommand(cmd: string): Promise<string> {
79-
if (!this.clientReady) {
80-
this.clientReady = await this.testGPTScriptURL(20)
90+
if (!this.ready) {
91+
this.ready = await this.testGPTScriptURL(20)
8192
}
82-
const r = new RunSubcommand(cmd, "", "", {}, this.gptscriptURL)
93+
const r = new RunSubcommand(cmd, "", "", {}, GPTScript.serverURL)
8394
r.requestNoStream(null)
8495
return r.text()
8596
}
@@ -92,10 +103,10 @@ export class Client {
92103
* @return {Run} The Run object representing the running tool.
93104
*/
94105
async run(toolName: string, opts: RunOpts = {}): Promise<Run> {
95-
if (!this.clientReady) {
96-
this.clientReady = await this.testGPTScriptURL(20)
106+
if (!this.ready) {
107+
this.ready = await this.testGPTScriptURL(20)
97108
}
98-
return (new Run("run", toolName, "", opts, this.gptscriptURL)).nextChat(opts.input)
109+
return (new Run("run", toolName, "", opts, GPTScript.serverURL)).nextChat(opts.input)
99110
}
100111

101112
/**
@@ -106,8 +117,8 @@ export class Client {
106117
* @return {Run} The Run object representing the evaluation.
107118
*/
108119
async evaluate(tool: ToolDef | ToolDef[] | string, opts: RunOpts = {}): Promise<Run> {
109-
if (!this.clientReady) {
110-
this.clientReady = await this.testGPTScriptURL(20)
120+
if (!this.ready) {
121+
this.ready = await this.testGPTScriptURL(20)
111122
}
112123
let toolString: string = ""
113124

@@ -119,30 +130,30 @@ export class Client {
119130
toolString = toolDefToString(tool)
120131
}
121132

122-
return (new Run("evaluate", "", toolString, opts, this.gptscriptURL)).nextChat(opts.input)
133+
return (new Run("evaluate", "", toolString, opts, GPTScript.serverURL)).nextChat(opts.input)
123134
}
124135

125136
async parse(fileName: string): Promise<Block[]> {
126-
if (!this.clientReady) {
127-
this.clientReady = await this.testGPTScriptURL(20)
137+
if (!this.ready) {
138+
this.ready = await this.testGPTScriptURL(20)
128139
}
129-
const r: Run = new RunSubcommand("parse", fileName, "", {}, this.gptscriptURL)
140+
const r: Run = new RunSubcommand("parse", fileName, "", {}, GPTScript.serverURL)
130141
r.request({file: fileName})
131142
return parseBlocksFromNodes((await r.json()).nodes)
132143
}
133144

134145
async parseTool(toolContent: string): Promise<Block[]> {
135-
if (!this.clientReady) {
136-
this.clientReady = await this.testGPTScriptURL(20)
146+
if (!this.ready) {
147+
this.ready = await this.testGPTScriptURL(20)
137148
}
138-
const r: Run = new RunSubcommand("parse", "", toolContent, {}, this.gptscriptURL)
149+
const r: Run = new RunSubcommand("parse", "", toolContent, {}, GPTScript.serverURL)
139150
r.request({content: toolContent})
140151
return parseBlocksFromNodes((await r.json()).nodes)
141152
}
142153

143154
async stringify(blocks: Block[]): Promise<string> {
144-
if (!this.clientReady) {
145-
this.clientReady = await this.testGPTScriptURL(20)
155+
if (!this.ready) {
156+
this.ready = await this.testGPTScriptURL(20)
146157
}
147158
const nodes: any[] = []
148159

@@ -162,16 +173,16 @@ export class Client {
162173
}
163174
}
164175

165-
const r: Run = new RunSubcommand("fmt", "", JSON.stringify({nodes: nodes}), {}, this.gptscriptURL)
176+
const r: Run = new RunSubcommand("fmt", "", JSON.stringify({nodes: nodes}), {}, GPTScript.serverURL)
166177
r.request({nodes: nodes})
167178
return r.text()
168179
}
169180

170181
async confirm(response: AuthResponse): Promise<void> {
171-
if (!this.clientReady) {
172-
this.clientReady = await this.testGPTScriptURL(20)
182+
if (!this.ready) {
183+
this.ready = await this.testGPTScriptURL(20)
173184
}
174-
const resp = await fetch(`${this.gptscriptURL}/confirm/${response.id}`, {
185+
const resp = await fetch(`${GPTScript.serverURL}/confirm/${response.id}`, {
175186
method: "POST",
176187
body: JSON.stringify(response)
177188
})
@@ -182,10 +193,10 @@ export class Client {
182193
}
183194

184195
async promptResponse(response: PromptResponse): Promise<void> {
185-
if (!this.clientReady) {
186-
this.clientReady = await this.testGPTScriptURL(20)
196+
if (!this.ready) {
197+
this.ready = await this.testGPTScriptURL(20)
187198
}
188-
const resp = await fetch(`${this.gptscriptURL}/prompt-response/${response.id}`, {
199+
const resp = await fetch(`${GPTScript.serverURL}/prompt-response/${response.id}`, {
189200
method: "POST",
190201
body: JSON.stringify(response.responses)
191202
})
@@ -197,7 +208,7 @@ export class Client {
197208

198209
private async testGPTScriptURL(count: number): Promise<boolean> {
199210
try {
200-
await fetch(`${this.gptscriptURL}/healthz`)
211+
await fetch(`${GPTScript.serverURL}/healthz`)
201212
return true
202213
} catch {
203214
if (count === 0) {

0 commit comments

Comments
 (0)