@qlik/api 1.30.0 → 1.32.0
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/api-keys.d.ts +2 -2
- package/api-keys.js +2 -2
- package/apps.d.ts +4 -2
- package/apps.js +2 -2
- package/assistants.d.ts +1301 -0
- package/assistants.js +273 -0
- package/audits.d.ts +2 -2
- package/audits.js +2 -2
- package/{auth-types-PkN9CAF_.d.ts → auth-types-DqfMuSRX.d.ts} +1 -0
- package/auth.d.ts +27 -3
- package/auth.js +8 -4
- package/automation-connections.d.ts +366 -0
- package/automation-connections.js +91 -0
- package/automations.d.ts +2 -2
- package/automations.js +2 -2
- package/automl-deployments.d.ts +97 -0
- package/automl-deployments.js +27 -0
- package/automl-predictions.d.ts +214 -0
- package/automl-predictions.js +72 -0
- package/brands.d.ts +2 -2
- package/brands.js +2 -2
- package/chunks/{JIX6RMFP.js → 6ZONDHRN.js} +1 -1
- package/chunks/ETNHFALU.js +61 -0
- package/chunks/{G6QUM5WQ.js → FKDGGR2O.js} +137 -45
- package/chunks/{TXC5XORK.js → LTNGXTXG.js} +3 -3
- package/chunks/{OTTC4QSX.js → LY7RP2HA.js} +7 -3
- package/chunks/{FKCZFVJL.js → M64RLKVG.js} +2074 -12
- package/chunks/{F5UDCCRD.js → PLVPW5IR.js} +1 -1
- package/chunks/{QK4TMJ64.js → RCLKKVYB.js} +11 -1
- package/chunks/{QWQLGDMI.js → UZTIZ4H5.js} +392 -372
- package/chunks/{PTDXR7AY.js → VVD2DPKQ.js} +2 -2
- package/chunks/{IQBP2PKS.js → YTT2FEVE.js} +1 -1
- package/collections.d.ts +3 -3
- package/collections.js +2 -2
- package/conditions.d.ts +662 -0
- package/conditions.js +113 -0
- package/consumption.d.ts +182 -0
- package/consumption.js +24 -0
- package/csp-origins.d.ts +2 -2
- package/csp-origins.js +2 -2
- package/csrf-token.d.ts +62 -0
- package/csrf-token.js +23 -0
- package/data-alerts.d.ts +1004 -0
- package/data-alerts.js +155 -0
- package/data-assets.d.ts +2 -2
- package/data-assets.js +2 -2
- package/data-connections.d.ts +7 -7
- package/data-connections.js +2 -2
- package/data-credentials.d.ts +2 -2
- package/data-credentials.js +2 -2
- package/data-files.d.ts +2 -2
- package/data-files.js +2 -2
- package/data-qualities.d.ts +175 -0
- package/data-qualities.js +44 -0
- package/data-sets.d.ts +424 -0
- package/data-sets.js +75 -0
- package/data-sources.d.ts +268 -0
- package/data-sources.js +39 -0
- package/data-stores.d.ts +537 -0
- package/data-stores.js +108 -0
- package/dcaas.d.ts +192 -0
- package/dcaas.js +39 -0
- package/di-projects.d.ts +673 -0
- package/di-projects.js +164 -0
- package/docs/authentication.md +47 -0
- package/encryption.d.ts +370 -0
- package/encryption.js +98 -0
- package/extensions.d.ts +2 -2
- package/extensions.js +2 -2
- package/glossaries.d.ts +2 -2
- package/glossaries.js +2 -2
- package/groups.d.ts +5 -4
- package/groups.js +2 -2
- package/identity-providers.d.ts +2 -2
- package/identity-providers.js +2 -2
- package/index.d.ts +110 -4
- package/index.js +556 -4
- package/interceptors.d.ts +2 -2
- package/{invoke-fetch-types-BXn-uSF5.d.ts → invoke-fetch-types-Cq7bjkqn.d.ts} +10 -2
- package/items.d.ts +3 -3
- package/items.js +2 -2
- package/knowledgebases.d.ts +890 -0
- package/knowledgebases.js +169 -0
- package/licenses.d.ts +6 -3
- package/licenses.js +2 -2
- package/lineage-graphs.d.ts +712 -0
- package/lineage-graphs.js +92 -0
- package/ml.d.ts +2628 -0
- package/ml.js +384 -0
- package/notes.d.ts +110 -0
- package/notes.js +31 -0
- package/notifications.d.ts +98 -0
- package/notifications.js +24 -0
- package/oauth-clients.d.ts +7 -2
- package/oauth-clients.js +2 -2
- package/oauth-tokens.d.ts +126 -0
- package/oauth-tokens.js +31 -0
- package/package.json +29 -2
- package/qix.d.ts +421 -26
- package/qix.js +2 -2
- package/questions.d.ts +364 -0
- package/questions.js +34 -0
- package/quotas.d.ts +2 -2
- package/quotas.js +2 -2
- package/reload-tasks.d.ts +4 -2
- package/reload-tasks.js +2 -2
- package/reloads.d.ts +4 -2
- package/reloads.js +2 -2
- package/report-templates.d.ts +287 -0
- package/report-templates.js +80 -0
- package/reports.d.ts +2 -2
- package/reports.js +2 -2
- package/roles.d.ts +2 -2
- package/roles.js +2 -2
- package/sharing-tasks.d.ts +952 -0
- package/sharing-tasks.js +105 -0
- package/spaces.d.ts +3 -7
- package/spaces.js +2 -2
- package/tasks.d.ts +564 -0
- package/tasks.js +106 -0
- package/temp-contents.d.ts +2 -2
- package/temp-contents.js +2 -2
- package/tenants.d.ts +2 -2
- package/tenants.js +2 -2
- package/themes.d.ts +2 -2
- package/themes.js +2 -2
- package/transports.d.ts +2 -2
- package/transports.js +2 -2
- package/ui-config.d.ts +274 -0
- package/ui-config.js +77 -0
- package/users.d.ts +2 -2
- package/users.js +2 -2
- package/web-integrations.d.ts +2 -2
- package/web-integrations.js +2 -2
- package/web-notifications.d.ts +2 -2
- package/web-notifications.js +2 -2
- package/webhooks.d.ts +2 -2
- package/webhooks.js +2 -2
package/assistants.d.ts
ADDED
|
@@ -0,0 +1,1301 @@
|
|
|
1
|
+
import { A as ApiCallOptions } from './invoke-fetch-types-Cq7bjkqn.js';
|
|
2
|
+
import './auth-types-DqfMuSRX.js';
|
|
3
|
+
|
|
4
|
+
type Assistant = {
|
|
5
|
+
/** Datetime when the assistant was created. */
|
|
6
|
+
readonly createdAt: string;
|
|
7
|
+
/** Unique identifier of the user who created the assistant. */
|
|
8
|
+
readonly createdBy: string;
|
|
9
|
+
/** freeform JSON to allow custom customization options. */
|
|
10
|
+
customProperties: unknown;
|
|
11
|
+
/** Default prompt type for the assistant. */
|
|
12
|
+
defaultPromptType?: "thread" | "oneshot";
|
|
13
|
+
/** The description of the assistant. */
|
|
14
|
+
description: string;
|
|
15
|
+
/** Indicates if the assistant has an avatar. */
|
|
16
|
+
hasAvatar?: boolean;
|
|
17
|
+
/** Unique identifier of the assistant. */
|
|
18
|
+
id: string;
|
|
19
|
+
/** List of knowledgebases the assistant is using. */
|
|
20
|
+
knowledgeBases: string[];
|
|
21
|
+
/** The name of the assistant. */
|
|
22
|
+
name: string;
|
|
23
|
+
/** List of starter IDs in the order they will be sorted. */
|
|
24
|
+
orderedStarterIds?: string[];
|
|
25
|
+
/** Unique identifier of the assistant owner. */
|
|
26
|
+
ownerId: string;
|
|
27
|
+
/** Unique identifier of the space containing the assistant. */
|
|
28
|
+
spaceId: string;
|
|
29
|
+
/** @deprecated
|
|
30
|
+
* System prompt setting up conversation context. */
|
|
31
|
+
systemMessage?: string;
|
|
32
|
+
/** The list of tags associated with the assistant. */
|
|
33
|
+
tags: string[];
|
|
34
|
+
/** Unique identifier of the assistant tenant. */
|
|
35
|
+
tenantId: string;
|
|
36
|
+
/** The title of the assistant. */
|
|
37
|
+
title?: string;
|
|
38
|
+
/** Datetime when the assistant was updated. */
|
|
39
|
+
readonly updatedAt: string;
|
|
40
|
+
/** Unique identifier of the user who last updated the assistant. */
|
|
41
|
+
readonly updatedBy: string;
|
|
42
|
+
/** Initial message in the chat conversation. */
|
|
43
|
+
welcomeMessage: string;
|
|
44
|
+
};
|
|
45
|
+
/**
|
|
46
|
+
* @example
|
|
47
|
+
* {
|
|
48
|
+
* chunkIds: [
|
|
49
|
+
* "c2ef42d9-7164-4fb0-bdbb-6534ae37263e",
|
|
50
|
+
* "486ada2c-f895-4961-8ba5-7995f1026d26"
|
|
51
|
+
* ]
|
|
52
|
+
* }
|
|
53
|
+
*/
|
|
54
|
+
type ChunksRefs = {
|
|
55
|
+
chunkIds: string[];
|
|
56
|
+
};
|
|
57
|
+
type Feedback = {
|
|
58
|
+
/** Optional comment for feedback. */
|
|
59
|
+
comment: string;
|
|
60
|
+
/** Unique feedback identifier. */
|
|
61
|
+
id: string;
|
|
62
|
+
/** Reason for feedback. */
|
|
63
|
+
reason: string;
|
|
64
|
+
/** Feedback review status. */
|
|
65
|
+
reviewStatus: string;
|
|
66
|
+
/** Datetime when the feedback was reviewed. */
|
|
67
|
+
reviewedAt?: string;
|
|
68
|
+
/** Unique feedback reviewer identifier. */
|
|
69
|
+
reviewerId: string;
|
|
70
|
+
/** Integer representation of feedback given (-1 = negative, 1 = positive). */
|
|
71
|
+
vote: number;
|
|
72
|
+
};
|
|
73
|
+
type Interaction = {
|
|
74
|
+
/** Datetime when the interaction was created. */
|
|
75
|
+
readonly createdAt: string;
|
|
76
|
+
feedback?: Feedback;
|
|
77
|
+
id: string;
|
|
78
|
+
/** Unique identifier of user which created the interaction. */
|
|
79
|
+
ownerId: string;
|
|
80
|
+
/** Indicator the system marked request as suspicious. */
|
|
81
|
+
rejected?: boolean;
|
|
82
|
+
/** Interaction request content. */
|
|
83
|
+
request: string;
|
|
84
|
+
/** Interaction response content. */
|
|
85
|
+
response: string;
|
|
86
|
+
/** List of sources used to generate AI messages (interactions). */
|
|
87
|
+
sources: MessageSource[];
|
|
88
|
+
/** ID of the thread to which the interaction belongs. */
|
|
89
|
+
threadId: string;
|
|
90
|
+
/** Datetime when the interaction was updated. */
|
|
91
|
+
readonly updatedAt: string;
|
|
92
|
+
};
|
|
93
|
+
/**
|
|
94
|
+
* A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
|
|
95
|
+
*/
|
|
96
|
+
type JSONPatch = {
|
|
97
|
+
/** The operation to be performed. */
|
|
98
|
+
op: "replace" | "add";
|
|
99
|
+
/** A JSON Pointer. */
|
|
100
|
+
path: string;
|
|
101
|
+
/** The value to be used for this operation. */
|
|
102
|
+
value: string | number | boolean;
|
|
103
|
+
};
|
|
104
|
+
/**
|
|
105
|
+
* An array of JSON Patch documents.
|
|
106
|
+
* @example
|
|
107
|
+
* [
|
|
108
|
+
* {
|
|
109
|
+
* op: "replace",
|
|
110
|
+
* path: "/name",
|
|
111
|
+
* value: "new name"
|
|
112
|
+
* },
|
|
113
|
+
* {
|
|
114
|
+
* op: "replace",
|
|
115
|
+
* path: "/description",
|
|
116
|
+
* value: "new description"
|
|
117
|
+
* },
|
|
118
|
+
* {
|
|
119
|
+
* op: "add",
|
|
120
|
+
* path: "/defaultPromptType",
|
|
121
|
+
* value: "thread"
|
|
122
|
+
* },
|
|
123
|
+
* {
|
|
124
|
+
* path: "/avatar"
|
|
125
|
+
* },
|
|
126
|
+
* {
|
|
127
|
+
* op: "add",
|
|
128
|
+
* path: "/avatar",
|
|
129
|
+
* value: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAlAQAAAAAsYlcCAAAACklEQVR4AWMYBQABAwABRUEDtQAAAABJRU5ErkJggg=="
|
|
130
|
+
* },
|
|
131
|
+
* {
|
|
132
|
+
* op: "replace",
|
|
133
|
+
* path: "/avatar",
|
|
134
|
+
* value: "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADAAAAAlAQAAAAAsYlcCAAAACklEQVR4AWMYBQABAwABRUEDtQAAAABJRU5ErkJggg=="
|
|
135
|
+
* }
|
|
136
|
+
* ]
|
|
137
|
+
*/
|
|
138
|
+
type JSONPatchArray = JSONPatch[];
|
|
139
|
+
type Message = {
|
|
140
|
+
/** Message content. */
|
|
141
|
+
content: string;
|
|
142
|
+
/** Datetime when the interaction was created. */
|
|
143
|
+
readonly createdAt: string;
|
|
144
|
+
id: string;
|
|
145
|
+
/** human or ai role. */
|
|
146
|
+
role: string;
|
|
147
|
+
/** List of sources used to generate AI messages (interactions). */
|
|
148
|
+
sources: MessageSource[];
|
|
149
|
+
};
|
|
150
|
+
type MessageSource = {
|
|
151
|
+
/** List of Chunks used for "AI" generated messages. */
|
|
152
|
+
chunks: MessageSourceChunk[];
|
|
153
|
+
/** Reference to DataSource used for "AI" generated messages. */
|
|
154
|
+
datasourceId: string;
|
|
155
|
+
/** Reference to Document used for "AI" generated messages. */
|
|
156
|
+
documentId: string;
|
|
157
|
+
/** Reference to KnowledgeBase used for "AI" generated messages. */
|
|
158
|
+
knowledgebaseId: string;
|
|
159
|
+
/** Datetime when the knowledgebase was last indexed. */
|
|
160
|
+
lastIndexedAt?: string;
|
|
161
|
+
/** Path to the document used. */
|
|
162
|
+
source: string;
|
|
163
|
+
};
|
|
164
|
+
type MessageSourceChunk = {
|
|
165
|
+
/** Chunk unique identifier for "AI" generated message source. */
|
|
166
|
+
chunkId: string;
|
|
167
|
+
/** Chunk text for "AI" generated message source. */
|
|
168
|
+
text?: string;
|
|
169
|
+
};
|
|
170
|
+
type Starter = {
|
|
171
|
+
/** Optional context collected from curated meant to be leveraged by LLM-based question recommendation system. */
|
|
172
|
+
additionalContext: string;
|
|
173
|
+
/** Datetime when the starter was created. */
|
|
174
|
+
readonly createdAt: string;
|
|
175
|
+
/** List of followups. */
|
|
176
|
+
followups?: Followup[];
|
|
177
|
+
/** Unique identifier of the starter. */
|
|
178
|
+
id: string;
|
|
179
|
+
/** Starter sample question. */
|
|
180
|
+
question: string;
|
|
181
|
+
recommendedAnswer: RecommendedAnswer;
|
|
182
|
+
/** Datetime when the starter was updated. */
|
|
183
|
+
readonly updatedAt: string;
|
|
184
|
+
};
|
|
185
|
+
type Thread = {
|
|
186
|
+
/** Datetime when the thread was created. */
|
|
187
|
+
readonly createdAt: string;
|
|
188
|
+
/** Datetime when the thread was deleted. */
|
|
189
|
+
readonly deletedAt?: string;
|
|
190
|
+
/** If thread is marked as favorite. */
|
|
191
|
+
favorite: boolean;
|
|
192
|
+
/** If feedback was provided for a thread interaction. */
|
|
193
|
+
hasFeedback: boolean;
|
|
194
|
+
/** Unique identifier of the thread. */
|
|
195
|
+
id: string;
|
|
196
|
+
/** The name of the thread. */
|
|
197
|
+
name: string;
|
|
198
|
+
ownerId: string;
|
|
199
|
+
summaryStats: FeedbackSummary;
|
|
200
|
+
/** Datetime when the thread was updated. */
|
|
201
|
+
readonly updatedAt: string;
|
|
202
|
+
};
|
|
203
|
+
type ThreadWithMessages = {
|
|
204
|
+
/** Datetime when the thread was created. */
|
|
205
|
+
readonly createdAt: string;
|
|
206
|
+
/** Datetime when the thread was deleted. */
|
|
207
|
+
readonly deletedAt?: string;
|
|
208
|
+
/** If thread is marked as favorite. */
|
|
209
|
+
favorite: boolean;
|
|
210
|
+
/** If feedback was provided for a thread interaction. */
|
|
211
|
+
hasFeedback: boolean;
|
|
212
|
+
/** Unique identifier of the thread. */
|
|
213
|
+
id: string;
|
|
214
|
+
messages: Message[];
|
|
215
|
+
/** The name of the thread. */
|
|
216
|
+
name: string;
|
|
217
|
+
/** Unique identifier of the thread owner. */
|
|
218
|
+
ownerId: string;
|
|
219
|
+
summaryStats: FeedbackSummary;
|
|
220
|
+
/** Datetime when the thread was updated. */
|
|
221
|
+
readonly updatedAt: string;
|
|
222
|
+
};
|
|
223
|
+
type AssistantsResult = {
|
|
224
|
+
data: Assistant[];
|
|
225
|
+
links?: PageLinks;
|
|
226
|
+
meta?: ResultMeta;
|
|
227
|
+
};
|
|
228
|
+
type CreateAssistant = {
|
|
229
|
+
/** freeform JSON to allow custom customization options. */
|
|
230
|
+
customProperties: unknown;
|
|
231
|
+
/** Default prompt type for the assistant. */
|
|
232
|
+
defaultPromptType?: "thread" | "oneshot";
|
|
233
|
+
/** The description of the assistant. */
|
|
234
|
+
description: string;
|
|
235
|
+
/** List of knowledgebases the assistant is using. */
|
|
236
|
+
knowledgeBases: string[];
|
|
237
|
+
/** The name of the assistant. */
|
|
238
|
+
name: string;
|
|
239
|
+
/** List of starter IDs in the order they will be sorted. */
|
|
240
|
+
orderedStarterIds?: string[];
|
|
241
|
+
/** Unique identifier of the space to contain the assistant. */
|
|
242
|
+
spaceId: string;
|
|
243
|
+
/** @deprecated
|
|
244
|
+
* System prompt setting up conversation context. */
|
|
245
|
+
systemMessage?: string;
|
|
246
|
+
/** The list of tags for the assistant. */
|
|
247
|
+
tags: string[];
|
|
248
|
+
/** The title of the assistant. */
|
|
249
|
+
title: string;
|
|
250
|
+
/** Initial message in the chat conversation. */
|
|
251
|
+
welcomeMessage: string;
|
|
252
|
+
};
|
|
253
|
+
type CreateAssistantWithAvatar = {
|
|
254
|
+
/** user uploaded avatar, filetype must be png */
|
|
255
|
+
avatar?: string;
|
|
256
|
+
/** freeform JSON to allow custom customization options. */
|
|
257
|
+
customProperties: unknown;
|
|
258
|
+
/** Default prompt type for the assistant. */
|
|
259
|
+
defaultPromptType?: "thread" | "oneshot";
|
|
260
|
+
/** The description of the assistant. */
|
|
261
|
+
description: string;
|
|
262
|
+
/** List of knowledgebases the assistant is using. */
|
|
263
|
+
knowledgeBases: string[];
|
|
264
|
+
/** The name of the assistant. */
|
|
265
|
+
name: string;
|
|
266
|
+
/** Unique identifier of the space to contain the assistant. */
|
|
267
|
+
spaceId: string;
|
|
268
|
+
/** @deprecated
|
|
269
|
+
* System prompt setting up conversation context. */
|
|
270
|
+
systemMessage?: string;
|
|
271
|
+
/** The list of tags for the assistant. */
|
|
272
|
+
tags: string[];
|
|
273
|
+
/** The title of the assistant. */
|
|
274
|
+
title: string;
|
|
275
|
+
/** Initial message in the chat conversation. */
|
|
276
|
+
welcomeMessage: string;
|
|
277
|
+
};
|
|
278
|
+
type CreateFeedback = {
|
|
279
|
+
/** Optional comment for feedback. */
|
|
280
|
+
comment?: string;
|
|
281
|
+
/** Reason for feedback. */
|
|
282
|
+
reason: string;
|
|
283
|
+
/** Integer representation of feedback given (-1 = negative, 1 = positive). */
|
|
284
|
+
vote: number;
|
|
285
|
+
};
|
|
286
|
+
type CreateInteraction = {
|
|
287
|
+
/** Indicator the system marked request as suspicious. */
|
|
288
|
+
rejected?: boolean;
|
|
289
|
+
/** Rejection reason for a question:
|
|
290
|
+
* * 1 - PROMPT_INJECTION
|
|
291
|
+
* * 2 - OUT_OF_CONTEXT
|
|
292
|
+
* * 3 - TOO_COMPLEX */
|
|
293
|
+
rejectionReason?: RejectionReason;
|
|
294
|
+
/** Interaction request content. */
|
|
295
|
+
request: string;
|
|
296
|
+
/** Interaction response content. */
|
|
297
|
+
response: string;
|
|
298
|
+
/** List of sources used to generate AI messages (interactions). */
|
|
299
|
+
sources: MessageSource[];
|
|
300
|
+
};
|
|
301
|
+
type CreateReview = {
|
|
302
|
+
/** Review status. */
|
|
303
|
+
reviewStatus: string;
|
|
304
|
+
};
|
|
305
|
+
type CreateStarter = {
|
|
306
|
+
/** Optional context collected from curated meant to be leveraged by LLM-based question recommendation system. */
|
|
307
|
+
additionalContext?: string;
|
|
308
|
+
/** List of followups. */
|
|
309
|
+
followups?: Followup[];
|
|
310
|
+
/** Starter sample question. */
|
|
311
|
+
question: string;
|
|
312
|
+
recommendedAnswer?: RecommendedAnswer;
|
|
313
|
+
};
|
|
314
|
+
type CreateThread = {
|
|
315
|
+
/** Datetime when the thread was created. */
|
|
316
|
+
readonly createdAt?: string;
|
|
317
|
+
/** The name of the thread. */
|
|
318
|
+
name: string;
|
|
319
|
+
/** Datetime when the thread was updated. */
|
|
320
|
+
readonly updatedAt?: string;
|
|
321
|
+
};
|
|
322
|
+
type ErrorResponse = {
|
|
323
|
+
errors?: ErrorResponseCode[];
|
|
324
|
+
traceId?: string;
|
|
325
|
+
};
|
|
326
|
+
type ErrorResponseCode = {
|
|
327
|
+
code?: string;
|
|
328
|
+
detail?: string;
|
|
329
|
+
title?: string;
|
|
330
|
+
};
|
|
331
|
+
type ErrorResponseCodeCopy = {
|
|
332
|
+
/** Custom error codes
|
|
333
|
+
* * AE-1 - Internal processing error
|
|
334
|
+
* * AE-2 - Incorrect request
|
|
335
|
+
* * AE-3 - Authentication issue
|
|
336
|
+
* * AE-4 - Prompt is rejected
|
|
337
|
+
* * AE-5 - Resource is not found
|
|
338
|
+
* * AE-6 - API usage rate limit is exceeded
|
|
339
|
+
* * AE-7 - Method is not allowed */
|
|
340
|
+
code?: string;
|
|
341
|
+
detail?: string;
|
|
342
|
+
title?: string;
|
|
343
|
+
};
|
|
344
|
+
type ErrorResponseCopy = {
|
|
345
|
+
errors?: ErrorResponseCodeCopy[];
|
|
346
|
+
traceId?: string;
|
|
347
|
+
};
|
|
348
|
+
/**
|
|
349
|
+
* An array of JSON Patch documents.
|
|
350
|
+
* @example
|
|
351
|
+
* [
|
|
352
|
+
* {
|
|
353
|
+
* op: "replace",
|
|
354
|
+
* path: "/reason",
|
|
355
|
+
* value: "irrelevant"
|
|
356
|
+
* }
|
|
357
|
+
* ]
|
|
358
|
+
*/
|
|
359
|
+
type FeedbackPatchArray = JSONPatch[];
|
|
360
|
+
type FeedbackSummary = {
|
|
361
|
+
/** Amount of dislikes for a thread or an assistant. */
|
|
362
|
+
dislikes: number;
|
|
363
|
+
/** Count of answers which users marked as "inaccurate". */
|
|
364
|
+
inaccurate?: number;
|
|
365
|
+
/** Amount of interactions for a thread or an assistant. */
|
|
366
|
+
interactions: number;
|
|
367
|
+
/** Count of answers which users marked as "irrelevant". */
|
|
368
|
+
irrelevant?: number;
|
|
369
|
+
/** Amount of likes for a thread or an assistant. */
|
|
370
|
+
likes: number;
|
|
371
|
+
/** Count of answers which users disliked and gave "other" as reason. */
|
|
372
|
+
other?: number;
|
|
373
|
+
/** Count of answers which users marked as "repetitive". */
|
|
374
|
+
repetitive?: number;
|
|
375
|
+
/** Amount of reviews for a thread or an assistant. */
|
|
376
|
+
reviews: number;
|
|
377
|
+
/** Count of questions for which the assistant provided no answer. */
|
|
378
|
+
unanswered?: number;
|
|
379
|
+
/** Count of answers which users marked as "unhelpful". */
|
|
380
|
+
unhelpful?: number;
|
|
381
|
+
};
|
|
382
|
+
type Followup = {
|
|
383
|
+
/** Optional context collected from curated meant to be leveraged by LLM-based question recommendation system. */
|
|
384
|
+
additionalContext: string;
|
|
385
|
+
/** Unique identifier of the Followup. */
|
|
386
|
+
id: string;
|
|
387
|
+
/** Starter sample question. */
|
|
388
|
+
question: string;
|
|
389
|
+
recommendedAnswer: RecommendedAnswer;
|
|
390
|
+
};
|
|
391
|
+
type InteractionsResult = {
|
|
392
|
+
data: Interaction[];
|
|
393
|
+
links?: PageLinks;
|
|
394
|
+
meta?: ResultMeta;
|
|
395
|
+
};
|
|
396
|
+
type PageLink = {
|
|
397
|
+
href?: string;
|
|
398
|
+
};
|
|
399
|
+
type PageLinks = {
|
|
400
|
+
next?: PageLink;
|
|
401
|
+
prev?: PageLink;
|
|
402
|
+
self?: PageLink;
|
|
403
|
+
};
|
|
404
|
+
type PromptInput = {
|
|
405
|
+
input?: {
|
|
406
|
+
/** Returns text from chunks in sources output. Default value is false. */
|
|
407
|
+
includeText?: boolean;
|
|
408
|
+
/** Input prompt string for the Assistant to respond to. */
|
|
409
|
+
prompt?: string;
|
|
410
|
+
/** Sets the prompt type to thread. */
|
|
411
|
+
promptType?: "thread";
|
|
412
|
+
};
|
|
413
|
+
};
|
|
414
|
+
type PromptOutput = {
|
|
415
|
+
/** Assistant's response to the prompt */
|
|
416
|
+
output?: string;
|
|
417
|
+
/** List of sources used to generate AI messages */
|
|
418
|
+
sources?: Source[];
|
|
419
|
+
};
|
|
420
|
+
type PromptOutputInvoke = {
|
|
421
|
+
/** Assistant's response to the prompt */
|
|
422
|
+
output?: string;
|
|
423
|
+
/** Question asked by the user for assistant to answer */
|
|
424
|
+
question?: string;
|
|
425
|
+
/** List of sources used to generate AI messages */
|
|
426
|
+
sources?: Source[];
|
|
427
|
+
};
|
|
428
|
+
type RecommendedAnswer = {
|
|
429
|
+
/** Starter answer content. */
|
|
430
|
+
content: string;
|
|
431
|
+
/** Answer type of content. */
|
|
432
|
+
contentType: string;
|
|
433
|
+
};
|
|
434
|
+
/**
|
|
435
|
+
* Rejection reason for a question:
|
|
436
|
+
* * 1 - PROMPT_INJECTION
|
|
437
|
+
* * 2 - OUT_OF_CONTEXT
|
|
438
|
+
* * 3 - TOO_COMPLEX
|
|
439
|
+
* @example
|
|
440
|
+
* 1
|
|
441
|
+
*/
|
|
442
|
+
type RejectionReason = 1 | 2 | 3;
|
|
443
|
+
type ResultMeta = {
|
|
444
|
+
countTotal?: number;
|
|
445
|
+
};
|
|
446
|
+
type Source = {
|
|
447
|
+
/** List of Chunks used for "AI" generated messages */
|
|
448
|
+
chunks?: unknown[];
|
|
449
|
+
/** reference to DataSource used for "AI" generated messages */
|
|
450
|
+
datasourceId?: string;
|
|
451
|
+
/** reference to Document used for "AI" generated messages */
|
|
452
|
+
documentId?: string;
|
|
453
|
+
/** reference to KnowledgeBase used for "AI" generated messages */
|
|
454
|
+
knowledgebaseId?: string;
|
|
455
|
+
/** path to the document used */
|
|
456
|
+
source?: string;
|
|
457
|
+
};
|
|
458
|
+
type SourcesPlaintext = {
|
|
459
|
+
textByChunkId?: unknown;
|
|
460
|
+
};
|
|
461
|
+
type StartersResult = {
|
|
462
|
+
data: Starter[];
|
|
463
|
+
links?: PageLinks;
|
|
464
|
+
meta?: ResultMeta;
|
|
465
|
+
};
|
|
466
|
+
/**
|
|
467
|
+
* An array of JSON Patch documents.
|
|
468
|
+
* @example
|
|
469
|
+
* [
|
|
470
|
+
* {
|
|
471
|
+
* op: "replace",
|
|
472
|
+
* path: "/name",
|
|
473
|
+
* value: "new name"
|
|
474
|
+
* }
|
|
475
|
+
* ]
|
|
476
|
+
*/
|
|
477
|
+
type ThreadPatchArray = JSONPatch[];
|
|
478
|
+
type ThreadsResult = {
|
|
479
|
+
data: Thread[];
|
|
480
|
+
links?: PageLinks;
|
|
481
|
+
meta?: ResultMeta;
|
|
482
|
+
};
|
|
483
|
+
/**
|
|
484
|
+
* Retrieves the list of assistants. The result can be filtered, sorted, and paginated.
|
|
485
|
+
*
|
|
486
|
+
* @param query an object with query parameters
|
|
487
|
+
* @throws GetAssistantsHttpError
|
|
488
|
+
*/
|
|
489
|
+
declare const getAssistants: (query: {
|
|
490
|
+
/** @deprecated
|
|
491
|
+
* Optional parameter to request total count for query. */
|
|
492
|
+
countTotal?: boolean;
|
|
493
|
+
/** The number of assistants to get. */
|
|
494
|
+
limit?: number;
|
|
495
|
+
/** Optional parameter to request the next page. */
|
|
496
|
+
next?: string;
|
|
497
|
+
/** Optional parameter to request the previous page. */
|
|
498
|
+
prev?: string;
|
|
499
|
+
/** Optional resource field name to sort on, case insensitive, e.g. `name`. Can be prefixed with `-` to set descending order; defaults to ascending. */
|
|
500
|
+
sort?: "NAME" | "-NAME" | "DESCRIPTION" | "-DESCRIPTION" | "CREATED" | "-CREATED" | "UPDATED" | "-UPDATED";
|
|
501
|
+
}, options?: ApiCallOptions) => Promise<GetAssistantsHttpResponse>;
|
|
502
|
+
type GetAssistantsHttpResponse = {
|
|
503
|
+
data: AssistantsResult;
|
|
504
|
+
headers: Headers;
|
|
505
|
+
status: 200;
|
|
506
|
+
prev?: (options?: ApiCallOptions) => Promise<GetAssistantsHttpResponse>;
|
|
507
|
+
next?: (options?: ApiCallOptions) => Promise<GetAssistantsHttpResponse>;
|
|
508
|
+
};
|
|
509
|
+
type GetAssistantsHttpError = {
|
|
510
|
+
data: ErrorResponse;
|
|
511
|
+
headers: Headers;
|
|
512
|
+
status: 400 | 403;
|
|
513
|
+
};
|
|
514
|
+
/**
|
|
515
|
+
* Creates a new assistant.
|
|
516
|
+
*
|
|
517
|
+
* @param body an object with the body content
|
|
518
|
+
* @throws CreateAssistantHttpError
|
|
519
|
+
*/
|
|
520
|
+
declare const createAssistant: (body: CreateAssistant, options?: ApiCallOptions) => Promise<CreateAssistantHttpResponse>;
|
|
521
|
+
type CreateAssistantHttpResponse = {
|
|
522
|
+
data: Assistant;
|
|
523
|
+
headers: Headers;
|
|
524
|
+
status: 201;
|
|
525
|
+
};
|
|
526
|
+
type CreateAssistantHttpError = {
|
|
527
|
+
data: ErrorResponse;
|
|
528
|
+
headers: Headers;
|
|
529
|
+
status: 400 | 403;
|
|
530
|
+
};
|
|
531
|
+
/**
|
|
532
|
+
* Retrieves feedback summary for the assistant.
|
|
533
|
+
*
|
|
534
|
+
* @param assistantId The ID of the assistant from which to retrieve feedback summary.
|
|
535
|
+
* @throws GetAssistantFeedbackHttpError
|
|
536
|
+
*/
|
|
537
|
+
declare const getAssistantFeedback: (assistantId: string, options?: ApiCallOptions) => Promise<GetAssistantFeedbackHttpResponse>;
|
|
538
|
+
type GetAssistantFeedbackHttpResponse = {
|
|
539
|
+
data: FeedbackSummary;
|
|
540
|
+
headers: Headers;
|
|
541
|
+
status: 200;
|
|
542
|
+
};
|
|
543
|
+
type GetAssistantFeedbackHttpError = {
|
|
544
|
+
data: ErrorResponse;
|
|
545
|
+
headers: Headers;
|
|
546
|
+
status: 400 | 403 | 404;
|
|
547
|
+
};
|
|
548
|
+
/**
|
|
549
|
+
* Perform a bulk search for the plaintext of source chunks for the assistant.
|
|
550
|
+
*
|
|
551
|
+
* @param assistantId The ID of the assistant in which to search for source chunks.
|
|
552
|
+
* @param body an object with the body content
|
|
553
|
+
* @throws GetAssistantSourcesHttpError
|
|
554
|
+
*/
|
|
555
|
+
declare const getAssistantSources: (assistantId: string, body: ChunksRefs, options?: ApiCallOptions) => Promise<GetAssistantSourcesHttpResponse>;
|
|
556
|
+
type GetAssistantSourcesHttpResponse = {
|
|
557
|
+
data: SourcesPlaintext;
|
|
558
|
+
headers: Headers;
|
|
559
|
+
status: 202;
|
|
560
|
+
};
|
|
561
|
+
type GetAssistantSourcesHttpError = {
|
|
562
|
+
data: ErrorResponse;
|
|
563
|
+
headers: Headers;
|
|
564
|
+
status: 400 | 403 | 404;
|
|
565
|
+
};
|
|
566
|
+
/**
|
|
567
|
+
* Retrieves the list of starters for the assistant.
|
|
568
|
+
*
|
|
569
|
+
* @param assistantId The ID of the assistant from which to retrieve starters.
|
|
570
|
+
* @param query an object with query parameters
|
|
571
|
+
* @throws GetAssistantStartersHttpError
|
|
572
|
+
*/
|
|
573
|
+
declare const getAssistantStarters: (assistantId: string, query: {
|
|
574
|
+
/** The number of starters to get. */
|
|
575
|
+
limit?: number;
|
|
576
|
+
/** Optional parameter to request the next page. */
|
|
577
|
+
next?: string;
|
|
578
|
+
/** Optional parameter to request the previous page. */
|
|
579
|
+
prev?: string;
|
|
580
|
+
/** Optional resource field name to sort on, case insensitive, e.g. `name`. Can be prefixed with `-` to set descending order; defaults to ascending. */
|
|
581
|
+
sort?: "QUESTION" | "-QUESTION" | "CREATED" | "-CREATED" | "UPDATED" | "-UPDATED";
|
|
582
|
+
}, options?: ApiCallOptions) => Promise<GetAssistantStartersHttpResponse>;
|
|
583
|
+
type GetAssistantStartersHttpResponse = {
|
|
584
|
+
data: StartersResult;
|
|
585
|
+
headers: Headers;
|
|
586
|
+
status: 200;
|
|
587
|
+
prev?: (options?: ApiCallOptions) => Promise<GetAssistantStartersHttpResponse>;
|
|
588
|
+
next?: (options?: ApiCallOptions) => Promise<GetAssistantStartersHttpResponse>;
|
|
589
|
+
};
|
|
590
|
+
type GetAssistantStartersHttpError = {
|
|
591
|
+
data: ErrorResponse;
|
|
592
|
+
headers: Headers;
|
|
593
|
+
status: 400 | 403 | 404;
|
|
594
|
+
};
|
|
595
|
+
/**
|
|
596
|
+
* Creates a new starter for the assistant.
|
|
597
|
+
*
|
|
598
|
+
* @param assistantId The ID of the assistant in which to create the starter.
|
|
599
|
+
* @param body an object with the body content
|
|
600
|
+
* @throws CreateAssistantStarterHttpError
|
|
601
|
+
*/
|
|
602
|
+
declare const createAssistantStarter: (assistantId: string, body: CreateStarter, options?: ApiCallOptions) => Promise<CreateAssistantStarterHttpResponse>;
|
|
603
|
+
type CreateAssistantStarterHttpResponse = {
|
|
604
|
+
data: Starter;
|
|
605
|
+
headers: Headers;
|
|
606
|
+
status: 201;
|
|
607
|
+
};
|
|
608
|
+
type CreateAssistantStarterHttpError = {
|
|
609
|
+
data: ErrorResponse;
|
|
610
|
+
headers: Headers;
|
|
611
|
+
status: 400 | 403 | 404;
|
|
612
|
+
};
|
|
613
|
+
/**
|
|
614
|
+
* Deletes the starter and all of its resources.
|
|
615
|
+
*
|
|
616
|
+
* @param assistantId The ID of the assistant containing the requested starter.
|
|
617
|
+
* @param starterId The ID of the starter to delete.
|
|
618
|
+
* @throws DeleteAssistantStarterHttpError
|
|
619
|
+
*/
|
|
620
|
+
declare const deleteAssistantStarter: (assistantId: string, starterId: string, options?: ApiCallOptions) => Promise<DeleteAssistantStarterHttpResponse>;
|
|
621
|
+
type DeleteAssistantStarterHttpResponse = {
|
|
622
|
+
data: void;
|
|
623
|
+
headers: Headers;
|
|
624
|
+
status: 204;
|
|
625
|
+
};
|
|
626
|
+
type DeleteAssistantStarterHttpError = {
|
|
627
|
+
data: ErrorResponse;
|
|
628
|
+
headers: Headers;
|
|
629
|
+
status: 400 | 403 | 404;
|
|
630
|
+
};
|
|
631
|
+
/**
|
|
632
|
+
* Retrieves the specified starter.
|
|
633
|
+
*
|
|
634
|
+
* @param assistantId The ID of the assistant containing the requested starter.
|
|
635
|
+
* @param starterId The ID of the starter to retrieve.
|
|
636
|
+
* @throws GetAssistantStarterHttpError
|
|
637
|
+
*/
|
|
638
|
+
declare const getAssistantStarter: (assistantId: string, starterId: string, options?: ApiCallOptions) => Promise<GetAssistantStarterHttpResponse>;
|
|
639
|
+
type GetAssistantStarterHttpResponse = {
|
|
640
|
+
data: Starter;
|
|
641
|
+
headers: Headers;
|
|
642
|
+
status: 200;
|
|
643
|
+
};
|
|
644
|
+
type GetAssistantStarterHttpError = {
|
|
645
|
+
data: ErrorResponse;
|
|
646
|
+
headers: Headers;
|
|
647
|
+
status: 400 | 403 | 404;
|
|
648
|
+
};
|
|
649
|
+
/**
|
|
650
|
+
* Updates the specified starter.
|
|
651
|
+
*
|
|
652
|
+
* @param assistantId The ID of the assistant containing the requested starter.
|
|
653
|
+
* @param starterId The ID of the starter to retrieve.
|
|
654
|
+
* @param body an object with the body content
|
|
655
|
+
* @throws UpdateAssistantStarterHttpError
|
|
656
|
+
*/
|
|
657
|
+
declare const updateAssistantStarter: (assistantId: string, starterId: string, body: Starter, options?: ApiCallOptions) => Promise<UpdateAssistantStarterHttpResponse>;
|
|
658
|
+
type UpdateAssistantStarterHttpResponse = {
|
|
659
|
+
data: Starter;
|
|
660
|
+
headers: Headers;
|
|
661
|
+
status: 200;
|
|
662
|
+
};
|
|
663
|
+
type UpdateAssistantStarterHttpError = {
|
|
664
|
+
data: ErrorResponse;
|
|
665
|
+
headers: Headers;
|
|
666
|
+
status: 400 | 403 | 404;
|
|
667
|
+
};
|
|
668
|
+
/**
|
|
669
|
+
* Deletes the specified Followup.
|
|
670
|
+
*
|
|
671
|
+
* @param assistantId The ID of the assistant containing the requested Followup.
|
|
672
|
+
* @param starterId The ID of the starter containing the requested Followup.
|
|
673
|
+
* @param followupId The ID of the Followup to delete.
|
|
674
|
+
* @throws DeleteAssistantStarterFollowupHttpError
|
|
675
|
+
*/
|
|
676
|
+
declare const deleteAssistantStarterFollowup: (assistantId: string, starterId: string, followupId: string, options?: ApiCallOptions) => Promise<DeleteAssistantStarterFollowupHttpResponse>;
|
|
677
|
+
type DeleteAssistantStarterFollowupHttpResponse = {
|
|
678
|
+
data: void;
|
|
679
|
+
headers: Headers;
|
|
680
|
+
status: 204;
|
|
681
|
+
};
|
|
682
|
+
type DeleteAssistantStarterFollowupHttpError = {
|
|
683
|
+
data: ErrorResponse;
|
|
684
|
+
headers: Headers;
|
|
685
|
+
status: 400 | 403 | 404;
|
|
686
|
+
};
|
|
687
|
+
/**
|
|
688
|
+
* Updates the specified Followup.
|
|
689
|
+
*
|
|
690
|
+
* @param assistantId The ID of the assistant containing the requested Followup.
|
|
691
|
+
* @param starterId The ID of the starter containing the requested Followup.
|
|
692
|
+
* @param followupId The ID of the Followup to update.
|
|
693
|
+
* @param body an object with the body content
|
|
694
|
+
* @throws UpdateAssistantStarterFollowupHttpError
|
|
695
|
+
*/
|
|
696
|
+
declare const updateAssistantStarterFollowup: (assistantId: string, starterId: string, followupId: string, body: Followup, options?: ApiCallOptions) => Promise<UpdateAssistantStarterFollowupHttpResponse>;
|
|
697
|
+
type UpdateAssistantStarterFollowupHttpResponse = {
|
|
698
|
+
data: Starter;
|
|
699
|
+
headers: Headers;
|
|
700
|
+
status: 200;
|
|
701
|
+
};
|
|
702
|
+
type UpdateAssistantStarterFollowupHttpError = {
|
|
703
|
+
data: ErrorResponse;
|
|
704
|
+
headers: Headers;
|
|
705
|
+
status: 400 | 403 | 404;
|
|
706
|
+
};
|
|
707
|
+
/**
|
|
708
|
+
* Retrieves the list of threads for the assistant.
|
|
709
|
+
*
|
|
710
|
+
* @param assistantId The ID of the assistant from which to retrieve threads.
|
|
711
|
+
* @param query an object with query parameters
|
|
712
|
+
* @throws GetAssistantThreadsHttpError
|
|
713
|
+
*/
|
|
714
|
+
declare const getAssistantThreads: (assistantId: string, query: {
|
|
715
|
+
/** Optional parameter to filter threads. */
|
|
716
|
+
filter?: string;
|
|
717
|
+
/** The number of assistants to get. */
|
|
718
|
+
limit?: number;
|
|
719
|
+
/** Optional parameter to request the next page. */
|
|
720
|
+
next?: string;
|
|
721
|
+
/** Optional parameter to request the previous page. */
|
|
722
|
+
prev?: string;
|
|
723
|
+
/** Optional resource field name to sort on, case insensitive, e.g. `name`. Can be prefixed with `-` to set descending order; defaults to ascending. */
|
|
724
|
+
sort?: "NAME" | "-NAME" | "CREATED" | "-CREATED" | "UPDATED" | "-UPDATED";
|
|
725
|
+
}, options?: ApiCallOptions) => Promise<GetAssistantThreadsHttpResponse>;
|
|
726
|
+
type GetAssistantThreadsHttpResponse = {
|
|
727
|
+
data: ThreadsResult;
|
|
728
|
+
headers: Headers;
|
|
729
|
+
status: 200;
|
|
730
|
+
prev?: (options?: ApiCallOptions) => Promise<GetAssistantThreadsHttpResponse>;
|
|
731
|
+
next?: (options?: ApiCallOptions) => Promise<GetAssistantThreadsHttpResponse>;
|
|
732
|
+
};
|
|
733
|
+
type GetAssistantThreadsHttpError = {
|
|
734
|
+
data: ErrorResponse;
|
|
735
|
+
headers: Headers;
|
|
736
|
+
status: 400 | 403 | 404;
|
|
737
|
+
};
|
|
738
|
+
/**
|
|
739
|
+
* Creates a new thread for the assistant.
|
|
740
|
+
*
|
|
741
|
+
* @param assistantId The ID of the assistant in which to create the thread.
|
|
742
|
+
* @param body an object with the body content
|
|
743
|
+
* @throws CreateAssistantThreadHttpError
|
|
744
|
+
*/
|
|
745
|
+
declare const createAssistantThread: (assistantId: string, body: CreateThread, options?: ApiCallOptions) => Promise<CreateAssistantThreadHttpResponse>;
|
|
746
|
+
type CreateAssistantThreadHttpResponse = {
|
|
747
|
+
data: Thread;
|
|
748
|
+
headers: Headers;
|
|
749
|
+
status: 201;
|
|
750
|
+
};
|
|
751
|
+
type CreateAssistantThreadHttpError = {
|
|
752
|
+
data: ErrorResponse;
|
|
753
|
+
headers: Headers;
|
|
754
|
+
status: 400 | 403 | 404;
|
|
755
|
+
};
|
|
756
|
+
/**
|
|
757
|
+
* Execute prompt in synchronous non-streaming mode.
|
|
758
|
+
*
|
|
759
|
+
* @param assistantId The id of the Assistant containing requested Thread
|
|
760
|
+
* @param threadId The id of the Thread to retrieve
|
|
761
|
+
* @param body an object with the body content
|
|
762
|
+
* @throws InvokeAssistantThreadHttpError
|
|
763
|
+
*/
|
|
764
|
+
declare const invokeAssistantThread: (assistantId: string, threadId: string, body: PromptInput, options?: ApiCallOptions) => Promise<InvokeAssistantThreadHttpResponse>;
|
|
765
|
+
type InvokeAssistantThreadHttpResponse = {
|
|
766
|
+
data: PromptOutputInvoke;
|
|
767
|
+
headers: Headers;
|
|
768
|
+
status: 200;
|
|
769
|
+
};
|
|
770
|
+
type InvokeAssistantThreadHttpError = {
|
|
771
|
+
data: ErrorResponseCopy;
|
|
772
|
+
headers: Headers;
|
|
773
|
+
status: 400 | 403 | 404 | 500;
|
|
774
|
+
};
|
|
775
|
+
/**
|
|
776
|
+
* Execute prompt in asynchronous streaming mode.
|
|
777
|
+
*
|
|
778
|
+
* @param assistantId The id of the Assistant containing requested Thread
|
|
779
|
+
* @param threadId The id of the Thread to retrieve
|
|
780
|
+
* @param body an object with the body content
|
|
781
|
+
* @throws StreamAssistantThreadHttpError
|
|
782
|
+
*/
|
|
783
|
+
declare const streamAssistantThread: (assistantId: string, threadId: string, body: PromptInput, options?: ApiCallOptions) => Promise<StreamAssistantThreadHttpResponse>;
|
|
784
|
+
type StreamAssistantThreadHttpResponse = {
|
|
785
|
+
data: PromptOutput;
|
|
786
|
+
headers: Headers;
|
|
787
|
+
status: 200;
|
|
788
|
+
};
|
|
789
|
+
type StreamAssistantThreadHttpError = {
|
|
790
|
+
data: ErrorResponseCopy;
|
|
791
|
+
headers: Headers;
|
|
792
|
+
status: 400 | 403 | 404 | 405 | 500;
|
|
793
|
+
};
|
|
794
|
+
/**
|
|
795
|
+
* Retrieves the list of interactions for the thread.
|
|
796
|
+
*
|
|
797
|
+
* @param assistantId The ID of the assistant from which to retrieve the interactions.
|
|
798
|
+
* @param threadId The ID of the thread from which to retrieve the interactions.
|
|
799
|
+
* @param query an object with query parameters
|
|
800
|
+
* @throws GetAssistantThreadInteractionsHttpError
|
|
801
|
+
*/
|
|
802
|
+
declare const getAssistantThreadInteractions: (assistantId: string, threadId: string, query: {
|
|
803
|
+
/** The number of feedback to get. */
|
|
804
|
+
limit?: number;
|
|
805
|
+
/** Optional parameter to request the next page. */
|
|
806
|
+
next?: string;
|
|
807
|
+
/** Optional parameter to request the previous page. */
|
|
808
|
+
prev?: string;
|
|
809
|
+
/** Optional resource field name to sort on, case insensitive, e.g. `created`. Can be prefixed with `-` to set descending order; defaults to ascending. */
|
|
810
|
+
sort?: "CREATED" | "-CREATED" | "UPDATED" | "-UPDATED";
|
|
811
|
+
}, options?: ApiCallOptions) => Promise<GetAssistantThreadInteractionsHttpResponse>;
|
|
812
|
+
type GetAssistantThreadInteractionsHttpResponse = {
|
|
813
|
+
data: InteractionsResult;
|
|
814
|
+
headers: Headers;
|
|
815
|
+
status: 200;
|
|
816
|
+
prev?: (options?: ApiCallOptions) => Promise<GetAssistantThreadInteractionsHttpResponse>;
|
|
817
|
+
next?: (options?: ApiCallOptions) => Promise<GetAssistantThreadInteractionsHttpResponse>;
|
|
818
|
+
};
|
|
819
|
+
type GetAssistantThreadInteractionsHttpError = {
|
|
820
|
+
data: ErrorResponse;
|
|
821
|
+
headers: Headers;
|
|
822
|
+
status: 400 | 403 | 404;
|
|
823
|
+
};
|
|
824
|
+
/**
|
|
825
|
+
* Creates a new interaction for the thread.
|
|
826
|
+
*
|
|
827
|
+
* @param assistantId The ID of the assistant in which to create the interaction.
|
|
828
|
+
* @param threadId The ID of the thread in which to create the interaction.
|
|
829
|
+
* @param body an object with the body content
|
|
830
|
+
* @throws CreateAssistantThreadInteractionHttpError
|
|
831
|
+
*/
|
|
832
|
+
declare const createAssistantThreadInteraction: (assistantId: string, threadId: string, body: CreateInteraction, options?: ApiCallOptions) => Promise<CreateAssistantThreadInteractionHttpResponse>;
|
|
833
|
+
type CreateAssistantThreadInteractionHttpResponse = {
|
|
834
|
+
data: Interaction;
|
|
835
|
+
headers: Headers;
|
|
836
|
+
status: 201;
|
|
837
|
+
};
|
|
838
|
+
type CreateAssistantThreadInteractionHttpError = {
|
|
839
|
+
data: ErrorResponse;
|
|
840
|
+
headers: Headers;
|
|
841
|
+
status: 400 | 403 | 404;
|
|
842
|
+
};
|
|
843
|
+
/**
|
|
844
|
+
* Deletes the specified interaction and all of its resources.
|
|
845
|
+
*
|
|
846
|
+
* @param assistantId The ID of the assistant in which to delete the interaction.
|
|
847
|
+
* @param threadId The ID of the thread in which to delete the interaction.
|
|
848
|
+
* @param interactionId The ID of the interaction to delete.
|
|
849
|
+
* @throws DeleteAssistantThreadInteractionHttpError
|
|
850
|
+
*/
|
|
851
|
+
declare const deleteAssistantThreadInteraction: (assistantId: string, threadId: string, interactionId: string, options?: ApiCallOptions) => Promise<DeleteAssistantThreadInteractionHttpResponse>;
|
|
852
|
+
type DeleteAssistantThreadInteractionHttpResponse = {
|
|
853
|
+
data: void;
|
|
854
|
+
headers: Headers;
|
|
855
|
+
status: 204;
|
|
856
|
+
};
|
|
857
|
+
type DeleteAssistantThreadInteractionHttpError = {
|
|
858
|
+
data: ErrorResponse;
|
|
859
|
+
headers: Headers;
|
|
860
|
+
status: 400 | 403 | 404;
|
|
861
|
+
};
|
|
862
|
+
/**
|
|
863
|
+
* Retrieves an interaction for the thread.
|
|
864
|
+
*
|
|
865
|
+
* @param assistantId The ID of the assistant in which to retrieve the interaction.
|
|
866
|
+
* @param threadId The ID of the thread in which to retrieve the interaction.
|
|
867
|
+
* @param interactionId The ID of the interaction to retrieve.
|
|
868
|
+
* @throws GetAssistantThreadInteractionHttpError
|
|
869
|
+
*/
|
|
870
|
+
declare const getAssistantThreadInteraction: (assistantId: string, threadId: string, interactionId: string, options?: ApiCallOptions) => Promise<GetAssistantThreadInteractionHttpResponse>;
|
|
871
|
+
type GetAssistantThreadInteractionHttpResponse = {
|
|
872
|
+
data: Interaction;
|
|
873
|
+
headers: Headers;
|
|
874
|
+
status: 200;
|
|
875
|
+
};
|
|
876
|
+
type GetAssistantThreadInteractionHttpError = {
|
|
877
|
+
data: ErrorResponse;
|
|
878
|
+
headers: Headers;
|
|
879
|
+
status: 400 | 403 | 404;
|
|
880
|
+
};
|
|
881
|
+
/**
|
|
882
|
+
* Creates feedback for the thread.
|
|
883
|
+
*
|
|
884
|
+
* @param assistantId The ID of the assistant in which to create the feedback.
|
|
885
|
+
* @param threadId The ID of the thread in which to create the feedback.
|
|
886
|
+
* @param interactionId The ID of the interaction in which to create the feedback.
|
|
887
|
+
* @param body an object with the body content
|
|
888
|
+
* @throws CreateAssistantThreadInteractionFeedbackHttpError
|
|
889
|
+
*/
|
|
890
|
+
declare const createAssistantThreadInteractionFeedback: (assistantId: string, threadId: string, interactionId: string, body: CreateFeedback, options?: ApiCallOptions) => Promise<CreateAssistantThreadInteractionFeedbackHttpResponse>;
|
|
891
|
+
type CreateAssistantThreadInteractionFeedbackHttpResponse = {
|
|
892
|
+
data: Interaction;
|
|
893
|
+
headers: Headers;
|
|
894
|
+
status: 201;
|
|
895
|
+
};
|
|
896
|
+
type CreateAssistantThreadInteractionFeedbackHttpError = {
|
|
897
|
+
data: ErrorResponse;
|
|
898
|
+
headers: Headers;
|
|
899
|
+
status: 400 | 403 | 404;
|
|
900
|
+
};
|
|
901
|
+
/**
|
|
902
|
+
* Updates feedback for the thread.
|
|
903
|
+
*
|
|
904
|
+
* @param assistantId The ID of the assistant containing the requested feedback.
|
|
905
|
+
* @param threadId The ID of the thread containing the requested feedback.
|
|
906
|
+
* @param interactionId The ID of the interaction containing the requested Feedback.
|
|
907
|
+
* @param feedbackId The ID of the feedback to update.
|
|
908
|
+
* @param body an object with the body content
|
|
909
|
+
* @throws PatchAssistantThreadInteractionFeedbackHttpError
|
|
910
|
+
*/
|
|
911
|
+
declare const patchAssistantThreadInteractionFeedback: (assistantId: string, threadId: string, interactionId: string, feedbackId: string, body: FeedbackPatchArray, options?: ApiCallOptions) => Promise<PatchAssistantThreadInteractionFeedbackHttpResponse>;
|
|
912
|
+
type PatchAssistantThreadInteractionFeedbackHttpResponse = {
|
|
913
|
+
data: void;
|
|
914
|
+
headers: Headers;
|
|
915
|
+
status: 204;
|
|
916
|
+
};
|
|
917
|
+
type PatchAssistantThreadInteractionFeedbackHttpError = {
|
|
918
|
+
data: ErrorResponse;
|
|
919
|
+
headers: Headers;
|
|
920
|
+
status: 400 | 403 | 404;
|
|
921
|
+
};
|
|
922
|
+
/**
|
|
923
|
+
* Creates feedback review for the thread.
|
|
924
|
+
*
|
|
925
|
+
* @param assistantId The ID of the assistant in which to create the feedback review.
|
|
926
|
+
* @param threadId The ID of the thread in which to create the feedback review.
|
|
927
|
+
* @param interactionId The ID of the interaction in which to create the feedback review.
|
|
928
|
+
* @param body an object with the body content
|
|
929
|
+
* @throws CreateAssistantThreadInteractionReviewHttpError
|
|
930
|
+
*/
|
|
931
|
+
declare const createAssistantThreadInteractionReview: (assistantId: string, threadId: string, interactionId: string, body: CreateReview, options?: ApiCallOptions) => Promise<CreateAssistantThreadInteractionReviewHttpResponse>;
|
|
932
|
+
type CreateAssistantThreadInteractionReviewHttpResponse = {
|
|
933
|
+
data: Interaction;
|
|
934
|
+
headers: Headers;
|
|
935
|
+
status: 201;
|
|
936
|
+
};
|
|
937
|
+
type CreateAssistantThreadInteractionReviewHttpError = {
|
|
938
|
+
data: ErrorResponse;
|
|
939
|
+
headers: Headers;
|
|
940
|
+
status: 400 | 403 | 404;
|
|
941
|
+
};
|
|
942
|
+
/**
|
|
943
|
+
* Deletes the specified thread and all of its resources.
|
|
944
|
+
*
|
|
945
|
+
* @param assistantid The ID of the assistant containing the requested thread.
|
|
946
|
+
* @param threadid The ID of the thread to retrieve.
|
|
947
|
+
* @throws DeleteAssistantThreadHttpError
|
|
948
|
+
*/
|
|
949
|
+
declare const deleteAssistantThread: (assistantid: string, threadid: string, options?: ApiCallOptions) => Promise<DeleteAssistantThreadHttpResponse>;
|
|
950
|
+
type DeleteAssistantThreadHttpResponse = {
|
|
951
|
+
data: void;
|
|
952
|
+
headers: Headers;
|
|
953
|
+
status: 204;
|
|
954
|
+
};
|
|
955
|
+
type DeleteAssistantThreadHttpError = {
|
|
956
|
+
data: ErrorResponse;
|
|
957
|
+
headers: Headers;
|
|
958
|
+
status: 400 | 403 | 404;
|
|
959
|
+
};
|
|
960
|
+
/**
|
|
961
|
+
* Retrieves a thread for the assistant.
|
|
962
|
+
*
|
|
963
|
+
* @param assistantid The ID of the assistant containing the requested thread.
|
|
964
|
+
* @param threadid The ID of the thread to retrieve.
|
|
965
|
+
* @throws GetAssistantThreadHttpError
|
|
966
|
+
*/
|
|
967
|
+
declare const getAssistantThread: (assistantid: string, threadid: string, options?: ApiCallOptions) => Promise<GetAssistantThreadHttpResponse>;
|
|
968
|
+
type GetAssistantThreadHttpResponse = {
|
|
969
|
+
data: ThreadWithMessages;
|
|
970
|
+
headers: Headers;
|
|
971
|
+
status: 200;
|
|
972
|
+
};
|
|
973
|
+
type GetAssistantThreadHttpError = {
|
|
974
|
+
data: ErrorResponse;
|
|
975
|
+
headers: Headers;
|
|
976
|
+
status: 400 | 403 | 404;
|
|
977
|
+
};
|
|
978
|
+
/**
|
|
979
|
+
* Updates the properties of an existing thread with JSON Patch-formatted data.
|
|
980
|
+
*
|
|
981
|
+
* @param assistantid The ID of the assistant containing the requested thread.
|
|
982
|
+
* @param threadid The ID of the thread to retrieve.
|
|
983
|
+
* @param body an object with the body content
|
|
984
|
+
* @throws PatchAssistantThreadHttpError
|
|
985
|
+
*/
|
|
986
|
+
declare const patchAssistantThread: (assistantid: string, threadid: string, body: ThreadPatchArray, options?: ApiCallOptions) => Promise<PatchAssistantThreadHttpResponse>;
|
|
987
|
+
type PatchAssistantThreadHttpResponse = {
|
|
988
|
+
data: void;
|
|
989
|
+
headers: Headers;
|
|
990
|
+
status: 204;
|
|
991
|
+
};
|
|
992
|
+
type PatchAssistantThreadHttpError = {
|
|
993
|
+
data: ErrorResponse;
|
|
994
|
+
headers: Headers;
|
|
995
|
+
status: 400 | 401 | 403 | 404 | 429;
|
|
996
|
+
};
|
|
997
|
+
/**
|
|
998
|
+
* Deletes the assistant and all of its resources.
|
|
999
|
+
*
|
|
1000
|
+
* @param id The ID of the assistant to delete.
|
|
1001
|
+
* @throws DeleteAssistantHttpError
|
|
1002
|
+
*/
|
|
1003
|
+
declare const deleteAssistant: (id: string, options?: ApiCallOptions) => Promise<DeleteAssistantHttpResponse>;
|
|
1004
|
+
type DeleteAssistantHttpResponse = {
|
|
1005
|
+
data: void;
|
|
1006
|
+
headers: Headers;
|
|
1007
|
+
status: 204;
|
|
1008
|
+
};
|
|
1009
|
+
type DeleteAssistantHttpError = {
|
|
1010
|
+
data: ErrorResponse;
|
|
1011
|
+
headers: Headers;
|
|
1012
|
+
status: 400 | 403 | 404;
|
|
1013
|
+
};
|
|
1014
|
+
/**
|
|
1015
|
+
* Retrieves the specified assistant.
|
|
1016
|
+
*
|
|
1017
|
+
* @param id The ID of the assistant to retrieve.
|
|
1018
|
+
* @throws GetAssistantHttpError
|
|
1019
|
+
*/
|
|
1020
|
+
declare const getAssistant: (id: string, options?: ApiCallOptions) => Promise<GetAssistantHttpResponse>;
|
|
1021
|
+
type GetAssistantHttpResponse = {
|
|
1022
|
+
data: Assistant;
|
|
1023
|
+
headers: Headers;
|
|
1024
|
+
status: 200;
|
|
1025
|
+
};
|
|
1026
|
+
type GetAssistantHttpError = {
|
|
1027
|
+
data: ErrorResponse;
|
|
1028
|
+
headers: Headers;
|
|
1029
|
+
status: 400 | 403 | 404;
|
|
1030
|
+
};
|
|
1031
|
+
/**
|
|
1032
|
+
* Updates the properties of an existing assistant with JSON Patch-formatted data.
|
|
1033
|
+
*
|
|
1034
|
+
* @param id The assistant ID.
|
|
1035
|
+
* @param body an object with the body content
|
|
1036
|
+
* @throws PatchAssistantHttpError
|
|
1037
|
+
*/
|
|
1038
|
+
declare const patchAssistant: (id: string, body: JSONPatchArray, options?: ApiCallOptions) => Promise<PatchAssistantHttpResponse>;
|
|
1039
|
+
type PatchAssistantHttpResponse = {
|
|
1040
|
+
data: void;
|
|
1041
|
+
headers: Headers;
|
|
1042
|
+
status: 204;
|
|
1043
|
+
};
|
|
1044
|
+
type PatchAssistantHttpError = {
|
|
1045
|
+
data: ErrorResponse;
|
|
1046
|
+
headers: Headers;
|
|
1047
|
+
status: 400 | 401 | 403 | 404 | 429;
|
|
1048
|
+
};
|
|
1049
|
+
/**
|
|
1050
|
+
* Clears the cache for assistants api requests.
|
|
1051
|
+
*/
|
|
1052
|
+
declare function clearCache(): void;
|
|
1053
|
+
interface AssistantsAPI {
|
|
1054
|
+
/**
|
|
1055
|
+
* Retrieves the list of assistants. The result can be filtered, sorted, and paginated.
|
|
1056
|
+
*
|
|
1057
|
+
* @param query an object with query parameters
|
|
1058
|
+
* @throws GetAssistantsHttpError
|
|
1059
|
+
*/
|
|
1060
|
+
getAssistants: typeof getAssistants;
|
|
1061
|
+
/**
|
|
1062
|
+
* Creates a new assistant.
|
|
1063
|
+
*
|
|
1064
|
+
* @param body an object with the body content
|
|
1065
|
+
* @throws CreateAssistantHttpError
|
|
1066
|
+
*/
|
|
1067
|
+
createAssistant: typeof createAssistant;
|
|
1068
|
+
/**
|
|
1069
|
+
* Retrieves feedback summary for the assistant.
|
|
1070
|
+
*
|
|
1071
|
+
* @param assistantId The ID of the assistant from which to retrieve feedback summary.
|
|
1072
|
+
* @throws GetAssistantFeedbackHttpError
|
|
1073
|
+
*/
|
|
1074
|
+
getAssistantFeedback: typeof getAssistantFeedback;
|
|
1075
|
+
/**
|
|
1076
|
+
* Perform a bulk search for the plaintext of source chunks for the assistant.
|
|
1077
|
+
*
|
|
1078
|
+
* @param assistantId The ID of the assistant in which to search for source chunks.
|
|
1079
|
+
* @param body an object with the body content
|
|
1080
|
+
* @throws GetAssistantSourcesHttpError
|
|
1081
|
+
*/
|
|
1082
|
+
getAssistantSources: typeof getAssistantSources;
|
|
1083
|
+
/**
|
|
1084
|
+
* Retrieves the list of starters for the assistant.
|
|
1085
|
+
*
|
|
1086
|
+
* @param assistantId The ID of the assistant from which to retrieve starters.
|
|
1087
|
+
* @param query an object with query parameters
|
|
1088
|
+
* @throws GetAssistantStartersHttpError
|
|
1089
|
+
*/
|
|
1090
|
+
getAssistantStarters: typeof getAssistantStarters;
|
|
1091
|
+
/**
|
|
1092
|
+
* Creates a new starter for the assistant.
|
|
1093
|
+
*
|
|
1094
|
+
* @param assistantId The ID of the assistant in which to create the starter.
|
|
1095
|
+
* @param body an object with the body content
|
|
1096
|
+
* @throws CreateAssistantStarterHttpError
|
|
1097
|
+
*/
|
|
1098
|
+
createAssistantStarter: typeof createAssistantStarter;
|
|
1099
|
+
/**
|
|
1100
|
+
* Deletes the starter and all of its resources.
|
|
1101
|
+
*
|
|
1102
|
+
* @param assistantId The ID of the assistant containing the requested starter.
|
|
1103
|
+
* @param starterId The ID of the starter to delete.
|
|
1104
|
+
* @throws DeleteAssistantStarterHttpError
|
|
1105
|
+
*/
|
|
1106
|
+
deleteAssistantStarter: typeof deleteAssistantStarter;
|
|
1107
|
+
/**
|
|
1108
|
+
* Retrieves the specified starter.
|
|
1109
|
+
*
|
|
1110
|
+
* @param assistantId The ID of the assistant containing the requested starter.
|
|
1111
|
+
* @param starterId The ID of the starter to retrieve.
|
|
1112
|
+
* @throws GetAssistantStarterHttpError
|
|
1113
|
+
*/
|
|
1114
|
+
getAssistantStarter: typeof getAssistantStarter;
|
|
1115
|
+
/**
|
|
1116
|
+
* Updates the specified starter.
|
|
1117
|
+
*
|
|
1118
|
+
* @param assistantId The ID of the assistant containing the requested starter.
|
|
1119
|
+
* @param starterId The ID of the starter to retrieve.
|
|
1120
|
+
* @param body an object with the body content
|
|
1121
|
+
* @throws UpdateAssistantStarterHttpError
|
|
1122
|
+
*/
|
|
1123
|
+
updateAssistantStarter: typeof updateAssistantStarter;
|
|
1124
|
+
/**
|
|
1125
|
+
* Deletes the specified Followup.
|
|
1126
|
+
*
|
|
1127
|
+
* @param assistantId The ID of the assistant containing the requested Followup.
|
|
1128
|
+
* @param starterId The ID of the starter containing the requested Followup.
|
|
1129
|
+
* @param followupId The ID of the Followup to delete.
|
|
1130
|
+
* @throws DeleteAssistantStarterFollowupHttpError
|
|
1131
|
+
*/
|
|
1132
|
+
deleteAssistantStarterFollowup: typeof deleteAssistantStarterFollowup;
|
|
1133
|
+
/**
|
|
1134
|
+
* Updates the specified Followup.
|
|
1135
|
+
*
|
|
1136
|
+
* @param assistantId The ID of the assistant containing the requested Followup.
|
|
1137
|
+
* @param starterId The ID of the starter containing the requested Followup.
|
|
1138
|
+
* @param followupId The ID of the Followup to update.
|
|
1139
|
+
* @param body an object with the body content
|
|
1140
|
+
* @throws UpdateAssistantStarterFollowupHttpError
|
|
1141
|
+
*/
|
|
1142
|
+
updateAssistantStarterFollowup: typeof updateAssistantStarterFollowup;
|
|
1143
|
+
/**
|
|
1144
|
+
* Retrieves the list of threads for the assistant.
|
|
1145
|
+
*
|
|
1146
|
+
* @param assistantId The ID of the assistant from which to retrieve threads.
|
|
1147
|
+
* @param query an object with query parameters
|
|
1148
|
+
* @throws GetAssistantThreadsHttpError
|
|
1149
|
+
*/
|
|
1150
|
+
getAssistantThreads: typeof getAssistantThreads;
|
|
1151
|
+
/**
|
|
1152
|
+
* Creates a new thread for the assistant.
|
|
1153
|
+
*
|
|
1154
|
+
* @param assistantId The ID of the assistant in which to create the thread.
|
|
1155
|
+
* @param body an object with the body content
|
|
1156
|
+
* @throws CreateAssistantThreadHttpError
|
|
1157
|
+
*/
|
|
1158
|
+
createAssistantThread: typeof createAssistantThread;
|
|
1159
|
+
/**
|
|
1160
|
+
* Execute prompt in synchronous non-streaming mode.
|
|
1161
|
+
*
|
|
1162
|
+
* @param assistantId The id of the Assistant containing requested Thread
|
|
1163
|
+
* @param threadId The id of the Thread to retrieve
|
|
1164
|
+
* @param body an object with the body content
|
|
1165
|
+
* @throws InvokeAssistantThreadHttpError
|
|
1166
|
+
*/
|
|
1167
|
+
invokeAssistantThread: typeof invokeAssistantThread;
|
|
1168
|
+
/**
|
|
1169
|
+
* Execute prompt in asynchronous streaming mode.
|
|
1170
|
+
*
|
|
1171
|
+
* @param assistantId The id of the Assistant containing requested Thread
|
|
1172
|
+
* @param threadId The id of the Thread to retrieve
|
|
1173
|
+
* @param body an object with the body content
|
|
1174
|
+
* @throws StreamAssistantThreadHttpError
|
|
1175
|
+
*/
|
|
1176
|
+
streamAssistantThread: typeof streamAssistantThread;
|
|
1177
|
+
/**
|
|
1178
|
+
* Retrieves the list of interactions for the thread.
|
|
1179
|
+
*
|
|
1180
|
+
* @param assistantId The ID of the assistant from which to retrieve the interactions.
|
|
1181
|
+
* @param threadId The ID of the thread from which to retrieve the interactions.
|
|
1182
|
+
* @param query an object with query parameters
|
|
1183
|
+
* @throws GetAssistantThreadInteractionsHttpError
|
|
1184
|
+
*/
|
|
1185
|
+
getAssistantThreadInteractions: typeof getAssistantThreadInteractions;
|
|
1186
|
+
/**
|
|
1187
|
+
* Creates a new interaction for the thread.
|
|
1188
|
+
*
|
|
1189
|
+
* @param assistantId The ID of the assistant in which to create the interaction.
|
|
1190
|
+
* @param threadId The ID of the thread in which to create the interaction.
|
|
1191
|
+
* @param body an object with the body content
|
|
1192
|
+
* @throws CreateAssistantThreadInteractionHttpError
|
|
1193
|
+
*/
|
|
1194
|
+
createAssistantThreadInteraction: typeof createAssistantThreadInteraction;
|
|
1195
|
+
/**
|
|
1196
|
+
* Deletes the specified interaction and all of its resources.
|
|
1197
|
+
*
|
|
1198
|
+
* @param assistantId The ID of the assistant in which to delete the interaction.
|
|
1199
|
+
* @param threadId The ID of the thread in which to delete the interaction.
|
|
1200
|
+
* @param interactionId The ID of the interaction to delete.
|
|
1201
|
+
* @throws DeleteAssistantThreadInteractionHttpError
|
|
1202
|
+
*/
|
|
1203
|
+
deleteAssistantThreadInteraction: typeof deleteAssistantThreadInteraction;
|
|
1204
|
+
/**
|
|
1205
|
+
* Retrieves an interaction for the thread.
|
|
1206
|
+
*
|
|
1207
|
+
* @param assistantId The ID of the assistant in which to retrieve the interaction.
|
|
1208
|
+
* @param threadId The ID of the thread in which to retrieve the interaction.
|
|
1209
|
+
* @param interactionId The ID of the interaction to retrieve.
|
|
1210
|
+
* @throws GetAssistantThreadInteractionHttpError
|
|
1211
|
+
*/
|
|
1212
|
+
getAssistantThreadInteraction: typeof getAssistantThreadInteraction;
|
|
1213
|
+
/**
|
|
1214
|
+
* Creates feedback for the thread.
|
|
1215
|
+
*
|
|
1216
|
+
* @param assistantId The ID of the assistant in which to create the feedback.
|
|
1217
|
+
* @param threadId The ID of the thread in which to create the feedback.
|
|
1218
|
+
* @param interactionId The ID of the interaction in which to create the feedback.
|
|
1219
|
+
* @param body an object with the body content
|
|
1220
|
+
* @throws CreateAssistantThreadInteractionFeedbackHttpError
|
|
1221
|
+
*/
|
|
1222
|
+
createAssistantThreadInteractionFeedback: typeof createAssistantThreadInteractionFeedback;
|
|
1223
|
+
/**
|
|
1224
|
+
* Updates feedback for the thread.
|
|
1225
|
+
*
|
|
1226
|
+
* @param assistantId The ID of the assistant containing the requested feedback.
|
|
1227
|
+
* @param threadId The ID of the thread containing the requested feedback.
|
|
1228
|
+
* @param interactionId The ID of the interaction containing the requested Feedback.
|
|
1229
|
+
* @param feedbackId The ID of the feedback to update.
|
|
1230
|
+
* @param body an object with the body content
|
|
1231
|
+
* @throws PatchAssistantThreadInteractionFeedbackHttpError
|
|
1232
|
+
*/
|
|
1233
|
+
patchAssistantThreadInteractionFeedback: typeof patchAssistantThreadInteractionFeedback;
|
|
1234
|
+
/**
|
|
1235
|
+
* Creates feedback review for the thread.
|
|
1236
|
+
*
|
|
1237
|
+
* @param assistantId The ID of the assistant in which to create the feedback review.
|
|
1238
|
+
* @param threadId The ID of the thread in which to create the feedback review.
|
|
1239
|
+
* @param interactionId The ID of the interaction in which to create the feedback review.
|
|
1240
|
+
* @param body an object with the body content
|
|
1241
|
+
* @throws CreateAssistantThreadInteractionReviewHttpError
|
|
1242
|
+
*/
|
|
1243
|
+
createAssistantThreadInteractionReview: typeof createAssistantThreadInteractionReview;
|
|
1244
|
+
/**
|
|
1245
|
+
* Deletes the specified thread and all of its resources.
|
|
1246
|
+
*
|
|
1247
|
+
* @param assistantid The ID of the assistant containing the requested thread.
|
|
1248
|
+
* @param threadid The ID of the thread to retrieve.
|
|
1249
|
+
* @throws DeleteAssistantThreadHttpError
|
|
1250
|
+
*/
|
|
1251
|
+
deleteAssistantThread: typeof deleteAssistantThread;
|
|
1252
|
+
/**
|
|
1253
|
+
* Retrieves a thread for the assistant.
|
|
1254
|
+
*
|
|
1255
|
+
* @param assistantid The ID of the assistant containing the requested thread.
|
|
1256
|
+
* @param threadid The ID of the thread to retrieve.
|
|
1257
|
+
* @throws GetAssistantThreadHttpError
|
|
1258
|
+
*/
|
|
1259
|
+
getAssistantThread: typeof getAssistantThread;
|
|
1260
|
+
/**
|
|
1261
|
+
* Updates the properties of an existing thread with JSON Patch-formatted data.
|
|
1262
|
+
*
|
|
1263
|
+
* @param assistantid The ID of the assistant containing the requested thread.
|
|
1264
|
+
* @param threadid The ID of the thread to retrieve.
|
|
1265
|
+
* @param body an object with the body content
|
|
1266
|
+
* @throws PatchAssistantThreadHttpError
|
|
1267
|
+
*/
|
|
1268
|
+
patchAssistantThread: typeof patchAssistantThread;
|
|
1269
|
+
/**
|
|
1270
|
+
* Deletes the assistant and all of its resources.
|
|
1271
|
+
*
|
|
1272
|
+
* @param id The ID of the assistant to delete.
|
|
1273
|
+
* @throws DeleteAssistantHttpError
|
|
1274
|
+
*/
|
|
1275
|
+
deleteAssistant: typeof deleteAssistant;
|
|
1276
|
+
/**
|
|
1277
|
+
* Retrieves the specified assistant.
|
|
1278
|
+
*
|
|
1279
|
+
* @param id The ID of the assistant to retrieve.
|
|
1280
|
+
* @throws GetAssistantHttpError
|
|
1281
|
+
*/
|
|
1282
|
+
getAssistant: typeof getAssistant;
|
|
1283
|
+
/**
|
|
1284
|
+
* Updates the properties of an existing assistant with JSON Patch-formatted data.
|
|
1285
|
+
*
|
|
1286
|
+
* @param id The assistant ID.
|
|
1287
|
+
* @param body an object with the body content
|
|
1288
|
+
* @throws PatchAssistantHttpError
|
|
1289
|
+
*/
|
|
1290
|
+
patchAssistant: typeof patchAssistant;
|
|
1291
|
+
/**
|
|
1292
|
+
* Clears the cache for assistants api requests.
|
|
1293
|
+
*/
|
|
1294
|
+
clearCache: typeof clearCache;
|
|
1295
|
+
}
|
|
1296
|
+
/**
|
|
1297
|
+
* Functions for the assistants api
|
|
1298
|
+
*/
|
|
1299
|
+
declare const assistantsExport: AssistantsAPI;
|
|
1300
|
+
|
|
1301
|
+
export { type Assistant, type AssistantsAPI, type AssistantsResult, type ChunksRefs, type CreateAssistant, type CreateAssistantHttpError, type CreateAssistantHttpResponse, type CreateAssistantStarterHttpError, type CreateAssistantStarterHttpResponse, type CreateAssistantThreadHttpError, type CreateAssistantThreadHttpResponse, type CreateAssistantThreadInteractionFeedbackHttpError, type CreateAssistantThreadInteractionFeedbackHttpResponse, type CreateAssistantThreadInteractionHttpError, type CreateAssistantThreadInteractionHttpResponse, type CreateAssistantThreadInteractionReviewHttpError, type CreateAssistantThreadInteractionReviewHttpResponse, type CreateAssistantWithAvatar, type CreateFeedback, type CreateInteraction, type CreateReview, type CreateStarter, type CreateThread, type DeleteAssistantHttpError, type DeleteAssistantHttpResponse, type DeleteAssistantStarterFollowupHttpError, type DeleteAssistantStarterFollowupHttpResponse, type DeleteAssistantStarterHttpError, type DeleteAssistantStarterHttpResponse, type DeleteAssistantThreadHttpError, type DeleteAssistantThreadHttpResponse, type DeleteAssistantThreadInteractionHttpError, type DeleteAssistantThreadInteractionHttpResponse, type ErrorResponse, type ErrorResponseCode, type ErrorResponseCodeCopy, type ErrorResponseCopy, type Feedback, type FeedbackPatchArray, type FeedbackSummary, type Followup, type GetAssistantFeedbackHttpError, type GetAssistantFeedbackHttpResponse, type GetAssistantHttpError, type GetAssistantHttpResponse, type GetAssistantSourcesHttpError, type GetAssistantSourcesHttpResponse, type GetAssistantStarterHttpError, type GetAssistantStarterHttpResponse, type GetAssistantStartersHttpError, type GetAssistantStartersHttpResponse, type GetAssistantThreadHttpError, type GetAssistantThreadHttpResponse, type GetAssistantThreadInteractionHttpError, type GetAssistantThreadInteractionHttpResponse, type GetAssistantThreadInteractionsHttpError, type GetAssistantThreadInteractionsHttpResponse, type GetAssistantThreadsHttpError, type GetAssistantThreadsHttpResponse, type GetAssistantsHttpError, type GetAssistantsHttpResponse, type Interaction, type InteractionsResult, type InvokeAssistantThreadHttpError, type InvokeAssistantThreadHttpResponse, type JSONPatch, type JSONPatchArray, type Message, type MessageSource, type MessageSourceChunk, type PageLink, type PageLinks, type PatchAssistantHttpError, type PatchAssistantHttpResponse, type PatchAssistantThreadHttpError, type PatchAssistantThreadHttpResponse, type PatchAssistantThreadInteractionFeedbackHttpError, type PatchAssistantThreadInteractionFeedbackHttpResponse, type PromptInput, type PromptOutput, type PromptOutputInvoke, type RecommendedAnswer, type RejectionReason, type ResultMeta, type Source, type SourcesPlaintext, type Starter, type StartersResult, type StreamAssistantThreadHttpError, type StreamAssistantThreadHttpResponse, type Thread, type ThreadPatchArray, type ThreadWithMessages, type ThreadsResult, type UpdateAssistantStarterFollowupHttpError, type UpdateAssistantStarterFollowupHttpResponse, type UpdateAssistantStarterHttpError, type UpdateAssistantStarterHttpResponse, clearCache, createAssistant, createAssistantStarter, createAssistantThread, createAssistantThreadInteraction, createAssistantThreadInteractionFeedback, createAssistantThreadInteractionReview, assistantsExport as default, deleteAssistant, deleteAssistantStarter, deleteAssistantStarterFollowup, deleteAssistantThread, deleteAssistantThreadInteraction, getAssistant, getAssistantFeedback, getAssistantSources, getAssistantStarter, getAssistantStarters, getAssistantThread, getAssistantThreadInteraction, getAssistantThreadInteractions, getAssistantThreads, getAssistants, invokeAssistantThread, patchAssistant, patchAssistantThread, patchAssistantThreadInteractionFeedback, streamAssistantThread, updateAssistantStarter, updateAssistantStarterFollowup };
|