-
-
Notifications
You must be signed in to change notification settings - Fork 44
/
retrieval.ts
181 lines (155 loc) · 4.89 KB
/
retrieval.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
import assert from 'node:assert'
import fs from 'node:fs'
import { sha256 } from 'crypto-hash'
import delay from 'delay'
import 'dotenv/config'
import OpenAI from 'openai'
import { oraPromise } from 'ora'
import type { Run } from '~/lib/db'
/**
* This file contains an end-to-end Assistants example using the built-in
* `retrieval` tool which summarizes an attached markdown file.
*
* To run it against the offical OpenAI API:
* ```bash
* npx tsx e2e/retrieval.ts
* ```
*
* To run it against your custom, local API:
* ```bash
* OPENAI_API_BASE_URL='http://127.0.0.1:3000' npx tsx e2e/retrieval.ts
* ```
*/
async function main() {
const defaultBaseUrl = 'https://api.openai.com/v1'
const baseUrl = process.env.OPENAI_API_BASE_URL ?? defaultBaseUrl
const isOfficalAPI = baseUrl === defaultBaseUrl
const testId =
process.env.TEST_ID ??
`test_${(await sha256(Date.now().toString())).slice(0, 24)}`
const metadata = { testId, isOfficalAPI }
const cleanupTest = !process.env.NO_TEST_CLEANUP
console.log('baseUrl', baseUrl)
console.log('testId', testId)
console.log()
const openai = new OpenAI({
baseURL: baseUrl
})
let assistant: Awaited<
ReturnType<typeof openai.beta.assistants.create>
> | null = null
let thread: Awaited<ReturnType<typeof openai.beta.threads.create>> | null =
null
const readmeFileStream = fs.createReadStream('readme.md', 'utf8')
const readmeFile = await openai.files.create({
file: readmeFileStream,
purpose: 'assistants'
})
console.log('created readme file', readmeFile)
try {
assistant = await openai.beta.assistants.create({
model: 'gpt-4-1106-preview',
instructions: 'You are a helpful assistant.',
metadata,
tools: [
{
type: 'retrieval'
}
],
file_ids: [readmeFile.id]
})
assert(assistant)
console.log('created assistant', assistant)
thread = await openai.beta.threads.create({
metadata,
messages: [
{
role: 'user',
content:
'Give me a concise summary of the attached file using markdown.',
metadata
}
]
})
assert(thread)
console.log('created thread', thread)
let listMessages = await openai.beta.threads.messages.list(thread.id)
assert(listMessages?.data)
console.log('messages', prettifyMessages(listMessages.data))
let run = await openai.beta.threads.runs.create(thread.id, {
assistant_id: assistant.id,
metadata,
instructions: assistant.instructions,
model: assistant.model,
tools: assistant.tools
})
assert(run?.id)
console.log('created run', run)
let listRunSteps = await openai.beta.threads.runs.steps.list(
thread.id,
run.id
)
assert(listRunSteps?.data)
console.log('runSteps', listRunSteps.data)
async function waitForRunStatus(
status: Run['status'],
{ intervalMs = 500 }: { intervalMs?: number } = {}
) {
assert(run?.id)
return oraPromise(async () => {
while (run.status !== status) {
if (
status !== run.status &&
(run.status === 'cancelled' ||
run.status === 'cancelling' ||
run.status === 'failed' ||
run.status === 'expired')
) {
throw new Error(
`Error run "${run.id}" status reached terminal status "${run.status}" while waiting for status "${status}"`
)
}
await delay(intervalMs)
assert(thread?.id)
assert(run?.id)
run = await openai.beta.threads.runs.retrieve(thread.id, run.id)
assert(run?.id)
}
}, `waiting for run "${run.id}" to have status "${status}"...`)
}
await waitForRunStatus('completed')
console.log('run', run)
listRunSteps = await openai.beta.threads.runs.steps.list(thread.id, run.id)
assert(listRunSteps?.data)
console.log('runSteps', listRunSteps.data)
thread = await openai.beta.threads.retrieve(thread.id)
assert(thread)
console.log('thread', thread)
listMessages = await openai.beta.threads.messages.list(thread.id)
assert(listMessages?.data)
console.log('messages', prettifyMessages(listMessages.data))
} catch (err) {
console.error(err)
process.exit(1)
} finally {
if (cleanupTest) {
// TODO: there's no way to delete messages, runs, or run steps...
// maybe deleting the thread implicitly causes a cascade of deletes?
// TODO: test this assumption
if (thread?.id) {
await openai.beta.threads.del(thread.id)
}
if (assistant?.id) {
await openai.beta.assistants.del(assistant.id)
}
}
}
}
// Make message content easier to read in the console
function prettifyMessages(messages: any[]) {
return messages.map((message) => ({
...message,
content: message.content?.[0]?.text?.value ?? message.content
}))
}
main()