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