@iblai/iblai-api 3.45.7-ai-plus → 3.45.8-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.
Files changed (95) hide show
  1. package/dist/index.cjs.js +109 -1404
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +110 -1403
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +109 -1404
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/index.d.ts +2 -40
  8. package/dist/types/models/DocumentSettingsResponse.d.ts +3 -0
  9. package/dist/types/models/{VoiceProviderEnum.d.ts → ProviderEnum.d.ts} +1 -1
  10. package/dist/types/models/Voice.d.ts +2 -2
  11. package/dist/types/services/AiIndexService.d.ts +20 -0
  12. package/package.json +1 -1
  13. package/src/core/OpenAPI.ts +1 -1
  14. package/src/index.ts +2 -40
  15. package/src/models/{WhatAppWebHook.ts → DocumentSettingsResponse.ts} +2 -2
  16. package/src/models/{VoiceProviderEnum.ts → ProviderEnum.ts} +1 -1
  17. package/src/models/Voice.ts +2 -2
  18. package/src/services/AiIndexService.ts +51 -0
  19. package/dist/types/models/Bot.d.ts +0 -15
  20. package/dist/types/models/BotCommand.d.ts +0 -6
  21. package/dist/types/models/BotCreate.d.ts +0 -12
  22. package/dist/types/models/DataSet.d.ts +0 -21
  23. package/dist/types/models/DataSetCreate.d.ts +0 -12
  24. package/dist/types/models/DataSetStatusEnum.d.ts +0 -12
  25. package/dist/types/models/DiscordConfig.d.ts +0 -7
  26. package/dist/types/models/DiscordUserConfig.d.ts +0 -10
  27. package/dist/types/models/DiscordWebhook.d.ts +0 -6
  28. package/dist/types/models/PaginatedDataSetList.d.ts +0 -7
  29. package/dist/types/models/PaginatedTrainingList.d.ts +0 -7
  30. package/dist/types/models/PatchedBotCommand.d.ts +0 -6
  31. package/dist/types/models/PatchedBotCreate.d.ts +0 -12
  32. package/dist/types/models/PatchedDataSet.d.ts +0 -21
  33. package/dist/types/models/PatchedDiscordConfig.d.ts +0 -7
  34. package/dist/types/models/PatchedDiscordUserConfig.d.ts +0 -10
  35. package/dist/types/models/PatchedSlackConfig.d.ts +0 -8
  36. package/dist/types/models/PatchedSlackUserConfig.d.ts +0 -17
  37. package/dist/types/models/PatchedTeamsConfig.d.ts +0 -7
  38. package/dist/types/models/PatchedTrainingCreate.d.ts +0 -31
  39. package/dist/types/models/PatchedWebexConfig.d.ts +0 -10
  40. package/dist/types/models/PatchedWhatsappConfig.d.ts +0 -11
  41. package/dist/types/models/PatchedWhatsappUserConfig.d.ts +0 -10
  42. package/dist/types/models/Provider05cEnum.d.ts +0 -14
  43. package/dist/types/models/Provider63aEnum.d.ts +0 -6
  44. package/dist/types/models/SlackConfig.d.ts +0 -8
  45. package/dist/types/models/SlackUserConfig.d.ts +0 -17
  46. package/dist/types/models/SlackWebhook.d.ts +0 -6
  47. package/dist/types/models/TeamsConfig.d.ts +0 -7
  48. package/dist/types/models/TeamsWebhook.d.ts +0 -17
  49. package/dist/types/models/Training.d.ts +0 -41
  50. package/dist/types/models/TrainingCreate.d.ts +0 -31
  51. package/dist/types/models/WebexConfig.d.ts +0 -10
  52. package/dist/types/models/WebexWebhook.d.ts +0 -4
  53. package/dist/types/models/WhatAppWebHook.d.ts +0 -3
  54. package/dist/types/models/WhatsappConfig.d.ts +0 -11
  55. package/dist/types/models/WhatsappUserConfig.d.ts +0 -10
  56. package/dist/types/services/AiBotService.d.ts +0 -486
  57. package/dist/types/services/AiFinetuningService.d.ts +0 -162
  58. package/src/models/Bot.ts +0 -20
  59. package/src/models/BotCommand.ts +0 -11
  60. package/src/models/BotCreate.ts +0 -17
  61. package/src/models/DataSet.ts +0 -26
  62. package/src/models/DataSetCreate.ts +0 -17
  63. package/src/models/DataSetStatusEnum.ts +0 -16
  64. package/src/models/DiscordConfig.ts +0 -12
  65. package/src/models/DiscordUserConfig.ts +0 -15
  66. package/src/models/DiscordWebhook.ts +0 -11
  67. package/src/models/PaginatedDataSetList.ts +0 -12
  68. package/src/models/PaginatedTrainingList.ts +0 -12
  69. package/src/models/PatchedBotCommand.ts +0 -11
  70. package/src/models/PatchedBotCreate.ts +0 -17
  71. package/src/models/PatchedDataSet.ts +0 -26
  72. package/src/models/PatchedDiscordConfig.ts +0 -12
  73. package/src/models/PatchedDiscordUserConfig.ts +0 -15
  74. package/src/models/PatchedSlackConfig.ts +0 -13
  75. package/src/models/PatchedSlackUserConfig.ts +0 -22
  76. package/src/models/PatchedTeamsConfig.ts +0 -12
  77. package/src/models/PatchedTrainingCreate.ts +0 -36
  78. package/src/models/PatchedWebexConfig.ts +0 -15
  79. package/src/models/PatchedWhatsappConfig.ts +0 -16
  80. package/src/models/PatchedWhatsappUserConfig.ts +0 -15
  81. package/src/models/Provider05cEnum.ts +0 -18
  82. package/src/models/Provider63aEnum.ts +0 -10
  83. package/src/models/SlackConfig.ts +0 -13
  84. package/src/models/SlackUserConfig.ts +0 -22
  85. package/src/models/SlackWebhook.ts +0 -11
  86. package/src/models/TeamsConfig.ts +0 -12
  87. package/src/models/TeamsWebhook.ts +0 -22
  88. package/src/models/Training.ts +0 -46
  89. package/src/models/TrainingCreate.ts +0 -36
  90. package/src/models/WebexConfig.ts +0 -15
  91. package/src/models/WebexWebhook.ts +0 -9
  92. package/src/models/WhatsappConfig.ts +0 -16
  93. package/src/models/WhatsappUserConfig.ts +0 -15
  94. package/src/services/AiBotService.ts +0 -1174
  95. 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.6-ai-plus',
117
+ VERSION: '3.45.8-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.Provider63aEnum = void 0;
566
- (function (Provider63aEnum) {
567
- Provider63aEnum["OPENAI"] = "openai";
568
- })(exports.Provider63aEnum || (exports.Provider63aEnum = {}));
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,1404 +5744,161 @@
5794
5744
  }
5795
5745
  }
5796
5746
 
5797
- class AiBotService {
5798
- /**
5799
- * Create modify and update bot information for a specific tenant.
5800
- * @param org
5801
- * @returns Bot
5802
- * @throws ApiError
5803
- */
5804
- static aiBotV1BotsBotList(org) {
5805
- return request(OpenAPI, {
5806
- method: 'GET',
5807
- url: '/api/ai-bot/v1/bots/{org}/bot/',
5808
- path: {
5809
- 'org': org
5810
- }
5811
- });
5812
- }
5813
- /**
5814
- * Create modify and update bot information for a specific tenant.
5815
- * @param org
5816
- * @param requestBody
5817
- * @returns BotCreate
5818
- * @throws ApiError
5819
- */
5820
- static aiBotV1BotsBotCreate(org, requestBody) {
5821
- return request(OpenAPI, {
5822
- method: 'POST',
5823
- url: '/api/ai-bot/v1/bots/{org}/bot/',
5824
- path: {
5825
- 'org': org
5826
- },
5827
- body: requestBody,
5828
- mediaType: 'application/json'
5829
- });
5830
- }
5747
+ class AiIndexService {
5831
5748
  /**
5832
- * Create slash commands for a specific bot
5833
- * eg. /iblai-baseline
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
5834
5765
  * @param org
5835
- * @returns BotCommand
5766
+ * @param userId
5767
+ * @returns RetrieverDocumentEmbedding
5836
5768
  * @throws ApiError
5837
5769
  */
5838
- static aiBotV1BotsBotCommandsList(org) {
5770
+ static aiIndexOrgsUsersDocumentsRetrieve(documentId, org, userId) {
5839
5771
  return request(OpenAPI, {
5840
5772
  method: 'GET',
5841
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/',
5842
- path: {
5843
- 'org': org
5844
- }
5845
- });
5846
- }
5847
- /**
5848
- * Create slash commands for a specific bot
5849
- * eg. /iblai-baseline
5850
- * @param org
5851
- * @param requestBody
5852
- * @returns BotCommand
5853
- * @throws ApiError
5854
- */
5855
- static aiBotV1BotsBotCommandsCreate(org, requestBody) {
5856
- return request(OpenAPI, {
5857
- method: 'POST',
5858
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/',
5773
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
5859
5774
  path: {
5860
- 'org': org
5775
+ 'document_id': documentId,
5776
+ 'org': org,
5777
+ 'user_id': userId
5861
5778
  },
5862
- body: requestBody,
5863
- mediaType: 'application/json'
5864
- });
5865
- }
5866
- /**
5867
- * Create slash commands for a specific bot
5868
- * eg. /iblai-baseline
5869
- * @param id A unique integer value identifying this bot command.
5870
- * @param org
5871
- * @returns BotCommand
5872
- * @throws ApiError
5873
- */
5874
- static aiBotV1BotsBotCommandsRetrieve(id, org) {
5875
- return request(OpenAPI, {
5876
- method: 'GET',
5877
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
5878
- path: {
5879
- 'id': id,
5880
- 'org': org
5779
+ errors: {
5780
+ 404: `Document not found`
5881
5781
  }
5882
5782
  });
5883
5783
  }
5884
5784
  /**
5885
- * Create slash commands for a specific bot
5886
- * eg. /iblai-baseline
5887
- * @param id A unique integer value identifying this bot command.
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
5888
5802
  * @param org
5889
- * @param requestBody
5890
- * @returns BotCommand
5803
+ * @param userId
5804
+ * @param formData
5805
+ * @returns RetrieverDocumentEmbedding
5891
5806
  * @throws ApiError
5892
5807
  */
5893
- static aiBotV1BotsBotCommandsUpdate(id, org, requestBody) {
5808
+ static aiIndexOrgsUsersDocumentsUpdate(documentId, org, userId, formData) {
5894
5809
  return request(OpenAPI, {
5895
5810
  method: 'PUT',
5896
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
5897
- path: {
5898
- 'id': id,
5899
- 'org': org
5900
- },
5901
- body: requestBody,
5902
- mediaType: 'application/json'
5903
- });
5904
- }
5905
- /**
5906
- * Create slash commands for a specific bot
5907
- * eg. /iblai-baseline
5908
- * @param id A unique integer value identifying this bot command.
5909
- * @param org
5910
- * @param requestBody
5911
- * @returns BotCommand
5912
- * @throws ApiError
5913
- */
5914
- static aiBotV1BotsBotCommandsPartialUpdate(id, org, requestBody) {
5915
- return request(OpenAPI, {
5916
- method: 'PATCH',
5917
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
5811
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
5918
5812
  path: {
5919
- 'id': id,
5920
- 'org': org
5813
+ 'document_id': documentId,
5814
+ 'org': org,
5815
+ 'user_id': userId
5921
5816
  },
5922
- body: requestBody,
5923
- mediaType: 'application/json'
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
5941
- }
5942
- });
5943
- }
5944
- /**
5945
- * Create modify and update bot information for a specific tenant.
5946
- * @param id A unique integer value identifying this bot.
5947
- * @param org
5948
- * @returns Bot
5949
- * @throws ApiError
5950
- */
5951
- static aiBotV1BotsBotRetrieve(id, org) {
5952
- return request(OpenAPI, {
5953
- method: 'GET',
5954
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
5955
- path: {
5956
- 'id': id,
5957
- 'org': org
5817
+ formData: formData,
5818
+ mediaType: 'multipart/form-data',
5819
+ errors: {
5820
+ 400: `Invalid request data`,
5821
+ 404: `Document not found`
5958
5822
  }
5959
5823
  });
5960
5824
  }
5961
5825
  /**
5962
- * Create modify and update bot information for a specific tenant.
5963
- * @param id A unique integer value identifying this bot.
5964
- * @param org
5965
- * @param requestBody
5966
- * @returns BotCreate
5967
- * @throws ApiError
5968
- */
5969
- static aiBotV1BotsBotUpdate(id, org, requestBody) {
5970
- return request(OpenAPI, {
5971
- method: 'PUT',
5972
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
5973
- path: {
5974
- 'id': id,
5975
- 'org': org
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.
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
6004
5842
  * @param org
5843
+ * @param userId
6005
5844
  * @returns void
6006
5845
  * @throws ApiError
6007
5846
  */
6008
- static aiBotV1BotsBotDestroy(id, org) {
5847
+ static aiIndexOrgsUsersDocumentsDestroy(documentId, org, userId) {
6009
5848
  return request(OpenAPI, {
6010
5849
  method: 'DELETE',
6011
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
5850
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
6012
5851
  path: {
6013
- 'id': id,
6014
- 'org': org
5852
+ 'document_id': documentId,
5853
+ 'org': org,
5854
+ 'user_id': userId
5855
+ },
5856
+ errors: {
5857
+ 404: `Document not found`
6015
5858
  }
6016
5859
  });
6017
5860
  }
6018
5861
  /**
6019
- * Create modify and update bot information for a specific tenant.
6020
- * @param id A unique integer value identifying this bot.
5862
+ * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
5863
+ * @param documentId
6021
5864
  * @param org
6022
- * @returns DiscordConfig
5865
+ * @param userId
5866
+ * @returns DocumentSettingsResponse
6023
5867
  * @throws ApiError
6024
5868
  */
6025
- static aiBotV1BotsBotConfigDiscordRetrieve(id, org) {
5869
+ static aiIndexOrgsUsersDocumentsSettingsRetrieve(documentId, org, userId) {
6026
5870
  return request(OpenAPI, {
6027
5871
  method: 'GET',
6028
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
5872
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/',
6029
5873
  path: {
6030
- 'id': id,
6031
- 'org': org
5874
+ 'document_id': documentId,
5875
+ 'org': org,
5876
+ 'user_id': userId
6032
5877
  }
6033
5878
  });
6034
5879
  }
6035
5880
  /**
6036
- * Create modify and update bot information for a specific tenant.
6037
- * @param id A unique integer value identifying this bot.
5881
+ * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
5882
+ * @param documentId
6038
5883
  * @param org
5884
+ * @param userId
6039
5885
  * @param requestBody
6040
- * @returns DiscordConfig
5886
+ * @returns DocumentSettingsResponse
6041
5887
  * @throws ApiError
6042
5888
  */
6043
- static aiBotV1BotsBotConfigDiscordPartialUpdate(id, org, requestBody) {
5889
+ static aiIndexOrgsUsersDocumentsSettingsCreate(documentId, org, userId, requestBody) {
6044
5890
  return request(OpenAPI, {
6045
- method: 'PATCH',
6046
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
5891
+ method: 'POST',
5892
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/',
6047
5893
  path: {
6048
- 'id': id,
6049
- 'org': org
5894
+ 'document_id': documentId,
5895
+ 'org': org,
5896
+ 'user_id': userId
6050
5897
  },
6051
5898
  body: requestBody,
6052
5899
  mediaType: 'application/json'
6053
5900
  });
6054
5901
  }
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
5902
  /**
7196
5903
  * Train a graph-based document through a worker process.
7197
5904
  *
@@ -33707,8 +32414,6 @@
33707
32414
 
33708
32415
  exports.AiAccountService = AiAccountService;
33709
32416
  exports.AiAnalyticsService = AiAnalyticsService;
33710
- exports.AiBotService = AiBotService;
33711
- exports.AiFinetuningService = AiFinetuningService;
33712
32417
  exports.AiIndexService = AiIndexService;
33713
32418
  exports.AiMarketingService = AiMarketingService;
33714
32419
  exports.AiMediaService = AiMediaService;