@iblai/iblai-api 3.45.8-ai-plus → 3.45.9-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 +536 -1984
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +537 -1983
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +536 -1984
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +11 -41
- package/dist/types/models/CatalogAutoIncrementResponse.d.ts +11 -11
- package/dist/types/models/CourseReviewPaginatedResponse.d.ts +18 -0
- package/dist/types/models/CourseReviewRequest.d.ts +37 -0
- package/dist/types/models/CourseReviewResponse.d.ts +40 -0
- package/dist/types/models/PaginatedSkill.d.ts +7 -0
- package/dist/types/models/ProgramEnrollmentSearchResponse.d.ts +22 -0
- package/dist/types/models/ProgramMetadataRequest.d.ts +29 -0
- package/dist/types/models/ProgramMetadataResponse.d.ts +29 -0
- package/dist/types/models/ProgramReview.d.ts +41 -0
- package/dist/types/models/ProgramReviewPaginatedResponse.d.ts +22 -0
- package/dist/types/models/ProgramReviewRequest.d.ts +37 -0
- 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/CatalogService.d.ts +168 -458
- package/package.json +1 -1
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +11 -41
- package/src/models/CatalogAutoIncrementResponse.ts +11 -11
- package/src/models/CourseReviewPaginatedResponse.ts +23 -0
- package/src/models/CourseReviewRequest.ts +42 -0
- package/src/models/CourseReviewResponse.ts +45 -0
- package/src/models/PaginatedSkill.ts +12 -0
- package/src/models/ProgramEnrollmentSearchResponse.ts +27 -0
- package/src/models/ProgramMetadataRequest.ts +34 -0
- package/src/models/ProgramMetadataResponse.ts +34 -0
- package/src/models/ProgramReview.ts +46 -0
- package/src/models/ProgramReviewPaginatedResponse.ts +27 -0
- package/src/models/ProgramReviewRequest.ts +42 -0
- package/src/models/{VoiceProviderEnum.ts → ProviderEnum.ts} +1 -1
- package/src/models/Voice.ts +2 -2
- package/src/services/CatalogService.ts +3415 -3417
- 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/CourseEligibilityCheckResponse.d.ts +0 -25
- 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/CourseEligibilityCheckResponse.ts +0 -30
- 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
package/dist/index.cjs.js
CHANGED
|
@@ -110,7 +110,7 @@ class CancelablePromise {
|
|
|
110
110
|
|
|
111
111
|
const OpenAPI = {
|
|
112
112
|
BASE: 'https://base.manager.iblai.app',
|
|
113
|
-
VERSION: '3.45.
|
|
113
|
+
VERSION: '3.45.9-ai',
|
|
114
114
|
WITH_CREDENTIALS: false,
|
|
115
115
|
CREDENTIALS: 'include',
|
|
116
116
|
TOKEN: undefined,
|
|
@@ -231,24 +231,6 @@ exports.CourseCreationTaskStatusEnum = void 0;
|
|
|
231
231
|
CourseCreationTaskStatusEnum["IN_PROGRESS"] = "In Progress";
|
|
232
232
|
})(exports.CourseCreationTaskStatusEnum || (exports.CourseCreationTaskStatusEnum = {}));
|
|
233
233
|
|
|
234
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
235
|
-
/* istanbul ignore file */
|
|
236
|
-
/* tslint:disable */
|
|
237
|
-
/* eslint-disable */
|
|
238
|
-
/**
|
|
239
|
-
* * `pending` - Pending
|
|
240
|
-
* * `processing` - Processing
|
|
241
|
-
* * `completed` - Completed
|
|
242
|
-
* * `failed` - Failed
|
|
243
|
-
*/
|
|
244
|
-
exports.DataSetStatusEnum = void 0;
|
|
245
|
-
(function (DataSetStatusEnum) {
|
|
246
|
-
DataSetStatusEnum["PENDING"] = "pending";
|
|
247
|
-
DataSetStatusEnum["PROCESSING"] = "processing";
|
|
248
|
-
DataSetStatusEnum["COMPLETED"] = "completed";
|
|
249
|
-
DataSetStatusEnum["FAILED"] = "failed";
|
|
250
|
-
})(exports.DataSetStatusEnum || (exports.DataSetStatusEnum = {}));
|
|
251
|
-
|
|
252
234
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
253
235
|
/* istanbul ignore file */
|
|
254
236
|
/* tslint:disable */
|
|
@@ -531,37 +513,21 @@ exports.PromptVisibilityEnum = void 0;
|
|
|
531
513
|
PromptVisibilityEnum["VIEWABLE_BY_ANYONE"] = "viewable_by_anyone";
|
|
532
514
|
})(exports.PromptVisibilityEnum || (exports.PromptVisibilityEnum = {}));
|
|
533
515
|
|
|
534
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
535
|
-
/* istanbul ignore file */
|
|
536
|
-
/* tslint:disable */
|
|
537
|
-
/* eslint-disable */
|
|
538
|
-
/**
|
|
539
|
-
* * `webex` - Webex
|
|
540
|
-
* * `slack` - Slack
|
|
541
|
-
* * `whatsapp` - Whatsapp
|
|
542
|
-
* * `discord` - Discord
|
|
543
|
-
* * `teams` - Teams
|
|
544
|
-
*/
|
|
545
|
-
exports.Provider05cEnum = void 0;
|
|
546
|
-
(function (Provider05cEnum) {
|
|
547
|
-
Provider05cEnum["WEBEX"] = "webex";
|
|
548
|
-
Provider05cEnum["SLACK"] = "slack";
|
|
549
|
-
Provider05cEnum["WHATSAPP"] = "whatsapp";
|
|
550
|
-
Provider05cEnum["DISCORD"] = "discord";
|
|
551
|
-
Provider05cEnum["TEAMS"] = "teams";
|
|
552
|
-
})(exports.Provider05cEnum || (exports.Provider05cEnum = {}));
|
|
553
|
-
|
|
554
516
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
555
517
|
/* istanbul ignore file */
|
|
556
518
|
/* tslint:disable */
|
|
557
519
|
/* eslint-disable */
|
|
558
520
|
/**
|
|
559
521
|
* * `openai` - Openai
|
|
522
|
+
* * `google` - Google
|
|
523
|
+
* * `elevenlabs` - Elevenlabs
|
|
560
524
|
*/
|
|
561
|
-
exports.
|
|
562
|
-
(function (
|
|
563
|
-
|
|
564
|
-
|
|
525
|
+
exports.ProviderEnum = void 0;
|
|
526
|
+
(function (ProviderEnum) {
|
|
527
|
+
ProviderEnum["OPENAI"] = "openai";
|
|
528
|
+
ProviderEnum["GOOGLE"] = "google";
|
|
529
|
+
ProviderEnum["ELEVENLABS"] = "elevenlabs";
|
|
530
|
+
})(exports.ProviderEnum || (exports.ProviderEnum = {}));
|
|
565
531
|
|
|
566
532
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
567
533
|
/* istanbul ignore file */
|
|
@@ -731,22 +697,6 @@ exports.TypeC42Enum = void 0;
|
|
|
731
697
|
TypeC42Enum["ASSESSMENT"] = "assessment";
|
|
732
698
|
})(exports.TypeC42Enum || (exports.TypeC42Enum = {}));
|
|
733
699
|
|
|
734
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
735
|
-
/* istanbul ignore file */
|
|
736
|
-
/* tslint:disable */
|
|
737
|
-
/* eslint-disable */
|
|
738
|
-
/**
|
|
739
|
-
* * `openai` - Openai
|
|
740
|
-
* * `google` - Google
|
|
741
|
-
* * `elevenlabs` - Elevenlabs
|
|
742
|
-
*/
|
|
743
|
-
exports.VoiceProviderEnum = void 0;
|
|
744
|
-
(function (VoiceProviderEnum) {
|
|
745
|
-
VoiceProviderEnum["OPENAI"] = "openai";
|
|
746
|
-
VoiceProviderEnum["GOOGLE"] = "google";
|
|
747
|
-
VoiceProviderEnum["ELEVENLABS"] = "elevenlabs";
|
|
748
|
-
})(exports.VoiceProviderEnum || (exports.VoiceProviderEnum = {}));
|
|
749
|
-
|
|
750
700
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
751
701
|
/* istanbul ignore file */
|
|
752
702
|
/* tslint:disable */
|
|
@@ -5790,1541 +5740,257 @@ class AiAnalyticsService {
|
|
|
5790
5740
|
}
|
|
5791
5741
|
}
|
|
5792
5742
|
|
|
5793
|
-
class
|
|
5743
|
+
class AiIndexService {
|
|
5794
5744
|
/**
|
|
5795
|
-
*
|
|
5745
|
+
* Retrieve details of a specific document embedding.
|
|
5746
|
+
*
|
|
5747
|
+
* This endpoint returns detailed information about a specific
|
|
5748
|
+
* document embedding identified by its ID.
|
|
5749
|
+
*
|
|
5750
|
+
* Args:
|
|
5751
|
+
* request: The HTTP request.
|
|
5752
|
+
* org: Organization key identifier.
|
|
5753
|
+
* document_id: The ID of the document embedding to retrieve.
|
|
5754
|
+
*
|
|
5755
|
+
* Returns:
|
|
5756
|
+
* Response: Detailed information about the document embedding.
|
|
5757
|
+
*
|
|
5758
|
+
* Raises:
|
|
5759
|
+
* NotFound: If the specified document embedding does not exist.
|
|
5760
|
+
* @param documentId
|
|
5796
5761
|
* @param org
|
|
5797
|
-
* @
|
|
5762
|
+
* @param userId
|
|
5763
|
+
* @returns RetrieverDocumentEmbedding
|
|
5798
5764
|
* @throws ApiError
|
|
5799
5765
|
*/
|
|
5800
|
-
static
|
|
5766
|
+
static aiIndexOrgsUsersDocumentsRetrieve(documentId, org, userId) {
|
|
5801
5767
|
return request(OpenAPI, {
|
|
5802
5768
|
method: 'GET',
|
|
5803
|
-
url: '/api/ai-
|
|
5769
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
|
|
5804
5770
|
path: {
|
|
5805
|
-
'
|
|
5771
|
+
'document_id': documentId,
|
|
5772
|
+
'org': org,
|
|
5773
|
+
'user_id': userId
|
|
5774
|
+
},
|
|
5775
|
+
errors: {
|
|
5776
|
+
404: `Document not found`
|
|
5806
5777
|
}
|
|
5807
5778
|
});
|
|
5808
5779
|
}
|
|
5809
5780
|
/**
|
|
5810
|
-
*
|
|
5781
|
+
* Update a specific document embedding.
|
|
5782
|
+
*
|
|
5783
|
+
* This endpoint allows updating various properties of a document embedding,
|
|
5784
|
+
* including its name, type, pathway, and training status.
|
|
5785
|
+
*
|
|
5786
|
+
* Args:
|
|
5787
|
+
* request: The HTTP request containing the updated document data.
|
|
5788
|
+
* org: Organization key identifier.
|
|
5789
|
+
* document_id: The ID of the document embedding to update.
|
|
5790
|
+
*
|
|
5791
|
+
* Returns:
|
|
5792
|
+
* Response: The updated document embedding information.
|
|
5793
|
+
*
|
|
5794
|
+
* Raises:
|
|
5795
|
+
* BadRequest: If the provided data is invalid.
|
|
5796
|
+
* NotFound: If the specified document embedding does not exist.
|
|
5797
|
+
* @param documentId
|
|
5811
5798
|
* @param org
|
|
5812
|
-
* @param
|
|
5813
|
-
* @
|
|
5799
|
+
* @param userId
|
|
5800
|
+
* @param formData
|
|
5801
|
+
* @returns RetrieverDocumentEmbedding
|
|
5814
5802
|
* @throws ApiError
|
|
5815
5803
|
*/
|
|
5816
|
-
static
|
|
5804
|
+
static aiIndexOrgsUsersDocumentsUpdate(documentId, org, userId, formData) {
|
|
5817
5805
|
return request(OpenAPI, {
|
|
5818
|
-
method: '
|
|
5819
|
-
url: '/api/ai-
|
|
5806
|
+
method: 'PUT',
|
|
5807
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
|
|
5820
5808
|
path: {
|
|
5821
|
-
'
|
|
5809
|
+
'document_id': documentId,
|
|
5810
|
+
'org': org,
|
|
5811
|
+
'user_id': userId
|
|
5822
5812
|
},
|
|
5823
|
-
|
|
5824
|
-
mediaType: '
|
|
5825
|
-
|
|
5826
|
-
|
|
5827
|
-
|
|
5828
|
-
* Create slash commands for a specific bot
|
|
5829
|
-
* eg. /iblai-baseline
|
|
5830
|
-
* @param org
|
|
5831
|
-
* @returns BotCommand
|
|
5832
|
-
* @throws ApiError
|
|
5833
|
-
*/
|
|
5834
|
-
static aiBotV1BotsBotCommandsList(org) {
|
|
5835
|
-
return request(OpenAPI, {
|
|
5836
|
-
method: 'GET',
|
|
5837
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/',
|
|
5838
|
-
path: {
|
|
5839
|
-
'org': org
|
|
5813
|
+
formData: formData,
|
|
5814
|
+
mediaType: 'multipart/form-data',
|
|
5815
|
+
errors: {
|
|
5816
|
+
400: `Invalid request data`,
|
|
5817
|
+
404: `Document not found`
|
|
5840
5818
|
}
|
|
5841
5819
|
});
|
|
5842
5820
|
}
|
|
5843
5821
|
/**
|
|
5844
|
-
*
|
|
5845
|
-
*
|
|
5822
|
+
* Delete a specific document embedding.
|
|
5823
|
+
*
|
|
5824
|
+
* This endpoint removes a document embedding from the system,
|
|
5825
|
+
* including untraining it from any associated pathways.
|
|
5826
|
+
*
|
|
5827
|
+
* Args:
|
|
5828
|
+
* request: The HTTP request.
|
|
5829
|
+
* org: Organization key identifier.
|
|
5830
|
+
* document_id: The ID of the document embedding to delete.
|
|
5831
|
+
*
|
|
5832
|
+
* Returns:
|
|
5833
|
+
* Response: An empty response with a 204 status code if successful.
|
|
5834
|
+
*
|
|
5835
|
+
* Raises:
|
|
5836
|
+
* NotFound: If the specified document embedding does not exist.
|
|
5837
|
+
* @param documentId
|
|
5846
5838
|
* @param org
|
|
5847
|
-
* @param
|
|
5848
|
-
* @returns
|
|
5839
|
+
* @param userId
|
|
5840
|
+
* @returns void
|
|
5849
5841
|
* @throws ApiError
|
|
5850
5842
|
*/
|
|
5851
|
-
static
|
|
5843
|
+
static aiIndexOrgsUsersDocumentsDestroy(documentId, org, userId) {
|
|
5852
5844
|
return request(OpenAPI, {
|
|
5853
|
-
method: '
|
|
5854
|
-
url: '/api/ai-
|
|
5845
|
+
method: 'DELETE',
|
|
5846
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
|
|
5855
5847
|
path: {
|
|
5856
|
-
'
|
|
5848
|
+
'document_id': documentId,
|
|
5849
|
+
'org': org,
|
|
5850
|
+
'user_id': userId
|
|
5857
5851
|
},
|
|
5858
|
-
|
|
5859
|
-
|
|
5852
|
+
errors: {
|
|
5853
|
+
404: `Document not found`
|
|
5854
|
+
}
|
|
5860
5855
|
});
|
|
5861
5856
|
}
|
|
5862
5857
|
/**
|
|
5863
|
-
*
|
|
5864
|
-
*
|
|
5865
|
-
* @param id A unique integer value identifying this bot command.
|
|
5858
|
+
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
5859
|
+
* @param documentId
|
|
5866
5860
|
* @param org
|
|
5867
|
-
* @
|
|
5861
|
+
* @param userId
|
|
5862
|
+
* @returns DocumentSettingsResponse
|
|
5868
5863
|
* @throws ApiError
|
|
5869
5864
|
*/
|
|
5870
|
-
static
|
|
5865
|
+
static aiIndexOrgsUsersDocumentsSettingsRetrieve(documentId, org, userId) {
|
|
5871
5866
|
return request(OpenAPI, {
|
|
5872
5867
|
method: 'GET',
|
|
5873
|
-
url: '/api/ai-
|
|
5868
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/',
|
|
5874
5869
|
path: {
|
|
5875
|
-
'
|
|
5876
|
-
'org': org
|
|
5870
|
+
'document_id': documentId,
|
|
5871
|
+
'org': org,
|
|
5872
|
+
'user_id': userId
|
|
5877
5873
|
}
|
|
5878
5874
|
});
|
|
5879
5875
|
}
|
|
5880
5876
|
/**
|
|
5881
|
-
*
|
|
5882
|
-
*
|
|
5883
|
-
* @param id A unique integer value identifying this bot command.
|
|
5877
|
+
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
5878
|
+
* @param documentId
|
|
5884
5879
|
* @param org
|
|
5880
|
+
* @param userId
|
|
5885
5881
|
* @param requestBody
|
|
5886
|
-
* @returns
|
|
5882
|
+
* @returns DocumentSettingsResponse
|
|
5887
5883
|
* @throws ApiError
|
|
5888
5884
|
*/
|
|
5889
|
-
static
|
|
5885
|
+
static aiIndexOrgsUsersDocumentsSettingsCreate(documentId, org, userId, requestBody) {
|
|
5890
5886
|
return request(OpenAPI, {
|
|
5891
|
-
method: '
|
|
5892
|
-
url: '/api/ai-
|
|
5887
|
+
method: 'POST',
|
|
5888
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/',
|
|
5893
5889
|
path: {
|
|
5894
|
-
'
|
|
5895
|
-
'org': org
|
|
5890
|
+
'document_id': documentId,
|
|
5891
|
+
'org': org,
|
|
5892
|
+
'user_id': userId
|
|
5896
5893
|
},
|
|
5897
5894
|
body: requestBody,
|
|
5898
5895
|
mediaType: 'application/json'
|
|
5899
5896
|
});
|
|
5900
5897
|
}
|
|
5901
5898
|
/**
|
|
5902
|
-
*
|
|
5903
|
-
*
|
|
5904
|
-
*
|
|
5899
|
+
* Train a graph-based document through a worker process.
|
|
5900
|
+
*
|
|
5901
|
+
* This endpoint queues graph-based documents for training through a
|
|
5902
|
+
* specialized worker process that handles knowledge graph processing.
|
|
5903
|
+
*
|
|
5904
|
+
* Args:
|
|
5905
|
+
* request: The HTTP request containing the document information.
|
|
5906
|
+
* org: Organization key identifier.
|
|
5907
|
+
*
|
|
5908
|
+
* Returns:
|
|
5909
|
+
* Response: A confirmation that the document was queued for training,
|
|
5910
|
+
* including a task ID for tracking the progress.
|
|
5911
|
+
*
|
|
5912
|
+
* Raises:
|
|
5913
|
+
* ValidationError: If the request data is invalid.
|
|
5914
|
+
* BadRequest: If there was an error processing the document.
|
|
5905
5915
|
* @param org
|
|
5906
|
-
* @param
|
|
5907
|
-
* @
|
|
5916
|
+
* @param userId
|
|
5917
|
+
* @param formData
|
|
5918
|
+
* @returns TrainDocumentViewResponse
|
|
5908
5919
|
* @throws ApiError
|
|
5909
5920
|
*/
|
|
5910
|
-
static
|
|
5921
|
+
static aiIndexOrgsUsersDocumentsGraphTrainCreate(org, userId, formData) {
|
|
5911
5922
|
return request(OpenAPI, {
|
|
5912
|
-
method: '
|
|
5913
|
-
url: '/api/ai-
|
|
5923
|
+
method: 'POST',
|
|
5924
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/graph-train/',
|
|
5914
5925
|
path: {
|
|
5915
|
-
'
|
|
5916
|
-
'
|
|
5926
|
+
'org': org,
|
|
5927
|
+
'user_id': userId
|
|
5917
5928
|
},
|
|
5918
|
-
|
|
5919
|
-
mediaType: '
|
|
5920
|
-
|
|
5921
|
-
|
|
5922
|
-
/**
|
|
5923
|
-
* Create slash commands for a specific bot
|
|
5924
|
-
* eg. /iblai-baseline
|
|
5925
|
-
* @param id A unique integer value identifying this bot command.
|
|
5926
|
-
* @param org
|
|
5927
|
-
* @returns void
|
|
5928
|
-
* @throws ApiError
|
|
5929
|
-
*/
|
|
5930
|
-
static aiBotV1BotsBotCommandsDestroy(id, org) {
|
|
5931
|
-
return request(OpenAPI, {
|
|
5932
|
-
method: 'DELETE',
|
|
5933
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
|
|
5934
|
-
path: {
|
|
5935
|
-
'id': id,
|
|
5936
|
-
'org': org
|
|
5929
|
+
formData: formData,
|
|
5930
|
+
mediaType: 'multipart/form-data',
|
|
5931
|
+
errors: {
|
|
5932
|
+
400: `Invalid request data or document processing error`
|
|
5937
5933
|
}
|
|
5938
5934
|
});
|
|
5939
5935
|
}
|
|
5940
5936
|
/**
|
|
5941
|
-
*
|
|
5942
|
-
*
|
|
5937
|
+
* Retrieve a list of document embeddings for a specific pathway.
|
|
5938
|
+
*
|
|
5939
|
+
* This endpoint returns a paginated list of all document embeddings
|
|
5940
|
+
* that have been created for the specified pathway within the organization.
|
|
5941
|
+
*
|
|
5942
|
+
* Args:
|
|
5943
|
+
* request: The HTTP request.
|
|
5944
|
+
* org: Organization key identifier.
|
|
5945
|
+
* pathway: The pathway to retrieve document embeddings for.
|
|
5946
|
+
*
|
|
5947
|
+
* Returns:
|
|
5948
|
+
* Response: A paginated list of document embeddings for the pathway.
|
|
5943
5949
|
* @param org
|
|
5944
|
-
* @
|
|
5950
|
+
* @param pathway
|
|
5951
|
+
* @param userId
|
|
5952
|
+
* @returns RetrieverDocumentEmbedding
|
|
5945
5953
|
* @throws ApiError
|
|
5946
5954
|
*/
|
|
5947
|
-
static
|
|
5955
|
+
static aiIndexOrgsUsersDocumentsPathwaysList(org, pathway, userId) {
|
|
5948
5956
|
return request(OpenAPI, {
|
|
5949
5957
|
method: 'GET',
|
|
5950
|
-
url: '/api/ai-
|
|
5958
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/pathways/{pathway}/',
|
|
5951
5959
|
path: {
|
|
5952
|
-
'
|
|
5953
|
-
'
|
|
5960
|
+
'org': org,
|
|
5961
|
+
'pathway': pathway,
|
|
5962
|
+
'user_id': userId
|
|
5954
5963
|
}
|
|
5955
5964
|
});
|
|
5956
5965
|
}
|
|
5957
5966
|
/**
|
|
5958
|
-
*
|
|
5959
|
-
*
|
|
5967
|
+
* Retrieve resource documents similar to the given query.
|
|
5968
|
+
*
|
|
5969
|
+
* This endpoint performs a semantic search to find documents that are
|
|
5970
|
+
* relevant to the provided query within the specified pathway.
|
|
5971
|
+
*
|
|
5972
|
+
* Args:
|
|
5973
|
+
* request: The HTTP request containing the search query.
|
|
5974
|
+
* org: Organization key identifier.
|
|
5975
|
+
*
|
|
5976
|
+
* Returns:
|
|
5977
|
+
* Response: A list of documents relevant to the search query.
|
|
5978
|
+
*
|
|
5979
|
+
* Raises:
|
|
5980
|
+
* ValidationError: If the request data is invalid.
|
|
5960
5981
|
* @param org
|
|
5982
|
+
* @param userId
|
|
5961
5983
|
* @param requestBody
|
|
5962
|
-
* @returns
|
|
5984
|
+
* @returns RetrieverResponseSearch
|
|
5963
5985
|
* @throws ApiError
|
|
5964
5986
|
*/
|
|
5965
|
-
static
|
|
5987
|
+
static aiIndexOrgsUsersDocumentsSearchCreate(org, userId, requestBody) {
|
|
5966
5988
|
return request(OpenAPI, {
|
|
5967
|
-
method: '
|
|
5968
|
-
url: '/api/ai-
|
|
5989
|
+
method: 'POST',
|
|
5990
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/search/',
|
|
5969
5991
|
path: {
|
|
5970
|
-
'
|
|
5971
|
-
'
|
|
5972
|
-
},
|
|
5973
|
-
body: requestBody,
|
|
5974
|
-
mediaType: 'application/json'
|
|
5975
|
-
});
|
|
5976
|
-
}
|
|
5977
|
-
/**
|
|
5978
|
-
* Create modify and update bot information for a specific tenant.
|
|
5979
|
-
* @param id A unique integer value identifying this bot.
|
|
5980
|
-
* @param org
|
|
5981
|
-
* @param requestBody
|
|
5982
|
-
* @returns BotCreate
|
|
5983
|
-
* @throws ApiError
|
|
5984
|
-
*/
|
|
5985
|
-
static aiBotV1BotsBotPartialUpdate(id, org, requestBody) {
|
|
5986
|
-
return request(OpenAPI, {
|
|
5987
|
-
method: 'PATCH',
|
|
5988
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
|
|
5989
|
-
path: {
|
|
5990
|
-
'id': id,
|
|
5991
|
-
'org': org
|
|
5992
|
-
},
|
|
5993
|
-
body: requestBody,
|
|
5994
|
-
mediaType: 'application/json'
|
|
5995
|
-
});
|
|
5996
|
-
}
|
|
5997
|
-
/**
|
|
5998
|
-
* Create modify and update bot information for a specific tenant.
|
|
5999
|
-
* @param id A unique integer value identifying this bot.
|
|
6000
|
-
* @param org
|
|
6001
|
-
* @returns void
|
|
6002
|
-
* @throws ApiError
|
|
6003
|
-
*/
|
|
6004
|
-
static aiBotV1BotsBotDestroy(id, org) {
|
|
6005
|
-
return request(OpenAPI, {
|
|
6006
|
-
method: 'DELETE',
|
|
6007
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
|
|
6008
|
-
path: {
|
|
6009
|
-
'id': id,
|
|
6010
|
-
'org': org
|
|
6011
|
-
}
|
|
6012
|
-
});
|
|
6013
|
-
}
|
|
6014
|
-
/**
|
|
6015
|
-
* Create modify and update bot information for a specific tenant.
|
|
6016
|
-
* @param id A unique integer value identifying this bot.
|
|
6017
|
-
* @param org
|
|
6018
|
-
* @returns DiscordConfig
|
|
6019
|
-
* @throws ApiError
|
|
6020
|
-
*/
|
|
6021
|
-
static aiBotV1BotsBotConfigDiscordRetrieve(id, org) {
|
|
6022
|
-
return request(OpenAPI, {
|
|
6023
|
-
method: 'GET',
|
|
6024
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
|
|
6025
|
-
path: {
|
|
6026
|
-
'id': id,
|
|
6027
|
-
'org': org
|
|
6028
|
-
}
|
|
6029
|
-
});
|
|
6030
|
-
}
|
|
6031
|
-
/**
|
|
6032
|
-
* Create modify and update bot information for a specific tenant.
|
|
6033
|
-
* @param id A unique integer value identifying this bot.
|
|
6034
|
-
* @param org
|
|
6035
|
-
* @param requestBody
|
|
6036
|
-
* @returns DiscordConfig
|
|
6037
|
-
* @throws ApiError
|
|
6038
|
-
*/
|
|
6039
|
-
static aiBotV1BotsBotConfigDiscordPartialUpdate(id, org, requestBody) {
|
|
6040
|
-
return request(OpenAPI, {
|
|
6041
|
-
method: 'PATCH',
|
|
6042
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
|
|
6043
|
-
path: {
|
|
6044
|
-
'id': id,
|
|
6045
|
-
'org': org
|
|
6046
|
-
},
|
|
6047
|
-
body: requestBody,
|
|
6048
|
-
mediaType: 'application/json'
|
|
6049
|
-
});
|
|
6050
|
-
}
|
|
6051
|
-
/**
|
|
6052
|
-
* Create modify and update bot information for a specific tenant.
|
|
6053
|
-
* @param id A unique integer value identifying this bot.
|
|
6054
|
-
* @param org
|
|
6055
|
-
* @returns SlackConfig
|
|
6056
|
-
* @throws ApiError
|
|
6057
|
-
*/
|
|
6058
|
-
static aiBotV1BotsBotConfigSlackRetrieve(id, org) {
|
|
6059
|
-
return request(OpenAPI, {
|
|
6060
|
-
method: 'GET',
|
|
6061
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/',
|
|
6062
|
-
path: {
|
|
6063
|
-
'id': id,
|
|
6064
|
-
'org': org
|
|
6065
|
-
}
|
|
6066
|
-
});
|
|
6067
|
-
}
|
|
6068
|
-
/**
|
|
6069
|
-
* Create modify and update bot information for a specific tenant.
|
|
6070
|
-
* @param id A unique integer value identifying this bot.
|
|
6071
|
-
* @param org
|
|
6072
|
-
* @param requestBody
|
|
6073
|
-
* @returns SlackConfig
|
|
6074
|
-
* @throws ApiError
|
|
6075
|
-
*/
|
|
6076
|
-
static aiBotV1BotsBotConfigSlackUpdateCreate(id, org, requestBody) {
|
|
6077
|
-
return request(OpenAPI, {
|
|
6078
|
-
method: 'POST',
|
|
6079
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
|
|
6080
|
-
path: {
|
|
6081
|
-
'id': id,
|
|
6082
|
-
'org': org
|
|
6083
|
-
},
|
|
6084
|
-
body: requestBody,
|
|
6085
|
-
mediaType: 'application/json'
|
|
6086
|
-
});
|
|
6087
|
-
}
|
|
6088
|
-
/**
|
|
6089
|
-
* Create modify and update bot information for a specific tenant.
|
|
6090
|
-
* @param id A unique integer value identifying this bot.
|
|
6091
|
-
* @param org
|
|
6092
|
-
* @param requestBody
|
|
6093
|
-
* @returns SlackConfig
|
|
6094
|
-
* @throws ApiError
|
|
6095
|
-
*/
|
|
6096
|
-
static aiBotV1BotsBotConfigSlackUpdateUpdate(id, org, requestBody) {
|
|
6097
|
-
return request(OpenAPI, {
|
|
6098
|
-
method: 'PUT',
|
|
6099
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
|
|
6100
|
-
path: {
|
|
6101
|
-
'id': id,
|
|
6102
|
-
'org': org
|
|
6103
|
-
},
|
|
6104
|
-
body: requestBody,
|
|
6105
|
-
mediaType: 'application/json'
|
|
6106
|
-
});
|
|
6107
|
-
}
|
|
6108
|
-
/**
|
|
6109
|
-
* Create modify and update bot information for a specific tenant.
|
|
6110
|
-
* @param id A unique integer value identifying this bot.
|
|
6111
|
-
* @param org
|
|
6112
|
-
* @param requestBody
|
|
6113
|
-
* @returns SlackConfig
|
|
6114
|
-
* @throws ApiError
|
|
6115
|
-
*/
|
|
6116
|
-
static aiBotV1BotsBotConfigSlackUpdatePartialUpdate(id, org, requestBody) {
|
|
6117
|
-
return request(OpenAPI, {
|
|
6118
|
-
method: 'PATCH',
|
|
6119
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
|
|
6120
|
-
path: {
|
|
6121
|
-
'id': id,
|
|
6122
|
-
'org': org
|
|
6123
|
-
},
|
|
6124
|
-
body: requestBody,
|
|
6125
|
-
mediaType: 'application/json'
|
|
6126
|
-
});
|
|
6127
|
-
}
|
|
6128
|
-
/**
|
|
6129
|
-
* Create modify and update bot information for a specific tenant.
|
|
6130
|
-
* @param id A unique integer value identifying this bot.
|
|
6131
|
-
* @param org
|
|
6132
|
-
* @returns TeamsConfig
|
|
6133
|
-
* @throws ApiError
|
|
6134
|
-
*/
|
|
6135
|
-
static aiBotV1BotsBotConfigTeamsRetrieve(id, org) {
|
|
6136
|
-
return request(OpenAPI, {
|
|
6137
|
-
method: 'GET',
|
|
6138
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/',
|
|
6139
|
-
path: {
|
|
6140
|
-
'id': id,
|
|
6141
|
-
'org': org
|
|
6142
|
-
}
|
|
6143
|
-
});
|
|
6144
|
-
}
|
|
6145
|
-
/**
|
|
6146
|
-
* Create modify and update bot information for a specific tenant.
|
|
6147
|
-
* @param id A unique integer value identifying this bot.
|
|
6148
|
-
* @param org
|
|
6149
|
-
* @param requestBody
|
|
6150
|
-
* @returns TeamsConfig
|
|
6151
|
-
* @throws ApiError
|
|
6152
|
-
*/
|
|
6153
|
-
static aiBotV1BotsBotConfigTeamsUpdateCreate(id, org, requestBody) {
|
|
6154
|
-
return request(OpenAPI, {
|
|
6155
|
-
method: 'POST',
|
|
6156
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
|
|
6157
|
-
path: {
|
|
6158
|
-
'id': id,
|
|
6159
|
-
'org': org
|
|
6160
|
-
},
|
|
6161
|
-
body: requestBody,
|
|
6162
|
-
mediaType: 'application/json'
|
|
6163
|
-
});
|
|
6164
|
-
}
|
|
6165
|
-
/**
|
|
6166
|
-
* Create modify and update bot information for a specific tenant.
|
|
6167
|
-
* @param id A unique integer value identifying this bot.
|
|
6168
|
-
* @param org
|
|
6169
|
-
* @param requestBody
|
|
6170
|
-
* @returns TeamsConfig
|
|
6171
|
-
* @throws ApiError
|
|
6172
|
-
*/
|
|
6173
|
-
static aiBotV1BotsBotConfigTeamsUpdateUpdate(id, org, requestBody) {
|
|
6174
|
-
return request(OpenAPI, {
|
|
6175
|
-
method: 'PUT',
|
|
6176
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
|
|
6177
|
-
path: {
|
|
6178
|
-
'id': id,
|
|
6179
|
-
'org': org
|
|
6180
|
-
},
|
|
6181
|
-
body: requestBody,
|
|
6182
|
-
mediaType: 'application/json'
|
|
6183
|
-
});
|
|
6184
|
-
}
|
|
6185
|
-
/**
|
|
6186
|
-
* Create modify and update bot information for a specific tenant.
|
|
6187
|
-
* @param id A unique integer value identifying this bot.
|
|
6188
|
-
* @param org
|
|
6189
|
-
* @param requestBody
|
|
6190
|
-
* @returns TeamsConfig
|
|
6191
|
-
* @throws ApiError
|
|
6192
|
-
*/
|
|
6193
|
-
static aiBotV1BotsBotConfigTeamsUpdatePartialUpdate(id, org, requestBody) {
|
|
6194
|
-
return request(OpenAPI, {
|
|
6195
|
-
method: 'PATCH',
|
|
6196
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
|
|
6197
|
-
path: {
|
|
6198
|
-
'id': id,
|
|
6199
|
-
'org': org
|
|
6200
|
-
},
|
|
6201
|
-
body: requestBody,
|
|
6202
|
-
mediaType: 'application/json'
|
|
6203
|
-
});
|
|
6204
|
-
}
|
|
6205
|
-
/**
|
|
6206
|
-
* Create modify and update bot information for a specific tenant.
|
|
6207
|
-
* @param id A unique integer value identifying this bot.
|
|
6208
|
-
* @param org
|
|
6209
|
-
* @returns WebexConfig
|
|
6210
|
-
* @throws ApiError
|
|
6211
|
-
*/
|
|
6212
|
-
static aiBotV1BotsBotConfigWebexRetrieve(id, org) {
|
|
6213
|
-
return request(OpenAPI, {
|
|
6214
|
-
method: 'GET',
|
|
6215
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/webex/',
|
|
6216
|
-
path: {
|
|
6217
|
-
'id': id,
|
|
6218
|
-
'org': org
|
|
6219
|
-
}
|
|
6220
|
-
});
|
|
6221
|
-
}
|
|
6222
|
-
/**
|
|
6223
|
-
* Create modify and update bot information for a specific tenant.
|
|
6224
|
-
* @param id A unique integer value identifying this bot.
|
|
6225
|
-
* @param org
|
|
6226
|
-
* @param requestBody
|
|
6227
|
-
* @returns WebexConfig
|
|
6228
|
-
* @throws ApiError
|
|
6229
|
-
*/
|
|
6230
|
-
static aiBotV1BotsBotConfigWebexPartialUpdate(id, org, requestBody) {
|
|
6231
|
-
return request(OpenAPI, {
|
|
6232
|
-
method: 'PATCH',
|
|
6233
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/webex/',
|
|
6234
|
-
path: {
|
|
6235
|
-
'id': id,
|
|
6236
|
-
'org': org
|
|
6237
|
-
},
|
|
6238
|
-
body: requestBody,
|
|
6239
|
-
mediaType: 'application/json'
|
|
6240
|
-
});
|
|
6241
|
-
}
|
|
6242
|
-
/**
|
|
6243
|
-
* Create modify and update bot information for a specific tenant.
|
|
6244
|
-
* @param id A unique integer value identifying this bot.
|
|
6245
|
-
* @param org
|
|
6246
|
-
* @returns WhatsappConfig
|
|
6247
|
-
* @throws ApiError
|
|
6248
|
-
*/
|
|
6249
|
-
static aiBotV1BotsBotConfigWhatsappRetrieve(id, org) {
|
|
6250
|
-
return request(OpenAPI, {
|
|
6251
|
-
method: 'GET',
|
|
6252
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/whatsapp/',
|
|
6253
|
-
path: {
|
|
6254
|
-
'id': id,
|
|
6255
|
-
'org': org
|
|
6256
|
-
}
|
|
6257
|
-
});
|
|
6258
|
-
}
|
|
6259
|
-
/**
|
|
6260
|
-
* Create modify and update bot information for a specific tenant.
|
|
6261
|
-
* @param id A unique integer value identifying this bot.
|
|
6262
|
-
* @param org
|
|
6263
|
-
* @param requestBody
|
|
6264
|
-
* @returns WhatsappConfig
|
|
6265
|
-
* @throws ApiError
|
|
6266
|
-
*/
|
|
6267
|
-
static aiBotV1BotsBotWhatsappConfigUpdate(id, org, requestBody) {
|
|
6268
|
-
return request(OpenAPI, {
|
|
6269
|
-
method: 'PUT',
|
|
6270
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/whatsapp-config/',
|
|
6271
|
-
path: {
|
|
6272
|
-
'id': id,
|
|
6273
|
-
'org': org
|
|
6274
|
-
},
|
|
6275
|
-
body: requestBody,
|
|
6276
|
-
mediaType: 'application/json'
|
|
6277
|
-
});
|
|
6278
|
-
}
|
|
6279
|
-
/**
|
|
6280
|
-
* Create modify and update bot information for a specific tenant.
|
|
6281
|
-
* @param id A unique integer value identifying this bot.
|
|
6282
|
-
* @param org
|
|
6283
|
-
* @param requestBody
|
|
6284
|
-
* @returns WhatsappConfig
|
|
6285
|
-
* @throws ApiError
|
|
6286
|
-
*/
|
|
6287
|
-
static aiBotV1BotsBotWhatsappConfigPartialUpdate(id, org, requestBody) {
|
|
6288
|
-
return request(OpenAPI, {
|
|
6289
|
-
method: 'PATCH',
|
|
6290
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/whatsapp-config/',
|
|
6291
|
-
path: {
|
|
6292
|
-
'id': id,
|
|
6293
|
-
'org': org
|
|
6294
|
-
},
|
|
6295
|
-
body: requestBody,
|
|
6296
|
-
mediaType: 'application/json'
|
|
6297
|
-
});
|
|
6298
|
-
}
|
|
6299
|
-
/**
|
|
6300
|
-
* Setup discord user id linkage with discord bots
|
|
6301
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
6302
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
6303
|
-
* @param org
|
|
6304
|
-
* @returns DiscordUserConfig
|
|
6305
|
-
* @throws ApiError
|
|
6306
|
-
*/
|
|
6307
|
-
static aiBotV1BotsDiscordUserConfigList(org) {
|
|
6308
|
-
return request(OpenAPI, {
|
|
6309
|
-
method: 'GET',
|
|
6310
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/',
|
|
6311
|
-
path: {
|
|
6312
|
-
'org': org
|
|
6313
|
-
}
|
|
6314
|
-
});
|
|
6315
|
-
}
|
|
6316
|
-
/**
|
|
6317
|
-
* Setup discord user id linkage with discord bots
|
|
6318
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
6319
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
6320
|
-
* @param org
|
|
6321
|
-
* @param requestBody
|
|
6322
|
-
* @returns DiscordUserConfig
|
|
6323
|
-
* @throws ApiError
|
|
6324
|
-
*/
|
|
6325
|
-
static aiBotV1BotsDiscordUserConfigCreate(org, requestBody) {
|
|
6326
|
-
return request(OpenAPI, {
|
|
6327
|
-
method: 'POST',
|
|
6328
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/',
|
|
6329
|
-
path: {
|
|
6330
|
-
'org': org
|
|
6331
|
-
},
|
|
6332
|
-
body: requestBody,
|
|
6333
|
-
mediaType: 'application/json'
|
|
6334
|
-
});
|
|
6335
|
-
}
|
|
6336
|
-
/**
|
|
6337
|
-
* Setup discord user id linkage with discord bots
|
|
6338
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
6339
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
6340
|
-
* @param id A unique integer value identifying this discord user config.
|
|
6341
|
-
* @param org
|
|
6342
|
-
* @returns DiscordUserConfig
|
|
6343
|
-
* @throws ApiError
|
|
6344
|
-
*/
|
|
6345
|
-
static aiBotV1BotsDiscordUserConfigRetrieve(id, org) {
|
|
6346
|
-
return request(OpenAPI, {
|
|
6347
|
-
method: 'GET',
|
|
6348
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
6349
|
-
path: {
|
|
6350
|
-
'id': id,
|
|
6351
|
-
'org': org
|
|
6352
|
-
}
|
|
6353
|
-
});
|
|
6354
|
-
}
|
|
6355
|
-
/**
|
|
6356
|
-
* Setup discord user id linkage with discord bots
|
|
6357
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
6358
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
6359
|
-
* @param id A unique integer value identifying this discord user config.
|
|
6360
|
-
* @param org
|
|
6361
|
-
* @param requestBody
|
|
6362
|
-
* @returns DiscordUserConfig
|
|
6363
|
-
* @throws ApiError
|
|
6364
|
-
*/
|
|
6365
|
-
static aiBotV1BotsDiscordUserConfigUpdate(id, org, requestBody) {
|
|
6366
|
-
return request(OpenAPI, {
|
|
6367
|
-
method: 'PUT',
|
|
6368
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
6369
|
-
path: {
|
|
6370
|
-
'id': id,
|
|
6371
|
-
'org': org
|
|
6372
|
-
},
|
|
6373
|
-
body: requestBody,
|
|
6374
|
-
mediaType: 'application/json'
|
|
6375
|
-
});
|
|
6376
|
-
}
|
|
6377
|
-
/**
|
|
6378
|
-
* Setup discord user id linkage with discord bots
|
|
6379
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
6380
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
6381
|
-
* @param id A unique integer value identifying this discord user config.
|
|
6382
|
-
* @param org
|
|
6383
|
-
* @param requestBody
|
|
6384
|
-
* @returns DiscordUserConfig
|
|
6385
|
-
* @throws ApiError
|
|
6386
|
-
*/
|
|
6387
|
-
static aiBotV1BotsDiscordUserConfigPartialUpdate(id, org, requestBody) {
|
|
6388
|
-
return request(OpenAPI, {
|
|
6389
|
-
method: 'PATCH',
|
|
6390
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
6391
|
-
path: {
|
|
6392
|
-
'id': id,
|
|
6393
|
-
'org': org
|
|
6394
|
-
},
|
|
6395
|
-
body: requestBody,
|
|
6396
|
-
mediaType: 'application/json'
|
|
6397
|
-
});
|
|
6398
|
-
}
|
|
6399
|
-
/**
|
|
6400
|
-
* Setup discord user id linkage with discord bots
|
|
6401
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
6402
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
6403
|
-
* @param id A unique integer value identifying this discord user config.
|
|
6404
|
-
* @param org
|
|
6405
|
-
* @returns void
|
|
6406
|
-
* @throws ApiError
|
|
6407
|
-
*/
|
|
6408
|
-
static aiBotV1BotsDiscordUserConfigDestroy(id, org) {
|
|
6409
|
-
return request(OpenAPI, {
|
|
6410
|
-
method: 'DELETE',
|
|
6411
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
6412
|
-
path: {
|
|
6413
|
-
'id': id,
|
|
6414
|
-
'org': org
|
|
6415
|
-
}
|
|
6416
|
-
});
|
|
6417
|
-
}
|
|
6418
|
-
/**
|
|
6419
|
-
* Setup slack username and domain linkage with slack bots
|
|
6420
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
6421
|
-
* @param org
|
|
6422
|
-
* @returns SlackUserConfig
|
|
6423
|
-
* @throws ApiError
|
|
6424
|
-
*/
|
|
6425
|
-
static aiBotV1BotsSlackUserConfigList(org) {
|
|
6426
|
-
return request(OpenAPI, {
|
|
6427
|
-
method: 'GET',
|
|
6428
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/',
|
|
6429
|
-
path: {
|
|
6430
|
-
'org': org
|
|
6431
|
-
}
|
|
6432
|
-
});
|
|
6433
|
-
}
|
|
6434
|
-
/**
|
|
6435
|
-
* Setup slack username and domain linkage with slack bots
|
|
6436
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
6437
|
-
* @param org
|
|
6438
|
-
* @param requestBody
|
|
6439
|
-
* @returns SlackUserConfig
|
|
6440
|
-
* @throws ApiError
|
|
6441
|
-
*/
|
|
6442
|
-
static aiBotV1BotsSlackUserConfigCreate(org, requestBody) {
|
|
6443
|
-
return request(OpenAPI, {
|
|
6444
|
-
method: 'POST',
|
|
6445
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/',
|
|
6446
|
-
path: {
|
|
6447
|
-
'org': org
|
|
6448
|
-
},
|
|
6449
|
-
body: requestBody,
|
|
6450
|
-
mediaType: 'application/json'
|
|
6451
|
-
});
|
|
6452
|
-
}
|
|
6453
|
-
/**
|
|
6454
|
-
* Setup slack username and domain linkage with slack bots
|
|
6455
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
6456
|
-
* @param id A unique integer value identifying this slack user config.
|
|
6457
|
-
* @param org
|
|
6458
|
-
* @returns SlackUserConfig
|
|
6459
|
-
* @throws ApiError
|
|
6460
|
-
*/
|
|
6461
|
-
static aiBotV1BotsSlackUserConfigRetrieve(id, org) {
|
|
6462
|
-
return request(OpenAPI, {
|
|
6463
|
-
method: 'GET',
|
|
6464
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
6465
|
-
path: {
|
|
6466
|
-
'id': id,
|
|
6467
|
-
'org': org
|
|
6468
|
-
}
|
|
6469
|
-
});
|
|
6470
|
-
}
|
|
6471
|
-
/**
|
|
6472
|
-
* Setup slack username and domain linkage with slack bots
|
|
6473
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
6474
|
-
* @param id A unique integer value identifying this slack user config.
|
|
6475
|
-
* @param org
|
|
6476
|
-
* @param requestBody
|
|
6477
|
-
* @returns SlackUserConfig
|
|
6478
|
-
* @throws ApiError
|
|
6479
|
-
*/
|
|
6480
|
-
static aiBotV1BotsSlackUserConfigUpdate(id, org, requestBody) {
|
|
6481
|
-
return request(OpenAPI, {
|
|
6482
|
-
method: 'PUT',
|
|
6483
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
6484
|
-
path: {
|
|
6485
|
-
'id': id,
|
|
6486
|
-
'org': org
|
|
6487
|
-
},
|
|
6488
|
-
body: requestBody,
|
|
6489
|
-
mediaType: 'application/json'
|
|
6490
|
-
});
|
|
6491
|
-
}
|
|
6492
|
-
/**
|
|
6493
|
-
* Setup slack username and domain linkage with slack bots
|
|
6494
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
6495
|
-
* @param id A unique integer value identifying this slack user config.
|
|
6496
|
-
* @param org
|
|
6497
|
-
* @param requestBody
|
|
6498
|
-
* @returns SlackUserConfig
|
|
6499
|
-
* @throws ApiError
|
|
6500
|
-
*/
|
|
6501
|
-
static aiBotV1BotsSlackUserConfigPartialUpdate(id, org, requestBody) {
|
|
6502
|
-
return request(OpenAPI, {
|
|
6503
|
-
method: 'PATCH',
|
|
6504
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
6505
|
-
path: {
|
|
6506
|
-
'id': id,
|
|
6507
|
-
'org': org
|
|
6508
|
-
},
|
|
6509
|
-
body: requestBody,
|
|
6510
|
-
mediaType: 'application/json'
|
|
6511
|
-
});
|
|
6512
|
-
}
|
|
6513
|
-
/**
|
|
6514
|
-
* Setup slack username and domain linkage with slack bots
|
|
6515
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
6516
|
-
* @param id A unique integer value identifying this slack user config.
|
|
6517
|
-
* @param org
|
|
6518
|
-
* @returns void
|
|
6519
|
-
* @throws ApiError
|
|
6520
|
-
*/
|
|
6521
|
-
static aiBotV1BotsSlackUserConfigDestroy(id, org) {
|
|
6522
|
-
return request(OpenAPI, {
|
|
6523
|
-
method: 'DELETE',
|
|
6524
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
6525
|
-
path: {
|
|
6526
|
-
'id': id,
|
|
6527
|
-
'org': org
|
|
6528
|
-
}
|
|
6529
|
-
});
|
|
6530
|
-
}
|
|
6531
|
-
/**
|
|
6532
|
-
* Setup phone number linkage with whatsapp bots
|
|
6533
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
6534
|
-
* @param org
|
|
6535
|
-
* @returns WhatsappUserConfig
|
|
6536
|
-
* @throws ApiError
|
|
6537
|
-
*/
|
|
6538
|
-
static aiBotV1BotsWhatsappUserConfigList(org) {
|
|
6539
|
-
return request(OpenAPI, {
|
|
6540
|
-
method: 'GET',
|
|
6541
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/',
|
|
6542
|
-
path: {
|
|
6543
|
-
'org': org
|
|
6544
|
-
}
|
|
6545
|
-
});
|
|
6546
|
-
}
|
|
6547
|
-
/**
|
|
6548
|
-
* Setup phone number linkage with whatsapp bots
|
|
6549
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
6550
|
-
* @param org
|
|
6551
|
-
* @param requestBody
|
|
6552
|
-
* @returns WhatsappUserConfig
|
|
6553
|
-
* @throws ApiError
|
|
6554
|
-
*/
|
|
6555
|
-
static aiBotV1BotsWhatsappUserConfigCreate(org, requestBody) {
|
|
6556
|
-
return request(OpenAPI, {
|
|
6557
|
-
method: 'POST',
|
|
6558
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/',
|
|
6559
|
-
path: {
|
|
6560
|
-
'org': org
|
|
6561
|
-
},
|
|
6562
|
-
body: requestBody,
|
|
6563
|
-
mediaType: 'application/json'
|
|
6564
|
-
});
|
|
6565
|
-
}
|
|
6566
|
-
/**
|
|
6567
|
-
* Setup phone number linkage with whatsapp bots
|
|
6568
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
6569
|
-
* @param id A unique integer value identifying this whatsapp user config.
|
|
6570
|
-
* @param org
|
|
6571
|
-
* @returns WhatsappUserConfig
|
|
6572
|
-
* @throws ApiError
|
|
6573
|
-
*/
|
|
6574
|
-
static aiBotV1BotsWhatsappUserConfigRetrieve(id, org) {
|
|
6575
|
-
return request(OpenAPI, {
|
|
6576
|
-
method: 'GET',
|
|
6577
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
6578
|
-
path: {
|
|
6579
|
-
'id': id,
|
|
6580
|
-
'org': org
|
|
6581
|
-
}
|
|
6582
|
-
});
|
|
6583
|
-
}
|
|
6584
|
-
/**
|
|
6585
|
-
* Setup phone number linkage with whatsapp bots
|
|
6586
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
6587
|
-
* @param id A unique integer value identifying this whatsapp user config.
|
|
6588
|
-
* @param org
|
|
6589
|
-
* @param requestBody
|
|
6590
|
-
* @returns WhatsappUserConfig
|
|
6591
|
-
* @throws ApiError
|
|
6592
|
-
*/
|
|
6593
|
-
static aiBotV1BotsWhatsappUserConfigUpdate(id, org, requestBody) {
|
|
6594
|
-
return request(OpenAPI, {
|
|
6595
|
-
method: 'PUT',
|
|
6596
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
6597
|
-
path: {
|
|
6598
|
-
'id': id,
|
|
6599
|
-
'org': org
|
|
6600
|
-
},
|
|
6601
|
-
body: requestBody,
|
|
6602
|
-
mediaType: 'application/json'
|
|
6603
|
-
});
|
|
6604
|
-
}
|
|
6605
|
-
/**
|
|
6606
|
-
* Setup phone number linkage with whatsapp bots
|
|
6607
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
6608
|
-
* @param id A unique integer value identifying this whatsapp user config.
|
|
6609
|
-
* @param org
|
|
6610
|
-
* @param requestBody
|
|
6611
|
-
* @returns WhatsappUserConfig
|
|
6612
|
-
* @throws ApiError
|
|
6613
|
-
*/
|
|
6614
|
-
static aiBotV1BotsWhatsappUserConfigPartialUpdate(id, org, requestBody) {
|
|
6615
|
-
return request(OpenAPI, {
|
|
6616
|
-
method: 'PATCH',
|
|
6617
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
6618
|
-
path: {
|
|
6619
|
-
'id': id,
|
|
6620
|
-
'org': org
|
|
6621
|
-
},
|
|
6622
|
-
body: requestBody,
|
|
6623
|
-
mediaType: 'application/json'
|
|
6624
|
-
});
|
|
6625
|
-
}
|
|
6626
|
-
/**
|
|
6627
|
-
* Setup phone number linkage with whatsapp bots
|
|
6628
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
6629
|
-
* @param id A unique integer value identifying this whatsapp user config.
|
|
6630
|
-
* @param org
|
|
6631
|
-
* @returns void
|
|
6632
|
-
* @throws ApiError
|
|
6633
|
-
*/
|
|
6634
|
-
static aiBotV1BotsWhatsappUserConfigDestroy(id, org) {
|
|
6635
|
-
return request(OpenAPI, {
|
|
6636
|
-
method: 'DELETE',
|
|
6637
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
6638
|
-
path: {
|
|
6639
|
-
'id': id,
|
|
6640
|
-
'org': org
|
|
6641
|
-
}
|
|
6642
|
-
});
|
|
6643
|
-
}
|
|
6644
|
-
/**
|
|
6645
|
-
* Webhook endpoint to receive and process discord messages.
|
|
6646
|
-
* @param name
|
|
6647
|
-
* @param org
|
|
6648
|
-
* @param requestBody
|
|
6649
|
-
* @returns DiscordWebhook
|
|
6650
|
-
* @throws ApiError
|
|
6651
|
-
*/
|
|
6652
|
-
static aiBotV1BotsWebhooksDiscordCreate(name, org, requestBody) {
|
|
6653
|
-
return request(OpenAPI, {
|
|
6654
|
-
method: 'POST',
|
|
6655
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/discord/{name}/',
|
|
6656
|
-
path: {
|
|
6657
|
-
'name': name,
|
|
6658
|
-
'org': org
|
|
6659
|
-
},
|
|
6660
|
-
body: requestBody,
|
|
6661
|
-
mediaType: 'application/json'
|
|
6662
|
-
});
|
|
6663
|
-
}
|
|
6664
|
-
/**
|
|
6665
|
-
* @param name
|
|
6666
|
-
* @param org
|
|
6667
|
-
* @param requestBody
|
|
6668
|
-
* @returns SlackWebhook
|
|
6669
|
-
* @throws ApiError
|
|
6670
|
-
*/
|
|
6671
|
-
static aiBotV1BotsWebhooksSlackCreate(name, org, requestBody) {
|
|
6672
|
-
return request(OpenAPI, {
|
|
6673
|
-
method: 'POST',
|
|
6674
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/slack/{name}/',
|
|
6675
|
-
path: {
|
|
6676
|
-
'name': name,
|
|
6677
|
-
'org': org
|
|
6678
|
-
},
|
|
6679
|
-
body: requestBody,
|
|
6680
|
-
mediaType: 'application/json'
|
|
6681
|
-
});
|
|
6682
|
-
}
|
|
6683
|
-
/**
|
|
6684
|
-
* @param name
|
|
6685
|
-
* @param org
|
|
6686
|
-
* @param requestBody
|
|
6687
|
-
* @returns TeamsWebhook
|
|
6688
|
-
* @throws ApiError
|
|
6689
|
-
*/
|
|
6690
|
-
static aiBotV1BotsWebhooksTeamsCreate(name, org, requestBody) {
|
|
6691
|
-
return request(OpenAPI, {
|
|
6692
|
-
method: 'POST',
|
|
6693
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/teams/{name}/',
|
|
6694
|
-
path: {
|
|
6695
|
-
'name': name,
|
|
6696
|
-
'org': org
|
|
6697
|
-
},
|
|
6698
|
-
body: requestBody,
|
|
6699
|
-
mediaType: 'application/json'
|
|
6700
|
-
});
|
|
6701
|
-
}
|
|
6702
|
-
/**
|
|
6703
|
-
* Webhook endpoint to receive and process discord messages.
|
|
6704
|
-
* @param name
|
|
6705
|
-
* @param org
|
|
6706
|
-
* @param requestBody
|
|
6707
|
-
* @returns WebexWebhook
|
|
6708
|
-
* @throws ApiError
|
|
6709
|
-
*/
|
|
6710
|
-
static aiBotV1BotsWebhooksWebexCreate(name, org, requestBody) {
|
|
6711
|
-
return request(OpenAPI, {
|
|
6712
|
-
method: 'POST',
|
|
6713
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/webex/{name}/',
|
|
6714
|
-
path: {
|
|
6715
|
-
'name': name,
|
|
6716
|
-
'org': org
|
|
6717
|
-
},
|
|
6718
|
-
body: requestBody,
|
|
6719
|
-
mediaType: 'application/json'
|
|
6720
|
-
});
|
|
6721
|
-
}
|
|
6722
|
-
/**
|
|
6723
|
-
* Respond to whatsapp's webhook challenge.
|
|
6724
|
-
* Parameters Required include the tenant key (org) and the name of the bot: (name)
|
|
6725
|
-
* @param name
|
|
6726
|
-
* @param org
|
|
6727
|
-
* @returns WhatAppWebHook
|
|
6728
|
-
* @throws ApiError
|
|
6729
|
-
*/
|
|
6730
|
-
static aiBotV1BotsWebhooksWhatsappRetrieve(name, org) {
|
|
6731
|
-
return request(OpenAPI, {
|
|
6732
|
-
method: 'GET',
|
|
6733
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/whatsapp/{name}/',
|
|
6734
|
-
path: {
|
|
6735
|
-
'name': name,
|
|
6736
|
-
'org': org
|
|
6737
|
-
}
|
|
6738
|
-
});
|
|
6739
|
-
}
|
|
6740
|
-
/**
|
|
6741
|
-
* Accept and process webhook events from whatsapp.
|
|
6742
|
-
* @param name
|
|
6743
|
-
* @param org
|
|
6744
|
-
* @param requestBody
|
|
6745
|
-
* @returns WhatAppWebHook
|
|
6746
|
-
* @throws ApiError
|
|
6747
|
-
*/
|
|
6748
|
-
static aiBotV1BotsWebhooksWhatsappCreate(name, org, requestBody) {
|
|
6749
|
-
return request(OpenAPI, {
|
|
6750
|
-
method: 'POST',
|
|
6751
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/whatsapp/{name}/',
|
|
6752
|
-
path: {
|
|
6753
|
-
'name': name,
|
|
6754
|
-
'org': org
|
|
6755
|
-
},
|
|
6756
|
-
body: requestBody,
|
|
6757
|
-
mediaType: 'application/json'
|
|
6758
|
-
});
|
|
6759
|
-
}
|
|
6760
|
-
}
|
|
6761
|
-
|
|
6762
|
-
class AiFinetuningService {
|
|
6763
|
-
/**
|
|
6764
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6765
|
-
* @param org
|
|
6766
|
-
* @param username
|
|
6767
|
-
* @param dateCreated
|
|
6768
|
-
* @param numDataPoints
|
|
6769
|
-
* @param ordering Which field to use when ordering the results.
|
|
6770
|
-
* @param page A page number within the paginated result set.
|
|
6771
|
-
* @param pageSize Number of results to return per page.
|
|
6772
|
-
* @param retryAttempts
|
|
6773
|
-
* @param search A search term.
|
|
6774
|
-
* @param status * `pending` - Pending
|
|
6775
|
-
* * `processing` - Processing
|
|
6776
|
-
* * `completed` - Completed
|
|
6777
|
-
* * `failed` - Failed
|
|
6778
|
-
* @returns PaginatedDataSetList
|
|
6779
|
-
* @throws ApiError
|
|
6780
|
-
*/
|
|
6781
|
-
static aiFinetuningV1OrgUserDatasetsList(org, username, dateCreated, numDataPoints, ordering, page, pageSize, retryAttempts, search, status) {
|
|
6782
|
-
return request(OpenAPI, {
|
|
6783
|
-
method: 'GET',
|
|
6784
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/',
|
|
6785
|
-
path: {
|
|
6786
|
-
'org': org,
|
|
6787
|
-
'username': username
|
|
6788
|
-
},
|
|
6789
|
-
query: {
|
|
6790
|
-
'date_created': dateCreated,
|
|
6791
|
-
'num_data_points': numDataPoints,
|
|
6792
|
-
'ordering': ordering,
|
|
6793
|
-
'page': page,
|
|
6794
|
-
'page_size': pageSize,
|
|
6795
|
-
'retry_attempts': retryAttempts,
|
|
6796
|
-
'search': search,
|
|
6797
|
-
'status': status
|
|
6798
|
-
}
|
|
6799
|
-
});
|
|
6800
|
-
}
|
|
6801
|
-
/**
|
|
6802
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6803
|
-
* @param org
|
|
6804
|
-
* @param username
|
|
6805
|
-
* @param requestBody
|
|
6806
|
-
* @returns DataSetCreate
|
|
6807
|
-
* @throws ApiError
|
|
6808
|
-
*/
|
|
6809
|
-
static aiFinetuningV1OrgUserDatasetsCreate(org, username, requestBody) {
|
|
6810
|
-
return request(OpenAPI, {
|
|
6811
|
-
method: 'POST',
|
|
6812
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/',
|
|
6813
|
-
path: {
|
|
6814
|
-
'org': org,
|
|
6815
|
-
'username': username
|
|
6816
|
-
},
|
|
6817
|
-
body: requestBody,
|
|
6818
|
-
mediaType: 'application/json'
|
|
6819
|
-
});
|
|
6820
|
-
}
|
|
6821
|
-
/**
|
|
6822
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6823
|
-
* @param id A UUID string identifying this data set.
|
|
6824
|
-
* @param org
|
|
6825
|
-
* @param username
|
|
6826
|
-
* @returns DataSet
|
|
6827
|
-
* @throws ApiError
|
|
6828
|
-
*/
|
|
6829
|
-
static aiFinetuningV1OrgUserDatasetsRetrieve(id, org, username) {
|
|
6830
|
-
return request(OpenAPI, {
|
|
6831
|
-
method: 'GET',
|
|
6832
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
|
|
6833
|
-
path: {
|
|
6834
|
-
'id': id,
|
|
6835
|
-
'org': org,
|
|
6836
|
-
'username': username
|
|
6837
|
-
}
|
|
6838
|
-
});
|
|
6839
|
-
}
|
|
6840
|
-
/**
|
|
6841
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6842
|
-
* @param id A UUID string identifying this data set.
|
|
6843
|
-
* @param org
|
|
6844
|
-
* @param username
|
|
6845
|
-
* @param requestBody
|
|
6846
|
-
* @returns DataSet
|
|
6847
|
-
* @throws ApiError
|
|
6848
|
-
*/
|
|
6849
|
-
static aiFinetuningV1OrgUserDatasetsUpdate(id, org, username, requestBody) {
|
|
6850
|
-
return request(OpenAPI, {
|
|
6851
|
-
method: 'PUT',
|
|
6852
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
|
|
6853
|
-
path: {
|
|
6854
|
-
'id': id,
|
|
6855
|
-
'org': org,
|
|
6856
|
-
'username': username
|
|
6857
|
-
},
|
|
6858
|
-
body: requestBody,
|
|
6859
|
-
mediaType: 'application/json'
|
|
6860
|
-
});
|
|
6861
|
-
}
|
|
6862
|
-
/**
|
|
6863
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6864
|
-
* @param id A UUID string identifying this data set.
|
|
6865
|
-
* @param org
|
|
6866
|
-
* @param username
|
|
6867
|
-
* @param requestBody
|
|
6868
|
-
* @returns DataSet
|
|
6869
|
-
* @throws ApiError
|
|
6870
|
-
*/
|
|
6871
|
-
static aiFinetuningV1OrgUserDatasetsPartialUpdate(id, org, username, requestBody) {
|
|
6872
|
-
return request(OpenAPI, {
|
|
6873
|
-
method: 'PATCH',
|
|
6874
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
|
|
6875
|
-
path: {
|
|
6876
|
-
'id': id,
|
|
6877
|
-
'org': org,
|
|
6878
|
-
'username': username
|
|
6879
|
-
},
|
|
6880
|
-
body: requestBody,
|
|
6881
|
-
mediaType: 'application/json'
|
|
6882
|
-
});
|
|
6883
|
-
}
|
|
6884
|
-
/**
|
|
6885
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6886
|
-
* @param id A UUID string identifying this data set.
|
|
6887
|
-
* @param org
|
|
6888
|
-
* @param username
|
|
6889
|
-
* @returns void
|
|
6890
|
-
* @throws ApiError
|
|
6891
|
-
*/
|
|
6892
|
-
static aiFinetuningV1OrgUserDatasetsDestroy(id, org, username) {
|
|
6893
|
-
return request(OpenAPI, {
|
|
6894
|
-
method: 'DELETE',
|
|
6895
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
|
|
6896
|
-
path: {
|
|
6897
|
-
'id': id,
|
|
6898
|
-
'org': org,
|
|
6899
|
-
'username': username
|
|
6900
|
-
}
|
|
6901
|
-
});
|
|
6902
|
-
}
|
|
6903
|
-
/**
|
|
6904
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6905
|
-
* @param org
|
|
6906
|
-
* @param username
|
|
6907
|
-
* @param baseModelName
|
|
6908
|
-
* @param dataset
|
|
6909
|
-
* @param dateCreated
|
|
6910
|
-
* @param fineTunedModel
|
|
6911
|
-
* @param lastModified
|
|
6912
|
-
* @param ordering Which field to use when ordering the results.
|
|
6913
|
-
* @param page A page number within the paginated result set.
|
|
6914
|
-
* @param pageSize Number of results to return per page.
|
|
6915
|
-
* @param preprocessDataset
|
|
6916
|
-
* @param provider * `openai` - Openai
|
|
6917
|
-
* @param search A search term.
|
|
6918
|
-
* @param status * `pending` - Pending
|
|
6919
|
-
* * `processing` - Processing
|
|
6920
|
-
* * `completed` - Completed
|
|
6921
|
-
* * `cancelled` - Cancelled
|
|
6922
|
-
* * `failed` - Failed
|
|
6923
|
-
* @returns PaginatedTrainingList
|
|
6924
|
-
* @throws ApiError
|
|
6925
|
-
*/
|
|
6926
|
-
static aiFinetuningV1OrgUserTrainingsList(org, username, baseModelName, dataset, dateCreated, fineTunedModel, lastModified, ordering, page, pageSize, preprocessDataset, provider, search, status) {
|
|
6927
|
-
return request(OpenAPI, {
|
|
6928
|
-
method: 'GET',
|
|
6929
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/',
|
|
6930
|
-
path: {
|
|
6931
|
-
'org': org,
|
|
6932
|
-
'username': username
|
|
6933
|
-
},
|
|
6934
|
-
query: {
|
|
6935
|
-
'base_model_name': baseModelName,
|
|
6936
|
-
'dataset': dataset,
|
|
6937
|
-
'date_created': dateCreated,
|
|
6938
|
-
'fine_tuned_model': fineTunedModel,
|
|
6939
|
-
'last_modified': lastModified,
|
|
6940
|
-
'ordering': ordering,
|
|
6941
|
-
'page': page,
|
|
6942
|
-
'page_size': pageSize,
|
|
6943
|
-
'preprocess_dataset': preprocessDataset,
|
|
6944
|
-
'provider': provider,
|
|
6945
|
-
'search': search,
|
|
6946
|
-
'status': status
|
|
6947
|
-
}
|
|
6948
|
-
});
|
|
6949
|
-
}
|
|
6950
|
-
/**
|
|
6951
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6952
|
-
* @param org
|
|
6953
|
-
* @param username
|
|
6954
|
-
* @param requestBody
|
|
6955
|
-
* @returns TrainingCreate
|
|
6956
|
-
* @throws ApiError
|
|
6957
|
-
*/
|
|
6958
|
-
static aiFinetuningV1OrgUserTrainingsCreate(org, username, requestBody) {
|
|
6959
|
-
return request(OpenAPI, {
|
|
6960
|
-
method: 'POST',
|
|
6961
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/',
|
|
6962
|
-
path: {
|
|
6963
|
-
'org': org,
|
|
6964
|
-
'username': username
|
|
6965
|
-
},
|
|
6966
|
-
body: requestBody,
|
|
6967
|
-
mediaType: 'application/json'
|
|
6968
|
-
});
|
|
6969
|
-
}
|
|
6970
|
-
/**
|
|
6971
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6972
|
-
* @param id A UUID string identifying this training.
|
|
6973
|
-
* @param org
|
|
6974
|
-
* @param username
|
|
6975
|
-
* @returns Training
|
|
6976
|
-
* @throws ApiError
|
|
6977
|
-
*/
|
|
6978
|
-
static aiFinetuningV1OrgUserTrainingsRetrieve(id, org, username) {
|
|
6979
|
-
return request(OpenAPI, {
|
|
6980
|
-
method: 'GET',
|
|
6981
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
|
|
6982
|
-
path: {
|
|
6983
|
-
'id': id,
|
|
6984
|
-
'org': org,
|
|
6985
|
-
'username': username
|
|
6986
|
-
}
|
|
6987
|
-
});
|
|
6988
|
-
}
|
|
6989
|
-
/**
|
|
6990
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6991
|
-
* @param id A UUID string identifying this training.
|
|
6992
|
-
* @param org
|
|
6993
|
-
* @param username
|
|
6994
|
-
* @param requestBody
|
|
6995
|
-
* @returns TrainingCreate
|
|
6996
|
-
* @throws ApiError
|
|
6997
|
-
*/
|
|
6998
|
-
static aiFinetuningV1OrgUserTrainingsUpdate(id, org, username, requestBody) {
|
|
6999
|
-
return request(OpenAPI, {
|
|
7000
|
-
method: 'PUT',
|
|
7001
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
|
|
7002
|
-
path: {
|
|
7003
|
-
'id': id,
|
|
7004
|
-
'org': org,
|
|
7005
|
-
'username': username
|
|
7006
|
-
},
|
|
7007
|
-
body: requestBody,
|
|
7008
|
-
mediaType: 'application/json'
|
|
7009
|
-
});
|
|
7010
|
-
}
|
|
7011
|
-
/**
|
|
7012
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
7013
|
-
* @param id A UUID string identifying this training.
|
|
7014
|
-
* @param org
|
|
7015
|
-
* @param username
|
|
7016
|
-
* @param requestBody
|
|
7017
|
-
* @returns TrainingCreate
|
|
7018
|
-
* @throws ApiError
|
|
7019
|
-
*/
|
|
7020
|
-
static aiFinetuningV1OrgUserTrainingsPartialUpdate(id, org, username, requestBody) {
|
|
7021
|
-
return request(OpenAPI, {
|
|
7022
|
-
method: 'PATCH',
|
|
7023
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
|
|
7024
|
-
path: {
|
|
7025
|
-
'id': id,
|
|
7026
|
-
'org': org,
|
|
7027
|
-
'username': username
|
|
7028
|
-
},
|
|
7029
|
-
body: requestBody,
|
|
7030
|
-
mediaType: 'application/json'
|
|
7031
|
-
});
|
|
7032
|
-
}
|
|
7033
|
-
/**
|
|
7034
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
7035
|
-
* @param id A UUID string identifying this training.
|
|
7036
|
-
* @param org
|
|
7037
|
-
* @param username
|
|
7038
|
-
* @returns void
|
|
7039
|
-
* @throws ApiError
|
|
7040
|
-
*/
|
|
7041
|
-
static aiFinetuningV1OrgUserTrainingsDestroy(id, org, username) {
|
|
7042
|
-
return request(OpenAPI, {
|
|
7043
|
-
method: 'DELETE',
|
|
7044
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
|
|
7045
|
-
path: {
|
|
7046
|
-
'id': id,
|
|
7047
|
-
'org': org,
|
|
7048
|
-
'username': username
|
|
7049
|
-
}
|
|
7050
|
-
});
|
|
7051
|
-
}
|
|
7052
|
-
/**
|
|
7053
|
-
* Retrieves a paginated list of completed fine-tuned models, excluding those without a fine-tuned model.
|
|
7054
|
-
* Filtering and pagination is allowed.
|
|
7055
|
-
*
|
|
7056
|
-
* NB: This is only a helper endpoint. The same functionality can be achieved with the appropriate filters using the
|
|
7057
|
-
* training list endpoint.
|
|
7058
|
-
* Returns:
|
|
7059
|
-
* Response: A paginated response containing the serialized fine-tuned models.
|
|
7060
|
-
* @param org
|
|
7061
|
-
* @param username
|
|
7062
|
-
* @returns Training
|
|
7063
|
-
* @throws ApiError
|
|
7064
|
-
*/
|
|
7065
|
-
static aiFinetuningV1OrgUserTrainingsFinetunedModelsRetrieve(org, username) {
|
|
7066
|
-
return request(OpenAPI, {
|
|
7067
|
-
method: 'GET',
|
|
7068
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/finetuned-models/',
|
|
7069
|
-
path: {
|
|
7070
|
-
'org': org,
|
|
7071
|
-
'username': username
|
|
7072
|
-
}
|
|
7073
|
-
});
|
|
7074
|
-
}
|
|
7075
|
-
}
|
|
7076
|
-
|
|
7077
|
-
class AiIndexService {
|
|
7078
|
-
/**
|
|
7079
|
-
* Retrieve details of a specific document embedding.
|
|
7080
|
-
*
|
|
7081
|
-
* This endpoint returns detailed information about a specific
|
|
7082
|
-
* document embedding identified by its ID.
|
|
7083
|
-
*
|
|
7084
|
-
* Args:
|
|
7085
|
-
* request: The HTTP request.
|
|
7086
|
-
* org: Organization key identifier.
|
|
7087
|
-
* document_id: The ID of the document embedding to retrieve.
|
|
7088
|
-
*
|
|
7089
|
-
* Returns:
|
|
7090
|
-
* Response: Detailed information about the document embedding.
|
|
7091
|
-
*
|
|
7092
|
-
* Raises:
|
|
7093
|
-
* NotFound: If the specified document embedding does not exist.
|
|
7094
|
-
* @param documentId
|
|
7095
|
-
* @param org
|
|
7096
|
-
* @param userId
|
|
7097
|
-
* @returns RetrieverDocumentEmbedding
|
|
7098
|
-
* @throws ApiError
|
|
7099
|
-
*/
|
|
7100
|
-
static aiIndexOrgsUsersDocumentsRetrieve(documentId, org, userId) {
|
|
7101
|
-
return request(OpenAPI, {
|
|
7102
|
-
method: 'GET',
|
|
7103
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
|
|
7104
|
-
path: {
|
|
7105
|
-
'document_id': documentId,
|
|
7106
|
-
'org': org,
|
|
7107
|
-
'user_id': userId
|
|
7108
|
-
},
|
|
7109
|
-
errors: {
|
|
7110
|
-
404: `Document not found`
|
|
7111
|
-
}
|
|
7112
|
-
});
|
|
7113
|
-
}
|
|
7114
|
-
/**
|
|
7115
|
-
* Update a specific document embedding.
|
|
7116
|
-
*
|
|
7117
|
-
* This endpoint allows updating various properties of a document embedding,
|
|
7118
|
-
* including its name, type, pathway, and training status.
|
|
7119
|
-
*
|
|
7120
|
-
* Args:
|
|
7121
|
-
* request: The HTTP request containing the updated document data.
|
|
7122
|
-
* org: Organization key identifier.
|
|
7123
|
-
* document_id: The ID of the document embedding to update.
|
|
7124
|
-
*
|
|
7125
|
-
* Returns:
|
|
7126
|
-
* Response: The updated document embedding information.
|
|
7127
|
-
*
|
|
7128
|
-
* Raises:
|
|
7129
|
-
* BadRequest: If the provided data is invalid.
|
|
7130
|
-
* NotFound: If the specified document embedding does not exist.
|
|
7131
|
-
* @param documentId
|
|
7132
|
-
* @param org
|
|
7133
|
-
* @param userId
|
|
7134
|
-
* @param formData
|
|
7135
|
-
* @returns RetrieverDocumentEmbedding
|
|
7136
|
-
* @throws ApiError
|
|
7137
|
-
*/
|
|
7138
|
-
static aiIndexOrgsUsersDocumentsUpdate(documentId, org, userId, formData) {
|
|
7139
|
-
return request(OpenAPI, {
|
|
7140
|
-
method: 'PUT',
|
|
7141
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
|
|
7142
|
-
path: {
|
|
7143
|
-
'document_id': documentId,
|
|
7144
|
-
'org': org,
|
|
7145
|
-
'user_id': userId
|
|
7146
|
-
},
|
|
7147
|
-
formData: formData,
|
|
7148
|
-
mediaType: 'multipart/form-data',
|
|
7149
|
-
errors: {
|
|
7150
|
-
400: `Invalid request data`,
|
|
7151
|
-
404: `Document not found`
|
|
7152
|
-
}
|
|
7153
|
-
});
|
|
7154
|
-
}
|
|
7155
|
-
/**
|
|
7156
|
-
* Delete a specific document embedding.
|
|
7157
|
-
*
|
|
7158
|
-
* This endpoint removes a document embedding from the system,
|
|
7159
|
-
* including untraining it from any associated pathways.
|
|
7160
|
-
*
|
|
7161
|
-
* Args:
|
|
7162
|
-
* request: The HTTP request.
|
|
7163
|
-
* org: Organization key identifier.
|
|
7164
|
-
* document_id: The ID of the document embedding to delete.
|
|
7165
|
-
*
|
|
7166
|
-
* Returns:
|
|
7167
|
-
* Response: An empty response with a 204 status code if successful.
|
|
7168
|
-
*
|
|
7169
|
-
* Raises:
|
|
7170
|
-
* NotFound: If the specified document embedding does not exist.
|
|
7171
|
-
* @param documentId
|
|
7172
|
-
* @param org
|
|
7173
|
-
* @param userId
|
|
7174
|
-
* @returns void
|
|
7175
|
-
* @throws ApiError
|
|
7176
|
-
*/
|
|
7177
|
-
static aiIndexOrgsUsersDocumentsDestroy(documentId, org, userId) {
|
|
7178
|
-
return request(OpenAPI, {
|
|
7179
|
-
method: 'DELETE',
|
|
7180
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
|
|
7181
|
-
path: {
|
|
7182
|
-
'document_id': documentId,
|
|
7183
|
-
'org': org,
|
|
7184
|
-
'user_id': userId
|
|
7185
|
-
},
|
|
7186
|
-
errors: {
|
|
7187
|
-
404: `Document not found`
|
|
7188
|
-
}
|
|
7189
|
-
});
|
|
7190
|
-
}
|
|
7191
|
-
/**
|
|
7192
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
7193
|
-
* @param documentId
|
|
7194
|
-
* @param org
|
|
7195
|
-
* @param userId
|
|
7196
|
-
* @returns DocumentSettingsResponse
|
|
7197
|
-
* @throws ApiError
|
|
7198
|
-
*/
|
|
7199
|
-
static aiIndexOrgsUsersDocumentsSettingsRetrieve(documentId, org, userId) {
|
|
7200
|
-
return request(OpenAPI, {
|
|
7201
|
-
method: 'GET',
|
|
7202
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/',
|
|
7203
|
-
path: {
|
|
7204
|
-
'document_id': documentId,
|
|
7205
|
-
'org': org,
|
|
7206
|
-
'user_id': userId
|
|
7207
|
-
}
|
|
7208
|
-
});
|
|
7209
|
-
}
|
|
7210
|
-
/**
|
|
7211
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
7212
|
-
* @param documentId
|
|
7213
|
-
* @param org
|
|
7214
|
-
* @param userId
|
|
7215
|
-
* @param requestBody
|
|
7216
|
-
* @returns DocumentSettingsResponse
|
|
7217
|
-
* @throws ApiError
|
|
7218
|
-
*/
|
|
7219
|
-
static aiIndexOrgsUsersDocumentsSettingsCreate(documentId, org, userId, requestBody) {
|
|
7220
|
-
return request(OpenAPI, {
|
|
7221
|
-
method: 'POST',
|
|
7222
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/',
|
|
7223
|
-
path: {
|
|
7224
|
-
'document_id': documentId,
|
|
7225
|
-
'org': org,
|
|
7226
|
-
'user_id': userId
|
|
7227
|
-
},
|
|
7228
|
-
body: requestBody,
|
|
7229
|
-
mediaType: 'application/json'
|
|
7230
|
-
});
|
|
7231
|
-
}
|
|
7232
|
-
/**
|
|
7233
|
-
* Train a graph-based document through a worker process.
|
|
7234
|
-
*
|
|
7235
|
-
* This endpoint queues graph-based documents for training through a
|
|
7236
|
-
* specialized worker process that handles knowledge graph processing.
|
|
7237
|
-
*
|
|
7238
|
-
* Args:
|
|
7239
|
-
* request: The HTTP request containing the document information.
|
|
7240
|
-
* org: Organization key identifier.
|
|
7241
|
-
*
|
|
7242
|
-
* Returns:
|
|
7243
|
-
* Response: A confirmation that the document was queued for training,
|
|
7244
|
-
* including a task ID for tracking the progress.
|
|
7245
|
-
*
|
|
7246
|
-
* Raises:
|
|
7247
|
-
* ValidationError: If the request data is invalid.
|
|
7248
|
-
* BadRequest: If there was an error processing the document.
|
|
7249
|
-
* @param org
|
|
7250
|
-
* @param userId
|
|
7251
|
-
* @param formData
|
|
7252
|
-
* @returns TrainDocumentViewResponse
|
|
7253
|
-
* @throws ApiError
|
|
7254
|
-
*/
|
|
7255
|
-
static aiIndexOrgsUsersDocumentsGraphTrainCreate(org, userId, formData) {
|
|
7256
|
-
return request(OpenAPI, {
|
|
7257
|
-
method: 'POST',
|
|
7258
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/graph-train/',
|
|
7259
|
-
path: {
|
|
7260
|
-
'org': org,
|
|
7261
|
-
'user_id': userId
|
|
7262
|
-
},
|
|
7263
|
-
formData: formData,
|
|
7264
|
-
mediaType: 'multipart/form-data',
|
|
7265
|
-
errors: {
|
|
7266
|
-
400: `Invalid request data or document processing error`
|
|
7267
|
-
}
|
|
7268
|
-
});
|
|
7269
|
-
}
|
|
7270
|
-
/**
|
|
7271
|
-
* Retrieve a list of document embeddings for a specific pathway.
|
|
7272
|
-
*
|
|
7273
|
-
* This endpoint returns a paginated list of all document embeddings
|
|
7274
|
-
* that have been created for the specified pathway within the organization.
|
|
7275
|
-
*
|
|
7276
|
-
* Args:
|
|
7277
|
-
* request: The HTTP request.
|
|
7278
|
-
* org: Organization key identifier.
|
|
7279
|
-
* pathway: The pathway to retrieve document embeddings for.
|
|
7280
|
-
*
|
|
7281
|
-
* Returns:
|
|
7282
|
-
* Response: A paginated list of document embeddings for the pathway.
|
|
7283
|
-
* @param org
|
|
7284
|
-
* @param pathway
|
|
7285
|
-
* @param userId
|
|
7286
|
-
* @returns RetrieverDocumentEmbedding
|
|
7287
|
-
* @throws ApiError
|
|
7288
|
-
*/
|
|
7289
|
-
static aiIndexOrgsUsersDocumentsPathwaysList(org, pathway, userId) {
|
|
7290
|
-
return request(OpenAPI, {
|
|
7291
|
-
method: 'GET',
|
|
7292
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/pathways/{pathway}/',
|
|
7293
|
-
path: {
|
|
7294
|
-
'org': org,
|
|
7295
|
-
'pathway': pathway,
|
|
7296
|
-
'user_id': userId
|
|
7297
|
-
}
|
|
7298
|
-
});
|
|
7299
|
-
}
|
|
7300
|
-
/**
|
|
7301
|
-
* Retrieve resource documents similar to the given query.
|
|
7302
|
-
*
|
|
7303
|
-
* This endpoint performs a semantic search to find documents that are
|
|
7304
|
-
* relevant to the provided query within the specified pathway.
|
|
7305
|
-
*
|
|
7306
|
-
* Args:
|
|
7307
|
-
* request: The HTTP request containing the search query.
|
|
7308
|
-
* org: Organization key identifier.
|
|
7309
|
-
*
|
|
7310
|
-
* Returns:
|
|
7311
|
-
* Response: A list of documents relevant to the search query.
|
|
7312
|
-
*
|
|
7313
|
-
* Raises:
|
|
7314
|
-
* ValidationError: If the request data is invalid.
|
|
7315
|
-
* @param org
|
|
7316
|
-
* @param userId
|
|
7317
|
-
* @param requestBody
|
|
7318
|
-
* @returns RetrieverResponseSearch
|
|
7319
|
-
* @throws ApiError
|
|
7320
|
-
*/
|
|
7321
|
-
static aiIndexOrgsUsersDocumentsSearchCreate(org, userId, requestBody) {
|
|
7322
|
-
return request(OpenAPI, {
|
|
7323
|
-
method: 'POST',
|
|
7324
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/search/',
|
|
7325
|
-
path: {
|
|
7326
|
-
'org': org,
|
|
7327
|
-
'user_id': userId
|
|
5992
|
+
'org': org,
|
|
5993
|
+
'user_id': userId
|
|
7328
5994
|
},
|
|
7329
5995
|
body: requestBody,
|
|
7330
5996
|
mediaType: 'application/json',
|
|
@@ -17551,7 +16217,7 @@ class CatalogService {
|
|
|
17551
16217
|
}
|
|
17552
16218
|
/**
|
|
17553
16219
|
* Remove a course from the database.
|
|
17554
|
-
* @param courseId
|
|
16220
|
+
* @param courseId The unique identifier for the course to be deleted
|
|
17555
16221
|
* @param org Filter courses by their associated organization
|
|
17556
16222
|
* @param slug Filter courses by their slug (case-insensitive)
|
|
17557
16223
|
* @returns CourseDeleteResponse
|
|
@@ -17602,7 +16268,7 @@ class CatalogService {
|
|
|
17602
16268
|
* @param org Organization of the course
|
|
17603
16269
|
* @param userId User ID to check eligibility for
|
|
17604
16270
|
* @param username Username to check eligibility for
|
|
17605
|
-
* @returns
|
|
16271
|
+
* @returns any
|
|
17606
16272
|
* @throws ApiError
|
|
17607
16273
|
*/
|
|
17608
16274
|
static catalogEligibilityCoursesCheckRetrieve(courseId, localOnly, org, userId, username) {
|
|
@@ -18036,7 +16702,7 @@ class CatalogService {
|
|
|
18036
16702
|
* @param sort Field to sort results by
|
|
18037
16703
|
* @param userId Filter enrollments by user ID
|
|
18038
16704
|
* @param username Filter enrollments by username
|
|
18039
|
-
* @returns
|
|
16705
|
+
* @returns ProgramEnrollmentSearchResponse
|
|
18040
16706
|
* @throws ApiError
|
|
18041
16707
|
*/
|
|
18042
16708
|
static catalogEnrollmentProgramsSearchRetrieve(includeDefaultPlatform, org, page, pageSize, platformKey, programId, programType, slug, sort = '-id', userId, username) {
|
|
@@ -18133,13 +16799,19 @@ class CatalogService {
|
|
|
18133
16799
|
}
|
|
18134
16800
|
/**
|
|
18135
16801
|
* Retrieve auto increment information for a specific platform.
|
|
16802
|
+
* @param key Platform key identifier
|
|
16803
|
+
* @param org Platform organization identifier
|
|
18136
16804
|
* @returns CatalogAutoIncrementResponse
|
|
18137
16805
|
* @throws ApiError
|
|
18138
16806
|
*/
|
|
18139
|
-
static catalogIncrementRetrieve() {
|
|
16807
|
+
static catalogIncrementRetrieve(key, org) {
|
|
18140
16808
|
return request(OpenAPI, {
|
|
18141
16809
|
method: 'GET',
|
|
18142
16810
|
url: '/api/catalog/increment/',
|
|
16811
|
+
query: {
|
|
16812
|
+
'key': key,
|
|
16813
|
+
'org': org
|
|
16814
|
+
},
|
|
18143
16815
|
errors: {
|
|
18144
16816
|
404: `No response body`
|
|
18145
16817
|
}
|
|
@@ -18148,7 +16820,7 @@ class CatalogService {
|
|
|
18148
16820
|
/**
|
|
18149
16821
|
* Update auto increment information and retrieve a new ID for a specific platform.
|
|
18150
16822
|
* @param requestBody
|
|
18151
|
-
* @returns
|
|
16823
|
+
* @returns number
|
|
18152
16824
|
* @throws ApiError
|
|
18153
16825
|
*/
|
|
18154
16826
|
static catalogIncrementCreate(requestBody) {
|
|
@@ -18156,11 +16828,7 @@ class CatalogService {
|
|
|
18156
16828
|
method: 'POST',
|
|
18157
16829
|
url: '/api/catalog/increment/',
|
|
18158
16830
|
body: requestBody,
|
|
18159
|
-
mediaType: 'application/json'
|
|
18160
|
-
errors: {
|
|
18161
|
-
400: `No response body`,
|
|
18162
|
-
500: `No response body`
|
|
18163
|
-
}
|
|
16831
|
+
mediaType: 'application/json'
|
|
18164
16832
|
});
|
|
18165
16833
|
}
|
|
18166
16834
|
/**
|
|
@@ -20502,184 +19170,178 @@ class CatalogService {
|
|
|
20502
19170
|
});
|
|
20503
19171
|
}
|
|
20504
19172
|
/**
|
|
20505
|
-
*
|
|
20506
|
-
*
|
|
20507
|
-
*
|
|
20508
|
-
*
|
|
20509
|
-
*
|
|
20510
|
-
*
|
|
20511
|
-
* If the program cannot be found, a 404 status code is returned.
|
|
20512
|
-
*
|
|
20513
|
-
* Params:
|
|
20514
|
-
* program_id: The unique identifier for the program.
|
|
20515
|
-
* org: The organization associated with the program.
|
|
20516
|
-
*
|
|
20517
|
-
* Returns:
|
|
20518
|
-
* A JSON response containing the program metadata if successful, or an
|
|
20519
|
-
* appropriate error status code.
|
|
20520
|
-
*
|
|
20521
|
-
* TODO: program-key compatibility
|
|
20522
|
-
* @returns any No response body
|
|
19173
|
+
* Retrieve metadata for a specified program
|
|
19174
|
+
* @param programId The unique identifier for the program
|
|
19175
|
+
* @param org The organization associated with the program
|
|
19176
|
+
* @param platformKey Platform key identifier (alternative to org)
|
|
19177
|
+
* @param programKey Program key (alternative to program_id + org)
|
|
19178
|
+
* @returns ProgramMetadataResponse
|
|
20523
19179
|
* @throws ApiError
|
|
20524
19180
|
*/
|
|
20525
|
-
static catalogMetadataProgramRetrieve() {
|
|
19181
|
+
static catalogMetadataProgramRetrieve(programId, org, platformKey, programKey) {
|
|
20526
19182
|
return request(OpenAPI, {
|
|
20527
19183
|
method: 'GET',
|
|
20528
|
-
url: '/api/catalog/metadata/program/'
|
|
19184
|
+
url: '/api/catalog/metadata/program/',
|
|
19185
|
+
query: {
|
|
19186
|
+
'org': org,
|
|
19187
|
+
'platform_key': platformKey,
|
|
19188
|
+
'program_id': programId,
|
|
19189
|
+
'program_key': programKey
|
|
19190
|
+
},
|
|
19191
|
+
errors: {
|
|
19192
|
+
400: `Missing or invalid parameters`,
|
|
19193
|
+
401: `Unauthorized`,
|
|
19194
|
+
403: `Permission denied`,
|
|
19195
|
+
404: `Program not found`
|
|
19196
|
+
}
|
|
20529
19197
|
});
|
|
20530
19198
|
}
|
|
20531
19199
|
/**
|
|
20532
|
-
*
|
|
20533
|
-
*
|
|
20534
|
-
*
|
|
20535
|
-
*
|
|
20536
|
-
*
|
|
20537
|
-
*
|
|
20538
|
-
*
|
|
20539
|
-
* field parameter is provided, a 404 status code is returned as field
|
|
20540
|
-
* updates are not supported.
|
|
20541
|
-
*
|
|
20542
|
-
* Params:
|
|
20543
|
-
* program_id: The unique identifier for the program.
|
|
20544
|
-
* org: The organization associated with the program.
|
|
20545
|
-
* metadata: The new metadata to update the program with.
|
|
20546
|
-
* update (optional): A flag indicating whether to update the metadata.
|
|
20547
|
-
*
|
|
20548
|
-
* Returns:
|
|
20549
|
-
* A JSON response containing the updated program metadata if successful,
|
|
20550
|
-
* or an appropriate error status code.
|
|
20551
|
-
*
|
|
20552
|
-
* TODO: program-key compatibility
|
|
20553
|
-
* @returns any No response body
|
|
19200
|
+
* Update metadata for a specified program
|
|
19201
|
+
* @param programId The unique identifier for the program
|
|
19202
|
+
* @param requestBody
|
|
19203
|
+
* @param org The organization associated with the program
|
|
19204
|
+
* @param platformKey Platform key identifier (alternative to org)
|
|
19205
|
+
* @param programKey Program key (alternative to program_id + org)
|
|
19206
|
+
* @returns ProgramMetadataResponse
|
|
20554
19207
|
* @throws ApiError
|
|
20555
19208
|
*/
|
|
20556
|
-
static catalogMetadataProgramCreate() {
|
|
19209
|
+
static catalogMetadataProgramCreate(programId, requestBody, org, platformKey, programKey) {
|
|
20557
19210
|
return request(OpenAPI, {
|
|
20558
19211
|
method: 'POST',
|
|
20559
|
-
url: '/api/catalog/metadata/program/'
|
|
19212
|
+
url: '/api/catalog/metadata/program/',
|
|
19213
|
+
query: {
|
|
19214
|
+
'org': org,
|
|
19215
|
+
'platform_key': platformKey,
|
|
19216
|
+
'program_id': programId,
|
|
19217
|
+
'program_key': programKey
|
|
19218
|
+
},
|
|
19219
|
+
body: requestBody,
|
|
19220
|
+
mediaType: 'application/json',
|
|
19221
|
+
errors: {
|
|
19222
|
+
400: `Missing or invalid parameters`,
|
|
19223
|
+
401: `Unauthorized`,
|
|
19224
|
+
403: `Permission denied`,
|
|
19225
|
+
404: `Program not found`
|
|
19226
|
+
}
|
|
20560
19227
|
});
|
|
20561
19228
|
}
|
|
20562
19229
|
/**
|
|
20563
|
-
*
|
|
20564
|
-
*
|
|
20565
|
-
*
|
|
20566
|
-
*
|
|
20567
|
-
*
|
|
20568
|
-
*
|
|
20569
|
-
*
|
|
20570
|
-
* Params:
|
|
20571
|
-
* - program_id: The unique identifier for the program.
|
|
20572
|
-
* - org: The organization associated with the program.
|
|
20573
|
-
*
|
|
20574
|
-
* Returns:
|
|
20575
|
-
* - 200: Successfully retrieved the program metadata.
|
|
20576
|
-
* - 400: Bad request if the program ID is not provided.
|
|
20577
|
-
* - 404: Not found if the program or its metadata cannot be retrieved.
|
|
20578
|
-
*
|
|
20579
|
-
* TODO: Implement program-key compatibility for enhanced querying.
|
|
20580
|
-
* @returns any No response body
|
|
19230
|
+
* Retrieve public metadata for a specified program
|
|
19231
|
+
* @param programId The unique identifier for the program
|
|
19232
|
+
* @param org The organization associated with the program
|
|
19233
|
+
* @param platformKey Platform key identifier (alternative to org)
|
|
19234
|
+
* @param programKey Program key (alternative to program_id + org)
|
|
19235
|
+
* @returns ProgramMetadataResponse
|
|
20581
19236
|
* @throws ApiError
|
|
20582
19237
|
*/
|
|
20583
|
-
static catalogMetadataProgramPublicRetrieve() {
|
|
19238
|
+
static catalogMetadataProgramPublicRetrieve(programId, org, platformKey, programKey) {
|
|
20584
19239
|
return request(OpenAPI, {
|
|
20585
19240
|
method: 'GET',
|
|
20586
|
-
url: '/api/catalog/metadata/program-public/'
|
|
19241
|
+
url: '/api/catalog/metadata/program-public/',
|
|
19242
|
+
query: {
|
|
19243
|
+
'org': org,
|
|
19244
|
+
'platform_key': platformKey,
|
|
19245
|
+
'program_id': programId,
|
|
19246
|
+
'program_key': programKey
|
|
19247
|
+
},
|
|
19248
|
+
errors: {
|
|
19249
|
+
400: `Missing or invalid parameters`,
|
|
19250
|
+
404: `Program not found or no public metadata available`
|
|
19251
|
+
}
|
|
20587
19252
|
});
|
|
20588
19253
|
}
|
|
20589
19254
|
/**
|
|
20590
|
-
*
|
|
20591
|
-
* Query public program metadata.
|
|
20592
|
-
*
|
|
20593
|
-
* This method retrieves public metadata for a specified program. It requires
|
|
20594
|
-
* a program ID and optionally an organization to identify the program. The
|
|
20595
|
-
* metadata is filtered to include only public fields.
|
|
20596
|
-
*
|
|
20597
|
-
* Params:
|
|
20598
|
-
* - program_id: The unique identifier for the program.
|
|
20599
|
-
* - org: The organization associated with the program.
|
|
20600
|
-
*
|
|
20601
|
-
* Returns:
|
|
20602
|
-
* - 200: Successfully retrieved the program metadata.
|
|
20603
|
-
* - 400: Bad request if the program ID is not provided.
|
|
20604
|
-
* - 404: Not found if the program or its metadata cannot be retrieved.
|
|
20605
|
-
*
|
|
20606
|
-
* TODO: Implement program-key compatibility for enhanced querying.
|
|
19255
|
+
* Retrieve public metadata for a specified program
|
|
20607
19256
|
* @param field
|
|
20608
|
-
* @
|
|
19257
|
+
* @param programId The unique identifier for the program
|
|
19258
|
+
* @param org The organization associated with the program
|
|
19259
|
+
* @param platformKey Platform key identifier (alternative to org)
|
|
19260
|
+
* @param programKey Program key (alternative to program_id + org)
|
|
19261
|
+
* @returns ProgramMetadataResponse
|
|
20609
19262
|
* @throws ApiError
|
|
20610
19263
|
*/
|
|
20611
|
-
static catalogMetadataProgramPublicRetrieve2(field) {
|
|
19264
|
+
static catalogMetadataProgramPublicRetrieve2(field, programId, org, platformKey, programKey) {
|
|
20612
19265
|
return request(OpenAPI, {
|
|
20613
19266
|
method: 'GET',
|
|
20614
19267
|
url: '/api/catalog/metadata/program-public/{field}/',
|
|
20615
19268
|
path: {
|
|
20616
19269
|
'field': field
|
|
19270
|
+
},
|
|
19271
|
+
query: {
|
|
19272
|
+
'org': org,
|
|
19273
|
+
'platform_key': platformKey,
|
|
19274
|
+
'program_id': programId,
|
|
19275
|
+
'program_key': programKey
|
|
19276
|
+
},
|
|
19277
|
+
errors: {
|
|
19278
|
+
400: `Missing or invalid parameters`,
|
|
19279
|
+
404: `Program not found or no public metadata available`
|
|
20617
19280
|
}
|
|
20618
19281
|
});
|
|
20619
19282
|
}
|
|
20620
19283
|
/**
|
|
20621
|
-
*
|
|
20622
|
-
* Query program metadata.
|
|
20623
|
-
*
|
|
20624
|
-
* This method retrieves metadata for a specified program. The program is
|
|
20625
|
-
* identified by its program_id and organization (org). If the program_id
|
|
20626
|
-
* is not provided, a 400 status code is returned indicating a bad request.
|
|
20627
|
-
* If the program cannot be found, a 404 status code is returned.
|
|
20628
|
-
*
|
|
20629
|
-
* Params:
|
|
20630
|
-
* program_id: The unique identifier for the program.
|
|
20631
|
-
* org: The organization associated with the program.
|
|
20632
|
-
*
|
|
20633
|
-
* Returns:
|
|
20634
|
-
* A JSON response containing the program metadata if successful, or an
|
|
20635
|
-
* appropriate error status code.
|
|
20636
|
-
*
|
|
20637
|
-
* TODO: program-key compatibility
|
|
19284
|
+
* Retrieve metadata for a specified program
|
|
20638
19285
|
* @param field
|
|
20639
|
-
* @
|
|
19286
|
+
* @param programId The unique identifier for the program
|
|
19287
|
+
* @param org The organization associated with the program
|
|
19288
|
+
* @param platformKey Platform key identifier (alternative to org)
|
|
19289
|
+
* @param programKey Program key (alternative to program_id + org)
|
|
19290
|
+
* @returns ProgramMetadataResponse
|
|
20640
19291
|
* @throws ApiError
|
|
20641
19292
|
*/
|
|
20642
|
-
static catalogMetadataProgramRetrieve2(field) {
|
|
19293
|
+
static catalogMetadataProgramRetrieve2(field, programId, org, platformKey, programKey) {
|
|
20643
19294
|
return request(OpenAPI, {
|
|
20644
19295
|
method: 'GET',
|
|
20645
19296
|
url: '/api/catalog/metadata/program/{field}/',
|
|
20646
19297
|
path: {
|
|
20647
19298
|
'field': field
|
|
19299
|
+
},
|
|
19300
|
+
query: {
|
|
19301
|
+
'org': org,
|
|
19302
|
+
'platform_key': platformKey,
|
|
19303
|
+
'program_id': programId,
|
|
19304
|
+
'program_key': programKey
|
|
19305
|
+
},
|
|
19306
|
+
errors: {
|
|
19307
|
+
400: `Missing or invalid parameters`,
|
|
19308
|
+
401: `Unauthorized`,
|
|
19309
|
+
403: `Permission denied`,
|
|
19310
|
+
404: `Program not found`
|
|
20648
19311
|
}
|
|
20649
19312
|
});
|
|
20650
19313
|
}
|
|
20651
19314
|
/**
|
|
20652
|
-
*
|
|
20653
|
-
* Update program metadata.
|
|
20654
|
-
*
|
|
20655
|
-
* This method updates the metadata for a specified program. The program is
|
|
20656
|
-
* identified by its program_id and organization (org). If the program_id
|
|
20657
|
-
* is not provided, a 400 status code is returned indicating a bad request.
|
|
20658
|
-
* If the program cannot be found, a 404 status code is returned. If the
|
|
20659
|
-
* field parameter is provided, a 404 status code is returned as field
|
|
20660
|
-
* updates are not supported.
|
|
20661
|
-
*
|
|
20662
|
-
* Params:
|
|
20663
|
-
* program_id: The unique identifier for the program.
|
|
20664
|
-
* org: The organization associated with the program.
|
|
20665
|
-
* metadata: The new metadata to update the program with.
|
|
20666
|
-
* update (optional): A flag indicating whether to update the metadata.
|
|
20667
|
-
*
|
|
20668
|
-
* Returns:
|
|
20669
|
-
* A JSON response containing the updated program metadata if successful,
|
|
20670
|
-
* or an appropriate error status code.
|
|
20671
|
-
*
|
|
20672
|
-
* TODO: program-key compatibility
|
|
19315
|
+
* Update metadata for a specified program
|
|
20673
19316
|
* @param field
|
|
20674
|
-
* @
|
|
19317
|
+
* @param programId The unique identifier for the program
|
|
19318
|
+
* @param requestBody
|
|
19319
|
+
* @param org The organization associated with the program
|
|
19320
|
+
* @param platformKey Platform key identifier (alternative to org)
|
|
19321
|
+
* @param programKey Program key (alternative to program_id + org)
|
|
19322
|
+
* @returns ProgramMetadataResponse
|
|
20675
19323
|
* @throws ApiError
|
|
20676
19324
|
*/
|
|
20677
|
-
static catalogMetadataProgramCreate2(field) {
|
|
19325
|
+
static catalogMetadataProgramCreate2(field, programId, requestBody, org, platformKey, programKey) {
|
|
20678
19326
|
return request(OpenAPI, {
|
|
20679
19327
|
method: 'POST',
|
|
20680
19328
|
url: '/api/catalog/metadata/program/{field}/',
|
|
20681
19329
|
path: {
|
|
20682
19330
|
'field': field
|
|
19331
|
+
},
|
|
19332
|
+
query: {
|
|
19333
|
+
'org': org,
|
|
19334
|
+
'platform_key': platformKey,
|
|
19335
|
+
'program_id': programId,
|
|
19336
|
+
'program_key': programKey
|
|
19337
|
+
},
|
|
19338
|
+
body: requestBody,
|
|
19339
|
+
mediaType: 'application/json',
|
|
19340
|
+
errors: {
|
|
19341
|
+
400: `Missing or invalid parameters`,
|
|
19342
|
+
401: `Unauthorized`,
|
|
19343
|
+
403: `Permission denied`,
|
|
19344
|
+
404: `Program not found`
|
|
20683
19345
|
}
|
|
20684
19346
|
});
|
|
20685
19347
|
}
|
|
@@ -21106,25 +19768,65 @@ class CatalogService {
|
|
|
21106
19768
|
}
|
|
21107
19769
|
/**
|
|
21108
19770
|
* Retrieve pathways matching query. Limited parameters.
|
|
19771
|
+
* @param itemId Item ID associated with the pathway
|
|
19772
|
+
* @param name Pathway name
|
|
19773
|
+
* @param pathwayId Pathway ID
|
|
19774
|
+
* @param pathwayUuid Pathway UUID
|
|
19775
|
+
* @param platformKey Platform key
|
|
19776
|
+
* @param slug Pathway slug (case-insensitive)
|
|
19777
|
+
* @param userId User ID of the pathway owner
|
|
19778
|
+
* @param username Username of the pathway owner
|
|
19779
|
+
* @param visible Whether the pathway is visible
|
|
21109
19780
|
* @returns Pathway
|
|
21110
19781
|
* @throws ApiError
|
|
21111
19782
|
*/
|
|
21112
|
-
static catalogPathwaysList() {
|
|
19783
|
+
static catalogPathwaysList(itemId, name, pathwayId, pathwayUuid, platformKey, slug, userId, username, visible) {
|
|
21113
19784
|
return request(OpenAPI, {
|
|
21114
19785
|
method: 'GET',
|
|
21115
|
-
url: '/api/catalog/pathways/'
|
|
19786
|
+
url: '/api/catalog/pathways/',
|
|
19787
|
+
query: {
|
|
19788
|
+
'item_id': itemId,
|
|
19789
|
+
'name': name,
|
|
19790
|
+
'pathway_id': pathwayId,
|
|
19791
|
+
'pathway_uuid': pathwayUuid,
|
|
19792
|
+
'platform_key': platformKey,
|
|
19793
|
+
'slug': slug,
|
|
19794
|
+
'user_id': userId,
|
|
19795
|
+
'username': username,
|
|
19796
|
+
'visible': visible
|
|
19797
|
+
}
|
|
21116
19798
|
});
|
|
21117
19799
|
}
|
|
21118
19800
|
/**
|
|
21119
19801
|
* Add or update a pathway.
|
|
21120
19802
|
* @param requestBody
|
|
19803
|
+
* @param itemId Item ID associated with the pathway
|
|
19804
|
+
* @param name Pathway name
|
|
19805
|
+
* @param pathwayId Pathway ID
|
|
19806
|
+
* @param pathwayUuid Pathway UUID
|
|
19807
|
+
* @param platformKey Platform key
|
|
19808
|
+
* @param slug Pathway slug (case-insensitive)
|
|
19809
|
+
* @param userId User ID of the pathway owner
|
|
19810
|
+
* @param username Username of the pathway owner
|
|
19811
|
+
* @param visible Whether the pathway is visible
|
|
21121
19812
|
* @returns Pathway
|
|
21122
19813
|
* @throws ApiError
|
|
21123
19814
|
*/
|
|
21124
|
-
static catalogPathwaysCreate(requestBody) {
|
|
19815
|
+
static catalogPathwaysCreate(requestBody, itemId, name, pathwayId, pathwayUuid, platformKey, slug, userId, username, visible) {
|
|
21125
19816
|
return request(OpenAPI, {
|
|
21126
19817
|
method: 'POST',
|
|
21127
19818
|
url: '/api/catalog/pathways/',
|
|
19819
|
+
query: {
|
|
19820
|
+
'item_id': itemId,
|
|
19821
|
+
'name': name,
|
|
19822
|
+
'pathway_id': pathwayId,
|
|
19823
|
+
'pathway_uuid': pathwayUuid,
|
|
19824
|
+
'platform_key': platformKey,
|
|
19825
|
+
'slug': slug,
|
|
19826
|
+
'user_id': userId,
|
|
19827
|
+
'username': username,
|
|
19828
|
+
'visible': visible
|
|
19829
|
+
},
|
|
21128
19830
|
body: requestBody,
|
|
21129
19831
|
mediaType: 'application/json',
|
|
21130
19832
|
errors: {
|
|
@@ -21134,13 +19836,33 @@ class CatalogService {
|
|
|
21134
19836
|
}
|
|
21135
19837
|
/**
|
|
21136
19838
|
* Remove a pathway from the database.
|
|
19839
|
+
* @param pathwayId Pathway ID to delete
|
|
19840
|
+
* @param userId User ID of the pathway owner
|
|
19841
|
+
* @param itemId Item ID associated with the pathway
|
|
19842
|
+
* @param name Pathway name
|
|
19843
|
+
* @param pathwayUuid Pathway UUID
|
|
19844
|
+
* @param platformKey Platform key
|
|
19845
|
+
* @param slug Pathway slug (case-insensitive)
|
|
19846
|
+
* @param username Username of the pathway owner
|
|
19847
|
+
* @param visible Whether the pathway is visible
|
|
21137
19848
|
* @returns PathwayDeleteResponse
|
|
21138
19849
|
* @throws ApiError
|
|
21139
19850
|
*/
|
|
21140
|
-
static catalogPathwaysDestroy() {
|
|
19851
|
+
static catalogPathwaysDestroy(pathwayId, userId, itemId, name, pathwayUuid, platformKey, slug, username, visible) {
|
|
21141
19852
|
return request(OpenAPI, {
|
|
21142
19853
|
method: 'DELETE',
|
|
21143
19854
|
url: '/api/catalog/pathways/',
|
|
19855
|
+
query: {
|
|
19856
|
+
'item_id': itemId,
|
|
19857
|
+
'name': name,
|
|
19858
|
+
'pathway_id': pathwayId,
|
|
19859
|
+
'pathway_uuid': pathwayUuid,
|
|
19860
|
+
'platform_key': platformKey,
|
|
19861
|
+
'slug': slug,
|
|
19862
|
+
'user_id': userId,
|
|
19863
|
+
'username': username,
|
|
19864
|
+
'visible': visible
|
|
19865
|
+
},
|
|
21144
19866
|
errors: {
|
|
21145
19867
|
400: `No response body`
|
|
21146
19868
|
}
|
|
@@ -21148,13 +19870,27 @@ class CatalogService {
|
|
|
21148
19870
|
}
|
|
21149
19871
|
/**
|
|
21150
19872
|
* Retrieve programs matching query parameters. Limited parameters include program_id, name, slug, enabled, and org.
|
|
19873
|
+
* @param courseId Course ID contained in the program
|
|
19874
|
+
* @param enabled Whether the program is enabled
|
|
19875
|
+
* @param name Program name
|
|
19876
|
+
* @param org Organization of the program
|
|
19877
|
+
* @param programId Program ID
|
|
19878
|
+
* @param slug Program slug (case-insensitive)
|
|
21151
19879
|
* @returns Program
|
|
21152
19880
|
* @throws ApiError
|
|
21153
19881
|
*/
|
|
21154
|
-
static catalogProgramsList() {
|
|
19882
|
+
static catalogProgramsList(courseId, enabled, name, org, programId, slug) {
|
|
21155
19883
|
return request(OpenAPI, {
|
|
21156
19884
|
method: 'GET',
|
|
21157
|
-
url: '/api/catalog/programs/'
|
|
19885
|
+
url: '/api/catalog/programs/',
|
|
19886
|
+
query: {
|
|
19887
|
+
'course_id': courseId,
|
|
19888
|
+
'enabled': enabled,
|
|
19889
|
+
'name': name,
|
|
19890
|
+
'org': org,
|
|
19891
|
+
'program_id': programId,
|
|
19892
|
+
'slug': slug
|
|
19893
|
+
}
|
|
21158
19894
|
});
|
|
21159
19895
|
}
|
|
21160
19896
|
/**
|
|
@@ -21176,13 +19912,19 @@ class CatalogService {
|
|
|
21176
19912
|
}
|
|
21177
19913
|
/**
|
|
21178
19914
|
* Remove a program from the database. Requires program_id and org as parameters.
|
|
19915
|
+
* @param org Organization of the program
|
|
19916
|
+
* @param programId Program ID to delete
|
|
21179
19917
|
* @returns ProgramDeleteResponse
|
|
21180
19918
|
* @throws ApiError
|
|
21181
19919
|
*/
|
|
21182
|
-
static catalogProgramsDestroy() {
|
|
19920
|
+
static catalogProgramsDestroy(org, programId) {
|
|
21183
19921
|
return request(OpenAPI, {
|
|
21184
19922
|
method: 'DELETE',
|
|
21185
19923
|
url: '/api/catalog/programs/',
|
|
19924
|
+
query: {
|
|
19925
|
+
'org': org,
|
|
19926
|
+
'program_id': programId
|
|
19927
|
+
},
|
|
21186
19928
|
errors: {
|
|
21187
19929
|
400: `No response body`
|
|
21188
19930
|
}
|
|
@@ -21297,12 +20039,12 @@ class CatalogService {
|
|
|
21297
20039
|
}
|
|
21298
20040
|
/**
|
|
21299
20041
|
* Remove a resource from the database.
|
|
21300
|
-
* @param id Resource ID
|
|
20042
|
+
* @param id Resource ID to delete
|
|
21301
20043
|
* @param itemId Item ID associated with the resource
|
|
21302
20044
|
* @param key Platform key
|
|
21303
20045
|
* @param name Resource name
|
|
21304
20046
|
* @param org Platform organization
|
|
21305
|
-
* @param platformKey Platform key
|
|
20047
|
+
* @param platformKey Platform key
|
|
21306
20048
|
* @param platformOrg Platform organization (alternative to org)
|
|
21307
20049
|
* @param resourceType Type of resource
|
|
21308
20050
|
* @param userId User ID who owns the resource
|
|
@@ -21329,63 +20071,38 @@ class CatalogService {
|
|
|
21329
20071
|
});
|
|
21330
20072
|
}
|
|
21331
20073
|
/**
|
|
21332
|
-
*
|
|
21333
|
-
*
|
|
21334
|
-
*
|
|
21335
|
-
*
|
|
21336
|
-
*
|
|
21337
|
-
*
|
|
21338
|
-
*
|
|
21339
|
-
*
|
|
21340
|
-
*
|
|
21341
|
-
*
|
|
21342
|
-
*
|
|
21343
|
-
|
|
21344
|
-
|
|
21345
|
-
* page_size (int, optional): Number of items per page
|
|
21346
|
-
*
|
|
21347
|
-
* Methods:
|
|
21348
|
-
* GET: Retrieve a paginated list of course reviews with filtering
|
|
21349
|
-
*
|
|
21350
|
-
* Returns:
|
|
21351
|
-
* GET: A paginated JSON response containing course reviews:
|
|
21352
|
-
* {
|
|
21353
|
-
* "count": 15,
|
|
21354
|
-
* "next": "https://api.example.com/api/catalog/reviews/course/?page=2",
|
|
21355
|
-
* "previous": null,
|
|
21356
|
-
* "results": [
|
|
21357
|
-
* {
|
|
21358
|
-
* "user_id": 123,
|
|
21359
|
-
* "username": "student1",
|
|
21360
|
-
* "content": "This course was excellent and very informative.",
|
|
21361
|
-
* "rating": 4.5,
|
|
21362
|
-
* "title": "Great Course!",
|
|
21363
|
-
* "visible": true,
|
|
21364
|
-
* "created": "2023-01-15T10:30:00Z",
|
|
21365
|
-
* "modified": "2023-01-15T10:30:00Z",
|
|
21366
|
-
* "course_id": "course-v1:org+course+run"
|
|
21367
|
-
* },
|
|
21368
|
-
* ...
|
|
21369
|
-
* ]
|
|
21370
|
-
* }
|
|
21371
|
-
*
|
|
21372
|
-
* Error Responses:
|
|
21373
|
-
* 400 Bad Request: If required parameters are missing or invalid
|
|
21374
|
-
* 401 Unauthorized: If the user is not authenticated
|
|
21375
|
-
* 403 Forbidden: If the user does not have permission to access this resource
|
|
21376
|
-
* 500 Internal Server Error: If an unexpected error occurs
|
|
21377
|
-
*
|
|
21378
|
-
* Access Control:
|
|
21379
|
-
* - Requires IsDMAdmin, IsPlatformAdminReadOnly, or IsPlatformAdminForCourse permission
|
|
21380
|
-
* - Platform admins can view reviews for courses in their platform (read-only)
|
|
21381
|
-
* - DM admins can view all reviews
|
|
21382
|
-
* @returns any No response body
|
|
21383
|
-
* @throws ApiError
|
|
21384
|
-
*/
|
|
21385
|
-
static catalogReviewsCourseRetrieve() {
|
|
20074
|
+
* Retrieve a paginated list of course reviews with filtering options
|
|
20075
|
+
* @param courseId Filter reviews by course ID
|
|
20076
|
+
* @param org Alias for platform_org
|
|
20077
|
+
* @param page Page number for pagination
|
|
20078
|
+
* @param pageSize Number of items per page
|
|
20079
|
+
* @param platformKey Filter reviews by platform key
|
|
20080
|
+
* @param platformOrg Filter reviews by platform organization
|
|
20081
|
+
* @param sort Field to sort results by (default: '-id')
|
|
20082
|
+
* @param userId Filter reviews by user ID
|
|
20083
|
+
* @returns CourseReviewPaginatedResponse
|
|
20084
|
+
* @throws ApiError
|
|
20085
|
+
*/
|
|
20086
|
+
static catalogReviewsCourseRetrieve(courseId, org, page, pageSize, platformKey, platformOrg, sort = '-id', userId) {
|
|
21386
20087
|
return request(OpenAPI, {
|
|
21387
20088
|
method: 'GET',
|
|
21388
|
-
url: '/api/catalog/reviews/course/'
|
|
20089
|
+
url: '/api/catalog/reviews/course/',
|
|
20090
|
+
query: {
|
|
20091
|
+
'course_id': courseId,
|
|
20092
|
+
'org': org,
|
|
20093
|
+
'page': page,
|
|
20094
|
+
'page_size': pageSize,
|
|
20095
|
+
'platform_key': platformKey,
|
|
20096
|
+
'platform_org': platformOrg,
|
|
20097
|
+
'sort': sort,
|
|
20098
|
+
'user_id': userId
|
|
20099
|
+
},
|
|
20100
|
+
errors: {
|
|
20101
|
+
400: `Invalid parameters`,
|
|
20102
|
+
401: `Unauthorized`,
|
|
20103
|
+
403: `Permission denied`,
|
|
20104
|
+
500: `Internal server error`
|
|
20105
|
+
}
|
|
21389
20106
|
});
|
|
21390
20107
|
}
|
|
21391
20108
|
/**
|
|
@@ -21408,177 +20125,83 @@ class CatalogService {
|
|
|
21408
20125
|
});
|
|
21409
20126
|
}
|
|
21410
20127
|
/**
|
|
21411
|
-
*
|
|
21412
|
-
*
|
|
21413
|
-
*
|
|
21414
|
-
*
|
|
21415
|
-
|
|
21416
|
-
|
|
21417
|
-
* DELETE: Delete a course review
|
|
21418
|
-
*
|
|
21419
|
-
* Request Body (POST):
|
|
21420
|
-
* A JSON object containing:
|
|
21421
|
-
* - course_id (str, required): The course ID to review
|
|
21422
|
-
* - username (str, required): The username of the reviewer
|
|
21423
|
-
* - rating (float, optional): The rating value (typically 1-5)
|
|
21424
|
-
* - title (str, optional): The review title
|
|
21425
|
-
* - content (str, optional): The review content/text
|
|
21426
|
-
* - visible (bool, optional): Whether the review is visible (default: true)
|
|
21427
|
-
*
|
|
21428
|
-
* Query Parameters (DELETE):
|
|
21429
|
-
* course_id (str, required): The course ID of the review to delete
|
|
21430
|
-
* username (str, required): The username of the reviewer
|
|
21431
|
-
*
|
|
21432
|
-
* Returns:
|
|
21433
|
-
* POST: A JSON response containing the created/updated review:
|
|
21434
|
-
* {
|
|
21435
|
-
* "user_id": 123,
|
|
21436
|
-
* "username": "student1",
|
|
21437
|
-
* "content": "This course was excellent and very informative.",
|
|
21438
|
-
* "rating": 4.5,
|
|
21439
|
-
* "title": "Great Course!",
|
|
21440
|
-
* "visible": true,
|
|
21441
|
-
* "created": "2023-01-15T10:30:00Z",
|
|
21442
|
-
* "modified": "2023-01-15T10:30:00Z",
|
|
21443
|
-
* "course_id": "course-v1:org+course+run"
|
|
21444
|
-
* }
|
|
21445
|
-
*
|
|
21446
|
-
* DELETE: A success response with status 200
|
|
21447
|
-
*
|
|
21448
|
-
* Error Responses:
|
|
21449
|
-
* 400 Bad Request: If required parameters are missing or invalid
|
|
21450
|
-
* 401 Unauthorized: If the user is not authenticated
|
|
21451
|
-
* 403 Forbidden: If the user does not have permission to manage this review
|
|
21452
|
-
* 500 Internal Server Error: If an unexpected error occurs during review operations
|
|
21453
|
-
*
|
|
21454
|
-
* Access Control:
|
|
21455
|
-
* - Requires IsDMAdmin or IsEdxUserReadWriteDelete permission
|
|
21456
|
-
* - Users can create, update, or delete their own reviews
|
|
21457
|
-
* - DM admins can manage all reviews
|
|
21458
|
-
* @returns any No response body
|
|
21459
|
-
* @throws ApiError
|
|
21460
|
-
*/
|
|
21461
|
-
static catalogReviewsCourseUpdateCreate() {
|
|
20128
|
+
* Create or update a course review
|
|
20129
|
+
* @param requestBody
|
|
20130
|
+
* @returns CourseReviewResponse
|
|
20131
|
+
* @throws ApiError
|
|
20132
|
+
*/
|
|
20133
|
+
static catalogReviewsCourseUpdateCreate(requestBody) {
|
|
21462
20134
|
return request(OpenAPI, {
|
|
21463
20135
|
method: 'POST',
|
|
21464
|
-
url: '/api/catalog/reviews/course/update/'
|
|
20136
|
+
url: '/api/catalog/reviews/course/update/',
|
|
20137
|
+
body: requestBody,
|
|
20138
|
+
mediaType: 'application/json',
|
|
20139
|
+
errors: {
|
|
20140
|
+
400: `Invalid parameters`,
|
|
20141
|
+
401: `Unauthorized`,
|
|
20142
|
+
403: `Permission denied`,
|
|
20143
|
+
500: `Review could not be saved`
|
|
20144
|
+
}
|
|
21465
20145
|
});
|
|
21466
20146
|
}
|
|
21467
20147
|
/**
|
|
21468
|
-
*
|
|
21469
|
-
*
|
|
21470
|
-
*
|
|
21471
|
-
*
|
|
21472
|
-
*
|
|
21473
|
-
*
|
|
21474
|
-
|
|
21475
|
-
|
|
21476
|
-
* Request Body (POST):
|
|
21477
|
-
* A JSON object containing:
|
|
21478
|
-
* - course_id (str, required): The course ID to review
|
|
21479
|
-
* - username (str, required): The username of the reviewer
|
|
21480
|
-
* - rating (float, optional): The rating value (typically 1-5)
|
|
21481
|
-
* - title (str, optional): The review title
|
|
21482
|
-
* - content (str, optional): The review content/text
|
|
21483
|
-
* - visible (bool, optional): Whether the review is visible (default: true)
|
|
21484
|
-
*
|
|
21485
|
-
* Query Parameters (DELETE):
|
|
21486
|
-
* course_id (str, required): The course ID of the review to delete
|
|
21487
|
-
* username (str, required): The username of the reviewer
|
|
21488
|
-
*
|
|
21489
|
-
* Returns:
|
|
21490
|
-
* POST: A JSON response containing the created/updated review:
|
|
21491
|
-
* {
|
|
21492
|
-
* "user_id": 123,
|
|
21493
|
-
* "username": "student1",
|
|
21494
|
-
* "content": "This course was excellent and very informative.",
|
|
21495
|
-
* "rating": 4.5,
|
|
21496
|
-
* "title": "Great Course!",
|
|
21497
|
-
* "visible": true,
|
|
21498
|
-
* "created": "2023-01-15T10:30:00Z",
|
|
21499
|
-
* "modified": "2023-01-15T10:30:00Z",
|
|
21500
|
-
* "course_id": "course-v1:org+course+run"
|
|
21501
|
-
* }
|
|
21502
|
-
*
|
|
21503
|
-
* DELETE: A success response with status 200
|
|
21504
|
-
*
|
|
21505
|
-
* Error Responses:
|
|
21506
|
-
* 400 Bad Request: If required parameters are missing or invalid
|
|
21507
|
-
* 401 Unauthorized: If the user is not authenticated
|
|
21508
|
-
* 403 Forbidden: If the user does not have permission to manage this review
|
|
21509
|
-
* 500 Internal Server Error: If an unexpected error occurs during review operations
|
|
21510
|
-
*
|
|
21511
|
-
* Access Control:
|
|
21512
|
-
* - Requires IsDMAdmin or IsEdxUserReadWriteDelete permission
|
|
21513
|
-
* - Users can create, update, or delete their own reviews
|
|
21514
|
-
* - DM admins can manage all reviews
|
|
21515
|
-
* @returns void
|
|
21516
|
-
* @throws ApiError
|
|
21517
|
-
*/
|
|
21518
|
-
static catalogReviewsCourseUpdateDestroy() {
|
|
20148
|
+
* Delete a course review
|
|
20149
|
+
* @param courseId The course ID of the review to delete
|
|
20150
|
+
* @param username The username of the reviewer
|
|
20151
|
+
* @param userId The user ID of the reviewer (alternative to username)
|
|
20152
|
+
* @returns any Review successfully deleted
|
|
20153
|
+
* @throws ApiError
|
|
20154
|
+
*/
|
|
20155
|
+
static catalogReviewsCourseUpdateDestroy(courseId, username, userId) {
|
|
21519
20156
|
return request(OpenAPI, {
|
|
21520
20157
|
method: 'DELETE',
|
|
21521
|
-
url: '/api/catalog/reviews/course/update/'
|
|
20158
|
+
url: '/api/catalog/reviews/course/update/',
|
|
20159
|
+
query: {
|
|
20160
|
+
'course_id': courseId,
|
|
20161
|
+
'user_id': userId,
|
|
20162
|
+
'username': username
|
|
20163
|
+
},
|
|
20164
|
+
errors: {
|
|
20165
|
+
400: `Invalid parameters`,
|
|
20166
|
+
401: `Unauthorized`,
|
|
20167
|
+
403: `Permission denied`,
|
|
20168
|
+
500: `Review could not be deleted`
|
|
20169
|
+
}
|
|
21522
20170
|
});
|
|
21523
20171
|
}
|
|
21524
20172
|
/**
|
|
21525
|
-
*
|
|
21526
|
-
*
|
|
21527
|
-
*
|
|
21528
|
-
*
|
|
21529
|
-
*
|
|
21530
|
-
*
|
|
21531
|
-
*
|
|
21532
|
-
*
|
|
21533
|
-
*
|
|
21534
|
-
*
|
|
21535
|
-
*
|
|
21536
|
-
|
|
21537
|
-
|
|
21538
|
-
* page_size (int, optional): Number of items per page
|
|
21539
|
-
*
|
|
21540
|
-
* Methods:
|
|
21541
|
-
* GET: Retrieve a paginated list of program reviews with filtering
|
|
21542
|
-
*
|
|
21543
|
-
* Returns:
|
|
21544
|
-
* GET: A paginated JSON response containing program reviews:
|
|
21545
|
-
* {
|
|
21546
|
-
* "count": 15,
|
|
21547
|
-
* "next": "https://api.example.com/api/catalog/reviews/program/?page=2",
|
|
21548
|
-
* "previous": null,
|
|
21549
|
-
* "results": [
|
|
21550
|
-
* {
|
|
21551
|
-
* "user_id": 123,
|
|
21552
|
-
* "username": "student1",
|
|
21553
|
-
* "content": "This program was comprehensive and well-structured.",
|
|
21554
|
-
* "rating": 4.5,
|
|
21555
|
-
* "title": "Excellent Program",
|
|
21556
|
-
* "visible": true,
|
|
21557
|
-
* "created": "2023-01-15T10:30:00Z",
|
|
21558
|
-
* "modified": "2023-01-15T10:30:00Z",
|
|
21559
|
-
* "program_key": "program-v1:org+program123"
|
|
21560
|
-
* },
|
|
21561
|
-
* ...
|
|
21562
|
-
* ]
|
|
21563
|
-
* }
|
|
21564
|
-
*
|
|
21565
|
-
* Error Responses:
|
|
21566
|
-
* 400 Bad Request: If required parameters are missing or invalid
|
|
21567
|
-
* 401 Unauthorized: If the user is not authenticated
|
|
21568
|
-
* 403 Forbidden: If the user does not have permission to access this resource
|
|
21569
|
-
* 500 Internal Server Error: If an unexpected error occurs
|
|
21570
|
-
*
|
|
21571
|
-
* Access Control:
|
|
21572
|
-
* - Requires IsDMAdmin, IsPlatformAdminReadOnly, or IsPlatformAdminForProgram permission
|
|
21573
|
-
* - Platform admins can view reviews for programs in their platform (read-only)
|
|
21574
|
-
* - DM admins can view all reviews
|
|
21575
|
-
* @returns any No response body
|
|
21576
|
-
* @throws ApiError
|
|
21577
|
-
*/
|
|
21578
|
-
static catalogReviewsProgramRetrieve() {
|
|
20173
|
+
* Retrieve a paginated list of program reviews with filtering options
|
|
20174
|
+
* @param org Alias for platform_org
|
|
20175
|
+
* @param page Page number for pagination
|
|
20176
|
+
* @param pageSize Number of items per page
|
|
20177
|
+
* @param platformKey Filter reviews by platform key
|
|
20178
|
+
* @param platformOrg Filter reviews by platform organization
|
|
20179
|
+
* @param programId Filter reviews by program ID
|
|
20180
|
+
* @param sort Field to sort results by (default: '-id')
|
|
20181
|
+
* @param userId Filter reviews by user ID
|
|
20182
|
+
* @returns ProgramReviewPaginatedResponse
|
|
20183
|
+
* @throws ApiError
|
|
20184
|
+
*/
|
|
20185
|
+
static catalogReviewsProgramRetrieve(org, page, pageSize, platformKey, platformOrg, programId, sort = '-id', userId) {
|
|
21579
20186
|
return request(OpenAPI, {
|
|
21580
20187
|
method: 'GET',
|
|
21581
|
-
url: '/api/catalog/reviews/program/'
|
|
20188
|
+
url: '/api/catalog/reviews/program/',
|
|
20189
|
+
query: {
|
|
20190
|
+
'org': org,
|
|
20191
|
+
'page': page,
|
|
20192
|
+
'page_size': pageSize,
|
|
20193
|
+
'platform_key': platformKey,
|
|
20194
|
+
'platform_org': platformOrg,
|
|
20195
|
+
'program_id': programId,
|
|
20196
|
+
'sort': sort,
|
|
20197
|
+
'user_id': userId
|
|
20198
|
+
},
|
|
20199
|
+
errors: {
|
|
20200
|
+
400: `Invalid parameters`,
|
|
20201
|
+
401: `Unauthorized`,
|
|
20202
|
+
403: `Permission denied`,
|
|
20203
|
+
500: `Internal server error`
|
|
20204
|
+
}
|
|
21582
20205
|
});
|
|
21583
20206
|
}
|
|
21584
20207
|
/**
|
|
@@ -21601,117 +20224,48 @@ class CatalogService {
|
|
|
21601
20224
|
});
|
|
21602
20225
|
}
|
|
21603
20226
|
/**
|
|
21604
|
-
*
|
|
21605
|
-
*
|
|
21606
|
-
*
|
|
21607
|
-
*
|
|
21608
|
-
|
|
21609
|
-
|
|
21610
|
-
* DELETE: Delete a program review
|
|
21611
|
-
*
|
|
21612
|
-
* Request Body (POST):
|
|
21613
|
-
* A JSON object containing:
|
|
21614
|
-
* - program_key (str, required): The program key to review (format: program-v1:org+program_id)
|
|
21615
|
-
* - username (str, required): The username of the reviewer
|
|
21616
|
-
* - rating (float, optional): The rating value (typically 1-5)
|
|
21617
|
-
* - title (str, optional): The review title
|
|
21618
|
-
* - content (str, optional): The review content/text
|
|
21619
|
-
* - visible (bool, optional): Whether the review is visible (default: true)
|
|
21620
|
-
*
|
|
21621
|
-
* Query Parameters (DELETE):
|
|
21622
|
-
* program_key (str, required): The program key of the review to delete
|
|
21623
|
-
* username (str, required): The username of the reviewer
|
|
21624
|
-
*
|
|
21625
|
-
* Returns:
|
|
21626
|
-
* POST: A JSON response containing the created/updated review:
|
|
21627
|
-
* {
|
|
21628
|
-
* "user_id": 123,
|
|
21629
|
-
* "username": "student1",
|
|
21630
|
-
* "content": "This program was comprehensive and well-structured.",
|
|
21631
|
-
* "rating": 4.5,
|
|
21632
|
-
* "title": "Excellent Program",
|
|
21633
|
-
* "visible": true,
|
|
21634
|
-
* "created": "2023-01-15T10:30:00Z",
|
|
21635
|
-
* "modified": "2023-01-15T10:30:00Z",
|
|
21636
|
-
* "program_key": "program-v1:org+program123"
|
|
21637
|
-
* }
|
|
21638
|
-
*
|
|
21639
|
-
* DELETE: A success response with status 200
|
|
21640
|
-
*
|
|
21641
|
-
* Error Responses:
|
|
21642
|
-
* 400 Bad Request: If required parameters are missing or invalid
|
|
21643
|
-
* 401 Unauthorized: If the user is not authenticated
|
|
21644
|
-
* 403 Forbidden: If the user does not have permission to manage this review
|
|
21645
|
-
* 500 Internal Server Error: If an unexpected error occurs during review operations
|
|
21646
|
-
*
|
|
21647
|
-
* Access Control:
|
|
21648
|
-
* - Requires IsDMAdmin or IsEdxUserReadWriteDelete permission
|
|
21649
|
-
* - Users can create, update, or delete their own reviews
|
|
21650
|
-
* - DM admins can manage all reviews
|
|
21651
|
-
* @returns any No response body
|
|
21652
|
-
* @throws ApiError
|
|
21653
|
-
*/
|
|
21654
|
-
static catalogReviewsProgramUpdateCreate() {
|
|
20227
|
+
* Create or update a program review
|
|
20228
|
+
* @param requestBody
|
|
20229
|
+
* @returns ProgramReview
|
|
20230
|
+
* @throws ApiError
|
|
20231
|
+
*/
|
|
20232
|
+
static catalogReviewsProgramUpdateCreate(requestBody) {
|
|
21655
20233
|
return request(OpenAPI, {
|
|
21656
20234
|
method: 'POST',
|
|
21657
|
-
url: '/api/catalog/reviews/program/update/'
|
|
20235
|
+
url: '/api/catalog/reviews/program/update/',
|
|
20236
|
+
body: requestBody,
|
|
20237
|
+
mediaType: 'application/json',
|
|
20238
|
+
errors: {
|
|
20239
|
+
400: `Invalid parameters`,
|
|
20240
|
+
401: `Unauthorized`,
|
|
20241
|
+
403: `Permission denied`,
|
|
20242
|
+
500: `Review could not be saved`
|
|
20243
|
+
}
|
|
21658
20244
|
});
|
|
21659
20245
|
}
|
|
21660
20246
|
/**
|
|
21661
|
-
*
|
|
21662
|
-
*
|
|
21663
|
-
*
|
|
21664
|
-
*
|
|
21665
|
-
*
|
|
21666
|
-
*
|
|
21667
|
-
|
|
21668
|
-
|
|
21669
|
-
* Request Body (POST):
|
|
21670
|
-
* A JSON object containing:
|
|
21671
|
-
* - program_key (str, required): The program key to review (format: program-v1:org+program_id)
|
|
21672
|
-
* - username (str, required): The username of the reviewer
|
|
21673
|
-
* - rating (float, optional): The rating value (typically 1-5)
|
|
21674
|
-
* - title (str, optional): The review title
|
|
21675
|
-
* - content (str, optional): The review content/text
|
|
21676
|
-
* - visible (bool, optional): Whether the review is visible (default: true)
|
|
21677
|
-
*
|
|
21678
|
-
* Query Parameters (DELETE):
|
|
21679
|
-
* program_key (str, required): The program key of the review to delete
|
|
21680
|
-
* username (str, required): The username of the reviewer
|
|
21681
|
-
*
|
|
21682
|
-
* Returns:
|
|
21683
|
-
* POST: A JSON response containing the created/updated review:
|
|
21684
|
-
* {
|
|
21685
|
-
* "user_id": 123,
|
|
21686
|
-
* "username": "student1",
|
|
21687
|
-
* "content": "This program was comprehensive and well-structured.",
|
|
21688
|
-
* "rating": 4.5,
|
|
21689
|
-
* "title": "Excellent Program",
|
|
21690
|
-
* "visible": true,
|
|
21691
|
-
* "created": "2023-01-15T10:30:00Z",
|
|
21692
|
-
* "modified": "2023-01-15T10:30:00Z",
|
|
21693
|
-
* "program_key": "program-v1:org+program123"
|
|
21694
|
-
* }
|
|
21695
|
-
*
|
|
21696
|
-
* DELETE: A success response with status 200
|
|
21697
|
-
*
|
|
21698
|
-
* Error Responses:
|
|
21699
|
-
* 400 Bad Request: If required parameters are missing or invalid
|
|
21700
|
-
* 401 Unauthorized: If the user is not authenticated
|
|
21701
|
-
* 403 Forbidden: If the user does not have permission to manage this review
|
|
21702
|
-
* 500 Internal Server Error: If an unexpected error occurs during review operations
|
|
21703
|
-
*
|
|
21704
|
-
* Access Control:
|
|
21705
|
-
* - Requires IsDMAdmin or IsEdxUserReadWriteDelete permission
|
|
21706
|
-
* - Users can create, update, or delete their own reviews
|
|
21707
|
-
* - DM admins can manage all reviews
|
|
21708
|
-
* @returns void
|
|
21709
|
-
* @throws ApiError
|
|
21710
|
-
*/
|
|
21711
|
-
static catalogReviewsProgramUpdateDestroy() {
|
|
20247
|
+
* Delete a program review
|
|
20248
|
+
* @param programKey The program key of the review to delete
|
|
20249
|
+
* @param username The username of the reviewer
|
|
20250
|
+
* @param userId The user ID of the reviewer (alternative to username)
|
|
20251
|
+
* @returns any Review successfully deleted
|
|
20252
|
+
* @throws ApiError
|
|
20253
|
+
*/
|
|
20254
|
+
static catalogReviewsProgramUpdateDestroy(programKey, username, userId) {
|
|
21712
20255
|
return request(OpenAPI, {
|
|
21713
20256
|
method: 'DELETE',
|
|
21714
|
-
url: '/api/catalog/reviews/program/update/'
|
|
20257
|
+
url: '/api/catalog/reviews/program/update/',
|
|
20258
|
+
query: {
|
|
20259
|
+
'program_key': programKey,
|
|
20260
|
+
'user_id': userId,
|
|
20261
|
+
'username': username
|
|
20262
|
+
},
|
|
20263
|
+
errors: {
|
|
20264
|
+
400: `Invalid parameters`,
|
|
20265
|
+
401: `Unauthorized`,
|
|
20266
|
+
403: `Permission denied`,
|
|
20267
|
+
500: `Review could not be deleted`
|
|
20268
|
+
}
|
|
21715
20269
|
});
|
|
21716
20270
|
}
|
|
21717
20271
|
/**
|
|
@@ -21926,7 +20480,7 @@ class CatalogService {
|
|
|
21926
20480
|
* @param platformKey Platform key
|
|
21927
20481
|
* @param slug Skill slug
|
|
21928
20482
|
* @param sort Field to sort results by
|
|
21929
|
-
* @returns
|
|
20483
|
+
* @returns PaginatedSkill
|
|
21930
20484
|
* @throws ApiError
|
|
21931
20485
|
*/
|
|
21932
20486
|
static catalogSkillsRetrieve(id, name, nameIexact, page, pageSize, platformKey, slug, sort = 'id') {
|
|
@@ -21947,6 +20501,7 @@ class CatalogService {
|
|
|
21947
20501
|
}
|
|
21948
20502
|
/**
|
|
21949
20503
|
* Add or update a skill.
|
|
20504
|
+
* @param requestBody
|
|
21950
20505
|
* @param id Skill ID
|
|
21951
20506
|
* @param name Skill name
|
|
21952
20507
|
* @param nameIexact Exact match for skill name (case insensitive)
|
|
@@ -21955,11 +20510,10 @@ class CatalogService {
|
|
|
21955
20510
|
* @param platformKey Platform key
|
|
21956
20511
|
* @param slug Skill slug
|
|
21957
20512
|
* @param sort Field to sort results by
|
|
21958
|
-
* @
|
|
21959
|
-
* @returns Skill
|
|
20513
|
+
* @returns PaginatedSkill
|
|
21960
20514
|
* @throws ApiError
|
|
21961
20515
|
*/
|
|
21962
|
-
static catalogSkillsCreate(id, name, nameIexact, page, pageSize, platformKey, slug, sort = 'id'
|
|
20516
|
+
static catalogSkillsCreate(requestBody, id, name, nameIexact, page, pageSize, platformKey, slug, sort = 'id') {
|
|
21963
20517
|
return request(OpenAPI, {
|
|
21964
20518
|
method: 'POST',
|
|
21965
20519
|
url: '/api/catalog/skills/',
|
|
@@ -33744,8 +32298,6 @@ class UserGroupsService {
|
|
|
33744
32298
|
|
|
33745
32299
|
exports.AiAccountService = AiAccountService;
|
|
33746
32300
|
exports.AiAnalyticsService = AiAnalyticsService;
|
|
33747
|
-
exports.AiBotService = AiBotService;
|
|
33748
|
-
exports.AiFinetuningService = AiFinetuningService;
|
|
33749
32301
|
exports.AiIndexService = AiIndexService;
|
|
33750
32302
|
exports.AiMarketingService = AiMarketingService;
|
|
33751
32303
|
exports.AiMediaService = AiMediaService;
|