@qlik/api 2.3.1 → 2.4.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/analytics/change-stores.d.ts +40 -76
- package/analytics/change-stores.js +9 -10
- package/analytics.d.ts +1 -2
- package/analytics.js +5 -6
- package/api-keys.d.ts +46 -100
- package/api-keys.js +3 -4
- package/apps.d.ts +334 -461
- package/apps.js +74 -6
- package/assistants.d.ts +172 -337
- package/assistants.js +3 -4
- package/audits.d.ts +41 -85
- package/audits.js +3 -4
- package/auth-types.d.ts +110 -1
- package/auth-types.js +22 -1
- package/auth.d.ts +1 -2
- package/auth.js +1 -1
- package/automation-connections.d.ts +44 -95
- package/automation-connections.js +3 -4
- package/automation-connectors.d.ts +10 -20
- package/automation-connectors.js +3 -4
- package/automations.d.ts +54 -112
- package/automations.js +3 -4
- package/automl-deployments.d.ts +17 -36
- package/automl-deployments.js +3 -4
- package/automl-predictions.d.ts +12 -24
- package/automl-predictions.js +3 -4
- package/banners.d.ts +8 -14
- package/banners.js +3 -4
- package/brands.d.ts +19 -39
- package/brands.js +3 -4
- package/chunks/auth-B8lJw7rm.js +31 -0
- package/chunks/{interceptors-2VSXImC9.js → boot-interceptors-DqRxTczb.js} +50 -150
- package/chunks/{chunk-D3vHIbds.js → chunk-BdHzlgOL.js} +3 -3
- package/chunks/{invoke-fetch-CckTK7bh.js → invoke-fetch-DMAi6Fg3.js} +3 -3
- package/chunks/{invoke-fetch-D9lpiAb-.js → invoke-fetch-pMN6iqup.js} +2 -3
- package/chunks/platform-types-CECrZkOF.d.ts +29 -0
- package/chunks/{public-runtime-modules-BqxAMJ9M.js → public-runtime-modules-2KfyI2qM.js} +5 -5
- package/chunks/{qix-DpvHvpx7.js → qix-BdNrIA4s.js} +19 -20
- package/chunks/{qix-chunk-entrypoint-BXZPnE6J.js → qix-chunk-entrypoint-L9RpWwLK.js} +52 -58
- package/chunks/{qix-CrqXv44x.d.ts → qix-types-y_di0roE.d.ts} +33 -115
- package/collections.d.ts +67 -144
- package/collections.js +3 -4
- package/conditions.d.ts +87 -190
- package/conditions.js +3 -4
- package/consumption.d.ts +35 -72
- package/consumption.js +3 -4
- package/core/ip-policies.d.ts +43 -93
- package/core/ip-policies.js +5 -6
- package/core.d.ts +1 -2
- package/core.js +5 -6
- package/csp-origins.d.ts +42 -85
- package/csp-origins.js +3 -4
- package/csrf-token.d.ts +6 -11
- package/csrf-token.js +3 -4
- package/data-alerts.d.ts +152 -325
- package/data-alerts.js +3 -4
- package/data-assets.d.ts +16 -31
- package/data-assets.js +3 -4
- package/data-connections.d.ts +123 -257
- package/data-connections.js +3 -4
- package/data-credentials.d.ts +36 -76
- package/data-credentials.js +3 -4
- package/data-files.d.ts +60 -121
- package/data-files.js +3 -4
- package/data-governance/data-products.d.ts +429 -0
- package/data-governance/data-products.js +212 -0
- package/data-governance.d.ts +13 -0
- package/data-governance.js +12 -0
- package/data-qualities.d.ts +11 -25
- package/data-qualities.js +3 -4
- package/data-sets.d.ts +28 -57
- package/data-sets.js +3 -4
- package/data-sources.d.ts +45 -97
- package/data-sources.js +3 -4
- package/data-stores.d.ts +53 -107
- package/data-stores.js +3 -4
- package/dcaas.d.ts +32 -67
- package/dcaas.js +3 -4
- package/di-projects.d.ts +111 -136
- package/di-projects.js +25 -4
- package/direct-access-agents.d.ts +29 -63
- package/direct-access-agents.js +3 -4
- package/encryption.d.ts +28 -59
- package/encryption.js +3 -4
- package/extensions.d.ts +35 -73
- package/extensions.js +3 -4
- package/global-types.d.ts +139 -1
- package/glossaries.d.ts +75 -158
- package/glossaries.js +3 -4
- package/groups.d.ts +58 -125
- package/groups.js +3 -4
- package/identity-providers.d.ts +148 -324
- package/identity-providers.js +3 -4
- package/index.d.ts +18 -4
- package/index.js +64 -19
- package/interceptors.d.ts +2 -3
- package/interceptors.js +104 -2
- package/invoke-fetch-types.d.ts +97 -1
- package/items.d.ts +85 -181
- package/items.js +3 -4
- package/knowledgebases.d.ts +137 -270
- package/knowledgebases.js +3 -4
- package/licenses.d.ts +71 -153
- package/licenses.js +3 -4
- package/lineage-graphs.d.ts +39 -85
- package/lineage-graphs.js +3 -4
- package/ml.d.ts +290 -621
- package/ml.js +3 -4
- package/notes.d.ts +9 -18
- package/notes.js +3 -4
- package/notifications.d.ts +14 -30
- package/notifications.js +3 -4
- package/oauth-clients.d.ts +98 -159
- package/oauth-clients.js +4 -5
- package/oauth-tokens.d.ts +16 -33
- package/oauth-tokens.js +3 -4
- package/package.json +6 -3
- package/qix.d.ts +46 -2
- package/qix.js +2 -3
- package/questions.d.ts +53 -110
- package/questions.js +3 -4
- package/quotas.d.ts +13 -26
- package/quotas.js +3 -4
- package/reload-tasks.d.ts +23 -46
- package/reload-tasks.js +3 -4
- package/reloads.d.ts +26 -52
- package/reloads.js +3 -4
- package/report-templates.d.ts +30 -63
- package/report-templates.js +3 -4
- package/reports.d.ts +111 -238
- package/reports.js +3 -4
- package/roles.d.ts +36 -77
- package/roles.js +3 -4
- package/sharing-tasks.d.ts +201 -427
- package/sharing-tasks.js +3 -4
- package/spaces.d.ts +71 -157
- package/spaces.js +3 -4
- package/tasks.d.ts +76 -164
- package/tasks.js +3 -4
- package/temp-contents.d.ts +17 -35
- package/temp-contents.js +3 -4
- package/tenant-settings.d.ts +298 -0
- package/tenant-settings.js +107 -0
- package/tenants.d.ts +31 -67
- package/tenants.js +3 -4
- package/themes.d.ts +27 -55
- package/themes.js +3 -4
- package/transports.d.ts +46 -106
- package/transports.js +3 -4
- package/ui-config.d.ts +8 -17
- package/ui-config.js +3 -4
- package/users.d.ts +80 -170
- package/users.js +3 -4
- package/web-integrations.d.ts +38 -83
- package/web-integrations.js +3 -4
- package/web-notifications.d.ts +14 -29
- package/web-notifications.js +3 -4
- package/webhooks.d.ts +77 -162
- package/webhooks.js +3 -4
- package/chunks/auth-XusKk8IA.js +0 -32
- package/chunks/auth-types-YrlH_R9f.d.ts +0 -416
- package/chunks/auth-types-h43TVDpB.js +0 -24
- package/chunks/global-types-CEVAJebk.js +0 -1
- /package/chunks/{dist-n3iOVn1W.js → dist-DR758NU5.js} +0 -0
- /package/chunks/{invoke-fetch-C1Z0RJYU.d.ts → invoke-fetch-DFc3yzaj.d.ts} +0 -0
- /package/chunks/{utils-vv-xFm06.js → utils-jkpLuYZR.js} +0 -0
- /package/chunks/{websocket-errors-CRTDTtBL.js → websocket-errors-C5U1tba-.js} +0 -0
package/assistants.d.ts
CHANGED
|
@@ -1,48 +1,28 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import "./chunks/invoke-fetch-
|
|
1
|
+
import { ApiCallOptions } from "./invoke-fetch-types.js";
|
|
2
|
+
import "./chunks/invoke-fetch-DFc3yzaj.js";
|
|
3
3
|
|
|
4
4
|
//#region src/public/rest/assistants.d.ts
|
|
5
5
|
type Assistant = {
|
|
6
|
-
/**
|
|
7
|
-
readonly
|
|
8
|
-
/**
|
|
9
|
-
|
|
10
|
-
/**
|
|
11
|
-
|
|
12
|
-
/**
|
|
13
|
-
|
|
14
|
-
/**
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
description: string;
|
|
18
|
-
/** Indicates if the assistant has an avatar. */
|
|
19
|
-
hasAvatar?: boolean;
|
|
20
|
-
/** Unique identifier of the assistant. */
|
|
21
|
-
id: string;
|
|
22
|
-
/** List of knowledgebases the assistant is using. */
|
|
23
|
-
knowledgeBases: string[];
|
|
24
|
-
/** The name of the assistant. */
|
|
25
|
-
name: string;
|
|
26
|
-
/** List of starter IDs in the order they will be sorted. */
|
|
27
|
-
orderedStarterIds?: string[];
|
|
28
|
-
/** Unique identifier of the assistant owner. */
|
|
29
|
-
ownerId: string;
|
|
30
|
-
/** Unique identifier of the space containing the assistant. */
|
|
6
|
+
/** Datetime when the assistant was created. */readonly createdAt: string; /** Unique identifier of the user who created the assistant. */
|
|
7
|
+
readonly createdBy: string; /** freeform JSON to allow custom customization options. */
|
|
8
|
+
customProperties: unknown; /** Default prompt type for the assistant. */
|
|
9
|
+
defaultPromptType?: "thread" | "oneshot"; /** The description of the assistant. */
|
|
10
|
+
description: string; /** Indicates if the assistant has an avatar. */
|
|
11
|
+
hasAvatar?: boolean; /** Unique identifier of the assistant. */
|
|
12
|
+
id: string; /** List of knowledgebases the assistant is using. */
|
|
13
|
+
knowledgeBases: string[]; /** The name of the assistant. */
|
|
14
|
+
name: string; /** List of starter IDs in the order they will be sorted. */
|
|
15
|
+
orderedStarterIds?: string[]; /** Unique identifier of the assistant owner. */
|
|
16
|
+
ownerId: string; /** Unique identifier of the space containing the assistant. */
|
|
31
17
|
spaceId: string;
|
|
32
18
|
/** @deprecated
|
|
33
19
|
* System prompt setting up conversation context. */
|
|
34
|
-
systemMessage?: string;
|
|
35
|
-
/**
|
|
36
|
-
|
|
37
|
-
/**
|
|
38
|
-
|
|
39
|
-
/**
|
|
40
|
-
title?: string;
|
|
41
|
-
/** Datetime when the assistant was updated. */
|
|
42
|
-
readonly updatedAt: string;
|
|
43
|
-
/** Unique identifier of the user who last updated the assistant. */
|
|
44
|
-
readonly updatedBy: string;
|
|
45
|
-
/** Initial message in the chat conversation. */
|
|
20
|
+
systemMessage?: string; /** The list of tags associated with the assistant. */
|
|
21
|
+
tags: string[]; /** Unique identifier of the assistant tenant. */
|
|
22
|
+
tenantId: string; /** The title of the assistant. */
|
|
23
|
+
title?: string; /** Datetime when the assistant was updated. */
|
|
24
|
+
readonly updatedAt: string; /** Unique identifier of the user who last updated the assistant. */
|
|
25
|
+
readonly updatedBy: string; /** Initial message in the chat conversation. */
|
|
46
26
|
welcomeMessage: string;
|
|
47
27
|
};
|
|
48
28
|
/**
|
|
@@ -58,50 +38,32 @@ type ChunksRefs = {
|
|
|
58
38
|
chunkIds: string[];
|
|
59
39
|
};
|
|
60
40
|
type Feedback = {
|
|
61
|
-
/** Optional comment for feedback. */
|
|
62
|
-
|
|
63
|
-
/**
|
|
64
|
-
|
|
65
|
-
/**
|
|
66
|
-
|
|
67
|
-
/** Feedback review status. */
|
|
68
|
-
reviewStatus: string;
|
|
69
|
-
/** Datetime when the feedback was reviewed. */
|
|
70
|
-
reviewedAt?: string;
|
|
71
|
-
/** Unique feedback reviewer identifier. */
|
|
72
|
-
reviewerId: string;
|
|
73
|
-
/** Integer representation of feedback given (-1 = negative, 1 = positive). */
|
|
41
|
+
/** Optional comment for feedback. */comment: string; /** Unique feedback identifier. */
|
|
42
|
+
id: string; /** Reason for feedback. */
|
|
43
|
+
reason: string; /** Feedback review status. */
|
|
44
|
+
reviewStatus: string; /** Datetime when the feedback was reviewed. */
|
|
45
|
+
reviewedAt?: string; /** Unique feedback reviewer identifier. */
|
|
46
|
+
reviewerId: string; /** Integer representation of feedback given (-1 = negative, 1 = positive). */
|
|
74
47
|
vote: number;
|
|
75
48
|
};
|
|
76
49
|
type Interaction = {
|
|
77
|
-
/** Datetime when the interaction was created. */
|
|
78
|
-
readonly createdAt: string;
|
|
50
|
+
/** Datetime when the interaction was created. */readonly createdAt: string;
|
|
79
51
|
feedback?: Feedback;
|
|
80
|
-
id: string;
|
|
81
|
-
/**
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
/**
|
|
86
|
-
|
|
87
|
-
/** Interaction response content. */
|
|
88
|
-
response: string;
|
|
89
|
-
/** List of sources used to generate AI messages (interactions). */
|
|
90
|
-
sources: MessageSource[];
|
|
91
|
-
/** ID of the thread to which the interaction belongs. */
|
|
92
|
-
threadId: string;
|
|
93
|
-
/** Datetime when the interaction was updated. */
|
|
52
|
+
id: string; /** Unique identifier of user which created the interaction. */
|
|
53
|
+
ownerId: string; /** Indicator the system marked request as suspicious. */
|
|
54
|
+
rejected?: boolean; /** Interaction request content. */
|
|
55
|
+
request: string; /** Interaction response content. */
|
|
56
|
+
response: string; /** List of sources used to generate AI messages (interactions). */
|
|
57
|
+
sources: MessageSource[]; /** ID of the thread to which the interaction belongs. */
|
|
58
|
+
threadId: string; /** Datetime when the interaction was updated. */
|
|
94
59
|
readonly updatedAt: string;
|
|
95
60
|
};
|
|
96
61
|
/**
|
|
97
62
|
* A JSON Patch document as defined in http://tools.ietf.org/html/rfc6902.
|
|
98
63
|
*/
|
|
99
64
|
type JSONPatch = {
|
|
100
|
-
/** The operation to be performed. */
|
|
101
|
-
|
|
102
|
-
/** A JSON Pointer. */
|
|
103
|
-
path: string;
|
|
104
|
-
/** The value to be used for this operation. */
|
|
65
|
+
/** The operation to be performed. */op: "replace" | "add"; /** A JSON Pointer. */
|
|
66
|
+
path: string; /** The value to be used for this operation. */
|
|
105
67
|
value: string | number | boolean;
|
|
106
68
|
};
|
|
107
69
|
/**
|
|
@@ -140,87 +102,54 @@ type JSONPatch = {
|
|
|
140
102
|
*/
|
|
141
103
|
type JSONPatchArray = JSONPatch[];
|
|
142
104
|
type Message = {
|
|
143
|
-
/** Message content. */
|
|
144
|
-
content: string;
|
|
145
|
-
/** Datetime when the interaction was created. */
|
|
105
|
+
/** Message content. */content: string; /** Datetime when the interaction was created. */
|
|
146
106
|
readonly createdAt: string;
|
|
147
|
-
id: string;
|
|
148
|
-
/**
|
|
149
|
-
role: string;
|
|
150
|
-
/** List of sources used to generate AI messages (interactions). */
|
|
107
|
+
id: string; /** human or ai role. */
|
|
108
|
+
role: string; /** List of sources used to generate AI messages (interactions). */
|
|
151
109
|
sources: MessageSource[];
|
|
152
110
|
};
|
|
153
111
|
type MessageSource = {
|
|
154
|
-
/** List of Chunks used for "AI" generated messages. */
|
|
155
|
-
|
|
156
|
-
/** Reference to
|
|
157
|
-
|
|
158
|
-
/**
|
|
159
|
-
documentId: string;
|
|
160
|
-
/** Reference to KnowledgeBase used for "AI" generated messages. */
|
|
161
|
-
knowledgebaseId: string;
|
|
162
|
-
/** Datetime when the knowledgebase was last indexed. */
|
|
163
|
-
lastIndexedAt?: string;
|
|
164
|
-
/** Path to the document used. */
|
|
112
|
+
/** List of Chunks used for "AI" generated messages. */chunks: MessageSourceChunk[]; /** Reference to DataSource used for "AI" generated messages. */
|
|
113
|
+
datasourceId: string; /** Reference to Document used for "AI" generated messages. */
|
|
114
|
+
documentId: string; /** Reference to KnowledgeBase used for "AI" generated messages. */
|
|
115
|
+
knowledgebaseId: string; /** Datetime when the knowledgebase was last indexed. */
|
|
116
|
+
lastIndexedAt?: string; /** Path to the document used. */
|
|
165
117
|
source: string;
|
|
166
118
|
};
|
|
167
119
|
type MessageSourceChunk = {
|
|
168
|
-
/** Chunk unique identifier for "AI" generated message source. */
|
|
169
|
-
chunkId: string;
|
|
170
|
-
/** Chunk text for "AI" generated message source. */
|
|
120
|
+
/** Chunk unique identifier for "AI" generated message source. */chunkId: string; /** Chunk text for "AI" generated message source. */
|
|
171
121
|
text?: string;
|
|
172
122
|
};
|
|
173
123
|
type Starter = {
|
|
174
|
-
/** Optional context collected from curated meant to be leveraged by LLM-based question recommendation system. */
|
|
175
|
-
|
|
176
|
-
/**
|
|
177
|
-
|
|
178
|
-
/** List of followups. */
|
|
179
|
-
followups?: Followup[];
|
|
180
|
-
/** Unique identifier of the starter. */
|
|
181
|
-
id: string;
|
|
182
|
-
/** Starter sample question. */
|
|
124
|
+
/** Optional context collected from curated meant to be leveraged by LLM-based question recommendation system. */additionalContext: string; /** Datetime when the starter was created. */
|
|
125
|
+
readonly createdAt: string; /** List of followups. */
|
|
126
|
+
followups?: Followup[]; /** Unique identifier of the starter. */
|
|
127
|
+
id: string; /** Starter sample question. */
|
|
183
128
|
question: string;
|
|
184
|
-
recommendedAnswer: RecommendedAnswer;
|
|
185
|
-
/** Datetime when the starter was updated. */
|
|
129
|
+
recommendedAnswer: RecommendedAnswer; /** Datetime when the starter was updated. */
|
|
186
130
|
readonly updatedAt: string;
|
|
187
131
|
};
|
|
188
132
|
type Thread = {
|
|
189
|
-
/** Datetime when the thread was created. */
|
|
190
|
-
readonly
|
|
191
|
-
/**
|
|
192
|
-
|
|
193
|
-
/**
|
|
194
|
-
favorite: boolean;
|
|
195
|
-
/** If feedback was provided for a thread interaction. */
|
|
196
|
-
hasFeedback: boolean;
|
|
197
|
-
/** Unique identifier of the thread. */
|
|
198
|
-
id: string;
|
|
199
|
-
/** The name of the thread. */
|
|
133
|
+
/** Datetime when the thread was created. */readonly createdAt: string; /** Datetime when the thread was deleted. */
|
|
134
|
+
readonly deletedAt?: string; /** If thread is marked as favorite. */
|
|
135
|
+
favorite: boolean; /** If feedback was provided for a thread interaction. */
|
|
136
|
+
hasFeedback: boolean; /** Unique identifier of the thread. */
|
|
137
|
+
id: string; /** The name of the thread. */
|
|
200
138
|
name: string;
|
|
201
139
|
ownerId: string;
|
|
202
|
-
summaryStats: FeedbackSummary;
|
|
203
|
-
/** Datetime when the thread was updated. */
|
|
140
|
+
summaryStats: FeedbackSummary; /** Datetime when the thread was updated. */
|
|
204
141
|
readonly updatedAt: string;
|
|
205
142
|
};
|
|
206
143
|
type ThreadWithMessages = {
|
|
207
|
-
/** Datetime when the thread was created. */
|
|
208
|
-
readonly
|
|
209
|
-
/**
|
|
210
|
-
|
|
211
|
-
/** If thread is marked as favorite. */
|
|
212
|
-
favorite: boolean;
|
|
213
|
-
/** If feedback was provided for a thread interaction. */
|
|
214
|
-
hasFeedback: boolean;
|
|
215
|
-
/** Unique identifier of the thread. */
|
|
144
|
+
/** Datetime when the thread was created. */readonly createdAt: string; /** Datetime when the thread was deleted. */
|
|
145
|
+
readonly deletedAt?: string; /** If thread is marked as favorite. */
|
|
146
|
+
favorite: boolean; /** If feedback was provided for a thread interaction. */
|
|
147
|
+
hasFeedback: boolean; /** Unique identifier of the thread. */
|
|
216
148
|
id: string;
|
|
217
|
-
messages: Message[];
|
|
218
|
-
/**
|
|
219
|
-
name: string;
|
|
220
|
-
/** Unique identifier of the thread owner. */
|
|
149
|
+
messages: Message[]; /** The name of the thread. */
|
|
150
|
+
name: string; /** Unique identifier of the thread owner. */
|
|
221
151
|
ownerId: string;
|
|
222
|
-
summaryStats: FeedbackSummary;
|
|
223
|
-
/** Datetime when the thread was updated. */
|
|
152
|
+
summaryStats: FeedbackSummary; /** Datetime when the thread was updated. */
|
|
224
153
|
readonly updatedAt: string;
|
|
225
154
|
};
|
|
226
155
|
type AssistantsResult = {
|
|
@@ -229,109 +158,70 @@ type AssistantsResult = {
|
|
|
229
158
|
meta?: ResultMeta;
|
|
230
159
|
};
|
|
231
160
|
type Chunk = {
|
|
232
|
-
/** Metadata about the chunk */
|
|
233
|
-
|
|
234
|
-
/**
|
|
235
|
-
|
|
236
|
-
/** Similarity score from embedding match */
|
|
237
|
-
semanticScore?: number;
|
|
238
|
-
/** Text content of the chunk */
|
|
239
|
-
text: string;
|
|
240
|
-
/** Score from keyword search */
|
|
161
|
+
/** Metadata about the chunk */chunkMeta: KbChunkMeta; /** search method for the chunk, e.g. `semantic search`, `keyword search` or `semantic and keyword search` */
|
|
162
|
+
searchSource?: string; /** Similarity score from embedding match */
|
|
163
|
+
semanticScore?: number; /** Text content of the chunk */
|
|
164
|
+
text: string; /** Score from keyword search */
|
|
241
165
|
tfidfScore?: number;
|
|
242
166
|
};
|
|
243
167
|
type CreateAssistant = {
|
|
244
|
-
/** freeform JSON to allow custom customization options. */
|
|
245
|
-
|
|
246
|
-
/**
|
|
247
|
-
|
|
248
|
-
/**
|
|
249
|
-
|
|
250
|
-
/** List of knowledgebases the assistant is using. */
|
|
251
|
-
knowledgeBases: string[];
|
|
252
|
-
/** The name of the assistant. */
|
|
253
|
-
name: string;
|
|
254
|
-
/** List of starter IDs in the order they will be sorted. */
|
|
255
|
-
orderedStarterIds?: string[];
|
|
256
|
-
/** Unique identifier of the space to contain the assistant. */
|
|
168
|
+
/** freeform JSON to allow custom customization options. */customProperties: unknown; /** Default prompt type for the assistant. */
|
|
169
|
+
defaultPromptType?: "thread" | "oneshot"; /** The description of the assistant. */
|
|
170
|
+
description: string; /** List of knowledgebases the assistant is using. */
|
|
171
|
+
knowledgeBases: string[]; /** The name of the assistant. */
|
|
172
|
+
name: string; /** List of starter IDs in the order they will be sorted. */
|
|
173
|
+
orderedStarterIds?: string[]; /** Unique identifier of the space to contain the assistant. */
|
|
257
174
|
spaceId: string;
|
|
258
175
|
/** @deprecated
|
|
259
176
|
* System prompt setting up conversation context. */
|
|
260
|
-
systemMessage?: string;
|
|
261
|
-
/** The
|
|
262
|
-
|
|
263
|
-
/** The title of the assistant. */
|
|
264
|
-
title: string;
|
|
265
|
-
/** Initial message in the chat conversation. */
|
|
177
|
+
systemMessage?: string; /** The list of tags for the assistant. */
|
|
178
|
+
tags: string[]; /** The title of the assistant. */
|
|
179
|
+
title: string; /** Initial message in the chat conversation. */
|
|
266
180
|
welcomeMessage: string;
|
|
267
181
|
};
|
|
268
182
|
type CreateAssistantWithAvatar = {
|
|
269
|
-
/** user uploaded avatar, filetype must be png */
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
/**
|
|
274
|
-
|
|
275
|
-
/** The description of the assistant. */
|
|
276
|
-
description: string;
|
|
277
|
-
/** List of knowledgebases the assistant is using. */
|
|
278
|
-
knowledgeBases: string[];
|
|
279
|
-
/** The name of the assistant. */
|
|
280
|
-
name: string;
|
|
281
|
-
/** Unique identifier of the space to contain the assistant. */
|
|
183
|
+
/** user uploaded avatar, filetype must be png */avatar?: string; /** freeform JSON to allow custom customization options. */
|
|
184
|
+
customProperties: unknown; /** Default prompt type for the assistant. */
|
|
185
|
+
defaultPromptType?: "thread" | "oneshot"; /** The description of the assistant. */
|
|
186
|
+
description: string; /** List of knowledgebases the assistant is using. */
|
|
187
|
+
knowledgeBases: string[]; /** The name of the assistant. */
|
|
188
|
+
name: string; /** Unique identifier of the space to contain the assistant. */
|
|
282
189
|
spaceId: string;
|
|
283
190
|
/** @deprecated
|
|
284
191
|
* System prompt setting up conversation context. */
|
|
285
|
-
systemMessage?: string;
|
|
286
|
-
/** The
|
|
287
|
-
|
|
288
|
-
/** The title of the assistant. */
|
|
289
|
-
title: string;
|
|
290
|
-
/** Initial message in the chat conversation. */
|
|
192
|
+
systemMessage?: string; /** The list of tags for the assistant. */
|
|
193
|
+
tags: string[]; /** The title of the assistant. */
|
|
194
|
+
title: string; /** Initial message in the chat conversation. */
|
|
291
195
|
welcomeMessage: string;
|
|
292
196
|
};
|
|
293
197
|
type CreateFeedback = {
|
|
294
|
-
/** Optional comment for feedback. */
|
|
295
|
-
|
|
296
|
-
/** Reason for feedback. */
|
|
297
|
-
reason: string;
|
|
298
|
-
/** Integer representation of feedback given (-1 = negative, 1 = positive). */
|
|
198
|
+
/** Optional comment for feedback. */comment?: string; /** Reason for feedback. */
|
|
199
|
+
reason: string; /** Integer representation of feedback given (-1 = negative, 1 = positive). */
|
|
299
200
|
vote: number;
|
|
300
201
|
};
|
|
301
202
|
type CreateInteraction = {
|
|
302
|
-
/** Indicator the system marked request as suspicious. */
|
|
303
|
-
rejected?: boolean;
|
|
203
|
+
/** Indicator the system marked request as suspicious. */rejected?: boolean;
|
|
304
204
|
/** Rejection reason for a question:
|
|
305
205
|
* * 1 - PROMPT_INJECTION
|
|
306
206
|
* * 2 - OUT_OF_CONTEXT
|
|
307
207
|
* * 3 - TOO_COMPLEX */
|
|
308
|
-
rejectionReason?: RejectionReason;
|
|
309
|
-
/** Interaction
|
|
310
|
-
|
|
311
|
-
/** Interaction response content. */
|
|
312
|
-
response: string;
|
|
313
|
-
/** List of sources used to generate AI messages (interactions). */
|
|
208
|
+
rejectionReason?: RejectionReason; /** Interaction request content. */
|
|
209
|
+
request: string; /** Interaction response content. */
|
|
210
|
+
response: string; /** List of sources used to generate AI messages (interactions). */
|
|
314
211
|
sources: MessageSource[];
|
|
315
212
|
};
|
|
316
213
|
type CreateReview = {
|
|
317
|
-
/** Review status. */
|
|
318
|
-
reviewStatus: string;
|
|
214
|
+
/** Review status. */reviewStatus: string;
|
|
319
215
|
};
|
|
320
216
|
type CreateStarter = {
|
|
321
|
-
/** Optional context collected from curated meant to be leveraged by LLM-based question recommendation system. */
|
|
322
|
-
|
|
323
|
-
/** List of followups. */
|
|
324
|
-
followups?: Followup[];
|
|
325
|
-
/** Starter sample question. */
|
|
217
|
+
/** Optional context collected from curated meant to be leveraged by LLM-based question recommendation system. */additionalContext?: string; /** List of followups. */
|
|
218
|
+
followups?: Followup[]; /** Starter sample question. */
|
|
326
219
|
question: string;
|
|
327
220
|
recommendedAnswer?: RecommendedAnswer;
|
|
328
221
|
};
|
|
329
222
|
type CreateThread = {
|
|
330
|
-
/** Datetime when the thread was created. */
|
|
331
|
-
|
|
332
|
-
/** The name of the thread. */
|
|
333
|
-
name: string;
|
|
334
|
-
/** Datetime when the thread was updated. */
|
|
223
|
+
/** Datetime when the thread was created. */readonly createdAt?: string; /** The name of the thread. */
|
|
224
|
+
name: string; /** Datetime when the thread was updated. */
|
|
335
225
|
readonly updatedAt?: string;
|
|
336
226
|
};
|
|
337
227
|
type ErrorResponse = {
|
|
@@ -339,11 +229,6 @@ type ErrorResponse = {
|
|
|
339
229
|
traceId?: string;
|
|
340
230
|
};
|
|
341
231
|
type ErrorResponseCode = {
|
|
342
|
-
code?: string;
|
|
343
|
-
detail?: string;
|
|
344
|
-
title?: string;
|
|
345
|
-
};
|
|
346
|
-
type ErrorResponseCodeCopy = {
|
|
347
232
|
/** Custom error codes
|
|
348
233
|
* * AE-1 - Internal processing error
|
|
349
234
|
* * AE-2 - Incorrect request
|
|
@@ -356,6 +241,11 @@ type ErrorResponseCodeCopy = {
|
|
|
356
241
|
detail?: string;
|
|
357
242
|
title?: string;
|
|
358
243
|
};
|
|
244
|
+
type ErrorResponseCodeCopy = {
|
|
245
|
+
code?: string;
|
|
246
|
+
detail?: string;
|
|
247
|
+
title?: string;
|
|
248
|
+
};
|
|
359
249
|
type ErrorResponseCopy = {
|
|
360
250
|
errors?: ErrorResponseCodeCopy[];
|
|
361
251
|
traceId?: string;
|
|
@@ -373,33 +263,20 @@ type ErrorResponseCopy = {
|
|
|
373
263
|
*/
|
|
374
264
|
type FeedbackPatchArray = JSONPatch[];
|
|
375
265
|
type FeedbackSummary = {
|
|
376
|
-
/** Amount of dislikes for a thread or an assistant. */
|
|
377
|
-
|
|
378
|
-
/** Count of answers which users marked as "
|
|
379
|
-
|
|
380
|
-
/**
|
|
381
|
-
|
|
382
|
-
/**
|
|
383
|
-
|
|
384
|
-
/**
|
|
385
|
-
likes: number;
|
|
386
|
-
/** Count of answers which users disliked and gave "other" as reason. */
|
|
387
|
-
other?: number;
|
|
388
|
-
/** Count of answers which users marked as "repetitive". */
|
|
389
|
-
repetitive?: number;
|
|
390
|
-
/** Amount of reviews for a thread or an assistant. */
|
|
391
|
-
reviews: number;
|
|
392
|
-
/** Count of questions for which the assistant provided no answer. */
|
|
393
|
-
unanswered?: number;
|
|
394
|
-
/** Count of answers which users marked as "unhelpful". */
|
|
266
|
+
/** Amount of dislikes for a thread or an assistant. */dislikes: number; /** Count of answers which users marked as "inaccurate". */
|
|
267
|
+
inaccurate?: number; /** Amount of interactions for a thread or an assistant. */
|
|
268
|
+
interactions: number; /** Count of answers which users marked as "irrelevant". */
|
|
269
|
+
irrelevant?: number; /** Amount of likes for a thread or an assistant. */
|
|
270
|
+
likes: number; /** Count of answers which users disliked and gave "other" as reason. */
|
|
271
|
+
other?: number; /** Count of answers which users marked as "repetitive". */
|
|
272
|
+
repetitive?: number; /** Amount of reviews for a thread or an assistant. */
|
|
273
|
+
reviews: number; /** Count of questions for which the assistant provided no answer. */
|
|
274
|
+
unanswered?: number; /** Count of answers which users marked as "unhelpful". */
|
|
395
275
|
unhelpful?: number;
|
|
396
276
|
};
|
|
397
277
|
type Followup = {
|
|
398
|
-
/** Optional context collected from curated meant to be leveraged by LLM-based question recommendation system. */
|
|
399
|
-
|
|
400
|
-
/** Unique identifier of the Followup. */
|
|
401
|
-
id: string;
|
|
402
|
-
/** Starter sample question. */
|
|
278
|
+
/** Optional context collected from curated meant to be leveraged by LLM-based question recommendation system. */additionalContext: string; /** Unique identifier of the Followup. */
|
|
279
|
+
id: string; /** Starter sample question. */
|
|
403
280
|
question: string;
|
|
404
281
|
recommendedAnswer: RecommendedAnswer;
|
|
405
282
|
};
|
|
@@ -412,15 +289,10 @@ type InteractionsResult = {
|
|
|
412
289
|
* Metadata about the chunk
|
|
413
290
|
*/
|
|
414
291
|
type KbChunkMeta = {
|
|
415
|
-
/** chunkId */
|
|
416
|
-
|
|
417
|
-
/**
|
|
418
|
-
|
|
419
|
-
/** documentId of chunk */
|
|
420
|
-
documentId: string;
|
|
421
|
-
/** knowledgeBaseId of chunk */
|
|
422
|
-
knowledgeBaseId: string;
|
|
423
|
-
/** source of chunk */
|
|
292
|
+
/** chunkId */chunkId: string; /** datasourceId of chunk */
|
|
293
|
+
datasourceId: string; /** documentId of chunk */
|
|
294
|
+
documentId: string; /** knowledgeBaseId of chunk */
|
|
295
|
+
knowledgeBaseId: string; /** source of chunk */
|
|
424
296
|
source: string;
|
|
425
297
|
};
|
|
426
298
|
type PageLink = {
|
|
@@ -433,32 +305,22 @@ type PageLinks = {
|
|
|
433
305
|
};
|
|
434
306
|
type PromptInput = {
|
|
435
307
|
input?: {
|
|
436
|
-
/** Returns text from chunks in sources output. Default value is false. */
|
|
437
|
-
|
|
438
|
-
/** Input prompt string for the Assistant to respond to. */
|
|
439
|
-
prompt?: string;
|
|
440
|
-
/** Sets the prompt type to thread. */
|
|
308
|
+
/** Returns text from chunks in sources output. Default value is false. */includeText?: boolean; /** Input prompt string for the Assistant to respond to. */
|
|
309
|
+
prompt?: string; /** Sets the prompt type to thread. */
|
|
441
310
|
promptType?: "thread";
|
|
442
311
|
};
|
|
443
312
|
};
|
|
444
313
|
type PromptOutput = {
|
|
445
|
-
/** Assistant's response to the prompt */
|
|
446
|
-
output?: string;
|
|
447
|
-
/** List of sources used to generate AI messages */
|
|
314
|
+
/** Assistant's response to the prompt */output?: string; /** List of sources used to generate AI messages */
|
|
448
315
|
sources?: Source[];
|
|
449
316
|
};
|
|
450
317
|
type PromptOutputInvoke = {
|
|
451
|
-
/** Assistant's response to the prompt */
|
|
452
|
-
|
|
453
|
-
/** Question asked by the user for assistant to answer */
|
|
454
|
-
question?: string;
|
|
455
|
-
/** List of sources used to generate AI messages */
|
|
318
|
+
/** Assistant's response to the prompt */output?: string; /** Question asked by the user for assistant to answer */
|
|
319
|
+
question?: string; /** List of sources used to generate AI messages */
|
|
456
320
|
sources?: Source[];
|
|
457
321
|
};
|
|
458
322
|
type RecommendedAnswer = {
|
|
459
|
-
/** Starter answer content. */
|
|
460
|
-
content: string;
|
|
461
|
-
/** Answer type of content. */
|
|
323
|
+
/** Starter answer content. */content: string; /** Answer type of content. */
|
|
462
324
|
contentType: string;
|
|
463
325
|
};
|
|
464
326
|
/**
|
|
@@ -474,27 +336,18 @@ type ResultMeta = {
|
|
|
474
336
|
countTotal?: number;
|
|
475
337
|
};
|
|
476
338
|
type SearchRequest = {
|
|
477
|
-
/** Query text or question to search. */
|
|
478
|
-
|
|
479
|
-
/** Search mode to use. Allowed values: `SIMPLE` and `FULL`. Default: `SIMPLE`. */
|
|
480
|
-
searchMode?: "SIMPLE" | "FULL";
|
|
481
|
-
/** Number of chunks to return in results. */
|
|
339
|
+
/** Query text or question to search. */prompt: string; /** Search mode to use. Allowed values: `SIMPLE` and `FULL`. Default: `SIMPLE`. */
|
|
340
|
+
searchMode?: "SIMPLE" | "FULL"; /** Number of chunks to return in results. */
|
|
482
341
|
topN?: number;
|
|
483
342
|
};
|
|
484
343
|
type SearchResponse = {
|
|
485
|
-
/** Retrieved document chunks */
|
|
486
|
-
chunks: Chunk[];
|
|
344
|
+
/** Retrieved document chunks */chunks: Chunk[];
|
|
487
345
|
};
|
|
488
346
|
type Source = {
|
|
489
|
-
/** List of Chunks used for "AI" generated messages */
|
|
490
|
-
|
|
491
|
-
/** reference to
|
|
492
|
-
|
|
493
|
-
/** reference to Document used for "AI" generated messages */
|
|
494
|
-
documentId?: string;
|
|
495
|
-
/** reference to KnowledgeBase used for "AI" generated messages */
|
|
496
|
-
knowledgebaseId?: string;
|
|
497
|
-
/** path to the document used */
|
|
347
|
+
/** List of Chunks used for "AI" generated messages */chunks?: unknown[]; /** reference to DataSource used for "AI" generated messages */
|
|
348
|
+
datasourceId?: string; /** reference to Document used for "AI" generated messages */
|
|
349
|
+
documentId?: string; /** reference to KnowledgeBase used for "AI" generated messages */
|
|
350
|
+
knowledgebaseId?: string; /** path to the document used */
|
|
498
351
|
source?: string;
|
|
499
352
|
};
|
|
500
353
|
type SourcesPlaintext = {
|
|
@@ -531,16 +384,11 @@ type ThreadsResult = {
|
|
|
531
384
|
declare function getAssistants(query: {
|
|
532
385
|
/** @deprecated
|
|
533
386
|
* Optional parameter to request total count for query. */
|
|
534
|
-
countTotal?: boolean;
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
/** Optional
|
|
538
|
-
|
|
539
|
-
/** Optional parameter to request the previous page. */
|
|
540
|
-
prev?: string;
|
|
541
|
-
/** Optional resource field name to sort on, case insensitive, e.g. `name`. Can be prefixed with `-` to set descending order; defaults to ascending. */
|
|
542
|
-
sort?: "NAME" | "-NAME" | "DESCRIPTION" | "-DESCRIPTION" | "CREATED" | "-CREATED" | "UPDATED" | "-UPDATED";
|
|
543
|
-
/** Optional parameter to filter assistants by space ID. */
|
|
387
|
+
countTotal?: boolean; /** The number of assistants to get. */
|
|
388
|
+
limit?: number; /** Optional parameter to request the next page. */
|
|
389
|
+
next?: string; /** Optional parameter to request the previous page. */
|
|
390
|
+
prev?: string; /** Optional resource field name to sort on, case insensitive, e.g. `name`. Can be prefixed with `-` to set descending order; defaults to ascending. */
|
|
391
|
+
sort?: "NAME" | "-NAME" | "DESCRIPTION" | "-DESCRIPTION" | "CREATED" | "-CREATED" | "UPDATED" | "-UPDATED"; /** Optional parameter to filter assistants by space ID. */
|
|
544
392
|
spaceId?: string;
|
|
545
393
|
}, options?: ApiCallOptions): Promise<GetAssistantsHttpResponse>;
|
|
546
394
|
type GetAssistantsHttpResponse = {
|
|
@@ -551,7 +399,7 @@ type GetAssistantsHttpResponse = {
|
|
|
551
399
|
next?: (options?: ApiCallOptions) => Promise<GetAssistantsHttpResponse>;
|
|
552
400
|
};
|
|
553
401
|
type GetAssistantsHttpError = {
|
|
554
|
-
data:
|
|
402
|
+
data: ErrorResponseCopy;
|
|
555
403
|
headers: Headers;
|
|
556
404
|
status: 400 | 403;
|
|
557
405
|
};
|
|
@@ -568,7 +416,7 @@ type CreateAssistantHttpResponse = {
|
|
|
568
416
|
status: 201;
|
|
569
417
|
};
|
|
570
418
|
type CreateAssistantHttpError = {
|
|
571
|
-
data:
|
|
419
|
+
data: ErrorResponseCopy;
|
|
572
420
|
headers: Headers;
|
|
573
421
|
status: 400 | 403;
|
|
574
422
|
};
|
|
@@ -586,7 +434,7 @@ type SearchAssistantHttpResponse = {
|
|
|
586
434
|
status: 200;
|
|
587
435
|
};
|
|
588
436
|
type SearchAssistantHttpError = {
|
|
589
|
-
data:
|
|
437
|
+
data: ErrorResponse;
|
|
590
438
|
headers: Headers;
|
|
591
439
|
status: 400 | 403 | 404 | 405 | 500;
|
|
592
440
|
};
|
|
@@ -603,7 +451,7 @@ type GetAssistantFeedbackHttpResponse = {
|
|
|
603
451
|
status: 200;
|
|
604
452
|
};
|
|
605
453
|
type GetAssistantFeedbackHttpError = {
|
|
606
|
-
data:
|
|
454
|
+
data: ErrorResponseCopy;
|
|
607
455
|
headers: Headers;
|
|
608
456
|
status: 400 | 403 | 404;
|
|
609
457
|
};
|
|
@@ -621,7 +469,7 @@ type GetAssistantSourcesHttpResponse = {
|
|
|
621
469
|
status: 202;
|
|
622
470
|
};
|
|
623
471
|
type GetAssistantSourcesHttpError = {
|
|
624
|
-
data:
|
|
472
|
+
data: ErrorResponseCopy;
|
|
625
473
|
headers: Headers;
|
|
626
474
|
status: 400 | 403 | 404;
|
|
627
475
|
};
|
|
@@ -633,13 +481,9 @@ type GetAssistantSourcesHttpError = {
|
|
|
633
481
|
* @throws GetAssistantStartersHttpError
|
|
634
482
|
*/
|
|
635
483
|
declare function getAssistantStarters(assistantId: string, query: {
|
|
636
|
-
/** The number of starters to get. */
|
|
637
|
-
|
|
638
|
-
/** Optional
|
|
639
|
-
next?: string;
|
|
640
|
-
/** Optional parameter to request the previous page. */
|
|
641
|
-
prev?: string;
|
|
642
|
-
/** Optional resource field name to sort on, case insensitive, e.g. `name`. Can be prefixed with `-` to set descending order; defaults to ascending. */
|
|
484
|
+
/** The number of starters to get. */limit?: number; /** Optional parameter to request the next page. */
|
|
485
|
+
next?: string; /** Optional parameter to request the previous page. */
|
|
486
|
+
prev?: string; /** Optional resource field name to sort on, case insensitive, e.g. `name`. Can be prefixed with `-` to set descending order; defaults to ascending. */
|
|
643
487
|
sort?: "QUESTION" | "-QUESTION" | "CREATED" | "-CREATED" | "UPDATED" | "-UPDATED";
|
|
644
488
|
}, options?: ApiCallOptions): Promise<GetAssistantStartersHttpResponse>;
|
|
645
489
|
type GetAssistantStartersHttpResponse = {
|
|
@@ -650,7 +494,7 @@ type GetAssistantStartersHttpResponse = {
|
|
|
650
494
|
next?: (options?: ApiCallOptions) => Promise<GetAssistantStartersHttpResponse>;
|
|
651
495
|
};
|
|
652
496
|
type GetAssistantStartersHttpError = {
|
|
653
|
-
data:
|
|
497
|
+
data: ErrorResponseCopy;
|
|
654
498
|
headers: Headers;
|
|
655
499
|
status: 400 | 403 | 404;
|
|
656
500
|
};
|
|
@@ -668,7 +512,7 @@ type CreateAssistantStarterHttpResponse = {
|
|
|
668
512
|
status: 201;
|
|
669
513
|
};
|
|
670
514
|
type CreateAssistantStarterHttpError = {
|
|
671
|
-
data:
|
|
515
|
+
data: ErrorResponseCopy;
|
|
672
516
|
headers: Headers;
|
|
673
517
|
status: 400 | 403 | 404;
|
|
674
518
|
};
|
|
@@ -686,7 +530,7 @@ type DeleteAssistantStarterHttpResponse = {
|
|
|
686
530
|
status: 204;
|
|
687
531
|
};
|
|
688
532
|
type DeleteAssistantStarterHttpError = {
|
|
689
|
-
data:
|
|
533
|
+
data: ErrorResponseCopy;
|
|
690
534
|
headers: Headers;
|
|
691
535
|
status: 400 | 403 | 404;
|
|
692
536
|
};
|
|
@@ -704,7 +548,7 @@ type GetAssistantStarterHttpResponse = {
|
|
|
704
548
|
status: 200;
|
|
705
549
|
};
|
|
706
550
|
type GetAssistantStarterHttpError = {
|
|
707
|
-
data:
|
|
551
|
+
data: ErrorResponseCopy;
|
|
708
552
|
headers: Headers;
|
|
709
553
|
status: 400 | 403 | 404;
|
|
710
554
|
};
|
|
@@ -723,7 +567,7 @@ type UpdateAssistantStarterHttpResponse = {
|
|
|
723
567
|
status: 200;
|
|
724
568
|
};
|
|
725
569
|
type UpdateAssistantStarterHttpError = {
|
|
726
|
-
data:
|
|
570
|
+
data: ErrorResponseCopy;
|
|
727
571
|
headers: Headers;
|
|
728
572
|
status: 400 | 403 | 404;
|
|
729
573
|
};
|
|
@@ -742,7 +586,7 @@ type DeleteAssistantStarterFollowupHttpResponse = {
|
|
|
742
586
|
status: 204;
|
|
743
587
|
};
|
|
744
588
|
type DeleteAssistantStarterFollowupHttpError = {
|
|
745
|
-
data:
|
|
589
|
+
data: ErrorResponseCopy;
|
|
746
590
|
headers: Headers;
|
|
747
591
|
status: 400 | 403 | 404;
|
|
748
592
|
};
|
|
@@ -762,7 +606,7 @@ type UpdateAssistantStarterFollowupHttpResponse = {
|
|
|
762
606
|
status: 200;
|
|
763
607
|
};
|
|
764
608
|
type UpdateAssistantStarterFollowupHttpError = {
|
|
765
|
-
data:
|
|
609
|
+
data: ErrorResponseCopy;
|
|
766
610
|
headers: Headers;
|
|
767
611
|
status: 400 | 403 | 404;
|
|
768
612
|
};
|
|
@@ -774,15 +618,10 @@ type UpdateAssistantStarterFollowupHttpError = {
|
|
|
774
618
|
* @throws GetAssistantThreadsHttpError
|
|
775
619
|
*/
|
|
776
620
|
declare function getAssistantThreads(assistantId: string, query: {
|
|
777
|
-
/** Optional parameter to filter threads. */
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
/** Optional parameter to request the next page. */
|
|
782
|
-
next?: string;
|
|
783
|
-
/** Optional parameter to request the previous page. */
|
|
784
|
-
prev?: string;
|
|
785
|
-
/** Optional resource field name to sort on, case insensitive, e.g. `name`. Can be prefixed with `-` to set descending order; defaults to ascending. */
|
|
621
|
+
/** Optional parameter to filter threads. */filter?: string; /** The number of assistants to get. */
|
|
622
|
+
limit?: number; /** Optional parameter to request the next page. */
|
|
623
|
+
next?: string; /** Optional parameter to request the previous page. */
|
|
624
|
+
prev?: string; /** Optional resource field name to sort on, case insensitive, e.g. `name`. Can be prefixed with `-` to set descending order; defaults to ascending. */
|
|
786
625
|
sort?: "NAME" | "-NAME" | "CREATED" | "-CREATED" | "UPDATED" | "-UPDATED";
|
|
787
626
|
}, options?: ApiCallOptions): Promise<GetAssistantThreadsHttpResponse>;
|
|
788
627
|
type GetAssistantThreadsHttpResponse = {
|
|
@@ -793,7 +632,7 @@ type GetAssistantThreadsHttpResponse = {
|
|
|
793
632
|
next?: (options?: ApiCallOptions) => Promise<GetAssistantThreadsHttpResponse>;
|
|
794
633
|
};
|
|
795
634
|
type GetAssistantThreadsHttpError = {
|
|
796
|
-
data:
|
|
635
|
+
data: ErrorResponseCopy;
|
|
797
636
|
headers: Headers;
|
|
798
637
|
status: 400 | 403 | 404;
|
|
799
638
|
};
|
|
@@ -811,7 +650,7 @@ type CreateAssistantThreadHttpResponse = {
|
|
|
811
650
|
status: 201;
|
|
812
651
|
};
|
|
813
652
|
type CreateAssistantThreadHttpError = {
|
|
814
|
-
data:
|
|
653
|
+
data: ErrorResponseCopy;
|
|
815
654
|
headers: Headers;
|
|
816
655
|
status: 400 | 403 | 404;
|
|
817
656
|
};
|
|
@@ -830,7 +669,7 @@ type InvokeAssistantThreadHttpResponse = {
|
|
|
830
669
|
status: 200;
|
|
831
670
|
};
|
|
832
671
|
type InvokeAssistantThreadHttpError = {
|
|
833
|
-
data:
|
|
672
|
+
data: ErrorResponse;
|
|
834
673
|
headers: Headers;
|
|
835
674
|
status: 400 | 403 | 404 | 500;
|
|
836
675
|
};
|
|
@@ -849,7 +688,7 @@ type StreamAssistantThreadHttpResponse = {
|
|
|
849
688
|
status: 200;
|
|
850
689
|
};
|
|
851
690
|
type StreamAssistantThreadHttpError = {
|
|
852
|
-
data:
|
|
691
|
+
data: ErrorResponse;
|
|
853
692
|
headers: Headers;
|
|
854
693
|
status: 400 | 403 | 404 | 405 | 500;
|
|
855
694
|
};
|
|
@@ -862,13 +701,9 @@ type StreamAssistantThreadHttpError = {
|
|
|
862
701
|
* @throws GetAssistantThreadInteractionsHttpError
|
|
863
702
|
*/
|
|
864
703
|
declare function getAssistantThreadInteractions(assistantId: string, threadId: string, query: {
|
|
865
|
-
/** The number of feedback to get. */
|
|
866
|
-
|
|
867
|
-
/** Optional
|
|
868
|
-
next?: string;
|
|
869
|
-
/** Optional parameter to request the previous page. */
|
|
870
|
-
prev?: string;
|
|
871
|
-
/** Optional resource field name to sort on, case insensitive, e.g. `created`. Can be prefixed with `-` to set descending order; defaults to ascending. */
|
|
704
|
+
/** The number of feedback to get. */limit?: number; /** Optional parameter to request the next page. */
|
|
705
|
+
next?: string; /** Optional parameter to request the previous page. */
|
|
706
|
+
prev?: string; /** Optional resource field name to sort on, case insensitive, e.g. `created`. Can be prefixed with `-` to set descending order; defaults to ascending. */
|
|
872
707
|
sort?: "CREATED" | "-CREATED" | "UPDATED" | "-UPDATED";
|
|
873
708
|
}, options?: ApiCallOptions): Promise<GetAssistantThreadInteractionsHttpResponse>;
|
|
874
709
|
type GetAssistantThreadInteractionsHttpResponse = {
|
|
@@ -879,7 +714,7 @@ type GetAssistantThreadInteractionsHttpResponse = {
|
|
|
879
714
|
next?: (options?: ApiCallOptions) => Promise<GetAssistantThreadInteractionsHttpResponse>;
|
|
880
715
|
};
|
|
881
716
|
type GetAssistantThreadInteractionsHttpError = {
|
|
882
|
-
data:
|
|
717
|
+
data: ErrorResponseCopy;
|
|
883
718
|
headers: Headers;
|
|
884
719
|
status: 400 | 403 | 404;
|
|
885
720
|
};
|
|
@@ -898,7 +733,7 @@ type CreateAssistantThreadInteractionHttpResponse = {
|
|
|
898
733
|
status: 201;
|
|
899
734
|
};
|
|
900
735
|
type CreateAssistantThreadInteractionHttpError = {
|
|
901
|
-
data:
|
|
736
|
+
data: ErrorResponseCopy;
|
|
902
737
|
headers: Headers;
|
|
903
738
|
status: 400 | 403 | 404;
|
|
904
739
|
};
|
|
@@ -917,7 +752,7 @@ type DeleteAssistantThreadInteractionHttpResponse = {
|
|
|
917
752
|
status: 204;
|
|
918
753
|
};
|
|
919
754
|
type DeleteAssistantThreadInteractionHttpError = {
|
|
920
|
-
data:
|
|
755
|
+
data: ErrorResponseCopy;
|
|
921
756
|
headers: Headers;
|
|
922
757
|
status: 400 | 403 | 404;
|
|
923
758
|
};
|
|
@@ -936,7 +771,7 @@ type GetAssistantThreadInteractionHttpResponse = {
|
|
|
936
771
|
status: 200;
|
|
937
772
|
};
|
|
938
773
|
type GetAssistantThreadInteractionHttpError = {
|
|
939
|
-
data:
|
|
774
|
+
data: ErrorResponseCopy;
|
|
940
775
|
headers: Headers;
|
|
941
776
|
status: 400 | 403 | 404;
|
|
942
777
|
};
|
|
@@ -956,7 +791,7 @@ type CreateAssistantThreadInteractionFeedbackHttpResponse = {
|
|
|
956
791
|
status: 201;
|
|
957
792
|
};
|
|
958
793
|
type CreateAssistantThreadInteractionFeedbackHttpError = {
|
|
959
|
-
data:
|
|
794
|
+
data: ErrorResponseCopy;
|
|
960
795
|
headers: Headers;
|
|
961
796
|
status: 400 | 403 | 404;
|
|
962
797
|
};
|
|
@@ -977,7 +812,7 @@ type PatchAssistantThreadInteractionFeedbackHttpResponse = {
|
|
|
977
812
|
status: 204;
|
|
978
813
|
};
|
|
979
814
|
type PatchAssistantThreadInteractionFeedbackHttpError = {
|
|
980
|
-
data:
|
|
815
|
+
data: ErrorResponseCopy;
|
|
981
816
|
headers: Headers;
|
|
982
817
|
status: 400 | 403 | 404;
|
|
983
818
|
};
|
|
@@ -997,7 +832,7 @@ type CreateAssistantThreadInteractionReviewHttpResponse = {
|
|
|
997
832
|
status: 201;
|
|
998
833
|
};
|
|
999
834
|
type CreateAssistantThreadInteractionReviewHttpError = {
|
|
1000
|
-
data:
|
|
835
|
+
data: ErrorResponseCopy;
|
|
1001
836
|
headers: Headers;
|
|
1002
837
|
status: 400 | 403 | 404;
|
|
1003
838
|
};
|
|
@@ -1015,7 +850,7 @@ type DeleteAssistantThreadHttpResponse = {
|
|
|
1015
850
|
status: 204;
|
|
1016
851
|
};
|
|
1017
852
|
type DeleteAssistantThreadHttpError = {
|
|
1018
|
-
data:
|
|
853
|
+
data: ErrorResponseCopy;
|
|
1019
854
|
headers: Headers;
|
|
1020
855
|
status: 400 | 403 | 404;
|
|
1021
856
|
};
|
|
@@ -1033,7 +868,7 @@ type GetAssistantThreadHttpResponse = {
|
|
|
1033
868
|
status: 200;
|
|
1034
869
|
};
|
|
1035
870
|
type GetAssistantThreadHttpError = {
|
|
1036
|
-
data:
|
|
871
|
+
data: ErrorResponseCopy;
|
|
1037
872
|
headers: Headers;
|
|
1038
873
|
status: 400 | 403 | 404;
|
|
1039
874
|
};
|
|
@@ -1052,7 +887,7 @@ type PatchAssistantThreadHttpResponse = {
|
|
|
1052
887
|
status: 204;
|
|
1053
888
|
};
|
|
1054
889
|
type PatchAssistantThreadHttpError = {
|
|
1055
|
-
data:
|
|
890
|
+
data: ErrorResponseCopy;
|
|
1056
891
|
headers: Headers;
|
|
1057
892
|
status: 400 | 401 | 403 | 404 | 429;
|
|
1058
893
|
};
|
|
@@ -1069,7 +904,7 @@ type DeleteAssistantHttpResponse = {
|
|
|
1069
904
|
status: 204;
|
|
1070
905
|
};
|
|
1071
906
|
type DeleteAssistantHttpError = {
|
|
1072
|
-
data:
|
|
907
|
+
data: ErrorResponseCopy;
|
|
1073
908
|
headers: Headers;
|
|
1074
909
|
status: 400 | 403 | 404;
|
|
1075
910
|
};
|
|
@@ -1086,7 +921,7 @@ type GetAssistantHttpResponse = {
|
|
|
1086
921
|
status: 200;
|
|
1087
922
|
};
|
|
1088
923
|
type GetAssistantHttpError = {
|
|
1089
|
-
data:
|
|
924
|
+
data: ErrorResponseCopy;
|
|
1090
925
|
headers: Headers;
|
|
1091
926
|
status: 400 | 403 | 404;
|
|
1092
927
|
};
|
|
@@ -1104,7 +939,7 @@ type PatchAssistantHttpResponse = {
|
|
|
1104
939
|
status: 204;
|
|
1105
940
|
};
|
|
1106
941
|
type PatchAssistantHttpError = {
|
|
1107
|
-
data:
|
|
942
|
+
data: ErrorResponseCopy;
|
|
1108
943
|
headers: Headers;
|
|
1109
944
|
status: 400 | 401 | 403 | 404 | 429;
|
|
1110
945
|
};
|