@iblai/iblai-api 3.48.3-ai-plus → 3.48.4-ai
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/dist/index.cjs.js +5918 -6748
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +5919 -6747
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +5918 -6748
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +1 -40
- package/dist/types/models/{VoiceProviderEnum.d.ts → ProviderEnum.d.ts} +1 -1
- package/dist/types/models/Voice.d.ts +2 -2
- package/dist/types/services/AiAccountService.d.ts +66 -41
- package/dist/types/services/AiAnalyticsService.d.ts +2021 -923
- package/dist/types/services/AiIndexService.d.ts +78 -71
- package/dist/types/services/AiMarketingService.d.ts +17 -13
- package/dist/types/services/AiMediaService.d.ts +45 -41
- package/dist/types/services/AiMentorService.d.ts +1545 -1037
- package/dist/types/services/AiPromptService.d.ts +342 -228
- package/dist/types/services/AnalyticsService.d.ts +42 -13
- package/dist/types/services/AudienceService.d.ts +345 -149
- package/dist/types/services/CareerService.d.ts +117 -90
- package/dist/types/services/CatalogService.d.ts +3735 -1072
- package/dist/types/services/CoreService.d.ts +441 -215
- package/dist/types/services/CredentialsService.d.ts +173 -138
- package/dist/types/services/DepartmentsService.d.ts +53 -16
- package/dist/types/services/EngagementService.d.ts +459 -179
- package/dist/types/services/FeaturesService.d.ts +16 -7
- package/dist/types/services/FinanceService.d.ts +49 -20
- package/dist/types/services/MediaResourcesService.d.ts +243 -67
- package/dist/types/services/NotificationBuilderService.d.ts +31 -17
- package/dist/types/services/NotificationService.d.ts +56 -49
- package/dist/types/services/OrgsService.d.ts +106 -77
- package/dist/types/services/OverviewService.d.ts +154 -55
- package/dist/types/services/PerformanceService.d.ts +132 -56
- package/dist/types/services/PerlearnerService.d.ts +431 -217
- package/dist/types/services/PlatformService.d.ts +221 -116
- package/dist/types/services/ProviderAssociationService.d.ts +3 -2
- package/dist/types/services/ProvidersService.d.ts +27 -18
- package/dist/types/services/ProvisionService.d.ts +3 -2
- package/dist/types/services/RecommendationsService.d.ts +3 -3
- package/dist/types/services/ReportsService.d.ts +22 -16
- package/dist/types/services/RolesService.d.ts +8 -6
- package/dist/types/services/SearchService.d.ts +730 -195
- package/dist/types/services/ServiceService.d.ts +33 -29
- package/dist/types/services/SkillsService.d.ts +40 -32
- package/dist/types/services/UserGroupsService.d.ts +53 -16
- package/package.json +1 -1
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +1 -40
- package/src/models/{VoiceProviderEnum.ts → ProviderEnum.ts} +1 -1
- package/src/models/Voice.ts +2 -2
- package/src/services/AiAccountService.ts +81 -55
- package/src/services/AiAnalyticsService.ts +2422 -1181
- package/src/services/AiIndexService.ts +112 -87
- package/src/services/AiMarketingService.ts +25 -16
- package/src/services/AiMediaService.ts +67 -51
- package/src/services/AiMentorService.ts +2105 -1265
- package/src/services/AiPromptService.ts +484 -275
- package/src/services/AnalyticsService.ts +45 -16
- package/src/services/AudienceService.ts +380 -184
- package/src/services/CareerService.ts +144 -117
- package/src/services/CatalogService.ts +3995 -1332
- package/src/services/CoreService.ts +523 -291
- package/src/services/CredentialsService.ts +253 -173
- package/src/services/DepartmentsService.ts +56 -19
- package/src/services/EngagementService.ts +528 -236
- package/src/services/FeaturesService.ts +19 -10
- package/src/services/FinanceService.ts +54 -25
- package/src/services/MediaResourcesService.ts +251 -75
- package/src/services/NotificationBuilderService.ts +36 -22
- package/src/services/NotificationService.ts +73 -61
- package/src/services/OrgsService.ts +135 -106
- package/src/services/OverviewService.ts +172 -73
- package/src/services/PerformanceService.ts +153 -77
- package/src/services/PerlearnerService.ts +591 -279
- package/src/services/PlatformService.ts +278 -157
- package/src/services/ProviderAssociationService.ts +4 -3
- package/src/services/ProvidersService.ts +36 -27
- package/src/services/ProvisionService.ts +4 -3
- package/src/services/RecommendationsService.ts +5 -4
- package/src/services/ReportsService.ts +28 -22
- package/src/services/RolesService.ts +10 -8
- package/src/services/SearchService.ts +771 -236
- package/src/services/ServiceService.ts +49 -39
- package/src/services/SkillsService.ts +56 -44
- package/src/services/UserGroupsService.ts +56 -19
- package/dist/types/models/Bot.d.ts +0 -15
- package/dist/types/models/BotCommand.d.ts +0 -6
- package/dist/types/models/BotCreate.d.ts +0 -12
- package/dist/types/models/DataSet.d.ts +0 -21
- package/dist/types/models/DataSetCreate.d.ts +0 -12
- package/dist/types/models/DataSetStatusEnum.d.ts +0 -12
- package/dist/types/models/DiscordConfig.d.ts +0 -7
- package/dist/types/models/DiscordUserConfig.d.ts +0 -10
- package/dist/types/models/DiscordWebhook.d.ts +0 -6
- package/dist/types/models/PaginatedDataSetList.d.ts +0 -7
- package/dist/types/models/PaginatedTrainingList.d.ts +0 -7
- package/dist/types/models/PatchedBotCommand.d.ts +0 -6
- package/dist/types/models/PatchedBotCreate.d.ts +0 -12
- package/dist/types/models/PatchedDataSet.d.ts +0 -21
- package/dist/types/models/PatchedDiscordConfig.d.ts +0 -7
- package/dist/types/models/PatchedDiscordUserConfig.d.ts +0 -10
- package/dist/types/models/PatchedSlackConfig.d.ts +0 -8
- package/dist/types/models/PatchedSlackUserConfig.d.ts +0 -17
- package/dist/types/models/PatchedTeamsConfig.d.ts +0 -7
- package/dist/types/models/PatchedTrainingCreate.d.ts +0 -31
- package/dist/types/models/PatchedWebexConfig.d.ts +0 -10
- package/dist/types/models/PatchedWhatsappConfig.d.ts +0 -11
- package/dist/types/models/PatchedWhatsappUserConfig.d.ts +0 -10
- package/dist/types/models/Provider05cEnum.d.ts +0 -14
- package/dist/types/models/Provider63aEnum.d.ts +0 -6
- package/dist/types/models/SlackConfig.d.ts +0 -8
- package/dist/types/models/SlackUserConfig.d.ts +0 -17
- package/dist/types/models/SlackWebhook.d.ts +0 -6
- package/dist/types/models/TeamsConfig.d.ts +0 -7
- package/dist/types/models/TeamsWebhook.d.ts +0 -17
- package/dist/types/models/Training.d.ts +0 -41
- package/dist/types/models/TrainingCreate.d.ts +0 -31
- package/dist/types/models/WebexConfig.d.ts +0 -10
- package/dist/types/models/WebexWebhook.d.ts +0 -4
- package/dist/types/models/WhatAppWebHook.d.ts +0 -3
- package/dist/types/models/WhatsappConfig.d.ts +0 -11
- package/dist/types/models/WhatsappUserConfig.d.ts +0 -10
- package/dist/types/services/AiBotService.d.ts +0 -486
- package/dist/types/services/AiFinetuningService.d.ts +0 -162
- package/src/models/Bot.ts +0 -20
- package/src/models/BotCommand.ts +0 -11
- package/src/models/BotCreate.ts +0 -17
- package/src/models/DataSet.ts +0 -26
- package/src/models/DataSetCreate.ts +0 -17
- package/src/models/DataSetStatusEnum.ts +0 -16
- package/src/models/DiscordConfig.ts +0 -12
- package/src/models/DiscordUserConfig.ts +0 -15
- package/src/models/DiscordWebhook.ts +0 -11
- package/src/models/PaginatedDataSetList.ts +0 -12
- package/src/models/PaginatedTrainingList.ts +0 -12
- package/src/models/PatchedBotCommand.ts +0 -11
- package/src/models/PatchedBotCreate.ts +0 -17
- package/src/models/PatchedDataSet.ts +0 -26
- package/src/models/PatchedDiscordConfig.ts +0 -12
- package/src/models/PatchedDiscordUserConfig.ts +0 -15
- package/src/models/PatchedSlackConfig.ts +0 -13
- package/src/models/PatchedSlackUserConfig.ts +0 -22
- package/src/models/PatchedTeamsConfig.ts +0 -12
- package/src/models/PatchedTrainingCreate.ts +0 -36
- package/src/models/PatchedWebexConfig.ts +0 -15
- package/src/models/PatchedWhatsappConfig.ts +0 -16
- package/src/models/PatchedWhatsappUserConfig.ts +0 -15
- package/src/models/Provider05cEnum.ts +0 -18
- package/src/models/Provider63aEnum.ts +0 -10
- package/src/models/SlackConfig.ts +0 -13
- package/src/models/SlackUserConfig.ts +0 -22
- package/src/models/SlackWebhook.ts +0 -11
- package/src/models/TeamsConfig.ts +0 -12
- package/src/models/TeamsWebhook.ts +0 -22
- package/src/models/Training.ts +0 -46
- package/src/models/TrainingCreate.ts +0 -36
- package/src/models/WebexConfig.ts +0 -15
- package/src/models/WebexWebhook.ts +0 -9
- package/src/models/WhatAppWebHook.ts +0 -8
- package/src/models/WhatsappConfig.ts +0 -16
- package/src/models/WhatsappUserConfig.ts +0 -15
- package/src/services/AiBotService.ts +0 -1174
- package/src/services/AiFinetuningService.ts +0 -402
|
@@ -136,11 +136,12 @@ export declare class AiMentorService {
|
|
|
136
136
|
*
|
|
137
137
|
* Raises:
|
|
138
138
|
* BadRequest: If the request is invalid.
|
|
139
|
-
* @param org
|
|
140
139
|
* @returns any List of trigger slugs
|
|
141
140
|
* @throws ApiError
|
|
142
141
|
*/
|
|
143
|
-
static aiMentorOrgsAllTriggersRetrieve(org
|
|
142
|
+
static aiMentorOrgsAllTriggersRetrieve({ org, }: {
|
|
143
|
+
org: string;
|
|
144
|
+
}): CancelablePromise<any>;
|
|
144
145
|
/**
|
|
145
146
|
* Retrieve a list of emails in a mentor's inbox.
|
|
146
147
|
*
|
|
@@ -155,15 +156,25 @@ export declare class AiMentorService {
|
|
|
155
156
|
*
|
|
156
157
|
* Raises:
|
|
157
158
|
* NotFound: If the specified mentor does not exist.
|
|
158
|
-
* @param mentor
|
|
159
|
-
* @param org
|
|
160
|
-
* @param page A page number within the paginated result set.
|
|
161
|
-
* @param pageSize Number of results to return per page.
|
|
162
|
-
* @param search Search term to filter emails by content or subject
|
|
163
159
|
* @returns PaginatedEmailPromptListList
|
|
164
160
|
* @throws ApiError
|
|
165
161
|
*/
|
|
166
|
-
static aiMentorOrgsMentorsEmailInboxList(mentor
|
|
162
|
+
static aiMentorOrgsMentorsEmailInboxList({ mentor, org, page, pageSize, search, }: {
|
|
163
|
+
mentor: string;
|
|
164
|
+
org: string;
|
|
165
|
+
/**
|
|
166
|
+
* A page number within the paginated result set.
|
|
167
|
+
*/
|
|
168
|
+
page?: number;
|
|
169
|
+
/**
|
|
170
|
+
* Number of results to return per page.
|
|
171
|
+
*/
|
|
172
|
+
pageSize?: number;
|
|
173
|
+
/**
|
|
174
|
+
* Search term to filter emails by content or subject
|
|
175
|
+
*/
|
|
176
|
+
search?: string;
|
|
177
|
+
}): CancelablePromise<PaginatedEmailPromptListList>;
|
|
167
178
|
/**
|
|
168
179
|
* Retrieve a summary of a mentor's email inbox.
|
|
169
180
|
*
|
|
@@ -176,12 +187,13 @@ export declare class AiMentorService {
|
|
|
176
187
|
*
|
|
177
188
|
* Raises:
|
|
178
189
|
* NotFound: If the specified mentor does not exist.
|
|
179
|
-
* @param mentor
|
|
180
|
-
* @param org
|
|
181
190
|
* @returns EmailPromptSummary
|
|
182
191
|
* @throws ApiError
|
|
183
192
|
*/
|
|
184
|
-
static aiMentorOrgsMentorsEmailInboxSummaryRetrieve(mentor
|
|
193
|
+
static aiMentorOrgsMentorsEmailInboxSummaryRetrieve({ mentor, org, }: {
|
|
194
|
+
mentor: string;
|
|
195
|
+
org: string;
|
|
196
|
+
}): CancelablePromise<EmailPromptSummary>;
|
|
185
197
|
/**
|
|
186
198
|
* Retrieve details of a specific email in a mentor's inbox.
|
|
187
199
|
*
|
|
@@ -194,36 +206,39 @@ export declare class AiMentorService {
|
|
|
194
206
|
*
|
|
195
207
|
* Raises:
|
|
196
208
|
* NotFound: If the specified email does not exist.
|
|
197
|
-
* @param emailPromptId
|
|
198
|
-
* @param mentor
|
|
199
|
-
* @param org
|
|
200
209
|
* @returns EmailPromptDetail
|
|
201
210
|
* @throws ApiError
|
|
202
211
|
*/
|
|
203
|
-
static aiMentorOrgsMentorsEmailInboxRetrieve(emailPromptId
|
|
212
|
+
static aiMentorOrgsMentorsEmailInboxRetrieve({ emailPromptId, mentor, org, }: {
|
|
213
|
+
emailPromptId: number;
|
|
214
|
+
mentor: string;
|
|
215
|
+
org: string;
|
|
216
|
+
}): CancelablePromise<EmailPromptDetail>;
|
|
204
217
|
/**
|
|
205
218
|
* API endpoint to link mentor with a course and enable guided mode.
|
|
206
219
|
*
|
|
207
220
|
* Permissions:
|
|
208
221
|
* - Accessible to tenant admins.
|
|
209
|
-
* @param mentor
|
|
210
|
-
* @param org
|
|
211
222
|
* @returns LinkCourseResponse
|
|
212
223
|
* @throws ApiError
|
|
213
224
|
*/
|
|
214
|
-
static aiMentorOrgsMentorsLinkCourseRetrieve(mentor
|
|
225
|
+
static aiMentorOrgsMentorsLinkCourseRetrieve({ mentor, org, }: {
|
|
226
|
+
mentor: string;
|
|
227
|
+
org: string;
|
|
228
|
+
}): CancelablePromise<LinkCourseResponse>;
|
|
215
229
|
/**
|
|
216
230
|
* API endpoint to link mentor with a course and enable guided mode.
|
|
217
231
|
*
|
|
218
232
|
* Permissions:
|
|
219
233
|
* - Accessible to tenant admins.
|
|
220
|
-
* @param mentor
|
|
221
|
-
* @param org
|
|
222
|
-
* @param requestBody
|
|
223
234
|
* @returns LinkCourseResponse
|
|
224
235
|
* @throws ApiError
|
|
225
236
|
*/
|
|
226
|
-
static aiMentorOrgsMentorsLinkCourseCreate(mentor
|
|
237
|
+
static aiMentorOrgsMentorsLinkCourseCreate({ mentor, org, requestBody, }: {
|
|
238
|
+
mentor: string;
|
|
239
|
+
org: string;
|
|
240
|
+
requestBody: LinkCourseRequest;
|
|
241
|
+
}): CancelablePromise<LinkCourseResponse>;
|
|
227
242
|
/**
|
|
228
243
|
* Create or update metadata for a mentor.
|
|
229
244
|
*
|
|
@@ -236,12 +251,13 @@ export declare class AiMentorService {
|
|
|
236
251
|
*
|
|
237
252
|
* Raises:
|
|
238
253
|
* BadRequest: If the provided data is invalid.
|
|
239
|
-
* @param org
|
|
240
|
-
* @param requestBody
|
|
241
254
|
* @returns MentorMetadata
|
|
242
255
|
* @throws ApiError
|
|
243
256
|
*/
|
|
244
|
-
static aiMentorOrgsMetadataCreate(org
|
|
257
|
+
static aiMentorOrgsMetadataCreate({ org, requestBody, }: {
|
|
258
|
+
org: string;
|
|
259
|
+
requestBody: MentorMetadata;
|
|
260
|
+
}): CancelablePromise<MentorMetadata>;
|
|
245
261
|
/**
|
|
246
262
|
* Retrieve existing questions.
|
|
247
263
|
*
|
|
@@ -250,11 +266,12 @@ export declare class AiMentorService {
|
|
|
250
266
|
*
|
|
251
267
|
* Returns:
|
|
252
268
|
* Response: The existing questions.
|
|
253
|
-
* @param org
|
|
254
269
|
* @returns any No response body
|
|
255
270
|
* @throws ApiError
|
|
256
271
|
*/
|
|
257
|
-
static aiMentorOrgsQuizCustomizerRetrieve(org
|
|
272
|
+
static aiMentorOrgsQuizCustomizerRetrieve({ org, }: {
|
|
273
|
+
org: string;
|
|
274
|
+
}): CancelablePromise<any>;
|
|
258
275
|
/**
|
|
259
276
|
* Generate follow-up questions based on initial questions.
|
|
260
277
|
*
|
|
@@ -266,12 +283,13 @@ export declare class AiMentorService {
|
|
|
266
283
|
*
|
|
267
284
|
* Raises:
|
|
268
285
|
* BadRequest: If the provided data is invalid.
|
|
269
|
-
* @param org
|
|
270
|
-
* @param requestBody
|
|
271
286
|
* @returns QuestionResponse
|
|
272
287
|
* @throws ApiError
|
|
273
288
|
*/
|
|
274
|
-
static aiMentorOrgsQuizCustomizerCreate(org
|
|
289
|
+
static aiMentorOrgsQuizCustomizerCreate({ org, requestBody, }: {
|
|
290
|
+
org: string;
|
|
291
|
+
requestBody: QuestionRequest;
|
|
292
|
+
}): CancelablePromise<QuestionResponse>;
|
|
275
293
|
/**
|
|
276
294
|
* Retrieve or create a chat session with a mentor.
|
|
277
295
|
*
|
|
@@ -290,12 +308,13 @@ export declare class AiMentorService {
|
|
|
290
308
|
* Http404: If the mentor is not found.
|
|
291
309
|
* ValidationError: If the username is invalid.
|
|
292
310
|
* ValidationError: If one or more tool slugs are invalid.
|
|
293
|
-
* @param org
|
|
294
|
-
* @param requestBody
|
|
295
311
|
* @returns ChatSessionResponse
|
|
296
312
|
* @throws ApiError
|
|
297
313
|
*/
|
|
298
|
-
static aiMentorOrgsSessionsCreate(org
|
|
314
|
+
static aiMentorOrgsSessionsCreate({ org, requestBody, }: {
|
|
315
|
+
org: string;
|
|
316
|
+
requestBody: ChatSessionRequest;
|
|
317
|
+
}): CancelablePromise<ChatSessionResponse>;
|
|
299
318
|
/**
|
|
300
319
|
* Create or modify a trigger.
|
|
301
320
|
*
|
|
@@ -308,12 +327,13 @@ export declare class AiMentorService {
|
|
|
308
327
|
*
|
|
309
328
|
* Raises:
|
|
310
329
|
* BadRequest: If the provided data is invalid or missing required parameters.
|
|
311
|
-
* @param org
|
|
312
|
-
* @param requestBody
|
|
313
330
|
* @returns TriggerResponse
|
|
314
331
|
* @throws ApiError
|
|
315
332
|
*/
|
|
316
|
-
static aiMentorOrgsTriggerCreate(org
|
|
333
|
+
static aiMentorOrgsTriggerCreate({ org, requestBody, }: {
|
|
334
|
+
org: string;
|
|
335
|
+
requestBody: TriggerRequest;
|
|
336
|
+
}): CancelablePromise<TriggerResponse>;
|
|
317
337
|
/**
|
|
318
338
|
* Retrieve available trigger templates.
|
|
319
339
|
*
|
|
@@ -326,11 +346,12 @@ export declare class AiMentorService {
|
|
|
326
346
|
*
|
|
327
347
|
* Raises:
|
|
328
348
|
* BadRequest: If the request is invalid.
|
|
329
|
-
* @param org
|
|
330
349
|
* @returns any Dictionary of trigger templates and their required parameters
|
|
331
350
|
* @throws ApiError
|
|
332
351
|
*/
|
|
333
|
-
static aiMentorOrgsTriggerTemplatesRetrieve(org
|
|
352
|
+
static aiMentorOrgsTriggerTemplatesRetrieve({ org, }: {
|
|
353
|
+
org: string;
|
|
354
|
+
}): CancelablePromise<any>;
|
|
334
355
|
/**
|
|
335
356
|
* Retrieve details of a specific trigger.
|
|
336
357
|
*
|
|
@@ -344,12 +365,13 @@ export declare class AiMentorService {
|
|
|
344
365
|
*
|
|
345
366
|
* Raises:
|
|
346
367
|
* Http404: If the specified trigger does not exist.
|
|
347
|
-
* @param org
|
|
348
|
-
* @param slug
|
|
349
368
|
* @returns TriggerResponse
|
|
350
369
|
* @throws ApiError
|
|
351
370
|
*/
|
|
352
|
-
static aiMentorOrgsTriggerRetrieve(org
|
|
371
|
+
static aiMentorOrgsTriggerRetrieve({ org, slug, }: {
|
|
372
|
+
org: string;
|
|
373
|
+
slug: string;
|
|
374
|
+
}): CancelablePromise<TriggerResponse>;
|
|
353
375
|
/**
|
|
354
376
|
* Delete a specific trigger.
|
|
355
377
|
*
|
|
@@ -363,31 +385,48 @@ export declare class AiMentorService {
|
|
|
363
385
|
*
|
|
364
386
|
* Raises:
|
|
365
387
|
* BadRequest: If the specified trigger does not exist.
|
|
366
|
-
* @param org
|
|
367
|
-
* @param slug
|
|
368
388
|
* @returns any Trigger successfully deleted
|
|
369
389
|
* @throws ApiError
|
|
370
390
|
*/
|
|
371
|
-
static aiMentorOrgsTriggerDeletionCreate(org
|
|
391
|
+
static aiMentorOrgsTriggerDeletionCreate({ org, slug, }: {
|
|
392
|
+
org: string;
|
|
393
|
+
slug: string;
|
|
394
|
+
}): CancelablePromise<any>;
|
|
372
395
|
/**
|
|
373
396
|
* Retrieve a list of mentors.
|
|
374
397
|
*
|
|
375
398
|
* Returns:
|
|
376
399
|
* - List of mentors matching the filters.
|
|
377
|
-
* @param org
|
|
378
|
-
* @param userId
|
|
379
|
-
* @param departmentId Department to filter by
|
|
380
|
-
* @param filterBy Filter options include, date, name, default is date
|
|
381
|
-
* @param metadataKey Metadata key to be queried with
|
|
382
|
-
* @param metadataValue Metadata value to be filter for
|
|
383
|
-
* @param page A page number within the paginated result set.
|
|
384
|
-
* @param pageSize Number of results to return per page.
|
|
385
|
-
* @param returnSessionInformation Declares if session information should be included in the mentor data
|
|
386
|
-
* @param visibility visibility type to be queried with
|
|
387
400
|
* @returns PaginatedMentorList
|
|
388
401
|
* @throws ApiError
|
|
389
402
|
*/
|
|
390
|
-
static aiMentorOrgsUsersList(org
|
|
403
|
+
static aiMentorOrgsUsersList({ org, userId, departmentId, filterBy, metadataKey, metadataValue, page, pageSize, returnSessionInformation, visibility, }: {
|
|
404
|
+
org: string; /**
|
|
405
|
+
* Department to filter by
|
|
406
|
+
*/
|
|
407
|
+
departmentId?: number; /**
|
|
408
|
+
* Filter options include, date, name, default is date
|
|
409
|
+
*/
|
|
410
|
+
filterBy?: string; /**
|
|
411
|
+
* Metadata key to be queried with
|
|
412
|
+
*/
|
|
413
|
+
metadataKey?: string; /**
|
|
414
|
+
* Metadata value to be filter for
|
|
415
|
+
*/
|
|
416
|
+
metadataValue?: string; /**
|
|
417
|
+
* A page number within the paginated result set.
|
|
418
|
+
*/
|
|
419
|
+
page?: number; /**
|
|
420
|
+
* Number of results to return per page.
|
|
421
|
+
*/
|
|
422
|
+
pageSize?: number; /**
|
|
423
|
+
* Declares if session information should be included in the mentor data
|
|
424
|
+
*/
|
|
425
|
+
returnSessionInformation?: boolean; /**
|
|
426
|
+
* visibility type to be queried with
|
|
427
|
+
*/
|
|
428
|
+
visibility?: string;
|
|
429
|
+
}): CancelablePromise<PaginatedMentorList>;
|
|
391
430
|
/**
|
|
392
431
|
* Create a new mentor.
|
|
393
432
|
*
|
|
@@ -396,19 +435,31 @@ export declare class AiMentorService {
|
|
|
396
435
|
* - unique_id: Unique identifier.
|
|
397
436
|
* - platform_key: Associated platform.
|
|
398
437
|
* - metadata: Additional mentor attributes.
|
|
399
|
-
* @param org
|
|
400
|
-
* @param userId
|
|
401
|
-
* @param requestBody
|
|
402
|
-
* @param departmentId Department to filter by
|
|
403
|
-
* @param filterBy Filter options include, date, name, default is date
|
|
404
|
-
* @param metadataKey Metadata key to be queried with
|
|
405
|
-
* @param metadataValue Metadata value to be filter for
|
|
406
|
-
* @param returnSessionInformation Declares if session information should be included in the mentor data
|
|
407
|
-
* @param visibility visibility type to be queried with
|
|
408
438
|
* @returns Mentor
|
|
409
439
|
* @throws ApiError
|
|
410
440
|
*/
|
|
411
|
-
static aiMentorOrgsUsersCreate(org
|
|
441
|
+
static aiMentorOrgsUsersCreate({ org, userId, requestBody, departmentId, filterBy, metadataKey, metadataValue, returnSessionInformation, visibility, }: {
|
|
442
|
+
org: string;
|
|
443
|
+
requestBody: MentorCreate; /**
|
|
444
|
+
* Department to filter by
|
|
445
|
+
*/
|
|
446
|
+
departmentId?: number; /**
|
|
447
|
+
* Filter options include, date, name, default is date
|
|
448
|
+
*/
|
|
449
|
+
filterBy?: string; /**
|
|
450
|
+
* Metadata key to be queried with
|
|
451
|
+
*/
|
|
452
|
+
metadataKey?: string; /**
|
|
453
|
+
* Metadata value to be filter for
|
|
454
|
+
*/
|
|
455
|
+
metadataValue?: string; /**
|
|
456
|
+
* Declares if session information should be included in the mentor data
|
|
457
|
+
*/
|
|
458
|
+
returnSessionInformation?: boolean; /**
|
|
459
|
+
* visibility type to be queried with
|
|
460
|
+
*/
|
|
461
|
+
visibility?: string;
|
|
462
|
+
}): CancelablePromise<Mentor>;
|
|
412
463
|
/**
|
|
413
464
|
* API ViewSet for managing mentors.
|
|
414
465
|
*
|
|
@@ -416,35 +467,59 @@ export declare class AiMentorService {
|
|
|
416
467
|
*
|
|
417
468
|
* Permissions:
|
|
418
469
|
* - Accessible to both tenant admins and students.
|
|
419
|
-
* @param name
|
|
420
|
-
* @param org
|
|
421
|
-
* @param userId
|
|
422
|
-
* @param departmentId Department to filter by
|
|
423
|
-
* @param filterBy Filter options include, date, name, default is date
|
|
424
|
-
* @param metadataKey Metadata key to be queried with
|
|
425
|
-
* @param metadataValue Metadata value to be filter for
|
|
426
|
-
* @param returnSessionInformation Declares if session information should be included in the mentor data
|
|
427
|
-
* @param visibility visibility type to be queried with
|
|
428
470
|
* @returns Mentor
|
|
429
471
|
* @throws ApiError
|
|
430
472
|
*/
|
|
431
|
-
static aiMentorOrgsUsersRetrieve(name
|
|
473
|
+
static aiMentorOrgsUsersRetrieve({ name, org, userId, departmentId, filterBy, metadataKey, metadataValue, returnSessionInformation, visibility, }: {
|
|
474
|
+
name: string;
|
|
475
|
+
org: string; /**
|
|
476
|
+
* Department to filter by
|
|
477
|
+
*/
|
|
478
|
+
departmentId?: number; /**
|
|
479
|
+
* Filter options include, date, name, default is date
|
|
480
|
+
*/
|
|
481
|
+
filterBy?: string; /**
|
|
482
|
+
* Metadata key to be queried with
|
|
483
|
+
*/
|
|
484
|
+
metadataKey?: string; /**
|
|
485
|
+
* Metadata value to be filter for
|
|
486
|
+
*/
|
|
487
|
+
metadataValue?: string; /**
|
|
488
|
+
* Declares if session information should be included in the mentor data
|
|
489
|
+
*/
|
|
490
|
+
returnSessionInformation?: boolean; /**
|
|
491
|
+
* visibility type to be queried with
|
|
492
|
+
*/
|
|
493
|
+
visibility?: string;
|
|
494
|
+
}): CancelablePromise<Mentor>;
|
|
432
495
|
/**
|
|
433
496
|
* Update a mentor's details.
|
|
434
|
-
* @param name
|
|
435
|
-
* @param org
|
|
436
|
-
* @param userId
|
|
437
|
-
* @param requestBody
|
|
438
|
-
* @param departmentId Department to filter by
|
|
439
|
-
* @param filterBy Filter options include, date, name, default is date
|
|
440
|
-
* @param metadataKey Metadata key to be queried with
|
|
441
|
-
* @param metadataValue Metadata value to be filter for
|
|
442
|
-
* @param returnSessionInformation Declares if session information should be included in the mentor data
|
|
443
|
-
* @param visibility visibility type to be queried with
|
|
444
497
|
* @returns Mentor
|
|
445
498
|
* @throws ApiError
|
|
446
499
|
*/
|
|
447
|
-
static aiMentorOrgsUsersUpdate(name
|
|
500
|
+
static aiMentorOrgsUsersUpdate({ name, org, userId, requestBody, departmentId, filterBy, metadataKey, metadataValue, returnSessionInformation, visibility, }: {
|
|
501
|
+
name: string;
|
|
502
|
+
org: string;
|
|
503
|
+
requestBody: MentorCreate; /**
|
|
504
|
+
* Department to filter by
|
|
505
|
+
*/
|
|
506
|
+
departmentId?: number; /**
|
|
507
|
+
* Filter options include, date, name, default is date
|
|
508
|
+
*/
|
|
509
|
+
filterBy?: string; /**
|
|
510
|
+
* Metadata key to be queried with
|
|
511
|
+
*/
|
|
512
|
+
metadataKey?: string; /**
|
|
513
|
+
* Metadata value to be filter for
|
|
514
|
+
*/
|
|
515
|
+
metadataValue?: string; /**
|
|
516
|
+
* Declares if session information should be included in the mentor data
|
|
517
|
+
*/
|
|
518
|
+
returnSessionInformation?: boolean; /**
|
|
519
|
+
* visibility type to be queried with
|
|
520
|
+
*/
|
|
521
|
+
visibility?: string;
|
|
522
|
+
}): CancelablePromise<Mentor>;
|
|
448
523
|
/**
|
|
449
524
|
* API ViewSet for managing mentors.
|
|
450
525
|
*
|
|
@@ -452,35 +527,59 @@ export declare class AiMentorService {
|
|
|
452
527
|
*
|
|
453
528
|
* Permissions:
|
|
454
529
|
* - Accessible to both tenant admins and students.
|
|
455
|
-
* @param name
|
|
456
|
-
* @param org
|
|
457
|
-
* @param userId
|
|
458
|
-
* @param departmentId Department to filter by
|
|
459
|
-
* @param filterBy Filter options include, date, name, default is date
|
|
460
|
-
* @param metadataKey Metadata key to be queried with
|
|
461
|
-
* @param metadataValue Metadata value to be filter for
|
|
462
|
-
* @param returnSessionInformation Declares if session information should be included in the mentor data
|
|
463
|
-
* @param visibility visibility type to be queried with
|
|
464
|
-
* @param requestBody
|
|
465
530
|
* @returns MentorCreate
|
|
466
531
|
* @throws ApiError
|
|
467
532
|
*/
|
|
468
|
-
static aiMentorOrgsUsersPartialUpdate(name
|
|
533
|
+
static aiMentorOrgsUsersPartialUpdate({ name, org, userId, departmentId, filterBy, metadataKey, metadataValue, returnSessionInformation, visibility, requestBody, }: {
|
|
534
|
+
name: string;
|
|
535
|
+
org: string; /**
|
|
536
|
+
* Department to filter by
|
|
537
|
+
*/
|
|
538
|
+
departmentId?: number; /**
|
|
539
|
+
* Filter options include, date, name, default is date
|
|
540
|
+
*/
|
|
541
|
+
filterBy?: string; /**
|
|
542
|
+
* Metadata key to be queried with
|
|
543
|
+
*/
|
|
544
|
+
metadataKey?: string; /**
|
|
545
|
+
* Metadata value to be filter for
|
|
546
|
+
*/
|
|
547
|
+
metadataValue?: string; /**
|
|
548
|
+
* Declares if session information should be included in the mentor data
|
|
549
|
+
*/
|
|
550
|
+
returnSessionInformation?: boolean; /**
|
|
551
|
+
* visibility type to be queried with
|
|
552
|
+
*/
|
|
553
|
+
visibility?: string;
|
|
554
|
+
requestBody?: PatchedMentorCreate;
|
|
555
|
+
}): CancelablePromise<MentorCreate>;
|
|
469
556
|
/**
|
|
470
557
|
* Soft delete a mentor.
|
|
471
|
-
* @param name
|
|
472
|
-
* @param org
|
|
473
|
-
* @param userId
|
|
474
|
-
* @param departmentId Department to filter by
|
|
475
|
-
* @param filterBy Filter options include, date, name, default is date
|
|
476
|
-
* @param metadataKey Metadata key to be queried with
|
|
477
|
-
* @param metadataValue Metadata value to be filter for
|
|
478
|
-
* @param returnSessionInformation Declares if session information should be included in the mentor data
|
|
479
|
-
* @param visibility visibility type to be queried with
|
|
480
558
|
* @returns void
|
|
481
559
|
* @throws ApiError
|
|
482
560
|
*/
|
|
483
|
-
static aiMentorOrgsUsersDestroy(name
|
|
561
|
+
static aiMentorOrgsUsersDestroy({ name, org, userId, departmentId, filterBy, metadataKey, metadataValue, returnSessionInformation, visibility, }: {
|
|
562
|
+
name: string;
|
|
563
|
+
org: string; /**
|
|
564
|
+
* Department to filter by
|
|
565
|
+
*/
|
|
566
|
+
departmentId?: number; /**
|
|
567
|
+
* Filter options include, date, name, default is date
|
|
568
|
+
*/
|
|
569
|
+
filterBy?: string; /**
|
|
570
|
+
* Metadata key to be queried with
|
|
571
|
+
*/
|
|
572
|
+
metadataKey?: string; /**
|
|
573
|
+
* Metadata value to be filter for
|
|
574
|
+
*/
|
|
575
|
+
metadataValue?: string; /**
|
|
576
|
+
* Declares if session information should be included in the mentor data
|
|
577
|
+
*/
|
|
578
|
+
returnSessionInformation?: boolean; /**
|
|
579
|
+
* visibility type to be queried with
|
|
580
|
+
*/
|
|
581
|
+
visibility?: string;
|
|
582
|
+
}): CancelablePromise<void>;
|
|
484
583
|
/**
|
|
485
584
|
* Endpoint to view and delete AI generated images for a user.
|
|
486
585
|
*
|
|
@@ -492,19 +591,27 @@ export declare class AiMentorService {
|
|
|
492
591
|
* - model: the text to image model on the provider used to generate the image.
|
|
493
592
|
*
|
|
494
593
|
* This endpoint is accessible to both students and platform admins.
|
|
495
|
-
* @param org
|
|
496
|
-
* @param userId
|
|
497
|
-
* @param model
|
|
498
|
-
* @param ordering Which field to use when ordering the results.
|
|
499
|
-
* @param page A page number within the paginated result set.
|
|
500
|
-
* @param pageSize Number of results to return per page.
|
|
501
|
-
* @param provider
|
|
502
|
-
* @param search A search term.
|
|
503
|
-
* @param username
|
|
504
594
|
* @returns PaginatedAIGeneratedImageList
|
|
505
595
|
* @throws ApiError
|
|
506
596
|
*/
|
|
507
|
-
static aiMentorOrgsUsersAiGeneratedImagesList(org
|
|
597
|
+
static aiMentorOrgsUsersAiGeneratedImagesList({ org, userId, model, ordering, page, pageSize, provider, search, username, }: {
|
|
598
|
+
org: string;
|
|
599
|
+
model?: string; /**
|
|
600
|
+
* Which field to use when ordering the results.
|
|
601
|
+
*/
|
|
602
|
+
ordering?: string; /**
|
|
603
|
+
* A page number within the paginated result set.
|
|
604
|
+
*/
|
|
605
|
+
page?: number; /**
|
|
606
|
+
* Number of results to return per page.
|
|
607
|
+
*/
|
|
608
|
+
pageSize?: number;
|
|
609
|
+
provider?: string; /**
|
|
610
|
+
* A search term.
|
|
611
|
+
*/
|
|
612
|
+
search?: string;
|
|
613
|
+
username?: string;
|
|
614
|
+
}): CancelablePromise<PaginatedAIGeneratedImageList>;
|
|
508
615
|
/**
|
|
509
616
|
* Endpoint to view and delete AI generated images for a user.
|
|
510
617
|
*
|
|
@@ -516,13 +623,16 @@ export declare class AiMentorService {
|
|
|
516
623
|
* - model: the text to image model on the provider used to generate the image.
|
|
517
624
|
*
|
|
518
625
|
* This endpoint is accessible to both students and platform admins.
|
|
519
|
-
* @param id A unique integer value identifying this ai generated image.
|
|
520
|
-
* @param org
|
|
521
|
-
* @param userId
|
|
522
626
|
* @returns AIGeneratedImage
|
|
523
627
|
* @throws ApiError
|
|
524
628
|
*/
|
|
525
|
-
static aiMentorOrgsUsersAiGeneratedImagesRetrieve(id
|
|
629
|
+
static aiMentorOrgsUsersAiGeneratedImagesRetrieve({ id, org, userId, }: {
|
|
630
|
+
/**
|
|
631
|
+
* A unique integer value identifying this ai generated image.
|
|
632
|
+
*/
|
|
633
|
+
id: number;
|
|
634
|
+
org: string;
|
|
635
|
+
}): CancelablePromise<AIGeneratedImage>;
|
|
526
636
|
/**
|
|
527
637
|
* Endpoint to view and delete AI generated images for a user.
|
|
528
638
|
*
|
|
@@ -534,21 +644,24 @@ export declare class AiMentorService {
|
|
|
534
644
|
* - model: the text to image model on the provider used to generate the image.
|
|
535
645
|
*
|
|
536
646
|
* This endpoint is accessible to both students and platform admins.
|
|
537
|
-
* @param id A unique integer value identifying this ai generated image.
|
|
538
|
-
* @param org
|
|
539
|
-
* @param userId
|
|
540
647
|
* @returns void
|
|
541
648
|
* @throws ApiError
|
|
542
649
|
*/
|
|
543
|
-
static aiMentorOrgsUsersAiGeneratedImagesDestroy(id
|
|
650
|
+
static aiMentorOrgsUsersAiGeneratedImagesDestroy({ id, org, userId, }: {
|
|
651
|
+
/**
|
|
652
|
+
* A unique integer value identifying this ai generated image.
|
|
653
|
+
*/
|
|
654
|
+
id: number;
|
|
655
|
+
org: string;
|
|
656
|
+
}): CancelablePromise<void>;
|
|
544
657
|
/**
|
|
545
658
|
* Endpoint to get a list of AI user profile memory entries or to add an entry.
|
|
546
|
-
* @param org
|
|
547
|
-
* @param userId
|
|
548
659
|
* @returns AIUserProfileMemoryRelation
|
|
549
660
|
* @throws ApiError
|
|
550
661
|
*/
|
|
551
|
-
static aiMentorOrgsUsersAiUserProfileMemoryList(org
|
|
662
|
+
static aiMentorOrgsUsersAiUserProfileMemoryList({ org, userId, }: {
|
|
663
|
+
org: string;
|
|
664
|
+
}): CancelablePromise<Array<AIUserProfileMemoryRelation>>;
|
|
552
665
|
/**
|
|
553
666
|
* Endpoint to create an AI user profile memory entry.
|
|
554
667
|
*
|
|
@@ -560,26 +673,26 @@ export declare class AiMentorService {
|
|
|
560
673
|
* ```
|
|
561
674
|
* {"favorite-animal": "my favorite animal is cat"}
|
|
562
675
|
* ```
|
|
563
|
-
* @param org
|
|
564
|
-
* @param userId
|
|
565
|
-
* @param requestBody
|
|
566
676
|
* @returns AIUserProfileMemoryRelation
|
|
567
677
|
* @throws ApiError
|
|
568
678
|
*/
|
|
569
|
-
static aiMentorOrgsUsersAiUserProfileMemoryCreate(org
|
|
679
|
+
static aiMentorOrgsUsersAiUserProfileMemoryCreate({ org, userId, requestBody, }: {
|
|
680
|
+
org: string;
|
|
681
|
+
requestBody: AIUserProfileRequest;
|
|
682
|
+
}): CancelablePromise<AIUserProfileMemoryRelation>;
|
|
570
683
|
/**
|
|
571
684
|
* The endpoint to delete an AI user profile memory entry.
|
|
572
685
|
*
|
|
573
686
|
* No query parameters or JSON parameters are required.
|
|
574
687
|
*
|
|
575
688
|
* The response is always empty. Successful request will be responded with status 204, and failed request will be responded with status 404.
|
|
576
|
-
* @param org
|
|
577
|
-
* @param tag
|
|
578
|
-
* @param userId
|
|
579
689
|
* @returns void
|
|
580
690
|
* @throws ApiError
|
|
581
691
|
*/
|
|
582
|
-
static aiMentorOrgsUsersAiUserProfileMemoryDestroy(org
|
|
692
|
+
static aiMentorOrgsUsersAiUserProfileMemoryDestroy({ org, tag, userId, }: {
|
|
693
|
+
org: string;
|
|
694
|
+
tag: string;
|
|
695
|
+
}): CancelablePromise<void>;
|
|
583
696
|
/**
|
|
584
697
|
* Retrieve assumed knowledge levels.
|
|
585
698
|
*
|
|
@@ -593,12 +706,12 @@ export declare class AiMentorService {
|
|
|
593
706
|
*
|
|
594
707
|
* Raises:
|
|
595
708
|
* NotFound: If no assumed knowledge exists for the user.
|
|
596
|
-
* @param org
|
|
597
|
-
* @param userId
|
|
598
709
|
* @returns AssumedKnowledge
|
|
599
710
|
* @throws ApiError
|
|
600
711
|
*/
|
|
601
|
-
static aiMentorOrgsUsersAssumedKnowledgeRetrieve(org
|
|
712
|
+
static aiMentorOrgsUsersAssumedKnowledgeRetrieve({ org, userId, }: {
|
|
713
|
+
org: string;
|
|
714
|
+
}): CancelablePromise<AssumedKnowledge>;
|
|
602
715
|
/**
|
|
603
716
|
* Update assumed knowledge levels.
|
|
604
717
|
*
|
|
@@ -612,13 +725,13 @@ export declare class AiMentorService {
|
|
|
612
725
|
*
|
|
613
726
|
* Raises:
|
|
614
727
|
* BadRequest: If the provided data is invalid.
|
|
615
|
-
* @param org
|
|
616
|
-
* @param userId
|
|
617
|
-
* @param requestBody
|
|
618
728
|
* @returns AssumedKnowledge
|
|
619
729
|
* @throws ApiError
|
|
620
730
|
*/
|
|
621
|
-
static aiMentorOrgsUsersAssumedKnowledgeCreate(org
|
|
731
|
+
static aiMentorOrgsUsersAssumedKnowledgeCreate({ org, userId, requestBody, }: {
|
|
732
|
+
org: string;
|
|
733
|
+
requestBody: AssumedKnowledge;
|
|
734
|
+
}): CancelablePromise<AssumedKnowledge>;
|
|
622
735
|
/**
|
|
623
736
|
* Convert an uploaded audio file to text.
|
|
624
737
|
*
|
|
@@ -633,46 +746,50 @@ export declare class AiMentorService {
|
|
|
633
746
|
* Raises:
|
|
634
747
|
* BadRequest: If the audio file is invalid or cannot be processed.
|
|
635
748
|
* NotFound: If the API key for the tenant is not found.
|
|
636
|
-
* @param org
|
|
637
|
-
* @param userId
|
|
638
|
-
* @param formData
|
|
639
749
|
* @returns AudioToTextResponse
|
|
640
750
|
* @throws ApiError
|
|
641
751
|
*/
|
|
642
|
-
static aiMentorOrgsUsersAudioToTextCreate(org
|
|
752
|
+
static aiMentorOrgsUsersAudioToTextCreate({ org, userId, formData, }: {
|
|
753
|
+
org: string;
|
|
754
|
+
formData: AudioToTextRequest;
|
|
755
|
+
}): CancelablePromise<AudioToTextResponse>;
|
|
643
756
|
/**
|
|
644
757
|
* This endpoint list available template mentors for a tenant
|
|
645
758
|
*
|
|
646
759
|
* Returns:
|
|
647
760
|
*
|
|
648
761
|
* 200 : List of Tool objects
|
|
649
|
-
* @param org
|
|
650
|
-
* @param userId
|
|
651
762
|
* @returns TemplateMentor
|
|
652
763
|
* @throws ApiError
|
|
653
764
|
*/
|
|
654
|
-
static aiMentorOrgsUsersAvailableTemplateMentorsRetrieve(org
|
|
765
|
+
static aiMentorOrgsUsersAvailableTemplateMentorsRetrieve({ org, userId, }: {
|
|
766
|
+
org: string;
|
|
767
|
+
}): CancelablePromise<TemplateMentor>;
|
|
655
768
|
/**
|
|
656
769
|
* Retrieve a list of Mentor Category Groups.
|
|
657
|
-
* @param org
|
|
658
|
-
* @param userId
|
|
659
|
-
* @param audience
|
|
660
|
-
* @param audienceName
|
|
661
|
-
* @param ordering Which field to use when ordering the results.
|
|
662
|
-
* @param search A search term.
|
|
663
770
|
* @returns MentorCategoryGroup
|
|
664
771
|
* @throws ApiError
|
|
665
772
|
*/
|
|
666
|
-
static aiMentorOrgsUsersCategoryGroupsList(org
|
|
773
|
+
static aiMentorOrgsUsersCategoryGroupsList({ org, userId, audience, audienceName, ordering, search, }: {
|
|
774
|
+
org: string;
|
|
775
|
+
audience?: number;
|
|
776
|
+
audienceName?: string; /**
|
|
777
|
+
* Which field to use when ordering the results.
|
|
778
|
+
*/
|
|
779
|
+
ordering?: string; /**
|
|
780
|
+
* A search term.
|
|
781
|
+
*/
|
|
782
|
+
search?: string;
|
|
783
|
+
}): CancelablePromise<Array<MentorCategoryGroup>>;
|
|
667
784
|
/**
|
|
668
785
|
* Create a new Mentor Category Group. Only accessible to Platform Admins.
|
|
669
|
-
* @param org
|
|
670
|
-
* @param userId
|
|
671
|
-
* @param requestBody
|
|
672
786
|
* @returns MentorCategoryGroup
|
|
673
787
|
* @throws ApiError
|
|
674
788
|
*/
|
|
675
|
-
static aiMentorOrgsUsersCategoryGroupsCreate(org
|
|
789
|
+
static aiMentorOrgsUsersCategoryGroupsCreate({ org, userId, requestBody, }: {
|
|
790
|
+
org: string;
|
|
791
|
+
requestBody: MentorCategoryGroupCreate;
|
|
792
|
+
}): CancelablePromise<MentorCategoryGroup>;
|
|
676
793
|
/**
|
|
677
794
|
* Mentor Category Groups offer parent grouping for mentor category objects.
|
|
678
795
|
*
|
|
@@ -681,13 +798,16 @@ export declare class AiMentorService {
|
|
|
681
798
|
* Permissions:
|
|
682
799
|
* GET: Accessible to both Platform Admins and Students
|
|
683
800
|
* POST, DELETE, PATCH, PUT: Accessible to only Platform Admins
|
|
684
|
-
* @param id A unique integer value identifying this mentor category group.
|
|
685
|
-
* @param org
|
|
686
|
-
* @param userId
|
|
687
801
|
* @returns MentorCategoryGroup
|
|
688
802
|
* @throws ApiError
|
|
689
803
|
*/
|
|
690
|
-
static aiMentorOrgsUsersCategoryGroupsRetrieve(id
|
|
804
|
+
static aiMentorOrgsUsersCategoryGroupsRetrieve({ id, org, userId, }: {
|
|
805
|
+
/**
|
|
806
|
+
* A unique integer value identifying this mentor category group.
|
|
807
|
+
*/
|
|
808
|
+
id: number;
|
|
809
|
+
org: string;
|
|
810
|
+
}): CancelablePromise<MentorCategoryGroup>;
|
|
691
811
|
/**
|
|
692
812
|
* Mentor Category Groups offer parent grouping for mentor category objects.
|
|
693
813
|
*
|
|
@@ -696,14 +816,17 @@ export declare class AiMentorService {
|
|
|
696
816
|
* Permissions:
|
|
697
817
|
* GET: Accessible to both Platform Admins and Students
|
|
698
818
|
* POST, DELETE, PATCH, PUT: Accessible to only Platform Admins
|
|
699
|
-
* @param id A unique integer value identifying this mentor category group.
|
|
700
|
-
* @param org
|
|
701
|
-
* @param userId
|
|
702
|
-
* @param requestBody
|
|
703
819
|
* @returns MentorCategoryGroupCreate
|
|
704
820
|
* @throws ApiError
|
|
705
821
|
*/
|
|
706
|
-
static aiMentorOrgsUsersCategoryGroupsUpdate(id
|
|
822
|
+
static aiMentorOrgsUsersCategoryGroupsUpdate({ id, org, userId, requestBody, }: {
|
|
823
|
+
/**
|
|
824
|
+
* A unique integer value identifying this mentor category group.
|
|
825
|
+
*/
|
|
826
|
+
id: number;
|
|
827
|
+
org: string;
|
|
828
|
+
requestBody: MentorCategoryGroupCreate;
|
|
829
|
+
}): CancelablePromise<MentorCategoryGroupCreate>;
|
|
707
830
|
/**
|
|
708
831
|
* Mentor Category Groups offer parent grouping for mentor category objects.
|
|
709
832
|
*
|
|
@@ -712,14 +835,17 @@ export declare class AiMentorService {
|
|
|
712
835
|
* Permissions:
|
|
713
836
|
* GET: Accessible to both Platform Admins and Students
|
|
714
837
|
* POST, DELETE, PATCH, PUT: Accessible to only Platform Admins
|
|
715
|
-
* @param id A unique integer value identifying this mentor category group.
|
|
716
|
-
* @param org
|
|
717
|
-
* @param userId
|
|
718
|
-
* @param requestBody
|
|
719
838
|
* @returns MentorCategoryGroupCreate
|
|
720
839
|
* @throws ApiError
|
|
721
840
|
*/
|
|
722
|
-
static aiMentorOrgsUsersCategoryGroupsPartialUpdate(id
|
|
841
|
+
static aiMentorOrgsUsersCategoryGroupsPartialUpdate({ id, org, userId, requestBody, }: {
|
|
842
|
+
/**
|
|
843
|
+
* A unique integer value identifying this mentor category group.
|
|
844
|
+
*/
|
|
845
|
+
id: number;
|
|
846
|
+
org: string;
|
|
847
|
+
requestBody?: PatchedMentorCategoryGroupCreate;
|
|
848
|
+
}): CancelablePromise<MentorCategoryGroupCreate>;
|
|
723
849
|
/**
|
|
724
850
|
* Mentor Category Groups offer parent grouping for mentor category objects.
|
|
725
851
|
*
|
|
@@ -728,13 +854,16 @@ export declare class AiMentorService {
|
|
|
728
854
|
* Permissions:
|
|
729
855
|
* GET: Accessible to both Platform Admins and Students
|
|
730
856
|
* POST, DELETE, PATCH, PUT: Accessible to only Platform Admins
|
|
731
|
-
* @param id A unique integer value identifying this mentor category group.
|
|
732
|
-
* @param org
|
|
733
|
-
* @param userId
|
|
734
857
|
* @returns void
|
|
735
858
|
* @throws ApiError
|
|
736
859
|
*/
|
|
737
|
-
static aiMentorOrgsUsersCategoryGroupsDestroy(id
|
|
860
|
+
static aiMentorOrgsUsersCategoryGroupsDestroy({ id, org, userId, }: {
|
|
861
|
+
/**
|
|
862
|
+
* A unique integer value identifying this mentor category group.
|
|
863
|
+
*/
|
|
864
|
+
id: number;
|
|
865
|
+
org: string;
|
|
866
|
+
}): CancelablePromise<void>;
|
|
738
867
|
/**
|
|
739
868
|
* Retrieve and clean up vector results from a specific session.
|
|
740
869
|
*
|
|
@@ -754,13 +883,13 @@ export declare class AiMentorService {
|
|
|
754
883
|
* Raises:
|
|
755
884
|
* BadRequest: If the API key for the cleaning provider is not found.
|
|
756
885
|
* NotFound: If no vector results are found for the session.
|
|
757
|
-
* @param org
|
|
758
|
-
* @param sessionId
|
|
759
|
-
* @param userId
|
|
760
886
|
* @returns VectorResult
|
|
761
887
|
* @throws ApiError
|
|
762
888
|
*/
|
|
763
|
-
static aiMentorOrgsUsersCleanVectorResultsList(org
|
|
889
|
+
static aiMentorOrgsUsersCleanVectorResultsList({ org, sessionId, userId, }: {
|
|
890
|
+
org: string;
|
|
891
|
+
sessionId: string;
|
|
892
|
+
}): CancelablePromise<Array<VectorResult>>;
|
|
764
893
|
/**
|
|
765
894
|
* Clean up provided vector results.
|
|
766
895
|
*
|
|
@@ -777,80 +906,96 @@ export declare class AiMentorService {
|
|
|
777
906
|
*
|
|
778
907
|
* Raises:
|
|
779
908
|
* BadRequest: If the API key for the cleaning provider is not found or the provided data is invalid.
|
|
780
|
-
* @param org
|
|
781
|
-
* @param sessionId
|
|
782
|
-
* @param userId
|
|
783
|
-
* @param requestBody
|
|
784
909
|
* @returns VectorResult
|
|
785
910
|
* @throws ApiError
|
|
786
911
|
*/
|
|
787
|
-
static aiMentorOrgsUsersCleanVectorResultsCreate(org
|
|
912
|
+
static aiMentorOrgsUsersCleanVectorResultsCreate({ org, sessionId, userId, requestBody, }: {
|
|
913
|
+
org: string;
|
|
914
|
+
sessionId: string;
|
|
915
|
+
requestBody: Array<VectorResult>;
|
|
916
|
+
}): CancelablePromise<Array<VectorResult>>;
|
|
788
917
|
/**
|
|
789
918
|
* Delete User Chat History
|
|
790
919
|
* Endpoint to clear a user's chat history.
|
|
791
|
-
* @param org
|
|
792
|
-
* @param userId
|
|
793
920
|
* @returns void
|
|
794
921
|
* @throws ApiError
|
|
795
922
|
*/
|
|
796
|
-
static aiMentorOrgsUsersClearChathistoryDestroy(org
|
|
923
|
+
static aiMentorOrgsUsersClearChathistoryDestroy({ org, userId, }: {
|
|
924
|
+
org: string;
|
|
925
|
+
}): CancelablePromise<void>;
|
|
797
926
|
/**
|
|
798
927
|
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
799
|
-
* @param org
|
|
800
|
-
* @param userId
|
|
801
|
-
* @param page A page number within the paginated result set.
|
|
802
|
-
* @param pageSize Number of results to return per page.
|
|
803
928
|
* @returns PaginatedCourseCreationTaskFileList
|
|
804
929
|
* @throws ApiError
|
|
805
930
|
*/
|
|
806
|
-
static aiMentorOrgsUsersCourseCreationTaskFilesList(org
|
|
931
|
+
static aiMentorOrgsUsersCourseCreationTaskFilesList({ org, userId, page, pageSize, }: {
|
|
932
|
+
org: string; /**
|
|
933
|
+
* A page number within the paginated result set.
|
|
934
|
+
*/
|
|
935
|
+
page?: number; /**
|
|
936
|
+
* Number of results to return per page.
|
|
937
|
+
*/
|
|
938
|
+
pageSize?: number;
|
|
939
|
+
}): CancelablePromise<PaginatedCourseCreationTaskFileList>;
|
|
807
940
|
/**
|
|
808
941
|
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
809
|
-
* @param org
|
|
810
|
-
* @param userId
|
|
811
|
-
* @param formData
|
|
812
942
|
* @returns CourseCreationTaskFile
|
|
813
943
|
* @throws ApiError
|
|
814
944
|
*/
|
|
815
|
-
static aiMentorOrgsUsersCourseCreationTaskFilesCreate(org
|
|
945
|
+
static aiMentorOrgsUsersCourseCreationTaskFilesCreate({ org, userId, formData, }: {
|
|
946
|
+
org: string;
|
|
947
|
+
formData: CourseCreationTaskFile;
|
|
948
|
+
}): CancelablePromise<CourseCreationTaskFile>;
|
|
816
949
|
/**
|
|
817
950
|
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
818
|
-
* @param id A unique integer value identifying this course creation task file.
|
|
819
|
-
* @param org
|
|
820
|
-
* @param userId
|
|
821
951
|
* @returns CourseCreationTaskFile
|
|
822
952
|
* @throws ApiError
|
|
823
953
|
*/
|
|
824
|
-
static aiMentorOrgsUsersCourseCreationTaskFilesRetrieve(id
|
|
954
|
+
static aiMentorOrgsUsersCourseCreationTaskFilesRetrieve({ id, org, userId, }: {
|
|
955
|
+
/**
|
|
956
|
+
* A unique integer value identifying this course creation task file.
|
|
957
|
+
*/
|
|
958
|
+
id: number;
|
|
959
|
+
org: string;
|
|
960
|
+
}): CancelablePromise<CourseCreationTaskFile>;
|
|
825
961
|
/**
|
|
826
962
|
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
827
|
-
* @param id A unique integer value identifying this course creation task file.
|
|
828
|
-
* @param org
|
|
829
|
-
* @param userId
|
|
830
|
-
* @param formData
|
|
831
963
|
* @returns CourseCreationTaskFile
|
|
832
964
|
* @throws ApiError
|
|
833
965
|
*/
|
|
834
|
-
static aiMentorOrgsUsersCourseCreationTaskFilesUpdate(id
|
|
966
|
+
static aiMentorOrgsUsersCourseCreationTaskFilesUpdate({ id, org, userId, formData, }: {
|
|
967
|
+
/**
|
|
968
|
+
* A unique integer value identifying this course creation task file.
|
|
969
|
+
*/
|
|
970
|
+
id: number;
|
|
971
|
+
org: string;
|
|
972
|
+
formData: CourseCreationTaskFile;
|
|
973
|
+
}): CancelablePromise<CourseCreationTaskFile>;
|
|
835
974
|
/**
|
|
836
975
|
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
837
|
-
* @param id A unique integer value identifying this course creation task file.
|
|
838
|
-
* @param org
|
|
839
|
-
* @param userId
|
|
840
|
-
* @param formData
|
|
841
976
|
* @returns CourseCreationTaskFile
|
|
842
977
|
* @throws ApiError
|
|
843
978
|
*/
|
|
844
|
-
static aiMentorOrgsUsersCourseCreationTaskFilesPartialUpdate(id
|
|
979
|
+
static aiMentorOrgsUsersCourseCreationTaskFilesPartialUpdate({ id, org, userId, formData, }: {
|
|
980
|
+
/**
|
|
981
|
+
* A unique integer value identifying this course creation task file.
|
|
982
|
+
*/
|
|
983
|
+
id: number;
|
|
984
|
+
org: string;
|
|
985
|
+
formData?: PatchedCourseCreationTaskFile;
|
|
986
|
+
}): CancelablePromise<CourseCreationTaskFile>;
|
|
845
987
|
/**
|
|
846
988
|
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
847
|
-
* @param id A unique integer value identifying this course creation task file.
|
|
848
|
-
* @param org
|
|
849
|
-
* @param userId
|
|
850
989
|
* @returns void
|
|
851
990
|
* @throws ApiError
|
|
852
991
|
*/
|
|
853
|
-
static aiMentorOrgsUsersCourseCreationTaskFilesDestroy(id
|
|
992
|
+
static aiMentorOrgsUsersCourseCreationTaskFilesDestroy({ id, org, userId, }: {
|
|
993
|
+
/**
|
|
994
|
+
* A unique integer value identifying this course creation task file.
|
|
995
|
+
*/
|
|
996
|
+
id: number;
|
|
997
|
+
org: string;
|
|
998
|
+
}): CancelablePromise<void>;
|
|
854
999
|
/**
|
|
855
1000
|
* Create, retrieve and delete course creation tasks
|
|
856
1001
|
*
|
|
@@ -862,14 +1007,18 @@ export declare class AiMentorService {
|
|
|
862
1007
|
* Bigger and newer models tend to outperform smaller once.
|
|
863
1008
|
*
|
|
864
1009
|
* Clear and unambiguous parameters are more likely to produce better results.
|
|
865
|
-
* @param org
|
|
866
|
-
* @param userId
|
|
867
|
-
* @param page A page number within the paginated result set.
|
|
868
|
-
* @param pageSize Number of results to return per page.
|
|
869
1010
|
* @returns PaginatedCourseCreationTaskList
|
|
870
1011
|
* @throws ApiError
|
|
871
1012
|
*/
|
|
872
|
-
static aiMentorOrgsUsersCourseCreationTasksList(org
|
|
1013
|
+
static aiMentorOrgsUsersCourseCreationTasksList({ org, userId, page, pageSize, }: {
|
|
1014
|
+
org: string; /**
|
|
1015
|
+
* A page number within the paginated result set.
|
|
1016
|
+
*/
|
|
1017
|
+
page?: number; /**
|
|
1018
|
+
* Number of results to return per page.
|
|
1019
|
+
*/
|
|
1020
|
+
pageSize?: number;
|
|
1021
|
+
}): CancelablePromise<PaginatedCourseCreationTaskList>;
|
|
873
1022
|
/**
|
|
874
1023
|
* Create, retrieve and delete course creation tasks
|
|
875
1024
|
*
|
|
@@ -881,13 +1030,13 @@ export declare class AiMentorService {
|
|
|
881
1030
|
* Bigger and newer models tend to outperform smaller once.
|
|
882
1031
|
*
|
|
883
1032
|
* Clear and unambiguous parameters are more likely to produce better results.
|
|
884
|
-
* @param org
|
|
885
|
-
* @param userId
|
|
886
|
-
* @param formData
|
|
887
1033
|
* @returns CourseCreationTask
|
|
888
1034
|
* @throws ApiError
|
|
889
1035
|
*/
|
|
890
|
-
static aiMentorOrgsUsersCourseCreationTasksCreate(org
|
|
1036
|
+
static aiMentorOrgsUsersCourseCreationTasksCreate({ org, userId, formData, }: {
|
|
1037
|
+
org: string;
|
|
1038
|
+
formData: CourseCreationTask;
|
|
1039
|
+
}): CancelablePromise<CourseCreationTask>;
|
|
891
1040
|
/**
|
|
892
1041
|
* Create, retrieve and delete course creation tasks
|
|
893
1042
|
*
|
|
@@ -899,13 +1048,16 @@ export declare class AiMentorService {
|
|
|
899
1048
|
* Bigger and newer models tend to outperform smaller once.
|
|
900
1049
|
*
|
|
901
1050
|
* Clear and unambiguous parameters are more likely to produce better results.
|
|
902
|
-
* @param id A unique integer value identifying this course creation task.
|
|
903
|
-
* @param org
|
|
904
|
-
* @param userId
|
|
905
1051
|
* @returns CourseCreationTask
|
|
906
1052
|
* @throws ApiError
|
|
907
1053
|
*/
|
|
908
|
-
static aiMentorOrgsUsersCourseCreationTasksRetrieve(id
|
|
1054
|
+
static aiMentorOrgsUsersCourseCreationTasksRetrieve({ id, org, userId, }: {
|
|
1055
|
+
/**
|
|
1056
|
+
* A unique integer value identifying this course creation task.
|
|
1057
|
+
*/
|
|
1058
|
+
id: number;
|
|
1059
|
+
org: string;
|
|
1060
|
+
}): CancelablePromise<CourseCreationTask>;
|
|
909
1061
|
/**
|
|
910
1062
|
* Create, retrieve and delete course creation tasks
|
|
911
1063
|
*
|
|
@@ -917,13 +1069,16 @@ export declare class AiMentorService {
|
|
|
917
1069
|
* Bigger and newer models tend to outperform smaller once.
|
|
918
1070
|
*
|
|
919
1071
|
* Clear and unambiguous parameters are more likely to produce better results.
|
|
920
|
-
* @param id A unique integer value identifying this course creation task.
|
|
921
|
-
* @param org
|
|
922
|
-
* @param userId
|
|
923
1072
|
* @returns void
|
|
924
1073
|
* @throws ApiError
|
|
925
1074
|
*/
|
|
926
|
-
static aiMentorOrgsUsersCourseCreationTasksDestroy(id
|
|
1075
|
+
static aiMentorOrgsUsersCourseCreationTasksDestroy({ id, org, userId, }: {
|
|
1076
|
+
/**
|
|
1077
|
+
* A unique integer value identifying this course creation task.
|
|
1078
|
+
*/
|
|
1079
|
+
id: number;
|
|
1080
|
+
org: string;
|
|
1081
|
+
}): CancelablePromise<void>;
|
|
927
1082
|
/**
|
|
928
1083
|
* Cancel a course creation task run.
|
|
929
1084
|
* ** Conditions Required **:
|
|
@@ -931,36 +1086,45 @@ export declare class AiMentorService {
|
|
|
931
1086
|
* ** Response **:
|
|
932
1087
|
* - 200: The course creation task is successfully cancelled.
|
|
933
1088
|
* - 400: The course creation task is not in a running or pending state.
|
|
934
|
-
* @param id A unique integer value identifying this course creation task.
|
|
935
|
-
* @param org
|
|
936
|
-
* @param userId
|
|
937
1089
|
* @returns CourseCreationTask
|
|
938
1090
|
* @throws ApiError
|
|
939
1091
|
*/
|
|
940
|
-
static aiMentorOrgsUsersCourseCreationTasksCancelRetrieve(id
|
|
1092
|
+
static aiMentorOrgsUsersCourseCreationTasksCancelRetrieve({ id, org, userId, }: {
|
|
1093
|
+
/**
|
|
1094
|
+
* A unique integer value identifying this course creation task.
|
|
1095
|
+
*/
|
|
1096
|
+
id: number;
|
|
1097
|
+
org: string;
|
|
1098
|
+
}): CancelablePromise<CourseCreationTask>;
|
|
941
1099
|
/**
|
|
942
1100
|
* This is intended for stepwise approach of course creation.
|
|
943
1101
|
*
|
|
944
1102
|
* Use this to intiate generating an outline of the course.
|
|
945
|
-
* @param id A unique integer value identifying this course creation task.
|
|
946
|
-
* @param org
|
|
947
|
-
* @param userId
|
|
948
1103
|
* @returns FullCourse
|
|
949
1104
|
* @throws ApiError
|
|
950
1105
|
*/
|
|
951
|
-
static aiMentorOrgsUsersCourseCreationTasksCreateCourseOutlineRetrieve(id
|
|
1106
|
+
static aiMentorOrgsUsersCourseCreationTasksCreateCourseOutlineRetrieve({ id, org, userId, }: {
|
|
1107
|
+
/**
|
|
1108
|
+
* A unique integer value identifying this course creation task.
|
|
1109
|
+
*/
|
|
1110
|
+
id: number;
|
|
1111
|
+
org: string;
|
|
1112
|
+
}): CancelablePromise<FullCourse>;
|
|
952
1113
|
/**
|
|
953
1114
|
* This is intended for stepwise approach of course creation.
|
|
954
1115
|
*
|
|
955
1116
|
* Use this to intiate generating an outline of the course.
|
|
956
|
-
* @param id A unique integer value identifying this course creation task.
|
|
957
|
-
* @param org
|
|
958
|
-
* @param userId
|
|
959
|
-
* @param formData
|
|
960
1117
|
* @returns FullCourse
|
|
961
1118
|
* @throws ApiError
|
|
962
1119
|
*/
|
|
963
|
-
static aiMentorOrgsUsersCourseCreationTasksCreateCourseOutlineCreate(id
|
|
1120
|
+
static aiMentorOrgsUsersCourseCreationTasksCreateCourseOutlineCreate({ id, org, userId, formData, }: {
|
|
1121
|
+
/**
|
|
1122
|
+
* A unique integer value identifying this course creation task.
|
|
1123
|
+
*/
|
|
1124
|
+
id: number;
|
|
1125
|
+
org: string;
|
|
1126
|
+
formData: CourseCreationTask;
|
|
1127
|
+
}): CancelablePromise<FullCourse>;
|
|
964
1128
|
/**
|
|
965
1129
|
* Kick start the course creation task.
|
|
966
1130
|
* This endpoint should be called once the files for a course creation task has
|
|
@@ -972,13 +1136,16 @@ export declare class AiMentorService {
|
|
|
972
1136
|
* ** Response **:
|
|
973
1137
|
* - 200: The course creation task is successfully started.
|
|
974
1138
|
* - 400: The course creation task is not in a pending state.
|
|
975
|
-
* @param id A unique integer value identifying this course creation task.
|
|
976
|
-
* @param org
|
|
977
|
-
* @param userId
|
|
978
1139
|
* @returns CourseCreationTask
|
|
979
1140
|
* @throws ApiError
|
|
980
1141
|
*/
|
|
981
|
-
static aiMentorOrgsUsersCourseCreationTasksStartRetrieve(id
|
|
1142
|
+
static aiMentorOrgsUsersCourseCreationTasksStartRetrieve({ id, org, userId, }: {
|
|
1143
|
+
/**
|
|
1144
|
+
* A unique integer value identifying this course creation task.
|
|
1145
|
+
*/
|
|
1146
|
+
id: number;
|
|
1147
|
+
org: string;
|
|
1148
|
+
}): CancelablePromise<CourseCreationTask>;
|
|
982
1149
|
/**
|
|
983
1150
|
* API viewset for managing course units.
|
|
984
1151
|
*
|
|
@@ -987,20 +1154,28 @@ export declare class AiMentorService {
|
|
|
987
1154
|
*
|
|
988
1155
|
* Permissions:
|
|
989
1156
|
* - Restricted to platform administrators only
|
|
990
|
-
* @param org
|
|
991
|
-
* @param userId
|
|
992
|
-
* @param course
|
|
993
|
-
* @param ordering Which field to use when ordering the results.
|
|
994
|
-
* @param page A page number within the paginated result set.
|
|
995
|
-
* @param pageSize Number of results to return per page.
|
|
996
|
-
* @param search A search term.
|
|
997
|
-
* @param section
|
|
998
|
-
* @param subsection
|
|
999
|
-
* @param task
|
|
1000
1157
|
* @returns PaginatedUnitList
|
|
1001
1158
|
* @throws ApiError
|
|
1002
1159
|
*/
|
|
1003
|
-
static aiMentorOrgsUsersCourseCreationComponentList(org
|
|
1160
|
+
static aiMentorOrgsUsersCourseCreationComponentList({ org, userId, course, ordering, page, pageSize, search, section, subsection, task, }: {
|
|
1161
|
+
org: string;
|
|
1162
|
+
course?: number; /**
|
|
1163
|
+
* Which field to use when ordering the results.
|
|
1164
|
+
*/
|
|
1165
|
+
ordering?: string; /**
|
|
1166
|
+
* A page number within the paginated result set.
|
|
1167
|
+
*/
|
|
1168
|
+
page?: number; /**
|
|
1169
|
+
* Number of results to return per page.
|
|
1170
|
+
*/
|
|
1171
|
+
pageSize?: number; /**
|
|
1172
|
+
* A search term.
|
|
1173
|
+
*/
|
|
1174
|
+
search?: string;
|
|
1175
|
+
section?: number;
|
|
1176
|
+
subsection?: number;
|
|
1177
|
+
task?: number;
|
|
1178
|
+
}): CancelablePromise<PaginatedUnitList>;
|
|
1004
1179
|
/**
|
|
1005
1180
|
* API viewset for managing course units.
|
|
1006
1181
|
*
|
|
@@ -1009,13 +1184,13 @@ export declare class AiMentorService {
|
|
|
1009
1184
|
*
|
|
1010
1185
|
* Permissions:
|
|
1011
1186
|
* - Restricted to platform administrators only
|
|
1012
|
-
* @param org
|
|
1013
|
-
* @param userId
|
|
1014
|
-
* @param requestBody
|
|
1015
1187
|
* @returns Unit
|
|
1016
1188
|
* @throws ApiError
|
|
1017
1189
|
*/
|
|
1018
|
-
static aiMentorOrgsUsersCourseCreationComponentCreate(org
|
|
1190
|
+
static aiMentorOrgsUsersCourseCreationComponentCreate({ org, userId, requestBody, }: {
|
|
1191
|
+
org: string;
|
|
1192
|
+
requestBody: Unit;
|
|
1193
|
+
}): CancelablePromise<Unit>;
|
|
1019
1194
|
/**
|
|
1020
1195
|
* API viewset for managing course units.
|
|
1021
1196
|
*
|
|
@@ -1024,13 +1199,16 @@ export declare class AiMentorService {
|
|
|
1024
1199
|
*
|
|
1025
1200
|
* Permissions:
|
|
1026
1201
|
* - Restricted to platform administrators only
|
|
1027
|
-
* @param id A unique integer value identifying this unit.
|
|
1028
|
-
* @param org
|
|
1029
|
-
* @param userId
|
|
1030
1202
|
* @returns Unit
|
|
1031
1203
|
* @throws ApiError
|
|
1032
1204
|
*/
|
|
1033
|
-
static aiMentorOrgsUsersCourseCreationComponentRetrieve(id
|
|
1205
|
+
static aiMentorOrgsUsersCourseCreationComponentRetrieve({ id, org, userId, }: {
|
|
1206
|
+
/**
|
|
1207
|
+
* A unique integer value identifying this unit.
|
|
1208
|
+
*/
|
|
1209
|
+
id: number;
|
|
1210
|
+
org: string;
|
|
1211
|
+
}): CancelablePromise<Unit>;
|
|
1034
1212
|
/**
|
|
1035
1213
|
* API viewset for managing course units.
|
|
1036
1214
|
*
|
|
@@ -1039,14 +1217,17 @@ export declare class AiMentorService {
|
|
|
1039
1217
|
*
|
|
1040
1218
|
* Permissions:
|
|
1041
1219
|
* - Restricted to platform administrators only
|
|
1042
|
-
* @param id A unique integer value identifying this unit.
|
|
1043
|
-
* @param org
|
|
1044
|
-
* @param userId
|
|
1045
|
-
* @param requestBody
|
|
1046
1220
|
* @returns Unit
|
|
1047
1221
|
* @throws ApiError
|
|
1048
1222
|
*/
|
|
1049
|
-
static aiMentorOrgsUsersCourseCreationComponentUpdate(id
|
|
1223
|
+
static aiMentorOrgsUsersCourseCreationComponentUpdate({ id, org, userId, requestBody, }: {
|
|
1224
|
+
/**
|
|
1225
|
+
* A unique integer value identifying this unit.
|
|
1226
|
+
*/
|
|
1227
|
+
id: number;
|
|
1228
|
+
org: string;
|
|
1229
|
+
requestBody: Unit;
|
|
1230
|
+
}): CancelablePromise<Unit>;
|
|
1050
1231
|
/**
|
|
1051
1232
|
* API viewset for managing course units.
|
|
1052
1233
|
*
|
|
@@ -1055,14 +1236,17 @@ export declare class AiMentorService {
|
|
|
1055
1236
|
*
|
|
1056
1237
|
* Permissions:
|
|
1057
1238
|
* - Restricted to platform administrators only
|
|
1058
|
-
* @param id A unique integer value identifying this unit.
|
|
1059
|
-
* @param org
|
|
1060
|
-
* @param userId
|
|
1061
|
-
* @param requestBody
|
|
1062
1239
|
* @returns Unit
|
|
1063
1240
|
* @throws ApiError
|
|
1064
1241
|
*/
|
|
1065
|
-
static aiMentorOrgsUsersCourseCreationComponentPartialUpdate(id
|
|
1242
|
+
static aiMentorOrgsUsersCourseCreationComponentPartialUpdate({ id, org, userId, requestBody, }: {
|
|
1243
|
+
/**
|
|
1244
|
+
* A unique integer value identifying this unit.
|
|
1245
|
+
*/
|
|
1246
|
+
id: number;
|
|
1247
|
+
org: string;
|
|
1248
|
+
requestBody?: PatchedUnit;
|
|
1249
|
+
}): CancelablePromise<Unit>;
|
|
1066
1250
|
/**
|
|
1067
1251
|
* API viewset for managing course units.
|
|
1068
1252
|
*
|
|
@@ -1071,13 +1255,16 @@ export declare class AiMentorService {
|
|
|
1071
1255
|
*
|
|
1072
1256
|
* Permissions:
|
|
1073
1257
|
* - Restricted to platform administrators only
|
|
1074
|
-
* @param id A unique integer value identifying this unit.
|
|
1075
|
-
* @param org
|
|
1076
|
-
* @param userId
|
|
1077
1258
|
* @returns void
|
|
1078
1259
|
* @throws ApiError
|
|
1079
1260
|
*/
|
|
1080
|
-
static aiMentorOrgsUsersCourseCreationComponentDestroy(id
|
|
1261
|
+
static aiMentorOrgsUsersCourseCreationComponentDestroy({ id, org, userId, }: {
|
|
1262
|
+
/**
|
|
1263
|
+
* A unique integer value identifying this unit.
|
|
1264
|
+
*/
|
|
1265
|
+
id: number;
|
|
1266
|
+
org: string;
|
|
1267
|
+
}): CancelablePromise<void>;
|
|
1081
1268
|
/**
|
|
1082
1269
|
* Generate draft content for a specific unit.
|
|
1083
1270
|
*
|
|
@@ -1093,13 +1280,16 @@ export declare class AiMentorService {
|
|
|
1093
1280
|
*
|
|
1094
1281
|
* Raises:
|
|
1095
1282
|
* NotFound: If the specified unit does not exist.
|
|
1096
|
-
* @param id A unique integer value identifying this unit.
|
|
1097
|
-
* @param org
|
|
1098
|
-
* @param userId
|
|
1099
1283
|
* @returns any Content creation started successfully
|
|
1100
1284
|
* @throws ApiError
|
|
1101
1285
|
*/
|
|
1102
|
-
static aiMentorOrgsUsersCourseCreationComponentDraftContentRetrieve(id
|
|
1286
|
+
static aiMentorOrgsUsersCourseCreationComponentDraftContentRetrieve({ id, org, userId, }: {
|
|
1287
|
+
/**
|
|
1288
|
+
* A unique integer value identifying this unit.
|
|
1289
|
+
*/
|
|
1290
|
+
id: number;
|
|
1291
|
+
org: string;
|
|
1292
|
+
}): CancelablePromise<any>;
|
|
1103
1293
|
/**
|
|
1104
1294
|
* Generate draft content for a specific unit.
|
|
1105
1295
|
*
|
|
@@ -1115,14 +1305,17 @@ export declare class AiMentorService {
|
|
|
1115
1305
|
*
|
|
1116
1306
|
* Raises:
|
|
1117
1307
|
* NotFound: If the specified unit does not exist.
|
|
1118
|
-
* @param id A unique integer value identifying this unit.
|
|
1119
|
-
* @param org
|
|
1120
|
-
* @param userId
|
|
1121
|
-
* @param requestBody
|
|
1122
1308
|
* @returns any Content creation started successfully
|
|
1123
1309
|
* @throws ApiError
|
|
1124
1310
|
*/
|
|
1125
|
-
static aiMentorOrgsUsersCourseCreationComponentDraftContentCreate(id
|
|
1311
|
+
static aiMentorOrgsUsersCourseCreationComponentDraftContentCreate({ id, org, userId, requestBody, }: {
|
|
1312
|
+
/**
|
|
1313
|
+
* A unique integer value identifying this unit.
|
|
1314
|
+
*/
|
|
1315
|
+
id: number;
|
|
1316
|
+
org: string;
|
|
1317
|
+
requestBody: Unit;
|
|
1318
|
+
}): CancelablePromise<any>;
|
|
1126
1319
|
/**
|
|
1127
1320
|
* API viewset for managing EdX courses.
|
|
1128
1321
|
*
|
|
@@ -1132,17 +1325,25 @@ export declare class AiMentorService {
|
|
|
1132
1325
|
*
|
|
1133
1326
|
* Permissions:
|
|
1134
1327
|
* - Restricted to platform administrators only
|
|
1135
|
-
* @param org
|
|
1136
|
-
* @param userId
|
|
1137
|
-
* @param ordering Which field to use when ordering the results.
|
|
1138
|
-
* @param page A page number within the paginated result set.
|
|
1139
|
-
* @param pageSize Number of results to return per page.
|
|
1140
|
-
* @param search A search term.
|
|
1141
|
-
* @param task
|
|
1142
1328
|
* @returns PaginatedEdxCourseList
|
|
1143
1329
|
* @throws ApiError
|
|
1144
1330
|
*/
|
|
1145
|
-
static aiMentorOrgsUsersCourseCreationCourseList(org
|
|
1331
|
+
static aiMentorOrgsUsersCourseCreationCourseList({ org, userId, ordering, page, pageSize, search, task, }: {
|
|
1332
|
+
org: string; /**
|
|
1333
|
+
* Which field to use when ordering the results.
|
|
1334
|
+
*/
|
|
1335
|
+
ordering?: string; /**
|
|
1336
|
+
* A page number within the paginated result set.
|
|
1337
|
+
*/
|
|
1338
|
+
page?: number; /**
|
|
1339
|
+
* Number of results to return per page.
|
|
1340
|
+
*/
|
|
1341
|
+
pageSize?: number; /**
|
|
1342
|
+
* A search term.
|
|
1343
|
+
*/
|
|
1344
|
+
search?: string;
|
|
1345
|
+
task?: number;
|
|
1346
|
+
}): CancelablePromise<PaginatedEdxCourseList>;
|
|
1146
1347
|
/**
|
|
1147
1348
|
* API viewset for managing EdX courses.
|
|
1148
1349
|
*
|
|
@@ -1152,13 +1353,16 @@ export declare class AiMentorService {
|
|
|
1152
1353
|
*
|
|
1153
1354
|
* Permissions:
|
|
1154
1355
|
* - Restricted to platform administrators only
|
|
1155
|
-
* @param id A unique integer value identifying this edx course.
|
|
1156
|
-
* @param org
|
|
1157
|
-
* @param userId
|
|
1158
1356
|
* @returns EdxCourse
|
|
1159
1357
|
* @throws ApiError
|
|
1160
1358
|
*/
|
|
1161
|
-
static aiMentorOrgsUsersCourseCreationCourseRetrieve(id
|
|
1359
|
+
static aiMentorOrgsUsersCourseCreationCourseRetrieve({ id, org, userId, }: {
|
|
1360
|
+
/**
|
|
1361
|
+
* A unique integer value identifying this edx course.
|
|
1362
|
+
*/
|
|
1363
|
+
id: number;
|
|
1364
|
+
org: string;
|
|
1365
|
+
}): CancelablePromise<EdxCourse>;
|
|
1162
1366
|
/**
|
|
1163
1367
|
* API viewset for managing EdX courses.
|
|
1164
1368
|
*
|
|
@@ -1168,13 +1372,16 @@ export declare class AiMentorService {
|
|
|
1168
1372
|
*
|
|
1169
1373
|
* Permissions:
|
|
1170
1374
|
* - Restricted to platform administrators only
|
|
1171
|
-
* @param id A unique integer value identifying this edx course.
|
|
1172
|
-
* @param org
|
|
1173
|
-
* @param userId
|
|
1174
1375
|
* @returns void
|
|
1175
1376
|
* @throws ApiError
|
|
1176
1377
|
*/
|
|
1177
|
-
static aiMentorOrgsUsersCourseCreationCourseDestroy(id
|
|
1378
|
+
static aiMentorOrgsUsersCourseCreationCourseDestroy({ id, org, userId, }: {
|
|
1379
|
+
/**
|
|
1380
|
+
* A unique integer value identifying this edx course.
|
|
1381
|
+
*/
|
|
1382
|
+
id: number;
|
|
1383
|
+
org: string;
|
|
1384
|
+
}): CancelablePromise<void>;
|
|
1178
1385
|
/**
|
|
1179
1386
|
* Generate draft content for all units in a course.
|
|
1180
1387
|
*
|
|
@@ -1190,13 +1397,16 @@ export declare class AiMentorService {
|
|
|
1190
1397
|
*
|
|
1191
1398
|
* Raises:
|
|
1192
1399
|
* NotFound: If the specified course does not exist.
|
|
1193
|
-
* @param id A unique integer value identifying this edx course.
|
|
1194
|
-
* @param org
|
|
1195
|
-
* @param userId
|
|
1196
1400
|
* @returns any Content creation started successfully
|
|
1197
1401
|
* @throws ApiError
|
|
1198
1402
|
*/
|
|
1199
|
-
static aiMentorOrgsUsersCourseCreationCourseDraftContentForAllUnitsRetrieve(id
|
|
1403
|
+
static aiMentorOrgsUsersCourseCreationCourseDraftContentForAllUnitsRetrieve({ id, org, userId, }: {
|
|
1404
|
+
/**
|
|
1405
|
+
* A unique integer value identifying this edx course.
|
|
1406
|
+
*/
|
|
1407
|
+
id: number;
|
|
1408
|
+
org: string;
|
|
1409
|
+
}): CancelablePromise<any>;
|
|
1200
1410
|
/**
|
|
1201
1411
|
* Retrieve the full structure of a course.
|
|
1202
1412
|
*
|
|
@@ -1212,13 +1422,16 @@ export declare class AiMentorService {
|
|
|
1212
1422
|
*
|
|
1213
1423
|
* Raises:
|
|
1214
1424
|
* NotFound: If the specified course does not exist.
|
|
1215
|
-
* @param id A unique integer value identifying this edx course.
|
|
1216
|
-
* @param org
|
|
1217
|
-
* @param userId
|
|
1218
1425
|
* @returns FullCourse
|
|
1219
1426
|
* @throws ApiError
|
|
1220
1427
|
*/
|
|
1221
|
-
static aiMentorOrgsUsersCourseCreationCourseFullStructureRetrieve(id
|
|
1428
|
+
static aiMentorOrgsUsersCourseCreationCourseFullStructureRetrieve({ id, org, userId, }: {
|
|
1429
|
+
/**
|
|
1430
|
+
* A unique integer value identifying this edx course.
|
|
1431
|
+
*/
|
|
1432
|
+
id: number;
|
|
1433
|
+
org: string;
|
|
1434
|
+
}): CancelablePromise<FullCourse>;
|
|
1222
1435
|
/**
|
|
1223
1436
|
* Load existing course structure from OpenEdX.
|
|
1224
1437
|
*
|
|
@@ -1234,13 +1447,16 @@ export declare class AiMentorService {
|
|
|
1234
1447
|
*
|
|
1235
1448
|
* Raises:
|
|
1236
1449
|
* NotFound: If the specified course does not exist.
|
|
1237
|
-
* @param id A unique integer value identifying this edx course.
|
|
1238
|
-
* @param org
|
|
1239
|
-
* @param userId
|
|
1240
1450
|
* @returns any Course load started successfully
|
|
1241
1451
|
* @throws ApiError
|
|
1242
1452
|
*/
|
|
1243
|
-
static aiMentorOrgsUsersCourseCreationCourseLoadFromEdxRetrieve(id
|
|
1453
|
+
static aiMentorOrgsUsersCourseCreationCourseLoadFromEdxRetrieve({ id, org, userId, }: {
|
|
1454
|
+
/**
|
|
1455
|
+
* A unique integer value identifying this edx course.
|
|
1456
|
+
*/
|
|
1457
|
+
id: number;
|
|
1458
|
+
org: string;
|
|
1459
|
+
}): CancelablePromise<any>;
|
|
1244
1460
|
/**
|
|
1245
1461
|
* Synchronize the course structure to EdX.
|
|
1246
1462
|
*
|
|
@@ -1256,70 +1472,89 @@ export declare class AiMentorService {
|
|
|
1256
1472
|
*
|
|
1257
1473
|
* Raises:
|
|
1258
1474
|
* NotFound: If the specified course does not exist.
|
|
1259
|
-
* @param id A unique integer value identifying this edx course.
|
|
1260
|
-
* @param org
|
|
1261
|
-
* @param userId
|
|
1262
1475
|
* @returns any Course sync started successfully
|
|
1263
1476
|
* @throws ApiError
|
|
1264
1477
|
*/
|
|
1265
|
-
static aiMentorOrgsUsersCourseCreationCourseSyncToEdxRetrieve(id
|
|
1478
|
+
static aiMentorOrgsUsersCourseCreationCourseSyncToEdxRetrieve({ id, org, userId, }: {
|
|
1479
|
+
/**
|
|
1480
|
+
* A unique integer value identifying this edx course.
|
|
1481
|
+
*/
|
|
1482
|
+
id: number;
|
|
1483
|
+
org: string;
|
|
1484
|
+
}): CancelablePromise<any>;
|
|
1266
1485
|
/**
|
|
1267
1486
|
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
1268
|
-
* @param org
|
|
1269
|
-
* @param userId
|
|
1270
|
-
* @param page A page number within the paginated result set.
|
|
1271
|
-
* @param pageSize Number of results to return per page.
|
|
1272
1487
|
* @returns PaginatedCourseCreationTaskFileList
|
|
1273
1488
|
* @throws ApiError
|
|
1274
1489
|
*/
|
|
1275
|
-
static aiMentorOrgsUsersCourseCreationFilesList(org
|
|
1490
|
+
static aiMentorOrgsUsersCourseCreationFilesList({ org, userId, page, pageSize, }: {
|
|
1491
|
+
org: string; /**
|
|
1492
|
+
* A page number within the paginated result set.
|
|
1493
|
+
*/
|
|
1494
|
+
page?: number; /**
|
|
1495
|
+
* Number of results to return per page.
|
|
1496
|
+
*/
|
|
1497
|
+
pageSize?: number;
|
|
1498
|
+
}): CancelablePromise<PaginatedCourseCreationTaskFileList>;
|
|
1276
1499
|
/**
|
|
1277
1500
|
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
1278
|
-
* @param org
|
|
1279
|
-
* @param userId
|
|
1280
|
-
* @param formData
|
|
1281
1501
|
* @returns CourseCreationTaskFile
|
|
1282
1502
|
* @throws ApiError
|
|
1283
1503
|
*/
|
|
1284
|
-
static aiMentorOrgsUsersCourseCreationFilesCreate(org
|
|
1504
|
+
static aiMentorOrgsUsersCourseCreationFilesCreate({ org, userId, formData, }: {
|
|
1505
|
+
org: string;
|
|
1506
|
+
formData: CourseCreationTaskFile;
|
|
1507
|
+
}): CancelablePromise<CourseCreationTaskFile>;
|
|
1285
1508
|
/**
|
|
1286
1509
|
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
1287
|
-
* @param id A unique integer value identifying this course creation task file.
|
|
1288
|
-
* @param org
|
|
1289
|
-
* @param userId
|
|
1290
1510
|
* @returns CourseCreationTaskFile
|
|
1291
1511
|
* @throws ApiError
|
|
1292
1512
|
*/
|
|
1293
|
-
static aiMentorOrgsUsersCourseCreationFilesRetrieve(id
|
|
1513
|
+
static aiMentorOrgsUsersCourseCreationFilesRetrieve({ id, org, userId, }: {
|
|
1514
|
+
/**
|
|
1515
|
+
* A unique integer value identifying this course creation task file.
|
|
1516
|
+
*/
|
|
1517
|
+
id: number;
|
|
1518
|
+
org: string;
|
|
1519
|
+
}): CancelablePromise<CourseCreationTaskFile>;
|
|
1294
1520
|
/**
|
|
1295
1521
|
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
1296
|
-
* @param id A unique integer value identifying this course creation task file.
|
|
1297
|
-
* @param org
|
|
1298
|
-
* @param userId
|
|
1299
|
-
* @param formData
|
|
1300
1522
|
* @returns CourseCreationTaskFile
|
|
1301
1523
|
* @throws ApiError
|
|
1302
1524
|
*/
|
|
1303
|
-
static aiMentorOrgsUsersCourseCreationFilesUpdate(id
|
|
1525
|
+
static aiMentorOrgsUsersCourseCreationFilesUpdate({ id, org, userId, formData, }: {
|
|
1526
|
+
/**
|
|
1527
|
+
* A unique integer value identifying this course creation task file.
|
|
1528
|
+
*/
|
|
1529
|
+
id: number;
|
|
1530
|
+
org: string;
|
|
1531
|
+
formData: CourseCreationTaskFile;
|
|
1532
|
+
}): CancelablePromise<CourseCreationTaskFile>;
|
|
1304
1533
|
/**
|
|
1305
1534
|
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
1306
|
-
* @param id A unique integer value identifying this course creation task file.
|
|
1307
|
-
* @param org
|
|
1308
|
-
* @param userId
|
|
1309
|
-
* @param formData
|
|
1310
1535
|
* @returns CourseCreationTaskFile
|
|
1311
1536
|
* @throws ApiError
|
|
1312
1537
|
*/
|
|
1313
|
-
static aiMentorOrgsUsersCourseCreationFilesPartialUpdate(id
|
|
1538
|
+
static aiMentorOrgsUsersCourseCreationFilesPartialUpdate({ id, org, userId, formData, }: {
|
|
1539
|
+
/**
|
|
1540
|
+
* A unique integer value identifying this course creation task file.
|
|
1541
|
+
*/
|
|
1542
|
+
id: number;
|
|
1543
|
+
org: string;
|
|
1544
|
+
formData?: PatchedCourseCreationTaskFile;
|
|
1545
|
+
}): CancelablePromise<CourseCreationTaskFile>;
|
|
1314
1546
|
/**
|
|
1315
1547
|
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
1316
|
-
* @param id A unique integer value identifying this course creation task file.
|
|
1317
|
-
* @param org
|
|
1318
|
-
* @param userId
|
|
1319
1548
|
* @returns void
|
|
1320
1549
|
* @throws ApiError
|
|
1321
1550
|
*/
|
|
1322
|
-
static aiMentorOrgsUsersCourseCreationFilesDestroy(id
|
|
1551
|
+
static aiMentorOrgsUsersCourseCreationFilesDestroy({ id, org, userId, }: {
|
|
1552
|
+
/**
|
|
1553
|
+
* A unique integer value identifying this course creation task file.
|
|
1554
|
+
*/
|
|
1555
|
+
id: number;
|
|
1556
|
+
org: string;
|
|
1557
|
+
}): CancelablePromise<void>;
|
|
1323
1558
|
/**
|
|
1324
1559
|
* API viewset for managing course sections.
|
|
1325
1560
|
*
|
|
@@ -1328,18 +1563,26 @@ export declare class AiMentorService {
|
|
|
1328
1563
|
*
|
|
1329
1564
|
* Permissions:
|
|
1330
1565
|
* - Restricted to platform administrators only
|
|
1331
|
-
* @param org
|
|
1332
|
-
* @param userId
|
|
1333
|
-
* @param course
|
|
1334
|
-
* @param ordering Which field to use when ordering the results.
|
|
1335
|
-
* @param page A page number within the paginated result set.
|
|
1336
|
-
* @param pageSize Number of results to return per page.
|
|
1337
|
-
* @param search A search term.
|
|
1338
|
-
* @param task
|
|
1339
1566
|
* @returns PaginatedSectionList
|
|
1340
1567
|
* @throws ApiError
|
|
1341
1568
|
*/
|
|
1342
|
-
static aiMentorOrgsUsersCourseCreationSectionList(org
|
|
1569
|
+
static aiMentorOrgsUsersCourseCreationSectionList({ org, userId, course, ordering, page, pageSize, search, task, }: {
|
|
1570
|
+
org: string;
|
|
1571
|
+
course?: number; /**
|
|
1572
|
+
* Which field to use when ordering the results.
|
|
1573
|
+
*/
|
|
1574
|
+
ordering?: string; /**
|
|
1575
|
+
* A page number within the paginated result set.
|
|
1576
|
+
*/
|
|
1577
|
+
page?: number; /**
|
|
1578
|
+
* Number of results to return per page.
|
|
1579
|
+
*/
|
|
1580
|
+
pageSize?: number; /**
|
|
1581
|
+
* A search term.
|
|
1582
|
+
*/
|
|
1583
|
+
search?: string;
|
|
1584
|
+
task?: number;
|
|
1585
|
+
}): CancelablePromise<PaginatedSectionList>;
|
|
1343
1586
|
/**
|
|
1344
1587
|
* API viewset for managing course sections.
|
|
1345
1588
|
*
|
|
@@ -1348,13 +1591,13 @@ export declare class AiMentorService {
|
|
|
1348
1591
|
*
|
|
1349
1592
|
* Permissions:
|
|
1350
1593
|
* - Restricted to platform administrators only
|
|
1351
|
-
* @param org
|
|
1352
|
-
* @param userId
|
|
1353
|
-
* @param requestBody
|
|
1354
1594
|
* @returns Section
|
|
1355
1595
|
* @throws ApiError
|
|
1356
1596
|
*/
|
|
1357
|
-
static aiMentorOrgsUsersCourseCreationSectionCreate(org
|
|
1597
|
+
static aiMentorOrgsUsersCourseCreationSectionCreate({ org, userId, requestBody, }: {
|
|
1598
|
+
org: string;
|
|
1599
|
+
requestBody: Section;
|
|
1600
|
+
}): CancelablePromise<Section>;
|
|
1358
1601
|
/**
|
|
1359
1602
|
* API viewset for managing course sections.
|
|
1360
1603
|
*
|
|
@@ -1363,13 +1606,16 @@ export declare class AiMentorService {
|
|
|
1363
1606
|
*
|
|
1364
1607
|
* Permissions:
|
|
1365
1608
|
* - Restricted to platform administrators only
|
|
1366
|
-
* @param id A unique integer value identifying this section.
|
|
1367
|
-
* @param org
|
|
1368
|
-
* @param userId
|
|
1369
1609
|
* @returns Section
|
|
1370
1610
|
* @throws ApiError
|
|
1371
1611
|
*/
|
|
1372
|
-
static aiMentorOrgsUsersCourseCreationSectionRetrieve(id
|
|
1612
|
+
static aiMentorOrgsUsersCourseCreationSectionRetrieve({ id, org, userId, }: {
|
|
1613
|
+
/**
|
|
1614
|
+
* A unique integer value identifying this section.
|
|
1615
|
+
*/
|
|
1616
|
+
id: number;
|
|
1617
|
+
org: string;
|
|
1618
|
+
}): CancelablePromise<Section>;
|
|
1373
1619
|
/**
|
|
1374
1620
|
* API viewset for managing course sections.
|
|
1375
1621
|
*
|
|
@@ -1378,14 +1624,17 @@ export declare class AiMentorService {
|
|
|
1378
1624
|
*
|
|
1379
1625
|
* Permissions:
|
|
1380
1626
|
* - Restricted to platform administrators only
|
|
1381
|
-
* @param id A unique integer value identifying this section.
|
|
1382
|
-
* @param org
|
|
1383
|
-
* @param userId
|
|
1384
|
-
* @param requestBody
|
|
1385
1627
|
* @returns Section
|
|
1386
1628
|
* @throws ApiError
|
|
1387
1629
|
*/
|
|
1388
|
-
static aiMentorOrgsUsersCourseCreationSectionUpdate(id
|
|
1630
|
+
static aiMentorOrgsUsersCourseCreationSectionUpdate({ id, org, userId, requestBody, }: {
|
|
1631
|
+
/**
|
|
1632
|
+
* A unique integer value identifying this section.
|
|
1633
|
+
*/
|
|
1634
|
+
id: number;
|
|
1635
|
+
org: string;
|
|
1636
|
+
requestBody: Section;
|
|
1637
|
+
}): CancelablePromise<Section>;
|
|
1389
1638
|
/**
|
|
1390
1639
|
* API viewset for managing course sections.
|
|
1391
1640
|
*
|
|
@@ -1394,14 +1643,17 @@ export declare class AiMentorService {
|
|
|
1394
1643
|
*
|
|
1395
1644
|
* Permissions:
|
|
1396
1645
|
* - Restricted to platform administrators only
|
|
1397
|
-
* @param id A unique integer value identifying this section.
|
|
1398
|
-
* @param org
|
|
1399
|
-
* @param userId
|
|
1400
|
-
* @param requestBody
|
|
1401
1646
|
* @returns Section
|
|
1402
1647
|
* @throws ApiError
|
|
1403
1648
|
*/
|
|
1404
|
-
static aiMentorOrgsUsersCourseCreationSectionPartialUpdate(id
|
|
1649
|
+
static aiMentorOrgsUsersCourseCreationSectionPartialUpdate({ id, org, userId, requestBody, }: {
|
|
1650
|
+
/**
|
|
1651
|
+
* A unique integer value identifying this section.
|
|
1652
|
+
*/
|
|
1653
|
+
id: number;
|
|
1654
|
+
org: string;
|
|
1655
|
+
requestBody?: PatchedSection;
|
|
1656
|
+
}): CancelablePromise<Section>;
|
|
1405
1657
|
/**
|
|
1406
1658
|
* API viewset for managing course sections.
|
|
1407
1659
|
*
|
|
@@ -1410,13 +1662,16 @@ export declare class AiMentorService {
|
|
|
1410
1662
|
*
|
|
1411
1663
|
* Permissions:
|
|
1412
1664
|
* - Restricted to platform administrators only
|
|
1413
|
-
* @param id A unique integer value identifying this section.
|
|
1414
|
-
* @param org
|
|
1415
|
-
* @param userId
|
|
1416
1665
|
* @returns void
|
|
1417
1666
|
* @throws ApiError
|
|
1418
1667
|
*/
|
|
1419
|
-
static aiMentorOrgsUsersCourseCreationSectionDestroy(id
|
|
1668
|
+
static aiMentorOrgsUsersCourseCreationSectionDestroy({ id, org, userId, }: {
|
|
1669
|
+
/**
|
|
1670
|
+
* A unique integer value identifying this section.
|
|
1671
|
+
*/
|
|
1672
|
+
id: number;
|
|
1673
|
+
org: string;
|
|
1674
|
+
}): CancelablePromise<void>;
|
|
1420
1675
|
/**
|
|
1421
1676
|
* API viewset for managing course subsections.
|
|
1422
1677
|
*
|
|
@@ -1425,19 +1680,27 @@ export declare class AiMentorService {
|
|
|
1425
1680
|
*
|
|
1426
1681
|
* Permissions:
|
|
1427
1682
|
* - Restricted to platform administrators only
|
|
1428
|
-
* @param org
|
|
1429
|
-
* @param userId
|
|
1430
|
-
* @param course
|
|
1431
|
-
* @param ordering Which field to use when ordering the results.
|
|
1432
|
-
* @param page A page number within the paginated result set.
|
|
1433
|
-
* @param pageSize Number of results to return per page.
|
|
1434
|
-
* @param search A search term.
|
|
1435
|
-
* @param section
|
|
1436
|
-
* @param task
|
|
1437
1683
|
* @returns PaginatedSubSectionList
|
|
1438
1684
|
* @throws ApiError
|
|
1439
1685
|
*/
|
|
1440
|
-
static aiMentorOrgsUsersCourseCreationSubsectionList(org
|
|
1686
|
+
static aiMentorOrgsUsersCourseCreationSubsectionList({ org, userId, course, ordering, page, pageSize, search, section, task, }: {
|
|
1687
|
+
org: string;
|
|
1688
|
+
course?: number; /**
|
|
1689
|
+
* Which field to use when ordering the results.
|
|
1690
|
+
*/
|
|
1691
|
+
ordering?: string; /**
|
|
1692
|
+
* A page number within the paginated result set.
|
|
1693
|
+
*/
|
|
1694
|
+
page?: number; /**
|
|
1695
|
+
* Number of results to return per page.
|
|
1696
|
+
*/
|
|
1697
|
+
pageSize?: number; /**
|
|
1698
|
+
* A search term.
|
|
1699
|
+
*/
|
|
1700
|
+
search?: string;
|
|
1701
|
+
section?: number;
|
|
1702
|
+
task?: number;
|
|
1703
|
+
}): CancelablePromise<PaginatedSubSectionList>;
|
|
1441
1704
|
/**
|
|
1442
1705
|
* API viewset for managing course subsections.
|
|
1443
1706
|
*
|
|
@@ -1446,13 +1709,13 @@ export declare class AiMentorService {
|
|
|
1446
1709
|
*
|
|
1447
1710
|
* Permissions:
|
|
1448
1711
|
* - Restricted to platform administrators only
|
|
1449
|
-
* @param org
|
|
1450
|
-
* @param userId
|
|
1451
|
-
* @param requestBody
|
|
1452
1712
|
* @returns SubSection
|
|
1453
1713
|
* @throws ApiError
|
|
1454
1714
|
*/
|
|
1455
|
-
static aiMentorOrgsUsersCourseCreationSubsectionCreate(org
|
|
1715
|
+
static aiMentorOrgsUsersCourseCreationSubsectionCreate({ org, userId, requestBody, }: {
|
|
1716
|
+
org: string;
|
|
1717
|
+
requestBody: SubSection;
|
|
1718
|
+
}): CancelablePromise<SubSection>;
|
|
1456
1719
|
/**
|
|
1457
1720
|
* API viewset for managing course subsections.
|
|
1458
1721
|
*
|
|
@@ -1461,13 +1724,16 @@ export declare class AiMentorService {
|
|
|
1461
1724
|
*
|
|
1462
1725
|
* Permissions:
|
|
1463
1726
|
* - Restricted to platform administrators only
|
|
1464
|
-
* @param id A unique integer value identifying this sub section.
|
|
1465
|
-
* @param org
|
|
1466
|
-
* @param userId
|
|
1467
1727
|
* @returns SubSection
|
|
1468
1728
|
* @throws ApiError
|
|
1469
1729
|
*/
|
|
1470
|
-
static aiMentorOrgsUsersCourseCreationSubsectionRetrieve(id
|
|
1730
|
+
static aiMentorOrgsUsersCourseCreationSubsectionRetrieve({ id, org, userId, }: {
|
|
1731
|
+
/**
|
|
1732
|
+
* A unique integer value identifying this sub section.
|
|
1733
|
+
*/
|
|
1734
|
+
id: number;
|
|
1735
|
+
org: string;
|
|
1736
|
+
}): CancelablePromise<SubSection>;
|
|
1471
1737
|
/**
|
|
1472
1738
|
* API viewset for managing course subsections.
|
|
1473
1739
|
*
|
|
@@ -1476,14 +1742,17 @@ export declare class AiMentorService {
|
|
|
1476
1742
|
*
|
|
1477
1743
|
* Permissions:
|
|
1478
1744
|
* - Restricted to platform administrators only
|
|
1479
|
-
* @param id A unique integer value identifying this sub section.
|
|
1480
|
-
* @param org
|
|
1481
|
-
* @param userId
|
|
1482
|
-
* @param requestBody
|
|
1483
1745
|
* @returns SubSection
|
|
1484
1746
|
* @throws ApiError
|
|
1485
1747
|
*/
|
|
1486
|
-
static aiMentorOrgsUsersCourseCreationSubsectionUpdate(id
|
|
1748
|
+
static aiMentorOrgsUsersCourseCreationSubsectionUpdate({ id, org, userId, requestBody, }: {
|
|
1749
|
+
/**
|
|
1750
|
+
* A unique integer value identifying this sub section.
|
|
1751
|
+
*/
|
|
1752
|
+
id: number;
|
|
1753
|
+
org: string;
|
|
1754
|
+
requestBody: SubSection;
|
|
1755
|
+
}): CancelablePromise<SubSection>;
|
|
1487
1756
|
/**
|
|
1488
1757
|
* API viewset for managing course subsections.
|
|
1489
1758
|
*
|
|
@@ -1492,14 +1761,17 @@ export declare class AiMentorService {
|
|
|
1492
1761
|
*
|
|
1493
1762
|
* Permissions:
|
|
1494
1763
|
* - Restricted to platform administrators only
|
|
1495
|
-
* @param id A unique integer value identifying this sub section.
|
|
1496
|
-
* @param org
|
|
1497
|
-
* @param userId
|
|
1498
|
-
* @param requestBody
|
|
1499
1764
|
* @returns SubSection
|
|
1500
1765
|
* @throws ApiError
|
|
1501
1766
|
*/
|
|
1502
|
-
static aiMentorOrgsUsersCourseCreationSubsectionPartialUpdate(id
|
|
1767
|
+
static aiMentorOrgsUsersCourseCreationSubsectionPartialUpdate({ id, org, userId, requestBody, }: {
|
|
1768
|
+
/**
|
|
1769
|
+
* A unique integer value identifying this sub section.
|
|
1770
|
+
*/
|
|
1771
|
+
id: number;
|
|
1772
|
+
org: string;
|
|
1773
|
+
requestBody?: PatchedSubSection;
|
|
1774
|
+
}): CancelablePromise<SubSection>;
|
|
1503
1775
|
/**
|
|
1504
1776
|
* API viewset for managing course subsections.
|
|
1505
1777
|
*
|
|
@@ -1508,13 +1780,16 @@ export declare class AiMentorService {
|
|
|
1508
1780
|
*
|
|
1509
1781
|
* Permissions:
|
|
1510
1782
|
* - Restricted to platform administrators only
|
|
1511
|
-
* @param id A unique integer value identifying this sub section.
|
|
1512
|
-
* @param org
|
|
1513
|
-
* @param userId
|
|
1514
1783
|
* @returns void
|
|
1515
1784
|
* @throws ApiError
|
|
1516
1785
|
*/
|
|
1517
|
-
static aiMentorOrgsUsersCourseCreationSubsectionDestroy(id
|
|
1786
|
+
static aiMentorOrgsUsersCourseCreationSubsectionDestroy({ id, org, userId, }: {
|
|
1787
|
+
/**
|
|
1788
|
+
* A unique integer value identifying this sub section.
|
|
1789
|
+
*/
|
|
1790
|
+
id: number;
|
|
1791
|
+
org: string;
|
|
1792
|
+
}): CancelablePromise<void>;
|
|
1518
1793
|
/**
|
|
1519
1794
|
* Create, retrieve and delete course creation tasks
|
|
1520
1795
|
*
|
|
@@ -1526,14 +1801,18 @@ export declare class AiMentorService {
|
|
|
1526
1801
|
* Bigger and newer models tend to outperform smaller once.
|
|
1527
1802
|
*
|
|
1528
1803
|
* Clear and unambiguous parameters are more likely to produce better results.
|
|
1529
|
-
* @param org
|
|
1530
|
-
* @param userId
|
|
1531
|
-
* @param page A page number within the paginated result set.
|
|
1532
|
-
* @param pageSize Number of results to return per page.
|
|
1533
1804
|
* @returns PaginatedCourseCreationTaskList
|
|
1534
1805
|
* @throws ApiError
|
|
1535
1806
|
*/
|
|
1536
|
-
static aiMentorOrgsUsersCourseCreationTasksList2(org
|
|
1807
|
+
static aiMentorOrgsUsersCourseCreationTasksList2({ org, userId, page, pageSize, }: {
|
|
1808
|
+
org: string; /**
|
|
1809
|
+
* A page number within the paginated result set.
|
|
1810
|
+
*/
|
|
1811
|
+
page?: number; /**
|
|
1812
|
+
* Number of results to return per page.
|
|
1813
|
+
*/
|
|
1814
|
+
pageSize?: number;
|
|
1815
|
+
}): CancelablePromise<PaginatedCourseCreationTaskList>;
|
|
1537
1816
|
/**
|
|
1538
1817
|
* Create, retrieve and delete course creation tasks
|
|
1539
1818
|
*
|
|
@@ -1545,13 +1824,13 @@ export declare class AiMentorService {
|
|
|
1545
1824
|
* Bigger and newer models tend to outperform smaller once.
|
|
1546
1825
|
*
|
|
1547
1826
|
* Clear and unambiguous parameters are more likely to produce better results.
|
|
1548
|
-
* @param org
|
|
1549
|
-
* @param userId
|
|
1550
|
-
* @param formData
|
|
1551
1827
|
* @returns CourseCreationTask
|
|
1552
1828
|
* @throws ApiError
|
|
1553
1829
|
*/
|
|
1554
|
-
static aiMentorOrgsUsersCourseCreationTasksCreate2(org
|
|
1830
|
+
static aiMentorOrgsUsersCourseCreationTasksCreate2({ org, userId, formData, }: {
|
|
1831
|
+
org: string;
|
|
1832
|
+
formData: CourseCreationTask;
|
|
1833
|
+
}): CancelablePromise<CourseCreationTask>;
|
|
1555
1834
|
/**
|
|
1556
1835
|
* Create, retrieve and delete course creation tasks
|
|
1557
1836
|
*
|
|
@@ -1563,13 +1842,16 @@ export declare class AiMentorService {
|
|
|
1563
1842
|
* Bigger and newer models tend to outperform smaller once.
|
|
1564
1843
|
*
|
|
1565
1844
|
* Clear and unambiguous parameters are more likely to produce better results.
|
|
1566
|
-
* @param id A unique integer value identifying this course creation task.
|
|
1567
|
-
* @param org
|
|
1568
|
-
* @param userId
|
|
1569
1845
|
* @returns CourseCreationTask
|
|
1570
1846
|
* @throws ApiError
|
|
1571
1847
|
*/
|
|
1572
|
-
static aiMentorOrgsUsersCourseCreationTasksRetrieve2(id
|
|
1848
|
+
static aiMentorOrgsUsersCourseCreationTasksRetrieve2({ id, org, userId, }: {
|
|
1849
|
+
/**
|
|
1850
|
+
* A unique integer value identifying this course creation task.
|
|
1851
|
+
*/
|
|
1852
|
+
id: number;
|
|
1853
|
+
org: string;
|
|
1854
|
+
}): CancelablePromise<CourseCreationTask>;
|
|
1573
1855
|
/**
|
|
1574
1856
|
* Create, retrieve and delete course creation tasks
|
|
1575
1857
|
*
|
|
@@ -1581,13 +1863,16 @@ export declare class AiMentorService {
|
|
|
1581
1863
|
* Bigger and newer models tend to outperform smaller once.
|
|
1582
1864
|
*
|
|
1583
1865
|
* Clear and unambiguous parameters are more likely to produce better results.
|
|
1584
|
-
* @param id A unique integer value identifying this course creation task.
|
|
1585
|
-
* @param org
|
|
1586
|
-
* @param userId
|
|
1587
1866
|
* @returns void
|
|
1588
1867
|
* @throws ApiError
|
|
1589
1868
|
*/
|
|
1590
|
-
static aiMentorOrgsUsersCourseCreationTasksDestroy2(id
|
|
1869
|
+
static aiMentorOrgsUsersCourseCreationTasksDestroy2({ id, org, userId, }: {
|
|
1870
|
+
/**
|
|
1871
|
+
* A unique integer value identifying this course creation task.
|
|
1872
|
+
*/
|
|
1873
|
+
id: number;
|
|
1874
|
+
org: string;
|
|
1875
|
+
}): CancelablePromise<void>;
|
|
1591
1876
|
/**
|
|
1592
1877
|
* Cancel a course creation task run.
|
|
1593
1878
|
* ** Conditions Required **:
|
|
@@ -1595,36 +1880,45 @@ export declare class AiMentorService {
|
|
|
1595
1880
|
* ** Response **:
|
|
1596
1881
|
* - 200: The course creation task is successfully cancelled.
|
|
1597
1882
|
* - 400: The course creation task is not in a running or pending state.
|
|
1598
|
-
* @param id A unique integer value identifying this course creation task.
|
|
1599
|
-
* @param org
|
|
1600
|
-
* @param userId
|
|
1601
1883
|
* @returns CourseCreationTask
|
|
1602
1884
|
* @throws ApiError
|
|
1603
1885
|
*/
|
|
1604
|
-
static aiMentorOrgsUsersCourseCreationTasksCancelRetrieve2(id
|
|
1886
|
+
static aiMentorOrgsUsersCourseCreationTasksCancelRetrieve2({ id, org, userId, }: {
|
|
1887
|
+
/**
|
|
1888
|
+
* A unique integer value identifying this course creation task.
|
|
1889
|
+
*/
|
|
1890
|
+
id: number;
|
|
1891
|
+
org: string;
|
|
1892
|
+
}): CancelablePromise<CourseCreationTask>;
|
|
1605
1893
|
/**
|
|
1606
1894
|
* This is intended for stepwise approach of course creation.
|
|
1607
1895
|
*
|
|
1608
1896
|
* Use this to intiate generating an outline of the course.
|
|
1609
|
-
* @param id A unique integer value identifying this course creation task.
|
|
1610
|
-
* @param org
|
|
1611
|
-
* @param userId
|
|
1612
1897
|
* @returns FullCourse
|
|
1613
1898
|
* @throws ApiError
|
|
1614
1899
|
*/
|
|
1615
|
-
static aiMentorOrgsUsersCourseCreationTasksCreateCourseOutlineRetrieve2(id
|
|
1900
|
+
static aiMentorOrgsUsersCourseCreationTasksCreateCourseOutlineRetrieve2({ id, org, userId, }: {
|
|
1901
|
+
/**
|
|
1902
|
+
* A unique integer value identifying this course creation task.
|
|
1903
|
+
*/
|
|
1904
|
+
id: number;
|
|
1905
|
+
org: string;
|
|
1906
|
+
}): CancelablePromise<FullCourse>;
|
|
1616
1907
|
/**
|
|
1617
1908
|
* This is intended for stepwise approach of course creation.
|
|
1618
1909
|
*
|
|
1619
1910
|
* Use this to intiate generating an outline of the course.
|
|
1620
|
-
* @param id A unique integer value identifying this course creation task.
|
|
1621
|
-
* @param org
|
|
1622
|
-
* @param userId
|
|
1623
|
-
* @param formData
|
|
1624
1911
|
* @returns FullCourse
|
|
1625
1912
|
* @throws ApiError
|
|
1626
1913
|
*/
|
|
1627
|
-
static aiMentorOrgsUsersCourseCreationTasksCreateCourseOutlineCreate2(id
|
|
1914
|
+
static aiMentorOrgsUsersCourseCreationTasksCreateCourseOutlineCreate2({ id, org, userId, formData, }: {
|
|
1915
|
+
/**
|
|
1916
|
+
* A unique integer value identifying this course creation task.
|
|
1917
|
+
*/
|
|
1918
|
+
id: number;
|
|
1919
|
+
org: string;
|
|
1920
|
+
formData: CourseCreationTask;
|
|
1921
|
+
}): CancelablePromise<FullCourse>;
|
|
1628
1922
|
/**
|
|
1629
1923
|
* Kick start the course creation task.
|
|
1630
1924
|
* This endpoint should be called once the files for a course creation task has
|
|
@@ -1636,13 +1930,16 @@ export declare class AiMentorService {
|
|
|
1636
1930
|
* ** Response **:
|
|
1637
1931
|
* - 200: The course creation task is successfully started.
|
|
1638
1932
|
* - 400: The course creation task is not in a pending state.
|
|
1639
|
-
* @param id A unique integer value identifying this course creation task.
|
|
1640
|
-
* @param org
|
|
1641
|
-
* @param userId
|
|
1642
1933
|
* @returns CourseCreationTask
|
|
1643
1934
|
* @throws ApiError
|
|
1644
1935
|
*/
|
|
1645
|
-
static aiMentorOrgsUsersCourseCreationTasksStartRetrieve2(id
|
|
1936
|
+
static aiMentorOrgsUsersCourseCreationTasksStartRetrieve2({ id, org, userId, }: {
|
|
1937
|
+
/**
|
|
1938
|
+
* A unique integer value identifying this course creation task.
|
|
1939
|
+
*/
|
|
1940
|
+
id: number;
|
|
1941
|
+
org: string;
|
|
1942
|
+
}): CancelablePromise<CourseCreationTask>;
|
|
1646
1943
|
/**
|
|
1647
1944
|
* API viewset for managing course units.
|
|
1648
1945
|
*
|
|
@@ -1651,20 +1948,28 @@ export declare class AiMentorService {
|
|
|
1651
1948
|
*
|
|
1652
1949
|
* Permissions:
|
|
1653
1950
|
* - Restricted to platform administrators only
|
|
1654
|
-
* @param org
|
|
1655
|
-
* @param userId
|
|
1656
|
-
* @param course
|
|
1657
|
-
* @param ordering Which field to use when ordering the results.
|
|
1658
|
-
* @param page A page number within the paginated result set.
|
|
1659
|
-
* @param pageSize Number of results to return per page.
|
|
1660
|
-
* @param search A search term.
|
|
1661
|
-
* @param section
|
|
1662
|
-
* @param subsection
|
|
1663
|
-
* @param task
|
|
1664
1951
|
* @returns PaginatedUnitList
|
|
1665
1952
|
* @throws ApiError
|
|
1666
1953
|
*/
|
|
1667
|
-
static aiMentorOrgsUsersCourseCreationUnitList(org
|
|
1954
|
+
static aiMentorOrgsUsersCourseCreationUnitList({ org, userId, course, ordering, page, pageSize, search, section, subsection, task, }: {
|
|
1955
|
+
org: string;
|
|
1956
|
+
course?: number; /**
|
|
1957
|
+
* Which field to use when ordering the results.
|
|
1958
|
+
*/
|
|
1959
|
+
ordering?: string; /**
|
|
1960
|
+
* A page number within the paginated result set.
|
|
1961
|
+
*/
|
|
1962
|
+
page?: number; /**
|
|
1963
|
+
* Number of results to return per page.
|
|
1964
|
+
*/
|
|
1965
|
+
pageSize?: number; /**
|
|
1966
|
+
* A search term.
|
|
1967
|
+
*/
|
|
1968
|
+
search?: string;
|
|
1969
|
+
section?: number;
|
|
1970
|
+
subsection?: number;
|
|
1971
|
+
task?: number;
|
|
1972
|
+
}): CancelablePromise<PaginatedUnitList>;
|
|
1668
1973
|
/**
|
|
1669
1974
|
* API viewset for managing course units.
|
|
1670
1975
|
*
|
|
@@ -1673,13 +1978,13 @@ export declare class AiMentorService {
|
|
|
1673
1978
|
*
|
|
1674
1979
|
* Permissions:
|
|
1675
1980
|
* - Restricted to platform administrators only
|
|
1676
|
-
* @param org
|
|
1677
|
-
* @param userId
|
|
1678
|
-
* @param requestBody
|
|
1679
1981
|
* @returns Unit
|
|
1680
1982
|
* @throws ApiError
|
|
1681
1983
|
*/
|
|
1682
|
-
static aiMentorOrgsUsersCourseCreationUnitCreate(org
|
|
1984
|
+
static aiMentorOrgsUsersCourseCreationUnitCreate({ org, userId, requestBody, }: {
|
|
1985
|
+
org: string;
|
|
1986
|
+
requestBody: Unit;
|
|
1987
|
+
}): CancelablePromise<Unit>;
|
|
1683
1988
|
/**
|
|
1684
1989
|
* API viewset for managing course units.
|
|
1685
1990
|
*
|
|
@@ -1688,13 +1993,16 @@ export declare class AiMentorService {
|
|
|
1688
1993
|
*
|
|
1689
1994
|
* Permissions:
|
|
1690
1995
|
* - Restricted to platform administrators only
|
|
1691
|
-
* @param id A unique integer value identifying this unit.
|
|
1692
|
-
* @param org
|
|
1693
|
-
* @param userId
|
|
1694
1996
|
* @returns Unit
|
|
1695
1997
|
* @throws ApiError
|
|
1696
1998
|
*/
|
|
1697
|
-
static aiMentorOrgsUsersCourseCreationUnitRetrieve(id
|
|
1999
|
+
static aiMentorOrgsUsersCourseCreationUnitRetrieve({ id, org, userId, }: {
|
|
2000
|
+
/**
|
|
2001
|
+
* A unique integer value identifying this unit.
|
|
2002
|
+
*/
|
|
2003
|
+
id: number;
|
|
2004
|
+
org: string;
|
|
2005
|
+
}): CancelablePromise<Unit>;
|
|
1698
2006
|
/**
|
|
1699
2007
|
* API viewset for managing course units.
|
|
1700
2008
|
*
|
|
@@ -1703,14 +2011,17 @@ export declare class AiMentorService {
|
|
|
1703
2011
|
*
|
|
1704
2012
|
* Permissions:
|
|
1705
2013
|
* - Restricted to platform administrators only
|
|
1706
|
-
* @param id A unique integer value identifying this unit.
|
|
1707
|
-
* @param org
|
|
1708
|
-
* @param userId
|
|
1709
|
-
* @param requestBody
|
|
1710
2014
|
* @returns Unit
|
|
1711
2015
|
* @throws ApiError
|
|
1712
2016
|
*/
|
|
1713
|
-
static aiMentorOrgsUsersCourseCreationUnitUpdate(id
|
|
2017
|
+
static aiMentorOrgsUsersCourseCreationUnitUpdate({ id, org, userId, requestBody, }: {
|
|
2018
|
+
/**
|
|
2019
|
+
* A unique integer value identifying this unit.
|
|
2020
|
+
*/
|
|
2021
|
+
id: number;
|
|
2022
|
+
org: string;
|
|
2023
|
+
requestBody: Unit;
|
|
2024
|
+
}): CancelablePromise<Unit>;
|
|
1714
2025
|
/**
|
|
1715
2026
|
* API viewset for managing course units.
|
|
1716
2027
|
*
|
|
@@ -1719,14 +2030,17 @@ export declare class AiMentorService {
|
|
|
1719
2030
|
*
|
|
1720
2031
|
* Permissions:
|
|
1721
2032
|
* - Restricted to platform administrators only
|
|
1722
|
-
* @param id A unique integer value identifying this unit.
|
|
1723
|
-
* @param org
|
|
1724
|
-
* @param userId
|
|
1725
|
-
* @param requestBody
|
|
1726
2033
|
* @returns Unit
|
|
1727
2034
|
* @throws ApiError
|
|
1728
2035
|
*/
|
|
1729
|
-
static aiMentorOrgsUsersCourseCreationUnitPartialUpdate(id
|
|
2036
|
+
static aiMentorOrgsUsersCourseCreationUnitPartialUpdate({ id, org, userId, requestBody, }: {
|
|
2037
|
+
/**
|
|
2038
|
+
* A unique integer value identifying this unit.
|
|
2039
|
+
*/
|
|
2040
|
+
id: number;
|
|
2041
|
+
org: string;
|
|
2042
|
+
requestBody?: PatchedUnit;
|
|
2043
|
+
}): CancelablePromise<Unit>;
|
|
1730
2044
|
/**
|
|
1731
2045
|
* API viewset for managing course units.
|
|
1732
2046
|
*
|
|
@@ -1735,13 +2049,16 @@ export declare class AiMentorService {
|
|
|
1735
2049
|
*
|
|
1736
2050
|
* Permissions:
|
|
1737
2051
|
* - Restricted to platform administrators only
|
|
1738
|
-
* @param id A unique integer value identifying this unit.
|
|
1739
|
-
* @param org
|
|
1740
|
-
* @param userId
|
|
1741
2052
|
* @returns void
|
|
1742
2053
|
* @throws ApiError
|
|
1743
2054
|
*/
|
|
1744
|
-
static aiMentorOrgsUsersCourseCreationUnitDestroy(id
|
|
2055
|
+
static aiMentorOrgsUsersCourseCreationUnitDestroy({ id, org, userId, }: {
|
|
2056
|
+
/**
|
|
2057
|
+
* A unique integer value identifying this unit.
|
|
2058
|
+
*/
|
|
2059
|
+
id: number;
|
|
2060
|
+
org: string;
|
|
2061
|
+
}): CancelablePromise<void>;
|
|
1745
2062
|
/**
|
|
1746
2063
|
* Generate draft content for a specific unit.
|
|
1747
2064
|
*
|
|
@@ -1757,13 +2074,16 @@ export declare class AiMentorService {
|
|
|
1757
2074
|
*
|
|
1758
2075
|
* Raises:
|
|
1759
2076
|
* NotFound: If the specified unit does not exist.
|
|
1760
|
-
* @param id A unique integer value identifying this unit.
|
|
1761
|
-
* @param org
|
|
1762
|
-
* @param userId
|
|
1763
2077
|
* @returns any Content creation started successfully
|
|
1764
2078
|
* @throws ApiError
|
|
1765
2079
|
*/
|
|
1766
|
-
static aiMentorOrgsUsersCourseCreationUnitDraftContentRetrieve(id
|
|
2080
|
+
static aiMentorOrgsUsersCourseCreationUnitDraftContentRetrieve({ id, org, userId, }: {
|
|
2081
|
+
/**
|
|
2082
|
+
* A unique integer value identifying this unit.
|
|
2083
|
+
*/
|
|
2084
|
+
id: number;
|
|
2085
|
+
org: string;
|
|
2086
|
+
}): CancelablePromise<any>;
|
|
1767
2087
|
/**
|
|
1768
2088
|
* Generate draft content for a specific unit.
|
|
1769
2089
|
*
|
|
@@ -1779,14 +2099,17 @@ export declare class AiMentorService {
|
|
|
1779
2099
|
*
|
|
1780
2100
|
* Raises:
|
|
1781
2101
|
* NotFound: If the specified unit does not exist.
|
|
1782
|
-
* @param id A unique integer value identifying this unit.
|
|
1783
|
-
* @param org
|
|
1784
|
-
* @param userId
|
|
1785
|
-
* @param requestBody
|
|
1786
2102
|
* @returns any Content creation started successfully
|
|
1787
2103
|
* @throws ApiError
|
|
1788
2104
|
*/
|
|
1789
|
-
static aiMentorOrgsUsersCourseCreationUnitDraftContentCreate(id
|
|
2105
|
+
static aiMentorOrgsUsersCourseCreationUnitDraftContentCreate({ id, org, userId, requestBody, }: {
|
|
2106
|
+
/**
|
|
2107
|
+
* A unique integer value identifying this unit.
|
|
2108
|
+
*/
|
|
2109
|
+
id: number;
|
|
2110
|
+
org: string;
|
|
2111
|
+
requestBody: Unit;
|
|
2112
|
+
}): CancelablePromise<any>;
|
|
1790
2113
|
/**
|
|
1791
2114
|
* Create a new mentor using the wizard interface.
|
|
1792
2115
|
*
|
|
@@ -1800,13 +2123,13 @@ export declare class AiMentorService {
|
|
|
1800
2123
|
*
|
|
1801
2124
|
* Raises:
|
|
1802
2125
|
* BadRequest: If the provided data is invalid.
|
|
1803
|
-
* @param org
|
|
1804
|
-
* @param userId
|
|
1805
|
-
* @param requestBody
|
|
1806
2126
|
* @returns Mentor
|
|
1807
2127
|
* @throws ApiError
|
|
1808
2128
|
*/
|
|
1809
|
-
static aiMentorOrgsUsersCreateMentorWizardCreate(org
|
|
2129
|
+
static aiMentorOrgsUsersCreateMentorWizardCreate({ org, userId, requestBody, }: {
|
|
2130
|
+
org: string;
|
|
2131
|
+
requestBody: MentorWizard;
|
|
2132
|
+
}): CancelablePromise<Mentor>;
|
|
1810
2133
|
/**
|
|
1811
2134
|
* Retrieve custom instructions for a specific user.
|
|
1812
2135
|
*
|
|
@@ -1820,12 +2143,12 @@ export declare class AiMentorService {
|
|
|
1820
2143
|
*
|
|
1821
2144
|
* Raises:
|
|
1822
2145
|
* NotFound: If no custom instructions exist for the user.
|
|
1823
|
-
* @param org
|
|
1824
|
-
* @param userId
|
|
1825
2146
|
* @returns CustomInstructionResponse
|
|
1826
2147
|
* @throws ApiError
|
|
1827
2148
|
*/
|
|
1828
|
-
static aiMentorOrgsUsersCustomInstructionRetrieve(org
|
|
2149
|
+
static aiMentorOrgsUsersCustomInstructionRetrieve({ org, userId, }: {
|
|
2150
|
+
org: string;
|
|
2151
|
+
}): CancelablePromise<CustomInstructionResponse>;
|
|
1829
2152
|
/**
|
|
1830
2153
|
* Create a new custom instruction for a user.
|
|
1831
2154
|
*
|
|
@@ -1839,13 +2162,13 @@ export declare class AiMentorService {
|
|
|
1839
2162
|
*
|
|
1840
2163
|
* Raises:
|
|
1841
2164
|
* BadRequest: If the provided data is invalid.
|
|
1842
|
-
* @param org
|
|
1843
|
-
* @param userId
|
|
1844
|
-
* @param requestBody
|
|
1845
2165
|
* @returns CustomInstructionResponse
|
|
1846
2166
|
* @throws ApiError
|
|
1847
2167
|
*/
|
|
1848
|
-
static aiMentorOrgsUsersCustomInstructionCreate(org
|
|
2168
|
+
static aiMentorOrgsUsersCustomInstructionCreate({ org, userId, requestBody, }: {
|
|
2169
|
+
org: string;
|
|
2170
|
+
requestBody?: CustomInstructionResponse;
|
|
2171
|
+
}): CancelablePromise<CustomInstructionResponse>;
|
|
1849
2172
|
/**
|
|
1850
2173
|
* Update an existing custom instruction for a user.
|
|
1851
2174
|
*
|
|
@@ -1860,13 +2183,13 @@ export declare class AiMentorService {
|
|
|
1860
2183
|
* Raises:
|
|
1861
2184
|
* BadRequest: If the provided data is invalid.
|
|
1862
2185
|
* NotFound: If no custom instruction exists for the user.
|
|
1863
|
-
* @param org
|
|
1864
|
-
* @param userId
|
|
1865
|
-
* @param requestBody
|
|
1866
2186
|
* @returns CustomInstructionResponse
|
|
1867
2187
|
* @throws ApiError
|
|
1868
2188
|
*/
|
|
1869
|
-
static aiMentorOrgsUsersCustomInstructionUpdate(org
|
|
2189
|
+
static aiMentorOrgsUsersCustomInstructionUpdate({ org, userId, requestBody, }: {
|
|
2190
|
+
org: string;
|
|
2191
|
+
requestBody?: CustomInstructionResponse;
|
|
2192
|
+
}): CancelablePromise<CustomInstructionResponse>;
|
|
1870
2193
|
/**
|
|
1871
2194
|
* Retrieves the chat history for a user if the export task is ready.
|
|
1872
2195
|
*
|
|
@@ -1881,14 +2204,16 @@ export declare class AiMentorService {
|
|
|
1881
2204
|
* 200: chat history object
|
|
1882
2205
|
*
|
|
1883
2206
|
* 400: When data is not valid.
|
|
1884
|
-
* @param org
|
|
1885
|
-
* @param taskId
|
|
1886
|
-
* @param userId
|
|
1887
|
-
* @param toCsv Choose download in csv or not
|
|
1888
2207
|
* @returns ChatHistoryItem
|
|
1889
2208
|
* @throws ApiError
|
|
1890
2209
|
*/
|
|
1891
|
-
static aiMentorOrgsUsersDownloadsTasksRetrieve(org
|
|
2210
|
+
static aiMentorOrgsUsersDownloadsTasksRetrieve({ org, taskId, userId, toCsv, }: {
|
|
2211
|
+
org: string;
|
|
2212
|
+
taskId: string; /**
|
|
2213
|
+
* Choose download in csv or not
|
|
2214
|
+
*/
|
|
2215
|
+
toCsv?: boolean;
|
|
2216
|
+
}): CancelablePromise<ChatHistoryItem>;
|
|
1892
2217
|
/**
|
|
1893
2218
|
* Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with.
|
|
1894
2219
|
* This information is passed to the corresponding mentor so the mentor has context information
|
|
@@ -1933,18 +2258,26 @@ export declare class AiMentorService {
|
|
|
1933
2258
|
* "date_created": "2024-06-25T15:30:26.257140",
|
|
1934
2259
|
* "last_modified": "2024-06-25T15:30:26.257140"
|
|
1935
2260
|
* }
|
|
1936
|
-
* @param org
|
|
1937
|
-
* @param userId
|
|
1938
|
-
* @param courseId
|
|
1939
|
-
* @param ordering Which field to use when ordering the results.
|
|
1940
|
-
* @param page A page number within the paginated result set.
|
|
1941
|
-
* @param pageSize Number of results to return per page.
|
|
1942
|
-
* @param student edX user ID
|
|
1943
|
-
* @param username
|
|
1944
2261
|
* @returns PaginatedUserEdxMemoryList
|
|
1945
2262
|
* @throws ApiError
|
|
1946
2263
|
*/
|
|
1947
|
-
static aiMentorOrgsUsersEdxMemoryList(org
|
|
2264
|
+
static aiMentorOrgsUsersEdxMemoryList({ org, userId, courseId, ordering, page, pageSize, student, username, }: {
|
|
2265
|
+
org: string;
|
|
2266
|
+
courseId?: string; /**
|
|
2267
|
+
* Which field to use when ordering the results.
|
|
2268
|
+
*/
|
|
2269
|
+
ordering?: string; /**
|
|
2270
|
+
* A page number within the paginated result set.
|
|
2271
|
+
*/
|
|
2272
|
+
page?: number; /**
|
|
2273
|
+
* Number of results to return per page.
|
|
2274
|
+
*/
|
|
2275
|
+
pageSize?: number; /**
|
|
2276
|
+
* edX user ID
|
|
2277
|
+
*/
|
|
2278
|
+
student?: number;
|
|
2279
|
+
username?: string;
|
|
2280
|
+
}): CancelablePromise<PaginatedUserEdxMemoryList>;
|
|
1948
2281
|
/**
|
|
1949
2282
|
* Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with.
|
|
1950
2283
|
* This information is passed to the corresponding mentor so the mentor has context information
|
|
@@ -1989,13 +2322,16 @@ export declare class AiMentorService {
|
|
|
1989
2322
|
* "date_created": "2024-06-25T15:30:26.257140",
|
|
1990
2323
|
* "last_modified": "2024-06-25T15:30:26.257140"
|
|
1991
2324
|
* }
|
|
1992
|
-
* @param id A unique integer value identifying this user edx memory.
|
|
1993
|
-
* @param org
|
|
1994
|
-
* @param userId
|
|
1995
2325
|
* @returns UserEdxMemory
|
|
1996
2326
|
* @throws ApiError
|
|
1997
2327
|
*/
|
|
1998
|
-
static aiMentorOrgsUsersEdxMemoryRetrieve(id
|
|
2328
|
+
static aiMentorOrgsUsersEdxMemoryRetrieve({ id, org, userId, }: {
|
|
2329
|
+
/**
|
|
2330
|
+
* A unique integer value identifying this user edx memory.
|
|
2331
|
+
*/
|
|
2332
|
+
id: number;
|
|
2333
|
+
org: string;
|
|
2334
|
+
}): CancelablePromise<UserEdxMemory>;
|
|
1999
2335
|
/**
|
|
2000
2336
|
* Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with.
|
|
2001
2337
|
* This information is passed to the corresponding mentor so the mentor has context information
|
|
@@ -2040,13 +2376,16 @@ export declare class AiMentorService {
|
|
|
2040
2376
|
* "date_created": "2024-06-25T15:30:26.257140",
|
|
2041
2377
|
* "last_modified": "2024-06-25T15:30:26.257140"
|
|
2042
2378
|
* }
|
|
2043
|
-
* @param id A unique integer value identifying this user edx memory.
|
|
2044
|
-
* @param org
|
|
2045
|
-
* @param userId
|
|
2046
2379
|
* @returns void
|
|
2047
2380
|
* @throws ApiError
|
|
2048
2381
|
*/
|
|
2049
|
-
static aiMentorOrgsUsersEdxMemoryDestroy(id
|
|
2382
|
+
static aiMentorOrgsUsersEdxMemoryDestroy({ id, org, userId, }: {
|
|
2383
|
+
/**
|
|
2384
|
+
* A unique integer value identifying this user edx memory.
|
|
2385
|
+
*/
|
|
2386
|
+
id: number;
|
|
2387
|
+
org: string;
|
|
2388
|
+
}): CancelablePromise<void>;
|
|
2050
2389
|
/**
|
|
2051
2390
|
* Retrieve a list of Elevenlabs voices available to a user.
|
|
2052
2391
|
*
|
|
@@ -2063,12 +2402,12 @@ export declare class AiMentorService {
|
|
|
2063
2402
|
*
|
|
2064
2403
|
* Raises:
|
|
2065
2404
|
* NotFound: If the specified user does not exist.
|
|
2066
|
-
* @param org
|
|
2067
|
-
* @param userId
|
|
2068
2405
|
* @returns ElevenlabsCustomVoiceResponse
|
|
2069
2406
|
* @throws ApiError
|
|
2070
2407
|
*/
|
|
2071
|
-
static aiMentorOrgsUsersElevenlabsVoiceList(org
|
|
2408
|
+
static aiMentorOrgsUsersElevenlabsVoiceList({ org, userId, }: {
|
|
2409
|
+
org: string;
|
|
2410
|
+
}): CancelablePromise<Array<ElevenlabsCustomVoiceResponse>>;
|
|
2072
2411
|
/**
|
|
2073
2412
|
* Create a new custom Elevenlabs voice.
|
|
2074
2413
|
*
|
|
@@ -2088,13 +2427,13 @@ export declare class AiMentorService {
|
|
|
2088
2427
|
*
|
|
2089
2428
|
* Raises:
|
|
2090
2429
|
* BadRequest: If the provided data is invalid, credentials are not found, or there's an API error.
|
|
2091
|
-
* @param org
|
|
2092
|
-
* @param userId
|
|
2093
|
-
* @param formData
|
|
2094
2430
|
* @returns ElevenlabsCustomVoiceResponse
|
|
2095
2431
|
* @throws ApiError
|
|
2096
2432
|
*/
|
|
2097
|
-
static aiMentorOrgsUsersElevenlabsVoiceCreate(org
|
|
2433
|
+
static aiMentorOrgsUsersElevenlabsVoiceCreate({ org, userId, formData, }: {
|
|
2434
|
+
org: string;
|
|
2435
|
+
formData: ElevenlabsCustomVoice;
|
|
2436
|
+
}): CancelablePromise<ElevenlabsCustomVoiceResponse>;
|
|
2098
2437
|
/**
|
|
2099
2438
|
* Delete an existing Elevenlabs voice configuration.
|
|
2100
2439
|
*
|
|
@@ -2112,25 +2451,25 @@ export declare class AiMentorService {
|
|
|
2112
2451
|
*
|
|
2113
2452
|
* Raises:
|
|
2114
2453
|
* BadRequest: If the Elevenlabs credentials are not found or there's an API error.
|
|
2115
|
-
* @param org
|
|
2116
|
-
* @param userId
|
|
2117
|
-
* @param voiceName
|
|
2118
2454
|
* @returns any Voice successfully deleted
|
|
2119
2455
|
* @throws ApiError
|
|
2120
2456
|
*/
|
|
2121
|
-
static aiMentorOrgsUsersElevenlabsVoiceDestroy(org
|
|
2457
|
+
static aiMentorOrgsUsersElevenlabsVoiceDestroy({ org, userId, voiceName, }: {
|
|
2458
|
+
org: string;
|
|
2459
|
+
voiceName: string;
|
|
2460
|
+
}): CancelablePromise<any>;
|
|
2122
2461
|
/**
|
|
2123
2462
|
* Initiates a background task to export the user's chat history.
|
|
2124
2463
|
*
|
|
2125
2464
|
* Returns:
|
|
2126
2465
|
*
|
|
2127
2466
|
* 200: task id.
|
|
2128
|
-
* @param org
|
|
2129
|
-
* @param userId
|
|
2130
2467
|
* @returns TaskView
|
|
2131
2468
|
* @throws ApiError
|
|
2132
2469
|
*/
|
|
2133
|
-
static aiMentorOrgsUsersExportChathistoryCreate(org
|
|
2470
|
+
static aiMentorOrgsUsersExportChathistoryCreate({ org, userId, }: {
|
|
2471
|
+
org: string;
|
|
2472
|
+
}): CancelablePromise<TaskView>;
|
|
2134
2473
|
/**
|
|
2135
2474
|
* Retrieve the count of free usage credits available to a user.
|
|
2136
2475
|
*
|
|
@@ -2144,27 +2483,33 @@ export declare class AiMentorService {
|
|
|
2144
2483
|
*
|
|
2145
2484
|
* Raises:
|
|
2146
2485
|
* NotFound: If the specified user does not exist.
|
|
2147
|
-
* @param org
|
|
2148
|
-
* @param userId
|
|
2149
2486
|
* @returns FreeUsageCount
|
|
2150
2487
|
* @throws ApiError
|
|
2151
2488
|
*/
|
|
2152
|
-
static aiMentorOrgsUsersFreeUsageCountRetrieve(org
|
|
2489
|
+
static aiMentorOrgsUsersFreeUsageCountRetrieve({ org, userId, }: {
|
|
2490
|
+
org: string;
|
|
2491
|
+
}): CancelablePromise<FreeUsageCount>;
|
|
2153
2492
|
/**
|
|
2154
2493
|
* List all MCP servers.
|
|
2155
2494
|
*
|
|
2156
2495
|
* Returns a paginated list of MCP servers that can be filtered by platform
|
|
2157
2496
|
* and searched by name or URL.
|
|
2158
|
-
* @param org
|
|
2159
|
-
* @param userId
|
|
2160
|
-
* @param page A page number within the paginated result set.
|
|
2161
|
-
* @param pageSize Number of results to return per page.
|
|
2162
|
-
* @param platform
|
|
2163
|
-
* @param search A search term.
|
|
2164
2497
|
* @returns PaginatedMCPServerList
|
|
2165
2498
|
* @throws ApiError
|
|
2166
2499
|
*/
|
|
2167
|
-
static aiMentorOrgsUsersMcpServersList(org
|
|
2500
|
+
static aiMentorOrgsUsersMcpServersList({ org, userId, page, pageSize, platform, search, }: {
|
|
2501
|
+
org: string; /**
|
|
2502
|
+
* A page number within the paginated result set.
|
|
2503
|
+
*/
|
|
2504
|
+
page?: number; /**
|
|
2505
|
+
* Number of results to return per page.
|
|
2506
|
+
*/
|
|
2507
|
+
pageSize?: number;
|
|
2508
|
+
platform?: number; /**
|
|
2509
|
+
* A search term.
|
|
2510
|
+
*/
|
|
2511
|
+
search?: string;
|
|
2512
|
+
}): CancelablePromise<PaginatedMCPServerList>;
|
|
2168
2513
|
/**
|
|
2169
2514
|
* ViewSet for MCP Servers.
|
|
2170
2515
|
*
|
|
@@ -2172,13 +2517,13 @@ export declare class AiMentorService {
|
|
|
2172
2517
|
*
|
|
2173
2518
|
* Permissions:
|
|
2174
2519
|
* - Accessible to tenant admins.
|
|
2175
|
-
* @param org
|
|
2176
|
-
* @param userId
|
|
2177
|
-
* @param requestBody
|
|
2178
2520
|
* @returns MCPServer
|
|
2179
2521
|
* @throws ApiError
|
|
2180
2522
|
*/
|
|
2181
|
-
static aiMentorOrgsUsersMcpServersCreate(org
|
|
2523
|
+
static aiMentorOrgsUsersMcpServersCreate({ org, userId, requestBody, }: {
|
|
2524
|
+
org: string;
|
|
2525
|
+
requestBody: MCPServer;
|
|
2526
|
+
}): CancelablePromise<MCPServer>;
|
|
2182
2527
|
/**
|
|
2183
2528
|
* ViewSet for MCP Servers.
|
|
2184
2529
|
*
|
|
@@ -2186,13 +2531,16 @@ export declare class AiMentorService {
|
|
|
2186
2531
|
*
|
|
2187
2532
|
* Permissions:
|
|
2188
2533
|
* - Accessible to tenant admins.
|
|
2189
|
-
* @param id A unique integer value identifying this mcp server.
|
|
2190
|
-
* @param org
|
|
2191
|
-
* @param userId
|
|
2192
2534
|
* @returns MCPServer
|
|
2193
2535
|
* @throws ApiError
|
|
2194
2536
|
*/
|
|
2195
|
-
static aiMentorOrgsUsersMcpServersRetrieve(id
|
|
2537
|
+
static aiMentorOrgsUsersMcpServersRetrieve({ id, org, userId, }: {
|
|
2538
|
+
/**
|
|
2539
|
+
* A unique integer value identifying this mcp server.
|
|
2540
|
+
*/
|
|
2541
|
+
id: number;
|
|
2542
|
+
org: string;
|
|
2543
|
+
}): CancelablePromise<MCPServer>;
|
|
2196
2544
|
/**
|
|
2197
2545
|
* ViewSet for MCP Servers.
|
|
2198
2546
|
*
|
|
@@ -2200,14 +2548,17 @@ export declare class AiMentorService {
|
|
|
2200
2548
|
*
|
|
2201
2549
|
* Permissions:
|
|
2202
2550
|
* - Accessible to tenant admins.
|
|
2203
|
-
* @param id A unique integer value identifying this mcp server.
|
|
2204
|
-
* @param org
|
|
2205
|
-
* @param userId
|
|
2206
|
-
* @param requestBody
|
|
2207
2551
|
* @returns MCPServer
|
|
2208
2552
|
* @throws ApiError
|
|
2209
2553
|
*/
|
|
2210
|
-
static aiMentorOrgsUsersMcpServersUpdate(id
|
|
2554
|
+
static aiMentorOrgsUsersMcpServersUpdate({ id, org, userId, requestBody, }: {
|
|
2555
|
+
/**
|
|
2556
|
+
* A unique integer value identifying this mcp server.
|
|
2557
|
+
*/
|
|
2558
|
+
id: number;
|
|
2559
|
+
org: string;
|
|
2560
|
+
requestBody: MCPServer;
|
|
2561
|
+
}): CancelablePromise<MCPServer>;
|
|
2211
2562
|
/**
|
|
2212
2563
|
* ViewSet for MCP Servers.
|
|
2213
2564
|
*
|
|
@@ -2215,14 +2566,17 @@ export declare class AiMentorService {
|
|
|
2215
2566
|
*
|
|
2216
2567
|
* Permissions:
|
|
2217
2568
|
* - Accessible to tenant admins.
|
|
2218
|
-
* @param id A unique integer value identifying this mcp server.
|
|
2219
|
-
* @param org
|
|
2220
|
-
* @param userId
|
|
2221
|
-
* @param requestBody
|
|
2222
2569
|
* @returns MCPServer
|
|
2223
2570
|
* @throws ApiError
|
|
2224
2571
|
*/
|
|
2225
|
-
static aiMentorOrgsUsersMcpServersPartialUpdate(id
|
|
2572
|
+
static aiMentorOrgsUsersMcpServersPartialUpdate({ id, org, userId, requestBody, }: {
|
|
2573
|
+
/**
|
|
2574
|
+
* A unique integer value identifying this mcp server.
|
|
2575
|
+
*/
|
|
2576
|
+
id: number;
|
|
2577
|
+
org: string;
|
|
2578
|
+
requestBody?: PatchedMCPServer;
|
|
2579
|
+
}): CancelablePromise<MCPServer>;
|
|
2226
2580
|
/**
|
|
2227
2581
|
* ViewSet for MCP Servers.
|
|
2228
2582
|
*
|
|
@@ -2230,13 +2584,16 @@ export declare class AiMentorService {
|
|
|
2230
2584
|
*
|
|
2231
2585
|
* Permissions:
|
|
2232
2586
|
* - Accessible to tenant admins.
|
|
2233
|
-
* @param id A unique integer value identifying this mcp server.
|
|
2234
|
-
* @param org
|
|
2235
|
-
* @param userId
|
|
2236
2587
|
* @returns void
|
|
2237
2588
|
* @throws ApiError
|
|
2238
2589
|
*/
|
|
2239
|
-
static aiMentorOrgsUsersMcpServersDestroy(id
|
|
2590
|
+
static aiMentorOrgsUsersMcpServersDestroy({ id, org, userId, }: {
|
|
2591
|
+
/**
|
|
2592
|
+
* A unique integer value identifying this mcp server.
|
|
2593
|
+
*/
|
|
2594
|
+
id: number;
|
|
2595
|
+
org: string;
|
|
2596
|
+
}): CancelablePromise<void>;
|
|
2240
2597
|
/**
|
|
2241
2598
|
* Retrieve details of a specific user chat feedback entry.
|
|
2242
2599
|
*
|
|
@@ -2250,13 +2607,13 @@ export declare class AiMentorService {
|
|
|
2250
2607
|
*
|
|
2251
2608
|
* Raises:
|
|
2252
2609
|
* NotFound: If the specified feedback entry does not exist.
|
|
2253
|
-
* @param feedbackId
|
|
2254
|
-
* @param org
|
|
2255
|
-
* @param userId
|
|
2256
2610
|
* @returns UserChatFeedback
|
|
2257
2611
|
* @throws ApiError
|
|
2258
2612
|
*/
|
|
2259
|
-
static aiMentorOrgsUsersMentorFeedbackRetrieve(feedbackId
|
|
2613
|
+
static aiMentorOrgsUsersMentorFeedbackRetrieve({ feedbackId, org, userId, }: {
|
|
2614
|
+
feedbackId: number;
|
|
2615
|
+
org: string;
|
|
2616
|
+
}): CancelablePromise<UserChatFeedback>;
|
|
2260
2617
|
/**
|
|
2261
2618
|
* Update an existing user chat feedback entry.
|
|
2262
2619
|
*
|
|
@@ -2271,14 +2628,14 @@ export declare class AiMentorService {
|
|
|
2271
2628
|
* Raises:
|
|
2272
2629
|
* NotFound: If the specified feedback entry does not exist.
|
|
2273
2630
|
* BadRequest: If the provided data is invalid or the mentor does not exist.
|
|
2274
|
-
* @param feedbackId
|
|
2275
|
-
* @param org
|
|
2276
|
-
* @param userId
|
|
2277
|
-
* @param requestBody
|
|
2278
2631
|
* @returns UserChatFeedback
|
|
2279
2632
|
* @throws ApiError
|
|
2280
2633
|
*/
|
|
2281
|
-
static aiMentorOrgsUsersMentorFeedbackUpdate(feedbackId
|
|
2634
|
+
static aiMentorOrgsUsersMentorFeedbackUpdate({ feedbackId, org, userId, requestBody, }: {
|
|
2635
|
+
feedbackId: number;
|
|
2636
|
+
org: string;
|
|
2637
|
+
requestBody: UserChatFeedback;
|
|
2638
|
+
}): CancelablePromise<UserChatFeedback>;
|
|
2282
2639
|
/**
|
|
2283
2640
|
* Create a new user chat feedback entry.
|
|
2284
2641
|
*
|
|
@@ -2291,62 +2648,62 @@ export declare class AiMentorService {
|
|
|
2291
2648
|
*
|
|
2292
2649
|
* Raises:
|
|
2293
2650
|
* BadRequest: If the provided data is invalid or the mentor does not exist.
|
|
2294
|
-
* @param org
|
|
2295
|
-
* @param userId
|
|
2296
|
-
* @param requestBody
|
|
2297
2651
|
* @returns UserChatFeedback
|
|
2298
2652
|
* @throws ApiError
|
|
2299
2653
|
*/
|
|
2300
|
-
static aiMentorOrgsUsersMentorFeedbackCreateCreate(org
|
|
2654
|
+
static aiMentorOrgsUsersMentorFeedbackCreateCreate({ org, userId, requestBody, }: {
|
|
2655
|
+
org: string;
|
|
2656
|
+
requestBody: UserChatFeedback;
|
|
2657
|
+
}): CancelablePromise<UserChatFeedback>;
|
|
2301
2658
|
/**
|
|
2302
2659
|
* View to create a mentor from a template
|
|
2303
2660
|
*
|
|
2304
2661
|
* Accessible to only tenant admins.
|
|
2305
|
-
* @param org
|
|
2306
|
-
* @param userId
|
|
2307
|
-
* @param requestBody
|
|
2308
2662
|
* @returns Mentor
|
|
2309
2663
|
* @throws ApiError
|
|
2310
2664
|
*/
|
|
2311
|
-
static aiMentorOrgsUsersMentorFromTemplateCreate(org
|
|
2665
|
+
static aiMentorOrgsUsersMentorFromTemplateCreate({ org, userId, requestBody, }: {
|
|
2666
|
+
org: string;
|
|
2667
|
+
requestBody: MentorFromTemplateRequest;
|
|
2668
|
+
}): CancelablePromise<Mentor>;
|
|
2312
2669
|
/**
|
|
2313
2670
|
* Retrieve available LLMs for a user.
|
|
2314
|
-
* @param org
|
|
2315
|
-
* @param userId
|
|
2316
2671
|
* @returns LLMResponse
|
|
2317
2672
|
* @throws ApiError
|
|
2318
2673
|
*/
|
|
2319
|
-
static aiMentorOrgsUsersMentorLlmsList(org
|
|
2674
|
+
static aiMentorOrgsUsersMentorLlmsList({ org, userId, }: {
|
|
2675
|
+
org: string;
|
|
2676
|
+
}): CancelablePromise<Array<LLMResponse>>;
|
|
2320
2677
|
/**
|
|
2321
2678
|
* Retrieve the list of available mentor tools.
|
|
2322
|
-
* @param org
|
|
2323
|
-
* @param userId
|
|
2324
2679
|
* @returns ToolResponse
|
|
2325
2680
|
* @throws ApiError
|
|
2326
2681
|
*/
|
|
2327
|
-
static aiMentorOrgsUsersMentorToolsList(org
|
|
2682
|
+
static aiMentorOrgsUsersMentorToolsList({ org, userId, }: {
|
|
2683
|
+
org: string;
|
|
2684
|
+
}): CancelablePromise<Array<ToolResponse>>;
|
|
2328
2685
|
/**
|
|
2329
2686
|
* View to create a mentor from a template with settings.
|
|
2330
2687
|
*
|
|
2331
2688
|
* Accessible to tenant admins only.
|
|
2332
|
-
* @param org
|
|
2333
|
-
* @param userId
|
|
2334
|
-
* @param formData
|
|
2335
2689
|
* @returns Mentor
|
|
2336
2690
|
* @throws ApiError
|
|
2337
2691
|
*/
|
|
2338
|
-
static aiMentorOrgsUsersMentorWithSettingsCreate(org
|
|
2692
|
+
static aiMentorOrgsUsersMentorWithSettingsCreate({ org, userId, formData, }: {
|
|
2693
|
+
org: string;
|
|
2694
|
+
formData: MentorFromTemplateWithSettingRequest;
|
|
2695
|
+
}): CancelablePromise<Mentor>;
|
|
2339
2696
|
/**
|
|
2340
2697
|
* Retrieve the list of mentor audiences.
|
|
2341
2698
|
*
|
|
2342
2699
|
* Returns:
|
|
2343
2700
|
* - 200: List of mentor audiences.
|
|
2344
|
-
* @param org
|
|
2345
|
-
* @param userId
|
|
2346
2701
|
* @returns MentorAudience
|
|
2347
2702
|
* @throws ApiError
|
|
2348
2703
|
*/
|
|
2349
|
-
static aiMentorOrgsUsersMentorAudienceList(org
|
|
2704
|
+
static aiMentorOrgsUsersMentorAudienceList({ org, userId, }: {
|
|
2705
|
+
org: string;
|
|
2706
|
+
}): CancelablePromise<Array<MentorAudience>>;
|
|
2350
2707
|
/**
|
|
2351
2708
|
* Create a new mentor audience.
|
|
2352
2709
|
*
|
|
@@ -2355,13 +2712,13 @@ export declare class AiMentorService {
|
|
|
2355
2712
|
* Returns:
|
|
2356
2713
|
* - 201: Created mentor audience.
|
|
2357
2714
|
* - 401: Unauthorized.
|
|
2358
|
-
* @param org
|
|
2359
|
-
* @param userId
|
|
2360
|
-
* @param requestBody
|
|
2361
2715
|
* @returns MentorAudience
|
|
2362
2716
|
* @throws ApiError
|
|
2363
2717
|
*/
|
|
2364
|
-
static aiMentorOrgsUsersMentorAudienceCreate(org
|
|
2718
|
+
static aiMentorOrgsUsersMentorAudienceCreate({ org, userId, requestBody, }: {
|
|
2719
|
+
org: string;
|
|
2720
|
+
requestBody: MentorAudience;
|
|
2721
|
+
}): CancelablePromise<MentorAudience>;
|
|
2365
2722
|
/**
|
|
2366
2723
|
* Delete a mentor audience.
|
|
2367
2724
|
*
|
|
@@ -2372,23 +2729,23 @@ export declare class AiMentorService {
|
|
|
2372
2729
|
* - 400: Bad request if audience name is missing.
|
|
2373
2730
|
* - 404: Not found if audience does not exist.
|
|
2374
2731
|
* - 401: Unauthorized.
|
|
2375
|
-
* @param org
|
|
2376
|
-
* @param userId
|
|
2377
2732
|
* @returns void
|
|
2378
2733
|
* @throws ApiError
|
|
2379
2734
|
*/
|
|
2380
|
-
static aiMentorOrgsUsersMentorAudienceDestroy(org
|
|
2735
|
+
static aiMentorOrgsUsersMentorAudienceDestroy({ org, userId, }: {
|
|
2736
|
+
org: string;
|
|
2737
|
+
}): CancelablePromise<void>;
|
|
2381
2738
|
/**
|
|
2382
2739
|
* Retrieve a list of mentor categories.
|
|
2383
2740
|
*
|
|
2384
2741
|
* Returns:
|
|
2385
2742
|
* 200: A list of mentor categories.
|
|
2386
|
-
* @param org
|
|
2387
|
-
* @param userId
|
|
2388
2743
|
* @returns MentorCategory
|
|
2389
2744
|
* @throws ApiError
|
|
2390
2745
|
*/
|
|
2391
|
-
static aiMentorOrgsUsersMentorCategoriesList(org
|
|
2746
|
+
static aiMentorOrgsUsersMentorCategoriesList({ org, userId, }: {
|
|
2747
|
+
org: string;
|
|
2748
|
+
}): CancelablePromise<Array<MentorCategory>>;
|
|
2392
2749
|
/**
|
|
2393
2750
|
* Create a new mentor category.
|
|
2394
2751
|
*
|
|
@@ -2396,13 +2753,13 @@ export declare class AiMentorService {
|
|
|
2396
2753
|
*
|
|
2397
2754
|
* Returns:
|
|
2398
2755
|
* 200: Details of the created mentor category.
|
|
2399
|
-
* @param org
|
|
2400
|
-
* @param userId
|
|
2401
|
-
* @param requestBody
|
|
2402
2756
|
* @returns MentorCategory
|
|
2403
2757
|
* @throws ApiError
|
|
2404
2758
|
*/
|
|
2405
|
-
static aiMentorOrgsUsersMentorCategoriesCreate(org
|
|
2759
|
+
static aiMentorOrgsUsersMentorCategoriesCreate({ org, userId, requestBody, }: {
|
|
2760
|
+
org: string;
|
|
2761
|
+
requestBody: MentorCategoryCreate;
|
|
2762
|
+
}): CancelablePromise<MentorCategory>;
|
|
2406
2763
|
/**
|
|
2407
2764
|
* Delete a mentor category.
|
|
2408
2765
|
*
|
|
@@ -2411,12 +2768,12 @@ export declare class AiMentorService {
|
|
|
2411
2768
|
* Returns:
|
|
2412
2769
|
* 204: "No content" when Delete succeeded.
|
|
2413
2770
|
* 400: Bad request data received
|
|
2414
|
-
* @param org
|
|
2415
|
-
* @param userId
|
|
2416
2771
|
* @returns void
|
|
2417
2772
|
* @throws ApiError
|
|
2418
2773
|
*/
|
|
2419
|
-
static aiMentorOrgsUsersMentorCategoriesDestroy(org
|
|
2774
|
+
static aiMentorOrgsUsersMentorCategoriesDestroy({ org, userId, }: {
|
|
2775
|
+
org: string;
|
|
2776
|
+
}): CancelablePromise<void>;
|
|
2420
2777
|
/**
|
|
2421
2778
|
* Seed initial mentors in a tenant.
|
|
2422
2779
|
*
|
|
@@ -2430,30 +2787,30 @@ export declare class AiMentorService {
|
|
|
2430
2787
|
*
|
|
2431
2788
|
* Raises:
|
|
2432
2789
|
* BadRequest: If the seeding process fails.
|
|
2433
|
-
* @param org
|
|
2434
|
-
* @param userId
|
|
2435
2790
|
* @returns SeedMentorsView
|
|
2436
2791
|
* @throws ApiError
|
|
2437
2792
|
*/
|
|
2438
|
-
static aiMentorOrgsUsersMentorSeedRetrieve(org
|
|
2793
|
+
static aiMentorOrgsUsersMentorSeedRetrieve({ org, userId, }: {
|
|
2794
|
+
org: string;
|
|
2795
|
+
}): CancelablePromise<SeedMentorsView>;
|
|
2439
2796
|
/**
|
|
2440
2797
|
* Retrieve details of a specific mentor by slug or name.
|
|
2441
|
-
* @param mentor
|
|
2442
|
-
* @param org
|
|
2443
|
-
* @param userId
|
|
2444
2798
|
* @returns Mentor
|
|
2445
2799
|
* @throws ApiError
|
|
2446
2800
|
*/
|
|
2447
|
-
static aiMentorOrgsUsersMentorsRetrieve(mentor
|
|
2801
|
+
static aiMentorOrgsUsersMentorsRetrieve({ mentor, org, userId, }: {
|
|
2802
|
+
mentor: string;
|
|
2803
|
+
org: string;
|
|
2804
|
+
}): CancelablePromise<Mentor>;
|
|
2448
2805
|
/**
|
|
2449
2806
|
* Retrieve tools available for a particular mentor.
|
|
2450
|
-
* @param mentor
|
|
2451
|
-
* @param org
|
|
2452
|
-
* @param userId
|
|
2453
2807
|
* @returns ToolResponse
|
|
2454
2808
|
* @throws ApiError
|
|
2455
2809
|
*/
|
|
2456
|
-
static aiMentorOrgsUsersMentorsAvailableToolsList(mentor
|
|
2810
|
+
static aiMentorOrgsUsersMentorsAvailableToolsList({ mentor, org, userId, }: {
|
|
2811
|
+
mentor: string;
|
|
2812
|
+
org: string;
|
|
2813
|
+
}): CancelablePromise<Array<ToolResponse>>;
|
|
2457
2814
|
/**
|
|
2458
2815
|
* Generate IBL Call Pro authentication parameters for audio calls.
|
|
2459
2816
|
*
|
|
@@ -2472,14 +2829,14 @@ export declare class AiMentorService {
|
|
|
2472
2829
|
* Raises:
|
|
2473
2830
|
* ValidationError: If the request parameters are invalid.
|
|
2474
2831
|
* BadRequest: If the IBL Call Pro credentials are not properly configured.
|
|
2475
|
-
* @param mentor
|
|
2476
|
-
* @param org
|
|
2477
|
-
* @param userId
|
|
2478
|
-
* @param requestBody
|
|
2479
2832
|
* @returns CallAuthenticationResponse
|
|
2480
2833
|
* @throws ApiError
|
|
2481
2834
|
*/
|
|
2482
|
-
static aiMentorOrgsUsersMentorsCreateCallCredentialsCreate(mentor
|
|
2835
|
+
static aiMentorOrgsUsersMentorsCreateCallCredentialsCreate({ mentor, org, userId, requestBody, }: {
|
|
2836
|
+
mentor: string;
|
|
2837
|
+
org: string;
|
|
2838
|
+
requestBody: CallAuthenticationRequest;
|
|
2839
|
+
}): CancelablePromise<CallAuthenticationResponse>;
|
|
2483
2840
|
/**
|
|
2484
2841
|
* Retrieve memory components for a specific mentor.
|
|
2485
2842
|
*
|
|
@@ -2494,13 +2851,13 @@ export declare class AiMentorService {
|
|
|
2494
2851
|
*
|
|
2495
2852
|
* Raises:
|
|
2496
2853
|
* NotFound: If the specified mentor or memory does not exist.
|
|
2497
|
-
* @param mentor
|
|
2498
|
-
* @param org
|
|
2499
|
-
* @param userId
|
|
2500
2854
|
* @returns MemoryComponentResponse
|
|
2501
2855
|
* @throws ApiError
|
|
2502
2856
|
*/
|
|
2503
|
-
static aiMentorOrgsUsersMentorsCurrentMemoryRetrieve(mentor
|
|
2857
|
+
static aiMentorOrgsUsersMentorsCurrentMemoryRetrieve({ mentor, org, userId, }: {
|
|
2858
|
+
mentor: string;
|
|
2859
|
+
org: string;
|
|
2860
|
+
}): CancelablePromise<MemoryComponentResponse>;
|
|
2504
2861
|
/**
|
|
2505
2862
|
* Update memory components for a specific mentor.
|
|
2506
2863
|
*
|
|
@@ -2516,14 +2873,14 @@ export declare class AiMentorService {
|
|
|
2516
2873
|
* Raises:
|
|
2517
2874
|
* BadRequest: If the provided data is invalid.
|
|
2518
2875
|
* NotFound: If the specified mentor does not exist.
|
|
2519
|
-
* @param mentor
|
|
2520
|
-
* @param org
|
|
2521
|
-
* @param userId
|
|
2522
|
-
* @param requestBody
|
|
2523
2876
|
* @returns QuestionResponse
|
|
2524
2877
|
* @throws ApiError
|
|
2525
2878
|
*/
|
|
2526
|
-
static aiMentorOrgsUsersMentorsCurrentMemoryUpdate(mentor
|
|
2879
|
+
static aiMentorOrgsUsersMentorsCurrentMemoryUpdate({ mentor, org, userId, requestBody, }: {
|
|
2880
|
+
mentor: string;
|
|
2881
|
+
org: string;
|
|
2882
|
+
requestBody: QuestionRequest;
|
|
2883
|
+
}): CancelablePromise<QuestionResponse>;
|
|
2527
2884
|
/**
|
|
2528
2885
|
* Retrieve the current custom voice settings for a mentor.
|
|
2529
2886
|
*
|
|
@@ -2538,13 +2895,13 @@ export declare class AiMentorService {
|
|
|
2538
2895
|
*
|
|
2539
2896
|
* Raises:
|
|
2540
2897
|
* NotFound: If the specified mentor or student does not exist.
|
|
2541
|
-
* @param mentor
|
|
2542
|
-
* @param org
|
|
2543
|
-
* @param userId
|
|
2544
2898
|
* @returns MentorCustomVoiceResponse
|
|
2545
2899
|
* @throws ApiError
|
|
2546
2900
|
*/
|
|
2547
|
-
static aiMentorOrgsUsersMentorsCustomVoiceRetrieve(mentor
|
|
2901
|
+
static aiMentorOrgsUsersMentorsCustomVoiceRetrieve({ mentor, org, userId, }: {
|
|
2902
|
+
mentor: string;
|
|
2903
|
+
org: string;
|
|
2904
|
+
}): CancelablePromise<MentorCustomVoiceResponse>;
|
|
2548
2905
|
/**
|
|
2549
2906
|
* Set a custom voice for a mentor.
|
|
2550
2907
|
*
|
|
@@ -2563,14 +2920,14 @@ export declare class AiMentorService {
|
|
|
2563
2920
|
* Raises:
|
|
2564
2921
|
* BadRequest: If the provided data is invalid or the voice does not exist.
|
|
2565
2922
|
* NotFound: If the mentor or student does not exist.
|
|
2566
|
-
* @param mentor
|
|
2567
|
-
* @param org
|
|
2568
|
-
* @param userId
|
|
2569
|
-
* @param requestBody
|
|
2570
2923
|
* @returns MentorCustomVoiceResponse
|
|
2571
2924
|
* @throws ApiError
|
|
2572
2925
|
*/
|
|
2573
|
-
static aiMentorOrgsUsersMentorsCustomVoiceCreate(mentor
|
|
2926
|
+
static aiMentorOrgsUsersMentorsCustomVoiceCreate({ mentor, org, userId, requestBody, }: {
|
|
2927
|
+
mentor: string;
|
|
2928
|
+
org: string;
|
|
2929
|
+
requestBody: MentorCustomVoice;
|
|
2930
|
+
}): CancelablePromise<MentorCustomVoiceResponse>;
|
|
2574
2931
|
/**
|
|
2575
2932
|
* Generate audio from text using a mentor's custom voice.
|
|
2576
2933
|
*
|
|
@@ -2589,14 +2946,14 @@ export declare class AiMentorService {
|
|
|
2589
2946
|
* Raises:
|
|
2590
2947
|
* BadRequest: If the text is empty, credentials are not found, or custom voice is not set.
|
|
2591
2948
|
* NotFound: If the mentor or student does not exist.
|
|
2592
|
-
* @param mentor
|
|
2593
|
-
* @param org
|
|
2594
|
-
* @param userId
|
|
2595
|
-
* @param formData
|
|
2596
2949
|
* @returns any MP3 audio file
|
|
2597
2950
|
* @throws ApiError
|
|
2598
2951
|
*/
|
|
2599
|
-
static aiMentorOrgsUsersMentorsCustomVoiceTtsCreate(mentor
|
|
2952
|
+
static aiMentorOrgsUsersMentorsCustomVoiceTtsCreate({ mentor, org, userId, formData, }: {
|
|
2953
|
+
mentor: string;
|
|
2954
|
+
org: string;
|
|
2955
|
+
formData?: Record<string, any>;
|
|
2956
|
+
}): CancelablePromise<any>;
|
|
2600
2957
|
/**
|
|
2601
2958
|
* Update scenarios for a specific mentor.
|
|
2602
2959
|
*
|
|
@@ -2612,14 +2969,14 @@ export declare class AiMentorService {
|
|
|
2612
2969
|
* Raises:
|
|
2613
2970
|
* BadRequest: If the provided data is invalid.
|
|
2614
2971
|
* NotFound: If the specified mentor does not exist.
|
|
2615
|
-
* @param mentor
|
|
2616
|
-
* @param org
|
|
2617
|
-
* @param userId
|
|
2618
|
-
* @param requestBody
|
|
2619
2972
|
* @returns MentorScenario
|
|
2620
2973
|
* @throws ApiError
|
|
2621
2974
|
*/
|
|
2622
|
-
static aiMentorOrgsUsersMentorsEditScenariosUpdate(mentor
|
|
2975
|
+
static aiMentorOrgsUsersMentorsEditScenariosUpdate({ mentor, org, userId, requestBody, }: {
|
|
2976
|
+
mentor: string;
|
|
2977
|
+
org: string;
|
|
2978
|
+
requestBody: MentorScenario;
|
|
2979
|
+
}): CancelablePromise<MentorScenario>;
|
|
2623
2980
|
/**
|
|
2624
2981
|
* Fork (clone) an existing mentor.
|
|
2625
2982
|
*
|
|
@@ -2635,14 +2992,14 @@ export declare class AiMentorService {
|
|
|
2635
2992
|
* Raises:
|
|
2636
2993
|
* BadRequest: If the provided data is invalid or the fork operation fails.
|
|
2637
2994
|
* NotFound: If the specified mentor does not exist.
|
|
2638
|
-
* @param mentor
|
|
2639
|
-
* @param org
|
|
2640
|
-
* @param userId
|
|
2641
|
-
* @param requestBody
|
|
2642
2995
|
* @returns Mentor
|
|
2643
2996
|
* @throws ApiError
|
|
2644
2997
|
*/
|
|
2645
|
-
static aiMentorOrgsUsersMentorsForkCreate(mentor
|
|
2998
|
+
static aiMentorOrgsUsersMentorsForkCreate({ mentor, org, userId, requestBody, }: {
|
|
2999
|
+
mentor: string;
|
|
3000
|
+
org: string;
|
|
3001
|
+
requestBody: MentorFork;
|
|
3002
|
+
}): CancelablePromise<Mentor>;
|
|
2646
3003
|
/**
|
|
2647
3004
|
* Retrieve memory history entries for a specific mentor and user.
|
|
2648
3005
|
*
|
|
@@ -2657,22 +3014,22 @@ export declare class AiMentorService {
|
|
|
2657
3014
|
*
|
|
2658
3015
|
* Raises:
|
|
2659
3016
|
* NotFound: If the specified mentor or memory history does not exist.
|
|
2660
|
-
* @param mentor
|
|
2661
|
-
* @param org
|
|
2662
|
-
* @param userId
|
|
2663
3017
|
* @returns MemoryComponentMemoryDetail
|
|
2664
3018
|
* @throws ApiError
|
|
2665
3019
|
*/
|
|
2666
|
-
static aiMentorOrgsUsersMentorsHistoricalMemoryRetrieve(mentor
|
|
3020
|
+
static aiMentorOrgsUsersMentorsHistoricalMemoryRetrieve({ mentor, org, userId, }: {
|
|
3021
|
+
mentor: string;
|
|
3022
|
+
org: string;
|
|
3023
|
+
}): CancelablePromise<MemoryComponentMemoryDetail>;
|
|
2667
3024
|
/**
|
|
2668
3025
|
* Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
|
|
2669
|
-
* @param mentor
|
|
2670
|
-
* @param org
|
|
2671
|
-
* @param userId
|
|
2672
3026
|
* @returns MemoryProgress
|
|
2673
3027
|
* @throws ApiError
|
|
2674
3028
|
*/
|
|
2675
|
-
static aiMentorOrgsUsersMentorsMemoryProgressRetrieve(mentor
|
|
3029
|
+
static aiMentorOrgsUsersMentorsMemoryProgressRetrieve({ mentor, org, userId, }: {
|
|
3030
|
+
mentor: string;
|
|
3031
|
+
org: string;
|
|
3032
|
+
}): CancelablePromise<MemoryProgress>;
|
|
2676
3033
|
/**
|
|
2677
3034
|
* Retrieve memory settings for a specific mentor.
|
|
2678
3035
|
*
|
|
@@ -2687,13 +3044,13 @@ export declare class AiMentorService {
|
|
|
2687
3044
|
*
|
|
2688
3045
|
* Raises:
|
|
2689
3046
|
* NotFound: If the specified mentor or settings do not exist.
|
|
2690
|
-
* @param mentor
|
|
2691
|
-
* @param org
|
|
2692
|
-
* @param userId
|
|
2693
3047
|
* @returns MentorMemorySettingsResponse
|
|
2694
3048
|
* @throws ApiError
|
|
2695
3049
|
*/
|
|
2696
|
-
static aiMentorOrgsUsersMentorsMemorySettingsRetrieve(mentor
|
|
3050
|
+
static aiMentorOrgsUsersMentorsMemorySettingsRetrieve({ mentor, org, userId, }: {
|
|
3051
|
+
mentor: string;
|
|
3052
|
+
org: string;
|
|
3053
|
+
}): CancelablePromise<MentorMemorySettingsResponse>;
|
|
2697
3054
|
/**
|
|
2698
3055
|
* Endpoint for mentor memory item settings.
|
|
2699
3056
|
*
|
|
@@ -2704,14 +3061,14 @@ export declare class AiMentorService {
|
|
|
2704
3061
|
* 200: Change mentor memory component item.
|
|
2705
3062
|
*
|
|
2706
3063
|
* 400: When request is not valid.
|
|
2707
|
-
* @param mentor
|
|
2708
|
-
* @param org
|
|
2709
|
-
* @param userId
|
|
2710
|
-
* @param requestBody
|
|
2711
3064
|
* @returns MentorMemorySettingsResponse
|
|
2712
3065
|
* @throws ApiError
|
|
2713
3066
|
*/
|
|
2714
|
-
static aiMentorOrgsUsersMentorsMemorySettingsCreate(mentor
|
|
3067
|
+
static aiMentorOrgsUsersMentorsMemorySettingsCreate({ mentor, org, userId, requestBody, }: {
|
|
3068
|
+
mentor: string;
|
|
3069
|
+
org: string;
|
|
3070
|
+
requestBody?: MentorMemorySettingsRequest;
|
|
3071
|
+
}): CancelablePromise<MentorMemorySettingsResponse>;
|
|
2715
3072
|
/**
|
|
2716
3073
|
* Retrieve evaluation criteria for a specific mentor.
|
|
2717
3074
|
*
|
|
@@ -2726,13 +3083,13 @@ export declare class AiMentorService {
|
|
|
2726
3083
|
*
|
|
2727
3084
|
* Raises:
|
|
2728
3085
|
* NotFound: If the specified mentor or evaluations do not exist.
|
|
2729
|
-
* @param mentor
|
|
2730
|
-
* @param org
|
|
2731
|
-
* @param userId
|
|
2732
3086
|
* @returns MentorEval
|
|
2733
3087
|
* @throws ApiError
|
|
2734
3088
|
*/
|
|
2735
|
-
static aiMentorOrgsUsersMentorsMentorEvalRetrieve(mentor
|
|
3089
|
+
static aiMentorOrgsUsersMentorsMentorEvalRetrieve({ mentor, org, userId, }: {
|
|
3090
|
+
mentor: string;
|
|
3091
|
+
org: string;
|
|
3092
|
+
}): CancelablePromise<MentorEval>;
|
|
2736
3093
|
/**
|
|
2737
3094
|
* Create or update evaluation criteria for a specific mentor.
|
|
2738
3095
|
*
|
|
@@ -2747,14 +3104,14 @@ export declare class AiMentorService {
|
|
|
2747
3104
|
*
|
|
2748
3105
|
* Raises:
|
|
2749
3106
|
* BadRequest: If the provided data is invalid or the mentor does not exist.
|
|
2750
|
-
* @param mentor
|
|
2751
|
-
* @param org
|
|
2752
|
-
* @param userId
|
|
2753
|
-
* @param requestBody
|
|
2754
3107
|
* @returns MentorEval
|
|
2755
3108
|
* @throws ApiError
|
|
2756
3109
|
*/
|
|
2757
|
-
static aiMentorOrgsUsersMentorsMentorEvalCreate(mentor
|
|
3110
|
+
static aiMentorOrgsUsersMentorsMentorEvalCreate({ mentor, org, userId, requestBody, }: {
|
|
3111
|
+
mentor: string;
|
|
3112
|
+
org: string;
|
|
3113
|
+
requestBody?: MentorEvalRequest;
|
|
3114
|
+
}): CancelablePromise<MentorEval>;
|
|
2758
3115
|
/**
|
|
2759
3116
|
* Run an evaluation for a specific mentor.
|
|
2760
3117
|
*
|
|
@@ -2769,14 +3126,14 @@ export declare class AiMentorService {
|
|
|
2769
3126
|
*
|
|
2770
3127
|
* Raises:
|
|
2771
3128
|
* BadRequest: If the evaluation ID is invalid or the mentor does not match.
|
|
2772
|
-
* @param mentor
|
|
2773
|
-
* @param org
|
|
2774
|
-
* @param userId
|
|
2775
|
-
* @param requestBody
|
|
2776
3129
|
* @returns any Evaluation execution started successfully
|
|
2777
3130
|
* @throws ApiError
|
|
2778
3131
|
*/
|
|
2779
|
-
static aiMentorOrgsUsersMentorsMentorEvalExecutionCreate(mentor
|
|
3132
|
+
static aiMentorOrgsUsersMentorsMentorEvalExecutionCreate({ mentor, org, userId, requestBody, }: {
|
|
3133
|
+
mentor: string;
|
|
3134
|
+
org: string;
|
|
3135
|
+
requestBody: RunMentorEval;
|
|
3136
|
+
}): CancelablePromise<any>;
|
|
2780
3137
|
/**
|
|
2781
3138
|
* Retrieve public mentor settings.
|
|
2782
3139
|
*
|
|
@@ -2788,13 +3145,13 @@ export declare class AiMentorService {
|
|
|
2788
3145
|
*
|
|
2789
3146
|
* Returns:
|
|
2790
3147
|
* Response containing the mentor settings or an error message.
|
|
2791
|
-
* @param mentor
|
|
2792
|
-
* @param org
|
|
2793
|
-
* @param userId
|
|
2794
3148
|
* @returns MentorSettingsPublic
|
|
2795
3149
|
* @throws ApiError
|
|
2796
3150
|
*/
|
|
2797
|
-
static aiMentorOrgsUsersMentorsPublicSettingsRetrieve(mentor
|
|
3151
|
+
static aiMentorOrgsUsersMentorsPublicSettingsRetrieve({ mentor, org, userId, }: {
|
|
3152
|
+
mentor: string;
|
|
3153
|
+
org: string;
|
|
3154
|
+
}): CancelablePromise<MentorSettingsPublic>;
|
|
2798
3155
|
/**
|
|
2799
3156
|
* Retrieve a specific evaluation report.
|
|
2800
3157
|
*
|
|
@@ -2810,14 +3167,14 @@ export declare class AiMentorService {
|
|
|
2810
3167
|
*
|
|
2811
3168
|
* Raises:
|
|
2812
3169
|
* BadRequest: If the report does not exist, does not match the mentor, or is still being generated.
|
|
2813
|
-
* @param mentor
|
|
2814
|
-
* @param org
|
|
2815
|
-
* @param reportId
|
|
2816
|
-
* @param userId
|
|
2817
3170
|
* @returns MentorEvalReport
|
|
2818
3171
|
* @throws ApiError
|
|
2819
3172
|
*/
|
|
2820
|
-
static aiMentorOrgsUsersMentorsReportsMentorEvalReportRetrieve(mentor
|
|
3173
|
+
static aiMentorOrgsUsersMentorsReportsMentorEvalReportRetrieve({ mentor, org, reportId, userId, }: {
|
|
3174
|
+
mentor: string;
|
|
3175
|
+
org: string;
|
|
3176
|
+
reportId: number;
|
|
3177
|
+
}): CancelablePromise<MentorEvalReport>;
|
|
2821
3178
|
/**
|
|
2822
3179
|
* Retrieve available scenarios for a specific mentor.
|
|
2823
3180
|
*
|
|
@@ -2832,36 +3189,40 @@ export declare class AiMentorService {
|
|
|
2832
3189
|
*
|
|
2833
3190
|
* Raises:
|
|
2834
3191
|
* NotFound: If the specified mentor or scenarios do not exist.
|
|
2835
|
-
* @param mentor
|
|
2836
|
-
* @param org
|
|
2837
|
-
* @param userId
|
|
2838
3192
|
* @returns MentorScenario
|
|
2839
3193
|
* @throws ApiError
|
|
2840
3194
|
*/
|
|
2841
|
-
static aiMentorOrgsUsersMentorsScenariosRetrieve(mentor
|
|
3195
|
+
static aiMentorOrgsUsersMentorsScenariosRetrieve({ mentor, org, userId, }: {
|
|
3196
|
+
mentor: string;
|
|
3197
|
+
org: string;
|
|
3198
|
+
}): CancelablePromise<MentorScenario>;
|
|
2842
3199
|
/**
|
|
2843
3200
|
* Retrieve Mentor Settings
|
|
2844
3201
|
* Fetch the settings of a mentor within an organization. Only accessible to tenant admins.
|
|
2845
|
-
* @param mentor
|
|
2846
|
-
* @param org
|
|
2847
|
-
* @param userId
|
|
2848
|
-
* @param departmentId Department to authorize users by
|
|
2849
3202
|
* @returns MentorSettingsPublic
|
|
2850
3203
|
* @throws ApiError
|
|
2851
3204
|
*/
|
|
2852
|
-
static aiMentorOrgsUsersMentorsSettingsRetrieve(mentor
|
|
3205
|
+
static aiMentorOrgsUsersMentorsSettingsRetrieve({ mentor, org, userId, departmentId, }: {
|
|
3206
|
+
mentor: string;
|
|
3207
|
+
org: string; /**
|
|
3208
|
+
* Department to authorize users by
|
|
3209
|
+
*/
|
|
3210
|
+
departmentId?: number;
|
|
3211
|
+
}): CancelablePromise<MentorSettingsPublic>;
|
|
2853
3212
|
/**
|
|
2854
3213
|
* Update Mentor Settings
|
|
2855
3214
|
* Update various mentor settings including system prompts, tool permissions, and UI configurations.
|
|
2856
|
-
* @param mentor
|
|
2857
|
-
* @param org
|
|
2858
|
-
* @param userId
|
|
2859
|
-
* @param departmentId Department to authorize users by
|
|
2860
|
-
* @param formData
|
|
2861
3215
|
* @returns MentorSettings
|
|
2862
3216
|
* @throws ApiError
|
|
2863
3217
|
*/
|
|
2864
|
-
static aiMentorOrgsUsersMentorsSettingsUpdate(mentor
|
|
3218
|
+
static aiMentorOrgsUsersMentorsSettingsUpdate({ mentor, org, userId, departmentId, formData, }: {
|
|
3219
|
+
mentor: string;
|
|
3220
|
+
org: string; /**
|
|
3221
|
+
* Department to authorize users by
|
|
3222
|
+
*/
|
|
3223
|
+
departmentId?: number;
|
|
3224
|
+
formData?: MentorSettingsRequest;
|
|
3225
|
+
}): CancelablePromise<MentorSettings>;
|
|
2865
3226
|
/**
|
|
2866
3227
|
* Retrieve spaced repetition question statistics.
|
|
2867
3228
|
*
|
|
@@ -2876,13 +3237,13 @@ export declare class AiMentorService {
|
|
|
2876
3237
|
*
|
|
2877
3238
|
* Raises:
|
|
2878
3239
|
* NotFound: If the mentor or student does not exist.
|
|
2879
|
-
* @param mentor
|
|
2880
|
-
* @param org
|
|
2881
|
-
* @param userId
|
|
2882
3240
|
* @returns SpacedRepetitionQuestionStats
|
|
2883
3241
|
* @throws ApiError
|
|
2884
3242
|
*/
|
|
2885
|
-
static aiMentorOrgsUsersMentorsSpacedRepetitionQuestionStatsRetrieve(mentor
|
|
3243
|
+
static aiMentorOrgsUsersMentorsSpacedRepetitionQuestionStatsRetrieve({ mentor, org, userId, }: {
|
|
3244
|
+
mentor: string;
|
|
3245
|
+
org: string;
|
|
3246
|
+
}): CancelablePromise<SpacedRepetitionQuestionStats>;
|
|
2886
3247
|
/**
|
|
2887
3248
|
* Retrieve a list of learning paths associated with a specific mentor and student.
|
|
2888
3249
|
*
|
|
@@ -2907,13 +3268,13 @@ export declare class AiMentorService {
|
|
|
2907
3268
|
* Raises:
|
|
2908
3269
|
* NotFound: If the memory component for the specified mentor and student cannot be found,
|
|
2909
3270
|
* or if the organization identifier does not match the mentor's platform key.
|
|
2910
|
-
* @param mentor
|
|
2911
|
-
* @param org
|
|
2912
|
-
* @param userId
|
|
2913
3271
|
* @returns QuestionCardTag
|
|
2914
3272
|
* @throws ApiError
|
|
2915
3273
|
*/
|
|
2916
|
-
static aiMentorOrgsUsersMentorsSpacedRepetitionRecommendedPathsList(mentor
|
|
3274
|
+
static aiMentorOrgsUsersMentorsSpacedRepetitionRecommendedPathsList({ mentor, org, userId, }: {
|
|
3275
|
+
mentor: string;
|
|
3276
|
+
org: string;
|
|
3277
|
+
}): CancelablePromise<Array<QuestionCardTag>>;
|
|
2917
3278
|
/**
|
|
2918
3279
|
* Set a specific learning path for spaced repetition.
|
|
2919
3280
|
*
|
|
@@ -2929,14 +3290,14 @@ export declare class AiMentorService {
|
|
|
2929
3290
|
* Raises:
|
|
2930
3291
|
* BadRequest: If the provided data is invalid.
|
|
2931
3292
|
* NotFound: If the learning path, mentor, or student does not exist.
|
|
2932
|
-
* @param mentor
|
|
2933
|
-
* @param org
|
|
2934
|
-
* @param userId
|
|
2935
|
-
* @param requestBody
|
|
2936
3293
|
* @returns SpacedRepetitionLearningPath
|
|
2937
3294
|
* @throws ApiError
|
|
2938
3295
|
*/
|
|
2939
|
-
static aiMentorOrgsUsersMentorsSpacedRepetitionRecommendedPathsUpdate(mentor
|
|
3296
|
+
static aiMentorOrgsUsersMentorsSpacedRepetitionRecommendedPathsUpdate({ mentor, org, userId, requestBody, }: {
|
|
3297
|
+
mentor: string;
|
|
3298
|
+
org: string;
|
|
3299
|
+
requestBody: SpacedRepetitionLearningPath;
|
|
3300
|
+
}): CancelablePromise<SpacedRepetitionLearningPath>;
|
|
2940
3301
|
/**
|
|
2941
3302
|
* Endpoint for getting the star status of a mentor.
|
|
2942
3303
|
*
|
|
@@ -2948,13 +3309,13 @@ export declare class AiMentorService {
|
|
|
2948
3309
|
* 200: Star status.
|
|
2949
3310
|
*
|
|
2950
3311
|
* 400: When request is not valid.
|
|
2951
|
-
* @param mentor
|
|
2952
|
-
* @param org
|
|
2953
|
-
* @param userId
|
|
2954
3312
|
* @returns StarMentor
|
|
2955
3313
|
* @throws ApiError
|
|
2956
3314
|
*/
|
|
2957
|
-
static aiMentorOrgsUsersMentorsStarRetrieve(mentor
|
|
3315
|
+
static aiMentorOrgsUsersMentorsStarRetrieve({ mentor, org, userId, }: {
|
|
3316
|
+
mentor: string;
|
|
3317
|
+
org: string;
|
|
3318
|
+
}): CancelablePromise<StarMentor>;
|
|
2958
3319
|
/**
|
|
2959
3320
|
* Endpoint for starring a mentor.
|
|
2960
3321
|
*
|
|
@@ -2966,13 +3327,13 @@ export declare class AiMentorService {
|
|
|
2966
3327
|
* 200: Star status.
|
|
2967
3328
|
*
|
|
2968
3329
|
* 400: When request is not valid.
|
|
2969
|
-
* @param mentor
|
|
2970
|
-
* @param org
|
|
2971
|
-
* @param userId
|
|
2972
3330
|
* @returns StarMentor
|
|
2973
3331
|
* @throws ApiError
|
|
2974
3332
|
*/
|
|
2975
|
-
static aiMentorOrgsUsersMentorsStarCreate(mentor
|
|
3333
|
+
static aiMentorOrgsUsersMentorsStarCreate({ mentor, org, userId, }: {
|
|
3334
|
+
mentor: string;
|
|
3335
|
+
org: string;
|
|
3336
|
+
}): CancelablePromise<StarMentor>;
|
|
2976
3337
|
/**
|
|
2977
3338
|
* Remove a mentor from a user's starred list.
|
|
2978
3339
|
*
|
|
@@ -2988,13 +3349,13 @@ export declare class AiMentorService {
|
|
|
2988
3349
|
* Raises:
|
|
2989
3350
|
* NotFound: If the specified mentor or student does not exist.
|
|
2990
3351
|
* BadRequest: If the request is invalid.
|
|
2991
|
-
* @param mentor
|
|
2992
|
-
* @param org
|
|
2993
|
-
* @param userId
|
|
2994
3352
|
* @returns StarMentor
|
|
2995
3353
|
* @throws ApiError
|
|
2996
3354
|
*/
|
|
2997
|
-
static aiMentorOrgsUsersMentorsUnstarCreate(mentor
|
|
3355
|
+
static aiMentorOrgsUsersMentorsUnstarCreate({ mentor, org, userId, }: {
|
|
3356
|
+
mentor: string;
|
|
3357
|
+
org: string;
|
|
3358
|
+
}): CancelablePromise<StarMentor>;
|
|
2998
3359
|
/**
|
|
2999
3360
|
* Retrieve metadata for a mentor.
|
|
3000
3361
|
*
|
|
@@ -3008,12 +3369,12 @@ export declare class AiMentorService {
|
|
|
3008
3369
|
*
|
|
3009
3370
|
* Raises:
|
|
3010
3371
|
* NotFound: If no metadata exists for the specified mentor.
|
|
3011
|
-
* @param org
|
|
3012
|
-
* @param userId
|
|
3013
3372
|
* @returns MentorMetadata
|
|
3014
3373
|
* @throws ApiError
|
|
3015
3374
|
*/
|
|
3016
|
-
static aiMentorOrgsUsersMetadataRetrieve(org
|
|
3375
|
+
static aiMentorOrgsUsersMetadataRetrieve({ org, userId, }: {
|
|
3376
|
+
org: string;
|
|
3377
|
+
}): CancelablePromise<MentorMetadata>;
|
|
3017
3378
|
/**
|
|
3018
3379
|
* Endpoint to view and delete Moderation Logs for a tenant.
|
|
3019
3380
|
*
|
|
@@ -3021,21 +3382,31 @@ export declare class AiMentorService {
|
|
|
3021
3382
|
*
|
|
3022
3383
|
*
|
|
3023
3384
|
* A search query can be conducted to search through the prompts and reason for the moderation catch event.
|
|
3024
|
-
* @param org
|
|
3025
|
-
* @param userId
|
|
3026
|
-
* @param mentor
|
|
3027
|
-
* @param ordering Which field to use when ordering the results.
|
|
3028
|
-
* @param page A page number within the paginated result set.
|
|
3029
|
-
* @param pageSize Number of results to return per page.
|
|
3030
|
-
* @param platformKey
|
|
3031
|
-
* @param search A search term.
|
|
3032
|
-
* @param targetSystem * `Safety System` - Safety System
|
|
3033
|
-
* * `Moderation System` - Moderation System
|
|
3034
|
-
* @param username
|
|
3035
3385
|
* @returns PaginatedModerationLogList
|
|
3036
3386
|
* @throws ApiError
|
|
3037
3387
|
*/
|
|
3038
|
-
static aiMentorOrgsUsersModerationLogsList(org
|
|
3388
|
+
static aiMentorOrgsUsersModerationLogsList({ org, userId, mentor, ordering, page, pageSize, platformKey, search, targetSystem, username, }: {
|
|
3389
|
+
org: string;
|
|
3390
|
+
mentor?: number; /**
|
|
3391
|
+
* Which field to use when ordering the results.
|
|
3392
|
+
*/
|
|
3393
|
+
ordering?: string; /**
|
|
3394
|
+
* A page number within the paginated result set.
|
|
3395
|
+
*/
|
|
3396
|
+
page?: number; /**
|
|
3397
|
+
* Number of results to return per page.
|
|
3398
|
+
*/
|
|
3399
|
+
pageSize?: number;
|
|
3400
|
+
platformKey?: string; /**
|
|
3401
|
+
* A search term.
|
|
3402
|
+
*/
|
|
3403
|
+
search?: string; /**
|
|
3404
|
+
* * `Safety System` - Safety System
|
|
3405
|
+
* * `Moderation System` - Moderation System
|
|
3406
|
+
*/
|
|
3407
|
+
targetSystem?: 'Moderation System' | 'Safety System';
|
|
3408
|
+
username?: string;
|
|
3409
|
+
}): CancelablePromise<PaginatedModerationLogList>;
|
|
3039
3410
|
/**
|
|
3040
3411
|
* Endpoint to view and delete Moderation Logs for a tenant.
|
|
3041
3412
|
*
|
|
@@ -3043,13 +3414,16 @@ export declare class AiMentorService {
|
|
|
3043
3414
|
*
|
|
3044
3415
|
*
|
|
3045
3416
|
* A search query can be conducted to search through the prompts and reason for the moderation catch event.
|
|
3046
|
-
* @param id A unique integer value identifying this moderation log.
|
|
3047
|
-
* @param org
|
|
3048
|
-
* @param userId
|
|
3049
3417
|
* @returns ModerationLog
|
|
3050
3418
|
* @throws ApiError
|
|
3051
3419
|
*/
|
|
3052
|
-
static aiMentorOrgsUsersModerationLogsRetrieve(id
|
|
3420
|
+
static aiMentorOrgsUsersModerationLogsRetrieve({ id, org, userId, }: {
|
|
3421
|
+
/**
|
|
3422
|
+
* A unique integer value identifying this moderation log.
|
|
3423
|
+
*/
|
|
3424
|
+
id: number;
|
|
3425
|
+
org: string;
|
|
3426
|
+
}): CancelablePromise<ModerationLog>;
|
|
3053
3427
|
/**
|
|
3054
3428
|
* Endpoint to view and delete Moderation Logs for a tenant.
|
|
3055
3429
|
*
|
|
@@ -3057,13 +3431,16 @@ export declare class AiMentorService {
|
|
|
3057
3431
|
*
|
|
3058
3432
|
*
|
|
3059
3433
|
* A search query can be conducted to search through the prompts and reason for the moderation catch event.
|
|
3060
|
-
* @param id A unique integer value identifying this moderation log.
|
|
3061
|
-
* @param org
|
|
3062
|
-
* @param userId
|
|
3063
3434
|
* @returns void
|
|
3064
3435
|
* @throws ApiError
|
|
3065
3436
|
*/
|
|
3066
|
-
static aiMentorOrgsUsersModerationLogsDestroy(id
|
|
3437
|
+
static aiMentorOrgsUsersModerationLogsDestroy({ id, org, userId, }: {
|
|
3438
|
+
/**
|
|
3439
|
+
* A unique integer value identifying this moderation log.
|
|
3440
|
+
*/
|
|
3441
|
+
id: number;
|
|
3442
|
+
org: string;
|
|
3443
|
+
}): CancelablePromise<void>;
|
|
3067
3444
|
/**
|
|
3068
3445
|
* Endpoint to view logs for periodic agent runs.
|
|
3069
3446
|
*
|
|
@@ -3071,23 +3448,33 @@ export declare class AiMentorService {
|
|
|
3071
3448
|
* Logs are ordered from newest to oldest. However this can be changed.
|
|
3072
3449
|
*
|
|
3073
3450
|
* You can also filter logs for a PeriodicAgent by passing the `periodic_agent` query parameter in the URL.
|
|
3074
|
-
* @param org
|
|
3075
|
-
* @param userId
|
|
3076
|
-
* @param ordering Which field to use when ordering the results.
|
|
3077
|
-
* @param page A page number within the paginated result set.
|
|
3078
|
-
* @param pageSize Number of results to return per page.
|
|
3079
|
-
* @param parentMentorId
|
|
3080
|
-
* @param parentSessionId
|
|
3081
|
-
* @param periodicAgent
|
|
3082
|
-
* @param search A search term.
|
|
3083
|
-
* @param status * `success` - Success
|
|
3084
|
-
* * `error` - Error
|
|
3085
|
-
* * `running` - Running
|
|
3086
|
-
* @param username
|
|
3087
3451
|
* @returns PaginatedPeriodicAgentLogList
|
|
3088
3452
|
* @throws ApiError
|
|
3089
3453
|
*/
|
|
3090
|
-
static aiMentorOrgsUsersPeriodicAgentLogsList(org
|
|
3454
|
+
static aiMentorOrgsUsersPeriodicAgentLogsList({ org, userId, ordering, page, pageSize, parentMentorId, parentSessionId, periodicAgent, search, status, username, }: {
|
|
3455
|
+
org: string; /**
|
|
3456
|
+
* Which field to use when ordering the results.
|
|
3457
|
+
*/
|
|
3458
|
+
ordering?: string; /**
|
|
3459
|
+
* A page number within the paginated result set.
|
|
3460
|
+
*/
|
|
3461
|
+
page?: number; /**
|
|
3462
|
+
* Number of results to return per page.
|
|
3463
|
+
*/
|
|
3464
|
+
pageSize?: number;
|
|
3465
|
+
parentMentorId?: string;
|
|
3466
|
+
parentSessionId?: string;
|
|
3467
|
+
periodicAgent?: number; /**
|
|
3468
|
+
* A search term.
|
|
3469
|
+
*/
|
|
3470
|
+
search?: string; /**
|
|
3471
|
+
* * `success` - Success
|
|
3472
|
+
* * `error` - Error
|
|
3473
|
+
* * `running` - Running
|
|
3474
|
+
*/
|
|
3475
|
+
status?: 'error' | 'running' | 'success';
|
|
3476
|
+
username?: string;
|
|
3477
|
+
}): CancelablePromise<PaginatedPeriodicAgentLogList>;
|
|
3091
3478
|
/**
|
|
3092
3479
|
* Endpoint to view logs for periodic agent runs.
|
|
3093
3480
|
*
|
|
@@ -3095,13 +3482,16 @@ export declare class AiMentorService {
|
|
|
3095
3482
|
* Logs are ordered from newest to oldest. However this can be changed.
|
|
3096
3483
|
*
|
|
3097
3484
|
* You can also filter logs for a PeriodicAgent by passing the `periodic_agent` query parameter in the URL.
|
|
3098
|
-
* @param id A unique integer value identifying this periodic agent log.
|
|
3099
|
-
* @param org
|
|
3100
|
-
* @param userId
|
|
3101
3485
|
* @returns PeriodicAgentLog
|
|
3102
3486
|
* @throws ApiError
|
|
3103
3487
|
*/
|
|
3104
|
-
static aiMentorOrgsUsersPeriodicAgentLogsRetrieve(id
|
|
3488
|
+
static aiMentorOrgsUsersPeriodicAgentLogsRetrieve({ id, org, userId, }: {
|
|
3489
|
+
/**
|
|
3490
|
+
* A unique integer value identifying this periodic agent log.
|
|
3491
|
+
*/
|
|
3492
|
+
id: number;
|
|
3493
|
+
org: string;
|
|
3494
|
+
}): CancelablePromise<PeriodicAgentLog>;
|
|
3105
3495
|
/**
|
|
3106
3496
|
* Endpoint to create and view, update and delete periodic agents.
|
|
3107
3497
|
*
|
|
@@ -3166,32 +3556,44 @@ export declare class AiMentorService {
|
|
|
3166
3556
|
* return False
|
|
3167
3557
|
*
|
|
3168
3558
|
* ```
|
|
3169
|
-
* @param org
|
|
3170
|
-
* @param userId
|
|
3171
|
-
* @param enabled
|
|
3172
|
-
* @param ordering Which field to use when ordering the results.
|
|
3173
|
-
* @param page A page number within the paginated result set.
|
|
3174
|
-
* @param pageSize Number of results to return per page.
|
|
3175
|
-
* @param parentMentorId
|
|
3176
|
-
* @param parentSessionId
|
|
3177
|
-
* @param previousAgent
|
|
3178
|
-
* @param previousAgentStatus The status that the previous agent must be in before this agent gets scheduled.
|
|
3179
|
-
*
|
|
3180
|
-
* * `success` - Success
|
|
3181
|
-
* * `error` - Error
|
|
3182
|
-
* * `running` - Running
|
|
3183
|
-
* * `pending` - Pending
|
|
3184
|
-
* @param search A search term.
|
|
3185
|
-
* @param status * `success` - Success
|
|
3186
|
-
* * `error` - Error
|
|
3187
|
-
* * `running` - Running
|
|
3188
|
-
* * `pending` - Pending
|
|
3189
|
-
* @param title
|
|
3190
|
-
* @param username
|
|
3191
3559
|
* @returns PaginatedPeriodicAgentList
|
|
3192
3560
|
* @throws ApiError
|
|
3193
3561
|
*/
|
|
3194
|
-
static aiMentorOrgsUsersPeriodicAgentsList(org
|
|
3562
|
+
static aiMentorOrgsUsersPeriodicAgentsList({ org, userId, enabled, ordering, page, pageSize, parentMentorId, parentSessionId, previousAgent, previousAgentStatus, search, status, title, username, }: {
|
|
3563
|
+
org: string;
|
|
3564
|
+
enabled?: boolean; /**
|
|
3565
|
+
* Which field to use when ordering the results.
|
|
3566
|
+
*/
|
|
3567
|
+
ordering?: string; /**
|
|
3568
|
+
* A page number within the paginated result set.
|
|
3569
|
+
*/
|
|
3570
|
+
page?: number; /**
|
|
3571
|
+
* Number of results to return per page.
|
|
3572
|
+
*/
|
|
3573
|
+
pageSize?: number;
|
|
3574
|
+
parentMentorId?: number;
|
|
3575
|
+
parentSessionId?: string;
|
|
3576
|
+
previousAgent?: number; /**
|
|
3577
|
+
* The status that the previous agent must be in before this agent gets scheduled.
|
|
3578
|
+
*
|
|
3579
|
+
* * `success` - Success
|
|
3580
|
+
* * `error` - Error
|
|
3581
|
+
* * `running` - Running
|
|
3582
|
+
* * `pending` - Pending
|
|
3583
|
+
*/
|
|
3584
|
+
previousAgentStatus?: 'error' | 'pending' | 'running' | 'success'; /**
|
|
3585
|
+
* A search term.
|
|
3586
|
+
*/
|
|
3587
|
+
search?: string; /**
|
|
3588
|
+
* * `success` - Success
|
|
3589
|
+
* * `error` - Error
|
|
3590
|
+
* * `running` - Running
|
|
3591
|
+
* * `pending` - Pending
|
|
3592
|
+
*/
|
|
3593
|
+
status?: 'error' | 'pending' | 'running' | 'success';
|
|
3594
|
+
title?: string;
|
|
3595
|
+
username?: string;
|
|
3596
|
+
}): CancelablePromise<PaginatedPeriodicAgentList>;
|
|
3195
3597
|
/**
|
|
3196
3598
|
* Endpoint to create and view, update and delete periodic agents.
|
|
3197
3599
|
*
|
|
@@ -3256,13 +3658,13 @@ export declare class AiMentorService {
|
|
|
3256
3658
|
* return False
|
|
3257
3659
|
*
|
|
3258
3660
|
* ```
|
|
3259
|
-
* @param org
|
|
3260
|
-
* @param userId
|
|
3261
|
-
* @param requestBody
|
|
3262
3661
|
* @returns PeriodicAgentCreate
|
|
3263
3662
|
* @throws ApiError
|
|
3264
3663
|
*/
|
|
3265
|
-
static aiMentorOrgsUsersPeriodicAgentsCreate(org
|
|
3664
|
+
static aiMentorOrgsUsersPeriodicAgentsCreate({ org, userId, requestBody, }: {
|
|
3665
|
+
org: string;
|
|
3666
|
+
requestBody: PeriodicAgentCreate;
|
|
3667
|
+
}): CancelablePromise<PeriodicAgentCreate>;
|
|
3266
3668
|
/**
|
|
3267
3669
|
* Endpoint to create and view, update and delete periodic agents.
|
|
3268
3670
|
*
|
|
@@ -3327,13 +3729,16 @@ export declare class AiMentorService {
|
|
|
3327
3729
|
* return False
|
|
3328
3730
|
*
|
|
3329
3731
|
* ```
|
|
3330
|
-
* @param id A unique integer value identifying this periodic agent.
|
|
3331
|
-
* @param org
|
|
3332
|
-
* @param userId
|
|
3333
3732
|
* @returns PeriodicAgent
|
|
3334
3733
|
* @throws ApiError
|
|
3335
3734
|
*/
|
|
3336
|
-
static aiMentorOrgsUsersPeriodicAgentsRetrieve(id
|
|
3735
|
+
static aiMentorOrgsUsersPeriodicAgentsRetrieve({ id, org, userId, }: {
|
|
3736
|
+
/**
|
|
3737
|
+
* A unique integer value identifying this periodic agent.
|
|
3738
|
+
*/
|
|
3739
|
+
id: number;
|
|
3740
|
+
org: string;
|
|
3741
|
+
}): CancelablePromise<PeriodicAgent>;
|
|
3337
3742
|
/**
|
|
3338
3743
|
* Endpoint to create and view, update and delete periodic agents.
|
|
3339
3744
|
*
|
|
@@ -3398,14 +3803,17 @@ export declare class AiMentorService {
|
|
|
3398
3803
|
* return False
|
|
3399
3804
|
*
|
|
3400
3805
|
* ```
|
|
3401
|
-
* @param id A unique integer value identifying this periodic agent.
|
|
3402
|
-
* @param org
|
|
3403
|
-
* @param userId
|
|
3404
|
-
* @param requestBody
|
|
3405
3806
|
* @returns PeriodicAgentCreate
|
|
3406
3807
|
* @throws ApiError
|
|
3407
3808
|
*/
|
|
3408
|
-
static aiMentorOrgsUsersPeriodicAgentsUpdate(id
|
|
3809
|
+
static aiMentorOrgsUsersPeriodicAgentsUpdate({ id, org, userId, requestBody, }: {
|
|
3810
|
+
/**
|
|
3811
|
+
* A unique integer value identifying this periodic agent.
|
|
3812
|
+
*/
|
|
3813
|
+
id: number;
|
|
3814
|
+
org: string;
|
|
3815
|
+
requestBody: PeriodicAgentCreate;
|
|
3816
|
+
}): CancelablePromise<PeriodicAgentCreate>;
|
|
3409
3817
|
/**
|
|
3410
3818
|
* Endpoint to create and view, update and delete periodic agents.
|
|
3411
3819
|
*
|
|
@@ -3470,14 +3878,17 @@ export declare class AiMentorService {
|
|
|
3470
3878
|
* return False
|
|
3471
3879
|
*
|
|
3472
3880
|
* ```
|
|
3473
|
-
* @param id A unique integer value identifying this periodic agent.
|
|
3474
|
-
* @param org
|
|
3475
|
-
* @param userId
|
|
3476
|
-
* @param requestBody
|
|
3477
3881
|
* @returns PeriodicAgentCreate
|
|
3478
3882
|
* @throws ApiError
|
|
3479
3883
|
*/
|
|
3480
|
-
static aiMentorOrgsUsersPeriodicAgentsPartialUpdate(id
|
|
3884
|
+
static aiMentorOrgsUsersPeriodicAgentsPartialUpdate({ id, org, userId, requestBody, }: {
|
|
3885
|
+
/**
|
|
3886
|
+
* A unique integer value identifying this periodic agent.
|
|
3887
|
+
*/
|
|
3888
|
+
id: number;
|
|
3889
|
+
org: string;
|
|
3890
|
+
requestBody?: PatchedPeriodicAgentCreate;
|
|
3891
|
+
}): CancelablePromise<PeriodicAgentCreate>;
|
|
3481
3892
|
/**
|
|
3482
3893
|
* Endpoint to create and view, update and delete periodic agents.
|
|
3483
3894
|
*
|
|
@@ -3542,13 +3953,16 @@ export declare class AiMentorService {
|
|
|
3542
3953
|
* return False
|
|
3543
3954
|
*
|
|
3544
3955
|
* ```
|
|
3545
|
-
* @param id A unique integer value identifying this periodic agent.
|
|
3546
|
-
* @param org
|
|
3547
|
-
* @param userId
|
|
3548
3956
|
* @returns void
|
|
3549
3957
|
* @throws ApiError
|
|
3550
3958
|
*/
|
|
3551
|
-
static aiMentorOrgsUsersPeriodicAgentsDestroy(id
|
|
3959
|
+
static aiMentorOrgsUsersPeriodicAgentsDestroy({ id, org, userId, }: {
|
|
3960
|
+
/**
|
|
3961
|
+
* A unique integer value identifying this periodic agent.
|
|
3962
|
+
*/
|
|
3963
|
+
id: number;
|
|
3964
|
+
org: string;
|
|
3965
|
+
}): CancelablePromise<void>;
|
|
3552
3966
|
/**
|
|
3553
3967
|
* Retrieve pinned messages for a user.
|
|
3554
3968
|
*
|
|
@@ -3562,13 +3976,15 @@ export declare class AiMentorService {
|
|
|
3562
3976
|
*
|
|
3563
3977
|
* Raises:
|
|
3564
3978
|
* NotFound: If the student or session does not exist.
|
|
3565
|
-
* @param org
|
|
3566
|
-
* @param sessionId Session id of the message to pin
|
|
3567
|
-
* @param userId
|
|
3568
3979
|
* @returns PinnedMessageGet
|
|
3569
3980
|
* @throws ApiError
|
|
3570
3981
|
*/
|
|
3571
|
-
static aiMentorOrgsUsersPinMessageList(org
|
|
3982
|
+
static aiMentorOrgsUsersPinMessageList({ org, sessionId, userId, }: {
|
|
3983
|
+
org: string; /**
|
|
3984
|
+
* Session id of the message to pin
|
|
3985
|
+
*/
|
|
3986
|
+
sessionId: string;
|
|
3987
|
+
}): CancelablePromise<Array<PinnedMessageGet>>;
|
|
3572
3988
|
/**
|
|
3573
3989
|
* Create a pinned message for a user session.
|
|
3574
3990
|
*
|
|
@@ -3583,13 +3999,13 @@ export declare class AiMentorService {
|
|
|
3583
3999
|
* Raises:
|
|
3584
4000
|
* NotFound: If the student does not exist.
|
|
3585
4001
|
* ValidationError: If request data is invalid.
|
|
3586
|
-
* @param org
|
|
3587
|
-
* @param userId
|
|
3588
|
-
* @param requestBody
|
|
3589
4002
|
* @returns PinnedMessageCreate
|
|
3590
4003
|
* @throws ApiError
|
|
3591
4004
|
*/
|
|
3592
|
-
static aiMentorOrgsUsersPinMessageCreate(org
|
|
4005
|
+
static aiMentorOrgsUsersPinMessageCreate({ org, userId, requestBody, }: {
|
|
4006
|
+
org: string;
|
|
4007
|
+
requestBody: PinnedMessageRequest;
|
|
4008
|
+
}): CancelablePromise<PinnedMessageCreate>;
|
|
3593
4009
|
/**
|
|
3594
4010
|
* Delete a pinned message for a user.
|
|
3595
4011
|
*
|
|
@@ -3604,104 +4020,137 @@ export declare class AiMentorService {
|
|
|
3604
4020
|
* Raises:
|
|
3605
4021
|
* NotFound: If the student or pinned message does not exist.
|
|
3606
4022
|
* ValidationError: If request data is invalid.
|
|
3607
|
-
* @param org
|
|
3608
|
-
* @param userId
|
|
3609
4023
|
* @returns void
|
|
3610
4024
|
* @throws ApiError
|
|
3611
4025
|
*/
|
|
3612
|
-
static aiMentorOrgsUsersPinMessageDestroy(org
|
|
4026
|
+
static aiMentorOrgsUsersPinMessageDestroy({ org, userId, }: {
|
|
4027
|
+
org: string;
|
|
4028
|
+
}): CancelablePromise<void>;
|
|
3613
4029
|
/**
|
|
3614
4030
|
* Endpoints for viewing jobs and their status
|
|
3615
4031
|
* A job run refers to a task with steps that an agent is going to undertake.
|
|
3616
4032
|
* You can filter job runs by their status.
|
|
3617
4033
|
* Note that for a single user and a specified session, at most only one JobRun instance
|
|
3618
4034
|
* is active at any point in time.
|
|
3619
|
-
* @param org
|
|
3620
|
-
* @param userId
|
|
3621
|
-
* @param active
|
|
3622
|
-
* @param ordering Which field to use when ordering the results.
|
|
3623
|
-
* @param page A page number within the paginated result set.
|
|
3624
|
-
* @param pageSize Number of results to return per page.
|
|
3625
|
-
* @param search A search term.
|
|
3626
|
-
* @param session
|
|
3627
4035
|
* @returns PaginatedJobRunList
|
|
3628
4036
|
* @throws ApiError
|
|
3629
4037
|
*/
|
|
3630
|
-
static aiMentorOrgsUsersPlannedJobsList(org
|
|
4038
|
+
static aiMentorOrgsUsersPlannedJobsList({ org, userId, active, ordering, page, pageSize, search, session, }: {
|
|
4039
|
+
org: string;
|
|
4040
|
+
active?: boolean; /**
|
|
4041
|
+
* Which field to use when ordering the results.
|
|
4042
|
+
*/
|
|
4043
|
+
ordering?: string; /**
|
|
4044
|
+
* A page number within the paginated result set.
|
|
4045
|
+
*/
|
|
4046
|
+
page?: number; /**
|
|
4047
|
+
* Number of results to return per page.
|
|
4048
|
+
*/
|
|
4049
|
+
pageSize?: number; /**
|
|
4050
|
+
* A search term.
|
|
4051
|
+
*/
|
|
4052
|
+
search?: string;
|
|
4053
|
+
session?: string;
|
|
4054
|
+
}): CancelablePromise<PaginatedJobRunList>;
|
|
3631
4055
|
/**
|
|
3632
4056
|
* Endpoints for viewing jobs and their status
|
|
3633
4057
|
* A job run refers to a task with steps that an agent is going to undertake.
|
|
3634
4058
|
* You can filter job runs by their status.
|
|
3635
4059
|
* Note that for a single user and a specified session, at most only one JobRun instance
|
|
3636
4060
|
* is active at any point in time.
|
|
3637
|
-
* @param id A unique integer value identifying this job run.
|
|
3638
|
-
* @param org
|
|
3639
|
-
* @param userId
|
|
3640
4061
|
* @returns JobRun
|
|
3641
4062
|
* @throws ApiError
|
|
3642
4063
|
*/
|
|
3643
|
-
static aiMentorOrgsUsersPlannedJobsRetrieve(id
|
|
4064
|
+
static aiMentorOrgsUsersPlannedJobsRetrieve({ id, org, userId, }: {
|
|
4065
|
+
/**
|
|
4066
|
+
* A unique integer value identifying this job run.
|
|
4067
|
+
*/
|
|
4068
|
+
id: number;
|
|
4069
|
+
org: string;
|
|
4070
|
+
}): CancelablePromise<JobRun>;
|
|
3644
4071
|
/**
|
|
3645
4072
|
* Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
|
|
3646
|
-
* @param org
|
|
3647
|
-
* @param userId
|
|
3648
|
-
* @param isPublic
|
|
3649
|
-
* @param ordering Which field to use when ordering the results.
|
|
3650
|
-
* @param page A page number within the paginated result set.
|
|
3651
|
-
* @param pageSize Number of results to return per page.
|
|
3652
|
-
* @param search A search term.
|
|
3653
|
-
* @param student edX user ID
|
|
3654
4073
|
* @returns PaginatedPlayWrightScriptList
|
|
3655
4074
|
* @throws ApiError
|
|
3656
4075
|
*/
|
|
3657
|
-
static aiMentorOrgsUsersPlaywrightScriptsList(org
|
|
4076
|
+
static aiMentorOrgsUsersPlaywrightScriptsList({ org, userId, isPublic, ordering, page, pageSize, search, student, }: {
|
|
4077
|
+
org: string;
|
|
4078
|
+
isPublic?: boolean; /**
|
|
4079
|
+
* Which field to use when ordering the results.
|
|
4080
|
+
*/
|
|
4081
|
+
ordering?: string; /**
|
|
4082
|
+
* A page number within the paginated result set.
|
|
4083
|
+
*/
|
|
4084
|
+
page?: number; /**
|
|
4085
|
+
* Number of results to return per page.
|
|
4086
|
+
*/
|
|
4087
|
+
pageSize?: number; /**
|
|
4088
|
+
* A search term.
|
|
4089
|
+
*/
|
|
4090
|
+
search?: string; /**
|
|
4091
|
+
* edX user ID
|
|
4092
|
+
*/
|
|
4093
|
+
student?: number;
|
|
4094
|
+
}): CancelablePromise<PaginatedPlayWrightScriptList>;
|
|
3658
4095
|
/**
|
|
3659
4096
|
* Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
|
|
3660
|
-
* @param org
|
|
3661
|
-
* @param userId
|
|
3662
|
-
* @param requestBody
|
|
3663
4097
|
* @returns PlayWrightScript
|
|
3664
4098
|
* @throws ApiError
|
|
3665
4099
|
*/
|
|
3666
|
-
static aiMentorOrgsUsersPlaywrightScriptsCreate(org
|
|
4100
|
+
static aiMentorOrgsUsersPlaywrightScriptsCreate({ org, userId, requestBody, }: {
|
|
4101
|
+
org: string;
|
|
4102
|
+
requestBody: PlayWrightScript;
|
|
4103
|
+
}): CancelablePromise<PlayWrightScript>;
|
|
3667
4104
|
/**
|
|
3668
4105
|
* Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
|
|
3669
|
-
* @param id A unique integer value identifying this play wright script.
|
|
3670
|
-
* @param org
|
|
3671
|
-
* @param userId
|
|
3672
4106
|
* @returns PlayWrightScript
|
|
3673
4107
|
* @throws ApiError
|
|
3674
4108
|
*/
|
|
3675
|
-
static aiMentorOrgsUsersPlaywrightScriptsRetrieve(id
|
|
4109
|
+
static aiMentorOrgsUsersPlaywrightScriptsRetrieve({ id, org, userId, }: {
|
|
4110
|
+
/**
|
|
4111
|
+
* A unique integer value identifying this play wright script.
|
|
4112
|
+
*/
|
|
4113
|
+
id: number;
|
|
4114
|
+
org: string;
|
|
4115
|
+
}): CancelablePromise<PlayWrightScript>;
|
|
3676
4116
|
/**
|
|
3677
4117
|
* Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
|
|
3678
|
-
* @param id A unique integer value identifying this play wright script.
|
|
3679
|
-
* @param org
|
|
3680
|
-
* @param userId
|
|
3681
|
-
* @param requestBody
|
|
3682
4118
|
* @returns PlayWrightScript
|
|
3683
4119
|
* @throws ApiError
|
|
3684
4120
|
*/
|
|
3685
|
-
static aiMentorOrgsUsersPlaywrightScriptsUpdate(id
|
|
4121
|
+
static aiMentorOrgsUsersPlaywrightScriptsUpdate({ id, org, userId, requestBody, }: {
|
|
4122
|
+
/**
|
|
4123
|
+
* A unique integer value identifying this play wright script.
|
|
4124
|
+
*/
|
|
4125
|
+
id: number;
|
|
4126
|
+
org: string;
|
|
4127
|
+
requestBody: PlayWrightScript;
|
|
4128
|
+
}): CancelablePromise<PlayWrightScript>;
|
|
3686
4129
|
/**
|
|
3687
4130
|
* Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
|
|
3688
|
-
* @param id A unique integer value identifying this play wright script.
|
|
3689
|
-
* @param org
|
|
3690
|
-
* @param userId
|
|
3691
|
-
* @param requestBody
|
|
3692
4131
|
* @returns PlayWrightScript
|
|
3693
4132
|
* @throws ApiError
|
|
3694
4133
|
*/
|
|
3695
|
-
static aiMentorOrgsUsersPlaywrightScriptsPartialUpdate(id
|
|
4134
|
+
static aiMentorOrgsUsersPlaywrightScriptsPartialUpdate({ id, org, userId, requestBody, }: {
|
|
4135
|
+
/**
|
|
4136
|
+
* A unique integer value identifying this play wright script.
|
|
4137
|
+
*/
|
|
4138
|
+
id: number;
|
|
4139
|
+
org: string;
|
|
4140
|
+
requestBody?: PatchedPlayWrightScript;
|
|
4141
|
+
}): CancelablePromise<PlayWrightScript>;
|
|
3696
4142
|
/**
|
|
3697
4143
|
* Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
|
|
3698
|
-
* @param id A unique integer value identifying this play wright script.
|
|
3699
|
-
* @param org
|
|
3700
|
-
* @param userId
|
|
3701
4144
|
* @returns void
|
|
3702
4145
|
* @throws ApiError
|
|
3703
4146
|
*/
|
|
3704
|
-
static aiMentorOrgsUsersPlaywrightScriptsDestroy(id
|
|
4147
|
+
static aiMentorOrgsUsersPlaywrightScriptsDestroy({ id, org, userId, }: {
|
|
4148
|
+
/**
|
|
4149
|
+
* A unique integer value identifying this play wright script.
|
|
4150
|
+
*/
|
|
4151
|
+
id: number;
|
|
4152
|
+
org: string;
|
|
4153
|
+
}): CancelablePromise<void>;
|
|
3705
4154
|
/**
|
|
3706
4155
|
* Retrieve predictive analytics based on historical data variables.
|
|
3707
4156
|
*
|
|
@@ -3717,25 +4166,25 @@ export declare class AiMentorService {
|
|
|
3717
4166
|
*
|
|
3718
4167
|
* Example:
|
|
3719
4168
|
* **POST** `/api/ai-prompt/orgs/main/users/johndoe/predictive-analytics/`
|
|
3720
|
-
* @param org
|
|
3721
|
-
* @param userId
|
|
3722
|
-
* @param requestBody
|
|
3723
4169
|
* @returns PredictiveAnalyticsResponse
|
|
3724
4170
|
* @throws ApiError
|
|
3725
4171
|
*/
|
|
3726
|
-
static aiMentorOrgsUsersPredictiveAnalyticsCreate(org
|
|
4172
|
+
static aiMentorOrgsUsersPredictiveAnalyticsCreate({ org, userId, requestBody, }: {
|
|
4173
|
+
org: string;
|
|
4174
|
+
requestBody: PredictiveAnalyticsRequest;
|
|
4175
|
+
}): CancelablePromise<PredictiveAnalyticsResponse>;
|
|
3727
4176
|
/**
|
|
3728
4177
|
* Retrieves recent chat messages based on provided query parameters.
|
|
3729
4178
|
*
|
|
3730
4179
|
* Returns:
|
|
3731
4180
|
* 200: Paginated List of chat messages.
|
|
3732
4181
|
* 400: Invalid query parameters.
|
|
3733
|
-
* @param org
|
|
3734
|
-
* @param userId
|
|
3735
4182
|
* @returns any No response body
|
|
3736
4183
|
* @throws ApiError
|
|
3737
4184
|
*/
|
|
3738
|
-
static aiMentorOrgsUsersRecentMessagesRetrieve(org
|
|
4185
|
+
static aiMentorOrgsUsersRecentMessagesRetrieve({ org, userId, }: {
|
|
4186
|
+
org: string;
|
|
4187
|
+
}): CancelablePromise<any>;
|
|
3739
4188
|
/**
|
|
3740
4189
|
* Endpoint for listing most recently accessed mentors.
|
|
3741
4190
|
*
|
|
@@ -3747,12 +4196,12 @@ export declare class AiMentorService {
|
|
|
3747
4196
|
* 200: List of most recently accessed mentors.
|
|
3748
4197
|
*
|
|
3749
4198
|
* 400: When request is not valid.
|
|
3750
|
-
* @param org
|
|
3751
|
-
* @param userId
|
|
3752
4199
|
* @returns RecentlyAccessedMentor
|
|
3753
4200
|
* @throws ApiError
|
|
3754
4201
|
*/
|
|
3755
|
-
static aiMentorOrgsUsersRecentlyAccessedMentorsList(org
|
|
4202
|
+
static aiMentorOrgsUsersRecentlyAccessedMentorsList({ org, userId, }: {
|
|
4203
|
+
org: string;
|
|
4204
|
+
}): CancelablePromise<Array<RecentlyAccessedMentor>>;
|
|
3756
4205
|
/**
|
|
3757
4206
|
* Retrieve recommended courses for a specific user.
|
|
3758
4207
|
*
|
|
@@ -3769,18 +4218,30 @@ export declare class AiMentorService {
|
|
|
3769
4218
|
* NotFound: If the OpenAI API key for the tenant is not found.
|
|
3770
4219
|
* TooManyRequests: If rate limits are exceeded.
|
|
3771
4220
|
* ServerError: If there's an error processing the AI response.
|
|
3772
|
-
* @param org
|
|
3773
|
-
* @param userId
|
|
3774
|
-
* @param includeLearnerSkills Include available learner skills for search
|
|
3775
|
-
* @param includeMainCourses Include courses from the main tenant
|
|
3776
|
-
* @param rankByDifficulty Rank by course difficulty
|
|
3777
|
-
* @param returnCourseData Return course data
|
|
3778
|
-
* @param returnNumber Number of courses to return
|
|
3779
|
-
* @param searchTerms Terms to be searched
|
|
3780
4221
|
* @returns RecommendCourseResponse
|
|
3781
4222
|
* @throws ApiError
|
|
3782
4223
|
*/
|
|
3783
|
-
static aiMentorOrgsUsersRecommendCoursesRetrieve(org
|
|
4224
|
+
static aiMentorOrgsUsersRecommendCoursesRetrieve({ org, userId, includeLearnerSkills, includeMainCourses, rankByDifficulty, returnCourseData, returnNumber, searchTerms, }: {
|
|
4225
|
+
org: string; /**
|
|
4226
|
+
* Include available learner skills for search
|
|
4227
|
+
*/
|
|
4228
|
+
includeLearnerSkills?: boolean; /**
|
|
4229
|
+
* Include courses from the main tenant
|
|
4230
|
+
*/
|
|
4231
|
+
includeMainCourses?: boolean; /**
|
|
4232
|
+
* Rank by course difficulty
|
|
4233
|
+
*/
|
|
4234
|
+
rankByDifficulty?: boolean; /**
|
|
4235
|
+
* Return course data
|
|
4236
|
+
*/
|
|
4237
|
+
returnCourseData?: boolean; /**
|
|
4238
|
+
* Number of courses to return
|
|
4239
|
+
*/
|
|
4240
|
+
returnNumber?: number; /**
|
|
4241
|
+
* Terms to be searched
|
|
4242
|
+
*/
|
|
4243
|
+
searchTerms?: string;
|
|
4244
|
+
}): CancelablePromise<RecommendCourseResponse>;
|
|
3784
4245
|
/**
|
|
3785
4246
|
* Retrieve recommended course blocks for a specific user.
|
|
3786
4247
|
*
|
|
@@ -3794,18 +4255,30 @@ export declare class AiMentorService {
|
|
|
3794
4255
|
*
|
|
3795
4256
|
* Raises:
|
|
3796
4257
|
* BadRequest: If the query parameters are invalid.
|
|
3797
|
-
* @param org
|
|
3798
|
-
* @param userId
|
|
3799
|
-
* @param includeLearnerSkills Include available learner skills for search
|
|
3800
|
-
* @param includeMainCourses Include courses from the main tenant
|
|
3801
|
-
* @param rankByDifficulty Rank by course difficulty
|
|
3802
|
-
* @param returnCourseData Return course data
|
|
3803
|
-
* @param returnNumber Number of courses to return
|
|
3804
|
-
* @param searchTerms Terms to be searched
|
|
3805
4258
|
* @returns RecommendCourseBlock
|
|
3806
4259
|
* @throws ApiError
|
|
3807
4260
|
*/
|
|
3808
|
-
static aiMentorOrgsUsersRecommendCoursesBlockRetrieve(org
|
|
4261
|
+
static aiMentorOrgsUsersRecommendCoursesBlockRetrieve({ org, userId, includeLearnerSkills, includeMainCourses, rankByDifficulty, returnCourseData, returnNumber, searchTerms, }: {
|
|
4262
|
+
org: string; /**
|
|
4263
|
+
* Include available learner skills for search
|
|
4264
|
+
*/
|
|
4265
|
+
includeLearnerSkills?: boolean; /**
|
|
4266
|
+
* Include courses from the main tenant
|
|
4267
|
+
*/
|
|
4268
|
+
includeMainCourses?: boolean; /**
|
|
4269
|
+
* Rank by course difficulty
|
|
4270
|
+
*/
|
|
4271
|
+
rankByDifficulty?: boolean; /**
|
|
4272
|
+
* Return course data
|
|
4273
|
+
*/
|
|
4274
|
+
returnCourseData?: boolean; /**
|
|
4275
|
+
* Number of courses to return
|
|
4276
|
+
*/
|
|
4277
|
+
returnNumber?: number; /**
|
|
4278
|
+
* Terms to be searched
|
|
4279
|
+
*/
|
|
4280
|
+
searchTerms?: string;
|
|
4281
|
+
}): CancelablePromise<RecommendCourseBlock>;
|
|
3809
4282
|
/**
|
|
3810
4283
|
* Search for web resources based on a query.
|
|
3811
4284
|
*
|
|
@@ -3819,13 +4292,13 @@ export declare class AiMentorService {
|
|
|
3819
4292
|
*
|
|
3820
4293
|
* Raises:
|
|
3821
4294
|
* ValidationError: If the search fails or returns no results.
|
|
3822
|
-
* @param org
|
|
3823
|
-
* @param userId
|
|
3824
|
-
* @param requestBody
|
|
3825
4295
|
* @returns WebResource
|
|
3826
4296
|
* @throws ApiError
|
|
3827
4297
|
*/
|
|
3828
|
-
static aiMentorOrgsUsersResourcesWebCreate(org
|
|
4298
|
+
static aiMentorOrgsUsersResourcesWebCreate({ org, userId, requestBody, }: {
|
|
4299
|
+
org: string;
|
|
4300
|
+
requestBody: WebResourcesQuery;
|
|
4301
|
+
}): CancelablePromise<Array<WebResource>>;
|
|
3829
4302
|
/**
|
|
3830
4303
|
* Endpoint to view and delete Safety System Logs for a tenant.
|
|
3831
4304
|
*
|
|
@@ -3833,21 +4306,31 @@ export declare class AiMentorService {
|
|
|
3833
4306
|
*
|
|
3834
4307
|
*
|
|
3835
4308
|
* A search query can be conducted to search through the prompts and reason for the moderation catch event.
|
|
3836
|
-
* @param org
|
|
3837
|
-
* @param userId
|
|
3838
|
-
* @param mentor
|
|
3839
|
-
* @param ordering Which field to use when ordering the results.
|
|
3840
|
-
* @param page A page number within the paginated result set.
|
|
3841
|
-
* @param pageSize Number of results to return per page.
|
|
3842
|
-
* @param platformKey
|
|
3843
|
-
* @param search A search term.
|
|
3844
|
-
* @param targetSystem * `Safety System` - Safety System
|
|
3845
|
-
* * `Moderation System` - Moderation System
|
|
3846
|
-
* @param username
|
|
3847
4309
|
* @returns PaginatedModerationLogList
|
|
3848
4310
|
* @throws ApiError
|
|
3849
4311
|
*/
|
|
3850
|
-
static aiMentorOrgsUsersSafetyLogsList(org
|
|
4312
|
+
static aiMentorOrgsUsersSafetyLogsList({ org, userId, mentor, ordering, page, pageSize, platformKey, search, targetSystem, username, }: {
|
|
4313
|
+
org: string;
|
|
4314
|
+
mentor?: number; /**
|
|
4315
|
+
* Which field to use when ordering the results.
|
|
4316
|
+
*/
|
|
4317
|
+
ordering?: string; /**
|
|
4318
|
+
* A page number within the paginated result set.
|
|
4319
|
+
*/
|
|
4320
|
+
page?: number; /**
|
|
4321
|
+
* Number of results to return per page.
|
|
4322
|
+
*/
|
|
4323
|
+
pageSize?: number;
|
|
4324
|
+
platformKey?: string; /**
|
|
4325
|
+
* A search term.
|
|
4326
|
+
*/
|
|
4327
|
+
search?: string; /**
|
|
4328
|
+
* * `Safety System` - Safety System
|
|
4329
|
+
* * `Moderation System` - Moderation System
|
|
4330
|
+
*/
|
|
4331
|
+
targetSystem?: 'Moderation System' | 'Safety System';
|
|
4332
|
+
username?: string;
|
|
4333
|
+
}): CancelablePromise<PaginatedModerationLogList>;
|
|
3851
4334
|
/**
|
|
3852
4335
|
* Endpoint to view and delete Safety System Logs for a tenant.
|
|
3853
4336
|
*
|
|
@@ -3855,13 +4338,16 @@ export declare class AiMentorService {
|
|
|
3855
4338
|
*
|
|
3856
4339
|
*
|
|
3857
4340
|
* A search query can be conducted to search through the prompts and reason for the moderation catch event.
|
|
3858
|
-
* @param id A unique integer value identifying this moderation log.
|
|
3859
|
-
* @param org
|
|
3860
|
-
* @param userId
|
|
3861
4341
|
* @returns ModerationLog
|
|
3862
4342
|
* @throws ApiError
|
|
3863
4343
|
*/
|
|
3864
|
-
static aiMentorOrgsUsersSafetyLogsRetrieve(id
|
|
4344
|
+
static aiMentorOrgsUsersSafetyLogsRetrieve({ id, org, userId, }: {
|
|
4345
|
+
/**
|
|
4346
|
+
* A unique integer value identifying this moderation log.
|
|
4347
|
+
*/
|
|
4348
|
+
id: number;
|
|
4349
|
+
org: string;
|
|
4350
|
+
}): CancelablePromise<ModerationLog>;
|
|
3865
4351
|
/**
|
|
3866
4352
|
* Endpoint to view and delete Safety System Logs for a tenant.
|
|
3867
4353
|
*
|
|
@@ -3869,13 +4355,16 @@ export declare class AiMentorService {
|
|
|
3869
4355
|
*
|
|
3870
4356
|
*
|
|
3871
4357
|
* A search query can be conducted to search through the prompts and reason for the moderation catch event.
|
|
3872
|
-
* @param id A unique integer value identifying this moderation log.
|
|
3873
|
-
* @param org
|
|
3874
|
-
* @param userId
|
|
3875
4358
|
* @returns void
|
|
3876
4359
|
* @throws ApiError
|
|
3877
4360
|
*/
|
|
3878
|
-
static aiMentorOrgsUsersSafetyLogsDestroy(id
|
|
4361
|
+
static aiMentorOrgsUsersSafetyLogsDestroy({ id, org, userId, }: {
|
|
4362
|
+
/**
|
|
4363
|
+
* A unique integer value identifying this moderation log.
|
|
4364
|
+
*/
|
|
4365
|
+
id: number;
|
|
4366
|
+
org: string;
|
|
4367
|
+
}): CancelablePromise<void>;
|
|
3879
4368
|
/**
|
|
3880
4369
|
* Retrieve session details including message counts and timestamps.
|
|
3881
4370
|
*
|
|
@@ -3885,14 +4374,16 @@ export declare class AiMentorService {
|
|
|
3885
4374
|
* Returns:
|
|
3886
4375
|
* - 200: Paginated list of session details.
|
|
3887
4376
|
* - 404: Session not found.
|
|
3888
|
-
* @param mentor
|
|
3889
|
-
* @param org
|
|
3890
|
-
* @param userId
|
|
3891
|
-
* @param page Page number for pagination
|
|
3892
4377
|
* @returns SessionDetail
|
|
3893
4378
|
* @throws ApiError
|
|
3894
4379
|
*/
|
|
3895
|
-
static aiMentorOrgsUsersSessionDetailMentorsList(mentor
|
|
4380
|
+
static aiMentorOrgsUsersSessionDetailMentorsList({ mentor, org, userId, page, }: {
|
|
4381
|
+
mentor: string;
|
|
4382
|
+
org: string; /**
|
|
4383
|
+
* Page number for pagination
|
|
4384
|
+
*/
|
|
4385
|
+
page?: number;
|
|
4386
|
+
}): CancelablePromise<Array<SessionDetail>>;
|
|
3896
4387
|
/**
|
|
3897
4388
|
* Retrieve user sessions filtered by start date and end date.
|
|
3898
4389
|
*
|
|
@@ -3903,14 +4394,14 @@ export declare class AiMentorService {
|
|
|
3903
4394
|
* Returns:
|
|
3904
4395
|
* - 200: List of session IDs with insertion timestamps.
|
|
3905
4396
|
* - 400: Invalid request parameters.
|
|
3906
|
-
* @param org
|
|
3907
|
-
* @param userId
|
|
3908
|
-
* @param endDate
|
|
3909
|
-
* @param startDate
|
|
3910
4397
|
* @returns ChatHistorySessionId
|
|
3911
4398
|
* @throws ApiError
|
|
3912
4399
|
*/
|
|
3913
|
-
static aiMentorOrgsUsersSessionidList(org
|
|
4400
|
+
static aiMentorOrgsUsersSessionidList({ org, userId, endDate, startDate, }: {
|
|
4401
|
+
org: string;
|
|
4402
|
+
endDate?: string;
|
|
4403
|
+
startDate?: string;
|
|
4404
|
+
}): CancelablePromise<Array<ChatHistorySessionId>>;
|
|
3914
4405
|
/**
|
|
3915
4406
|
* Retrieve or create a chat session with a mentor.
|
|
3916
4407
|
*
|
|
@@ -3929,43 +4420,43 @@ export declare class AiMentorService {
|
|
|
3929
4420
|
* Http404: If the mentor is not found.
|
|
3930
4421
|
* ValidationError: If the username is invalid.
|
|
3931
4422
|
* ValidationError: If one or more tool slugs are invalid.
|
|
3932
|
-
* @param org
|
|
3933
|
-
* @param userId
|
|
3934
|
-
* @param requestBody
|
|
3935
4423
|
* @returns ChatSessionResponse
|
|
3936
4424
|
* @throws ApiError
|
|
3937
4425
|
*/
|
|
3938
|
-
static aiMentorOrgsUsersSessionsCreate(org
|
|
4426
|
+
static aiMentorOrgsUsersSessionsCreate({ org, userId, requestBody, }: {
|
|
4427
|
+
org: string;
|
|
4428
|
+
requestBody: ChatSessionRequest;
|
|
4429
|
+
}): CancelablePromise<ChatSessionResponse>;
|
|
3939
4430
|
/**
|
|
3940
4431
|
* Retrieve Chat Messages
|
|
3941
4432
|
* Fetches chat messages for a specific session.
|
|
3942
|
-
* @param org
|
|
3943
|
-
* @param sessionId
|
|
3944
|
-
* @param userId
|
|
3945
|
-
* @param share
|
|
3946
4433
|
* @returns MessageView
|
|
3947
4434
|
* @throws ApiError
|
|
3948
4435
|
*/
|
|
3949
|
-
static aiMentorOrgsUsersSessionsRetrieve(org
|
|
4436
|
+
static aiMentorOrgsUsersSessionsRetrieve({ org, sessionId, userId, share, }: {
|
|
4437
|
+
org: string;
|
|
4438
|
+
sessionId: string;
|
|
4439
|
+
share?: boolean;
|
|
4440
|
+
}): CancelablePromise<MessageView>;
|
|
3950
4441
|
/**
|
|
3951
4442
|
* Update the title of a chat session and its tools
|
|
3952
|
-
* @param org
|
|
3953
|
-
* @param sessionId
|
|
3954
|
-
* @param userId
|
|
3955
|
-
* @param requestBody
|
|
3956
4443
|
* @returns MessageViewUpdatResponse
|
|
3957
4444
|
* @throws ApiError
|
|
3958
4445
|
*/
|
|
3959
|
-
static aiMentorOrgsUsersSessionsUpdate(org
|
|
4446
|
+
static aiMentorOrgsUsersSessionsUpdate({ org, sessionId, userId, requestBody, }: {
|
|
4447
|
+
org: string;
|
|
4448
|
+
sessionId: string;
|
|
4449
|
+
requestBody?: MessageViewRequest;
|
|
4450
|
+
}): CancelablePromise<MessageViewUpdatResponse>;
|
|
3960
4451
|
/**
|
|
3961
4452
|
* Deletes all messages in a chat session.
|
|
3962
|
-
* @param org
|
|
3963
|
-
* @param sessionId
|
|
3964
|
-
* @param userId
|
|
3965
4453
|
* @returns void
|
|
3966
4454
|
* @throws ApiError
|
|
3967
4455
|
*/
|
|
3968
|
-
static aiMentorOrgsUsersSessionsDestroy(org
|
|
4456
|
+
static aiMentorOrgsUsersSessionsDestroy({ org, sessionId, userId, }: {
|
|
4457
|
+
org: string;
|
|
4458
|
+
sessionId: string;
|
|
4459
|
+
}): CancelablePromise<void>;
|
|
3969
4460
|
/**
|
|
3970
4461
|
* Endpoint to fetch the logs of a session.
|
|
3971
4462
|
* Logs are cached for up to 1 hour of their creation: accessing the logs after an hour will result in an empty data.
|
|
@@ -3982,25 +4473,25 @@ export declare class AiMentorService {
|
|
|
3982
4473
|
* Returns:
|
|
3983
4474
|
*
|
|
3984
4475
|
* 200: a SessionBrowserScreenshot object
|
|
3985
|
-
* @param org
|
|
3986
|
-
* @param sessionId
|
|
3987
|
-
* @param userId
|
|
3988
4476
|
* @returns SessionBrowserScreenshot
|
|
3989
4477
|
* @throws ApiError
|
|
3990
4478
|
*/
|
|
3991
|
-
static aiMentorOrgsUsersSessionsBrowserScreenshotRetrieve(org
|
|
4479
|
+
static aiMentorOrgsUsersSessionsBrowserScreenshotRetrieve({ org, sessionId, userId, }: {
|
|
4480
|
+
org: string;
|
|
4481
|
+
sessionId: string;
|
|
4482
|
+
}): CancelablePromise<SessionBrowserScreenshot>;
|
|
3992
4483
|
/**
|
|
3993
4484
|
* Retrieves the chat history for a session as a plain text file.
|
|
3994
4485
|
*
|
|
3995
4486
|
* Returns:
|
|
3996
4487
|
* 200: txt file containing coversation
|
|
3997
|
-
* @param org
|
|
3998
|
-
* @param sessionId
|
|
3999
|
-
* @param userId
|
|
4000
4488
|
* @returns any No response body
|
|
4001
4489
|
* @throws ApiError
|
|
4002
4490
|
*/
|
|
4003
|
-
static aiMentorOrgsUsersSessionsDownloadSessionRetrieve(org
|
|
4491
|
+
static aiMentorOrgsUsersSessionsDownloadSessionRetrieve({ org, sessionId, userId, }: {
|
|
4492
|
+
org: string;
|
|
4493
|
+
sessionId: string;
|
|
4494
|
+
}): CancelablePromise<any>;
|
|
4004
4495
|
/**
|
|
4005
4496
|
* Retrieve memory data for a specific session.
|
|
4006
4497
|
*
|
|
@@ -4017,13 +4508,13 @@ export declare class AiMentorService {
|
|
|
4017
4508
|
*
|
|
4018
4509
|
* Raises:
|
|
4019
4510
|
* NotFound: If the session does not exist or does not belong to the user.
|
|
4020
|
-
* @param org
|
|
4021
|
-
* @param sessionId
|
|
4022
|
-
* @param userId
|
|
4023
4511
|
* @returns SessionMemoryStorage
|
|
4024
4512
|
* @throws ApiError
|
|
4025
4513
|
*/
|
|
4026
|
-
static aiMentorOrgsUsersSessionsMemoryRetrieve(org
|
|
4514
|
+
static aiMentorOrgsUsersSessionsMemoryRetrieve({ org, sessionId, userId, }: {
|
|
4515
|
+
org: string;
|
|
4516
|
+
sessionId: string;
|
|
4517
|
+
}): CancelablePromise<SessionMemoryStorage>;
|
|
4027
4518
|
/**
|
|
4028
4519
|
* Retrieve shell logs for a specific session.
|
|
4029
4520
|
*
|
|
@@ -4038,23 +4529,23 @@ export declare class AiMentorService {
|
|
|
4038
4529
|
*
|
|
4039
4530
|
* Raises:
|
|
4040
4531
|
* NotFound: If the specified session does not exist.
|
|
4041
|
-
* @param org
|
|
4042
|
-
* @param sessionId
|
|
4043
|
-
* @param userId
|
|
4044
4532
|
* @returns ShellLogs
|
|
4045
4533
|
* @throws ApiError
|
|
4046
4534
|
*/
|
|
4047
|
-
static aiMentorOrgsUsersSessionsShellLogsRetrieve(org
|
|
4535
|
+
static aiMentorOrgsUsersSessionsShellLogsRetrieve({ org, sessionId, userId, }: {
|
|
4536
|
+
org: string;
|
|
4537
|
+
sessionId: string;
|
|
4538
|
+
}): CancelablePromise<ShellLogs>;
|
|
4048
4539
|
/**
|
|
4049
4540
|
* Retrieve a list of related questions based on a chat session.
|
|
4050
|
-
* @param org
|
|
4051
|
-
* @param sessionId
|
|
4052
|
-
* @param userId
|
|
4053
|
-
* @param numQuestions
|
|
4054
4541
|
* @returns RelatedText
|
|
4055
4542
|
* @throws ApiError
|
|
4056
4543
|
*/
|
|
4057
|
-
static aiMentorOrgsUsersSessionsSuggestionList(org
|
|
4544
|
+
static aiMentorOrgsUsersSessionsSuggestionList({ org, sessionId, userId, numQuestions, }: {
|
|
4545
|
+
org: string;
|
|
4546
|
+
sessionId: string;
|
|
4547
|
+
numQuestions?: number;
|
|
4548
|
+
}): CancelablePromise<Array<RelatedText>>;
|
|
4058
4549
|
/**
|
|
4059
4550
|
* Retrieves the chat history for a given session if the export task is ready.
|
|
4060
4551
|
*
|
|
@@ -4065,15 +4556,17 @@ export declare class AiMentorService {
|
|
|
4065
4556
|
* 200: chat history object
|
|
4066
4557
|
*
|
|
4067
4558
|
* 400: When data is not valid.
|
|
4068
|
-
* @param org
|
|
4069
|
-
* @param sessionId
|
|
4070
|
-
* @param taskId
|
|
4071
|
-
* @param userId
|
|
4072
|
-
* @param toCsv Choose download in csv or not
|
|
4073
4559
|
* @returns ChatHistoryItem
|
|
4074
4560
|
* @throws ApiError
|
|
4075
4561
|
*/
|
|
4076
|
-
static aiMentorOrgsUsersSessionsTasksRetrieve(org
|
|
4562
|
+
static aiMentorOrgsUsersSessionsTasksRetrieve({ org, sessionId, taskId, userId, toCsv, }: {
|
|
4563
|
+
org: string;
|
|
4564
|
+
sessionId: string;
|
|
4565
|
+
taskId: string; /**
|
|
4566
|
+
* Choose download in csv or not
|
|
4567
|
+
*/
|
|
4568
|
+
toCsv?: boolean;
|
|
4569
|
+
}): CancelablePromise<ChatHistoryItem>;
|
|
4077
4570
|
/**
|
|
4078
4571
|
* Retrieve all LLM models assigned to a specific tenant.
|
|
4079
4572
|
*
|
|
@@ -4087,12 +4580,12 @@ export declare class AiMentorService {
|
|
|
4087
4580
|
* Raises:
|
|
4088
4581
|
* NotFound: If the specified tenant does not have any associated models.
|
|
4089
4582
|
* ValidationError: If an unexpected error occurs.
|
|
4090
|
-
* @param org
|
|
4091
|
-
* @param userId
|
|
4092
4583
|
* @returns LLMModelForTenant
|
|
4093
4584
|
* @throws ApiError
|
|
4094
4585
|
*/
|
|
4095
|
-
static aiMentorOrgsUsersSettingsTenantLlmList(org
|
|
4586
|
+
static aiMentorOrgsUsersSettingsTenantLlmList({ org, userId, }: {
|
|
4587
|
+
org: string;
|
|
4588
|
+
}): CancelablePromise<Array<LLMModelForTenant>>;
|
|
4096
4589
|
/**
|
|
4097
4590
|
* Create or update an LLM model for a tenant.
|
|
4098
4591
|
*
|
|
@@ -4108,13 +4601,13 @@ export declare class AiMentorService {
|
|
|
4108
4601
|
* Raises:
|
|
4109
4602
|
* ValidationError: If request data is invalid.
|
|
4110
4603
|
* NotFound: If the tenant does not exist.
|
|
4111
|
-
* @param org
|
|
4112
|
-
* @param userId
|
|
4113
|
-
* @param requestBody
|
|
4114
4604
|
* @returns LLMModelForTenant
|
|
4115
4605
|
* @throws ApiError
|
|
4116
4606
|
*/
|
|
4117
|
-
static aiMentorOrgsUsersSettingsTenantLlmCreate(org
|
|
4607
|
+
static aiMentorOrgsUsersSettingsTenantLlmCreate({ org, userId, requestBody, }: {
|
|
4608
|
+
org: string;
|
|
4609
|
+
requestBody: LLMModelForTenant;
|
|
4610
|
+
}): CancelablePromise<LLMModelForTenant>;
|
|
4118
4611
|
/**
|
|
4119
4612
|
* Retrieve a list of mentors starred by a specific user.
|
|
4120
4613
|
*
|
|
@@ -4129,12 +4622,12 @@ export declare class AiMentorService {
|
|
|
4129
4622
|
* Raises:
|
|
4130
4623
|
* NotFound: If the specified student does not exist.
|
|
4131
4624
|
* BadRequest: If the request is invalid.
|
|
4132
|
-
* @param org
|
|
4133
|
-
* @param userId
|
|
4134
4625
|
* @returns StarMentor
|
|
4135
4626
|
* @throws ApiError
|
|
4136
4627
|
*/
|
|
4137
|
-
static aiMentorOrgsUsersStarredMentorsList(org
|
|
4628
|
+
static aiMentorOrgsUsersStarredMentorsList({ org, userId, }: {
|
|
4629
|
+
org: string;
|
|
4630
|
+
}): CancelablePromise<Array<StarMentor>>;
|
|
4138
4631
|
/**
|
|
4139
4632
|
* Retrieves the status of a task using its task ID.
|
|
4140
4633
|
*
|
|
@@ -4143,26 +4636,26 @@ export declare class AiMentorService {
|
|
|
4143
4636
|
* Returns:
|
|
4144
4637
|
*
|
|
4145
4638
|
* 200: task id
|
|
4146
|
-
* @param org
|
|
4147
|
-
* @param taskId
|
|
4148
|
-
* @param userId
|
|
4149
4639
|
* @returns RetrieveTask
|
|
4150
4640
|
* @throws ApiError
|
|
4151
4641
|
*/
|
|
4152
|
-
static aiMentorOrgsUsersTasksRetrieve(org
|
|
4642
|
+
static aiMentorOrgsUsersTasksRetrieve({ org, taskId, userId, }: {
|
|
4643
|
+
org: string;
|
|
4644
|
+
taskId: string;
|
|
4645
|
+
}): CancelablePromise<RetrieveTask>;
|
|
4153
4646
|
/**
|
|
4154
4647
|
* Export chat history for a session.
|
|
4155
4648
|
*
|
|
4156
4649
|
* Returns:
|
|
4157
4650
|
* 200: Task ID for the export operation.
|
|
4158
|
-
* @param org
|
|
4159
|
-
* @param sessionId
|
|
4160
|
-
* @param userId
|
|
4161
|
-
* @param requestBody
|
|
4162
4651
|
* @returns TaskView
|
|
4163
4652
|
* @throws ApiError
|
|
4164
4653
|
*/
|
|
4165
|
-
static aiMentorOrgsUsersTasksSessionsCreate(org
|
|
4654
|
+
static aiMentorOrgsUsersTasksSessionsCreate({ org, sessionId, userId, requestBody, }: {
|
|
4655
|
+
org: string;
|
|
4656
|
+
sessionId: string;
|
|
4657
|
+
requestBody: TaskView;
|
|
4658
|
+
}): CancelablePromise<TaskView>;
|
|
4166
4659
|
/**
|
|
4167
4660
|
* Retrieve a list of available voice options.
|
|
4168
4661
|
*
|
|
@@ -4174,19 +4667,29 @@ export declare class AiMentorService {
|
|
|
4174
4667
|
*
|
|
4175
4668
|
* Raises:
|
|
4176
4669
|
* NotFound: If no voice options are available.
|
|
4177
|
-
* @param org
|
|
4178
|
-
* @param userId
|
|
4179
|
-
* @param ordering Which field to use when ordering the results.
|
|
4180
|
-
* @param page A page number within the paginated result set.
|
|
4181
|
-
* @param pageSize Number of results to return per page.
|
|
4182
|
-
* @param provider * `openai` - Openai
|
|
4183
|
-
* * `google` - Google
|
|
4184
|
-
* * `elevenlabs` - Elevenlabs
|
|
4185
|
-
* @param search A search term.
|
|
4186
4670
|
* @returns PaginatedVoiceList
|
|
4187
4671
|
* @throws ApiError
|
|
4188
4672
|
*/
|
|
4189
|
-
static aiMentorOrgsUsersVoicesList(org
|
|
4673
|
+
static aiMentorOrgsUsersVoicesList({ org, userId, ordering, page, pageSize, provider, search, }: {
|
|
4674
|
+
org: string; /**
|
|
4675
|
+
* Which field to use when ordering the results.
|
|
4676
|
+
*/
|
|
4677
|
+
ordering?: string; /**
|
|
4678
|
+
* A page number within the paginated result set.
|
|
4679
|
+
*/
|
|
4680
|
+
page?: number; /**
|
|
4681
|
+
* Number of results to return per page.
|
|
4682
|
+
*/
|
|
4683
|
+
pageSize?: number; /**
|
|
4684
|
+
* * `openai` - Openai
|
|
4685
|
+
* * `google` - Google
|
|
4686
|
+
* * `elevenlabs` - Elevenlabs
|
|
4687
|
+
*/
|
|
4688
|
+
provider?: 'elevenlabs' | 'google' | 'openai'; /**
|
|
4689
|
+
* A search term.
|
|
4690
|
+
*/
|
|
4691
|
+
search?: string;
|
|
4692
|
+
}): CancelablePromise<PaginatedVoiceList>;
|
|
4190
4693
|
/**
|
|
4191
4694
|
* Retrieve details of a specific voice option.
|
|
4192
4695
|
*
|
|
@@ -4199,20 +4702,24 @@ export declare class AiMentorService {
|
|
|
4199
4702
|
*
|
|
4200
4703
|
* Raises:
|
|
4201
4704
|
* NotFound: If the specified voice option does not exist.
|
|
4202
|
-
* @param id A unique integer value identifying this voice.
|
|
4203
|
-
* @param org
|
|
4204
|
-
* @param userId
|
|
4205
4705
|
* @returns Voice
|
|
4206
4706
|
* @throws ApiError
|
|
4207
4707
|
*/
|
|
4208
|
-
static aiMentorOrgsUsersVoicesRetrieve(id
|
|
4708
|
+
static aiMentorOrgsUsersVoicesRetrieve({ id, org, userId, }: {
|
|
4709
|
+
/**
|
|
4710
|
+
* A unique integer value identifying this voice.
|
|
4711
|
+
*/
|
|
4712
|
+
id: number;
|
|
4713
|
+
org: string;
|
|
4714
|
+
}): CancelablePromise<Voice>;
|
|
4209
4715
|
/**
|
|
4210
|
-
* @param org
|
|
4211
|
-
* @param slug
|
|
4212
4716
|
* @returns any No response body
|
|
4213
4717
|
* @throws ApiError
|
|
4214
4718
|
*/
|
|
4215
|
-
static aiMentorOrgsWebhooksAzureTriggerCreate(org
|
|
4719
|
+
static aiMentorOrgsWebhooksAzureTriggerCreate({ org, slug, }: {
|
|
4720
|
+
org: string;
|
|
4721
|
+
slug: string;
|
|
4722
|
+
}): CancelablePromise<any>;
|
|
4216
4723
|
/**
|
|
4217
4724
|
* Handle incoming POST requests from GitHub webhook for pull requests.
|
|
4218
4725
|
*
|
|
@@ -4222,11 +4729,12 @@ export declare class AiMentorService {
|
|
|
4222
4729
|
*
|
|
4223
4730
|
* Returns:
|
|
4224
4731
|
* Response: A response indicating the result of processing the webhook event.
|
|
4225
|
-
* @param org
|
|
4226
4732
|
* @returns any No response body
|
|
4227
4733
|
* @throws ApiError
|
|
4228
4734
|
*/
|
|
4229
|
-
static aiMentorOrgsWebhooksGithubPullrequestCreate(org
|
|
4735
|
+
static aiMentorOrgsWebhooksGithubPullrequestCreate({ org, }: {
|
|
4736
|
+
org: string;
|
|
4737
|
+
}): CancelablePromise<any>;
|
|
4230
4738
|
/**
|
|
4231
4739
|
* @returns any No response body
|
|
4232
4740
|
* @throws ApiError
|