@iblai/iblai-api 3.47.0-ai-plus → 3.47.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.
Files changed (96) hide show
  1. package/dist/index.cjs.js +205 -1516
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +206 -1515
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +205 -1516
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/index.d.ts +1 -40
  8. package/dist/types/models/{VoiceProviderEnum.d.ts → ProviderEnum.d.ts} +1 -1
  9. package/dist/types/models/Voice.d.ts +2 -2
  10. package/dist/types/services/AiAnalyticsService.d.ts +12 -12
  11. package/dist/types/services/AiIndexService.d.ts +35 -15
  12. package/package.json +1 -1
  13. package/src/core/OpenAPI.ts +1 -1
  14. package/src/index.ts +1 -40
  15. package/src/models/{VoiceProviderEnum.ts → ProviderEnum.ts} +1 -1
  16. package/src/models/Voice.ts +2 -2
  17. package/src/services/AiAnalyticsService.ts +18 -18
  18. package/src/services/AiIndexService.ts +442 -414
  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/WhatAppWebHook.ts +0 -8
  93. package/src/models/WhatsappConfig.ts +0 -16
  94. package/src/models/WhatsappUserConfig.ts +0 -15
  95. package/src/services/AiBotService.ts +0 -1174
  96. 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.47.0-ai-plus',
113
+ VERSION: '3.47.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.Provider63aEnum = void 0;
562
- (function (Provider63aEnum) {
563
- Provider63aEnum["OPENAI"] = "openai";
564
- })(exports.Provider63aEnum || (exports.Provider63aEnum = {}));
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 */
@@ -2801,17 +2751,17 @@ class AiAnalyticsService {
2801
2751
  * @param org
2802
2752
  * @param userId
2803
2753
  * @param endDate
2754
+ * @param filterUserId
2804
2755
  * @param mentor
2805
2756
  * @param page A page number within the paginated result set.
2806
2757
  * @param pageSize Number of results to return per page.
2807
2758
  * @param sentiment
2808
2759
  * @param startDate
2809
2760
  * @param topics
2810
- * @param userId
2811
2761
  * @returns PaginatedConversationsList
2812
2762
  * @throws ApiError
2813
2763
  */
2814
- static aiAnalyticsOrgsUsersChatHistoryList(org, userId, endDate, mentor, page, pageSize, sentiment, startDate, topics) {
2764
+ static aiAnalyticsOrgsUsersChatHistoryList(org, userId, endDate, filterUserId, mentor, page, pageSize, sentiment, startDate, topics) {
2815
2765
  return request(OpenAPI, {
2816
2766
  method: 'GET',
2817
2767
  url: '/api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/',
@@ -2821,13 +2771,13 @@ class AiAnalyticsService {
2821
2771
  },
2822
2772
  query: {
2823
2773
  'end_date': endDate,
2774
+ 'filter_user_id': filterUserId,
2824
2775
  'mentor': mentor,
2825
2776
  'page': page,
2826
2777
  'page_size': pageSize,
2827
2778
  'sentiment': sentiment,
2828
2779
  'start_date': startDate,
2829
- 'topics': topics,
2830
- 'user_id': userId
2780
+ 'topics': topics
2831
2781
  }
2832
2782
  });
2833
2783
  }
@@ -2844,15 +2794,15 @@ class AiAnalyticsService {
2844
2794
  * @param userId
2845
2795
  * @param requestBody
2846
2796
  * @param endDate
2797
+ * @param filterUserId
2847
2798
  * @param mentor
2848
2799
  * @param sentiment
2849
2800
  * @param startDate
2850
2801
  * @param topics
2851
- * @param userId
2852
2802
  * @returns Conversations
2853
2803
  * @throws ApiError
2854
2804
  */
2855
- static aiAnalyticsOrgsUsersChatHistoryCreate(org, userId, requestBody, endDate, mentor, sentiment, startDate, topics) {
2805
+ static aiAnalyticsOrgsUsersChatHistoryCreate(org, userId, requestBody, endDate, filterUserId, mentor, sentiment, startDate, topics) {
2856
2806
  return request(OpenAPI, {
2857
2807
  method: 'POST',
2858
2808
  url: '/api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/',
@@ -2862,11 +2812,11 @@ class AiAnalyticsService {
2862
2812
  },
2863
2813
  query: {
2864
2814
  'end_date': endDate,
2815
+ 'filter_user_id': filterUserId,
2865
2816
  'mentor': mentor,
2866
2817
  'sentiment': sentiment,
2867
2818
  'start_date': startDate,
2868
- 'topics': topics,
2869
- 'user_id': userId
2819
+ 'topics': topics
2870
2820
  },
2871
2821
  body: requestBody,
2872
2822
  mediaType: 'application/json'
@@ -2933,15 +2883,15 @@ class AiAnalyticsService {
2933
2883
  * @param org
2934
2884
  * @param userId
2935
2885
  * @param endDate
2886
+ * @param filterUserId
2936
2887
  * @param mentor
2937
2888
  * @param sentiment
2938
2889
  * @param startDate
2939
2890
  * @param topics
2940
- * @param userId
2941
2891
  * @returns Conversations
2942
2892
  * @throws ApiError
2943
2893
  */
2944
- static aiAnalyticsOrgsUsersChatHistoryRetrieve(id, org, userId, endDate, mentor, sentiment, startDate, topics) {
2894
+ static aiAnalyticsOrgsUsersChatHistoryRetrieve(id, org, userId, endDate, filterUserId, mentor, sentiment, startDate, topics) {
2945
2895
  return request(OpenAPI, {
2946
2896
  method: 'GET',
2947
2897
  url: '/api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/{id}/',
@@ -2952,11 +2902,11 @@ class AiAnalyticsService {
2952
2902
  },
2953
2903
  query: {
2954
2904
  'end_date': endDate,
2905
+ 'filter_user_id': filterUserId,
2955
2906
  'mentor': mentor,
2956
2907
  'sentiment': sentiment,
2957
2908
  'start_date': startDate,
2958
- 'topics': topics,
2959
- 'user_id': userId
2909
+ 'topics': topics
2960
2910
  }
2961
2911
  });
2962
2912
  }
@@ -2974,15 +2924,15 @@ class AiAnalyticsService {
2974
2924
  * @param userId
2975
2925
  * @param requestBody
2976
2926
  * @param endDate
2927
+ * @param filterUserId
2977
2928
  * @param mentor
2978
2929
  * @param sentiment
2979
2930
  * @param startDate
2980
2931
  * @param topics
2981
- * @param userId
2982
2932
  * @returns Conversations
2983
2933
  * @throws ApiError
2984
2934
  */
2985
- static aiAnalyticsOrgsUsersChatHistoryUpdate(id, org, userId, requestBody, endDate, mentor, sentiment, startDate, topics) {
2935
+ static aiAnalyticsOrgsUsersChatHistoryUpdate(id, org, userId, requestBody, endDate, filterUserId, mentor, sentiment, startDate, topics) {
2986
2936
  return request(OpenAPI, {
2987
2937
  method: 'PUT',
2988
2938
  url: '/api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/{id}/',
@@ -2993,11 +2943,11 @@ class AiAnalyticsService {
2993
2943
  },
2994
2944
  query: {
2995
2945
  'end_date': endDate,
2946
+ 'filter_user_id': filterUserId,
2996
2947
  'mentor': mentor,
2997
2948
  'sentiment': sentiment,
2998
2949
  'start_date': startDate,
2999
- 'topics': topics,
3000
- 'user_id': userId
2950
+ 'topics': topics
3001
2951
  },
3002
2952
  body: requestBody,
3003
2953
  mediaType: 'application/json'
@@ -3016,16 +2966,16 @@ class AiAnalyticsService {
3016
2966
  * @param org
3017
2967
  * @param userId
3018
2968
  * @param endDate
2969
+ * @param filterUserId
3019
2970
  * @param mentor
3020
2971
  * @param sentiment
3021
2972
  * @param startDate
3022
2973
  * @param topics
3023
- * @param userId
3024
2974
  * @param requestBody
3025
2975
  * @returns Conversations
3026
2976
  * @throws ApiError
3027
2977
  */
3028
- static aiAnalyticsOrgsUsersChatHistoryPartialUpdate(id, org, userId, endDate, mentor, sentiment, startDate, topics, requestBody) {
2978
+ static aiAnalyticsOrgsUsersChatHistoryPartialUpdate(id, org, userId, endDate, filterUserId, mentor, sentiment, startDate, topics, requestBody) {
3029
2979
  return request(OpenAPI, {
3030
2980
  method: 'PATCH',
3031
2981
  url: '/api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/{id}/',
@@ -3036,11 +2986,11 @@ class AiAnalyticsService {
3036
2986
  },
3037
2987
  query: {
3038
2988
  'end_date': endDate,
2989
+ 'filter_user_id': filterUserId,
3039
2990
  'mentor': mentor,
3040
2991
  'sentiment': sentiment,
3041
2992
  'start_date': startDate,
3042
- 'topics': topics,
3043
- 'user_id': userId
2993
+ 'topics': topics
3044
2994
  },
3045
2995
  body: requestBody,
3046
2996
  mediaType: 'application/json'
@@ -3059,15 +3009,15 @@ class AiAnalyticsService {
3059
3009
  * @param org
3060
3010
  * @param userId
3061
3011
  * @param endDate
3012
+ * @param filterUserId
3062
3013
  * @param mentor
3063
3014
  * @param sentiment
3064
3015
  * @param startDate
3065
3016
  * @param topics
3066
- * @param userId
3067
3017
  * @returns void
3068
3018
  * @throws ApiError
3069
3019
  */
3070
- static aiAnalyticsOrgsUsersChatHistoryDestroy(id, org, userId, endDate, mentor, sentiment, startDate, topics) {
3020
+ static aiAnalyticsOrgsUsersChatHistoryDestroy(id, org, userId, endDate, filterUserId, mentor, sentiment, startDate, topics) {
3071
3021
  return request(OpenAPI, {
3072
3022
  method: 'DELETE',
3073
3023
  url: '/api/ai-analytics/orgs/{org}/users/{user_id}/chat-history/{id}/',
@@ -3078,11 +3028,11 @@ class AiAnalyticsService {
3078
3028
  },
3079
3029
  query: {
3080
3030
  'end_date': endDate,
3031
+ 'filter_user_id': filterUserId,
3081
3032
  'mentor': mentor,
3082
3033
  'sentiment': sentiment,
3083
3034
  'start_date': startDate,
3084
- 'topics': topics,
3085
- 'user_id': userId
3035
+ 'topics': topics
3086
3036
  }
3087
3037
  });
3088
3038
  }
@@ -5790,1510 +5740,251 @@ class AiAnalyticsService {
5790
5740
  }
5791
5741
  }
5792
5742
 
5793
- class AiBotService {
5794
- /**
5795
- * Create modify and update bot information for a specific tenant.
5796
- * @param org
5797
- * @returns Bot
5798
- * @throws ApiError
5799
- */
5800
- static aiBotV1BotsBotList(org) {
5801
- return request(OpenAPI, {
5802
- method: 'GET',
5803
- url: '/api/ai-bot/v1/bots/{org}/bot/',
5804
- path: {
5805
- 'org': org
5806
- }
5807
- });
5808
- }
5809
- /**
5810
- * Create modify and update bot information for a specific tenant.
5811
- * @param org
5812
- * @param requestBody
5813
- * @returns BotCreate
5814
- * @throws ApiError
5815
- */
5816
- static aiBotV1BotsBotCreate(org, requestBody) {
5817
- return request(OpenAPI, {
5818
- method: 'POST',
5819
- url: '/api/ai-bot/v1/bots/{org}/bot/',
5820
- path: {
5821
- 'org': org
5822
- },
5823
- body: requestBody,
5824
- mediaType: 'application/json'
5825
- });
5826
- }
5743
+ class AiIndexService {
5827
5744
  /**
5828
- * Create slash commands for a specific bot
5829
- * eg. /iblai-baseline
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
5830
5761
  * @param org
5831
- * @returns BotCommand
5762
+ * @param userId
5763
+ * @returns RetrieverDocumentEmbedding
5832
5764
  * @throws ApiError
5833
5765
  */
5834
- static aiBotV1BotsBotCommandsList(org) {
5766
+ static aiIndexOrgsUsersDocumentsRetrieve(documentId, org, userId) {
5835
5767
  return request(OpenAPI, {
5836
5768
  method: 'GET',
5837
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/',
5838
- path: {
5839
- 'org': org
5840
- }
5841
- });
5842
- }
5843
- /**
5844
- * Create slash commands for a specific bot
5845
- * eg. /iblai-baseline
5846
- * @param org
5847
- * @param requestBody
5848
- * @returns BotCommand
5849
- * @throws ApiError
5850
- */
5851
- static aiBotV1BotsBotCommandsCreate(org, requestBody) {
5852
- return request(OpenAPI, {
5853
- method: 'POST',
5854
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/',
5769
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
5855
5770
  path: {
5856
- 'org': org
5771
+ 'document_id': documentId,
5772
+ 'org': org,
5773
+ 'user_id': userId
5857
5774
  },
5858
- body: requestBody,
5859
- mediaType: 'application/json'
5860
- });
5861
- }
5862
- /**
5863
- * Create slash commands for a specific bot
5864
- * eg. /iblai-baseline
5865
- * @param id A unique integer value identifying this bot command.
5866
- * @param org
5867
- * @returns BotCommand
5868
- * @throws ApiError
5869
- */
5870
- static aiBotV1BotsBotCommandsRetrieve(id, org) {
5871
- return request(OpenAPI, {
5872
- method: 'GET',
5873
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
5874
- path: {
5875
- 'id': id,
5876
- 'org': org
5775
+ errors: {
5776
+ 404: `Document not found`
5877
5777
  }
5878
5778
  });
5879
5779
  }
5880
5780
  /**
5881
- * Create slash commands for a specific bot
5882
- * eg. /iblai-baseline
5883
- * @param id A unique integer value identifying this bot command.
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
5884
5798
  * @param org
5885
- * @param requestBody
5886
- * @returns BotCommand
5799
+ * @param userId
5800
+ * @param formData
5801
+ * @returns RetrieverDocumentEmbedding
5887
5802
  * @throws ApiError
5888
5803
  */
5889
- static aiBotV1BotsBotCommandsUpdate(id, org, requestBody) {
5804
+ static aiIndexOrgsUsersDocumentsUpdate(documentId, org, userId, formData) {
5890
5805
  return request(OpenAPI, {
5891
5806
  method: 'PUT',
5892
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
5893
- path: {
5894
- 'id': id,
5895
- 'org': org
5896
- },
5897
- body: requestBody,
5898
- mediaType: 'application/json'
5899
- });
5900
- }
5901
- /**
5902
- * Create slash commands for a specific bot
5903
- * eg. /iblai-baseline
5904
- * @param id A unique integer value identifying this bot command.
5905
- * @param org
5906
- * @param requestBody
5907
- * @returns BotCommand
5908
- * @throws ApiError
5909
- */
5910
- static aiBotV1BotsBotCommandsPartialUpdate(id, org, requestBody) {
5911
- return request(OpenAPI, {
5912
- method: 'PATCH',
5913
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
5807
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
5914
5808
  path: {
5915
- 'id': id,
5916
- 'org': org
5809
+ 'document_id': documentId,
5810
+ 'org': org,
5811
+ 'user_id': userId
5917
5812
  },
5918
- body: requestBody,
5919
- mediaType: 'application/json'
5920
- });
5921
- }
5922
- /**
5923
- * Create slash commands for a specific bot
5924
- * eg. /iblai-baseline
5925
- * @param id A unique integer value identifying this bot command.
5926
- * @param org
5927
- * @returns void
5928
- * @throws ApiError
5929
- */
5930
- static aiBotV1BotsBotCommandsDestroy(id, org) {
5931
- return request(OpenAPI, {
5932
- method: 'DELETE',
5933
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
5934
- path: {
5935
- 'id': id,
5936
- 'org': org
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
5813
+ formData: formData,
5814
+ mediaType: 'multipart/form-data',
5815
+ errors: {
5816
+ 400: `Invalid request data`,
5817
+ 404: `Document not found`
5954
5818
  }
5955
5819
  });
5956
5820
  }
5957
5821
  /**
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.
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
6000
5838
  * @param org
5839
+ * @param userId
6001
5840
  * @returns void
6002
5841
  * @throws ApiError
6003
5842
  */
6004
- static aiBotV1BotsBotDestroy(id, org) {
5843
+ static aiIndexOrgsUsersDocumentsDestroy(documentId, org, userId) {
6005
5844
  return request(OpenAPI, {
6006
5845
  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/',
5846
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
6043
5847
  path: {
6044
- 'id': id,
6045
- 'org': org
5848
+ 'document_id': documentId,
5849
+ 'org': org,
5850
+ 'user_id': userId
6046
5851
  },
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
5852
+ errors: {
5853
+ 404: `Document not found`
6065
5854
  }
6066
5855
  });
6067
5856
  }
6068
5857
  /**
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.
5858
+ * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
5859
+ * @param documentId
6131
5860
  * @param org
6132
- * @returns TeamsConfig
5861
+ * @param userId
5862
+ * @returns DocumentSettingsResponse
6133
5863
  * @throws ApiError
6134
5864
  */
6135
- static aiBotV1BotsBotConfigTeamsRetrieve(id, org) {
5865
+ static aiIndexOrgsUsersDocumentsSettingsRetrieve(documentId, org, userId) {
6136
5866
  return request(OpenAPI, {
6137
5867
  method: 'GET',
6138
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/',
5868
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/',
6139
5869
  path: {
6140
- 'id': id,
6141
- 'org': org
5870
+ 'document_id': documentId,
5871
+ 'org': org,
5872
+ 'user_id': userId
6142
5873
  }
6143
5874
  });
6144
5875
  }
6145
5876
  /**
6146
- * Create modify and update bot information for a specific tenant.
6147
- * @param id A unique integer value identifying this bot.
5877
+ * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
5878
+ * @param documentId
6148
5879
  * @param org
5880
+ * @param userId
6149
5881
  * @param requestBody
6150
- * @returns TeamsConfig
5882
+ * @returns DocumentSettingsResponse
6151
5883
  * @throws ApiError
6152
5884
  */
6153
- static aiBotV1BotsBotConfigTeamsUpdateCreate(id, org, requestBody) {
5885
+ static aiIndexOrgsUsersDocumentsSettingsCreate(documentId, org, userId, requestBody) {
6154
5886
  return request(OpenAPI, {
6155
5887
  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/',
5888
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/',
6177
5889
  path: {
6178
- 'id': id,
6179
- 'org': org
5890
+ 'document_id': documentId,
5891
+ 'org': org,
5892
+ 'user_id': userId
6180
5893
  },
6181
5894
  body: requestBody,
6182
5895
  mediaType: 'application/json'
6183
5896
  });
6184
5897
  }
6185
5898
  /**
6186
- * Create modify and update bot information for a specific tenant.
6187
- * @param id A unique integer value identifying this bot.
5899
+ * Train a graph-based document through a worker process.
5900
+ *
5901
+ * This endpoint queues graph-based documents for training through a
5902
+ * specialized worker process that handles knowledge graph processing.
5903
+ *
5904
+ * Args:
5905
+ * request: The HTTP request containing the document information.
5906
+ * org: Organization key identifier.
5907
+ *
5908
+ * Returns:
5909
+ * Response: A confirmation that the document was queued for training,
5910
+ * including a task ID for tracking the progress.
5911
+ *
5912
+ * Raises:
5913
+ * ValidationError: If the request data is invalid.
5914
+ * BadRequest: If there was an error processing the document.
6188
5915
  * @param org
6189
- * @param requestBody
6190
- * @returns TeamsConfig
5916
+ * @param userId
5917
+ * @param formData
5918
+ * @returns TrainDocumentViewResponse
6191
5919
  * @throws ApiError
6192
5920
  */
6193
- static aiBotV1BotsBotConfigTeamsUpdatePartialUpdate(id, org, requestBody) {
5921
+ static aiIndexOrgsUsersDocumentsGraphTrainCreate(org, userId, formData) {
6194
5922
  return request(OpenAPI, {
6195
- method: 'PATCH',
6196
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
5923
+ method: 'POST',
5924
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/graph-train/',
6197
5925
  path: {
6198
- 'id': id,
6199
- 'org': org
5926
+ 'org': org,
5927
+ 'user_id': userId
6200
5928
  },
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
5929
+ formData: formData,
5930
+ mediaType: 'multipart/form-data',
5931
+ errors: {
5932
+ 400: `Invalid request data or document processing error`
6219
5933
  }
6220
5934
  });
6221
5935
  }
6222
5936
  /**
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) {
5937
+ * Description:
5938
+ * Retrieves a list of document embeddings for a specific pathway with optional search and pagination.
5939
+ *
5940
+ * Methods:
5941
+ * - GET: Retrieves document embeddings that match the specified search criteria and are paginated according to offset and limit.
5942
+ *
5943
+ * Parameters:
5944
+ * - search (str): Search query to filter document names or URLs.
5945
+ * - offset (int): Offset number for pagination.
5946
+ * - limit (int): Limit number for pagination.
5947
+ *
5948
+ * Returns:
5949
+ * - GET: A paginated list of document embeddings with their details.
5950
+ * {
5951
+ * "count": 10,
5952
+ * "next": "http://api.example.com/retriever_documents/?offset=10&limit=2",
5953
+ * "previous": "http://api.example.com/retriever_documents/?offset=0&limit=2",
5954
+ * "results": [
5955
+ * {
5956
+ * "document_name": "Document2",
5957
+ * "platform_key": "example_platform",
5958
+ * "pathway": "example_pathway"
5959
+ * }
5960
+ * ]
5961
+ * }
5962
+ *
5963
+ * Error Responses:
5964
+ * - 400 Bad Request: Invalid query parameters.
5965
+ * - 404 Not Found: No document embeddings found for the specified criteria.
5966
+ * @param org
5967
+ * @param pathway
5968
+ * @param userId
5969
+ * @param limit limit number
5970
+ * @param offset Offset number
5971
+ * @param search Search query
5972
+ * @returns RetrieverDocumentEmbedding
5973
+ * @throws ApiError
5974
+ */
5975
+ static aiIndexOrgsUsersDocumentsPathwaysList(org, pathway, userId, limit, offset, search) {
6250
5976
  return request(OpenAPI, {
6251
5977
  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/',
5978
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/pathways/{pathway}/',
6291
5979
  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
5980
+ 'org': org,
5981
+ 'pathway': pathway,
5982
+ 'user_id': userId
6788
5983
  },
6789
5984
  query: {
6790
- 'date_created': dateCreated,
6791
- 'num_data_points': numDataPoints,
6792
- 'ordering': ordering,
6793
- 'page': page,
6794
- 'page_size': pageSize,
6795
- 'retry_attempts': retryAttempts,
6796
- 'search': search,
6797
- 'status': status
6798
- }
6799
- });
6800
- }
6801
- /**
6802
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6803
- * @param org
6804
- * @param username
6805
- * @param requestBody
6806
- * @returns DataSetCreate
6807
- * @throws ApiError
6808
- */
6809
- static aiFinetuningV1OrgUserDatasetsCreate(org, username, requestBody) {
6810
- return request(OpenAPI, {
6811
- method: 'POST',
6812
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/',
6813
- path: {
6814
- 'org': org,
6815
- 'username': username
6816
- },
6817
- body: requestBody,
6818
- mediaType: 'application/json'
6819
- });
6820
- }
6821
- /**
6822
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6823
- * @param id A UUID string identifying this data set.
6824
- * @param org
6825
- * @param username
6826
- * @returns DataSet
6827
- * @throws ApiError
6828
- */
6829
- static aiFinetuningV1OrgUserDatasetsRetrieve(id, org, username) {
6830
- return request(OpenAPI, {
6831
- method: 'GET',
6832
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
6833
- path: {
6834
- 'id': id,
6835
- 'org': org,
6836
- 'username': username
6837
- }
6838
- });
6839
- }
6840
- /**
6841
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6842
- * @param id A UUID string identifying this data set.
6843
- * @param org
6844
- * @param username
6845
- * @param requestBody
6846
- * @returns DataSet
6847
- * @throws ApiError
6848
- */
6849
- static aiFinetuningV1OrgUserDatasetsUpdate(id, org, username, requestBody) {
6850
- return request(OpenAPI, {
6851
- method: 'PUT',
6852
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
6853
- path: {
6854
- 'id': id,
6855
- 'org': org,
6856
- 'username': username
6857
- },
6858
- body: requestBody,
6859
- mediaType: 'application/json'
6860
- });
6861
- }
6862
- /**
6863
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6864
- * @param id A UUID string identifying this data set.
6865
- * @param org
6866
- * @param username
6867
- * @param requestBody
6868
- * @returns DataSet
6869
- * @throws ApiError
6870
- */
6871
- static aiFinetuningV1OrgUserDatasetsPartialUpdate(id, org, username, requestBody) {
6872
- return request(OpenAPI, {
6873
- method: 'PATCH',
6874
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
6875
- path: {
6876
- 'id': id,
6877
- 'org': org,
6878
- 'username': username
6879
- },
6880
- body: requestBody,
6881
- mediaType: 'application/json'
6882
- });
6883
- }
6884
- /**
6885
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6886
- * @param id A UUID string identifying this data set.
6887
- * @param org
6888
- * @param username
6889
- * @returns void
6890
- * @throws ApiError
6891
- */
6892
- static aiFinetuningV1OrgUserDatasetsDestroy(id, org, username) {
6893
- return request(OpenAPI, {
6894
- method: 'DELETE',
6895
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
6896
- path: {
6897
- 'id': id,
6898
- 'org': org,
6899
- 'username': username
6900
- }
6901
- });
6902
- }
6903
- /**
6904
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6905
- * @param org
6906
- * @param username
6907
- * @param baseModelName
6908
- * @param dataset
6909
- * @param dateCreated
6910
- * @param fineTunedModel
6911
- * @param lastModified
6912
- * @param ordering Which field to use when ordering the results.
6913
- * @param page A page number within the paginated result set.
6914
- * @param pageSize Number of results to return per page.
6915
- * @param preprocessDataset
6916
- * @param provider * `openai` - Openai
6917
- * @param search A search term.
6918
- * @param status * `pending` - Pending
6919
- * * `processing` - Processing
6920
- * * `completed` - Completed
6921
- * * `cancelled` - Cancelled
6922
- * * `failed` - Failed
6923
- * @returns PaginatedTrainingList
6924
- * @throws ApiError
6925
- */
6926
- static aiFinetuningV1OrgUserTrainingsList(org, username, baseModelName, dataset, dateCreated, fineTunedModel, lastModified, ordering, page, pageSize, preprocessDataset, provider, search, status) {
6927
- return request(OpenAPI, {
6928
- method: 'GET',
6929
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/',
6930
- path: {
6931
- 'org': org,
6932
- 'username': username
6933
- },
6934
- query: {
6935
- 'base_model_name': baseModelName,
6936
- 'dataset': dataset,
6937
- 'date_created': dateCreated,
6938
- 'fine_tuned_model': fineTunedModel,
6939
- 'last_modified': lastModified,
6940
- 'ordering': ordering,
6941
- 'page': page,
6942
- 'page_size': pageSize,
6943
- 'preprocess_dataset': preprocessDataset,
6944
- 'provider': provider,
6945
- 'search': search,
6946
- 'status': status
6947
- }
6948
- });
6949
- }
6950
- /**
6951
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6952
- * @param org
6953
- * @param username
6954
- * @param requestBody
6955
- * @returns TrainingCreate
6956
- * @throws ApiError
6957
- */
6958
- static aiFinetuningV1OrgUserTrainingsCreate(org, username, requestBody) {
6959
- return request(OpenAPI, {
6960
- method: 'POST',
6961
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/',
6962
- path: {
6963
- 'org': org,
6964
- 'username': username
6965
- },
6966
- body: requestBody,
6967
- mediaType: 'application/json'
6968
- });
6969
- }
6970
- /**
6971
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6972
- * @param id A UUID string identifying this training.
6973
- * @param org
6974
- * @param username
6975
- * @returns Training
6976
- * @throws ApiError
6977
- */
6978
- static aiFinetuningV1OrgUserTrainingsRetrieve(id, org, username) {
6979
- return request(OpenAPI, {
6980
- method: 'GET',
6981
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
6982
- path: {
6983
- 'id': id,
6984
- 'org': org,
6985
- 'username': username
6986
- }
6987
- });
6988
- }
6989
- /**
6990
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
6991
- * @param id A UUID string identifying this training.
6992
- * @param org
6993
- * @param username
6994
- * @param requestBody
6995
- * @returns TrainingCreate
6996
- * @throws ApiError
6997
- */
6998
- static aiFinetuningV1OrgUserTrainingsUpdate(id, org, username, requestBody) {
6999
- return request(OpenAPI, {
7000
- method: 'PUT',
7001
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
7002
- path: {
7003
- 'id': id,
7004
- 'org': org,
7005
- 'username': username
7006
- },
7007
- body: requestBody,
7008
- mediaType: 'application/json'
7009
- });
7010
- }
7011
- /**
7012
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
7013
- * @param id A UUID string identifying this training.
7014
- * @param org
7015
- * @param username
7016
- * @param requestBody
7017
- * @returns TrainingCreate
7018
- * @throws ApiError
7019
- */
7020
- static aiFinetuningV1OrgUserTrainingsPartialUpdate(id, org, username, requestBody) {
7021
- return request(OpenAPI, {
7022
- method: 'PATCH',
7023
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
7024
- path: {
7025
- 'id': id,
7026
- 'org': org,
7027
- 'username': username
7028
- },
7029
- body: requestBody,
7030
- mediaType: 'application/json'
7031
- });
7032
- }
7033
- /**
7034
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
7035
- * @param id A UUID string identifying this training.
7036
- * @param org
7037
- * @param username
7038
- * @returns void
7039
- * @throws ApiError
7040
- */
7041
- static aiFinetuningV1OrgUserTrainingsDestroy(id, org, username) {
7042
- return request(OpenAPI, {
7043
- method: 'DELETE',
7044
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
7045
- path: {
7046
- 'id': id,
7047
- 'org': org,
7048
- 'username': username
7049
- }
7050
- });
7051
- }
7052
- /**
7053
- * Retrieves a paginated list of completed fine-tuned models, excluding those without a fine-tuned model.
7054
- * Filtering and pagination is allowed.
7055
- *
7056
- * NB: This is only a helper endpoint. The same functionality can be achieved with the appropriate filters using the
7057
- * training list endpoint.
7058
- * Returns:
7059
- * Response: A paginated response containing the serialized fine-tuned models.
7060
- * @param org
7061
- * @param username
7062
- * @returns Training
7063
- * @throws ApiError
7064
- */
7065
- static aiFinetuningV1OrgUserTrainingsFinetunedModelsRetrieve(org, username) {
7066
- return request(OpenAPI, {
7067
- method: 'GET',
7068
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/finetuned-models/',
7069
- path: {
7070
- 'org': org,
7071
- 'username': username
7072
- }
7073
- });
7074
- }
7075
- }
7076
-
7077
- class AiIndexService {
7078
- /**
7079
- * Retrieve details of a specific document embedding.
7080
- *
7081
- * This endpoint returns detailed information about a specific
7082
- * document embedding identified by its ID.
7083
- *
7084
- * Args:
7085
- * request: The HTTP request.
7086
- * org: Organization key identifier.
7087
- * document_id: The ID of the document embedding to retrieve.
7088
- *
7089
- * Returns:
7090
- * Response: Detailed information about the document embedding.
7091
- *
7092
- * Raises:
7093
- * NotFound: If the specified document embedding does not exist.
7094
- * @param documentId
7095
- * @param org
7096
- * @param userId
7097
- * @returns RetrieverDocumentEmbedding
7098
- * @throws ApiError
7099
- */
7100
- static aiIndexOrgsUsersDocumentsRetrieve(documentId, org, userId) {
7101
- return request(OpenAPI, {
7102
- method: 'GET',
7103
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
7104
- path: {
7105
- 'document_id': documentId,
7106
- 'org': org,
7107
- 'user_id': userId
7108
- },
7109
- errors: {
7110
- 404: `Document not found`
7111
- }
7112
- });
7113
- }
7114
- /**
7115
- * Update a specific document embedding.
7116
- *
7117
- * This endpoint allows updating various properties of a document embedding,
7118
- * including its name, type, pathway, and training status.
7119
- *
7120
- * Args:
7121
- * request: The HTTP request containing the updated document data.
7122
- * org: Organization key identifier.
7123
- * document_id: The ID of the document embedding to update.
7124
- *
7125
- * Returns:
7126
- * Response: The updated document embedding information.
7127
- *
7128
- * Raises:
7129
- * BadRequest: If the provided data is invalid.
7130
- * NotFound: If the specified document embedding does not exist.
7131
- * @param documentId
7132
- * @param org
7133
- * @param userId
7134
- * @param formData
7135
- * @returns RetrieverDocumentEmbedding
7136
- * @throws ApiError
7137
- */
7138
- static aiIndexOrgsUsersDocumentsUpdate(documentId, org, userId, formData) {
7139
- return request(OpenAPI, {
7140
- method: 'PUT',
7141
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
7142
- path: {
7143
- 'document_id': documentId,
7144
- 'org': org,
7145
- 'user_id': userId
7146
- },
7147
- formData: formData,
7148
- mediaType: 'multipart/form-data',
7149
- errors: {
7150
- 400: `Invalid request data`,
7151
- 404: `Document not found`
7152
- }
7153
- });
7154
- }
7155
- /**
7156
- * Delete a specific document embedding.
7157
- *
7158
- * This endpoint removes a document embedding from the system,
7159
- * including untraining it from any associated pathways.
7160
- *
7161
- * Args:
7162
- * request: The HTTP request.
7163
- * org: Organization key identifier.
7164
- * document_id: The ID of the document embedding to delete.
7165
- *
7166
- * Returns:
7167
- * Response: An empty response with a 204 status code if successful.
7168
- *
7169
- * Raises:
7170
- * NotFound: If the specified document embedding does not exist.
7171
- * @param documentId
7172
- * @param org
7173
- * @param userId
7174
- * @returns void
7175
- * @throws ApiError
7176
- */
7177
- static aiIndexOrgsUsersDocumentsDestroy(documentId, org, userId) {
7178
- return request(OpenAPI, {
7179
- method: 'DELETE',
7180
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
7181
- path: {
7182
- 'document_id': documentId,
7183
- 'org': org,
7184
- 'user_id': userId
7185
- },
7186
- errors: {
7187
- 404: `Document not found`
7188
- }
7189
- });
7190
- }
7191
- /**
7192
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
7193
- * @param documentId
7194
- * @param org
7195
- * @param userId
7196
- * @returns DocumentSettingsResponse
7197
- * @throws ApiError
7198
- */
7199
- static aiIndexOrgsUsersDocumentsSettingsRetrieve(documentId, org, userId) {
7200
- return request(OpenAPI, {
7201
- method: 'GET',
7202
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/',
7203
- path: {
7204
- 'document_id': documentId,
7205
- 'org': org,
7206
- 'user_id': userId
7207
- }
7208
- });
7209
- }
7210
- /**
7211
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
7212
- * @param documentId
7213
- * @param org
7214
- * @param userId
7215
- * @param requestBody
7216
- * @returns DocumentSettingsResponse
7217
- * @throws ApiError
7218
- */
7219
- static aiIndexOrgsUsersDocumentsSettingsCreate(documentId, org, userId, requestBody) {
7220
- return request(OpenAPI, {
7221
- method: 'POST',
7222
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/',
7223
- path: {
7224
- 'document_id': documentId,
7225
- 'org': org,
7226
- 'user_id': userId
7227
- },
7228
- body: requestBody,
7229
- mediaType: 'application/json'
7230
- });
7231
- }
7232
- /**
7233
- * Train a graph-based document through a worker process.
7234
- *
7235
- * This endpoint queues graph-based documents for training through a
7236
- * specialized worker process that handles knowledge graph processing.
7237
- *
7238
- * Args:
7239
- * request: The HTTP request containing the document information.
7240
- * org: Organization key identifier.
7241
- *
7242
- * Returns:
7243
- * Response: A confirmation that the document was queued for training,
7244
- * including a task ID for tracking the progress.
7245
- *
7246
- * Raises:
7247
- * ValidationError: If the request data is invalid.
7248
- * BadRequest: If there was an error processing the document.
7249
- * @param org
7250
- * @param userId
7251
- * @param formData
7252
- * @returns TrainDocumentViewResponse
7253
- * @throws ApiError
7254
- */
7255
- static aiIndexOrgsUsersDocumentsGraphTrainCreate(org, userId, formData) {
7256
- return request(OpenAPI, {
7257
- method: 'POST',
7258
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/graph-train/',
7259
- path: {
7260
- 'org': org,
7261
- 'user_id': userId
7262
- },
7263
- formData: formData,
7264
- mediaType: 'multipart/form-data',
7265
- errors: {
7266
- 400: `Invalid request data or document processing error`
7267
- }
7268
- });
7269
- }
7270
- /**
7271
- * Retrieve a list of document embeddings for a specific pathway.
7272
- *
7273
- * This endpoint returns a paginated list of all document embeddings
7274
- * that have been created for the specified pathway within the organization.
7275
- *
7276
- * Args:
7277
- * request: The HTTP request.
7278
- * org: Organization key identifier.
7279
- * pathway: The pathway to retrieve document embeddings for.
7280
- *
7281
- * Returns:
7282
- * Response: A paginated list of document embeddings for the pathway.
7283
- * @param org
7284
- * @param pathway
7285
- * @param userId
7286
- * @returns RetrieverDocumentEmbedding
7287
- * @throws ApiError
7288
- */
7289
- static aiIndexOrgsUsersDocumentsPathwaysList(org, pathway, userId) {
7290
- return request(OpenAPI, {
7291
- method: 'GET',
7292
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/pathways/{pathway}/',
7293
- path: {
7294
- 'org': org,
7295
- 'pathway': pathway,
7296
- 'user_id': userId
5985
+ 'limit': limit,
5986
+ 'offset': offset,
5987
+ 'search': search
7297
5988
  }
7298
5989
  });
7299
5990
  }
@@ -33835,8 +32526,6 @@ class UserGroupsService {
33835
32526
 
33836
32527
  exports.AiAccountService = AiAccountService;
33837
32528
  exports.AiAnalyticsService = AiAnalyticsService;
33838
- exports.AiBotService = AiBotService;
33839
- exports.AiFinetuningService = AiFinetuningService;
33840
32529
  exports.AiIndexService = AiIndexService;
33841
32530
  exports.AiMarketingService = AiMarketingService;
33842
32531
  exports.AiMediaService = AiMediaService;