@iblai/iblai-api 3.42.0-ai-plus → 3.42.1-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 +292 -1563
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +293 -1562
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +292 -1563
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +6 -40
- package/dist/types/models/HeygenTemplateRequest.d.ts +5 -0
- package/dist/types/models/HeygenTemplateResponseSingle.d.ts +6 -0
- package/dist/types/models/HeygenVideoRequest.d.ts +5 -0
- package/dist/types/models/PaginatedHeygenTemplateResponseSingleList.d.ts +7 -0
- package/dist/types/models/{VoiceProviderEnum.d.ts → ProviderEnum.d.ts} +1 -1
- package/dist/types/models/VideoCaption.d.ts +3 -0
- package/dist/types/models/Voice.d.ts +2 -2
- package/dist/types/services/AiMediaService.d.ts +57 -15
- package/package.json +1 -1
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +6 -40
- package/src/models/{DiscordWebhook.ts → HeygenTemplateRequest.ts} +4 -5
- package/src/models/HeygenTemplateResponseSingle.ts +11 -0
- package/src/models/{WebexWebhook.ts → HeygenVideoRequest.ts} +4 -3
- package/src/models/{PaginatedDataSetList.ts → PaginatedHeygenTemplateResponseSingleList.ts} +3 -3
- package/src/models/{VoiceProviderEnum.ts → ProviderEnum.ts} +1 -1
- package/src/models/{WhatAppWebHook.ts → VideoCaption.ts} +2 -2
- package/src/models/Voice.ts +2 -2
- package/src/services/AiMediaService.ts +99 -19
- package/dist/types/models/Bot.d.ts +0 -15
- package/dist/types/models/BotCommand.d.ts +0 -6
- package/dist/types/models/BotCreate.d.ts +0 -12
- package/dist/types/models/DataSet.d.ts +0 -21
- package/dist/types/models/DataSetCreate.d.ts +0 -12
- package/dist/types/models/DataSetStatusEnum.d.ts +0 -12
- package/dist/types/models/DiscordConfig.d.ts +0 -7
- package/dist/types/models/DiscordUserConfig.d.ts +0 -10
- package/dist/types/models/DiscordWebhook.d.ts +0 -6
- package/dist/types/models/PaginatedDataSetList.d.ts +0 -7
- package/dist/types/models/PaginatedTrainingList.d.ts +0 -7
- package/dist/types/models/PatchedBotCommand.d.ts +0 -6
- package/dist/types/models/PatchedBotCreate.d.ts +0 -12
- package/dist/types/models/PatchedDataSet.d.ts +0 -21
- package/dist/types/models/PatchedDiscordConfig.d.ts +0 -7
- package/dist/types/models/PatchedDiscordUserConfig.d.ts +0 -10
- package/dist/types/models/PatchedSlackConfig.d.ts +0 -8
- package/dist/types/models/PatchedSlackUserConfig.d.ts +0 -17
- package/dist/types/models/PatchedTeamsConfig.d.ts +0 -7
- package/dist/types/models/PatchedTrainingCreate.d.ts +0 -31
- package/dist/types/models/PatchedWebexConfig.d.ts +0 -10
- package/dist/types/models/PatchedWhatsappConfig.d.ts +0 -11
- package/dist/types/models/PatchedWhatsappUserConfig.d.ts +0 -10
- package/dist/types/models/Provider05cEnum.d.ts +0 -14
- package/dist/types/models/Provider63aEnum.d.ts +0 -6
- package/dist/types/models/SlackConfig.d.ts +0 -8
- package/dist/types/models/SlackUserConfig.d.ts +0 -17
- package/dist/types/models/SlackWebhook.d.ts +0 -6
- package/dist/types/models/TeamsConfig.d.ts +0 -7
- package/dist/types/models/TeamsWebhook.d.ts +0 -17
- package/dist/types/models/Training.d.ts +0 -41
- package/dist/types/models/TrainingCreate.d.ts +0 -31
- package/dist/types/models/WebexConfig.d.ts +0 -10
- package/dist/types/models/WebexWebhook.d.ts +0 -4
- package/dist/types/models/WhatAppWebHook.d.ts +0 -3
- package/dist/types/models/WhatsappConfig.d.ts +0 -11
- package/dist/types/models/WhatsappUserConfig.d.ts +0 -10
- package/dist/types/services/AiBotService.d.ts +0 -486
- package/dist/types/services/AiFinetuningService.d.ts +0 -162
- package/src/models/Bot.ts +0 -20
- package/src/models/BotCommand.ts +0 -11
- package/src/models/BotCreate.ts +0 -17
- package/src/models/DataSet.ts +0 -26
- package/src/models/DataSetCreate.ts +0 -17
- package/src/models/DataSetStatusEnum.ts +0 -16
- package/src/models/DiscordConfig.ts +0 -12
- package/src/models/DiscordUserConfig.ts +0 -15
- package/src/models/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/WhatsappConfig.ts +0 -16
- package/src/models/WhatsappUserConfig.ts +0 -15
- package/src/services/AiBotService.ts +0 -1174
- package/src/services/AiFinetuningService.ts +0 -402
package/dist/index.cjs.js
CHANGED
|
@@ -110,7 +110,7 @@ class CancelablePromise {
|
|
|
110
110
|
|
|
111
111
|
const OpenAPI = {
|
|
112
112
|
BASE: 'https://base.manager.iblai.app',
|
|
113
|
-
VERSION: '3.42.
|
|
113
|
+
VERSION: '3.42.1-ai',
|
|
114
114
|
WITH_CREDENTIALS: false,
|
|
115
115
|
CREDENTIALS: 'include',
|
|
116
116
|
TOKEN: undefined,
|
|
@@ -231,24 +231,6 @@ exports.CourseCreationTaskStatusEnum = void 0;
|
|
|
231
231
|
CourseCreationTaskStatusEnum["IN_PROGRESS"] = "In Progress";
|
|
232
232
|
})(exports.CourseCreationTaskStatusEnum || (exports.CourseCreationTaskStatusEnum = {}));
|
|
233
233
|
|
|
234
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
235
|
-
/* istanbul ignore file */
|
|
236
|
-
/* tslint:disable */
|
|
237
|
-
/* eslint-disable */
|
|
238
|
-
/**
|
|
239
|
-
* * `pending` - Pending
|
|
240
|
-
* * `processing` - Processing
|
|
241
|
-
* * `completed` - Completed
|
|
242
|
-
* * `failed` - Failed
|
|
243
|
-
*/
|
|
244
|
-
exports.DataSetStatusEnum = void 0;
|
|
245
|
-
(function (DataSetStatusEnum) {
|
|
246
|
-
DataSetStatusEnum["PENDING"] = "pending";
|
|
247
|
-
DataSetStatusEnum["PROCESSING"] = "processing";
|
|
248
|
-
DataSetStatusEnum["COMPLETED"] = "completed";
|
|
249
|
-
DataSetStatusEnum["FAILED"] = "failed";
|
|
250
|
-
})(exports.DataSetStatusEnum || (exports.DataSetStatusEnum = {}));
|
|
251
|
-
|
|
252
234
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
253
235
|
/* istanbul ignore file */
|
|
254
236
|
/* tslint:disable */
|
|
@@ -531,37 +513,21 @@ exports.PromptVisibilityEnum = void 0;
|
|
|
531
513
|
PromptVisibilityEnum["VIEWABLE_BY_ANYONE"] = "viewable_by_anyone";
|
|
532
514
|
})(exports.PromptVisibilityEnum || (exports.PromptVisibilityEnum = {}));
|
|
533
515
|
|
|
534
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
535
|
-
/* istanbul ignore file */
|
|
536
|
-
/* tslint:disable */
|
|
537
|
-
/* eslint-disable */
|
|
538
|
-
/**
|
|
539
|
-
* * `webex` - Webex
|
|
540
|
-
* * `slack` - Slack
|
|
541
|
-
* * `whatsapp` - Whatsapp
|
|
542
|
-
* * `discord` - Discord
|
|
543
|
-
* * `teams` - Teams
|
|
544
|
-
*/
|
|
545
|
-
exports.Provider05cEnum = void 0;
|
|
546
|
-
(function (Provider05cEnum) {
|
|
547
|
-
Provider05cEnum["WEBEX"] = "webex";
|
|
548
|
-
Provider05cEnum["SLACK"] = "slack";
|
|
549
|
-
Provider05cEnum["WHATSAPP"] = "whatsapp";
|
|
550
|
-
Provider05cEnum["DISCORD"] = "discord";
|
|
551
|
-
Provider05cEnum["TEAMS"] = "teams";
|
|
552
|
-
})(exports.Provider05cEnum || (exports.Provider05cEnum = {}));
|
|
553
|
-
|
|
554
516
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
555
517
|
/* istanbul ignore file */
|
|
556
518
|
/* tslint:disable */
|
|
557
519
|
/* eslint-disable */
|
|
558
520
|
/**
|
|
559
521
|
* * `openai` - Openai
|
|
522
|
+
* * `google` - Google
|
|
523
|
+
* * `elevenlabs` - Elevenlabs
|
|
560
524
|
*/
|
|
561
|
-
exports.
|
|
562
|
-
(function (
|
|
563
|
-
|
|
564
|
-
|
|
525
|
+
exports.ProviderEnum = void 0;
|
|
526
|
+
(function (ProviderEnum) {
|
|
527
|
+
ProviderEnum["OPENAI"] = "openai";
|
|
528
|
+
ProviderEnum["GOOGLE"] = "google";
|
|
529
|
+
ProviderEnum["ELEVENLABS"] = "elevenlabs";
|
|
530
|
+
})(exports.ProviderEnum || (exports.ProviderEnum = {}));
|
|
565
531
|
|
|
566
532
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
567
533
|
/* istanbul ignore file */
|
|
@@ -731,22 +697,6 @@ exports.TypeC42Enum = void 0;
|
|
|
731
697
|
TypeC42Enum["ASSESSMENT"] = "assessment";
|
|
732
698
|
})(exports.TypeC42Enum || (exports.TypeC42Enum = {}));
|
|
733
699
|
|
|
734
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
735
|
-
/* istanbul ignore file */
|
|
736
|
-
/* tslint:disable */
|
|
737
|
-
/* eslint-disable */
|
|
738
|
-
/**
|
|
739
|
-
* * `openai` - Openai
|
|
740
|
-
* * `google` - Google
|
|
741
|
-
* * `elevenlabs` - Elevenlabs
|
|
742
|
-
*/
|
|
743
|
-
exports.VoiceProviderEnum = void 0;
|
|
744
|
-
(function (VoiceProviderEnum) {
|
|
745
|
-
VoiceProviderEnum["OPENAI"] = "openai";
|
|
746
|
-
VoiceProviderEnum["GOOGLE"] = "google";
|
|
747
|
-
VoiceProviderEnum["ELEVENLABS"] = "elevenlabs";
|
|
748
|
-
})(exports.VoiceProviderEnum || (exports.VoiceProviderEnum = {}));
|
|
749
|
-
|
|
750
700
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
751
701
|
/* istanbul ignore file */
|
|
752
702
|
/* tslint:disable */
|
|
@@ -5790,1566 +5740,282 @@ class AiAnalyticsService {
|
|
|
5790
5740
|
}
|
|
5791
5741
|
}
|
|
5792
5742
|
|
|
5793
|
-
class
|
|
5743
|
+
class AiIndexService {
|
|
5794
5744
|
/**
|
|
5795
|
-
*
|
|
5745
|
+
* Retrieve details of a specific document embedding.
|
|
5746
|
+
*
|
|
5747
|
+
* This endpoint returns detailed information about a specific
|
|
5748
|
+
* document embedding identified by its ID.
|
|
5749
|
+
*
|
|
5750
|
+
* Args:
|
|
5751
|
+
* request: The HTTP request.
|
|
5752
|
+
* org: Organization key identifier.
|
|
5753
|
+
* document_id: The ID of the document embedding to retrieve.
|
|
5754
|
+
*
|
|
5755
|
+
* Returns:
|
|
5756
|
+
* Response: Detailed information about the document embedding.
|
|
5757
|
+
*
|
|
5758
|
+
* Raises:
|
|
5759
|
+
* NotFound: If the specified document embedding does not exist.
|
|
5760
|
+
* @param documentId
|
|
5796
5761
|
* @param org
|
|
5797
|
-
* @
|
|
5762
|
+
* @param userId
|
|
5763
|
+
* @returns RetrieverDocumentEmbedding
|
|
5798
5764
|
* @throws ApiError
|
|
5799
5765
|
*/
|
|
5800
|
-
static
|
|
5766
|
+
static aiIndexOrgsUsersDocumentsRetrieve(documentId, org, userId) {
|
|
5801
5767
|
return request(OpenAPI, {
|
|
5802
5768
|
method: 'GET',
|
|
5803
|
-
url: '/api/ai-
|
|
5769
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
|
|
5804
5770
|
path: {
|
|
5805
|
-
'
|
|
5771
|
+
'document_id': documentId,
|
|
5772
|
+
'org': org,
|
|
5773
|
+
'user_id': userId
|
|
5774
|
+
},
|
|
5775
|
+
errors: {
|
|
5776
|
+
404: `Document not found`
|
|
5806
5777
|
}
|
|
5807
5778
|
});
|
|
5808
5779
|
}
|
|
5809
5780
|
/**
|
|
5810
|
-
*
|
|
5781
|
+
* Update a specific document embedding.
|
|
5782
|
+
*
|
|
5783
|
+
* This endpoint allows updating various properties of a document embedding,
|
|
5784
|
+
* including its name, type, pathway, and training status.
|
|
5785
|
+
*
|
|
5786
|
+
* Args:
|
|
5787
|
+
* request: The HTTP request containing the updated document data.
|
|
5788
|
+
* org: Organization key identifier.
|
|
5789
|
+
* document_id: The ID of the document embedding to update.
|
|
5790
|
+
*
|
|
5791
|
+
* Returns:
|
|
5792
|
+
* Response: The updated document embedding information.
|
|
5793
|
+
*
|
|
5794
|
+
* Raises:
|
|
5795
|
+
* BadRequest: If the provided data is invalid.
|
|
5796
|
+
* NotFound: If the specified document embedding does not exist.
|
|
5797
|
+
* @param documentId
|
|
5811
5798
|
* @param org
|
|
5812
|
-
* @param
|
|
5813
|
-
* @
|
|
5799
|
+
* @param userId
|
|
5800
|
+
* @param formData
|
|
5801
|
+
* @returns RetrieverDocumentEmbedding
|
|
5814
5802
|
* @throws ApiError
|
|
5815
5803
|
*/
|
|
5816
|
-
static
|
|
5804
|
+
static aiIndexOrgsUsersDocumentsUpdate(documentId, org, userId, formData) {
|
|
5817
5805
|
return request(OpenAPI, {
|
|
5818
|
-
method: '
|
|
5819
|
-
url: '/api/ai-
|
|
5806
|
+
method: 'PUT',
|
|
5807
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
|
|
5820
5808
|
path: {
|
|
5821
|
-
'
|
|
5809
|
+
'document_id': documentId,
|
|
5810
|
+
'org': org,
|
|
5811
|
+
'user_id': userId
|
|
5822
5812
|
},
|
|
5823
|
-
|
|
5824
|
-
mediaType: '
|
|
5813
|
+
formData: formData,
|
|
5814
|
+
mediaType: 'multipart/form-data',
|
|
5815
|
+
errors: {
|
|
5816
|
+
400: `Invalid request data`,
|
|
5817
|
+
404: `Document not found`
|
|
5818
|
+
}
|
|
5825
5819
|
});
|
|
5826
5820
|
}
|
|
5827
5821
|
/**
|
|
5828
|
-
*
|
|
5829
|
-
*
|
|
5822
|
+
* Delete a specific document embedding.
|
|
5823
|
+
*
|
|
5824
|
+
* This endpoint removes a document embedding from the system,
|
|
5825
|
+
* including untraining it from any associated pathways.
|
|
5826
|
+
*
|
|
5827
|
+
* Args:
|
|
5828
|
+
* request: The HTTP request.
|
|
5829
|
+
* org: Organization key identifier.
|
|
5830
|
+
* document_id: The ID of the document embedding to delete.
|
|
5831
|
+
*
|
|
5832
|
+
* Returns:
|
|
5833
|
+
* Response: An empty response with a 204 status code if successful.
|
|
5834
|
+
*
|
|
5835
|
+
* Raises:
|
|
5836
|
+
* NotFound: If the specified document embedding does not exist.
|
|
5837
|
+
* @param documentId
|
|
5830
5838
|
* @param org
|
|
5831
|
-
* @
|
|
5839
|
+
* @param userId
|
|
5840
|
+
* @returns void
|
|
5832
5841
|
* @throws ApiError
|
|
5833
5842
|
*/
|
|
5834
|
-
static
|
|
5843
|
+
static aiIndexOrgsUsersDocumentsDestroy(documentId, org, userId) {
|
|
5835
5844
|
return request(OpenAPI, {
|
|
5836
|
-
method: '
|
|
5837
|
-
url: '/api/ai-
|
|
5845
|
+
method: 'DELETE',
|
|
5846
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
|
|
5838
5847
|
path: {
|
|
5839
|
-
'
|
|
5848
|
+
'document_id': documentId,
|
|
5849
|
+
'org': org,
|
|
5850
|
+
'user_id': userId
|
|
5851
|
+
},
|
|
5852
|
+
errors: {
|
|
5853
|
+
404: `Document not found`
|
|
5840
5854
|
}
|
|
5841
5855
|
});
|
|
5842
5856
|
}
|
|
5843
5857
|
/**
|
|
5844
|
-
*
|
|
5845
|
-
*
|
|
5858
|
+
* Train a graph-based document through a worker process.
|
|
5859
|
+
*
|
|
5860
|
+
* This endpoint queues graph-based documents for training through a
|
|
5861
|
+
* specialized worker process that handles knowledge graph processing.
|
|
5862
|
+
*
|
|
5863
|
+
* Args:
|
|
5864
|
+
* request: The HTTP request containing the document information.
|
|
5865
|
+
* org: Organization key identifier.
|
|
5866
|
+
*
|
|
5867
|
+
* Returns:
|
|
5868
|
+
* Response: A confirmation that the document was queued for training,
|
|
5869
|
+
* including a task ID for tracking the progress.
|
|
5870
|
+
*
|
|
5871
|
+
* Raises:
|
|
5872
|
+
* ValidationError: If the request data is invalid.
|
|
5873
|
+
* BadRequest: If there was an error processing the document.
|
|
5846
5874
|
* @param org
|
|
5847
|
-
* @param
|
|
5848
|
-
* @
|
|
5875
|
+
* @param userId
|
|
5876
|
+
* @param formData
|
|
5877
|
+
* @returns TrainDocumentViewResponse
|
|
5849
5878
|
* @throws ApiError
|
|
5850
5879
|
*/
|
|
5851
|
-
static
|
|
5880
|
+
static aiIndexOrgsUsersDocumentsGraphTrainCreate(org, userId, formData) {
|
|
5852
5881
|
return request(OpenAPI, {
|
|
5853
5882
|
method: 'POST',
|
|
5854
|
-
url: '/api/ai-
|
|
5883
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/graph-train/',
|
|
5855
5884
|
path: {
|
|
5856
|
-
'org': org
|
|
5885
|
+
'org': org,
|
|
5886
|
+
'user_id': userId
|
|
5857
5887
|
},
|
|
5858
|
-
|
|
5859
|
-
mediaType: '
|
|
5888
|
+
formData: formData,
|
|
5889
|
+
mediaType: 'multipart/form-data',
|
|
5890
|
+
errors: {
|
|
5891
|
+
400: `Invalid request data or document processing error`
|
|
5892
|
+
}
|
|
5860
5893
|
});
|
|
5861
5894
|
}
|
|
5862
5895
|
/**
|
|
5863
|
-
*
|
|
5864
|
-
*
|
|
5865
|
-
*
|
|
5896
|
+
* Retrieve a list of document embeddings for a specific pathway.
|
|
5897
|
+
*
|
|
5898
|
+
* This endpoint returns a paginated list of all document embeddings
|
|
5899
|
+
* that have been created for the specified pathway within the organization.
|
|
5900
|
+
*
|
|
5901
|
+
* Args:
|
|
5902
|
+
* request: The HTTP request.
|
|
5903
|
+
* org: Organization key identifier.
|
|
5904
|
+
* pathway: The pathway to retrieve document embeddings for.
|
|
5905
|
+
*
|
|
5906
|
+
* Returns:
|
|
5907
|
+
* Response: A paginated list of document embeddings for the pathway.
|
|
5866
5908
|
* @param org
|
|
5867
|
-
* @
|
|
5909
|
+
* @param pathway
|
|
5910
|
+
* @param userId
|
|
5911
|
+
* @returns RetrieverDocumentEmbedding
|
|
5868
5912
|
* @throws ApiError
|
|
5869
5913
|
*/
|
|
5870
|
-
static
|
|
5914
|
+
static aiIndexOrgsUsersDocumentsPathwaysList(org, pathway, userId) {
|
|
5871
5915
|
return request(OpenAPI, {
|
|
5872
5916
|
method: 'GET',
|
|
5873
|
-
url: '/api/ai-
|
|
5917
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/pathways/{pathway}/',
|
|
5874
5918
|
path: {
|
|
5875
|
-
'
|
|
5876
|
-
'
|
|
5919
|
+
'org': org,
|
|
5920
|
+
'pathway': pathway,
|
|
5921
|
+
'user_id': userId
|
|
5877
5922
|
}
|
|
5878
5923
|
});
|
|
5879
5924
|
}
|
|
5880
5925
|
/**
|
|
5881
|
-
*
|
|
5882
|
-
*
|
|
5883
|
-
*
|
|
5926
|
+
* Retrieve resource documents similar to the given query.
|
|
5927
|
+
*
|
|
5928
|
+
* This endpoint performs a semantic search to find documents that are
|
|
5929
|
+
* relevant to the provided query within the specified pathway.
|
|
5930
|
+
*
|
|
5931
|
+
* Args:
|
|
5932
|
+
* request: The HTTP request containing the search query.
|
|
5933
|
+
* org: Organization key identifier.
|
|
5934
|
+
*
|
|
5935
|
+
* Returns:
|
|
5936
|
+
* Response: A list of documents relevant to the search query.
|
|
5937
|
+
*
|
|
5938
|
+
* Raises:
|
|
5939
|
+
* ValidationError: If the request data is invalid.
|
|
5884
5940
|
* @param org
|
|
5941
|
+
* @param userId
|
|
5885
5942
|
* @param requestBody
|
|
5886
|
-
* @returns
|
|
5943
|
+
* @returns RetrieverResponseSearch
|
|
5887
5944
|
* @throws ApiError
|
|
5888
5945
|
*/
|
|
5889
|
-
static
|
|
5946
|
+
static aiIndexOrgsUsersDocumentsSearchCreate(org, userId, requestBody) {
|
|
5890
5947
|
return request(OpenAPI, {
|
|
5891
|
-
method: '
|
|
5892
|
-
url: '/api/ai-
|
|
5948
|
+
method: 'POST',
|
|
5949
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/search/',
|
|
5893
5950
|
path: {
|
|
5894
|
-
'
|
|
5895
|
-
'
|
|
5951
|
+
'org': org,
|
|
5952
|
+
'user_id': userId
|
|
5896
5953
|
},
|
|
5897
5954
|
body: requestBody,
|
|
5898
|
-
mediaType: 'application/json'
|
|
5955
|
+
mediaType: 'application/json',
|
|
5956
|
+
errors: {
|
|
5957
|
+
400: `Invalid request data`
|
|
5958
|
+
}
|
|
5899
5959
|
});
|
|
5900
5960
|
}
|
|
5901
5961
|
/**
|
|
5902
|
-
*
|
|
5903
|
-
*
|
|
5904
|
-
*
|
|
5962
|
+
* Retrieve document sources related to a given query.
|
|
5963
|
+
*
|
|
5964
|
+
* This endpoint performs a semantic search to find document sources
|
|
5965
|
+
* that are relevant to the provided query within the specified pathway,
|
|
5966
|
+
* and returns them along with confidence levels.
|
|
5967
|
+
*
|
|
5968
|
+
* Args:
|
|
5969
|
+
* request: The HTTP request containing the search query.
|
|
5970
|
+
* org: Organization key identifier.
|
|
5971
|
+
*
|
|
5972
|
+
* Returns:
|
|
5973
|
+
* Response: A list of document sources with confidence levels.
|
|
5974
|
+
*
|
|
5975
|
+
* Raises:
|
|
5976
|
+
* ValidationError: If the request data is invalid.
|
|
5905
5977
|
* @param org
|
|
5978
|
+
* @param userId
|
|
5906
5979
|
* @param requestBody
|
|
5907
|
-
* @returns
|
|
5980
|
+
* @returns RetrieverRequestSearchDocument
|
|
5908
5981
|
* @throws ApiError
|
|
5909
5982
|
*/
|
|
5910
|
-
static
|
|
5983
|
+
static aiIndexOrgsUsersDocumentsSourcesCreate(org, userId, requestBody) {
|
|
5911
5984
|
return request(OpenAPI, {
|
|
5912
|
-
method: '
|
|
5913
|
-
url: '/api/ai-
|
|
5985
|
+
method: 'POST',
|
|
5986
|
+
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/sources/',
|
|
5914
5987
|
path: {
|
|
5915
|
-
'
|
|
5916
|
-
'
|
|
5988
|
+
'org': org,
|
|
5989
|
+
'user_id': userId
|
|
5917
5990
|
},
|
|
5918
5991
|
body: requestBody,
|
|
5919
|
-
mediaType: 'application/json'
|
|
5992
|
+
mediaType: 'application/json',
|
|
5993
|
+
errors: {
|
|
5994
|
+
400: `Invalid request data`
|
|
5995
|
+
}
|
|
5920
5996
|
});
|
|
5921
5997
|
}
|
|
5922
5998
|
/**
|
|
5923
|
-
*
|
|
5924
|
-
*
|
|
5925
|
-
*
|
|
5999
|
+
* Check the status of a document training task.
|
|
6000
|
+
*
|
|
6001
|
+
* This endpoint retrieves the current status of an asynchronous
|
|
6002
|
+
* document training task that was previously initiated.
|
|
6003
|
+
*
|
|
6004
|
+
* Args:
|
|
6005
|
+
* request: The HTTP request.
|
|
6006
|
+
* org: Organization key identifier.
|
|
6007
|
+
* task_id: The ID of the training task to check.
|
|
6008
|
+
*
|
|
6009
|
+
* Returns:
|
|
6010
|
+
* Response: The current status of the document training task,
|
|
6011
|
+
* which can be "pending", "completed", or "failed".
|
|
5926
6012
|
* @param org
|
|
5927
|
-
* @
|
|
6013
|
+
* @param taskId
|
|
6014
|
+
* @param userId
|
|
6015
|
+
* @returns CheckDocumentTrainingStatus
|
|
5928
6016
|
* @throws ApiError
|
|
5929
6017
|
*/
|
|
5930
|
-
static
|
|
5931
|
-
return request(OpenAPI, {
|
|
5932
|
-
method: 'DELETE',
|
|
5933
|
-
url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
|
|
5934
|
-
path: {
|
|
5935
|
-
'id': id,
|
|
5936
|
-
'org': org
|
|
5937
|
-
}
|
|
5938
|
-
});
|
|
5939
|
-
}
|
|
5940
|
-
/**
|
|
5941
|
-
* Create modify and update bot information for a specific tenant.
|
|
5942
|
-
* @param id A unique integer value identifying this bot.
|
|
5943
|
-
* @param org
|
|
5944
|
-
* @returns Bot
|
|
5945
|
-
* @throws ApiError
|
|
5946
|
-
*/
|
|
5947
|
-
static aiBotV1BotsBotRetrieve(id, org) {
|
|
5948
|
-
return request(OpenAPI, {
|
|
5949
|
-
method: 'GET',
|
|
5950
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
|
|
5951
|
-
path: {
|
|
5952
|
-
'id': id,
|
|
5953
|
-
'org': org
|
|
5954
|
-
}
|
|
5955
|
-
});
|
|
5956
|
-
}
|
|
5957
|
-
/**
|
|
5958
|
-
* Create modify and update bot information for a specific tenant.
|
|
5959
|
-
* @param id A unique integer value identifying this bot.
|
|
5960
|
-
* @param org
|
|
5961
|
-
* @param requestBody
|
|
5962
|
-
* @returns BotCreate
|
|
5963
|
-
* @throws ApiError
|
|
5964
|
-
*/
|
|
5965
|
-
static aiBotV1BotsBotUpdate(id, org, requestBody) {
|
|
5966
|
-
return request(OpenAPI, {
|
|
5967
|
-
method: 'PUT',
|
|
5968
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
|
|
5969
|
-
path: {
|
|
5970
|
-
'id': id,
|
|
5971
|
-
'org': org
|
|
5972
|
-
},
|
|
5973
|
-
body: requestBody,
|
|
5974
|
-
mediaType: 'application/json'
|
|
5975
|
-
});
|
|
5976
|
-
}
|
|
5977
|
-
/**
|
|
5978
|
-
* Create modify and update bot information for a specific tenant.
|
|
5979
|
-
* @param id A unique integer value identifying this bot.
|
|
5980
|
-
* @param org
|
|
5981
|
-
* @param requestBody
|
|
5982
|
-
* @returns BotCreate
|
|
5983
|
-
* @throws ApiError
|
|
5984
|
-
*/
|
|
5985
|
-
static aiBotV1BotsBotPartialUpdate(id, org, requestBody) {
|
|
5986
|
-
return request(OpenAPI, {
|
|
5987
|
-
method: 'PATCH',
|
|
5988
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
|
|
5989
|
-
path: {
|
|
5990
|
-
'id': id,
|
|
5991
|
-
'org': org
|
|
5992
|
-
},
|
|
5993
|
-
body: requestBody,
|
|
5994
|
-
mediaType: 'application/json'
|
|
5995
|
-
});
|
|
5996
|
-
}
|
|
5997
|
-
/**
|
|
5998
|
-
* Create modify and update bot information for a specific tenant.
|
|
5999
|
-
* @param id A unique integer value identifying this bot.
|
|
6000
|
-
* @param org
|
|
6001
|
-
* @returns void
|
|
6002
|
-
* @throws ApiError
|
|
6003
|
-
*/
|
|
6004
|
-
static aiBotV1BotsBotDestroy(id, org) {
|
|
6005
|
-
return request(OpenAPI, {
|
|
6006
|
-
method: 'DELETE',
|
|
6007
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
|
|
6008
|
-
path: {
|
|
6009
|
-
'id': id,
|
|
6010
|
-
'org': org
|
|
6011
|
-
}
|
|
6012
|
-
});
|
|
6013
|
-
}
|
|
6014
|
-
/**
|
|
6015
|
-
* Create modify and update bot information for a specific tenant.
|
|
6016
|
-
* @param id A unique integer value identifying this bot.
|
|
6017
|
-
* @param org
|
|
6018
|
-
* @returns DiscordConfig
|
|
6019
|
-
* @throws ApiError
|
|
6020
|
-
*/
|
|
6021
|
-
static aiBotV1BotsBotConfigDiscordRetrieve(id, org) {
|
|
6022
|
-
return request(OpenAPI, {
|
|
6023
|
-
method: 'GET',
|
|
6024
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
|
|
6025
|
-
path: {
|
|
6026
|
-
'id': id,
|
|
6027
|
-
'org': org
|
|
6028
|
-
}
|
|
6029
|
-
});
|
|
6030
|
-
}
|
|
6031
|
-
/**
|
|
6032
|
-
* Create modify and update bot information for a specific tenant.
|
|
6033
|
-
* @param id A unique integer value identifying this bot.
|
|
6034
|
-
* @param org
|
|
6035
|
-
* @param requestBody
|
|
6036
|
-
* @returns DiscordConfig
|
|
6037
|
-
* @throws ApiError
|
|
6038
|
-
*/
|
|
6039
|
-
static aiBotV1BotsBotConfigDiscordPartialUpdate(id, org, requestBody) {
|
|
6040
|
-
return request(OpenAPI, {
|
|
6041
|
-
method: 'PATCH',
|
|
6042
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
|
|
6043
|
-
path: {
|
|
6044
|
-
'id': id,
|
|
6045
|
-
'org': org
|
|
6046
|
-
},
|
|
6047
|
-
body: requestBody,
|
|
6048
|
-
mediaType: 'application/json'
|
|
6049
|
-
});
|
|
6050
|
-
}
|
|
6051
|
-
/**
|
|
6052
|
-
* Create modify and update bot information for a specific tenant.
|
|
6053
|
-
* @param id A unique integer value identifying this bot.
|
|
6054
|
-
* @param org
|
|
6055
|
-
* @returns SlackConfig
|
|
6056
|
-
* @throws ApiError
|
|
6057
|
-
*/
|
|
6058
|
-
static aiBotV1BotsBotConfigSlackRetrieve(id, org) {
|
|
6059
|
-
return request(OpenAPI, {
|
|
6060
|
-
method: 'GET',
|
|
6061
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/',
|
|
6062
|
-
path: {
|
|
6063
|
-
'id': id,
|
|
6064
|
-
'org': org
|
|
6065
|
-
}
|
|
6066
|
-
});
|
|
6067
|
-
}
|
|
6068
|
-
/**
|
|
6069
|
-
* Create modify and update bot information for a specific tenant.
|
|
6070
|
-
* @param id A unique integer value identifying this bot.
|
|
6071
|
-
* @param org
|
|
6072
|
-
* @param requestBody
|
|
6073
|
-
* @returns SlackConfig
|
|
6074
|
-
* @throws ApiError
|
|
6075
|
-
*/
|
|
6076
|
-
static aiBotV1BotsBotConfigSlackUpdateCreate(id, org, requestBody) {
|
|
6077
|
-
return request(OpenAPI, {
|
|
6078
|
-
method: 'POST',
|
|
6079
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
|
|
6080
|
-
path: {
|
|
6081
|
-
'id': id,
|
|
6082
|
-
'org': org
|
|
6083
|
-
},
|
|
6084
|
-
body: requestBody,
|
|
6085
|
-
mediaType: 'application/json'
|
|
6086
|
-
});
|
|
6087
|
-
}
|
|
6088
|
-
/**
|
|
6089
|
-
* Create modify and update bot information for a specific tenant.
|
|
6090
|
-
* @param id A unique integer value identifying this bot.
|
|
6091
|
-
* @param org
|
|
6092
|
-
* @param requestBody
|
|
6093
|
-
* @returns SlackConfig
|
|
6094
|
-
* @throws ApiError
|
|
6095
|
-
*/
|
|
6096
|
-
static aiBotV1BotsBotConfigSlackUpdateUpdate(id, org, requestBody) {
|
|
6097
|
-
return request(OpenAPI, {
|
|
6098
|
-
method: 'PUT',
|
|
6099
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
|
|
6100
|
-
path: {
|
|
6101
|
-
'id': id,
|
|
6102
|
-
'org': org
|
|
6103
|
-
},
|
|
6104
|
-
body: requestBody,
|
|
6105
|
-
mediaType: 'application/json'
|
|
6106
|
-
});
|
|
6107
|
-
}
|
|
6108
|
-
/**
|
|
6109
|
-
* Create modify and update bot information for a specific tenant.
|
|
6110
|
-
* @param id A unique integer value identifying this bot.
|
|
6111
|
-
* @param org
|
|
6112
|
-
* @param requestBody
|
|
6113
|
-
* @returns SlackConfig
|
|
6114
|
-
* @throws ApiError
|
|
6115
|
-
*/
|
|
6116
|
-
static aiBotV1BotsBotConfigSlackUpdatePartialUpdate(id, org, requestBody) {
|
|
6117
|
-
return request(OpenAPI, {
|
|
6118
|
-
method: 'PATCH',
|
|
6119
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
|
|
6120
|
-
path: {
|
|
6121
|
-
'id': id,
|
|
6122
|
-
'org': org
|
|
6123
|
-
},
|
|
6124
|
-
body: requestBody,
|
|
6125
|
-
mediaType: 'application/json'
|
|
6126
|
-
});
|
|
6127
|
-
}
|
|
6128
|
-
/**
|
|
6129
|
-
* Create modify and update bot information for a specific tenant.
|
|
6130
|
-
* @param id A unique integer value identifying this bot.
|
|
6131
|
-
* @param org
|
|
6132
|
-
* @returns TeamsConfig
|
|
6133
|
-
* @throws ApiError
|
|
6134
|
-
*/
|
|
6135
|
-
static aiBotV1BotsBotConfigTeamsRetrieve(id, org) {
|
|
6136
|
-
return request(OpenAPI, {
|
|
6137
|
-
method: 'GET',
|
|
6138
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/',
|
|
6139
|
-
path: {
|
|
6140
|
-
'id': id,
|
|
6141
|
-
'org': org
|
|
6142
|
-
}
|
|
6143
|
-
});
|
|
6144
|
-
}
|
|
6145
|
-
/**
|
|
6146
|
-
* Create modify and update bot information for a specific tenant.
|
|
6147
|
-
* @param id A unique integer value identifying this bot.
|
|
6148
|
-
* @param org
|
|
6149
|
-
* @param requestBody
|
|
6150
|
-
* @returns TeamsConfig
|
|
6151
|
-
* @throws ApiError
|
|
6152
|
-
*/
|
|
6153
|
-
static aiBotV1BotsBotConfigTeamsUpdateCreate(id, org, requestBody) {
|
|
6154
|
-
return request(OpenAPI, {
|
|
6155
|
-
method: 'POST',
|
|
6156
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
|
|
6157
|
-
path: {
|
|
6158
|
-
'id': id,
|
|
6159
|
-
'org': org
|
|
6160
|
-
},
|
|
6161
|
-
body: requestBody,
|
|
6162
|
-
mediaType: 'application/json'
|
|
6163
|
-
});
|
|
6164
|
-
}
|
|
6165
|
-
/**
|
|
6166
|
-
* Create modify and update bot information for a specific tenant.
|
|
6167
|
-
* @param id A unique integer value identifying this bot.
|
|
6168
|
-
* @param org
|
|
6169
|
-
* @param requestBody
|
|
6170
|
-
* @returns TeamsConfig
|
|
6171
|
-
* @throws ApiError
|
|
6172
|
-
*/
|
|
6173
|
-
static aiBotV1BotsBotConfigTeamsUpdateUpdate(id, org, requestBody) {
|
|
6174
|
-
return request(OpenAPI, {
|
|
6175
|
-
method: 'PUT',
|
|
6176
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
|
|
6177
|
-
path: {
|
|
6178
|
-
'id': id,
|
|
6179
|
-
'org': org
|
|
6180
|
-
},
|
|
6181
|
-
body: requestBody,
|
|
6182
|
-
mediaType: 'application/json'
|
|
6183
|
-
});
|
|
6184
|
-
}
|
|
6185
|
-
/**
|
|
6186
|
-
* Create modify and update bot information for a specific tenant.
|
|
6187
|
-
* @param id A unique integer value identifying this bot.
|
|
6188
|
-
* @param org
|
|
6189
|
-
* @param requestBody
|
|
6190
|
-
* @returns TeamsConfig
|
|
6191
|
-
* @throws ApiError
|
|
6192
|
-
*/
|
|
6193
|
-
static aiBotV1BotsBotConfigTeamsUpdatePartialUpdate(id, org, requestBody) {
|
|
6194
|
-
return request(OpenAPI, {
|
|
6195
|
-
method: 'PATCH',
|
|
6196
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
|
|
6197
|
-
path: {
|
|
6198
|
-
'id': id,
|
|
6199
|
-
'org': org
|
|
6200
|
-
},
|
|
6201
|
-
body: requestBody,
|
|
6202
|
-
mediaType: 'application/json'
|
|
6203
|
-
});
|
|
6204
|
-
}
|
|
6205
|
-
/**
|
|
6206
|
-
* Create modify and update bot information for a specific tenant.
|
|
6207
|
-
* @param id A unique integer value identifying this bot.
|
|
6208
|
-
* @param org
|
|
6209
|
-
* @returns WebexConfig
|
|
6210
|
-
* @throws ApiError
|
|
6211
|
-
*/
|
|
6212
|
-
static aiBotV1BotsBotConfigWebexRetrieve(id, org) {
|
|
6213
|
-
return request(OpenAPI, {
|
|
6214
|
-
method: 'GET',
|
|
6215
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/webex/',
|
|
6216
|
-
path: {
|
|
6217
|
-
'id': id,
|
|
6218
|
-
'org': org
|
|
6219
|
-
}
|
|
6220
|
-
});
|
|
6221
|
-
}
|
|
6222
|
-
/**
|
|
6223
|
-
* Create modify and update bot information for a specific tenant.
|
|
6224
|
-
* @param id A unique integer value identifying this bot.
|
|
6225
|
-
* @param org
|
|
6226
|
-
* @param requestBody
|
|
6227
|
-
* @returns WebexConfig
|
|
6228
|
-
* @throws ApiError
|
|
6229
|
-
*/
|
|
6230
|
-
static aiBotV1BotsBotConfigWebexPartialUpdate(id, org, requestBody) {
|
|
6231
|
-
return request(OpenAPI, {
|
|
6232
|
-
method: 'PATCH',
|
|
6233
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/webex/',
|
|
6234
|
-
path: {
|
|
6235
|
-
'id': id,
|
|
6236
|
-
'org': org
|
|
6237
|
-
},
|
|
6238
|
-
body: requestBody,
|
|
6239
|
-
mediaType: 'application/json'
|
|
6240
|
-
});
|
|
6241
|
-
}
|
|
6242
|
-
/**
|
|
6243
|
-
* Create modify and update bot information for a specific tenant.
|
|
6244
|
-
* @param id A unique integer value identifying this bot.
|
|
6245
|
-
* @param org
|
|
6246
|
-
* @returns WhatsappConfig
|
|
6247
|
-
* @throws ApiError
|
|
6248
|
-
*/
|
|
6249
|
-
static aiBotV1BotsBotConfigWhatsappRetrieve(id, org) {
|
|
6250
|
-
return request(OpenAPI, {
|
|
6251
|
-
method: 'GET',
|
|
6252
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/whatsapp/',
|
|
6253
|
-
path: {
|
|
6254
|
-
'id': id,
|
|
6255
|
-
'org': org
|
|
6256
|
-
}
|
|
6257
|
-
});
|
|
6258
|
-
}
|
|
6259
|
-
/**
|
|
6260
|
-
* Create modify and update bot information for a specific tenant.
|
|
6261
|
-
* @param id A unique integer value identifying this bot.
|
|
6262
|
-
* @param org
|
|
6263
|
-
* @param requestBody
|
|
6264
|
-
* @returns WhatsappConfig
|
|
6265
|
-
* @throws ApiError
|
|
6266
|
-
*/
|
|
6267
|
-
static aiBotV1BotsBotWhatsappConfigUpdate(id, org, requestBody) {
|
|
6268
|
-
return request(OpenAPI, {
|
|
6269
|
-
method: 'PUT',
|
|
6270
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/whatsapp-config/',
|
|
6271
|
-
path: {
|
|
6272
|
-
'id': id,
|
|
6273
|
-
'org': org
|
|
6274
|
-
},
|
|
6275
|
-
body: requestBody,
|
|
6276
|
-
mediaType: 'application/json'
|
|
6277
|
-
});
|
|
6278
|
-
}
|
|
6279
|
-
/**
|
|
6280
|
-
* Create modify and update bot information for a specific tenant.
|
|
6281
|
-
* @param id A unique integer value identifying this bot.
|
|
6282
|
-
* @param org
|
|
6283
|
-
* @param requestBody
|
|
6284
|
-
* @returns WhatsappConfig
|
|
6285
|
-
* @throws ApiError
|
|
6286
|
-
*/
|
|
6287
|
-
static aiBotV1BotsBotWhatsappConfigPartialUpdate(id, org, requestBody) {
|
|
6288
|
-
return request(OpenAPI, {
|
|
6289
|
-
method: 'PATCH',
|
|
6290
|
-
url: '/api/ai-bot/v1/bots/{org}/bot/{id}/whatsapp-config/',
|
|
6291
|
-
path: {
|
|
6292
|
-
'id': id,
|
|
6293
|
-
'org': org
|
|
6294
|
-
},
|
|
6295
|
-
body: requestBody,
|
|
6296
|
-
mediaType: 'application/json'
|
|
6297
|
-
});
|
|
6298
|
-
}
|
|
6299
|
-
/**
|
|
6300
|
-
* Setup discord user id linkage with discord bots
|
|
6301
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
6302
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
6303
|
-
* @param org
|
|
6304
|
-
* @returns DiscordUserConfig
|
|
6305
|
-
* @throws ApiError
|
|
6306
|
-
*/
|
|
6307
|
-
static aiBotV1BotsDiscordUserConfigList(org) {
|
|
6308
|
-
return request(OpenAPI, {
|
|
6309
|
-
method: 'GET',
|
|
6310
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/',
|
|
6311
|
-
path: {
|
|
6312
|
-
'org': org
|
|
6313
|
-
}
|
|
6314
|
-
});
|
|
6315
|
-
}
|
|
6316
|
-
/**
|
|
6317
|
-
* Setup discord user id linkage with discord bots
|
|
6318
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
6319
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
6320
|
-
* @param org
|
|
6321
|
-
* @param requestBody
|
|
6322
|
-
* @returns DiscordUserConfig
|
|
6323
|
-
* @throws ApiError
|
|
6324
|
-
*/
|
|
6325
|
-
static aiBotV1BotsDiscordUserConfigCreate(org, requestBody) {
|
|
6326
|
-
return request(OpenAPI, {
|
|
6327
|
-
method: 'POST',
|
|
6328
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/',
|
|
6329
|
-
path: {
|
|
6330
|
-
'org': org
|
|
6331
|
-
},
|
|
6332
|
-
body: requestBody,
|
|
6333
|
-
mediaType: 'application/json'
|
|
6334
|
-
});
|
|
6335
|
-
}
|
|
6336
|
-
/**
|
|
6337
|
-
* Setup discord user id linkage with discord bots
|
|
6338
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
6339
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
6340
|
-
* @param id A unique integer value identifying this discord user config.
|
|
6341
|
-
* @param org
|
|
6342
|
-
* @returns DiscordUserConfig
|
|
6343
|
-
* @throws ApiError
|
|
6344
|
-
*/
|
|
6345
|
-
static aiBotV1BotsDiscordUserConfigRetrieve(id, org) {
|
|
6346
|
-
return request(OpenAPI, {
|
|
6347
|
-
method: 'GET',
|
|
6348
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
6349
|
-
path: {
|
|
6350
|
-
'id': id,
|
|
6351
|
-
'org': org
|
|
6352
|
-
}
|
|
6353
|
-
});
|
|
6354
|
-
}
|
|
6355
|
-
/**
|
|
6356
|
-
* Setup discord user id linkage with discord bots
|
|
6357
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
6358
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
6359
|
-
* @param id A unique integer value identifying this discord user config.
|
|
6360
|
-
* @param org
|
|
6361
|
-
* @param requestBody
|
|
6362
|
-
* @returns DiscordUserConfig
|
|
6363
|
-
* @throws ApiError
|
|
6364
|
-
*/
|
|
6365
|
-
static aiBotV1BotsDiscordUserConfigUpdate(id, org, requestBody) {
|
|
6366
|
-
return request(OpenAPI, {
|
|
6367
|
-
method: 'PUT',
|
|
6368
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
6369
|
-
path: {
|
|
6370
|
-
'id': id,
|
|
6371
|
-
'org': org
|
|
6372
|
-
},
|
|
6373
|
-
body: requestBody,
|
|
6374
|
-
mediaType: 'application/json'
|
|
6375
|
-
});
|
|
6376
|
-
}
|
|
6377
|
-
/**
|
|
6378
|
-
* Setup discord user id linkage with discord bots
|
|
6379
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
6380
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
6381
|
-
* @param id A unique integer value identifying this discord user config.
|
|
6382
|
-
* @param org
|
|
6383
|
-
* @param requestBody
|
|
6384
|
-
* @returns DiscordUserConfig
|
|
6385
|
-
* @throws ApiError
|
|
6386
|
-
*/
|
|
6387
|
-
static aiBotV1BotsDiscordUserConfigPartialUpdate(id, org, requestBody) {
|
|
6388
|
-
return request(OpenAPI, {
|
|
6389
|
-
method: 'PATCH',
|
|
6390
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
6391
|
-
path: {
|
|
6392
|
-
'id': id,
|
|
6393
|
-
'org': org
|
|
6394
|
-
},
|
|
6395
|
-
body: requestBody,
|
|
6396
|
-
mediaType: 'application/json'
|
|
6397
|
-
});
|
|
6398
|
-
}
|
|
6399
|
-
/**
|
|
6400
|
-
* Setup discord user id linkage with discord bots
|
|
6401
|
-
* this will be used to authenticate the user when interracting with discord bots.
|
|
6402
|
-
* the user id can be copied from the discord app after tapping on the user profile.
|
|
6403
|
-
* @param id A unique integer value identifying this discord user config.
|
|
6404
|
-
* @param org
|
|
6405
|
-
* @returns void
|
|
6406
|
-
* @throws ApiError
|
|
6407
|
-
*/
|
|
6408
|
-
static aiBotV1BotsDiscordUserConfigDestroy(id, org) {
|
|
6409
|
-
return request(OpenAPI, {
|
|
6410
|
-
method: 'DELETE',
|
|
6411
|
-
url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
|
|
6412
|
-
path: {
|
|
6413
|
-
'id': id,
|
|
6414
|
-
'org': org
|
|
6415
|
-
}
|
|
6416
|
-
});
|
|
6417
|
-
}
|
|
6418
|
-
/**
|
|
6419
|
-
* Setup slack username and domain linkage with slack bots
|
|
6420
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
6421
|
-
* @param org
|
|
6422
|
-
* @returns SlackUserConfig
|
|
6423
|
-
* @throws ApiError
|
|
6424
|
-
*/
|
|
6425
|
-
static aiBotV1BotsSlackUserConfigList(org) {
|
|
6426
|
-
return request(OpenAPI, {
|
|
6427
|
-
method: 'GET',
|
|
6428
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/',
|
|
6429
|
-
path: {
|
|
6430
|
-
'org': org
|
|
6431
|
-
}
|
|
6432
|
-
});
|
|
6433
|
-
}
|
|
6434
|
-
/**
|
|
6435
|
-
* Setup slack username and domain linkage with slack bots
|
|
6436
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
6437
|
-
* @param org
|
|
6438
|
-
* @param requestBody
|
|
6439
|
-
* @returns SlackUserConfig
|
|
6440
|
-
* @throws ApiError
|
|
6441
|
-
*/
|
|
6442
|
-
static aiBotV1BotsSlackUserConfigCreate(org, requestBody) {
|
|
6443
|
-
return request(OpenAPI, {
|
|
6444
|
-
method: 'POST',
|
|
6445
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/',
|
|
6446
|
-
path: {
|
|
6447
|
-
'org': org
|
|
6448
|
-
},
|
|
6449
|
-
body: requestBody,
|
|
6450
|
-
mediaType: 'application/json'
|
|
6451
|
-
});
|
|
6452
|
-
}
|
|
6453
|
-
/**
|
|
6454
|
-
* Setup slack username and domain linkage with slack bots
|
|
6455
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
6456
|
-
* @param id A unique integer value identifying this slack user config.
|
|
6457
|
-
* @param org
|
|
6458
|
-
* @returns SlackUserConfig
|
|
6459
|
-
* @throws ApiError
|
|
6460
|
-
*/
|
|
6461
|
-
static aiBotV1BotsSlackUserConfigRetrieve(id, org) {
|
|
6462
|
-
return request(OpenAPI, {
|
|
6463
|
-
method: 'GET',
|
|
6464
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
6465
|
-
path: {
|
|
6466
|
-
'id': id,
|
|
6467
|
-
'org': org
|
|
6468
|
-
}
|
|
6469
|
-
});
|
|
6470
|
-
}
|
|
6471
|
-
/**
|
|
6472
|
-
* Setup slack username and domain linkage with slack bots
|
|
6473
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
6474
|
-
* @param id A unique integer value identifying this slack user config.
|
|
6475
|
-
* @param org
|
|
6476
|
-
* @param requestBody
|
|
6477
|
-
* @returns SlackUserConfig
|
|
6478
|
-
* @throws ApiError
|
|
6479
|
-
*/
|
|
6480
|
-
static aiBotV1BotsSlackUserConfigUpdate(id, org, requestBody) {
|
|
6481
|
-
return request(OpenAPI, {
|
|
6482
|
-
method: 'PUT',
|
|
6483
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
6484
|
-
path: {
|
|
6485
|
-
'id': id,
|
|
6486
|
-
'org': org
|
|
6487
|
-
},
|
|
6488
|
-
body: requestBody,
|
|
6489
|
-
mediaType: 'application/json'
|
|
6490
|
-
});
|
|
6491
|
-
}
|
|
6492
|
-
/**
|
|
6493
|
-
* Setup slack username and domain linkage with slack bots
|
|
6494
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
6495
|
-
* @param id A unique integer value identifying this slack user config.
|
|
6496
|
-
* @param org
|
|
6497
|
-
* @param requestBody
|
|
6498
|
-
* @returns SlackUserConfig
|
|
6499
|
-
* @throws ApiError
|
|
6500
|
-
*/
|
|
6501
|
-
static aiBotV1BotsSlackUserConfigPartialUpdate(id, org, requestBody) {
|
|
6502
|
-
return request(OpenAPI, {
|
|
6503
|
-
method: 'PATCH',
|
|
6504
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
6505
|
-
path: {
|
|
6506
|
-
'id': id,
|
|
6507
|
-
'org': org
|
|
6508
|
-
},
|
|
6509
|
-
body: requestBody,
|
|
6510
|
-
mediaType: 'application/json'
|
|
6511
|
-
});
|
|
6512
|
-
}
|
|
6513
|
-
/**
|
|
6514
|
-
* Setup slack username and domain linkage with slack bots
|
|
6515
|
-
* this will be used to authenticate the user when interracting with slack bots.
|
|
6516
|
-
* @param id A unique integer value identifying this slack user config.
|
|
6517
|
-
* @param org
|
|
6518
|
-
* @returns void
|
|
6519
|
-
* @throws ApiError
|
|
6520
|
-
*/
|
|
6521
|
-
static aiBotV1BotsSlackUserConfigDestroy(id, org) {
|
|
6522
|
-
return request(OpenAPI, {
|
|
6523
|
-
method: 'DELETE',
|
|
6524
|
-
url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
|
|
6525
|
-
path: {
|
|
6526
|
-
'id': id,
|
|
6527
|
-
'org': org
|
|
6528
|
-
}
|
|
6529
|
-
});
|
|
6530
|
-
}
|
|
6531
|
-
/**
|
|
6532
|
-
* Setup phone number linkage with whatsapp bots
|
|
6533
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
6534
|
-
* @param org
|
|
6535
|
-
* @returns WhatsappUserConfig
|
|
6536
|
-
* @throws ApiError
|
|
6537
|
-
*/
|
|
6538
|
-
static aiBotV1BotsWhatsappUserConfigList(org) {
|
|
6539
|
-
return request(OpenAPI, {
|
|
6540
|
-
method: 'GET',
|
|
6541
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/',
|
|
6542
|
-
path: {
|
|
6543
|
-
'org': org
|
|
6544
|
-
}
|
|
6545
|
-
});
|
|
6546
|
-
}
|
|
6547
|
-
/**
|
|
6548
|
-
* Setup phone number linkage with whatsapp bots
|
|
6549
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
6550
|
-
* @param org
|
|
6551
|
-
* @param requestBody
|
|
6552
|
-
* @returns WhatsappUserConfig
|
|
6553
|
-
* @throws ApiError
|
|
6554
|
-
*/
|
|
6555
|
-
static aiBotV1BotsWhatsappUserConfigCreate(org, requestBody) {
|
|
6556
|
-
return request(OpenAPI, {
|
|
6557
|
-
method: 'POST',
|
|
6558
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/',
|
|
6559
|
-
path: {
|
|
6560
|
-
'org': org
|
|
6561
|
-
},
|
|
6562
|
-
body: requestBody,
|
|
6563
|
-
mediaType: 'application/json'
|
|
6564
|
-
});
|
|
6565
|
-
}
|
|
6566
|
-
/**
|
|
6567
|
-
* Setup phone number linkage with whatsapp bots
|
|
6568
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
6569
|
-
* @param id A unique integer value identifying this whatsapp user config.
|
|
6570
|
-
* @param org
|
|
6571
|
-
* @returns WhatsappUserConfig
|
|
6572
|
-
* @throws ApiError
|
|
6573
|
-
*/
|
|
6574
|
-
static aiBotV1BotsWhatsappUserConfigRetrieve(id, org) {
|
|
6575
|
-
return request(OpenAPI, {
|
|
6576
|
-
method: 'GET',
|
|
6577
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
6578
|
-
path: {
|
|
6579
|
-
'id': id,
|
|
6580
|
-
'org': org
|
|
6581
|
-
}
|
|
6582
|
-
});
|
|
6583
|
-
}
|
|
6584
|
-
/**
|
|
6585
|
-
* Setup phone number linkage with whatsapp bots
|
|
6586
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
6587
|
-
* @param id A unique integer value identifying this whatsapp user config.
|
|
6588
|
-
* @param org
|
|
6589
|
-
* @param requestBody
|
|
6590
|
-
* @returns WhatsappUserConfig
|
|
6591
|
-
* @throws ApiError
|
|
6592
|
-
*/
|
|
6593
|
-
static aiBotV1BotsWhatsappUserConfigUpdate(id, org, requestBody) {
|
|
6594
|
-
return request(OpenAPI, {
|
|
6595
|
-
method: 'PUT',
|
|
6596
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
6597
|
-
path: {
|
|
6598
|
-
'id': id,
|
|
6599
|
-
'org': org
|
|
6600
|
-
},
|
|
6601
|
-
body: requestBody,
|
|
6602
|
-
mediaType: 'application/json'
|
|
6603
|
-
});
|
|
6604
|
-
}
|
|
6605
|
-
/**
|
|
6606
|
-
* Setup phone number linkage with whatsapp bots
|
|
6607
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
6608
|
-
* @param id A unique integer value identifying this whatsapp user config.
|
|
6609
|
-
* @param org
|
|
6610
|
-
* @param requestBody
|
|
6611
|
-
* @returns WhatsappUserConfig
|
|
6612
|
-
* @throws ApiError
|
|
6613
|
-
*/
|
|
6614
|
-
static aiBotV1BotsWhatsappUserConfigPartialUpdate(id, org, requestBody) {
|
|
6615
|
-
return request(OpenAPI, {
|
|
6616
|
-
method: 'PATCH',
|
|
6617
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
6618
|
-
path: {
|
|
6619
|
-
'id': id,
|
|
6620
|
-
'org': org
|
|
6621
|
-
},
|
|
6622
|
-
body: requestBody,
|
|
6623
|
-
mediaType: 'application/json'
|
|
6624
|
-
});
|
|
6625
|
-
}
|
|
6626
|
-
/**
|
|
6627
|
-
* Setup phone number linkage with whatsapp bots
|
|
6628
|
-
* This phone number will be used to authenticate and allow access to whatsapp bots.
|
|
6629
|
-
* @param id A unique integer value identifying this whatsapp user config.
|
|
6630
|
-
* @param org
|
|
6631
|
-
* @returns void
|
|
6632
|
-
* @throws ApiError
|
|
6633
|
-
*/
|
|
6634
|
-
static aiBotV1BotsWhatsappUserConfigDestroy(id, org) {
|
|
6635
|
-
return request(OpenAPI, {
|
|
6636
|
-
method: 'DELETE',
|
|
6637
|
-
url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
|
|
6638
|
-
path: {
|
|
6639
|
-
'id': id,
|
|
6640
|
-
'org': org
|
|
6641
|
-
}
|
|
6642
|
-
});
|
|
6643
|
-
}
|
|
6644
|
-
/**
|
|
6645
|
-
* Webhook endpoint to receive and process discord messages.
|
|
6646
|
-
* @param name
|
|
6647
|
-
* @param org
|
|
6648
|
-
* @param requestBody
|
|
6649
|
-
* @returns DiscordWebhook
|
|
6650
|
-
* @throws ApiError
|
|
6651
|
-
*/
|
|
6652
|
-
static aiBotV1BotsWebhooksDiscordCreate(name, org, requestBody) {
|
|
6653
|
-
return request(OpenAPI, {
|
|
6654
|
-
method: 'POST',
|
|
6655
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/discord/{name}/',
|
|
6656
|
-
path: {
|
|
6657
|
-
'name': name,
|
|
6658
|
-
'org': org
|
|
6659
|
-
},
|
|
6660
|
-
body: requestBody,
|
|
6661
|
-
mediaType: 'application/json'
|
|
6662
|
-
});
|
|
6663
|
-
}
|
|
6664
|
-
/**
|
|
6665
|
-
* @param name
|
|
6666
|
-
* @param org
|
|
6667
|
-
* @param requestBody
|
|
6668
|
-
* @returns SlackWebhook
|
|
6669
|
-
* @throws ApiError
|
|
6670
|
-
*/
|
|
6671
|
-
static aiBotV1BotsWebhooksSlackCreate(name, org, requestBody) {
|
|
6672
|
-
return request(OpenAPI, {
|
|
6673
|
-
method: 'POST',
|
|
6674
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/slack/{name}/',
|
|
6675
|
-
path: {
|
|
6676
|
-
'name': name,
|
|
6677
|
-
'org': org
|
|
6678
|
-
},
|
|
6679
|
-
body: requestBody,
|
|
6680
|
-
mediaType: 'application/json'
|
|
6681
|
-
});
|
|
6682
|
-
}
|
|
6683
|
-
/**
|
|
6684
|
-
* @param name
|
|
6685
|
-
* @param org
|
|
6686
|
-
* @param requestBody
|
|
6687
|
-
* @returns TeamsWebhook
|
|
6688
|
-
* @throws ApiError
|
|
6689
|
-
*/
|
|
6690
|
-
static aiBotV1BotsWebhooksTeamsCreate(name, org, requestBody) {
|
|
6691
|
-
return request(OpenAPI, {
|
|
6692
|
-
method: 'POST',
|
|
6693
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/teams/{name}/',
|
|
6694
|
-
path: {
|
|
6695
|
-
'name': name,
|
|
6696
|
-
'org': org
|
|
6697
|
-
},
|
|
6698
|
-
body: requestBody,
|
|
6699
|
-
mediaType: 'application/json'
|
|
6700
|
-
});
|
|
6701
|
-
}
|
|
6702
|
-
/**
|
|
6703
|
-
* Webhook endpoint to receive and process discord messages.
|
|
6704
|
-
* @param name
|
|
6705
|
-
* @param org
|
|
6706
|
-
* @param requestBody
|
|
6707
|
-
* @returns WebexWebhook
|
|
6708
|
-
* @throws ApiError
|
|
6709
|
-
*/
|
|
6710
|
-
static aiBotV1BotsWebhooksWebexCreate(name, org, requestBody) {
|
|
6711
|
-
return request(OpenAPI, {
|
|
6712
|
-
method: 'POST',
|
|
6713
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/webex/{name}/',
|
|
6714
|
-
path: {
|
|
6715
|
-
'name': name,
|
|
6716
|
-
'org': org
|
|
6717
|
-
},
|
|
6718
|
-
body: requestBody,
|
|
6719
|
-
mediaType: 'application/json'
|
|
6720
|
-
});
|
|
6721
|
-
}
|
|
6722
|
-
/**
|
|
6723
|
-
* Respond to whatsapp's webhook challenge.
|
|
6724
|
-
* Parameters Required include the tenant key (org) and the name of the bot: (name)
|
|
6725
|
-
* @param name
|
|
6726
|
-
* @param org
|
|
6727
|
-
* @returns WhatAppWebHook
|
|
6728
|
-
* @throws ApiError
|
|
6729
|
-
*/
|
|
6730
|
-
static aiBotV1BotsWebhooksWhatsappRetrieve(name, org) {
|
|
6731
|
-
return request(OpenAPI, {
|
|
6732
|
-
method: 'GET',
|
|
6733
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/whatsapp/{name}/',
|
|
6734
|
-
path: {
|
|
6735
|
-
'name': name,
|
|
6736
|
-
'org': org
|
|
6737
|
-
}
|
|
6738
|
-
});
|
|
6739
|
-
}
|
|
6740
|
-
/**
|
|
6741
|
-
* Accept and process webhook events from whatsapp.
|
|
6742
|
-
* @param name
|
|
6743
|
-
* @param org
|
|
6744
|
-
* @param requestBody
|
|
6745
|
-
* @returns WhatAppWebHook
|
|
6746
|
-
* @throws ApiError
|
|
6747
|
-
*/
|
|
6748
|
-
static aiBotV1BotsWebhooksWhatsappCreate(name, org, requestBody) {
|
|
6749
|
-
return request(OpenAPI, {
|
|
6750
|
-
method: 'POST',
|
|
6751
|
-
url: '/api/ai-bot/v1/bots/webhooks/{org}/whatsapp/{name}/',
|
|
6752
|
-
path: {
|
|
6753
|
-
'name': name,
|
|
6754
|
-
'org': org
|
|
6755
|
-
},
|
|
6756
|
-
body: requestBody,
|
|
6757
|
-
mediaType: 'application/json'
|
|
6758
|
-
});
|
|
6759
|
-
}
|
|
6760
|
-
}
|
|
6761
|
-
|
|
6762
|
-
class AiFinetuningService {
|
|
6763
|
-
/**
|
|
6764
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6765
|
-
* @param org
|
|
6766
|
-
* @param username
|
|
6767
|
-
* @param dateCreated
|
|
6768
|
-
* @param numDataPoints
|
|
6769
|
-
* @param ordering Which field to use when ordering the results.
|
|
6770
|
-
* @param page A page number within the paginated result set.
|
|
6771
|
-
* @param pageSize Number of results to return per page.
|
|
6772
|
-
* @param retryAttempts
|
|
6773
|
-
* @param search A search term.
|
|
6774
|
-
* @param status * `pending` - Pending
|
|
6775
|
-
* * `processing` - Processing
|
|
6776
|
-
* * `completed` - Completed
|
|
6777
|
-
* * `failed` - Failed
|
|
6778
|
-
* @returns PaginatedDataSetList
|
|
6779
|
-
* @throws ApiError
|
|
6780
|
-
*/
|
|
6781
|
-
static aiFinetuningV1OrgUserDatasetsList(org, username, dateCreated, numDataPoints, ordering, page, pageSize, retryAttempts, search, status) {
|
|
6782
|
-
return request(OpenAPI, {
|
|
6783
|
-
method: 'GET',
|
|
6784
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/',
|
|
6785
|
-
path: {
|
|
6786
|
-
'org': org,
|
|
6787
|
-
'username': username
|
|
6788
|
-
},
|
|
6789
|
-
query: {
|
|
6790
|
-
'date_created': dateCreated,
|
|
6791
|
-
'num_data_points': numDataPoints,
|
|
6792
|
-
'ordering': ordering,
|
|
6793
|
-
'page': page,
|
|
6794
|
-
'page_size': pageSize,
|
|
6795
|
-
'retry_attempts': retryAttempts,
|
|
6796
|
-
'search': search,
|
|
6797
|
-
'status': status
|
|
6798
|
-
}
|
|
6799
|
-
});
|
|
6800
|
-
}
|
|
6801
|
-
/**
|
|
6802
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6803
|
-
* @param org
|
|
6804
|
-
* @param username
|
|
6805
|
-
* @param requestBody
|
|
6806
|
-
* @returns DataSetCreate
|
|
6807
|
-
* @throws ApiError
|
|
6808
|
-
*/
|
|
6809
|
-
static aiFinetuningV1OrgUserDatasetsCreate(org, username, requestBody) {
|
|
6810
|
-
return request(OpenAPI, {
|
|
6811
|
-
method: 'POST',
|
|
6812
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/',
|
|
6813
|
-
path: {
|
|
6814
|
-
'org': org,
|
|
6815
|
-
'username': username
|
|
6816
|
-
},
|
|
6817
|
-
body: requestBody,
|
|
6818
|
-
mediaType: 'application/json'
|
|
6819
|
-
});
|
|
6820
|
-
}
|
|
6821
|
-
/**
|
|
6822
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6823
|
-
* @param id A UUID string identifying this data set.
|
|
6824
|
-
* @param org
|
|
6825
|
-
* @param username
|
|
6826
|
-
* @returns DataSet
|
|
6827
|
-
* @throws ApiError
|
|
6828
|
-
*/
|
|
6829
|
-
static aiFinetuningV1OrgUserDatasetsRetrieve(id, org, username) {
|
|
6830
|
-
return request(OpenAPI, {
|
|
6831
|
-
method: 'GET',
|
|
6832
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
|
|
6833
|
-
path: {
|
|
6834
|
-
'id': id,
|
|
6835
|
-
'org': org,
|
|
6836
|
-
'username': username
|
|
6837
|
-
}
|
|
6838
|
-
});
|
|
6839
|
-
}
|
|
6840
|
-
/**
|
|
6841
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6842
|
-
* @param id A UUID string identifying this data set.
|
|
6843
|
-
* @param org
|
|
6844
|
-
* @param username
|
|
6845
|
-
* @param requestBody
|
|
6846
|
-
* @returns DataSet
|
|
6847
|
-
* @throws ApiError
|
|
6848
|
-
*/
|
|
6849
|
-
static aiFinetuningV1OrgUserDatasetsUpdate(id, org, username, requestBody) {
|
|
6850
|
-
return request(OpenAPI, {
|
|
6851
|
-
method: 'PUT',
|
|
6852
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
|
|
6853
|
-
path: {
|
|
6854
|
-
'id': id,
|
|
6855
|
-
'org': org,
|
|
6856
|
-
'username': username
|
|
6857
|
-
},
|
|
6858
|
-
body: requestBody,
|
|
6859
|
-
mediaType: 'application/json'
|
|
6860
|
-
});
|
|
6861
|
-
}
|
|
6862
|
-
/**
|
|
6863
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6864
|
-
* @param id A UUID string identifying this data set.
|
|
6865
|
-
* @param org
|
|
6866
|
-
* @param username
|
|
6867
|
-
* @param requestBody
|
|
6868
|
-
* @returns DataSet
|
|
6869
|
-
* @throws ApiError
|
|
6870
|
-
*/
|
|
6871
|
-
static aiFinetuningV1OrgUserDatasetsPartialUpdate(id, org, username, requestBody) {
|
|
6872
|
-
return request(OpenAPI, {
|
|
6873
|
-
method: 'PATCH',
|
|
6874
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
|
|
6875
|
-
path: {
|
|
6876
|
-
'id': id,
|
|
6877
|
-
'org': org,
|
|
6878
|
-
'username': username
|
|
6879
|
-
},
|
|
6880
|
-
body: requestBody,
|
|
6881
|
-
mediaType: 'application/json'
|
|
6882
|
-
});
|
|
6883
|
-
}
|
|
6884
|
-
/**
|
|
6885
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6886
|
-
* @param id A UUID string identifying this data set.
|
|
6887
|
-
* @param org
|
|
6888
|
-
* @param username
|
|
6889
|
-
* @returns void
|
|
6890
|
-
* @throws ApiError
|
|
6891
|
-
*/
|
|
6892
|
-
static aiFinetuningV1OrgUserDatasetsDestroy(id, org, username) {
|
|
6893
|
-
return request(OpenAPI, {
|
|
6894
|
-
method: 'DELETE',
|
|
6895
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
|
|
6896
|
-
path: {
|
|
6897
|
-
'id': id,
|
|
6898
|
-
'org': org,
|
|
6899
|
-
'username': username
|
|
6900
|
-
}
|
|
6901
|
-
});
|
|
6902
|
-
}
|
|
6903
|
-
/**
|
|
6904
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6905
|
-
* @param org
|
|
6906
|
-
* @param username
|
|
6907
|
-
* @param baseModelName
|
|
6908
|
-
* @param dataset
|
|
6909
|
-
* @param dateCreated
|
|
6910
|
-
* @param fineTunedModel
|
|
6911
|
-
* @param lastModified
|
|
6912
|
-
* @param ordering Which field to use when ordering the results.
|
|
6913
|
-
* @param page A page number within the paginated result set.
|
|
6914
|
-
* @param pageSize Number of results to return per page.
|
|
6915
|
-
* @param preprocessDataset
|
|
6916
|
-
* @param provider * `openai` - Openai
|
|
6917
|
-
* @param search A search term.
|
|
6918
|
-
* @param status * `pending` - Pending
|
|
6919
|
-
* * `processing` - Processing
|
|
6920
|
-
* * `completed` - Completed
|
|
6921
|
-
* * `cancelled` - Cancelled
|
|
6922
|
-
* * `failed` - Failed
|
|
6923
|
-
* @returns PaginatedTrainingList
|
|
6924
|
-
* @throws ApiError
|
|
6925
|
-
*/
|
|
6926
|
-
static aiFinetuningV1OrgUserTrainingsList(org, username, baseModelName, dataset, dateCreated, fineTunedModel, lastModified, ordering, page, pageSize, preprocessDataset, provider, search, status) {
|
|
6927
|
-
return request(OpenAPI, {
|
|
6928
|
-
method: 'GET',
|
|
6929
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/',
|
|
6930
|
-
path: {
|
|
6931
|
-
'org': org,
|
|
6932
|
-
'username': username
|
|
6933
|
-
},
|
|
6934
|
-
query: {
|
|
6935
|
-
'base_model_name': baseModelName,
|
|
6936
|
-
'dataset': dataset,
|
|
6937
|
-
'date_created': dateCreated,
|
|
6938
|
-
'fine_tuned_model': fineTunedModel,
|
|
6939
|
-
'last_modified': lastModified,
|
|
6940
|
-
'ordering': ordering,
|
|
6941
|
-
'page': page,
|
|
6942
|
-
'page_size': pageSize,
|
|
6943
|
-
'preprocess_dataset': preprocessDataset,
|
|
6944
|
-
'provider': provider,
|
|
6945
|
-
'search': search,
|
|
6946
|
-
'status': status
|
|
6947
|
-
}
|
|
6948
|
-
});
|
|
6949
|
-
}
|
|
6950
|
-
/**
|
|
6951
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6952
|
-
* @param org
|
|
6953
|
-
* @param username
|
|
6954
|
-
* @param requestBody
|
|
6955
|
-
* @returns TrainingCreate
|
|
6956
|
-
* @throws ApiError
|
|
6957
|
-
*/
|
|
6958
|
-
static aiFinetuningV1OrgUserTrainingsCreate(org, username, requestBody) {
|
|
6959
|
-
return request(OpenAPI, {
|
|
6960
|
-
method: 'POST',
|
|
6961
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/',
|
|
6962
|
-
path: {
|
|
6963
|
-
'org': org,
|
|
6964
|
-
'username': username
|
|
6965
|
-
},
|
|
6966
|
-
body: requestBody,
|
|
6967
|
-
mediaType: 'application/json'
|
|
6968
|
-
});
|
|
6969
|
-
}
|
|
6970
|
-
/**
|
|
6971
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6972
|
-
* @param id A UUID string identifying this training.
|
|
6973
|
-
* @param org
|
|
6974
|
-
* @param username
|
|
6975
|
-
* @returns Training
|
|
6976
|
-
* @throws ApiError
|
|
6977
|
-
*/
|
|
6978
|
-
static aiFinetuningV1OrgUserTrainingsRetrieve(id, org, username) {
|
|
6979
|
-
return request(OpenAPI, {
|
|
6980
|
-
method: 'GET',
|
|
6981
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
|
|
6982
|
-
path: {
|
|
6983
|
-
'id': id,
|
|
6984
|
-
'org': org,
|
|
6985
|
-
'username': username
|
|
6986
|
-
}
|
|
6987
|
-
});
|
|
6988
|
-
}
|
|
6989
|
-
/**
|
|
6990
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
6991
|
-
* @param id A UUID string identifying this training.
|
|
6992
|
-
* @param org
|
|
6993
|
-
* @param username
|
|
6994
|
-
* @param requestBody
|
|
6995
|
-
* @returns TrainingCreate
|
|
6996
|
-
* @throws ApiError
|
|
6997
|
-
*/
|
|
6998
|
-
static aiFinetuningV1OrgUserTrainingsUpdate(id, org, username, requestBody) {
|
|
6999
|
-
return request(OpenAPI, {
|
|
7000
|
-
method: 'PUT',
|
|
7001
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
|
|
7002
|
-
path: {
|
|
7003
|
-
'id': id,
|
|
7004
|
-
'org': org,
|
|
7005
|
-
'username': username
|
|
7006
|
-
},
|
|
7007
|
-
body: requestBody,
|
|
7008
|
-
mediaType: 'application/json'
|
|
7009
|
-
});
|
|
7010
|
-
}
|
|
7011
|
-
/**
|
|
7012
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
7013
|
-
* @param id A UUID string identifying this training.
|
|
7014
|
-
* @param org
|
|
7015
|
-
* @param username
|
|
7016
|
-
* @param requestBody
|
|
7017
|
-
* @returns TrainingCreate
|
|
7018
|
-
* @throws ApiError
|
|
7019
|
-
*/
|
|
7020
|
-
static aiFinetuningV1OrgUserTrainingsPartialUpdate(id, org, username, requestBody) {
|
|
7021
|
-
return request(OpenAPI, {
|
|
7022
|
-
method: 'PATCH',
|
|
7023
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
|
|
7024
|
-
path: {
|
|
7025
|
-
'id': id,
|
|
7026
|
-
'org': org,
|
|
7027
|
-
'username': username
|
|
7028
|
-
},
|
|
7029
|
-
body: requestBody,
|
|
7030
|
-
mediaType: 'application/json'
|
|
7031
|
-
});
|
|
7032
|
-
}
|
|
7033
|
-
/**
|
|
7034
|
-
* Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
|
|
7035
|
-
* @param id A UUID string identifying this training.
|
|
7036
|
-
* @param org
|
|
7037
|
-
* @param username
|
|
7038
|
-
* @returns void
|
|
7039
|
-
* @throws ApiError
|
|
7040
|
-
*/
|
|
7041
|
-
static aiFinetuningV1OrgUserTrainingsDestroy(id, org, username) {
|
|
7042
|
-
return request(OpenAPI, {
|
|
7043
|
-
method: 'DELETE',
|
|
7044
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
|
|
7045
|
-
path: {
|
|
7046
|
-
'id': id,
|
|
7047
|
-
'org': org,
|
|
7048
|
-
'username': username
|
|
7049
|
-
}
|
|
7050
|
-
});
|
|
7051
|
-
}
|
|
7052
|
-
/**
|
|
7053
|
-
* Retrieves a paginated list of completed fine-tuned models, excluding those without a fine-tuned model.
|
|
7054
|
-
* Filtering and pagination is allowed.
|
|
7055
|
-
*
|
|
7056
|
-
* NB: This is only a helper endpoint. The same functionality can be achieved with the appropriate filters using the
|
|
7057
|
-
* training list endpoint.
|
|
7058
|
-
* Returns:
|
|
7059
|
-
* Response: A paginated response containing the serialized fine-tuned models.
|
|
7060
|
-
* @param org
|
|
7061
|
-
* @param username
|
|
7062
|
-
* @returns Training
|
|
7063
|
-
* @throws ApiError
|
|
7064
|
-
*/
|
|
7065
|
-
static aiFinetuningV1OrgUserTrainingsFinetunedModelsRetrieve(org, username) {
|
|
7066
|
-
return request(OpenAPI, {
|
|
7067
|
-
method: 'GET',
|
|
7068
|
-
url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/finetuned-models/',
|
|
7069
|
-
path: {
|
|
7070
|
-
'org': org,
|
|
7071
|
-
'username': username
|
|
7072
|
-
}
|
|
7073
|
-
});
|
|
7074
|
-
}
|
|
7075
|
-
}
|
|
7076
|
-
|
|
7077
|
-
class AiIndexService {
|
|
7078
|
-
/**
|
|
7079
|
-
* Retrieve details of a specific document embedding.
|
|
7080
|
-
*
|
|
7081
|
-
* This endpoint returns detailed information about a specific
|
|
7082
|
-
* document embedding identified by its ID.
|
|
7083
|
-
*
|
|
7084
|
-
* Args:
|
|
7085
|
-
* request: The HTTP request.
|
|
7086
|
-
* org: Organization key identifier.
|
|
7087
|
-
* document_id: The ID of the document embedding to retrieve.
|
|
7088
|
-
*
|
|
7089
|
-
* Returns:
|
|
7090
|
-
* Response: Detailed information about the document embedding.
|
|
7091
|
-
*
|
|
7092
|
-
* Raises:
|
|
7093
|
-
* NotFound: If the specified document embedding does not exist.
|
|
7094
|
-
* @param documentId
|
|
7095
|
-
* @param org
|
|
7096
|
-
* @param userId
|
|
7097
|
-
* @returns RetrieverDocumentEmbedding
|
|
7098
|
-
* @throws ApiError
|
|
7099
|
-
*/
|
|
7100
|
-
static aiIndexOrgsUsersDocumentsRetrieve(documentId, org, userId) {
|
|
7101
|
-
return request(OpenAPI, {
|
|
7102
|
-
method: 'GET',
|
|
7103
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
|
|
7104
|
-
path: {
|
|
7105
|
-
'document_id': documentId,
|
|
7106
|
-
'org': org,
|
|
7107
|
-
'user_id': userId
|
|
7108
|
-
},
|
|
7109
|
-
errors: {
|
|
7110
|
-
404: `Document not found`
|
|
7111
|
-
}
|
|
7112
|
-
});
|
|
7113
|
-
}
|
|
7114
|
-
/**
|
|
7115
|
-
* Update a specific document embedding.
|
|
7116
|
-
*
|
|
7117
|
-
* This endpoint allows updating various properties of a document embedding,
|
|
7118
|
-
* including its name, type, pathway, and training status.
|
|
7119
|
-
*
|
|
7120
|
-
* Args:
|
|
7121
|
-
* request: The HTTP request containing the updated document data.
|
|
7122
|
-
* org: Organization key identifier.
|
|
7123
|
-
* document_id: The ID of the document embedding to update.
|
|
7124
|
-
*
|
|
7125
|
-
* Returns:
|
|
7126
|
-
* Response: The updated document embedding information.
|
|
7127
|
-
*
|
|
7128
|
-
* Raises:
|
|
7129
|
-
* BadRequest: If the provided data is invalid.
|
|
7130
|
-
* NotFound: If the specified document embedding does not exist.
|
|
7131
|
-
* @param documentId
|
|
7132
|
-
* @param org
|
|
7133
|
-
* @param userId
|
|
7134
|
-
* @param formData
|
|
7135
|
-
* @returns RetrieverDocumentEmbedding
|
|
7136
|
-
* @throws ApiError
|
|
7137
|
-
*/
|
|
7138
|
-
static aiIndexOrgsUsersDocumentsUpdate(documentId, org, userId, formData) {
|
|
7139
|
-
return request(OpenAPI, {
|
|
7140
|
-
method: 'PUT',
|
|
7141
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
|
|
7142
|
-
path: {
|
|
7143
|
-
'document_id': documentId,
|
|
7144
|
-
'org': org,
|
|
7145
|
-
'user_id': userId
|
|
7146
|
-
},
|
|
7147
|
-
formData: formData,
|
|
7148
|
-
mediaType: 'multipart/form-data',
|
|
7149
|
-
errors: {
|
|
7150
|
-
400: `Invalid request data`,
|
|
7151
|
-
404: `Document not found`
|
|
7152
|
-
}
|
|
7153
|
-
});
|
|
7154
|
-
}
|
|
7155
|
-
/**
|
|
7156
|
-
* Delete a specific document embedding.
|
|
7157
|
-
*
|
|
7158
|
-
* This endpoint removes a document embedding from the system,
|
|
7159
|
-
* including untraining it from any associated pathways.
|
|
7160
|
-
*
|
|
7161
|
-
* Args:
|
|
7162
|
-
* request: The HTTP request.
|
|
7163
|
-
* org: Organization key identifier.
|
|
7164
|
-
* document_id: The ID of the document embedding to delete.
|
|
7165
|
-
*
|
|
7166
|
-
* Returns:
|
|
7167
|
-
* Response: An empty response with a 204 status code if successful.
|
|
7168
|
-
*
|
|
7169
|
-
* Raises:
|
|
7170
|
-
* NotFound: If the specified document embedding does not exist.
|
|
7171
|
-
* @param documentId
|
|
7172
|
-
* @param org
|
|
7173
|
-
* @param userId
|
|
7174
|
-
* @returns void
|
|
7175
|
-
* @throws ApiError
|
|
7176
|
-
*/
|
|
7177
|
-
static aiIndexOrgsUsersDocumentsDestroy(documentId, org, userId) {
|
|
7178
|
-
return request(OpenAPI, {
|
|
7179
|
-
method: 'DELETE',
|
|
7180
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
|
|
7181
|
-
path: {
|
|
7182
|
-
'document_id': documentId,
|
|
7183
|
-
'org': org,
|
|
7184
|
-
'user_id': userId
|
|
7185
|
-
},
|
|
7186
|
-
errors: {
|
|
7187
|
-
404: `Document not found`
|
|
7188
|
-
}
|
|
7189
|
-
});
|
|
7190
|
-
}
|
|
7191
|
-
/**
|
|
7192
|
-
* Train a graph-based document through a worker process.
|
|
7193
|
-
*
|
|
7194
|
-
* This endpoint queues graph-based documents for training through a
|
|
7195
|
-
* specialized worker process that handles knowledge graph processing.
|
|
7196
|
-
*
|
|
7197
|
-
* Args:
|
|
7198
|
-
* request: The HTTP request containing the document information.
|
|
7199
|
-
* org: Organization key identifier.
|
|
7200
|
-
*
|
|
7201
|
-
* Returns:
|
|
7202
|
-
* Response: A confirmation that the document was queued for training,
|
|
7203
|
-
* including a task ID for tracking the progress.
|
|
7204
|
-
*
|
|
7205
|
-
* Raises:
|
|
7206
|
-
* ValidationError: If the request data is invalid.
|
|
7207
|
-
* BadRequest: If there was an error processing the document.
|
|
7208
|
-
* @param org
|
|
7209
|
-
* @param userId
|
|
7210
|
-
* @param formData
|
|
7211
|
-
* @returns TrainDocumentViewResponse
|
|
7212
|
-
* @throws ApiError
|
|
7213
|
-
*/
|
|
7214
|
-
static aiIndexOrgsUsersDocumentsGraphTrainCreate(org, userId, formData) {
|
|
7215
|
-
return request(OpenAPI, {
|
|
7216
|
-
method: 'POST',
|
|
7217
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/graph-train/',
|
|
7218
|
-
path: {
|
|
7219
|
-
'org': org,
|
|
7220
|
-
'user_id': userId
|
|
7221
|
-
},
|
|
7222
|
-
formData: formData,
|
|
7223
|
-
mediaType: 'multipart/form-data',
|
|
7224
|
-
errors: {
|
|
7225
|
-
400: `Invalid request data or document processing error`
|
|
7226
|
-
}
|
|
7227
|
-
});
|
|
7228
|
-
}
|
|
7229
|
-
/**
|
|
7230
|
-
* Retrieve a list of document embeddings for a specific pathway.
|
|
7231
|
-
*
|
|
7232
|
-
* This endpoint returns a paginated list of all document embeddings
|
|
7233
|
-
* that have been created for the specified pathway within the organization.
|
|
7234
|
-
*
|
|
7235
|
-
* Args:
|
|
7236
|
-
* request: The HTTP request.
|
|
7237
|
-
* org: Organization key identifier.
|
|
7238
|
-
* pathway: The pathway to retrieve document embeddings for.
|
|
7239
|
-
*
|
|
7240
|
-
* Returns:
|
|
7241
|
-
* Response: A paginated list of document embeddings for the pathway.
|
|
7242
|
-
* @param org
|
|
7243
|
-
* @param pathway
|
|
7244
|
-
* @param userId
|
|
7245
|
-
* @returns RetrieverDocumentEmbedding
|
|
7246
|
-
* @throws ApiError
|
|
7247
|
-
*/
|
|
7248
|
-
static aiIndexOrgsUsersDocumentsPathwaysList(org, pathway, userId) {
|
|
7249
|
-
return request(OpenAPI, {
|
|
7250
|
-
method: 'GET',
|
|
7251
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/pathways/{pathway}/',
|
|
7252
|
-
path: {
|
|
7253
|
-
'org': org,
|
|
7254
|
-
'pathway': pathway,
|
|
7255
|
-
'user_id': userId
|
|
7256
|
-
}
|
|
7257
|
-
});
|
|
7258
|
-
}
|
|
7259
|
-
/**
|
|
7260
|
-
* Retrieve resource documents similar to the given query.
|
|
7261
|
-
*
|
|
7262
|
-
* This endpoint performs a semantic search to find documents that are
|
|
7263
|
-
* relevant to the provided query within the specified pathway.
|
|
7264
|
-
*
|
|
7265
|
-
* Args:
|
|
7266
|
-
* request: The HTTP request containing the search query.
|
|
7267
|
-
* org: Organization key identifier.
|
|
7268
|
-
*
|
|
7269
|
-
* Returns:
|
|
7270
|
-
* Response: A list of documents relevant to the search query.
|
|
7271
|
-
*
|
|
7272
|
-
* Raises:
|
|
7273
|
-
* ValidationError: If the request data is invalid.
|
|
7274
|
-
* @param org
|
|
7275
|
-
* @param userId
|
|
7276
|
-
* @param requestBody
|
|
7277
|
-
* @returns RetrieverResponseSearch
|
|
7278
|
-
* @throws ApiError
|
|
7279
|
-
*/
|
|
7280
|
-
static aiIndexOrgsUsersDocumentsSearchCreate(org, userId, requestBody) {
|
|
7281
|
-
return request(OpenAPI, {
|
|
7282
|
-
method: 'POST',
|
|
7283
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/search/',
|
|
7284
|
-
path: {
|
|
7285
|
-
'org': org,
|
|
7286
|
-
'user_id': userId
|
|
7287
|
-
},
|
|
7288
|
-
body: requestBody,
|
|
7289
|
-
mediaType: 'application/json',
|
|
7290
|
-
errors: {
|
|
7291
|
-
400: `Invalid request data`
|
|
7292
|
-
}
|
|
7293
|
-
});
|
|
7294
|
-
}
|
|
7295
|
-
/**
|
|
7296
|
-
* Retrieve document sources related to a given query.
|
|
7297
|
-
*
|
|
7298
|
-
* This endpoint performs a semantic search to find document sources
|
|
7299
|
-
* that are relevant to the provided query within the specified pathway,
|
|
7300
|
-
* and returns them along with confidence levels.
|
|
7301
|
-
*
|
|
7302
|
-
* Args:
|
|
7303
|
-
* request: The HTTP request containing the search query.
|
|
7304
|
-
* org: Organization key identifier.
|
|
7305
|
-
*
|
|
7306
|
-
* Returns:
|
|
7307
|
-
* Response: A list of document sources with confidence levels.
|
|
7308
|
-
*
|
|
7309
|
-
* Raises:
|
|
7310
|
-
* ValidationError: If the request data is invalid.
|
|
7311
|
-
* @param org
|
|
7312
|
-
* @param userId
|
|
7313
|
-
* @param requestBody
|
|
7314
|
-
* @returns RetrieverRequestSearchDocument
|
|
7315
|
-
* @throws ApiError
|
|
7316
|
-
*/
|
|
7317
|
-
static aiIndexOrgsUsersDocumentsSourcesCreate(org, userId, requestBody) {
|
|
7318
|
-
return request(OpenAPI, {
|
|
7319
|
-
method: 'POST',
|
|
7320
|
-
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/sources/',
|
|
7321
|
-
path: {
|
|
7322
|
-
'org': org,
|
|
7323
|
-
'user_id': userId
|
|
7324
|
-
},
|
|
7325
|
-
body: requestBody,
|
|
7326
|
-
mediaType: 'application/json',
|
|
7327
|
-
errors: {
|
|
7328
|
-
400: `Invalid request data`
|
|
7329
|
-
}
|
|
7330
|
-
});
|
|
7331
|
-
}
|
|
7332
|
-
/**
|
|
7333
|
-
* Check the status of a document training task.
|
|
7334
|
-
*
|
|
7335
|
-
* This endpoint retrieves the current status of an asynchronous
|
|
7336
|
-
* document training task that was previously initiated.
|
|
7337
|
-
*
|
|
7338
|
-
* Args:
|
|
7339
|
-
* request: The HTTP request.
|
|
7340
|
-
* org: Organization key identifier.
|
|
7341
|
-
* task_id: The ID of the training task to check.
|
|
7342
|
-
*
|
|
7343
|
-
* Returns:
|
|
7344
|
-
* Response: The current status of the document training task,
|
|
7345
|
-
* which can be "pending", "completed", or "failed".
|
|
7346
|
-
* @param org
|
|
7347
|
-
* @param taskId
|
|
7348
|
-
* @param userId
|
|
7349
|
-
* @returns CheckDocumentTrainingStatus
|
|
7350
|
-
* @throws ApiError
|
|
7351
|
-
*/
|
|
7352
|
-
static aiIndexOrgsUsersDocumentsTasksRetrieve(org, taskId, userId) {
|
|
6018
|
+
static aiIndexOrgsUsersDocumentsTasksRetrieve(org, taskId, userId) {
|
|
7353
6019
|
return request(OpenAPI, {
|
|
7354
6020
|
method: 'GET',
|
|
7355
6021
|
url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/tasks/{task_id}/',
|
|
@@ -7675,60 +6341,121 @@ class AiMarketingService {
|
|
|
7675
6341
|
|
|
7676
6342
|
class AiMediaService {
|
|
7677
6343
|
/**
|
|
7678
|
-
*
|
|
6344
|
+
* API view to list or append Heygen template ids for a tenant.
|
|
7679
6345
|
* @param org
|
|
7680
6346
|
* @param userId
|
|
7681
|
-
* @
|
|
6347
|
+
* @param page A page number within the paginated result set.
|
|
6348
|
+
* @returns PaginatedHeygenTemplateResponseSingleList
|
|
7682
6349
|
* @throws ApiError
|
|
7683
6350
|
*/
|
|
7684
|
-
static
|
|
6351
|
+
static aiMediaOrgsUsersHeygenTemplatesList(org, userId, page) {
|
|
7685
6352
|
return request(OpenAPI, {
|
|
7686
6353
|
method: 'GET',
|
|
7687
6354
|
url: '/api/ai-media/orgs/{org}/users/{user_id}/heygen/templates/',
|
|
7688
6355
|
path: {
|
|
7689
6356
|
'org': org,
|
|
7690
6357
|
'user_id': userId
|
|
6358
|
+
},
|
|
6359
|
+
query: {
|
|
6360
|
+
'page': page
|
|
7691
6361
|
}
|
|
7692
6362
|
});
|
|
7693
6363
|
}
|
|
7694
6364
|
/**
|
|
7695
|
-
*
|
|
6365
|
+
* Endpoint to add a Heygen template id to an org.
|
|
6366
|
+
*
|
|
6367
|
+
* Only platform admins have access to this endpoint.
|
|
7696
6368
|
* @param org
|
|
7697
6369
|
* @param userId
|
|
7698
|
-
* @
|
|
6370
|
+
* @param requestBody
|
|
6371
|
+
* @returns HeygenTemplateResponseSingle
|
|
7699
6372
|
* @throws ApiError
|
|
7700
6373
|
*/
|
|
7701
|
-
static aiMediaOrgsUsersHeygenTemplatesCreate(org, userId) {
|
|
6374
|
+
static aiMediaOrgsUsersHeygenTemplatesCreate(org, userId, requestBody) {
|
|
7702
6375
|
return request(OpenAPI, {
|
|
7703
6376
|
method: 'POST',
|
|
7704
6377
|
url: '/api/ai-media/orgs/{org}/users/{user_id}/heygen/templates/',
|
|
7705
6378
|
path: {
|
|
7706
6379
|
'org': org,
|
|
7707
6380
|
'user_id': userId
|
|
7708
|
-
}
|
|
6381
|
+
},
|
|
6382
|
+
body: requestBody,
|
|
6383
|
+
mediaType: 'application/json'
|
|
7709
6384
|
});
|
|
7710
6385
|
}
|
|
7711
6386
|
/**
|
|
7712
|
-
*
|
|
6387
|
+
* Endpoint to delete a Heygen template id for an org.
|
|
6388
|
+
*
|
|
6389
|
+
*
|
|
6390
|
+
* The reponse status code is always 204 when no error.
|
|
6391
|
+
*
|
|
6392
|
+
*
|
|
6393
|
+
* Only platform admins have access to this endpoint.
|
|
7713
6394
|
* @param org
|
|
7714
|
-
* @param
|
|
6395
|
+
* @param templateName
|
|
7715
6396
|
* @param userId
|
|
7716
6397
|
* @returns void
|
|
7717
6398
|
* @throws ApiError
|
|
7718
6399
|
*/
|
|
7719
|
-
static aiMediaOrgsUsersHeygenTemplatesDestroy(org,
|
|
6400
|
+
static aiMediaOrgsUsersHeygenTemplatesDestroy(org, templateName, userId) {
|
|
7720
6401
|
return request(OpenAPI, {
|
|
7721
6402
|
method: 'DELETE',
|
|
7722
|
-
url: '/api/ai-media/orgs/{org}/users/{user_id}/heygen/templates/{
|
|
6403
|
+
url: '/api/ai-media/orgs/{org}/users/{user_id}/heygen/templates/{template_name}/',
|
|
7723
6404
|
path: {
|
|
7724
6405
|
'org': org,
|
|
7725
|
-
'
|
|
6406
|
+
'template_name': templateName,
|
|
7726
6407
|
'user_id': userId
|
|
7727
6408
|
}
|
|
7728
6409
|
});
|
|
7729
6410
|
}
|
|
7730
6411
|
/**
|
|
7731
|
-
*
|
|
6412
|
+
* Endpoint to download caption for a video.
|
|
6413
|
+
* @param heygenMarketingVideoId
|
|
6414
|
+
* @param org
|
|
6415
|
+
* @param userId
|
|
6416
|
+
* @returns any No response body
|
|
6417
|
+
* @throws ApiError
|
|
6418
|
+
*/
|
|
6419
|
+
static aiMediaOrgsUsersHeygenVideoCaptionsRetrieve(heygenMarketingVideoId, org, userId) {
|
|
6420
|
+
return request(OpenAPI, {
|
|
6421
|
+
method: 'GET',
|
|
6422
|
+
url: '/api/ai-media/orgs/{org}/users/{user_id}/heygen/video-captions/{heygen_marketing_video_id}/',
|
|
6423
|
+
path: {
|
|
6424
|
+
'heygen_marketing_video_id': heygenMarketingVideoId,
|
|
6425
|
+
'org': org,
|
|
6426
|
+
'user_id': userId
|
|
6427
|
+
}
|
|
6428
|
+
});
|
|
6429
|
+
}
|
|
6430
|
+
/**
|
|
6431
|
+
* Endpoint to upload a new caption for a generated video.
|
|
6432
|
+
*
|
|
6433
|
+
* Only platform admins have access to this endpoint.
|
|
6434
|
+
* @param heygenMarketingVideoId
|
|
6435
|
+
* @param org
|
|
6436
|
+
* @param userId
|
|
6437
|
+
* @param formData
|
|
6438
|
+
* @returns HeygenVideoDetail
|
|
6439
|
+
* @throws ApiError
|
|
6440
|
+
*/
|
|
6441
|
+
static aiMediaOrgsUsersHeygenVideoCaptionsCreate(heygenMarketingVideoId, org, userId, formData) {
|
|
6442
|
+
return request(OpenAPI, {
|
|
6443
|
+
method: 'POST',
|
|
6444
|
+
url: '/api/ai-media/orgs/{org}/users/{user_id}/heygen/video-captions/{heygen_marketing_video_id}/',
|
|
6445
|
+
path: {
|
|
6446
|
+
'heygen_marketing_video_id': heygenMarketingVideoId,
|
|
6447
|
+
'org': org,
|
|
6448
|
+
'user_id': userId
|
|
6449
|
+
},
|
|
6450
|
+
formData: formData,
|
|
6451
|
+
mediaType: 'multipart/form-data'
|
|
6452
|
+
});
|
|
6453
|
+
}
|
|
6454
|
+
/**
|
|
6455
|
+
* Endpoint used to download a heygen video.
|
|
6456
|
+
*
|
|
6457
|
+
*
|
|
6458
|
+
* Only platform admins have access to this endpoint.
|
|
7732
6459
|
* @param heygenMarketingVideoId
|
|
7733
6460
|
* @param org
|
|
7734
6461
|
* @param userId
|
|
@@ -7768,11 +6495,13 @@ class AiMediaService {
|
|
|
7768
6495
|
});
|
|
7769
6496
|
}
|
|
7770
6497
|
/**
|
|
7771
|
-
*
|
|
6498
|
+
* Endpoint to create a Heygen video
|
|
6499
|
+
*
|
|
6500
|
+
* Only platform admins have access to this endpoint.
|
|
7772
6501
|
* @param org
|
|
7773
6502
|
* @param userId
|
|
7774
6503
|
* @param requestBody
|
|
7775
|
-
* @returns
|
|
6504
|
+
* @returns HeygenVideoDetail
|
|
7776
6505
|
* @throws ApiError
|
|
7777
6506
|
*/
|
|
7778
6507
|
static aiMediaOrgsUsersHeygenVideosCreate(org, userId, requestBody) {
|
|
@@ -7807,7 +6536,9 @@ class AiMediaService {
|
|
|
7807
6536
|
});
|
|
7808
6537
|
}
|
|
7809
6538
|
/**
|
|
7810
|
-
*
|
|
6539
|
+
* Endpoint used to delete a heygen video.
|
|
6540
|
+
*
|
|
6541
|
+
* Only platform admins have access to this endpoint.
|
|
7811
6542
|
* @param heygenMarketingVideoId
|
|
7812
6543
|
* @param org
|
|
7813
6544
|
* @param userId
|
|
@@ -33634,8 +32365,6 @@ class UserGroupsService {
|
|
|
33634
32365
|
|
|
33635
32366
|
exports.AiAccountService = AiAccountService;
|
|
33636
32367
|
exports.AiAnalyticsService = AiAnalyticsService;
|
|
33637
|
-
exports.AiBotService = AiBotService;
|
|
33638
|
-
exports.AiFinetuningService = AiFinetuningService;
|
|
33639
32368
|
exports.AiIndexService = AiIndexService;
|
|
33640
32369
|
exports.AiMarketingService = AiMarketingService;
|
|
33641
32370
|
exports.AiMediaService = AiMediaService;
|