openai 4.16.0 → 4.16.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +35 -0
- package/README.md +2 -2
- package/lib/AbstractChatCompletionRunner.d.ts.map +1 -1
- package/lib/AbstractChatCompletionRunner.js +2 -0
- package/lib/AbstractChatCompletionRunner.js.map +1 -1
- package/lib/AbstractChatCompletionRunner.mjs +2 -0
- package/lib/AbstractChatCompletionRunner.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/beta/assistants/assistants.d.ts +38 -38
- package/resources/beta/assistants/assistants.js +4 -4
- package/resources/beta/assistants/assistants.mjs +4 -4
- package/resources/beta/assistants/files.d.ts +9 -9
- package/resources/beta/assistants/files.js +3 -3
- package/resources/beta/assistants/files.mjs +3 -3
- package/resources/beta/assistants/index.d.ts +1 -1
- package/resources/beta/beta.d.ts +1 -1
- package/resources/beta/index.d.ts +1 -1
- package/resources/beta/threads/messages/files.d.ts +5 -5
- package/resources/beta/threads/messages/files.js +1 -1
- package/resources/beta/threads/messages/files.mjs +1 -1
- package/resources/beta/threads/messages/messages.d.ts +36 -36
- package/resources/beta/threads/messages/messages.js +3 -3
- package/resources/beta/threads/messages/messages.mjs +3 -3
- package/resources/beta/threads/runs/runs.d.ts +45 -45
- package/resources/beta/threads/runs/runs.js +5 -5
- package/resources/beta/threads/runs/runs.mjs +5 -5
- package/resources/beta/threads/runs/steps.d.ts +32 -32
- package/resources/beta/threads/runs/steps.js +1 -1
- package/resources/beta/threads/runs/steps.mjs +1 -1
- package/resources/beta/threads/threads.d.ts +33 -32
- package/resources/beta/threads/threads.d.ts.map +1 -1
- package/resources/beta/threads/threads.js +9 -8
- package/resources/beta/threads/threads.js.map +1 -1
- package/resources/beta/threads/threads.mjs +9 -8
- package/resources/beta/threads/threads.mjs.map +1 -1
- package/resources/chat/completions.d.ts +12 -5
- package/resources/chat/completions.d.ts.map +1 -1
- package/resources/chat/completions.js.map +1 -1
- package/resources/chat/completions.mjs.map +1 -1
- package/resources/embeddings.d.ts +2 -2
- package/resources/embeddings.d.ts.map +1 -1
- package/resources/files.d.ts +5 -5
- package/src/lib/AbstractChatCompletionRunner.ts +4 -0
- package/src/resources/beta/assistants/assistants.ts +38 -38
- package/src/resources/beta/assistants/files.ts +9 -9
- package/src/resources/beta/assistants/index.ts +1 -1
- package/src/resources/beta/beta.ts +1 -1
- package/src/resources/beta/index.ts +1 -1
- package/src/resources/beta/threads/messages/files.ts +5 -5
- package/src/resources/beta/threads/messages/messages.ts +36 -36
- package/src/resources/beta/threads/runs/runs.ts +45 -45
- package/src/resources/beta/threads/runs/steps.ts +32 -32
- package/src/resources/beta/threads/threads.ts +41 -32
- package/src/resources/chat/completions.ts +14 -4
- package/src/resources/embeddings.ts +2 -2
- package/src/resources/files.ts +5 -5
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -31,9 +31,9 @@ const FilesAPI = __importStar(require("openai/resources/beta/assistants/files"))
|
|
|
31
31
|
const pagination_1 = require("openai/pagination");
|
|
32
32
|
class Files extends resource_1.APIResource {
|
|
33
33
|
/**
|
|
34
|
-
* Create an
|
|
34
|
+
* Create an assistant file by attaching a
|
|
35
35
|
* [File](https://platform.openai.com/docs/api-reference/files) to an
|
|
36
|
-
* [
|
|
36
|
+
* [assistant](https://platform.openai.com/docs/api-reference/assistants).
|
|
37
37
|
*/
|
|
38
38
|
create(assistantId, body, options) {
|
|
39
39
|
return this.post(`/assistants/${assistantId}/files`, {
|
|
@@ -62,7 +62,7 @@ class Files extends resource_1.APIResource {
|
|
|
62
62
|
});
|
|
63
63
|
}
|
|
64
64
|
/**
|
|
65
|
-
* Delete an
|
|
65
|
+
* Delete an assistant file.
|
|
66
66
|
*/
|
|
67
67
|
del(assistantId, fileId, options) {
|
|
68
68
|
return this.delete(`/assistants/${assistantId}/files/${fileId}`, {
|
|
@@ -5,9 +5,9 @@ import * as FilesAPI from 'openai/resources/beta/assistants/files';
|
|
|
5
5
|
import { CursorPage } from 'openai/pagination';
|
|
6
6
|
export class Files extends APIResource {
|
|
7
7
|
/**
|
|
8
|
-
* Create an
|
|
8
|
+
* Create an assistant file by attaching a
|
|
9
9
|
* [File](https://platform.openai.com/docs/api-reference/files) to an
|
|
10
|
-
* [
|
|
10
|
+
* [assistant](https://platform.openai.com/docs/api-reference/assistants).
|
|
11
11
|
*/
|
|
12
12
|
create(assistantId, body, options) {
|
|
13
13
|
return this.post(`/assistants/${assistantId}/files`, {
|
|
@@ -36,7 +36,7 @@ export class Files extends APIResource {
|
|
|
36
36
|
});
|
|
37
37
|
}
|
|
38
38
|
/**
|
|
39
|
-
* Delete an
|
|
39
|
+
* Delete an assistant file.
|
|
40
40
|
*/
|
|
41
41
|
del(assistantId, fileId, options) {
|
|
42
42
|
return this.delete(`/assistants/${assistantId}/files/${fileId}`, {
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
export { Assistant,
|
|
1
|
+
export { Assistant, AssistantDeleted, AssistantCreateParams, AssistantUpdateParams, AssistantListParams, AssistantsPage, Assistants, } from "./assistants.js";
|
|
2
2
|
export { AssistantFile, FileDeleteResponse, FileCreateParams, FileListParams, AssistantFilesPage, Files, } from "./files.js";
|
|
3
3
|
//# sourceMappingURL=index.d.ts.map
|
package/resources/beta/beta.d.ts
CHANGED
|
@@ -11,7 +11,7 @@ export declare namespace Beta {
|
|
|
11
11
|
export import Chat = ChatAPI.Chat;
|
|
12
12
|
export import Assistants = AssistantsAPI.Assistants;
|
|
13
13
|
export import Assistant = AssistantsAPI.Assistant;
|
|
14
|
-
export import
|
|
14
|
+
export import AssistantDeleted = AssistantsAPI.AssistantDeleted;
|
|
15
15
|
export import AssistantsPage = AssistantsAPI.AssistantsPage;
|
|
16
16
|
export import AssistantCreateParams = AssistantsAPI.AssistantCreateParams;
|
|
17
17
|
export import AssistantUpdateParams = AssistantsAPI.AssistantUpdateParams;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { Assistant,
|
|
1
|
+
export { Assistant, AssistantDeleted, AssistantCreateParams, AssistantUpdateParams, AssistantListParams, AssistantsPage, Assistants, } from "./assistants/index.js";
|
|
2
2
|
export { Beta } from "./beta.js";
|
|
3
3
|
export { Chat } from "./chat/index.js";
|
|
4
4
|
export { Thread, ThreadDeleted, ThreadCreateParams, ThreadUpdateParams, ThreadCreateAndRunParams, Threads, } from "./threads/index.js";
|
|
@@ -4,11 +4,11 @@ import * as FilesAPI from 'openai/resources/beta/threads/messages/files';
|
|
|
4
4
|
import { CursorPage, type CursorPageParams } from 'openai/pagination';
|
|
5
5
|
export declare class Files extends APIResource {
|
|
6
6
|
/**
|
|
7
|
-
* Retrieves a
|
|
7
|
+
* Retrieves a message file.
|
|
8
8
|
*/
|
|
9
9
|
retrieve(threadId: string, messageId: string, fileId: string, options?: Core.RequestOptions): Core.APIPromise<MessageFile>;
|
|
10
10
|
/**
|
|
11
|
-
* Returns a list of
|
|
11
|
+
* Returns a list of message files.
|
|
12
12
|
*/
|
|
13
13
|
list(threadId: string, messageId: string, query?: FileListParams, options?: Core.RequestOptions): Core.PagePromise<MessageFilesPage, MessageFile>;
|
|
14
14
|
list(threadId: string, messageId: string, options?: Core.RequestOptions): Core.PagePromise<MessageFilesPage, MessageFile>;
|
|
@@ -16,7 +16,7 @@ export declare class Files extends APIResource {
|
|
|
16
16
|
export declare class MessageFilesPage extends CursorPage<MessageFile> {
|
|
17
17
|
}
|
|
18
18
|
/**
|
|
19
|
-
* A list of
|
|
19
|
+
* A list of files attached to a `message`.
|
|
20
20
|
*/
|
|
21
21
|
export interface MessageFile {
|
|
22
22
|
/**
|
|
@@ -24,11 +24,11 @@ export interface MessageFile {
|
|
|
24
24
|
*/
|
|
25
25
|
id: string;
|
|
26
26
|
/**
|
|
27
|
-
* The Unix timestamp (in seconds) for when the
|
|
27
|
+
* The Unix timestamp (in seconds) for when the message file was created.
|
|
28
28
|
*/
|
|
29
29
|
created_at: number;
|
|
30
30
|
/**
|
|
31
|
-
* The ID of the [
|
|
31
|
+
* The ID of the [message](https://platform.openai.com/docs/api-reference/messages)
|
|
32
32
|
* that the [File](https://platform.openai.com/docs/api-reference/files) is
|
|
33
33
|
* attached to.
|
|
34
34
|
*/
|
|
@@ -31,7 +31,7 @@ const FilesAPI = __importStar(require("openai/resources/beta/threads/messages/fi
|
|
|
31
31
|
const pagination_1 = require("openai/pagination");
|
|
32
32
|
class Files extends resource_1.APIResource {
|
|
33
33
|
/**
|
|
34
|
-
* Retrieves a
|
|
34
|
+
* Retrieves a message file.
|
|
35
35
|
*/
|
|
36
36
|
retrieve(threadId, messageId, fileId, options) {
|
|
37
37
|
return this.get(`/threads/${threadId}/messages/${messageId}/files/${fileId}`, {
|
|
@@ -5,7 +5,7 @@ import * as FilesAPI from 'openai/resources/beta/threads/messages/files';
|
|
|
5
5
|
import { CursorPage } from 'openai/pagination';
|
|
6
6
|
export class Files extends APIResource {
|
|
7
7
|
/**
|
|
8
|
-
* Retrieves a
|
|
8
|
+
* Retrieves a message file.
|
|
9
9
|
*/
|
|
10
10
|
retrieve(threadId, messageId, fileId, options) {
|
|
11
11
|
return this.get(`/threads/${threadId}/messages/${messageId}/files/${fileId}`, {
|
|
@@ -6,19 +6,19 @@ import { CursorPage, type CursorPageParams } from 'openai/pagination';
|
|
|
6
6
|
export declare class Messages extends APIResource {
|
|
7
7
|
files: FilesAPI.Files;
|
|
8
8
|
/**
|
|
9
|
-
* Create a
|
|
9
|
+
* Create a message.
|
|
10
10
|
*/
|
|
11
11
|
create(threadId: string, body: MessageCreateParams, options?: Core.RequestOptions): Core.APIPromise<ThreadMessage>;
|
|
12
12
|
/**
|
|
13
|
-
* Retrieve a
|
|
13
|
+
* Retrieve a message.
|
|
14
14
|
*/
|
|
15
15
|
retrieve(threadId: string, messageId: string, options?: Core.RequestOptions): Core.APIPromise<ThreadMessage>;
|
|
16
16
|
/**
|
|
17
|
-
* Modifies a
|
|
17
|
+
* Modifies a message.
|
|
18
18
|
*/
|
|
19
19
|
update(threadId: string, messageId: string, body: MessageUpdateParams, options?: Core.RequestOptions): Core.APIPromise<ThreadMessage>;
|
|
20
20
|
/**
|
|
21
|
-
* Returns a list of
|
|
21
|
+
* Returns a list of messages for a given thread.
|
|
22
22
|
*/
|
|
23
23
|
list(threadId: string, query?: MessageListParams, options?: Core.RequestOptions): Core.PagePromise<ThreadMessagesPage, ThreadMessage>;
|
|
24
24
|
list(threadId: string, options?: Core.RequestOptions): Core.PagePromise<ThreadMessagesPage, ThreadMessage>;
|
|
@@ -27,12 +27,12 @@ export declare class ThreadMessagesPage extends CursorPage<ThreadMessage> {
|
|
|
27
27
|
}
|
|
28
28
|
/**
|
|
29
29
|
* References an image [File](https://platform.openai.com/docs/api-reference/files)
|
|
30
|
-
* in the content of a
|
|
30
|
+
* in the content of a message.
|
|
31
31
|
*/
|
|
32
32
|
export interface MessageContentImageFile {
|
|
33
33
|
image_file: MessageContentImageFile.ImageFile;
|
|
34
34
|
/**
|
|
35
|
-
*
|
|
35
|
+
* Always `image_file`.
|
|
36
36
|
*/
|
|
37
37
|
type: 'image_file';
|
|
38
38
|
}
|
|
@@ -40,18 +40,18 @@ export declare namespace MessageContentImageFile {
|
|
|
40
40
|
interface ImageFile {
|
|
41
41
|
/**
|
|
42
42
|
* The [File](https://platform.openai.com/docs/api-reference/files) ID of the image
|
|
43
|
-
* in the
|
|
43
|
+
* in the message content.
|
|
44
44
|
*/
|
|
45
45
|
file_id: string;
|
|
46
46
|
}
|
|
47
47
|
}
|
|
48
48
|
/**
|
|
49
|
-
* The text content that is part of a
|
|
49
|
+
* The text content that is part of a message.
|
|
50
50
|
*/
|
|
51
51
|
export interface MessageContentText {
|
|
52
52
|
text: MessageContentText.Text;
|
|
53
53
|
/**
|
|
54
|
-
*
|
|
54
|
+
* Always `text`.
|
|
55
55
|
*/
|
|
56
56
|
type: 'text';
|
|
57
57
|
}
|
|
@@ -65,8 +65,8 @@ export declare namespace MessageContentText {
|
|
|
65
65
|
}
|
|
66
66
|
namespace Text {
|
|
67
67
|
/**
|
|
68
|
-
* A citation within the
|
|
69
|
-
* File associated with the
|
|
68
|
+
* A citation within the message that points to a specific quote from a specific
|
|
69
|
+
* File associated with the assistant or the message. Generated when the assistant
|
|
70
70
|
* uses the "retrieval" tool to search files.
|
|
71
71
|
*/
|
|
72
72
|
interface FileCitation {
|
|
@@ -74,11 +74,11 @@ export declare namespace MessageContentText {
|
|
|
74
74
|
file_citation: FileCitation.FileCitation;
|
|
75
75
|
start_index: number;
|
|
76
76
|
/**
|
|
77
|
-
* The text in the
|
|
77
|
+
* The text in the message content that needs to be replaced.
|
|
78
78
|
*/
|
|
79
79
|
text: string;
|
|
80
80
|
/**
|
|
81
|
-
*
|
|
81
|
+
* Always `file_citation`.
|
|
82
82
|
*/
|
|
83
83
|
type: 'file_citation';
|
|
84
84
|
}
|
|
@@ -89,32 +89,32 @@ export declare namespace MessageContentText {
|
|
|
89
89
|
*/
|
|
90
90
|
file_id: string;
|
|
91
91
|
/**
|
|
92
|
-
* The specific quote in the
|
|
92
|
+
* The specific quote in the file.
|
|
93
93
|
*/
|
|
94
94
|
quote: string;
|
|
95
95
|
}
|
|
96
96
|
}
|
|
97
97
|
/**
|
|
98
|
-
* A URL for the
|
|
99
|
-
* `code_interpreter` tool to generate a
|
|
98
|
+
* A URL for the file that's generated when the assistant used the
|
|
99
|
+
* `code_interpreter` tool to generate a file.
|
|
100
100
|
*/
|
|
101
101
|
interface FilePath {
|
|
102
102
|
end_index: number;
|
|
103
103
|
file_path: FilePath.FilePath;
|
|
104
104
|
start_index: number;
|
|
105
105
|
/**
|
|
106
|
-
* The text in the
|
|
106
|
+
* The text in the message content that needs to be replaced.
|
|
107
107
|
*/
|
|
108
108
|
text: string;
|
|
109
109
|
/**
|
|
110
|
-
*
|
|
110
|
+
* Always `file_path`.
|
|
111
111
|
*/
|
|
112
112
|
type: 'file_path';
|
|
113
113
|
}
|
|
114
114
|
namespace FilePath {
|
|
115
115
|
interface FilePath {
|
|
116
116
|
/**
|
|
117
|
-
* The ID of the
|
|
117
|
+
* The ID of the file that was generated.
|
|
118
118
|
*/
|
|
119
119
|
file_id: string;
|
|
120
120
|
}
|
|
@@ -122,8 +122,8 @@ export declare namespace MessageContentText {
|
|
|
122
122
|
}
|
|
123
123
|
}
|
|
124
124
|
/**
|
|
125
|
-
* Represents a
|
|
126
|
-
* [
|
|
125
|
+
* Represents a message within a
|
|
126
|
+
* [thread](https://platform.openai.com/docs/api-reference/threads).
|
|
127
127
|
*/
|
|
128
128
|
export interface ThreadMessage {
|
|
129
129
|
/**
|
|
@@ -132,22 +132,22 @@ export interface ThreadMessage {
|
|
|
132
132
|
id: string;
|
|
133
133
|
/**
|
|
134
134
|
* If applicable, the ID of the
|
|
135
|
-
* [
|
|
136
|
-
* authored this
|
|
135
|
+
* [assistant](https://platform.openai.com/docs/api-reference/assistants) that
|
|
136
|
+
* authored this message.
|
|
137
137
|
*/
|
|
138
138
|
assistant_id: string | null;
|
|
139
139
|
/**
|
|
140
|
-
* The content of the
|
|
140
|
+
* The content of the message in array of text and/or images.
|
|
141
141
|
*/
|
|
142
142
|
content: Array<MessageContentImageFile | MessageContentText>;
|
|
143
143
|
/**
|
|
144
|
-
* The Unix timestamp (in seconds) for when the
|
|
144
|
+
* The Unix timestamp (in seconds) for when the message was created.
|
|
145
145
|
*/
|
|
146
146
|
created_at: number;
|
|
147
147
|
/**
|
|
148
148
|
* A list of [file](https://platform.openai.com/docs/api-reference/files) IDs that
|
|
149
|
-
* the
|
|
150
|
-
* that can access files. A maximum of 10 files can be attached to a
|
|
149
|
+
* the assistant should use. Useful for tools like retrieval and code_interpreter
|
|
150
|
+
* that can access files. A maximum of 10 files can be attached to a message.
|
|
151
151
|
*/
|
|
152
152
|
file_ids: Array<string>;
|
|
153
153
|
/**
|
|
@@ -162,18 +162,18 @@ export interface ThreadMessage {
|
|
|
162
162
|
*/
|
|
163
163
|
object: 'thread.message';
|
|
164
164
|
/**
|
|
165
|
-
* The entity that produced the
|
|
165
|
+
* The entity that produced the message. One of `user` or `assistant`.
|
|
166
166
|
*/
|
|
167
167
|
role: 'user' | 'assistant';
|
|
168
168
|
/**
|
|
169
169
|
* If applicable, the ID of the
|
|
170
|
-
* [
|
|
171
|
-
* authoring of this
|
|
170
|
+
* [run](https://platform.openai.com/docs/api-reference/runs) associated with the
|
|
171
|
+
* authoring of this message.
|
|
172
172
|
*/
|
|
173
173
|
run_id: string | null;
|
|
174
174
|
/**
|
|
175
|
-
* The [
|
|
176
|
-
* this
|
|
175
|
+
* The [thread](https://platform.openai.com/docs/api-reference/threads) ID that
|
|
176
|
+
* this message belongs to.
|
|
177
177
|
*/
|
|
178
178
|
thread_id: string;
|
|
179
179
|
}
|
|
@@ -184,18 +184,18 @@ export interface ThreadMessageDeleted {
|
|
|
184
184
|
}
|
|
185
185
|
export interface MessageCreateParams {
|
|
186
186
|
/**
|
|
187
|
-
* The content of the
|
|
187
|
+
* The content of the message.
|
|
188
188
|
*/
|
|
189
189
|
content: string;
|
|
190
190
|
/**
|
|
191
|
-
* The role of the entity that is creating the
|
|
191
|
+
* The role of the entity that is creating the message. Currently only `user` is
|
|
192
192
|
* supported.
|
|
193
193
|
*/
|
|
194
194
|
role: 'user';
|
|
195
195
|
/**
|
|
196
196
|
* A list of [File](https://platform.openai.com/docs/api-reference/files) IDs that
|
|
197
|
-
* the
|
|
198
|
-
*
|
|
197
|
+
* the message should use. There can be a maximum of 10 files attached to a
|
|
198
|
+
* message. Useful for tools like `retrieval` and `code_interpreter` that can
|
|
199
199
|
* access and use files.
|
|
200
200
|
*/
|
|
201
201
|
file_ids?: Array<string>;
|
|
@@ -36,7 +36,7 @@ class Messages extends resource_1.APIResource {
|
|
|
36
36
|
this.files = new FilesAPI.Files(this.client);
|
|
37
37
|
}
|
|
38
38
|
/**
|
|
39
|
-
* Create a
|
|
39
|
+
* Create a message.
|
|
40
40
|
*/
|
|
41
41
|
create(threadId, body, options) {
|
|
42
42
|
return this.post(`/threads/${threadId}/messages`, {
|
|
@@ -46,7 +46,7 @@ class Messages extends resource_1.APIResource {
|
|
|
46
46
|
});
|
|
47
47
|
}
|
|
48
48
|
/**
|
|
49
|
-
* Retrieve a
|
|
49
|
+
* Retrieve a message.
|
|
50
50
|
*/
|
|
51
51
|
retrieve(threadId, messageId, options) {
|
|
52
52
|
return this.get(`/threads/${threadId}/messages/${messageId}`, {
|
|
@@ -55,7 +55,7 @@ class Messages extends resource_1.APIResource {
|
|
|
55
55
|
});
|
|
56
56
|
}
|
|
57
57
|
/**
|
|
58
|
-
* Modifies a
|
|
58
|
+
* Modifies a message.
|
|
59
59
|
*/
|
|
60
60
|
update(threadId, messageId, body, options) {
|
|
61
61
|
return this.post(`/threads/${threadId}/messages/${messageId}`, {
|
|
@@ -10,7 +10,7 @@ export class Messages extends APIResource {
|
|
|
10
10
|
this.files = new FilesAPI.Files(this.client);
|
|
11
11
|
}
|
|
12
12
|
/**
|
|
13
|
-
* Create a
|
|
13
|
+
* Create a message.
|
|
14
14
|
*/
|
|
15
15
|
create(threadId, body, options) {
|
|
16
16
|
return this.post(`/threads/${threadId}/messages`, {
|
|
@@ -20,7 +20,7 @@ export class Messages extends APIResource {
|
|
|
20
20
|
});
|
|
21
21
|
}
|
|
22
22
|
/**
|
|
23
|
-
* Retrieve a
|
|
23
|
+
* Retrieve a message.
|
|
24
24
|
*/
|
|
25
25
|
retrieve(threadId, messageId, options) {
|
|
26
26
|
return this.get(`/threads/${threadId}/messages/${messageId}`, {
|
|
@@ -29,7 +29,7 @@ export class Messages extends APIResource {
|
|
|
29
29
|
});
|
|
30
30
|
}
|
|
31
31
|
/**
|
|
32
|
-
* Modifies a
|
|
32
|
+
* Modifies a message.
|
|
33
33
|
*/
|
|
34
34
|
update(threadId, messageId, body, options) {
|
|
35
35
|
return this.post(`/threads/${threadId}/messages/${messageId}`, {
|
|
@@ -6,28 +6,28 @@ import { CursorPage, type CursorPageParams } from 'openai/pagination';
|
|
|
6
6
|
export declare class Runs extends APIResource {
|
|
7
7
|
steps: StepsAPI.Steps;
|
|
8
8
|
/**
|
|
9
|
-
* Create a
|
|
9
|
+
* Create a run.
|
|
10
10
|
*/
|
|
11
11
|
create(threadId: string, body: RunCreateParams, options?: Core.RequestOptions): Core.APIPromise<Run>;
|
|
12
12
|
/**
|
|
13
|
-
* Retrieves a
|
|
13
|
+
* Retrieves a run.
|
|
14
14
|
*/
|
|
15
15
|
retrieve(threadId: string, runId: string, options?: Core.RequestOptions): Core.APIPromise<Run>;
|
|
16
16
|
/**
|
|
17
|
-
* Modifies a
|
|
17
|
+
* Modifies a run.
|
|
18
18
|
*/
|
|
19
19
|
update(threadId: string, runId: string, body: RunUpdateParams, options?: Core.RequestOptions): Core.APIPromise<Run>;
|
|
20
20
|
/**
|
|
21
|
-
* Returns a list of
|
|
21
|
+
* Returns a list of runs belonging to a thread.
|
|
22
22
|
*/
|
|
23
23
|
list(threadId: string, query?: RunListParams, options?: Core.RequestOptions): Core.PagePromise<RunsPage, Run>;
|
|
24
24
|
list(threadId: string, options?: Core.RequestOptions): Core.PagePromise<RunsPage, Run>;
|
|
25
25
|
/**
|
|
26
|
-
* Cancels a
|
|
26
|
+
* Cancels a run that is `in_progress`.
|
|
27
27
|
*/
|
|
28
28
|
cancel(threadId: string, runId: string, options?: Core.RequestOptions): Core.APIPromise<Run>;
|
|
29
29
|
/**
|
|
30
|
-
* When a
|
|
30
|
+
* When a run has the `status: "requires_action"` and `required_action.type` is
|
|
31
31
|
* `submit_tool_outputs`, this endpoint can be used to submit the outputs from the
|
|
32
32
|
* tool calls once they're all completed. All outputs must be submitted in a single
|
|
33
33
|
* request.
|
|
@@ -43,7 +43,7 @@ export interface RequiredActionFunctionToolCall {
|
|
|
43
43
|
/**
|
|
44
44
|
* The ID of the tool call. This ID must be referenced when you submit the tool
|
|
45
45
|
* outputs in using the
|
|
46
|
-
* [Submit tool outputs to
|
|
46
|
+
* [Submit tool outputs to run](https://platform.openai.com/docs/api-reference/runs/submitToolOutputs)
|
|
47
47
|
* endpoint.
|
|
48
48
|
*/
|
|
49
49
|
id: string;
|
|
@@ -73,8 +73,8 @@ export declare namespace RequiredActionFunctionToolCall {
|
|
|
73
73
|
}
|
|
74
74
|
}
|
|
75
75
|
/**
|
|
76
|
-
* Represents an execution
|
|
77
|
-
* [
|
|
76
|
+
* Represents an execution run on a
|
|
77
|
+
* [thread](https://platform.openai.com/docs/api-reference/threads).
|
|
78
78
|
*/
|
|
79
79
|
export interface Run {
|
|
80
80
|
/**
|
|
@@ -83,44 +83,44 @@ export interface Run {
|
|
|
83
83
|
id: string;
|
|
84
84
|
/**
|
|
85
85
|
* The ID of the
|
|
86
|
-
* [
|
|
87
|
-
* execution of this
|
|
86
|
+
* [assistant](https://platform.openai.com/docs/api-reference/assistants) used for
|
|
87
|
+
* execution of this run.
|
|
88
88
|
*/
|
|
89
89
|
assistant_id: string;
|
|
90
90
|
/**
|
|
91
|
-
* The Unix timestamp (in seconds) for when the
|
|
91
|
+
* The Unix timestamp (in seconds) for when the run was cancelled.
|
|
92
92
|
*/
|
|
93
93
|
cancelled_at: number | null;
|
|
94
94
|
/**
|
|
95
|
-
* The Unix timestamp (in seconds) for when the
|
|
95
|
+
* The Unix timestamp (in seconds) for when the run was completed.
|
|
96
96
|
*/
|
|
97
97
|
completed_at: number | null;
|
|
98
98
|
/**
|
|
99
|
-
* The Unix timestamp (in seconds) for when the
|
|
99
|
+
* The Unix timestamp (in seconds) for when the run was created.
|
|
100
100
|
*/
|
|
101
101
|
created_at: number;
|
|
102
102
|
/**
|
|
103
|
-
* The Unix timestamp (in seconds) for when the
|
|
103
|
+
* The Unix timestamp (in seconds) for when the run will expire.
|
|
104
104
|
*/
|
|
105
105
|
expires_at: number;
|
|
106
106
|
/**
|
|
107
|
-
* The Unix timestamp (in seconds) for when the
|
|
107
|
+
* The Unix timestamp (in seconds) for when the run failed.
|
|
108
108
|
*/
|
|
109
109
|
failed_at: number | null;
|
|
110
110
|
/**
|
|
111
111
|
* The list of [File](https://platform.openai.com/docs/api-reference/files) IDs the
|
|
112
|
-
* [
|
|
113
|
-
* this
|
|
112
|
+
* [assistant](https://platform.openai.com/docs/api-reference/assistants) used for
|
|
113
|
+
* this run.
|
|
114
114
|
*/
|
|
115
115
|
file_ids: Array<string>;
|
|
116
116
|
/**
|
|
117
117
|
* The instructions that the
|
|
118
|
-
* [
|
|
118
|
+
* [assistant](https://platform.openai.com/docs/api-reference/assistants) used for
|
|
119
119
|
* this run.
|
|
120
120
|
*/
|
|
121
121
|
instructions: string;
|
|
122
122
|
/**
|
|
123
|
-
* The last error associated with this
|
|
123
|
+
* The last error associated with this run. Will be `null` if there are no errors.
|
|
124
124
|
*/
|
|
125
125
|
last_error: Run.LastError | null;
|
|
126
126
|
/**
|
|
@@ -132,8 +132,8 @@ export interface Run {
|
|
|
132
132
|
metadata: unknown | null;
|
|
133
133
|
/**
|
|
134
134
|
* The model that the
|
|
135
|
-
* [
|
|
136
|
-
* this
|
|
135
|
+
* [assistant](https://platform.openai.com/docs/api-reference/assistants) used for
|
|
136
|
+
* this run.
|
|
137
137
|
*/
|
|
138
138
|
model: string;
|
|
139
139
|
/**
|
|
@@ -141,12 +141,12 @@ export interface Run {
|
|
|
141
141
|
*/
|
|
142
142
|
object: 'assistant.run';
|
|
143
143
|
/**
|
|
144
|
-
* Details on the action required to continue the
|
|
144
|
+
* Details on the action required to continue the run. Will be `null` if no action
|
|
145
145
|
* is required.
|
|
146
146
|
*/
|
|
147
147
|
required_action: Run.RequiredAction | null;
|
|
148
148
|
/**
|
|
149
|
-
* The Unix timestamp (in seconds) for when the
|
|
149
|
+
* The Unix timestamp (in seconds) for when the run was started.
|
|
150
150
|
*/
|
|
151
151
|
started_at: number | null;
|
|
152
152
|
/**
|
|
@@ -156,20 +156,20 @@ export interface Run {
|
|
|
156
156
|
*/
|
|
157
157
|
status: 'queued' | 'in_progress' | 'requires_action' | 'cancelling' | 'cancelled' | 'failed' | 'completed' | 'expired';
|
|
158
158
|
/**
|
|
159
|
-
* The ID of the [
|
|
160
|
-
* that was executed on as a part of this
|
|
159
|
+
* The ID of the [thread](https://platform.openai.com/docs/api-reference/threads)
|
|
160
|
+
* that was executed on as a part of this run.
|
|
161
161
|
*/
|
|
162
162
|
thread_id: string;
|
|
163
163
|
/**
|
|
164
164
|
* The list of tools that the
|
|
165
|
-
* [
|
|
166
|
-
* this
|
|
165
|
+
* [assistant](https://platform.openai.com/docs/api-reference/assistants) used for
|
|
166
|
+
* this run.
|
|
167
167
|
*/
|
|
168
168
|
tools: Array<Run.AssistantToolsCode | Run.AssistantToolsRetrieval | Run.AssistantToolsFunction>;
|
|
169
169
|
}
|
|
170
170
|
export declare namespace Run {
|
|
171
171
|
/**
|
|
172
|
-
* The last error associated with this
|
|
172
|
+
* The last error associated with this run. Will be `null` if there are no errors.
|
|
173
173
|
*/
|
|
174
174
|
interface LastError {
|
|
175
175
|
/**
|
|
@@ -182,12 +182,12 @@ export declare namespace Run {
|
|
|
182
182
|
message: string;
|
|
183
183
|
}
|
|
184
184
|
/**
|
|
185
|
-
* Details on the action required to continue the
|
|
185
|
+
* Details on the action required to continue the run. Will be `null` if no action
|
|
186
186
|
* is required.
|
|
187
187
|
*/
|
|
188
188
|
interface RequiredAction {
|
|
189
189
|
/**
|
|
190
|
-
* Details on the tool outputs needed for this
|
|
190
|
+
* Details on the tool outputs needed for this run to continue.
|
|
191
191
|
*/
|
|
192
192
|
submit_tool_outputs: RequiredAction.SubmitToolOutputs;
|
|
193
193
|
/**
|
|
@@ -197,7 +197,7 @@ export declare namespace Run {
|
|
|
197
197
|
}
|
|
198
198
|
namespace RequiredAction {
|
|
199
199
|
/**
|
|
200
|
-
* Details on the tool outputs needed for this
|
|
200
|
+
* Details on the tool outputs needed for this run to continue.
|
|
201
201
|
*/
|
|
202
202
|
interface SubmitToolOutputs {
|
|
203
203
|
/**
|
|
@@ -214,9 +214,9 @@ export declare namespace Run {
|
|
|
214
214
|
}
|
|
215
215
|
interface AssistantToolsRetrieval {
|
|
216
216
|
/**
|
|
217
|
-
* The type of tool being defined: `
|
|
217
|
+
* The type of tool being defined: `retrieval`
|
|
218
218
|
*/
|
|
219
|
-
type: '
|
|
219
|
+
type: 'retrieval';
|
|
220
220
|
}
|
|
221
221
|
interface AssistantToolsFunction {
|
|
222
222
|
/**
|
|
@@ -260,12 +260,12 @@ export declare namespace Run {
|
|
|
260
260
|
export interface RunCreateParams {
|
|
261
261
|
/**
|
|
262
262
|
* The ID of the
|
|
263
|
-
* [
|
|
264
|
-
* execute this
|
|
263
|
+
* [assistant](https://platform.openai.com/docs/api-reference/assistants) to use to
|
|
264
|
+
* execute this run.
|
|
265
265
|
*/
|
|
266
266
|
assistant_id: string;
|
|
267
267
|
/**
|
|
268
|
-
* Override the default system message of the
|
|
268
|
+
* Override the default system message of the assistant. This is useful for
|
|
269
269
|
* modifying the behavior on a per-run basis.
|
|
270
270
|
*/
|
|
271
271
|
instructions?: string | null;
|
|
@@ -278,13 +278,13 @@ export interface RunCreateParams {
|
|
|
278
278
|
metadata?: unknown | null;
|
|
279
279
|
/**
|
|
280
280
|
* The ID of the [Model](https://platform.openai.com/docs/api-reference/models) to
|
|
281
|
-
* be used to execute this
|
|
282
|
-
* model associated with the
|
|
283
|
-
*
|
|
281
|
+
* be used to execute this run. If a value is provided here, it will override the
|
|
282
|
+
* model associated with the assistant. If not, the model associated with the
|
|
283
|
+
* assistant will be used.
|
|
284
284
|
*/
|
|
285
285
|
model?: string | null;
|
|
286
286
|
/**
|
|
287
|
-
* Override the tools the
|
|
287
|
+
* Override the tools the assistant can use for this run. This is useful for
|
|
288
288
|
* modifying the behavior on a per-run basis.
|
|
289
289
|
*/
|
|
290
290
|
tools?: Array<RunCreateParams.AssistantToolsCode | RunCreateParams.AssistantToolsRetrieval | RunCreateParams.AssistantToolsFunction> | null;
|
|
@@ -298,9 +298,9 @@ export declare namespace RunCreateParams {
|
|
|
298
298
|
}
|
|
299
299
|
interface AssistantToolsRetrieval {
|
|
300
300
|
/**
|
|
301
|
-
* The type of tool being defined: `
|
|
301
|
+
* The type of tool being defined: `retrieval`
|
|
302
302
|
*/
|
|
303
|
-
type: '
|
|
303
|
+
type: 'retrieval';
|
|
304
304
|
}
|
|
305
305
|
interface AssistantToolsFunction {
|
|
306
306
|
/**
|
|
@@ -373,11 +373,11 @@ export interface RunSubmitToolOutputsParams {
|
|
|
373
373
|
export declare namespace RunSubmitToolOutputsParams {
|
|
374
374
|
interface ToolOutput {
|
|
375
375
|
/**
|
|
376
|
-
* The output of the tool call to be submitted to continue the
|
|
376
|
+
* The output of the tool call to be submitted to continue the run.
|
|
377
377
|
*/
|
|
378
378
|
output?: string;
|
|
379
379
|
/**
|
|
380
|
-
* The ID of the tool call in the `required_action` object within the
|
|
380
|
+
* The ID of the tool call in the `required_action` object within the run object
|
|
381
381
|
* the output is being submitted for.
|
|
382
382
|
*/
|
|
383
383
|
tool_call_id?: string;
|