@iblai/iblai-api 4.6.2-dev1-ai-plus → 4.7.0-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 +376 -1677
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +377 -1676
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +376 -1677
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +3 -39
- package/dist/types/models/MaskedIntegrationCredential.d.ts +8 -0
- package/dist/types/models/MaskedLLMCredential.d.ts +8 -0
- package/dist/types/models/ToolCategory.d.ts +5 -0
- package/dist/types/models/ToolResponse.d.ts +4 -1
- package/dist/types/services/AiAccountService.d.ts +54 -0
- package/dist/types/services/AiMentorService.d.ts +17 -2
- package/package.json +1 -1
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +3 -39
- package/src/models/MaskedIntegrationCredential.ts +13 -0
- package/src/models/{PatchedBotCommand.ts → MaskedLLMCredential.ts} +7 -5
- package/src/models/{BotCommand.ts → ToolCategory.ts} +3 -4
- package/src/models/ToolResponse.ts +4 -1
- package/src/services/AiAccountService.ts +82 -0
- package/src/services/AiMentorService.ts +36 -0
- 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 -642
- package/dist/types/services/AiFinetuningService.d.ts +0 -232
- package/src/models/Bot.ts +0 -20
- 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/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 -1330
- package/src/services/AiFinetuningService.ts +0 -472
package/dist/index.esm.js
CHANGED
|
@@ -108,7 +108,7 @@ class CancelablePromise {
|
|
|
108
108
|
|
|
109
109
|
const OpenAPI = {
|
|
110
110
|
BASE: 'https://base.manager.iblai.app',
|
|
111
|
-
VERSION: '4.
|
|
111
|
+
VERSION: '4.7.0-ai',
|
|
112
112
|
WITH_CREDENTIALS: false,
|
|
113
113
|
CREDENTIALS: 'include',
|
|
114
114
|
TOKEN: undefined,
|
|
@@ -269,24 +269,6 @@ var CrawlerPatternTypeEnum;
|
|
|
269
269
|
CrawlerPatternTypeEnum["REGEX"] = "regex";
|
|
270
270
|
})(CrawlerPatternTypeEnum || (CrawlerPatternTypeEnum = {}));
|
|
271
271
|
|
|
272
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
273
|
-
/* istanbul ignore file */
|
|
274
|
-
/* tslint:disable */
|
|
275
|
-
/* eslint-disable */
|
|
276
|
-
/**
|
|
277
|
-
* * `pending` - Pending
|
|
278
|
-
* * `processing` - Processing
|
|
279
|
-
* * `completed` - Completed
|
|
280
|
-
* * `failed` - Failed
|
|
281
|
-
*/
|
|
282
|
-
var DataSetStatusEnum;
|
|
283
|
-
(function (DataSetStatusEnum) {
|
|
284
|
-
DataSetStatusEnum["PENDING"] = "pending";
|
|
285
|
-
DataSetStatusEnum["PROCESSING"] = "processing";
|
|
286
|
-
DataSetStatusEnum["COMPLETED"] = "completed";
|
|
287
|
-
DataSetStatusEnum["FAILED"] = "failed";
|
|
288
|
-
})(DataSetStatusEnum || (DataSetStatusEnum = {}));
|
|
289
|
-
|
|
290
272
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
291
273
|
/* istanbul ignore file */
|
|
292
274
|
/* tslint:disable */
|
|
@@ -583,26 +565,6 @@ var PromptVisibilityEnum;
|
|
|
583
565
|
PromptVisibilityEnum["VIEWABLE_BY_ANYONE"] = "viewable_by_anyone";
|
|
584
566
|
})(PromptVisibilityEnum || (PromptVisibilityEnum = {}));
|
|
585
567
|
|
|
586
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
587
|
-
/* istanbul ignore file */
|
|
588
|
-
/* tslint:disable */
|
|
589
|
-
/* eslint-disable */
|
|
590
|
-
/**
|
|
591
|
-
* * `webex` - Webex
|
|
592
|
-
* * `slack` - Slack
|
|
593
|
-
* * `whatsapp` - Whatsapp
|
|
594
|
-
* * `discord` - Discord
|
|
595
|
-
* * `teams` - Teams
|
|
596
|
-
*/
|
|
597
|
-
var Provider05cEnum;
|
|
598
|
-
(function (Provider05cEnum) {
|
|
599
|
-
Provider05cEnum["WEBEX"] = "webex";
|
|
600
|
-
Provider05cEnum["SLACK"] = "slack";
|
|
601
|
-
Provider05cEnum["WHATSAPP"] = "whatsapp";
|
|
602
|
-
Provider05cEnum["DISCORD"] = "discord";
|
|
603
|
-
Provider05cEnum["TEAMS"] = "teams";
|
|
604
|
-
})(Provider05cEnum || (Provider05cEnum = {}));
|
|
605
|
-
|
|
606
568
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
607
569
|
/* istanbul ignore file */
|
|
608
570
|
/* tslint:disable */
|
|
@@ -619,18 +581,6 @@ var Provider637Enum;
|
|
|
619
581
|
Provider637Enum["ELEVENLABS"] = "elevenlabs";
|
|
620
582
|
})(Provider637Enum || (Provider637Enum = {}));
|
|
621
583
|
|
|
622
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
623
|
-
/* istanbul ignore file */
|
|
624
|
-
/* tslint:disable */
|
|
625
|
-
/* eslint-disable */
|
|
626
|
-
/**
|
|
627
|
-
* * `openai` - Openai
|
|
628
|
-
*/
|
|
629
|
-
var Provider63aEnum;
|
|
630
|
-
(function (Provider63aEnum) {
|
|
631
|
-
Provider63aEnum["OPENAI"] = "openai";
|
|
632
|
-
})(Provider63aEnum || (Provider63aEnum = {}));
|
|
633
|
-
|
|
634
584
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
635
585
|
/* istanbul ignore file */
|
|
636
586
|
/* tslint:disable */
|
|
@@ -1572,6 +1522,74 @@ class AiAccountService {
|
|
|
1572
1522
|
}
|
|
1573
1523
|
});
|
|
1574
1524
|
}
|
|
1525
|
+
/**
|
|
1526
|
+
* Retrieve masked integration credentials for an organization.
|
|
1527
|
+
*
|
|
1528
|
+
* Query Parameters:
|
|
1529
|
+
* name (optional): Filter results by integration service name
|
|
1530
|
+
*
|
|
1531
|
+
* Args:
|
|
1532
|
+
* request: The HTTP request
|
|
1533
|
+
* org: Organization key identifier
|
|
1534
|
+
*
|
|
1535
|
+
* Returns:
|
|
1536
|
+
* Response: List of integration credentials for the organization
|
|
1537
|
+
*
|
|
1538
|
+
* Raises:
|
|
1539
|
+
* NotFound: When organization is not found or when no credentials match the filters
|
|
1540
|
+
* ValidationError: When query parameters are invalid
|
|
1541
|
+
* @returns MaskedIntegrationCredential
|
|
1542
|
+
* @throws ApiError
|
|
1543
|
+
*/
|
|
1544
|
+
static aiAccountOrgsMaskedIntegrationCredentialList({
|
|
1545
|
+
org,
|
|
1546
|
+
name
|
|
1547
|
+
}) {
|
|
1548
|
+
return request(OpenAPI, {
|
|
1549
|
+
method: 'GET',
|
|
1550
|
+
url: '/api/ai-account/orgs/{org}/masked-integration-credential/',
|
|
1551
|
+
path: {
|
|
1552
|
+
'org': org
|
|
1553
|
+
},
|
|
1554
|
+
query: {
|
|
1555
|
+
'name': name
|
|
1556
|
+
}
|
|
1557
|
+
});
|
|
1558
|
+
}
|
|
1559
|
+
/**
|
|
1560
|
+
* Retrieve LLM credentials for an organization with the value entries masked.
|
|
1561
|
+
*
|
|
1562
|
+
* Query Parameters:
|
|
1563
|
+
* name (optional): Filter results by LLM provider name
|
|
1564
|
+
*
|
|
1565
|
+
* Args:
|
|
1566
|
+
* request: The HTTP request
|
|
1567
|
+
* org: Organization key identifier
|
|
1568
|
+
*
|
|
1569
|
+
* Returns:
|
|
1570
|
+
* Response: List of LLM credentials for the organization
|
|
1571
|
+
*
|
|
1572
|
+
* Raises:
|
|
1573
|
+
* NotFound: When organization is not found or when no credentials match the filters
|
|
1574
|
+
* ValidationError: When query parameters are invalid
|
|
1575
|
+
* @returns MaskedLLMCredential
|
|
1576
|
+
* @throws ApiError
|
|
1577
|
+
*/
|
|
1578
|
+
static aiAccountOrgsMaskedLlmCredentialRetrieve({
|
|
1579
|
+
org,
|
|
1580
|
+
name
|
|
1581
|
+
}) {
|
|
1582
|
+
return request(OpenAPI, {
|
|
1583
|
+
method: 'GET',
|
|
1584
|
+
url: '/api/ai-account/orgs/{org}/masked-llm-credential/',
|
|
1585
|
+
path: {
|
|
1586
|
+
'org': org
|
|
1587
|
+
},
|
|
1588
|
+
query: {
|
|
1589
|
+
'name': name
|
|
1590
|
+
}
|
|
1591
|
+
});
|
|
1592
|
+
}
|
|
1575
1593
|
/**
|
|
1576
1594
|
* Enable or disable the use of main LLM credentials for an organization.
|
|
1577
1595
|
*
|
|
@@ -9339,1747 +9357,406 @@ class AiAnalyticsService {
|
|
|
9339
9357
|
}
|
|
9340
9358
|
}
|
|
9341
9359
|
|
|
9342
|
-
class
|
|
9360
|
+
class AiIndexService {
|
|
9343
9361
|
/**
|
|
9344
|
-
*
|
|
9345
|
-
*
|
|
9362
|
+
* Retrieve details of a specific document embedding.
|
|
9363
|
+
*
|
|
9364
|
+
* This endpoint returns detailed information about a specific
|
|
9365
|
+
* document embedding identified by its ID.
|
|
9366
|
+
*
|
|
9367
|
+
* Args:
|
|
9368
|
+
* request: The HTTP request.
|
|
9369
|
+
* org: Organization key identifier.
|
|
9370
|
+
* document_id: The ID of the document embedding to retrieve.
|
|
9371
|
+
*
|
|
9372
|
+
* Returns:
|
|
9373
|
+
* Response: Detailed information about the document embedding.
|
|
9374
|
+
*
|
|
9375
|
+
* Raises:
|
|
9376
|
+
* NotFound: If the specified document embedding does not exist.
|
|
9377
|
+
* @returns RetrieverDocumentEmbedding
|
|
9346
9378
|
* @throws ApiError
|
|
9347
9379
|
*/
|
|
9348
|
-
static
|
|
9349
|
-
|
|
9380
|
+
static aiIndexOrgsUsersDocumentsRetrieve({
|
|
9381
|
+
documentId,
|
|
9382
|
+
org,
|
|
9383
|
+
userId
|
|
9350
9384
|
}) {
|
|
9351
9385
|
return request(OpenAPI, {
|
|
9352
9386
|
method: 'GET',
|
|
9353
|
-
url: '/api/ai-
|
|
9387
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
|
|
9354
9388
|
path: {
|
|
9355
|
-
'
|
|
9389
|
+
'document_id': documentId,
|
|
9390
|
+
'org': org,
|
|
9391
|
+
'user_id': userId
|
|
9392
|
+
},
|
|
9393
|
+
errors: {
|
|
9394
|
+
404: `Document not found`
|
|
9356
9395
|
}
|
|
9357
9396
|
});
|
|
9358
9397
|
}
|
|
9359
9398
|
/**
|
|
9360
|
-
*
|
|
9361
|
-
*
|
|
9399
|
+
* Update a specific document embedding.
|
|
9400
|
+
*
|
|
9401
|
+
* This endpoint allows updating various properties of a document embedding,
|
|
9402
|
+
* including its name, type, pathway, and training status.
|
|
9403
|
+
*
|
|
9404
|
+
* Args:
|
|
9405
|
+
* request: The HTTP request containing the updated document data.
|
|
9406
|
+
* org: Organization key identifier.
|
|
9407
|
+
* document_id: The ID of the document embedding to update.
|
|
9408
|
+
*
|
|
9409
|
+
* Returns:
|
|
9410
|
+
* Response: The updated document embedding information.
|
|
9411
|
+
*
|
|
9412
|
+
* Raises:
|
|
9413
|
+
* BadRequest: If the provided data is invalid.
|
|
9414
|
+
* NotFound: If the specified document embedding does not exist.
|
|
9415
|
+
* @returns RetrieverDocumentEmbedding
|
|
9362
9416
|
* @throws ApiError
|
|
9363
9417
|
*/
|
|
9364
|
-
static
|
|
9418
|
+
static aiIndexOrgsUsersDocumentsUpdate({
|
|
9419
|
+
documentId,
|
|
9365
9420
|
org,
|
|
9366
|
-
|
|
9421
|
+
userId,
|
|
9422
|
+
formData
|
|
9367
9423
|
}) {
|
|
9368
9424
|
return request(OpenAPI, {
|
|
9369
|
-
method: '
|
|
9370
|
-
url: '/api/ai-
|
|
9425
|
+
method: 'PUT',
|
|
9426
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
|
|
9371
9427
|
path: {
|
|
9372
|
-
'
|
|
9428
|
+
'document_id': documentId,
|
|
9429
|
+
'org': org,
|
|
9430
|
+
'user_id': userId
|
|
9373
9431
|
},
|
|
9374
|
-
|
|
9375
|
-
mediaType: '
|
|
9376
|
-
|
|
9377
|
-
|
|
9378
|
-
|
|
9379
|
-
* Create slash commands for a specific bot
|
|
9380
|
-
* eg. /iblai-baseline
|
|
9381
|
-
* @returns BotCommand
|
|
9382
|
-
* @throws ApiError
|
|
9383
|
-
*/
|
|
9384
|
-
static aiBotV1BotsBotCommandsList({
|
|
9385
|
-
org
|
|
9386
|
-
}) {
|
|
9387
|
-
return request(OpenAPI, {
|
|
9388
|
-
method: 'GET',
|
|
9389
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/',
|
|
9390
|
-
path: {
|
|
9391
|
-
'org': org
|
|
9432
|
+
formData: formData,
|
|
9433
|
+
mediaType: 'multipart/form-data',
|
|
9434
|
+
errors: {
|
|
9435
|
+
400: `Invalid request data`,
|
|
9436
|
+
404: `Document not found`
|
|
9392
9437
|
}
|
|
9393
9438
|
});
|
|
9394
9439
|
}
|
|
9395
9440
|
/**
|
|
9396
|
-
*
|
|
9397
|
-
*
|
|
9398
|
-
*
|
|
9441
|
+
* Delete a specific document embedding.
|
|
9442
|
+
*
|
|
9443
|
+
* This endpoint removes a document embedding from the system,
|
|
9444
|
+
* including untraining it from any associated pathways.
|
|
9445
|
+
*
|
|
9446
|
+
* Args:
|
|
9447
|
+
* request: The HTTP request.
|
|
9448
|
+
* org: Organization key identifier.
|
|
9449
|
+
* document_id: The ID of the document embedding to delete.
|
|
9450
|
+
*
|
|
9451
|
+
* Returns:
|
|
9452
|
+
* Response: An empty response with a 204 status code if successful.
|
|
9453
|
+
*
|
|
9454
|
+
* Raises:
|
|
9455
|
+
* NotFound: If the specified document embedding does not exist.
|
|
9456
|
+
* @returns void
|
|
9399
9457
|
* @throws ApiError
|
|
9400
9458
|
*/
|
|
9401
|
-
static
|
|
9459
|
+
static aiIndexOrgsUsersDocumentsDestroy({
|
|
9460
|
+
documentId,
|
|
9402
9461
|
org,
|
|
9403
|
-
|
|
9462
|
+
userId
|
|
9404
9463
|
}) {
|
|
9405
9464
|
return request(OpenAPI, {
|
|
9406
|
-
method: '
|
|
9407
|
-
url: '/api/ai-
|
|
9465
|
+
method: 'DELETE',
|
|
9466
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
|
|
9408
9467
|
path: {
|
|
9409
|
-
'
|
|
9468
|
+
'document_id': documentId,
|
|
9469
|
+
'org': org,
|
|
9470
|
+
'user_id': userId
|
|
9410
9471
|
},
|
|
9411
|
-
|
|
9412
|
-
|
|
9472
|
+
errors: {
|
|
9473
|
+
404: `Document not found`
|
|
9474
|
+
}
|
|
9413
9475
|
});
|
|
9414
9476
|
}
|
|
9415
9477
|
/**
|
|
9416
|
-
*
|
|
9417
|
-
*
|
|
9418
|
-
* @returns BotCommand
|
|
9478
|
+
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
9479
|
+
* @returns DocumentSettingsResponse
|
|
9419
9480
|
* @throws ApiError
|
|
9420
9481
|
*/
|
|
9421
|
-
static
|
|
9422
|
-
|
|
9423
|
-
org
|
|
9482
|
+
static aiIndexOrgsUsersDocumentsSettingsRetrieve({
|
|
9483
|
+
documentId,
|
|
9484
|
+
org,
|
|
9485
|
+
userId
|
|
9424
9486
|
}) {
|
|
9425
9487
|
return request(OpenAPI, {
|
|
9426
9488
|
method: 'GET',
|
|
9427
|
-
url: '/api/ai-
|
|
9489
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/',
|
|
9428
9490
|
path: {
|
|
9429
|
-
'
|
|
9430
|
-
'org': org
|
|
9491
|
+
'document_id': documentId,
|
|
9492
|
+
'org': org,
|
|
9493
|
+
'user_id': userId
|
|
9431
9494
|
}
|
|
9432
9495
|
});
|
|
9433
9496
|
}
|
|
9434
9497
|
/**
|
|
9435
|
-
*
|
|
9436
|
-
*
|
|
9437
|
-
* @returns BotCommand
|
|
9498
|
+
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
9499
|
+
* @returns DocumentSettingsResponse
|
|
9438
9500
|
* @throws ApiError
|
|
9439
9501
|
*/
|
|
9440
|
-
static
|
|
9441
|
-
|
|
9502
|
+
static aiIndexOrgsUsersDocumentsSettingsCreate({
|
|
9503
|
+
documentId,
|
|
9442
9504
|
org,
|
|
9505
|
+
userId,
|
|
9443
9506
|
requestBody
|
|
9444
9507
|
}) {
|
|
9445
9508
|
return request(OpenAPI, {
|
|
9446
|
-
method: '
|
|
9447
|
-
url: '/api/ai-
|
|
9509
|
+
method: 'POST',
|
|
9510
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/',
|
|
9448
9511
|
path: {
|
|
9449
|
-
'
|
|
9450
|
-
'org': org
|
|
9512
|
+
'document_id': documentId,
|
|
9513
|
+
'org': org,
|
|
9514
|
+
'user_id': userId
|
|
9451
9515
|
},
|
|
9452
9516
|
body: requestBody,
|
|
9453
9517
|
mediaType: 'application/json'
|
|
9454
9518
|
});
|
|
9455
9519
|
}
|
|
9456
9520
|
/**
|
|
9457
|
-
*
|
|
9458
|
-
*
|
|
9459
|
-
*
|
|
9460
|
-
*
|
|
9461
|
-
|
|
9462
|
-
|
|
9463
|
-
|
|
9521
|
+
* Description:
|
|
9522
|
+
* Retrieves a list of document embeddings for a specific pathway with optional search and pagination.
|
|
9523
|
+
*
|
|
9524
|
+
* Methods:
|
|
9525
|
+
* - GET: Retrieves document embeddings that match the specified search criteria and are paginated according to offset and limit.
|
|
9526
|
+
*
|
|
9527
|
+
* Parameters:
|
|
9528
|
+
* - search (str): Search query to filter document names or URLs.
|
|
9529
|
+
* - offset (int): Offset number for pagination.
|
|
9530
|
+
* - limit (int): Limit number for pagination.
|
|
9531
|
+
*
|
|
9532
|
+
* Returns:
|
|
9533
|
+
* - GET: A paginated list of document embeddings with their details.
|
|
9534
|
+
* {
|
|
9535
|
+
* "count": 10,
|
|
9536
|
+
* "next": "http://api.example.com/retriever_documents/?offset=10&limit=2",
|
|
9537
|
+
* "previous": "http://api.example.com/retriever_documents/?offset=0&limit=2",
|
|
9538
|
+
* "results": [
|
|
9539
|
+
* {
|
|
9540
|
+
* "document_name": "Document2",
|
|
9541
|
+
* "platform_key": "example_platform",
|
|
9542
|
+
* "pathway": "example_pathway"
|
|
9543
|
+
* }
|
|
9544
|
+
* ]
|
|
9545
|
+
* }
|
|
9546
|
+
*
|
|
9547
|
+
* Error Responses:
|
|
9548
|
+
* - 400 Bad Request: Invalid query parameters.
|
|
9549
|
+
* - 404 Not Found: No document embeddings found for the specified criteria.
|
|
9550
|
+
* @returns PaginatedRetrieverDocumentEmbeddingList
|
|
9551
|
+
* @throws ApiError
|
|
9552
|
+
*/
|
|
9553
|
+
static aiIndexOrgsUsersDocumentsPathwaysList({
|
|
9464
9554
|
org,
|
|
9465
|
-
|
|
9466
|
-
|
|
9467
|
-
|
|
9468
|
-
|
|
9469
|
-
|
|
9470
|
-
path: {
|
|
9471
|
-
'id': id,
|
|
9472
|
-
'org': org
|
|
9473
|
-
},
|
|
9474
|
-
body: requestBody,
|
|
9475
|
-
mediaType: 'application/json'
|
|
9476
|
-
});
|
|
9477
|
-
}
|
|
9478
|
-
/**
|
|
9479
|
-
* Create slash commands for a specific bot
|
|
9480
|
-
* eg. /iblai-baseline
|
|
9481
|
-
* @returns void
|
|
9482
|
-
* @throws ApiError
|
|
9483
|
-
*/
|
|
9484
|
-
static aiBotV1BotsBotCommandsDestroy({
|
|
9485
|
-
id,
|
|
9486
|
-
org
|
|
9487
|
-
}) {
|
|
9488
|
-
return request(OpenAPI, {
|
|
9489
|
-
method: 'DELETE',
|
|
9490
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
|
|
9491
|
-
path: {
|
|
9492
|
-
'id': id,
|
|
9493
|
-
'org': org
|
|
9494
|
-
}
|
|
9495
|
-
});
|
|
9496
|
-
}
|
|
9497
|
-
/**
|
|
9498
|
-
* Create modify and update bot information for a specific tenant.
|
|
9499
|
-
* @returns Bot
|
|
9500
|
-
* @throws ApiError
|
|
9501
|
-
*/
|
|
9502
|
-
static aiBotV1BotsBotRetrieve({
|
|
9503
|
-
id,
|
|
9504
|
-
org
|
|
9555
|
+
pathway,
|
|
9556
|
+
userId,
|
|
9557
|
+
limit,
|
|
9558
|
+
offset,
|
|
9559
|
+
search
|
|
9505
9560
|
}) {
|
|
9506
9561
|
return request(OpenAPI, {
|
|
9507
9562
|
method: 'GET',
|
|
9508
|
-
url: '/api/ai-
|
|
9563
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/pathways/{pathway}/',
|
|
9509
9564
|
path: {
|
|
9510
|
-
'
|
|
9511
|
-
'
|
|
9565
|
+
'org': org,
|
|
9566
|
+
'pathway': pathway,
|
|
9567
|
+
'user_id': userId
|
|
9568
|
+
},
|
|
9569
|
+
query: {
|
|
9570
|
+
'limit': limit,
|
|
9571
|
+
'offset': offset,
|
|
9572
|
+
'search': search
|
|
9512
9573
|
}
|
|
9513
9574
|
});
|
|
9514
9575
|
}
|
|
9515
9576
|
/**
|
|
9516
|
-
*
|
|
9517
|
-
*
|
|
9577
|
+
* Retrieve resource documents similar to the given query.
|
|
9578
|
+
*
|
|
9579
|
+
* This endpoint performs a semantic search to find documents that are
|
|
9580
|
+
* relevant to the provided query within the specified pathway.
|
|
9581
|
+
*
|
|
9582
|
+
* Args:
|
|
9583
|
+
* request: The HTTP request containing the search query.
|
|
9584
|
+
* org: Organization key identifier.
|
|
9585
|
+
*
|
|
9586
|
+
* Returns:
|
|
9587
|
+
* Response: A list of documents relevant to the search query.
|
|
9588
|
+
*
|
|
9589
|
+
* Raises:
|
|
9590
|
+
* ValidationError: If the request data is invalid.
|
|
9591
|
+
* @returns RetrieverResponseSearch
|
|
9518
9592
|
* @throws ApiError
|
|
9519
9593
|
*/
|
|
9520
|
-
static
|
|
9521
|
-
id,
|
|
9594
|
+
static aiIndexOrgsUsersDocumentsSearchCreate({
|
|
9522
9595
|
org,
|
|
9596
|
+
userId,
|
|
9523
9597
|
requestBody
|
|
9524
9598
|
}) {
|
|
9525
9599
|
return request(OpenAPI, {
|
|
9526
|
-
method: '
|
|
9527
|
-
url: '/api/ai-
|
|
9600
|
+
method: 'POST',
|
|
9601
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/search/',
|
|
9528
9602
|
path: {
|
|
9529
|
-
'
|
|
9530
|
-
'
|
|
9603
|
+
'org': org,
|
|
9604
|
+
'user_id': userId
|
|
9531
9605
|
},
|
|
9532
9606
|
body: requestBody,
|
|
9533
|
-
mediaType: 'application/json'
|
|
9607
|
+
mediaType: 'application/json',
|
|
9608
|
+
errors: {
|
|
9609
|
+
400: `Invalid request data`
|
|
9610
|
+
}
|
|
9534
9611
|
});
|
|
9535
9612
|
}
|
|
9536
9613
|
/**
|
|
9537
|
-
*
|
|
9538
|
-
*
|
|
9614
|
+
* Retrieve document sources related to a given query.
|
|
9615
|
+
*
|
|
9616
|
+
* This endpoint performs a semantic search to find document sources
|
|
9617
|
+
* that are relevant to the provided query within the specified pathway,
|
|
9618
|
+
* and returns them along with confidence levels.
|
|
9619
|
+
*
|
|
9620
|
+
* Args:
|
|
9621
|
+
* request: The HTTP request containing the search query.
|
|
9622
|
+
* org: Organization key identifier.
|
|
9623
|
+
*
|
|
9624
|
+
* Returns:
|
|
9625
|
+
* Response: A list of document sources with confidence levels.
|
|
9626
|
+
*
|
|
9627
|
+
* Raises:
|
|
9628
|
+
* ValidationError: If the request data is invalid.
|
|
9629
|
+
* @returns RetrieverRequestSearchDocument
|
|
9539
9630
|
* @throws ApiError
|
|
9540
9631
|
*/
|
|
9541
|
-
static
|
|
9542
|
-
id,
|
|
9632
|
+
static aiIndexOrgsUsersDocumentsSourcesCreate({
|
|
9543
9633
|
org,
|
|
9634
|
+
userId,
|
|
9544
9635
|
requestBody
|
|
9545
9636
|
}) {
|
|
9546
9637
|
return request(OpenAPI, {
|
|
9547
|
-
method: '
|
|
9548
|
-
url: '/api/ai-
|
|
9638
|
+
method: 'POST',
|
|
9639
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/sources/',
|
|
9549
9640
|
path: {
|
|
9550
|
-
'
|
|
9551
|
-
'
|
|
9641
|
+
'org': org,
|
|
9642
|
+
'user_id': userId
|
|
9552
9643
|
},
|
|
9553
9644
|
body: requestBody,
|
|
9554
|
-
mediaType: 'application/json'
|
|
9555
|
-
|
|
9556
|
-
|
|
9557
|
-
/**
|
|
9558
|
-
* Create modify and update bot information for a specific tenant.
|
|
9559
|
-
* @returns void
|
|
9560
|
-
* @throws ApiError
|
|
9561
|
-
*/
|
|
9562
|
-
static aiBotV1BotsBotDestroy({
|
|
9563
|
-
id,
|
|
9564
|
-
org
|
|
9565
|
-
}) {
|
|
9566
|
-
return request(OpenAPI, {
|
|
9567
|
-
method: 'DELETE',
|
|
9568
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
|
|
9569
|
-
path: {
|
|
9570
|
-
'id': id,
|
|
9571
|
-
'org': org
|
|
9572
|
-
}
|
|
9573
|
-
});
|
|
9574
|
-
}
|
|
9575
|
-
/**
|
|
9576
|
-
* Create modify and update bot information for a specific tenant.
|
|
9577
|
-
* @returns DiscordConfig
|
|
9578
|
-
* @throws ApiError
|
|
9579
|
-
*/
|
|
9580
|
-
static aiBotV1BotsBotConfigDiscordRetrieve({
|
|
9581
|
-
id,
|
|
9582
|
-
org
|
|
9583
|
-
}) {
|
|
9584
|
-
return request(OpenAPI, {
|
|
9585
|
-
method: 'GET',
|
|
9586
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
|
|
9587
|
-
path: {
|
|
9588
|
-
'id': id,
|
|
9589
|
-
'org': org
|
|
9645
|
+
mediaType: 'application/json',
|
|
9646
|
+
errors: {
|
|
9647
|
+
400: `Invalid request data`
|
|
9590
9648
|
}
|
|
9591
9649
|
});
|
|
9592
9650
|
}
|
|
9593
9651
|
/**
|
|
9594
|
-
*
|
|
9595
|
-
*
|
|
9652
|
+
* Check the status of a document training task.
|
|
9653
|
+
*
|
|
9654
|
+
* This endpoint retrieves the current status of an asynchronous
|
|
9655
|
+
* document training task that was previously initiated.
|
|
9656
|
+
*
|
|
9657
|
+
* Args:
|
|
9658
|
+
* request: The HTTP request.
|
|
9659
|
+
* org: Organization key identifier.
|
|
9660
|
+
* task_id: The ID of the training task to check.
|
|
9661
|
+
*
|
|
9662
|
+
* Returns:
|
|
9663
|
+
* Response: The current status of the document training task,
|
|
9664
|
+
* which can be "pending", "completed", or "failed".
|
|
9665
|
+
* @returns CheckDocumentTrainingStatus
|
|
9596
9666
|
* @throws ApiError
|
|
9597
9667
|
*/
|
|
9598
|
-
static
|
|
9599
|
-
id,
|
|
9668
|
+
static aiIndexOrgsUsersDocumentsTasksRetrieve({
|
|
9600
9669
|
org,
|
|
9601
|
-
|
|
9602
|
-
|
|
9603
|
-
return request(OpenAPI, {
|
|
9604
|
-
method: 'PATCH',
|
|
9605
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
|
|
9606
|
-
path: {
|
|
9607
|
-
'id': id,
|
|
9608
|
-
'org': org
|
|
9609
|
-
},
|
|
9610
|
-
body: requestBody,
|
|
9611
|
-
mediaType: 'application/json'
|
|
9612
|
-
});
|
|
9613
|
-
}
|
|
9614
|
-
/**
|
|
9615
|
-
* Create modify and update bot information for a specific tenant.
|
|
9616
|
-
* @returns SlackConfig
|
|
9617
|
-
* @throws ApiError
|
|
9618
|
-
*/
|
|
9619
|
-
static aiBotV1BotsBotConfigSlackRetrieve({
|
|
9620
|
-
id,
|
|
9621
|
-
org
|
|
9670
|
+
taskId,
|
|
9671
|
+
userId
|
|
9622
9672
|
}) {
|
|
9623
9673
|
return request(OpenAPI, {
|
|
9624
9674
|
method: 'GET',
|
|
9625
|
-
url: '/api/ai-
|
|
9675
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/tasks/{task_id}/',
|
|
9626
9676
|
path: {
|
|
9627
|
-
'
|
|
9628
|
-
'
|
|
9677
|
+
'org': org,
|
|
9678
|
+
'task_id': taskId,
|
|
9679
|
+
'user_id': userId
|
|
9629
9680
|
}
|
|
9630
9681
|
});
|
|
9631
9682
|
}
|
|
9632
9683
|
/**
|
|
9633
|
-
*
|
|
9634
|
-
*
|
|
9684
|
+
* Train a document through a worker process.
|
|
9685
|
+
*
|
|
9686
|
+
* This endpoint queues larger documents for training through a worker
|
|
9687
|
+
* process, which is more suitable for handling documents that would
|
|
9688
|
+
* take too long to process directly.
|
|
9689
|
+
*
|
|
9690
|
+
* Args:
|
|
9691
|
+
* request: The HTTP request containing the document information.
|
|
9692
|
+
* org: Organization key identifier.
|
|
9693
|
+
*
|
|
9694
|
+
* Returns:
|
|
9695
|
+
* Response: A confirmation that the document was queued for training,
|
|
9696
|
+
* including a task ID for tracking the progress.
|
|
9697
|
+
*
|
|
9698
|
+
* Raises:
|
|
9699
|
+
* ValidationError: If the request data is invalid.
|
|
9700
|
+
* BadRequest: If there was an error processing the document.
|
|
9701
|
+
* @returns TrainDocumentViewResponse
|
|
9635
9702
|
* @throws ApiError
|
|
9636
9703
|
*/
|
|
9637
|
-
static
|
|
9638
|
-
id,
|
|
9704
|
+
static aiIndexOrgsUsersDocumentsTrainCreate({
|
|
9639
9705
|
org,
|
|
9640
|
-
|
|
9706
|
+
userId,
|
|
9707
|
+
formData
|
|
9641
9708
|
}) {
|
|
9642
9709
|
return request(OpenAPI, {
|
|
9643
9710
|
method: 'POST',
|
|
9644
|
-
url: '/api/ai-
|
|
9711
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/train/',
|
|
9645
9712
|
path: {
|
|
9646
|
-
'
|
|
9647
|
-
'
|
|
9713
|
+
'org': org,
|
|
9714
|
+
'user_id': userId
|
|
9648
9715
|
},
|
|
9649
|
-
|
|
9650
|
-
mediaType: '
|
|
9716
|
+
formData: formData,
|
|
9717
|
+
mediaType: 'multipart/form-data',
|
|
9718
|
+
errors: {
|
|
9719
|
+
400: `Invalid request data`
|
|
9720
|
+
}
|
|
9651
9721
|
});
|
|
9652
9722
|
}
|
|
9653
9723
|
/**
|
|
9654
|
-
*
|
|
9655
|
-
*
|
|
9724
|
+
* Train a document directly without using a worker.
|
|
9725
|
+
*
|
|
9726
|
+
* This endpoint is designed for training smaller documents directly
|
|
9727
|
+
* without queuing them through a worker process. For larger documents,
|
|
9728
|
+
* use the TrainDocumentView endpoint instead.
|
|
9729
|
+
*
|
|
9730
|
+
* Args:
|
|
9731
|
+
* request: The HTTP request containing the document information.
|
|
9732
|
+
* org: Organization key identifier.
|
|
9733
|
+
*
|
|
9734
|
+
* Returns:
|
|
9735
|
+
* Response: A confirmation that the document was trained successfully.
|
|
9736
|
+
*
|
|
9737
|
+
* Raises:
|
|
9738
|
+
* ValidationError: If the request data is invalid.
|
|
9739
|
+
* BadRequest: If the document training failed.
|
|
9740
|
+
* @returns RetreiverTrainViewResponse
|
|
9656
9741
|
* @throws ApiError
|
|
9657
9742
|
*/
|
|
9658
|
-
static
|
|
9659
|
-
id,
|
|
9743
|
+
static aiIndexOrgsUsersDocumentsTrainRetrieverCreate({
|
|
9660
9744
|
org,
|
|
9661
|
-
|
|
9745
|
+
userId,
|
|
9746
|
+
formData
|
|
9662
9747
|
}) {
|
|
9663
9748
|
return request(OpenAPI, {
|
|
9664
|
-
method: '
|
|
9665
|
-
url: '/api/ai-
|
|
9749
|
+
method: 'POST',
|
|
9750
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/train/retriever/',
|
|
9666
9751
|
path: {
|
|
9667
|
-
'
|
|
9668
|
-
'
|
|
9752
|
+
'org': org,
|
|
9753
|
+
'user_id': userId
|
|
9669
9754
|
},
|
|
9670
|
-
|
|
9671
|
-
mediaType: '
|
|
9672
|
-
|
|
9673
|
-
|
|
9674
|
-
|
|
9675
|
-
* Create modify and update bot information for a specific tenant.
|
|
9676
|
-
* @returns SlackConfig
|
|
9677
|
-
* @throws ApiError
|
|
9678
|
-
*/
|
|
9679
|
-
static aiBotV1BotsBotConfigSlackUpdatePartialUpdate({
|
|
9680
|
-
id,
|
|
9681
|
-
org,
|
|
9682
|
-
requestBody
|
|
9683
|
-
}) {
|
|
9684
|
-
return request(OpenAPI, {
|
|
9685
|
-
method: 'PATCH',
|
|
9686
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
|
|
9687
|
-
path: {
|
|
9688
|
-
'id': id,
|
|
9689
|
-
'org': org
|
|
9690
|
-
},
|
|
9691
|
-
body: requestBody,
|
|
9692
|
-
mediaType: 'application/json'
|
|
9693
|
-
});
|
|
9694
|
-
}
|
|
9695
|
-
/**
|
|
9696
|
-
* Create modify and update bot information for a specific tenant.
|
|
9697
|
-
* @returns TeamsConfig
|
|
9698
|
-
* @throws ApiError
|
|
9699
|
-
*/
|
|
9700
|
-
static aiBotV1BotsBotConfigTeamsRetrieve({
|
|
9701
|
-
id,
|
|
9702
|
-
org
|
|
9703
|
-
}) {
|
|
9704
|
-
return request(OpenAPI, {
|
|
9705
|
-
method: 'GET',
|
|
9706
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/',
|
|
9707
|
-
path: {
|
|
9708
|
-
'id': id,
|
|
9709
|
-
'org': org
|
|
9710
|
-
}
|
|
9711
|
-
});
|
|
9712
|
-
}
|
|
9713
|
-
/**
|
|
9714
|
-
* Create modify and update bot information for a specific tenant.
|
|
9715
|
-
* @returns TeamsConfig
|
|
9716
|
-
* @throws ApiError
|
|
9717
|
-
*/
|
|
9718
|
-
static aiBotV1BotsBotConfigTeamsUpdateCreate({
|
|
9719
|
-
id,
|
|
9720
|
-
org,
|
|
9721
|
-
requestBody
|
|
9722
|
-
}) {
|
|
9723
|
-
return request(OpenAPI, {
|
|
9724
|
-
method: 'POST',
|
|
9725
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
|
|
9726
|
-
path: {
|
|
9727
|
-
'id': id,
|
|
9728
|
-
'org': org
|
|
9729
|
-
},
|
|
9730
|
-
body: requestBody,
|
|
9731
|
-
mediaType: 'application/json'
|
|
9732
|
-
});
|
|
9733
|
-
}
|
|
9734
|
-
/**
|
|
9735
|
-
* Create modify and update bot information for a specific tenant.
|
|
9736
|
-
* @returns TeamsConfig
|
|
9737
|
-
* @throws ApiError
|
|
9738
|
-
*/
|
|
9739
|
-
static aiBotV1BotsBotConfigTeamsUpdateUpdate({
|
|
9740
|
-
id,
|
|
9741
|
-
org,
|
|
9742
|
-
requestBody
|
|
9743
|
-
}) {
|
|
9744
|
-
return request(OpenAPI, {
|
|
9745
|
-
method: 'PUT',
|
|
9746
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
|
|
9747
|
-
path: {
|
|
9748
|
-
'id': id,
|
|
9749
|
-
'org': org
|
|
9750
|
-
},
|
|
9751
|
-
body: requestBody,
|
|
9752
|
-
mediaType: 'application/json'
|
|
9753
|
-
});
|
|
9754
|
-
}
|
|
9755
|
-
/**
|
|
9756
|
-
* Create modify and update bot information for a specific tenant.
|
|
9757
|
-
* @returns TeamsConfig
|
|
9758
|
-
* @throws ApiError
|
|
9759
|
-
*/
|
|
9760
|
-
static aiBotV1BotsBotConfigTeamsUpdatePartialUpdate({
|
|
9761
|
-
id,
|
|
9762
|
-
org,
|
|
9763
|
-
requestBody
|
|
9764
|
-
}) {
|
|
9765
|
-
return request(OpenAPI, {
|
|
9766
|
-
method: 'PATCH',
|
|
9767
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
|
|
9768
|
-
path: {
|
|
9769
|
-
'id': id,
|
|
9770
|
-
'org': org
|
|
9771
|
-
},
|
|
9772
|
-
body: requestBody,
|
|
9773
|
-
mediaType: 'application/json'
|
|
9774
|
-
});
|
|
9775
|
-
}
|
|
9776
|
-
/**
|
|
9777
|
-
* Create modify and update bot information for a specific tenant.
|
|
9778
|
-
* @returns WebexConfig
|
|
9779
|
-
* @throws ApiError
|
|
9780
|
-
*/
|
|
9781
|
-
static aiBotV1BotsBotConfigWebexRetrieve({
|
|
9782
|
-
id,
|
|
9783
|
-
org
|
|
9784
|
-
}) {
|
|
9785
|
-
return request(OpenAPI, {
|
|
9786
|
-
method: 'GET',
|
|
9787
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/webex/',
|
|
9788
|
-
path: {
|
|
9789
|
-
'id': id,
|
|
9790
|
-
'org': org
|
|
9791
|
-
}
|
|
9792
|
-
});
|
|
9793
|
-
}
|
|
9794
|
-
/**
|
|
9795
|
-
* Create modify and update bot information for a specific tenant.
|
|
9796
|
-
* @returns WebexConfig
|
|
9797
|
-
* @throws ApiError
|
|
9798
|
-
*/
|
|
9799
|
-
static aiBotV1BotsBotConfigWebexPartialUpdate({
|
|
9800
|
-
id,
|
|
9801
|
-
org,
|
|
9802
|
-
requestBody
|
|
9803
|
-
}) {
|
|
9804
|
-
return request(OpenAPI, {
|
|
9805
|
-
method: 'PATCH',
|
|
9806
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/webex/',
|
|
9807
|
-
path: {
|
|
9808
|
-
'id': id,
|
|
9809
|
-
'org': org
|
|
9810
|
-
},
|
|
9811
|
-
body: requestBody,
|
|
9812
|
-
mediaType: 'application/json'
|
|
9813
|
-
});
|
|
9814
|
-
}
|
|
9815
|
-
/**
|
|
9816
|
-
* Create modify and update bot information for a specific tenant.
|
|
9817
|
-
* @returns WhatsappConfig
|
|
9818
|
-
* @throws ApiError
|
|
9819
|
-
*/
|
|
9820
|
-
static aiBotV1BotsBotConfigWhatsappRetrieve({
|
|
9821
|
-
id,
|
|
9822
|
-
org
|
|
9823
|
-
}) {
|
|
9824
|
-
return request(OpenAPI, {
|
|
9825
|
-
method: 'GET',
|
|
9826
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/whatsapp/',
|
|
9827
|
-
path: {
|
|
9828
|
-
'id': id,
|
|
9829
|
-
'org': org
|
|
9830
|
-
}
|
|
9831
|
-
});
|
|
9832
|
-
}
|
|
9833
|
-
/**
|
|
9834
|
-
* Create modify and update bot information for a specific tenant.
|
|
9835
|
-
* @returns WhatsappConfig
|
|
9836
|
-
* @throws ApiError
|
|
9837
|
-
*/
|
|
9838
|
-
static aiBotV1BotsBotWhatsappConfigUpdate({
|
|
9839
|
-
id,
|
|
9840
|
-
org,
|
|
9841
|
-
requestBody
|
|
9842
|
-
}) {
|
|
9843
|
-
return request(OpenAPI, {
|
|
9844
|
-
method: 'PUT',
|
|
9845
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/whatsapp-config/',
|
|
9846
|
-
path: {
|
|
9847
|
-
'id': id,
|
|
9848
|
-
'org': org
|
|
9849
|
-
},
|
|
9850
|
-
body: requestBody,
|
|
9851
|
-
mediaType: 'application/json'
|
|
9852
|
-
});
|
|
9853
|
-
}
|
|
9854
|
-
/**
|
|
9855
|
-
* Create modify and update bot information for a specific tenant.
|
|
9856
|
-
* @returns WhatsappConfig
|
|
9857
|
-
* @throws ApiError
|
|
9858
|
-
*/
|
|
9859
|
-
static aiBotV1BotsBotWhatsappConfigPartialUpdate({
|
|
9860
|
-
id,
|
|
9861
|
-
org,
|
|
9862
|
-
requestBody
|
|
9863
|
-
}) {
|
|
9864
|
-
return request(OpenAPI, {
|
|
9865
|
-
method: 'PATCH',
|
|
9866
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/whatsapp-config/',
|
|
9867
|
-
path: {
|
|
9868
|
-
'id': id,
|
|
9869
|
-
'org': org
|
|
9870
|
-
},
|
|
9871
|
-
body: requestBody,
|
|
9872
|
-
mediaType: 'application/json'
|
|
9873
|
-
});
|
|
9874
|
-
}
|
|
9875
|
-
/**
|
|
9876
|
-
* Setup discord user id linkage with discord bots
|
|
9877
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
9878
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
9879
|
-
* @returns DiscordUserConfig
|
|
9880
|
-
* @throws ApiError
|
|
9881
|
-
*/
|
|
9882
|
-
static aiBotV1BotsDiscordUserConfigList({
|
|
9883
|
-
org
|
|
9884
|
-
}) {
|
|
9885
|
-
return request(OpenAPI, {
|
|
9886
|
-
method: 'GET',
|
|
9887
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/',
|
|
9888
|
-
path: {
|
|
9889
|
-
'org': org
|
|
9890
|
-
}
|
|
9891
|
-
});
|
|
9892
|
-
}
|
|
9893
|
-
/**
|
|
9894
|
-
* Setup discord user id linkage with discord bots
|
|
9895
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
9896
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
9897
|
-
* @returns DiscordUserConfig
|
|
9898
|
-
* @throws ApiError
|
|
9899
|
-
*/
|
|
9900
|
-
static aiBotV1BotsDiscordUserConfigCreate({
|
|
9901
|
-
org,
|
|
9902
|
-
requestBody
|
|
9903
|
-
}) {
|
|
9904
|
-
return request(OpenAPI, {
|
|
9905
|
-
method: 'POST',
|
|
9906
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/',
|
|
9907
|
-
path: {
|
|
9908
|
-
'org': org
|
|
9909
|
-
},
|
|
9910
|
-
body: requestBody,
|
|
9911
|
-
mediaType: 'application/json'
|
|
9912
|
-
});
|
|
9913
|
-
}
|
|
9914
|
-
/**
|
|
9915
|
-
* Setup discord user id linkage with discord bots
|
|
9916
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
9917
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
9918
|
-
* @returns DiscordUserConfig
|
|
9919
|
-
* @throws ApiError
|
|
9920
|
-
*/
|
|
9921
|
-
static aiBotV1BotsDiscordUserConfigRetrieve({
|
|
9922
|
-
id,
|
|
9923
|
-
org
|
|
9924
|
-
}) {
|
|
9925
|
-
return request(OpenAPI, {
|
|
9926
|
-
method: 'GET',
|
|
9927
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
9928
|
-
path: {
|
|
9929
|
-
'id': id,
|
|
9930
|
-
'org': org
|
|
9931
|
-
}
|
|
9932
|
-
});
|
|
9933
|
-
}
|
|
9934
|
-
/**
|
|
9935
|
-
* Setup discord user id linkage with discord bots
|
|
9936
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
9937
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
9938
|
-
* @returns DiscordUserConfig
|
|
9939
|
-
* @throws ApiError
|
|
9940
|
-
*/
|
|
9941
|
-
static aiBotV1BotsDiscordUserConfigUpdate({
|
|
9942
|
-
id,
|
|
9943
|
-
org,
|
|
9944
|
-
requestBody
|
|
9945
|
-
}) {
|
|
9946
|
-
return request(OpenAPI, {
|
|
9947
|
-
method: 'PUT',
|
|
9948
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
9949
|
-
path: {
|
|
9950
|
-
'id': id,
|
|
9951
|
-
'org': org
|
|
9952
|
-
},
|
|
9953
|
-
body: requestBody,
|
|
9954
|
-
mediaType: 'application/json'
|
|
9955
|
-
});
|
|
9956
|
-
}
|
|
9957
|
-
/**
|
|
9958
|
-
* Setup discord user id linkage with discord bots
|
|
9959
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
9960
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
9961
|
-
* @returns DiscordUserConfig
|
|
9962
|
-
* @throws ApiError
|
|
9963
|
-
*/
|
|
9964
|
-
static aiBotV1BotsDiscordUserConfigPartialUpdate({
|
|
9965
|
-
id,
|
|
9966
|
-
org,
|
|
9967
|
-
requestBody
|
|
9968
|
-
}) {
|
|
9969
|
-
return request(OpenAPI, {
|
|
9970
|
-
method: 'PATCH',
|
|
9971
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
9972
|
-
path: {
|
|
9973
|
-
'id': id,
|
|
9974
|
-
'org': org
|
|
9975
|
-
},
|
|
9976
|
-
body: requestBody,
|
|
9977
|
-
mediaType: 'application/json'
|
|
9978
|
-
});
|
|
9979
|
-
}
|
|
9980
|
-
/**
|
|
9981
|
-
* Setup discord user id linkage with discord bots
|
|
9982
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
9983
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
9984
|
-
* @returns void
|
|
9985
|
-
* @throws ApiError
|
|
9986
|
-
*/
|
|
9987
|
-
static aiBotV1BotsDiscordUserConfigDestroy({
|
|
9988
|
-
id,
|
|
9989
|
-
org
|
|
9990
|
-
}) {
|
|
9991
|
-
return request(OpenAPI, {
|
|
9992
|
-
method: 'DELETE',
|
|
9993
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
9994
|
-
path: {
|
|
9995
|
-
'id': id,
|
|
9996
|
-
'org': org
|
|
9997
|
-
}
|
|
9998
|
-
});
|
|
9999
|
-
}
|
|
10000
|
-
/**
|
|
10001
|
-
* Setup slack username and domain linkage with slack bots
|
|
10002
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
10003
|
-
* @returns SlackUserConfig
|
|
10004
|
-
* @throws ApiError
|
|
10005
|
-
*/
|
|
10006
|
-
static aiBotV1BotsSlackUserConfigList({
|
|
10007
|
-
org
|
|
10008
|
-
}) {
|
|
10009
|
-
return request(OpenAPI, {
|
|
10010
|
-
method: 'GET',
|
|
10011
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/',
|
|
10012
|
-
path: {
|
|
10013
|
-
'org': org
|
|
10014
|
-
}
|
|
10015
|
-
});
|
|
10016
|
-
}
|
|
10017
|
-
/**
|
|
10018
|
-
* Setup slack username and domain linkage with slack bots
|
|
10019
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
10020
|
-
* @returns SlackUserConfig
|
|
10021
|
-
* @throws ApiError
|
|
10022
|
-
*/
|
|
10023
|
-
static aiBotV1BotsSlackUserConfigCreate({
|
|
10024
|
-
org,
|
|
10025
|
-
requestBody
|
|
10026
|
-
}) {
|
|
10027
|
-
return request(OpenAPI, {
|
|
10028
|
-
method: 'POST',
|
|
10029
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/',
|
|
10030
|
-
path: {
|
|
10031
|
-
'org': org
|
|
10032
|
-
},
|
|
10033
|
-
body: requestBody,
|
|
10034
|
-
mediaType: 'application/json'
|
|
10035
|
-
});
|
|
10036
|
-
}
|
|
10037
|
-
/**
|
|
10038
|
-
* Setup slack username and domain linkage with slack bots
|
|
10039
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
10040
|
-
* @returns SlackUserConfig
|
|
10041
|
-
* @throws ApiError
|
|
10042
|
-
*/
|
|
10043
|
-
static aiBotV1BotsSlackUserConfigRetrieve({
|
|
10044
|
-
id,
|
|
10045
|
-
org
|
|
10046
|
-
}) {
|
|
10047
|
-
return request(OpenAPI, {
|
|
10048
|
-
method: 'GET',
|
|
10049
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
10050
|
-
path: {
|
|
10051
|
-
'id': id,
|
|
10052
|
-
'org': org
|
|
10053
|
-
}
|
|
10054
|
-
});
|
|
10055
|
-
}
|
|
10056
|
-
/**
|
|
10057
|
-
* Setup slack username and domain linkage with slack bots
|
|
10058
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
10059
|
-
* @returns SlackUserConfig
|
|
10060
|
-
* @throws ApiError
|
|
10061
|
-
*/
|
|
10062
|
-
static aiBotV1BotsSlackUserConfigUpdate({
|
|
10063
|
-
id,
|
|
10064
|
-
org,
|
|
10065
|
-
requestBody
|
|
10066
|
-
}) {
|
|
10067
|
-
return request(OpenAPI, {
|
|
10068
|
-
method: 'PUT',
|
|
10069
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
10070
|
-
path: {
|
|
10071
|
-
'id': id,
|
|
10072
|
-
'org': org
|
|
10073
|
-
},
|
|
10074
|
-
body: requestBody,
|
|
10075
|
-
mediaType: 'application/json'
|
|
10076
|
-
});
|
|
10077
|
-
}
|
|
10078
|
-
/**
|
|
10079
|
-
* Setup slack username and domain linkage with slack bots
|
|
10080
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
10081
|
-
* @returns SlackUserConfig
|
|
10082
|
-
* @throws ApiError
|
|
10083
|
-
*/
|
|
10084
|
-
static aiBotV1BotsSlackUserConfigPartialUpdate({
|
|
10085
|
-
id,
|
|
10086
|
-
org,
|
|
10087
|
-
requestBody
|
|
10088
|
-
}) {
|
|
10089
|
-
return request(OpenAPI, {
|
|
10090
|
-
method: 'PATCH',
|
|
10091
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
10092
|
-
path: {
|
|
10093
|
-
'id': id,
|
|
10094
|
-
'org': org
|
|
10095
|
-
},
|
|
10096
|
-
body: requestBody,
|
|
10097
|
-
mediaType: 'application/json'
|
|
10098
|
-
});
|
|
10099
|
-
}
|
|
10100
|
-
/**
|
|
10101
|
-
* Setup slack username and domain linkage with slack bots
|
|
10102
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
10103
|
-
* @returns void
|
|
10104
|
-
* @throws ApiError
|
|
10105
|
-
*/
|
|
10106
|
-
static aiBotV1BotsSlackUserConfigDestroy({
|
|
10107
|
-
id,
|
|
10108
|
-
org
|
|
10109
|
-
}) {
|
|
10110
|
-
return request(OpenAPI, {
|
|
10111
|
-
method: 'DELETE',
|
|
10112
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
10113
|
-
path: {
|
|
10114
|
-
'id': id,
|
|
10115
|
-
'org': org
|
|
10116
|
-
}
|
|
10117
|
-
});
|
|
10118
|
-
}
|
|
10119
|
-
/**
|
|
10120
|
-
* Setup phone number linkage with whatsapp bots
|
|
10121
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
10122
|
-
* @returns WhatsappUserConfig
|
|
10123
|
-
* @throws ApiError
|
|
10124
|
-
*/
|
|
10125
|
-
static aiBotV1BotsWhatsappUserConfigList({
|
|
10126
|
-
org
|
|
10127
|
-
}) {
|
|
10128
|
-
return request(OpenAPI, {
|
|
10129
|
-
method: 'GET',
|
|
10130
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/',
|
|
10131
|
-
path: {
|
|
10132
|
-
'org': org
|
|
10133
|
-
}
|
|
10134
|
-
});
|
|
10135
|
-
}
|
|
10136
|
-
/**
|
|
10137
|
-
* Setup phone number linkage with whatsapp bots
|
|
10138
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
10139
|
-
* @returns WhatsappUserConfig
|
|
10140
|
-
* @throws ApiError
|
|
10141
|
-
*/
|
|
10142
|
-
static aiBotV1BotsWhatsappUserConfigCreate({
|
|
10143
|
-
org,
|
|
10144
|
-
requestBody
|
|
10145
|
-
}) {
|
|
10146
|
-
return request(OpenAPI, {
|
|
10147
|
-
method: 'POST',
|
|
10148
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/',
|
|
10149
|
-
path: {
|
|
10150
|
-
'org': org
|
|
10151
|
-
},
|
|
10152
|
-
body: requestBody,
|
|
10153
|
-
mediaType: 'application/json'
|
|
10154
|
-
});
|
|
10155
|
-
}
|
|
10156
|
-
/**
|
|
10157
|
-
* Setup phone number linkage with whatsapp bots
|
|
10158
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
10159
|
-
* @returns WhatsappUserConfig
|
|
10160
|
-
* @throws ApiError
|
|
10161
|
-
*/
|
|
10162
|
-
static aiBotV1BotsWhatsappUserConfigRetrieve({
|
|
10163
|
-
id,
|
|
10164
|
-
org
|
|
10165
|
-
}) {
|
|
10166
|
-
return request(OpenAPI, {
|
|
10167
|
-
method: 'GET',
|
|
10168
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
10169
|
-
path: {
|
|
10170
|
-
'id': id,
|
|
10171
|
-
'org': org
|
|
10172
|
-
}
|
|
10173
|
-
});
|
|
10174
|
-
}
|
|
10175
|
-
/**
|
|
10176
|
-
* Setup phone number linkage with whatsapp bots
|
|
10177
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
10178
|
-
* @returns WhatsappUserConfig
|
|
10179
|
-
* @throws ApiError
|
|
10180
|
-
*/
|
|
10181
|
-
static aiBotV1BotsWhatsappUserConfigUpdate({
|
|
10182
|
-
id,
|
|
10183
|
-
org,
|
|
10184
|
-
requestBody
|
|
10185
|
-
}) {
|
|
10186
|
-
return request(OpenAPI, {
|
|
10187
|
-
method: 'PUT',
|
|
10188
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
10189
|
-
path: {
|
|
10190
|
-
'id': id,
|
|
10191
|
-
'org': org
|
|
10192
|
-
},
|
|
10193
|
-
body: requestBody,
|
|
10194
|
-
mediaType: 'application/json'
|
|
10195
|
-
});
|
|
10196
|
-
}
|
|
10197
|
-
/**
|
|
10198
|
-
* Setup phone number linkage with whatsapp bots
|
|
10199
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
10200
|
-
* @returns WhatsappUserConfig
|
|
10201
|
-
* @throws ApiError
|
|
10202
|
-
*/
|
|
10203
|
-
static aiBotV1BotsWhatsappUserConfigPartialUpdate({
|
|
10204
|
-
id,
|
|
10205
|
-
org,
|
|
10206
|
-
requestBody
|
|
10207
|
-
}) {
|
|
10208
|
-
return request(OpenAPI, {
|
|
10209
|
-
method: 'PATCH',
|
|
10210
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
10211
|
-
path: {
|
|
10212
|
-
'id': id,
|
|
10213
|
-
'org': org
|
|
10214
|
-
},
|
|
10215
|
-
body: requestBody,
|
|
10216
|
-
mediaType: 'application/json'
|
|
10217
|
-
});
|
|
10218
|
-
}
|
|
10219
|
-
/**
|
|
10220
|
-
* Setup phone number linkage with whatsapp bots
|
|
10221
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
10222
|
-
* @returns void
|
|
10223
|
-
* @throws ApiError
|
|
10224
|
-
*/
|
|
10225
|
-
static aiBotV1BotsWhatsappUserConfigDestroy({
|
|
10226
|
-
id,
|
|
10227
|
-
org
|
|
10228
|
-
}) {
|
|
10229
|
-
return request(OpenAPI, {
|
|
10230
|
-
method: 'DELETE',
|
|
10231
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
10232
|
-
path: {
|
|
10233
|
-
'id': id,
|
|
10234
|
-
'org': org
|
|
10235
|
-
}
|
|
10236
|
-
});
|
|
10237
|
-
}
|
|
10238
|
-
/**
|
|
10239
|
-
* Webhook endpoint to receive and process discord messages.
|
|
10240
|
-
* @returns DiscordWebhook
|
|
10241
|
-
* @throws ApiError
|
|
10242
|
-
*/
|
|
10243
|
-
static aiBotV1BotsWebhooksDiscordCreate({
|
|
10244
|
-
name,
|
|
10245
|
-
org,
|
|
10246
|
-
requestBody
|
|
10247
|
-
}) {
|
|
10248
|
-
return request(OpenAPI, {
|
|
10249
|
-
method: 'POST',
|
|
10250
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/discord/{name}/',
|
|
10251
|
-
path: {
|
|
10252
|
-
'name': name,
|
|
10253
|
-
'org': org
|
|
10254
|
-
},
|
|
10255
|
-
body: requestBody,
|
|
10256
|
-
mediaType: 'application/json'
|
|
10257
|
-
});
|
|
10258
|
-
}
|
|
10259
|
-
/**
|
|
10260
|
-
* @returns SlackWebhook
|
|
10261
|
-
* @throws ApiError
|
|
10262
|
-
*/
|
|
10263
|
-
static aiBotV1BotsWebhooksSlackCreate({
|
|
10264
|
-
name,
|
|
10265
|
-
org,
|
|
10266
|
-
requestBody
|
|
10267
|
-
}) {
|
|
10268
|
-
return request(OpenAPI, {
|
|
10269
|
-
method: 'POST',
|
|
10270
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/slack/{name}/',
|
|
10271
|
-
path: {
|
|
10272
|
-
'name': name,
|
|
10273
|
-
'org': org
|
|
10274
|
-
},
|
|
10275
|
-
body: requestBody,
|
|
10276
|
-
mediaType: 'application/json'
|
|
10277
|
-
});
|
|
10278
|
-
}
|
|
10279
|
-
/**
|
|
10280
|
-
* @returns TeamsWebhook
|
|
10281
|
-
* @throws ApiError
|
|
10282
|
-
*/
|
|
10283
|
-
static aiBotV1BotsWebhooksTeamsCreate({
|
|
10284
|
-
name,
|
|
10285
|
-
org,
|
|
10286
|
-
requestBody
|
|
10287
|
-
}) {
|
|
10288
|
-
return request(OpenAPI, {
|
|
10289
|
-
method: 'POST',
|
|
10290
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/teams/{name}/',
|
|
10291
|
-
path: {
|
|
10292
|
-
'name': name,
|
|
10293
|
-
'org': org
|
|
10294
|
-
},
|
|
10295
|
-
body: requestBody,
|
|
10296
|
-
mediaType: 'application/json'
|
|
10297
|
-
});
|
|
10298
|
-
}
|
|
10299
|
-
/**
|
|
10300
|
-
* Webhook endpoint to receive and process discord messages.
|
|
10301
|
-
* @returns WebexWebhook
|
|
10302
|
-
* @throws ApiError
|
|
10303
|
-
*/
|
|
10304
|
-
static aiBotV1BotsWebhooksWebexCreate({
|
|
10305
|
-
name,
|
|
10306
|
-
org,
|
|
10307
|
-
requestBody
|
|
10308
|
-
}) {
|
|
10309
|
-
return request(OpenAPI, {
|
|
10310
|
-
method: 'POST',
|
|
10311
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/webex/{name}/',
|
|
10312
|
-
path: {
|
|
10313
|
-
'name': name,
|
|
10314
|
-
'org': org
|
|
10315
|
-
},
|
|
10316
|
-
body: requestBody,
|
|
10317
|
-
mediaType: 'application/json'
|
|
10318
|
-
});
|
|
10319
|
-
}
|
|
10320
|
-
/**
|
|
10321
|
-
* Respond to whatsapp's webhook challenge.
|
|
10322
|
-
* Parameters Required include the tenant key (org) and the name of the bot: (name)
|
|
10323
|
-
* @returns WhatAppWebHook
|
|
10324
|
-
* @throws ApiError
|
|
10325
|
-
*/
|
|
10326
|
-
static aiBotV1BotsWebhooksWhatsappRetrieve({
|
|
10327
|
-
name,
|
|
10328
|
-
org
|
|
10329
|
-
}) {
|
|
10330
|
-
return request(OpenAPI, {
|
|
10331
|
-
method: 'GET',
|
|
10332
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/whatsapp/{name}/',
|
|
10333
|
-
path: {
|
|
10334
|
-
'name': name,
|
|
10335
|
-
'org': org
|
|
10336
|
-
}
|
|
10337
|
-
});
|
|
10338
|
-
}
|
|
10339
|
-
/**
|
|
10340
|
-
* Accept and process webhook events from whatsapp.
|
|
10341
|
-
* @returns WhatAppWebHook
|
|
10342
|
-
* @throws ApiError
|
|
10343
|
-
*/
|
|
10344
|
-
static aiBotV1BotsWebhooksWhatsappCreate({
|
|
10345
|
-
name,
|
|
10346
|
-
org,
|
|
10347
|
-
requestBody
|
|
10348
|
-
}) {
|
|
10349
|
-
return request(OpenAPI, {
|
|
10350
|
-
method: 'POST',
|
|
10351
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/whatsapp/{name}/',
|
|
10352
|
-
path: {
|
|
10353
|
-
'name': name,
|
|
10354
|
-
'org': org
|
|
10355
|
-
},
|
|
10356
|
-
body: requestBody,
|
|
10357
|
-
mediaType: 'application/json'
|
|
10358
|
-
});
|
|
10359
|
-
}
|
|
10360
|
-
}
|
|
10361
|
-
|
|
10362
|
-
class AiFinetuningService {
|
|
10363
|
-
/**
|
|
10364
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
10365
|
-
* @returns PaginatedDataSetList
|
|
10366
|
-
* @throws ApiError
|
|
10367
|
-
*/
|
|
10368
|
-
static aiFinetuningV1OrgUserDatasetsList({
|
|
10369
|
-
org,
|
|
10370
|
-
username,
|
|
10371
|
-
dateCreated,
|
|
10372
|
-
numDataPoints,
|
|
10373
|
-
ordering,
|
|
10374
|
-
page,
|
|
10375
|
-
pageSize,
|
|
10376
|
-
retryAttempts,
|
|
10377
|
-
search,
|
|
10378
|
-
status
|
|
10379
|
-
}) {
|
|
10380
|
-
return request(OpenAPI, {
|
|
10381
|
-
method: 'GET',
|
|
10382
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/',
|
|
10383
|
-
path: {
|
|
10384
|
-
'org': org,
|
|
10385
|
-
'username': username
|
|
10386
|
-
},
|
|
10387
|
-
query: {
|
|
10388
|
-
'date_created': dateCreated,
|
|
10389
|
-
'num_data_points': numDataPoints,
|
|
10390
|
-
'ordering': ordering,
|
|
10391
|
-
'page': page,
|
|
10392
|
-
'page_size': pageSize,
|
|
10393
|
-
'retry_attempts': retryAttempts,
|
|
10394
|
-
'search': search,
|
|
10395
|
-
'status': status
|
|
10396
|
-
}
|
|
10397
|
-
});
|
|
10398
|
-
}
|
|
10399
|
-
/**
|
|
10400
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
10401
|
-
* @returns DataSetCreate
|
|
10402
|
-
* @throws ApiError
|
|
10403
|
-
*/
|
|
10404
|
-
static aiFinetuningV1OrgUserDatasetsCreate({
|
|
10405
|
-
org,
|
|
10406
|
-
username,
|
|
10407
|
-
requestBody
|
|
10408
|
-
}) {
|
|
10409
|
-
return request(OpenAPI, {
|
|
10410
|
-
method: 'POST',
|
|
10411
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/',
|
|
10412
|
-
path: {
|
|
10413
|
-
'org': org,
|
|
10414
|
-
'username': username
|
|
10415
|
-
},
|
|
10416
|
-
body: requestBody,
|
|
10417
|
-
mediaType: 'application/json'
|
|
10418
|
-
});
|
|
10419
|
-
}
|
|
10420
|
-
/**
|
|
10421
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
10422
|
-
* @returns DataSet
|
|
10423
|
-
* @throws ApiError
|
|
10424
|
-
*/
|
|
10425
|
-
static aiFinetuningV1OrgUserDatasetsRetrieve({
|
|
10426
|
-
id,
|
|
10427
|
-
org,
|
|
10428
|
-
username
|
|
10429
|
-
}) {
|
|
10430
|
-
return request(OpenAPI, {
|
|
10431
|
-
method: 'GET',
|
|
10432
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
|
|
10433
|
-
path: {
|
|
10434
|
-
'id': id,
|
|
10435
|
-
'org': org,
|
|
10436
|
-
'username': username
|
|
10437
|
-
}
|
|
10438
|
-
});
|
|
10439
|
-
}
|
|
10440
|
-
/**
|
|
10441
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
10442
|
-
* @returns DataSet
|
|
10443
|
-
* @throws ApiError
|
|
10444
|
-
*/
|
|
10445
|
-
static aiFinetuningV1OrgUserDatasetsUpdate({
|
|
10446
|
-
id,
|
|
10447
|
-
org,
|
|
10448
|
-
username,
|
|
10449
|
-
requestBody
|
|
10450
|
-
}) {
|
|
10451
|
-
return request(OpenAPI, {
|
|
10452
|
-
method: 'PUT',
|
|
10453
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
|
|
10454
|
-
path: {
|
|
10455
|
-
'id': id,
|
|
10456
|
-
'org': org,
|
|
10457
|
-
'username': username
|
|
10458
|
-
},
|
|
10459
|
-
body: requestBody,
|
|
10460
|
-
mediaType: 'application/json'
|
|
10461
|
-
});
|
|
10462
|
-
}
|
|
10463
|
-
/**
|
|
10464
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
10465
|
-
* @returns DataSet
|
|
10466
|
-
* @throws ApiError
|
|
10467
|
-
*/
|
|
10468
|
-
static aiFinetuningV1OrgUserDatasetsPartialUpdate({
|
|
10469
|
-
id,
|
|
10470
|
-
org,
|
|
10471
|
-
username,
|
|
10472
|
-
requestBody
|
|
10473
|
-
}) {
|
|
10474
|
-
return request(OpenAPI, {
|
|
10475
|
-
method: 'PATCH',
|
|
10476
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
|
|
10477
|
-
path: {
|
|
10478
|
-
'id': id,
|
|
10479
|
-
'org': org,
|
|
10480
|
-
'username': username
|
|
10481
|
-
},
|
|
10482
|
-
body: requestBody,
|
|
10483
|
-
mediaType: 'application/json'
|
|
10484
|
-
});
|
|
10485
|
-
}
|
|
10486
|
-
/**
|
|
10487
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
10488
|
-
* @returns void
|
|
10489
|
-
* @throws ApiError
|
|
10490
|
-
*/
|
|
10491
|
-
static aiFinetuningV1OrgUserDatasetsDestroy({
|
|
10492
|
-
id,
|
|
10493
|
-
org,
|
|
10494
|
-
username
|
|
10495
|
-
}) {
|
|
10496
|
-
return request(OpenAPI, {
|
|
10497
|
-
method: 'DELETE',
|
|
10498
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
|
|
10499
|
-
path: {
|
|
10500
|
-
'id': id,
|
|
10501
|
-
'org': org,
|
|
10502
|
-
'username': username
|
|
10503
|
-
}
|
|
10504
|
-
});
|
|
10505
|
-
}
|
|
10506
|
-
/**
|
|
10507
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
10508
|
-
* @returns PaginatedTrainingList
|
|
10509
|
-
* @throws ApiError
|
|
10510
|
-
*/
|
|
10511
|
-
static aiFinetuningV1OrgUserTrainingsList({
|
|
10512
|
-
org,
|
|
10513
|
-
username,
|
|
10514
|
-
baseModelName,
|
|
10515
|
-
dataset,
|
|
10516
|
-
dateCreated,
|
|
10517
|
-
fineTunedModel,
|
|
10518
|
-
lastModified,
|
|
10519
|
-
ordering,
|
|
10520
|
-
page,
|
|
10521
|
-
pageSize,
|
|
10522
|
-
preprocessDataset,
|
|
10523
|
-
provider,
|
|
10524
|
-
search,
|
|
10525
|
-
status
|
|
10526
|
-
}) {
|
|
10527
|
-
return request(OpenAPI, {
|
|
10528
|
-
method: 'GET',
|
|
10529
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/',
|
|
10530
|
-
path: {
|
|
10531
|
-
'org': org,
|
|
10532
|
-
'username': username
|
|
10533
|
-
},
|
|
10534
|
-
query: {
|
|
10535
|
-
'base_model_name': baseModelName,
|
|
10536
|
-
'dataset': dataset,
|
|
10537
|
-
'date_created': dateCreated,
|
|
10538
|
-
'fine_tuned_model': fineTunedModel,
|
|
10539
|
-
'last_modified': lastModified,
|
|
10540
|
-
'ordering': ordering,
|
|
10541
|
-
'page': page,
|
|
10542
|
-
'page_size': pageSize,
|
|
10543
|
-
'preprocess_dataset': preprocessDataset,
|
|
10544
|
-
'provider': provider,
|
|
10545
|
-
'search': search,
|
|
10546
|
-
'status': status
|
|
10547
|
-
}
|
|
10548
|
-
});
|
|
10549
|
-
}
|
|
10550
|
-
/**
|
|
10551
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
10552
|
-
* @returns TrainingCreate
|
|
10553
|
-
* @throws ApiError
|
|
10554
|
-
*/
|
|
10555
|
-
static aiFinetuningV1OrgUserTrainingsCreate({
|
|
10556
|
-
org,
|
|
10557
|
-
username,
|
|
10558
|
-
requestBody
|
|
10559
|
-
}) {
|
|
10560
|
-
return request(OpenAPI, {
|
|
10561
|
-
method: 'POST',
|
|
10562
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/',
|
|
10563
|
-
path: {
|
|
10564
|
-
'org': org,
|
|
10565
|
-
'username': username
|
|
10566
|
-
},
|
|
10567
|
-
body: requestBody,
|
|
10568
|
-
mediaType: 'application/json'
|
|
10569
|
-
});
|
|
10570
|
-
}
|
|
10571
|
-
/**
|
|
10572
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
10573
|
-
* @returns Training
|
|
10574
|
-
* @throws ApiError
|
|
10575
|
-
*/
|
|
10576
|
-
static aiFinetuningV1OrgUserTrainingsRetrieve({
|
|
10577
|
-
id,
|
|
10578
|
-
org,
|
|
10579
|
-
username
|
|
10580
|
-
}) {
|
|
10581
|
-
return request(OpenAPI, {
|
|
10582
|
-
method: 'GET',
|
|
10583
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
|
|
10584
|
-
path: {
|
|
10585
|
-
'id': id,
|
|
10586
|
-
'org': org,
|
|
10587
|
-
'username': username
|
|
10588
|
-
}
|
|
10589
|
-
});
|
|
10590
|
-
}
|
|
10591
|
-
/**
|
|
10592
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
10593
|
-
* @returns TrainingCreate
|
|
10594
|
-
* @throws ApiError
|
|
10595
|
-
*/
|
|
10596
|
-
static aiFinetuningV1OrgUserTrainingsUpdate({
|
|
10597
|
-
id,
|
|
10598
|
-
org,
|
|
10599
|
-
username,
|
|
10600
|
-
requestBody
|
|
10601
|
-
}) {
|
|
10602
|
-
return request(OpenAPI, {
|
|
10603
|
-
method: 'PUT',
|
|
10604
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
|
|
10605
|
-
path: {
|
|
10606
|
-
'id': id,
|
|
10607
|
-
'org': org,
|
|
10608
|
-
'username': username
|
|
10609
|
-
},
|
|
10610
|
-
body: requestBody,
|
|
10611
|
-
mediaType: 'application/json'
|
|
10612
|
-
});
|
|
10613
|
-
}
|
|
10614
|
-
/**
|
|
10615
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
10616
|
-
* @returns TrainingCreate
|
|
10617
|
-
* @throws ApiError
|
|
10618
|
-
*/
|
|
10619
|
-
static aiFinetuningV1OrgUserTrainingsPartialUpdate({
|
|
10620
|
-
id,
|
|
10621
|
-
org,
|
|
10622
|
-
username,
|
|
10623
|
-
requestBody
|
|
10624
|
-
}) {
|
|
10625
|
-
return request(OpenAPI, {
|
|
10626
|
-
method: 'PATCH',
|
|
10627
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
|
|
10628
|
-
path: {
|
|
10629
|
-
'id': id,
|
|
10630
|
-
'org': org,
|
|
10631
|
-
'username': username
|
|
10632
|
-
},
|
|
10633
|
-
body: requestBody,
|
|
10634
|
-
mediaType: 'application/json'
|
|
10635
|
-
});
|
|
10636
|
-
}
|
|
10637
|
-
/**
|
|
10638
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
10639
|
-
* @returns void
|
|
10640
|
-
* @throws ApiError
|
|
10641
|
-
*/
|
|
10642
|
-
static aiFinetuningV1OrgUserTrainingsDestroy({
|
|
10643
|
-
id,
|
|
10644
|
-
org,
|
|
10645
|
-
username
|
|
10646
|
-
}) {
|
|
10647
|
-
return request(OpenAPI, {
|
|
10648
|
-
method: 'DELETE',
|
|
10649
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
|
|
10650
|
-
path: {
|
|
10651
|
-
'id': id,
|
|
10652
|
-
'org': org,
|
|
10653
|
-
'username': username
|
|
10654
|
-
}
|
|
10655
|
-
});
|
|
10656
|
-
}
|
|
10657
|
-
/**
|
|
10658
|
-
* Retrieves a paginated list of completed fine-tuned models, excluding those without a fine-tuned model.
|
|
10659
|
-
* Filtering and pagination is allowed.
|
|
10660
|
-
*
|
|
10661
|
-
* NB: This is only a helper endpoint. The same functionality can be achieved with the appropriate filters using the
|
|
10662
|
-
* training list endpoint.
|
|
10663
|
-
* Returns:
|
|
10664
|
-
* Response: A paginated response containing the serialized fine-tuned models.
|
|
10665
|
-
* @returns Training
|
|
10666
|
-
* @throws ApiError
|
|
10667
|
-
*/
|
|
10668
|
-
static aiFinetuningV1OrgUserTrainingsFinetunedModelsRetrieve({
|
|
10669
|
-
org,
|
|
10670
|
-
username
|
|
10671
|
-
}) {
|
|
10672
|
-
return request(OpenAPI, {
|
|
10673
|
-
method: 'GET',
|
|
10674
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/finetuned-models/',
|
|
10675
|
-
path: {
|
|
10676
|
-
'org': org,
|
|
10677
|
-
'username': username
|
|
10678
|
-
}
|
|
10679
|
-
});
|
|
10680
|
-
}
|
|
10681
|
-
}
|
|
10682
|
-
|
|
10683
|
-
class AiIndexService {
|
|
10684
|
-
/**
|
|
10685
|
-
* Retrieve details of a specific document embedding.
|
|
10686
|
-
*
|
|
10687
|
-
* This endpoint returns detailed information about a specific
|
|
10688
|
-
* document embedding identified by its ID.
|
|
10689
|
-
*
|
|
10690
|
-
* Args:
|
|
10691
|
-
* request: The HTTP request.
|
|
10692
|
-
* org: Organization key identifier.
|
|
10693
|
-
* document_id: The ID of the document embedding to retrieve.
|
|
10694
|
-
*
|
|
10695
|
-
* Returns:
|
|
10696
|
-
* Response: Detailed information about the document embedding.
|
|
10697
|
-
*
|
|
10698
|
-
* Raises:
|
|
10699
|
-
* NotFound: If the specified document embedding does not exist.
|
|
10700
|
-
* @returns RetrieverDocumentEmbedding
|
|
10701
|
-
* @throws ApiError
|
|
10702
|
-
*/
|
|
10703
|
-
static aiIndexOrgsUsersDocumentsRetrieve({
|
|
10704
|
-
documentId,
|
|
10705
|
-
org,
|
|
10706
|
-
userId
|
|
10707
|
-
}) {
|
|
10708
|
-
return request(OpenAPI, {
|
|
10709
|
-
method: 'GET',
|
|
10710
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
|
|
10711
|
-
path: {
|
|
10712
|
-
'document_id': documentId,
|
|
10713
|
-
'org': org,
|
|
10714
|
-
'user_id': userId
|
|
10715
|
-
},
|
|
10716
|
-
errors: {
|
|
10717
|
-
404: `Document not found`
|
|
10718
|
-
}
|
|
10719
|
-
});
|
|
10720
|
-
}
|
|
10721
|
-
/**
|
|
10722
|
-
* Update a specific document embedding.
|
|
10723
|
-
*
|
|
10724
|
-
* This endpoint allows updating various properties of a document embedding,
|
|
10725
|
-
* including its name, type, pathway, and training status.
|
|
10726
|
-
*
|
|
10727
|
-
* Args:
|
|
10728
|
-
* request: The HTTP request containing the updated document data.
|
|
10729
|
-
* org: Organization key identifier.
|
|
10730
|
-
* document_id: The ID of the document embedding to update.
|
|
10731
|
-
*
|
|
10732
|
-
* Returns:
|
|
10733
|
-
* Response: The updated document embedding information.
|
|
10734
|
-
*
|
|
10735
|
-
* Raises:
|
|
10736
|
-
* BadRequest: If the provided data is invalid.
|
|
10737
|
-
* NotFound: If the specified document embedding does not exist.
|
|
10738
|
-
* @returns RetrieverDocumentEmbedding
|
|
10739
|
-
* @throws ApiError
|
|
10740
|
-
*/
|
|
10741
|
-
static aiIndexOrgsUsersDocumentsUpdate({
|
|
10742
|
-
documentId,
|
|
10743
|
-
org,
|
|
10744
|
-
userId,
|
|
10745
|
-
formData
|
|
10746
|
-
}) {
|
|
10747
|
-
return request(OpenAPI, {
|
|
10748
|
-
method: 'PUT',
|
|
10749
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
|
|
10750
|
-
path: {
|
|
10751
|
-
'document_id': documentId,
|
|
10752
|
-
'org': org,
|
|
10753
|
-
'user_id': userId
|
|
10754
|
-
},
|
|
10755
|
-
formData: formData,
|
|
10756
|
-
mediaType: 'multipart/form-data',
|
|
10757
|
-
errors: {
|
|
10758
|
-
400: `Invalid request data`,
|
|
10759
|
-
404: `Document not found`
|
|
10760
|
-
}
|
|
10761
|
-
});
|
|
10762
|
-
}
|
|
10763
|
-
/**
|
|
10764
|
-
* Delete a specific document embedding.
|
|
10765
|
-
*
|
|
10766
|
-
* This endpoint removes a document embedding from the system,
|
|
10767
|
-
* including untraining it from any associated pathways.
|
|
10768
|
-
*
|
|
10769
|
-
* Args:
|
|
10770
|
-
* request: The HTTP request.
|
|
10771
|
-
* org: Organization key identifier.
|
|
10772
|
-
* document_id: The ID of the document embedding to delete.
|
|
10773
|
-
*
|
|
10774
|
-
* Returns:
|
|
10775
|
-
* Response: An empty response with a 204 status code if successful.
|
|
10776
|
-
*
|
|
10777
|
-
* Raises:
|
|
10778
|
-
* NotFound: If the specified document embedding does not exist.
|
|
10779
|
-
* @returns void
|
|
10780
|
-
* @throws ApiError
|
|
10781
|
-
*/
|
|
10782
|
-
static aiIndexOrgsUsersDocumentsDestroy({
|
|
10783
|
-
documentId,
|
|
10784
|
-
org,
|
|
10785
|
-
userId
|
|
10786
|
-
}) {
|
|
10787
|
-
return request(OpenAPI, {
|
|
10788
|
-
method: 'DELETE',
|
|
10789
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
|
|
10790
|
-
path: {
|
|
10791
|
-
'document_id': documentId,
|
|
10792
|
-
'org': org,
|
|
10793
|
-
'user_id': userId
|
|
10794
|
-
},
|
|
10795
|
-
errors: {
|
|
10796
|
-
404: `Document not found`
|
|
10797
|
-
}
|
|
10798
|
-
});
|
|
10799
|
-
}
|
|
10800
|
-
/**
|
|
10801
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
10802
|
-
* @returns DocumentSettingsResponse
|
|
10803
|
-
* @throws ApiError
|
|
10804
|
-
*/
|
|
10805
|
-
static aiIndexOrgsUsersDocumentsSettingsRetrieve({
|
|
10806
|
-
documentId,
|
|
10807
|
-
org,
|
|
10808
|
-
userId
|
|
10809
|
-
}) {
|
|
10810
|
-
return request(OpenAPI, {
|
|
10811
|
-
method: 'GET',
|
|
10812
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/',
|
|
10813
|
-
path: {
|
|
10814
|
-
'document_id': documentId,
|
|
10815
|
-
'org': org,
|
|
10816
|
-
'user_id': userId
|
|
10817
|
-
}
|
|
10818
|
-
});
|
|
10819
|
-
}
|
|
10820
|
-
/**
|
|
10821
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
10822
|
-
* @returns DocumentSettingsResponse
|
|
10823
|
-
* @throws ApiError
|
|
10824
|
-
*/
|
|
10825
|
-
static aiIndexOrgsUsersDocumentsSettingsCreate({
|
|
10826
|
-
documentId,
|
|
10827
|
-
org,
|
|
10828
|
-
userId,
|
|
10829
|
-
requestBody
|
|
10830
|
-
}) {
|
|
10831
|
-
return request(OpenAPI, {
|
|
10832
|
-
method: 'POST',
|
|
10833
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/',
|
|
10834
|
-
path: {
|
|
10835
|
-
'document_id': documentId,
|
|
10836
|
-
'org': org,
|
|
10837
|
-
'user_id': userId
|
|
10838
|
-
},
|
|
10839
|
-
body: requestBody,
|
|
10840
|
-
mediaType: 'application/json'
|
|
10841
|
-
});
|
|
10842
|
-
}
|
|
10843
|
-
/**
|
|
10844
|
-
* Description:
|
|
10845
|
-
* Retrieves a list of document embeddings for a specific pathway with optional search and pagination.
|
|
10846
|
-
*
|
|
10847
|
-
* Methods:
|
|
10848
|
-
* - GET: Retrieves document embeddings that match the specified search criteria and are paginated according to offset and limit.
|
|
10849
|
-
*
|
|
10850
|
-
* Parameters:
|
|
10851
|
-
* - search (str): Search query to filter document names or URLs.
|
|
10852
|
-
* - offset (int): Offset number for pagination.
|
|
10853
|
-
* - limit (int): Limit number for pagination.
|
|
10854
|
-
*
|
|
10855
|
-
* Returns:
|
|
10856
|
-
* - GET: A paginated list of document embeddings with their details.
|
|
10857
|
-
* {
|
|
10858
|
-
* "count": 10,
|
|
10859
|
-
* "next": "http://api.example.com/retriever_documents/?offset=10&limit=2",
|
|
10860
|
-
* "previous": "http://api.example.com/retriever_documents/?offset=0&limit=2",
|
|
10861
|
-
* "results": [
|
|
10862
|
-
* {
|
|
10863
|
-
* "document_name": "Document2",
|
|
10864
|
-
* "platform_key": "example_platform",
|
|
10865
|
-
* "pathway": "example_pathway"
|
|
10866
|
-
* }
|
|
10867
|
-
* ]
|
|
10868
|
-
* }
|
|
10869
|
-
*
|
|
10870
|
-
* Error Responses:
|
|
10871
|
-
* - 400 Bad Request: Invalid query parameters.
|
|
10872
|
-
* - 404 Not Found: No document embeddings found for the specified criteria.
|
|
10873
|
-
* @returns PaginatedRetrieverDocumentEmbeddingList
|
|
10874
|
-
* @throws ApiError
|
|
10875
|
-
*/
|
|
10876
|
-
static aiIndexOrgsUsersDocumentsPathwaysList({
|
|
10877
|
-
org,
|
|
10878
|
-
pathway,
|
|
10879
|
-
userId,
|
|
10880
|
-
limit,
|
|
10881
|
-
offset,
|
|
10882
|
-
search
|
|
10883
|
-
}) {
|
|
10884
|
-
return request(OpenAPI, {
|
|
10885
|
-
method: 'GET',
|
|
10886
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/pathways/{pathway}/',
|
|
10887
|
-
path: {
|
|
10888
|
-
'org': org,
|
|
10889
|
-
'pathway': pathway,
|
|
10890
|
-
'user_id': userId
|
|
10891
|
-
},
|
|
10892
|
-
query: {
|
|
10893
|
-
'limit': limit,
|
|
10894
|
-
'offset': offset,
|
|
10895
|
-
'search': search
|
|
10896
|
-
}
|
|
10897
|
-
});
|
|
10898
|
-
}
|
|
10899
|
-
/**
|
|
10900
|
-
* Retrieve resource documents similar to the given query.
|
|
10901
|
-
*
|
|
10902
|
-
* This endpoint performs a semantic search to find documents that are
|
|
10903
|
-
* relevant to the provided query within the specified pathway.
|
|
10904
|
-
*
|
|
10905
|
-
* Args:
|
|
10906
|
-
* request: The HTTP request containing the search query.
|
|
10907
|
-
* org: Organization key identifier.
|
|
10908
|
-
*
|
|
10909
|
-
* Returns:
|
|
10910
|
-
* Response: A list of documents relevant to the search query.
|
|
10911
|
-
*
|
|
10912
|
-
* Raises:
|
|
10913
|
-
* ValidationError: If the request data is invalid.
|
|
10914
|
-
* @returns RetrieverResponseSearch
|
|
10915
|
-
* @throws ApiError
|
|
10916
|
-
*/
|
|
10917
|
-
static aiIndexOrgsUsersDocumentsSearchCreate({
|
|
10918
|
-
org,
|
|
10919
|
-
userId,
|
|
10920
|
-
requestBody
|
|
10921
|
-
}) {
|
|
10922
|
-
return request(OpenAPI, {
|
|
10923
|
-
method: 'POST',
|
|
10924
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/search/',
|
|
10925
|
-
path: {
|
|
10926
|
-
'org': org,
|
|
10927
|
-
'user_id': userId
|
|
10928
|
-
},
|
|
10929
|
-
body: requestBody,
|
|
10930
|
-
mediaType: 'application/json',
|
|
10931
|
-
errors: {
|
|
10932
|
-
400: `Invalid request data`
|
|
10933
|
-
}
|
|
10934
|
-
});
|
|
10935
|
-
}
|
|
10936
|
-
/**
|
|
10937
|
-
* Retrieve document sources related to a given query.
|
|
10938
|
-
*
|
|
10939
|
-
* This endpoint performs a semantic search to find document sources
|
|
10940
|
-
* that are relevant to the provided query within the specified pathway,
|
|
10941
|
-
* and returns them along with confidence levels.
|
|
10942
|
-
*
|
|
10943
|
-
* Args:
|
|
10944
|
-
* request: The HTTP request containing the search query.
|
|
10945
|
-
* org: Organization key identifier.
|
|
10946
|
-
*
|
|
10947
|
-
* Returns:
|
|
10948
|
-
* Response: A list of document sources with confidence levels.
|
|
10949
|
-
*
|
|
10950
|
-
* Raises:
|
|
10951
|
-
* ValidationError: If the request data is invalid.
|
|
10952
|
-
* @returns RetrieverRequestSearchDocument
|
|
10953
|
-
* @throws ApiError
|
|
10954
|
-
*/
|
|
10955
|
-
static aiIndexOrgsUsersDocumentsSourcesCreate({
|
|
10956
|
-
org,
|
|
10957
|
-
userId,
|
|
10958
|
-
requestBody
|
|
10959
|
-
}) {
|
|
10960
|
-
return request(OpenAPI, {
|
|
10961
|
-
method: 'POST',
|
|
10962
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/sources/',
|
|
10963
|
-
path: {
|
|
10964
|
-
'org': org,
|
|
10965
|
-
'user_id': userId
|
|
10966
|
-
},
|
|
10967
|
-
body: requestBody,
|
|
10968
|
-
mediaType: 'application/json',
|
|
10969
|
-
errors: {
|
|
10970
|
-
400: `Invalid request data`
|
|
10971
|
-
}
|
|
10972
|
-
});
|
|
10973
|
-
}
|
|
10974
|
-
/**
|
|
10975
|
-
* Check the status of a document training task.
|
|
10976
|
-
*
|
|
10977
|
-
* This endpoint retrieves the current status of an asynchronous
|
|
10978
|
-
* document training task that was previously initiated.
|
|
10979
|
-
*
|
|
10980
|
-
* Args:
|
|
10981
|
-
* request: The HTTP request.
|
|
10982
|
-
* org: Organization key identifier.
|
|
10983
|
-
* task_id: The ID of the training task to check.
|
|
10984
|
-
*
|
|
10985
|
-
* Returns:
|
|
10986
|
-
* Response: The current status of the document training task,
|
|
10987
|
-
* which can be "pending", "completed", or "failed".
|
|
10988
|
-
* @returns CheckDocumentTrainingStatus
|
|
10989
|
-
* @throws ApiError
|
|
10990
|
-
*/
|
|
10991
|
-
static aiIndexOrgsUsersDocumentsTasksRetrieve({
|
|
10992
|
-
org,
|
|
10993
|
-
taskId,
|
|
10994
|
-
userId
|
|
10995
|
-
}) {
|
|
10996
|
-
return request(OpenAPI, {
|
|
10997
|
-
method: 'GET',
|
|
10998
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/tasks/{task_id}/',
|
|
10999
|
-
path: {
|
|
11000
|
-
'org': org,
|
|
11001
|
-
'task_id': taskId,
|
|
11002
|
-
'user_id': userId
|
|
11003
|
-
}
|
|
11004
|
-
});
|
|
11005
|
-
}
|
|
11006
|
-
/**
|
|
11007
|
-
* Train a document through a worker process.
|
|
11008
|
-
*
|
|
11009
|
-
* This endpoint queues larger documents for training through a worker
|
|
11010
|
-
* process, which is more suitable for handling documents that would
|
|
11011
|
-
* take too long to process directly.
|
|
11012
|
-
*
|
|
11013
|
-
* Args:
|
|
11014
|
-
* request: The HTTP request containing the document information.
|
|
11015
|
-
* org: Organization key identifier.
|
|
11016
|
-
*
|
|
11017
|
-
* Returns:
|
|
11018
|
-
* Response: A confirmation that the document was queued for training,
|
|
11019
|
-
* including a task ID for tracking the progress.
|
|
11020
|
-
*
|
|
11021
|
-
* Raises:
|
|
11022
|
-
* ValidationError: If the request data is invalid.
|
|
11023
|
-
* BadRequest: If there was an error processing the document.
|
|
11024
|
-
* @returns TrainDocumentViewResponse
|
|
11025
|
-
* @throws ApiError
|
|
11026
|
-
*/
|
|
11027
|
-
static aiIndexOrgsUsersDocumentsTrainCreate({
|
|
11028
|
-
org,
|
|
11029
|
-
userId,
|
|
11030
|
-
formData
|
|
11031
|
-
}) {
|
|
11032
|
-
return request(OpenAPI, {
|
|
11033
|
-
method: 'POST',
|
|
11034
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/train/',
|
|
11035
|
-
path: {
|
|
11036
|
-
'org': org,
|
|
11037
|
-
'user_id': userId
|
|
11038
|
-
},
|
|
11039
|
-
formData: formData,
|
|
11040
|
-
mediaType: 'multipart/form-data',
|
|
11041
|
-
errors: {
|
|
11042
|
-
400: `Invalid request data`
|
|
11043
|
-
}
|
|
11044
|
-
});
|
|
11045
|
-
}
|
|
11046
|
-
/**
|
|
11047
|
-
* Train a document directly without using a worker.
|
|
11048
|
-
*
|
|
11049
|
-
* This endpoint is designed for training smaller documents directly
|
|
11050
|
-
* without queuing them through a worker process. For larger documents,
|
|
11051
|
-
* use the TrainDocumentView endpoint instead.
|
|
11052
|
-
*
|
|
11053
|
-
* Args:
|
|
11054
|
-
* request: The HTTP request containing the document information.
|
|
11055
|
-
* org: Organization key identifier.
|
|
11056
|
-
*
|
|
11057
|
-
* Returns:
|
|
11058
|
-
* Response: A confirmation that the document was trained successfully.
|
|
11059
|
-
*
|
|
11060
|
-
* Raises:
|
|
11061
|
-
* ValidationError: If the request data is invalid.
|
|
11062
|
-
* BadRequest: If the document training failed.
|
|
11063
|
-
* @returns RetreiverTrainViewResponse
|
|
11064
|
-
* @throws ApiError
|
|
11065
|
-
*/
|
|
11066
|
-
static aiIndexOrgsUsersDocumentsTrainRetrieverCreate({
|
|
11067
|
-
org,
|
|
11068
|
-
userId,
|
|
11069
|
-
formData
|
|
11070
|
-
}) {
|
|
11071
|
-
return request(OpenAPI, {
|
|
11072
|
-
method: 'POST',
|
|
11073
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/train/retriever/',
|
|
11074
|
-
path: {
|
|
11075
|
-
'org': org,
|
|
11076
|
-
'user_id': userId
|
|
11077
|
-
},
|
|
11078
|
-
formData: formData,
|
|
11079
|
-
mediaType: 'multipart/form-data',
|
|
11080
|
-
errors: {
|
|
11081
|
-
400: `Invalid request data or training failed`
|
|
11082
|
-
}
|
|
9755
|
+
formData: formData,
|
|
9756
|
+
mediaType: 'multipart/form-data',
|
|
9757
|
+
errors: {
|
|
9758
|
+
400: `Invalid request data or training failed`
|
|
9759
|
+
}
|
|
11083
9760
|
});
|
|
11084
9761
|
}
|
|
11085
9762
|
/**
|
|
@@ -16066,7 +14743,9 @@ class AiMentorService {
|
|
|
16066
14743
|
static aiMentorOrgsUsersMentorsAvailableToolsList({
|
|
16067
14744
|
mentor,
|
|
16068
14745
|
org,
|
|
16069
|
-
userId
|
|
14746
|
+
userId,
|
|
14747
|
+
ordering,
|
|
14748
|
+
search
|
|
16070
14749
|
}) {
|
|
16071
14750
|
return request(OpenAPI, {
|
|
16072
14751
|
method: 'GET',
|
|
@@ -16075,6 +14754,10 @@ class AiMentorService {
|
|
|
16075
14754
|
'mentor': mentor,
|
|
16076
14755
|
'org': org,
|
|
16077
14756
|
'user_id': userId
|
|
14757
|
+
},
|
|
14758
|
+
query: {
|
|
14759
|
+
'ordering': ordering,
|
|
14760
|
+
'search': search
|
|
16078
14761
|
}
|
|
16079
14762
|
});
|
|
16080
14763
|
}
|
|
@@ -19400,6 +18083,24 @@ class AiMentorService {
|
|
|
19400
18083
|
mediaType: 'application/json'
|
|
19401
18084
|
});
|
|
19402
18085
|
}
|
|
18086
|
+
/**
|
|
18087
|
+
* Retrieve Tool Categories
|
|
18088
|
+
* @returns ToolCategory
|
|
18089
|
+
* @throws ApiError
|
|
18090
|
+
*/
|
|
18091
|
+
static aiMentorOrgsUsersToolCategoriesList({
|
|
18092
|
+
org,
|
|
18093
|
+
userId
|
|
18094
|
+
}) {
|
|
18095
|
+
return request(OpenAPI, {
|
|
18096
|
+
method: 'GET',
|
|
18097
|
+
url: '/api/ai-mentor/orgs/{org}/users/{user_id}/tool-categories/',
|
|
18098
|
+
path: {
|
|
18099
|
+
'org': org,
|
|
18100
|
+
'user_id': userId
|
|
18101
|
+
}
|
|
18102
|
+
});
|
|
18103
|
+
}
|
|
19403
18104
|
/**
|
|
19404
18105
|
* Retrieve a list of available voice options.
|
|
19405
18106
|
*
|
|
@@ -35984,5 +34685,5 @@ class SkillsService {
|
|
|
35984
34685
|
}
|
|
35985
34686
|
}
|
|
35986
34687
|
|
|
35987
|
-
export { AcceptanceEnum, AccessEnum, AiAccountService, AiAnalyticsService,
|
|
34688
|
+
export { AcceptanceEnum, AccessEnum, AiAccountService, AiAnalyticsService, AiIndexService, AiMarketingService, AiMediaService, AiMentorService, AiPromptService, AlignMentorBubbleEnum, ApiError, BlankEnum, CallConfigurationModeEnum, CancelError, CancelablePromise, CareerService, CatalogService, CeleryHeartbeatFailStatusEnum, CeleryHeartbeatStatusEnum, CommerceService, ComponentBlockTypeEnum, ConnectedServiceProviderEnum, CoreService, CourseCreationTaskStatusEnum, CrawlerPatternTypeEnum, CredentialsService, CustomDomainsService, FeaturesService, GooglePayAccountResponseStatusEnum, GreetingMethodEnum, HumanSupportTicketStatusEnum, InstitutionTypeEnum, ItemTypeEnum, KindEnum, LlmProviderEnum, MediaService, MediaTypeEnum, MentorVisibilityEnum, NotificationSourceTypeEnum, NotificationStatusEnum, NotificationsService, OpenAPI, PeriodicAgentLogStatusEnum, PlatformListStatusEnum, PreviousAgentStatusEnum, ProgramTypeEnum, PromptVisibilityEnum, Provider637Enum, RatingEnum, RecommendationsService, ReportsService, ResourceScrappedDataStatusEnum, ScimService, SearchService, ServiceEnum, SkillsService, StateEnum, Status6eeEnum, StepStatusEnum, StripeCheckoutSessionRequestModeEnum, SttProviderEnum, TargetSystemEnum, ThemeEnum, TrainingStatusEnum, TransportEnum, TtsProviderEnum, TypeC42Enum };
|
|
35988
34689
|
//# sourceMappingURL=index.esm.js.map
|