@iblai/iblai-api 3.60.0-ai-plus → 3.61.0-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 (100) hide show
  1. package/dist/index.cjs.js +455 -1762
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +456 -1761
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +455 -1762
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/index.d.ts +2 -40
  8. package/dist/types/models/MentorSettings.d.ts +16 -0
  9. package/dist/types/models/MentorSettingsPublic.d.ts +6 -0
  10. package/dist/types/models/{Provider637Enum.d.ts → ProviderEnum.d.ts} +1 -1
  11. package/dist/types/models/ShareableMentorLink.d.ts +8 -0
  12. package/dist/types/models/Voice.d.ts +2 -2
  13. package/dist/types/services/AiMentorService.d.ts +39 -0
  14. package/package.json +1 -1
  15. package/src/core/OpenAPI.ts +1 -1
  16. package/src/index.ts +2 -40
  17. package/src/models/MentorSettings.ts +16 -0
  18. package/src/models/MentorSettingsPublic.ts +6 -0
  19. package/src/models/{Provider637Enum.ts → ProviderEnum.ts} +1 -1
  20. package/src/models/ShareableMentorLink.ts +13 -0
  21. package/src/models/Voice.ts +2 -2
  22. package/src/services/AiMentorService.ts +105 -0
  23. package/dist/types/models/Bot.d.ts +0 -15
  24. package/dist/types/models/BotCommand.d.ts +0 -6
  25. package/dist/types/models/BotCreate.d.ts +0 -12
  26. package/dist/types/models/DataSet.d.ts +0 -21
  27. package/dist/types/models/DataSetCreate.d.ts +0 -12
  28. package/dist/types/models/DataSetStatusEnum.d.ts +0 -12
  29. package/dist/types/models/DiscordConfig.d.ts +0 -7
  30. package/dist/types/models/DiscordUserConfig.d.ts +0 -10
  31. package/dist/types/models/DiscordWebhook.d.ts +0 -6
  32. package/dist/types/models/PaginatedDataSetList.d.ts +0 -7
  33. package/dist/types/models/PaginatedTrainingList.d.ts +0 -7
  34. package/dist/types/models/PatchedBotCommand.d.ts +0 -6
  35. package/dist/types/models/PatchedBotCreate.d.ts +0 -12
  36. package/dist/types/models/PatchedDataSet.d.ts +0 -21
  37. package/dist/types/models/PatchedDiscordConfig.d.ts +0 -7
  38. package/dist/types/models/PatchedDiscordUserConfig.d.ts +0 -10
  39. package/dist/types/models/PatchedSlackConfig.d.ts +0 -8
  40. package/dist/types/models/PatchedSlackUserConfig.d.ts +0 -17
  41. package/dist/types/models/PatchedTeamsConfig.d.ts +0 -7
  42. package/dist/types/models/PatchedTrainingCreate.d.ts +0 -31
  43. package/dist/types/models/PatchedWebexConfig.d.ts +0 -10
  44. package/dist/types/models/PatchedWhatsappConfig.d.ts +0 -11
  45. package/dist/types/models/PatchedWhatsappUserConfig.d.ts +0 -10
  46. package/dist/types/models/Provider05cEnum.d.ts +0 -14
  47. package/dist/types/models/Provider63aEnum.d.ts +0 -6
  48. package/dist/types/models/SlackConfig.d.ts +0 -8
  49. package/dist/types/models/SlackUserConfig.d.ts +0 -17
  50. package/dist/types/models/SlackWebhook.d.ts +0 -6
  51. package/dist/types/models/TeamsConfig.d.ts +0 -7
  52. package/dist/types/models/TeamsWebhook.d.ts +0 -17
  53. package/dist/types/models/Training.d.ts +0 -41
  54. package/dist/types/models/TrainingCreate.d.ts +0 -31
  55. package/dist/types/models/WebexConfig.d.ts +0 -10
  56. package/dist/types/models/WebexWebhook.d.ts +0 -4
  57. package/dist/types/models/WhatAppWebHook.d.ts +0 -3
  58. package/dist/types/models/WhatsappConfig.d.ts +0 -11
  59. package/dist/types/models/WhatsappUserConfig.d.ts +0 -10
  60. package/dist/types/services/AiBotService.d.ts +0 -642
  61. package/dist/types/services/AiFinetuningService.d.ts +0 -232
  62. package/src/models/Bot.ts +0 -20
  63. package/src/models/BotCommand.ts +0 -11
  64. package/src/models/BotCreate.ts +0 -17
  65. package/src/models/DataSet.ts +0 -26
  66. package/src/models/DataSetCreate.ts +0 -17
  67. package/src/models/DataSetStatusEnum.ts +0 -16
  68. package/src/models/DiscordConfig.ts +0 -12
  69. package/src/models/DiscordUserConfig.ts +0 -15
  70. package/src/models/DiscordWebhook.ts +0 -11
  71. package/src/models/PaginatedDataSetList.ts +0 -12
  72. package/src/models/PaginatedTrainingList.ts +0 -12
  73. package/src/models/PatchedBotCommand.ts +0 -11
  74. package/src/models/PatchedBotCreate.ts +0 -17
  75. package/src/models/PatchedDataSet.ts +0 -26
  76. package/src/models/PatchedDiscordConfig.ts +0 -12
  77. package/src/models/PatchedDiscordUserConfig.ts +0 -15
  78. package/src/models/PatchedSlackConfig.ts +0 -13
  79. package/src/models/PatchedSlackUserConfig.ts +0 -22
  80. package/src/models/PatchedTeamsConfig.ts +0 -12
  81. package/src/models/PatchedTrainingCreate.ts +0 -36
  82. package/src/models/PatchedWebexConfig.ts +0 -15
  83. package/src/models/PatchedWhatsappConfig.ts +0 -16
  84. package/src/models/PatchedWhatsappUserConfig.ts +0 -15
  85. package/src/models/Provider05cEnum.ts +0 -18
  86. package/src/models/Provider63aEnum.ts +0 -10
  87. package/src/models/SlackConfig.ts +0 -13
  88. package/src/models/SlackUserConfig.ts +0 -22
  89. package/src/models/SlackWebhook.ts +0 -11
  90. package/src/models/TeamsConfig.ts +0 -12
  91. package/src/models/TeamsWebhook.ts +0 -22
  92. package/src/models/Training.ts +0 -46
  93. package/src/models/TrainingCreate.ts +0 -36
  94. package/src/models/WebexConfig.ts +0 -15
  95. package/src/models/WebexWebhook.ts +0 -9
  96. package/src/models/WhatAppWebHook.ts +0 -8
  97. package/src/models/WhatsappConfig.ts +0 -16
  98. package/src/models/WhatsappUserConfig.ts +0 -15
  99. package/src/services/AiBotService.ts +0 -1330
  100. package/src/services/AiFinetuningService.ts +0 -472
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.60.0-ai-plus',
113
+ VERSION: '3.61.0-ai',
114
114
  WITH_CREDENTIALS: false,
115
115
  CREDENTIALS: 'include',
116
116
  TOKEN: undefined,
@@ -245,24 +245,6 @@ exports.CourseCreationTaskStatusEnum = void 0;
245
245
  CourseCreationTaskStatusEnum["IN_PROGRESS"] = "In Progress";
246
246
  })(exports.CourseCreationTaskStatusEnum || (exports.CourseCreationTaskStatusEnum = {}));
247
247
 
248
- /* generated using openapi-typescript-codegen -- do not edit */
249
- /* istanbul ignore file */
250
- /* tslint:disable */
251
- /* eslint-disable */
252
- /**
253
- * * `pending` - Pending
254
- * * `processing` - Processing
255
- * * `completed` - Completed
256
- * * `failed` - Failed
257
- */
258
- exports.DataSetStatusEnum = void 0;
259
- (function (DataSetStatusEnum) {
260
- DataSetStatusEnum["PENDING"] = "pending";
261
- DataSetStatusEnum["PROCESSING"] = "processing";
262
- DataSetStatusEnum["COMPLETED"] = "completed";
263
- DataSetStatusEnum["FAILED"] = "failed";
264
- })(exports.DataSetStatusEnum || (exports.DataSetStatusEnum = {}));
265
-
266
248
  /* generated using openapi-typescript-codegen -- do not edit */
267
249
  /* istanbul ignore file */
268
250
  /* tslint:disable */
@@ -543,26 +525,6 @@ exports.PromptVisibilityEnum = void 0;
543
525
  PromptVisibilityEnum["VIEWABLE_BY_ANYONE"] = "viewable_by_anyone";
544
526
  })(exports.PromptVisibilityEnum || (exports.PromptVisibilityEnum = {}));
545
527
 
546
- /* generated using openapi-typescript-codegen -- do not edit */
547
- /* istanbul ignore file */
548
- /* tslint:disable */
549
- /* eslint-disable */
550
- /**
551
- * * `webex` - Webex
552
- * * `slack` - Slack
553
- * * `whatsapp` - Whatsapp
554
- * * `discord` - Discord
555
- * * `teams` - Teams
556
- */
557
- exports.Provider05cEnum = void 0;
558
- (function (Provider05cEnum) {
559
- Provider05cEnum["WEBEX"] = "webex";
560
- Provider05cEnum["SLACK"] = "slack";
561
- Provider05cEnum["WHATSAPP"] = "whatsapp";
562
- Provider05cEnum["DISCORD"] = "discord";
563
- Provider05cEnum["TEAMS"] = "teams";
564
- })(exports.Provider05cEnum || (exports.Provider05cEnum = {}));
565
-
566
528
  /* generated using openapi-typescript-codegen -- do not edit */
567
529
  /* istanbul ignore file */
568
530
  /* tslint:disable */
@@ -572,24 +534,12 @@ exports.Provider05cEnum = void 0;
572
534
  * * `google` - Google
573
535
  * * `elevenlabs` - Elevenlabs
574
536
  */
575
- exports.Provider637Enum = void 0;
576
- (function (Provider637Enum) {
577
- Provider637Enum["OPENAI"] = "openai";
578
- Provider637Enum["GOOGLE"] = "google";
579
- Provider637Enum["ELEVENLABS"] = "elevenlabs";
580
- })(exports.Provider637Enum || (exports.Provider637Enum = {}));
581
-
582
- /* generated using openapi-typescript-codegen -- do not edit */
583
- /* istanbul ignore file */
584
- /* tslint:disable */
585
- /* eslint-disable */
586
- /**
587
- * * `openai` - Openai
588
- */
589
- exports.Provider63aEnum = void 0;
590
- (function (Provider63aEnum) {
591
- Provider63aEnum["OPENAI"] = "openai";
592
- })(exports.Provider63aEnum || (exports.Provider63aEnum = {}));
537
+ exports.ProviderEnum = void 0;
538
+ (function (ProviderEnum) {
539
+ ProviderEnum["OPENAI"] = "openai";
540
+ ProviderEnum["GOOGLE"] = "google";
541
+ ProviderEnum["ELEVENLABS"] = "elevenlabs";
542
+ })(exports.ProviderEnum || (exports.ProviderEnum = {}));
593
543
 
594
544
  /* generated using openapi-typescript-codegen -- do not edit */
595
545
  /* istanbul ignore file */
@@ -9132,1845 +9082,504 @@ class AiAnalyticsService {
9132
9082
  }
9133
9083
  }
9134
9084
 
9135
- class AiBotService {
9085
+ class AiIndexService {
9136
9086
  /**
9137
- * Create modify and update bot information for a specific tenant.
9138
- * @returns Bot
9087
+ * Retrieve details of a specific document embedding.
9088
+ *
9089
+ * This endpoint returns detailed information about a specific
9090
+ * document embedding identified by its ID.
9091
+ *
9092
+ * Args:
9093
+ * request: The HTTP request.
9094
+ * org: Organization key identifier.
9095
+ * document_id: The ID of the document embedding to retrieve.
9096
+ *
9097
+ * Returns:
9098
+ * Response: Detailed information about the document embedding.
9099
+ *
9100
+ * Raises:
9101
+ * NotFound: If the specified document embedding does not exist.
9102
+ * @returns RetrieverDocumentEmbedding
9139
9103
  * @throws ApiError
9140
9104
  */
9141
- static aiBotV1BotsBotList({
9142
- org
9105
+ static aiIndexOrgsUsersDocumentsRetrieve({
9106
+ documentId,
9107
+ org,
9108
+ userId
9143
9109
  }) {
9144
9110
  return request(OpenAPI, {
9145
9111
  method: 'GET',
9146
- url: '/api/ai-bot/v1/bots/{org}/bot/',
9112
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
9147
9113
  path: {
9148
- 'org': org
9114
+ 'document_id': documentId,
9115
+ 'org': org,
9116
+ 'user_id': userId
9117
+ },
9118
+ errors: {
9119
+ 404: `Document not found`
9149
9120
  }
9150
9121
  });
9151
9122
  }
9152
9123
  /**
9153
- * Create modify and update bot information for a specific tenant.
9154
- * @returns BotCreate
9124
+ * Update a specific document embedding.
9125
+ *
9126
+ * This endpoint allows updating various properties of a document embedding,
9127
+ * including its name, type, pathway, and training status.
9128
+ *
9129
+ * Args:
9130
+ * request: The HTTP request containing the updated document data.
9131
+ * org: Organization key identifier.
9132
+ * document_id: The ID of the document embedding to update.
9133
+ *
9134
+ * Returns:
9135
+ * Response: The updated document embedding information.
9136
+ *
9137
+ * Raises:
9138
+ * BadRequest: If the provided data is invalid.
9139
+ * NotFound: If the specified document embedding does not exist.
9140
+ * @returns RetrieverDocumentEmbedding
9155
9141
  * @throws ApiError
9156
9142
  */
9157
- static aiBotV1BotsBotCreate({
9143
+ static aiIndexOrgsUsersDocumentsUpdate({
9144
+ documentId,
9158
9145
  org,
9159
- requestBody
9146
+ userId,
9147
+ formData
9160
9148
  }) {
9161
9149
  return request(OpenAPI, {
9162
- method: 'POST',
9163
- url: '/api/ai-bot/v1/bots/{org}/bot/',
9150
+ method: 'PUT',
9151
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
9164
9152
  path: {
9165
- 'org': org
9153
+ 'document_id': documentId,
9154
+ 'org': org,
9155
+ 'user_id': userId
9166
9156
  },
9167
- body: requestBody,
9168
- mediaType: 'application/json'
9169
- });
9170
- }
9171
- /**
9172
- * Create slash commands for a specific bot
9173
- * eg. /iblai-baseline
9174
- * @returns BotCommand
9175
- * @throws ApiError
9176
- */
9177
- static aiBotV1BotsBotCommandsList({
9178
- org
9179
- }) {
9180
- return request(OpenAPI, {
9181
- method: 'GET',
9182
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/',
9183
- path: {
9184
- 'org': org
9157
+ formData: formData,
9158
+ mediaType: 'multipart/form-data',
9159
+ errors: {
9160
+ 400: `Invalid request data`,
9161
+ 404: `Document not found`
9185
9162
  }
9186
9163
  });
9187
9164
  }
9188
9165
  /**
9189
- * Create slash commands for a specific bot
9190
- * eg. /iblai-baseline
9191
- * @returns BotCommand
9166
+ * Delete a specific document embedding.
9167
+ *
9168
+ * This endpoint removes a document embedding from the system,
9169
+ * including untraining it from any associated pathways.
9170
+ *
9171
+ * Args:
9172
+ * request: The HTTP request.
9173
+ * org: Organization key identifier.
9174
+ * document_id: The ID of the document embedding to delete.
9175
+ *
9176
+ * Returns:
9177
+ * Response: An empty response with a 204 status code if successful.
9178
+ *
9179
+ * Raises:
9180
+ * NotFound: If the specified document embedding does not exist.
9181
+ * @returns void
9192
9182
  * @throws ApiError
9193
9183
  */
9194
- static aiBotV1BotsBotCommandsCreate({
9184
+ static aiIndexOrgsUsersDocumentsDestroy({
9185
+ documentId,
9195
9186
  org,
9196
- requestBody
9187
+ userId
9197
9188
  }) {
9198
9189
  return request(OpenAPI, {
9199
- method: 'POST',
9200
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/',
9190
+ method: 'DELETE',
9191
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
9201
9192
  path: {
9202
- 'org': org
9193
+ 'document_id': documentId,
9194
+ 'org': org,
9195
+ 'user_id': userId
9203
9196
  },
9204
- body: requestBody,
9205
- mediaType: 'application/json'
9197
+ errors: {
9198
+ 404: `Document not found`
9199
+ }
9206
9200
  });
9207
9201
  }
9208
9202
  /**
9209
- * Create slash commands for a specific bot
9210
- * eg. /iblai-baseline
9211
- * @returns BotCommand
9203
+ * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
9204
+ * @returns DocumentSettingsResponse
9212
9205
  * @throws ApiError
9213
9206
  */
9214
- static aiBotV1BotsBotCommandsRetrieve({
9215
- id,
9216
- org
9207
+ static aiIndexOrgsUsersDocumentsSettingsRetrieve({
9208
+ documentId,
9209
+ org,
9210
+ userId
9217
9211
  }) {
9218
9212
  return request(OpenAPI, {
9219
9213
  method: 'GET',
9220
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
9214
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/',
9221
9215
  path: {
9222
- 'id': id,
9223
- 'org': org
9216
+ 'document_id': documentId,
9217
+ 'org': org,
9218
+ 'user_id': userId
9224
9219
  }
9225
9220
  });
9226
9221
  }
9227
9222
  /**
9228
- * Create slash commands for a specific bot
9229
- * eg. /iblai-baseline
9230
- * @returns BotCommand
9223
+ * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
9224
+ * @returns DocumentSettingsResponse
9231
9225
  * @throws ApiError
9232
9226
  */
9233
- static aiBotV1BotsBotCommandsUpdate({
9234
- id,
9227
+ static aiIndexOrgsUsersDocumentsSettingsCreate({
9228
+ documentId,
9235
9229
  org,
9230
+ userId,
9236
9231
  requestBody
9237
9232
  }) {
9238
9233
  return request(OpenAPI, {
9239
- method: 'PUT',
9240
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
9234
+ method: 'POST',
9235
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/',
9241
9236
  path: {
9242
- 'id': id,
9243
- 'org': org
9237
+ 'document_id': documentId,
9238
+ 'org': org,
9239
+ 'user_id': userId
9244
9240
  },
9245
9241
  body: requestBody,
9246
9242
  mediaType: 'application/json'
9247
9243
  });
9248
9244
  }
9249
9245
  /**
9250
- * Create slash commands for a specific bot
9251
- * eg. /iblai-baseline
9252
- * @returns BotCommand
9246
+ * Train a graph-based document through a worker process.
9247
+ *
9248
+ * This endpoint queues graph-based documents for training through a
9249
+ * specialized worker process that handles knowledge graph processing.
9250
+ *
9251
+ * Args:
9252
+ * request: The HTTP request containing the document information.
9253
+ * org: Organization key identifier.
9254
+ *
9255
+ * Returns:
9256
+ * Response: A confirmation that the document was queued for training,
9257
+ * including a task ID for tracking the progress.
9258
+ *
9259
+ * Raises:
9260
+ * ValidationError: If the request data is invalid.
9261
+ * BadRequest: If there was an error processing the document.
9262
+ * @returns TrainDocumentViewResponse
9253
9263
  * @throws ApiError
9254
9264
  */
9255
- static aiBotV1BotsBotCommandsPartialUpdate({
9256
- id,
9265
+ static aiIndexOrgsUsersDocumentsGraphTrainCreate({
9257
9266
  org,
9258
- requestBody
9267
+ userId,
9268
+ formData
9259
9269
  }) {
9260
9270
  return request(OpenAPI, {
9261
- method: 'PATCH',
9262
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
9271
+ method: 'POST',
9272
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/graph-train/',
9263
9273
  path: {
9264
- 'id': id,
9265
- 'org': org
9274
+ 'org': org,
9275
+ 'user_id': userId
9266
9276
  },
9267
- body: requestBody,
9268
- mediaType: 'application/json'
9269
- });
9270
- }
9271
- /**
9272
- * Create slash commands for a specific bot
9273
- * eg. /iblai-baseline
9274
- * @returns void
9275
- * @throws ApiError
9276
- */
9277
- static aiBotV1BotsBotCommandsDestroy({
9278
- id,
9279
- org
9280
- }) {
9281
- return request(OpenAPI, {
9282
- method: 'DELETE',
9283
- url: '/api/ai-bot/v1/bots/{org}/bot-commands/{id}/',
9284
- path: {
9285
- 'id': id,
9286
- 'org': org
9277
+ formData: formData,
9278
+ mediaType: 'multipart/form-data',
9279
+ errors: {
9280
+ 400: `Invalid request data or document processing error`
9287
9281
  }
9288
9282
  });
9289
9283
  }
9290
9284
  /**
9291
- * Create modify and update bot information for a specific tenant.
9292
- * @returns Bot
9293
- * @throws ApiError
9294
- */
9295
- static aiBotV1BotsBotRetrieve({
9296
- id,
9297
- org
9285
+ * Description:
9286
+ * Retrieves a list of document embeddings for a specific pathway with optional search and pagination.
9287
+ *
9288
+ * Methods:
9289
+ * - GET: Retrieves document embeddings that match the specified search criteria and are paginated according to offset and limit.
9290
+ *
9291
+ * Parameters:
9292
+ * - search (str): Search query to filter document names or URLs.
9293
+ * - offset (int): Offset number for pagination.
9294
+ * - limit (int): Limit number for pagination.
9295
+ *
9296
+ * Returns:
9297
+ * - GET: A paginated list of document embeddings with their details.
9298
+ * {
9299
+ * "count": 10,
9300
+ * "next": "http://api.example.com/retriever_documents/?offset=10&limit=2",
9301
+ * "previous": "http://api.example.com/retriever_documents/?offset=0&limit=2",
9302
+ * "results": [
9303
+ * {
9304
+ * "document_name": "Document2",
9305
+ * "platform_key": "example_platform",
9306
+ * "pathway": "example_pathway"
9307
+ * }
9308
+ * ]
9309
+ * }
9310
+ *
9311
+ * Error Responses:
9312
+ * - 400 Bad Request: Invalid query parameters.
9313
+ * - 404 Not Found: No document embeddings found for the specified criteria.
9314
+ * @returns PaginatedRetrieverDocumentEmbeddingList
9315
+ * @throws ApiError
9316
+ */
9317
+ static aiIndexOrgsUsersDocumentsPathwaysList({
9318
+ org,
9319
+ pathway,
9320
+ userId,
9321
+ limit,
9322
+ offset,
9323
+ search
9298
9324
  }) {
9299
9325
  return request(OpenAPI, {
9300
9326
  method: 'GET',
9301
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
9327
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/pathways/{pathway}/',
9302
9328
  path: {
9303
- 'id': id,
9304
- 'org': org
9329
+ 'org': org,
9330
+ 'pathway': pathway,
9331
+ 'user_id': userId
9332
+ },
9333
+ query: {
9334
+ 'limit': limit,
9335
+ 'offset': offset,
9336
+ 'search': search
9305
9337
  }
9306
9338
  });
9307
9339
  }
9308
9340
  /**
9309
- * Create modify and update bot information for a specific tenant.
9310
- * @returns BotCreate
9341
+ * Retrieve resource documents similar to the given query.
9342
+ *
9343
+ * This endpoint performs a semantic search to find documents that are
9344
+ * relevant to the provided query within the specified pathway.
9345
+ *
9346
+ * Args:
9347
+ * request: The HTTP request containing the search query.
9348
+ * org: Organization key identifier.
9349
+ *
9350
+ * Returns:
9351
+ * Response: A list of documents relevant to the search query.
9352
+ *
9353
+ * Raises:
9354
+ * ValidationError: If the request data is invalid.
9355
+ * @returns RetrieverResponseSearch
9311
9356
  * @throws ApiError
9312
9357
  */
9313
- static aiBotV1BotsBotUpdate({
9314
- id,
9358
+ static aiIndexOrgsUsersDocumentsSearchCreate({
9315
9359
  org,
9360
+ userId,
9316
9361
  requestBody
9317
9362
  }) {
9318
9363
  return request(OpenAPI, {
9319
- method: 'PUT',
9320
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
9364
+ method: 'POST',
9365
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/search/',
9321
9366
  path: {
9322
- 'id': id,
9323
- 'org': org
9367
+ 'org': org,
9368
+ 'user_id': userId
9324
9369
  },
9325
9370
  body: requestBody,
9326
- mediaType: 'application/json'
9371
+ mediaType: 'application/json',
9372
+ errors: {
9373
+ 400: `Invalid request data`
9374
+ }
9327
9375
  });
9328
9376
  }
9329
9377
  /**
9330
- * Create modify and update bot information for a specific tenant.
9331
- * @returns BotCreate
9378
+ * Retrieve document sources related to a given query.
9379
+ *
9380
+ * This endpoint performs a semantic search to find document sources
9381
+ * that are relevant to the provided query within the specified pathway,
9382
+ * and returns them along with confidence levels.
9383
+ *
9384
+ * Args:
9385
+ * request: The HTTP request containing the search query.
9386
+ * org: Organization key identifier.
9387
+ *
9388
+ * Returns:
9389
+ * Response: A list of document sources with confidence levels.
9390
+ *
9391
+ * Raises:
9392
+ * ValidationError: If the request data is invalid.
9393
+ * @returns RetrieverRequestSearchDocument
9332
9394
  * @throws ApiError
9333
9395
  */
9334
- static aiBotV1BotsBotPartialUpdate({
9335
- id,
9396
+ static aiIndexOrgsUsersDocumentsSourcesCreate({
9336
9397
  org,
9398
+ userId,
9337
9399
  requestBody
9338
9400
  }) {
9339
9401
  return request(OpenAPI, {
9340
- method: 'PATCH',
9341
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
9402
+ method: 'POST',
9403
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/sources/',
9342
9404
  path: {
9343
- 'id': id,
9344
- 'org': org
9405
+ 'org': org,
9406
+ 'user_id': userId
9345
9407
  },
9346
9408
  body: requestBody,
9347
- mediaType: 'application/json'
9348
- });
9349
- }
9350
- /**
9351
- * Create modify and update bot information for a specific tenant.
9352
- * @returns void
9353
- * @throws ApiError
9354
- */
9355
- static aiBotV1BotsBotDestroy({
9356
- id,
9357
- org
9358
- }) {
9359
- return request(OpenAPI, {
9360
- method: 'DELETE',
9361
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/',
9362
- path: {
9363
- 'id': id,
9364
- 'org': org
9409
+ mediaType: 'application/json',
9410
+ errors: {
9411
+ 400: `Invalid request data`
9365
9412
  }
9366
9413
  });
9367
9414
  }
9368
9415
  /**
9369
- * Create modify and update bot information for a specific tenant.
9370
- * @returns DiscordConfig
9416
+ * Check the status of a document training task.
9417
+ *
9418
+ * This endpoint retrieves the current status of an asynchronous
9419
+ * document training task that was previously initiated.
9420
+ *
9421
+ * Args:
9422
+ * request: The HTTP request.
9423
+ * org: Organization key identifier.
9424
+ * task_id: The ID of the training task to check.
9425
+ *
9426
+ * Returns:
9427
+ * Response: The current status of the document training task,
9428
+ * which can be "pending", "completed", or "failed".
9429
+ * @returns CheckDocumentTrainingStatus
9371
9430
  * @throws ApiError
9372
9431
  */
9373
- static aiBotV1BotsBotConfigDiscordRetrieve({
9374
- id,
9375
- org
9432
+ static aiIndexOrgsUsersDocumentsTasksRetrieve({
9433
+ org,
9434
+ taskId,
9435
+ userId
9376
9436
  }) {
9377
9437
  return request(OpenAPI, {
9378
9438
  method: 'GET',
9379
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
9439
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/tasks/{task_id}/',
9380
9440
  path: {
9381
- 'id': id,
9382
- 'org': org
9441
+ 'org': org,
9442
+ 'task_id': taskId,
9443
+ 'user_id': userId
9383
9444
  }
9384
9445
  });
9385
9446
  }
9386
9447
  /**
9387
- * Create modify and update bot information for a specific tenant.
9388
- * @returns DiscordConfig
9448
+ * Train a document through a worker process.
9449
+ *
9450
+ * This endpoint queues larger documents for training through a worker
9451
+ * process, which is more suitable for handling documents that would
9452
+ * take too long to process directly.
9453
+ *
9454
+ * Args:
9455
+ * request: The HTTP request containing the document information.
9456
+ * org: Organization key identifier.
9457
+ *
9458
+ * Returns:
9459
+ * Response: A confirmation that the document was queued for training,
9460
+ * including a task ID for tracking the progress.
9461
+ *
9462
+ * Raises:
9463
+ * ValidationError: If the request data is invalid.
9464
+ * BadRequest: If there was an error processing the document.
9465
+ * @returns TrainDocumentViewResponse
9389
9466
  * @throws ApiError
9390
9467
  */
9391
- static aiBotV1BotsBotConfigDiscordPartialUpdate({
9392
- id,
9468
+ static aiIndexOrgsUsersDocumentsTrainCreate({
9393
9469
  org,
9394
- requestBody
9470
+ userId,
9471
+ formData
9395
9472
  }) {
9396
9473
  return request(OpenAPI, {
9397
- method: 'PATCH',
9398
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/discord/',
9474
+ method: 'POST',
9475
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/train/',
9399
9476
  path: {
9400
- 'id': id,
9401
- 'org': org
9477
+ 'org': org,
9478
+ 'user_id': userId
9402
9479
  },
9403
- body: requestBody,
9404
- mediaType: 'application/json'
9405
- });
9406
- }
9407
- /**
9408
- * Create modify and update bot information for a specific tenant.
9409
- * @returns SlackConfig
9410
- * @throws ApiError
9411
- */
9412
- static aiBotV1BotsBotConfigSlackRetrieve({
9413
- id,
9414
- org
9415
- }) {
9416
- return request(OpenAPI, {
9417
- method: 'GET',
9418
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/',
9419
- path: {
9420
- 'id': id,
9421
- 'org': org
9480
+ formData: formData,
9481
+ mediaType: 'multipart/form-data',
9482
+ errors: {
9483
+ 400: `Invalid request data`
9422
9484
  }
9423
9485
  });
9424
9486
  }
9425
9487
  /**
9426
- * Create modify and update bot information for a specific tenant.
9427
- * @returns SlackConfig
9488
+ * Train a document directly without using a worker.
9489
+ *
9490
+ * This endpoint is designed for training smaller documents directly
9491
+ * without queuing them through a worker process. For larger documents,
9492
+ * use the TrainDocumentView endpoint instead.
9493
+ *
9494
+ * Args:
9495
+ * request: The HTTP request containing the document information.
9496
+ * org: Organization key identifier.
9497
+ *
9498
+ * Returns:
9499
+ * Response: A confirmation that the document was trained successfully.
9500
+ *
9501
+ * Raises:
9502
+ * ValidationError: If the request data is invalid.
9503
+ * BadRequest: If the document training failed.
9504
+ * @returns RetreiverTrainViewResponse
9428
9505
  * @throws ApiError
9429
9506
  */
9430
- static aiBotV1BotsBotConfigSlackUpdateCreate({
9431
- id,
9507
+ static aiIndexOrgsUsersDocumentsTrainRetrieverCreate({
9432
9508
  org,
9433
- requestBody
9509
+ userId,
9510
+ formData
9434
9511
  }) {
9435
9512
  return request(OpenAPI, {
9436
9513
  method: 'POST',
9437
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
9514
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/train/retriever/',
9438
9515
  path: {
9439
- 'id': id,
9440
- 'org': org
9516
+ 'org': org,
9517
+ 'user_id': userId
9441
9518
  },
9442
- body: requestBody,
9443
- mediaType: 'application/json'
9519
+ formData: formData,
9520
+ mediaType: 'multipart/form-data',
9521
+ errors: {
9522
+ 400: `Invalid request data or training failed`
9523
+ }
9444
9524
  });
9445
9525
  }
9446
9526
  /**
9447
- * Create modify and update bot information for a specific tenant.
9448
- * @returns SlackConfig
9449
- * @throws ApiError
9450
- */
9451
- static aiBotV1BotsBotConfigSlackUpdateUpdate({
9452
- id,
9527
+ * Description:
9528
+ * Submit a document file in a chat session. Checks file type, size, and ensures the session exists, then processes the file.
9529
+ * Process document for use in a specific chat session.
9530
+ * which will be processed and made available for the AI to reference
9531
+ * when responding to queries in that session.
9532
+ *
9533
+ * Methods:
9534
+ * - POST: Submits a document or media file for training within a specified chat session.
9535
+ *
9536
+ * Parameters:
9537
+ * - org (str):
9538
+ * - session_id (str): UUID of the chat session for which the document is being submitted.
9539
+ * - *args, **kwargs: Additional arguments.
9540
+ * - file (file): Multipart file input.
9541
+ *
9542
+ * Returns:
9543
+ * - POST: Returns a JSON message with the result of the upload process. Response code 200 on success.
9544
+ * {
9545
+ * "message": "File processed."
9546
+ * }
9547
+ *
9548
+ * Error Responses:
9549
+ * - 400 Bad Request:
9550
+ * - "File field is required" if the 'file' parameter is missing.
9551
+ * - "invalid file object" if the file object is not valid.
9552
+ * - Specific error message if an exception occurs while saving to Redis.
9553
+ * - 404 Not Found:
9554
+ * - "Session not found" if the provided session_id does not match any existing session.
9555
+ * - 413 Request Entity Too Large:
9556
+ * - "file is too large" including specific limits for document and media files if the file exceeds size limits.
9557
+ *
9558
+ * Access Control:
9559
+ * Requires authentication with a Bearer token in the Authorization header. The user associated with the session must exist and be authorized for the request.
9560
+ * @returns TrainChatSessionDocumentView
9561
+ * @throws ApiError
9562
+ */
9563
+ static aiIndexOrgsUsersDocumentsTrainSessionsCreate({
9453
9564
  org,
9454
- requestBody
9565
+ sessionId,
9566
+ userId,
9567
+ formData
9455
9568
  }) {
9456
9569
  return request(OpenAPI, {
9457
- method: 'PUT',
9458
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
9570
+ method: 'POST',
9571
+ url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/train/sessions/{session_id}/',
9459
9572
  path: {
9460
- 'id': id,
9461
- 'org': org
9573
+ 'org': org,
9574
+ 'session_id': sessionId,
9575
+ 'user_id': userId
9462
9576
  },
9463
- body: requestBody,
9464
- mediaType: 'application/json'
9465
- });
9466
- }
9467
- /**
9468
- * Create modify and update bot information for a specific tenant.
9469
- * @returns SlackConfig
9470
- * @throws ApiError
9471
- */
9472
- static aiBotV1BotsBotConfigSlackUpdatePartialUpdate({
9473
- id,
9474
- org,
9475
- requestBody
9476
- }) {
9477
- return request(OpenAPI, {
9478
- method: 'PATCH',
9479
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/slack/update/',
9480
- path: {
9481
- 'id': id,
9482
- 'org': org
9483
- },
9484
- body: requestBody,
9485
- mediaType: 'application/json'
9486
- });
9487
- }
9488
- /**
9489
- * Create modify and update bot information for a specific tenant.
9490
- * @returns TeamsConfig
9491
- * @throws ApiError
9492
- */
9493
- static aiBotV1BotsBotConfigTeamsRetrieve({
9494
- id,
9495
- org
9496
- }) {
9497
- return request(OpenAPI, {
9498
- method: 'GET',
9499
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/',
9500
- path: {
9501
- 'id': id,
9502
- 'org': org
9503
- }
9504
- });
9505
- }
9506
- /**
9507
- * Create modify and update bot information for a specific tenant.
9508
- * @returns TeamsConfig
9509
- * @throws ApiError
9510
- */
9511
- static aiBotV1BotsBotConfigTeamsUpdateCreate({
9512
- id,
9513
- org,
9514
- requestBody
9515
- }) {
9516
- return request(OpenAPI, {
9517
- method: 'POST',
9518
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
9519
- path: {
9520
- 'id': id,
9521
- 'org': org
9522
- },
9523
- body: requestBody,
9524
- mediaType: 'application/json'
9525
- });
9526
- }
9527
- /**
9528
- * Create modify and update bot information for a specific tenant.
9529
- * @returns TeamsConfig
9530
- * @throws ApiError
9531
- */
9532
- static aiBotV1BotsBotConfigTeamsUpdateUpdate({
9533
- id,
9534
- org,
9535
- requestBody
9536
- }) {
9537
- return request(OpenAPI, {
9538
- method: 'PUT',
9539
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
9540
- path: {
9541
- 'id': id,
9542
- 'org': org
9543
- },
9544
- body: requestBody,
9545
- mediaType: 'application/json'
9546
- });
9547
- }
9548
- /**
9549
- * Create modify and update bot information for a specific tenant.
9550
- * @returns TeamsConfig
9551
- * @throws ApiError
9552
- */
9553
- static aiBotV1BotsBotConfigTeamsUpdatePartialUpdate({
9554
- id,
9555
- org,
9556
- requestBody
9557
- }) {
9558
- return request(OpenAPI, {
9559
- method: 'PATCH',
9560
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/teams/update/',
9561
- path: {
9562
- 'id': id,
9563
- 'org': org
9564
- },
9565
- body: requestBody,
9566
- mediaType: 'application/json'
9567
- });
9568
- }
9569
- /**
9570
- * Create modify and update bot information for a specific tenant.
9571
- * @returns WebexConfig
9572
- * @throws ApiError
9573
- */
9574
- static aiBotV1BotsBotConfigWebexRetrieve({
9575
- id,
9576
- org
9577
- }) {
9578
- return request(OpenAPI, {
9579
- method: 'GET',
9580
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/webex/',
9581
- path: {
9582
- 'id': id,
9583
- 'org': org
9584
- }
9585
- });
9586
- }
9587
- /**
9588
- * Create modify and update bot information for a specific tenant.
9589
- * @returns WebexConfig
9590
- * @throws ApiError
9591
- */
9592
- static aiBotV1BotsBotConfigWebexPartialUpdate({
9593
- id,
9594
- org,
9595
- requestBody
9596
- }) {
9597
- return request(OpenAPI, {
9598
- method: 'PATCH',
9599
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/webex/',
9600
- path: {
9601
- 'id': id,
9602
- 'org': org
9603
- },
9604
- body: requestBody,
9605
- mediaType: 'application/json'
9606
- });
9607
- }
9608
- /**
9609
- * Create modify and update bot information for a specific tenant.
9610
- * @returns WhatsappConfig
9611
- * @throws ApiError
9612
- */
9613
- static aiBotV1BotsBotConfigWhatsappRetrieve({
9614
- id,
9615
- org
9616
- }) {
9617
- return request(OpenAPI, {
9618
- method: 'GET',
9619
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/config/whatsapp/',
9620
- path: {
9621
- 'id': id,
9622
- 'org': org
9623
- }
9624
- });
9625
- }
9626
- /**
9627
- * Create modify and update bot information for a specific tenant.
9628
- * @returns WhatsappConfig
9629
- * @throws ApiError
9630
- */
9631
- static aiBotV1BotsBotWhatsappConfigUpdate({
9632
- id,
9633
- org,
9634
- requestBody
9635
- }) {
9636
- return request(OpenAPI, {
9637
- method: 'PUT',
9638
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/whatsapp-config/',
9639
- path: {
9640
- 'id': id,
9641
- 'org': org
9642
- },
9643
- body: requestBody,
9644
- mediaType: 'application/json'
9645
- });
9646
- }
9647
- /**
9648
- * Create modify and update bot information for a specific tenant.
9649
- * @returns WhatsappConfig
9650
- * @throws ApiError
9651
- */
9652
- static aiBotV1BotsBotWhatsappConfigPartialUpdate({
9653
- id,
9654
- org,
9655
- requestBody
9656
- }) {
9657
- return request(OpenAPI, {
9658
- method: 'PATCH',
9659
- url: '/api/ai-bot/v1/bots/{org}/bot/{id}/whatsapp-config/',
9660
- path: {
9661
- 'id': id,
9662
- 'org': org
9663
- },
9664
- body: requestBody,
9665
- mediaType: 'application/json'
9666
- });
9667
- }
9668
- /**
9669
- * Setup discord user id linkage with discord bots
9670
- * this will be used to authenticate the user when interracting with discord bots.
9671
- * the user id can be copied from the discord app after tapping on the user profile.
9672
- * @returns DiscordUserConfig
9673
- * @throws ApiError
9674
- */
9675
- static aiBotV1BotsDiscordUserConfigList({
9676
- org
9677
- }) {
9678
- return request(OpenAPI, {
9679
- method: 'GET',
9680
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/',
9681
- path: {
9682
- 'org': org
9683
- }
9684
- });
9685
- }
9686
- /**
9687
- * Setup discord user id linkage with discord bots
9688
- * this will be used to authenticate the user when interracting with discord bots.
9689
- * the user id can be copied from the discord app after tapping on the user profile.
9690
- * @returns DiscordUserConfig
9691
- * @throws ApiError
9692
- */
9693
- static aiBotV1BotsDiscordUserConfigCreate({
9694
- org,
9695
- requestBody
9696
- }) {
9697
- return request(OpenAPI, {
9698
- method: 'POST',
9699
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/',
9700
- path: {
9701
- 'org': org
9702
- },
9703
- body: requestBody,
9704
- mediaType: 'application/json'
9705
- });
9706
- }
9707
- /**
9708
- * Setup discord user id linkage with discord bots
9709
- * this will be used to authenticate the user when interracting with discord bots.
9710
- * the user id can be copied from the discord app after tapping on the user profile.
9711
- * @returns DiscordUserConfig
9712
- * @throws ApiError
9713
- */
9714
- static aiBotV1BotsDiscordUserConfigRetrieve({
9715
- id,
9716
- org
9717
- }) {
9718
- return request(OpenAPI, {
9719
- method: 'GET',
9720
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
9721
- path: {
9722
- 'id': id,
9723
- 'org': org
9724
- }
9725
- });
9726
- }
9727
- /**
9728
- * Setup discord user id linkage with discord bots
9729
- * this will be used to authenticate the user when interracting with discord bots.
9730
- * the user id can be copied from the discord app after tapping on the user profile.
9731
- * @returns DiscordUserConfig
9732
- * @throws ApiError
9733
- */
9734
- static aiBotV1BotsDiscordUserConfigUpdate({
9735
- id,
9736
- org,
9737
- requestBody
9738
- }) {
9739
- return request(OpenAPI, {
9740
- method: 'PUT',
9741
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
9742
- path: {
9743
- 'id': id,
9744
- 'org': org
9745
- },
9746
- body: requestBody,
9747
- mediaType: 'application/json'
9748
- });
9749
- }
9750
- /**
9751
- * Setup discord user id linkage with discord bots
9752
- * this will be used to authenticate the user when interracting with discord bots.
9753
- * the user id can be copied from the discord app after tapping on the user profile.
9754
- * @returns DiscordUserConfig
9755
- * @throws ApiError
9756
- */
9757
- static aiBotV1BotsDiscordUserConfigPartialUpdate({
9758
- id,
9759
- org,
9760
- requestBody
9761
- }) {
9762
- return request(OpenAPI, {
9763
- method: 'PATCH',
9764
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
9765
- path: {
9766
- 'id': id,
9767
- 'org': org
9768
- },
9769
- body: requestBody,
9770
- mediaType: 'application/json'
9771
- });
9772
- }
9773
- /**
9774
- * Setup discord user id linkage with discord bots
9775
- * this will be used to authenticate the user when interracting with discord bots.
9776
- * the user id can be copied from the discord app after tapping on the user profile.
9777
- * @returns void
9778
- * @throws ApiError
9779
- */
9780
- static aiBotV1BotsDiscordUserConfigDestroy({
9781
- id,
9782
- org
9783
- }) {
9784
- return request(OpenAPI, {
9785
- method: 'DELETE',
9786
- url: '/api/ai-bot/v1/bots/{org}/discord-user-config/{id}/',
9787
- path: {
9788
- 'id': id,
9789
- 'org': org
9790
- }
9791
- });
9792
- }
9793
- /**
9794
- * Setup slack username and domain linkage with slack bots
9795
- * this will be used to authenticate the user when interracting with slack bots.
9796
- * @returns SlackUserConfig
9797
- * @throws ApiError
9798
- */
9799
- static aiBotV1BotsSlackUserConfigList({
9800
- org
9801
- }) {
9802
- return request(OpenAPI, {
9803
- method: 'GET',
9804
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/',
9805
- path: {
9806
- 'org': org
9807
- }
9808
- });
9809
- }
9810
- /**
9811
- * Setup slack username and domain linkage with slack bots
9812
- * this will be used to authenticate the user when interracting with slack bots.
9813
- * @returns SlackUserConfig
9814
- * @throws ApiError
9815
- */
9816
- static aiBotV1BotsSlackUserConfigCreate({
9817
- org,
9818
- requestBody
9819
- }) {
9820
- return request(OpenAPI, {
9821
- method: 'POST',
9822
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/',
9823
- path: {
9824
- 'org': org
9825
- },
9826
- body: requestBody,
9827
- mediaType: 'application/json'
9828
- });
9829
- }
9830
- /**
9831
- * Setup slack username and domain linkage with slack bots
9832
- * this will be used to authenticate the user when interracting with slack bots.
9833
- * @returns SlackUserConfig
9834
- * @throws ApiError
9835
- */
9836
- static aiBotV1BotsSlackUserConfigRetrieve({
9837
- id,
9838
- org
9839
- }) {
9840
- return request(OpenAPI, {
9841
- method: 'GET',
9842
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
9843
- path: {
9844
- 'id': id,
9845
- 'org': org
9846
- }
9847
- });
9848
- }
9849
- /**
9850
- * Setup slack username and domain linkage with slack bots
9851
- * this will be used to authenticate the user when interracting with slack bots.
9852
- * @returns SlackUserConfig
9853
- * @throws ApiError
9854
- */
9855
- static aiBotV1BotsSlackUserConfigUpdate({
9856
- id,
9857
- org,
9858
- requestBody
9859
- }) {
9860
- return request(OpenAPI, {
9861
- method: 'PUT',
9862
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
9863
- path: {
9864
- 'id': id,
9865
- 'org': org
9866
- },
9867
- body: requestBody,
9868
- mediaType: 'application/json'
9869
- });
9870
- }
9871
- /**
9872
- * Setup slack username and domain linkage with slack bots
9873
- * this will be used to authenticate the user when interracting with slack bots.
9874
- * @returns SlackUserConfig
9875
- * @throws ApiError
9876
- */
9877
- static aiBotV1BotsSlackUserConfigPartialUpdate({
9878
- id,
9879
- org,
9880
- requestBody
9881
- }) {
9882
- return request(OpenAPI, {
9883
- method: 'PATCH',
9884
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
9885
- path: {
9886
- 'id': id,
9887
- 'org': org
9888
- },
9889
- body: requestBody,
9890
- mediaType: 'application/json'
9891
- });
9892
- }
9893
- /**
9894
- * Setup slack username and domain linkage with slack bots
9895
- * this will be used to authenticate the user when interracting with slack bots.
9896
- * @returns void
9897
- * @throws ApiError
9898
- */
9899
- static aiBotV1BotsSlackUserConfigDestroy({
9900
- id,
9901
- org
9902
- }) {
9903
- return request(OpenAPI, {
9904
- method: 'DELETE',
9905
- url: '/api/ai-bot/v1/bots/{org}/slack-user-config/{id}/',
9906
- path: {
9907
- 'id': id,
9908
- 'org': org
9909
- }
9910
- });
9911
- }
9912
- /**
9913
- * Setup phone number linkage with whatsapp bots
9914
- * This phone number will be used to authenticate and allow access to whatsapp bots.
9915
- * @returns WhatsappUserConfig
9916
- * @throws ApiError
9917
- */
9918
- static aiBotV1BotsWhatsappUserConfigList({
9919
- org
9920
- }) {
9921
- return request(OpenAPI, {
9922
- method: 'GET',
9923
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/',
9924
- path: {
9925
- 'org': org
9926
- }
9927
- });
9928
- }
9929
- /**
9930
- * Setup phone number linkage with whatsapp bots
9931
- * This phone number will be used to authenticate and allow access to whatsapp bots.
9932
- * @returns WhatsappUserConfig
9933
- * @throws ApiError
9934
- */
9935
- static aiBotV1BotsWhatsappUserConfigCreate({
9936
- org,
9937
- requestBody
9938
- }) {
9939
- return request(OpenAPI, {
9940
- method: 'POST',
9941
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/',
9942
- path: {
9943
- 'org': org
9944
- },
9945
- body: requestBody,
9946
- mediaType: 'application/json'
9947
- });
9948
- }
9949
- /**
9950
- * Setup phone number linkage with whatsapp bots
9951
- * This phone number will be used to authenticate and allow access to whatsapp bots.
9952
- * @returns WhatsappUserConfig
9953
- * @throws ApiError
9954
- */
9955
- static aiBotV1BotsWhatsappUserConfigRetrieve({
9956
- id,
9957
- org
9958
- }) {
9959
- return request(OpenAPI, {
9960
- method: 'GET',
9961
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
9962
- path: {
9963
- 'id': id,
9964
- 'org': org
9965
- }
9966
- });
9967
- }
9968
- /**
9969
- * Setup phone number linkage with whatsapp bots
9970
- * This phone number will be used to authenticate and allow access to whatsapp bots.
9971
- * @returns WhatsappUserConfig
9972
- * @throws ApiError
9973
- */
9974
- static aiBotV1BotsWhatsappUserConfigUpdate({
9975
- id,
9976
- org,
9977
- requestBody
9978
- }) {
9979
- return request(OpenAPI, {
9980
- method: 'PUT',
9981
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
9982
- path: {
9983
- 'id': id,
9984
- 'org': org
9985
- },
9986
- body: requestBody,
9987
- mediaType: 'application/json'
9988
- });
9989
- }
9990
- /**
9991
- * Setup phone number linkage with whatsapp bots
9992
- * This phone number will be used to authenticate and allow access to whatsapp bots.
9993
- * @returns WhatsappUserConfig
9994
- * @throws ApiError
9995
- */
9996
- static aiBotV1BotsWhatsappUserConfigPartialUpdate({
9997
- id,
9998
- org,
9999
- requestBody
10000
- }) {
10001
- return request(OpenAPI, {
10002
- method: 'PATCH',
10003
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
10004
- path: {
10005
- 'id': id,
10006
- 'org': org
10007
- },
10008
- body: requestBody,
10009
- mediaType: 'application/json'
10010
- });
10011
- }
10012
- /**
10013
- * Setup phone number linkage with whatsapp bots
10014
- * This phone number will be used to authenticate and allow access to whatsapp bots.
10015
- * @returns void
10016
- * @throws ApiError
10017
- */
10018
- static aiBotV1BotsWhatsappUserConfigDestroy({
10019
- id,
10020
- org
10021
- }) {
10022
- return request(OpenAPI, {
10023
- method: 'DELETE',
10024
- url: '/api/ai-bot/v1/bots/{org}/whatsapp-user-config/{id}/',
10025
- path: {
10026
- 'id': id,
10027
- 'org': org
10028
- }
10029
- });
10030
- }
10031
- /**
10032
- * Webhook endpoint to receive and process discord messages.
10033
- * @returns DiscordWebhook
10034
- * @throws ApiError
10035
- */
10036
- static aiBotV1BotsWebhooksDiscordCreate({
10037
- name,
10038
- org,
10039
- requestBody
10040
- }) {
10041
- return request(OpenAPI, {
10042
- method: 'POST',
10043
- url: '/api/ai-bot/v1/bots/webhooks/{org}/discord/{name}/',
10044
- path: {
10045
- 'name': name,
10046
- 'org': org
10047
- },
10048
- body: requestBody,
10049
- mediaType: 'application/json'
10050
- });
10051
- }
10052
- /**
10053
- * @returns SlackWebhook
10054
- * @throws ApiError
10055
- */
10056
- static aiBotV1BotsWebhooksSlackCreate({
10057
- name,
10058
- org,
10059
- requestBody
10060
- }) {
10061
- return request(OpenAPI, {
10062
- method: 'POST',
10063
- url: '/api/ai-bot/v1/bots/webhooks/{org}/slack/{name}/',
10064
- path: {
10065
- 'name': name,
10066
- 'org': org
10067
- },
10068
- body: requestBody,
10069
- mediaType: 'application/json'
10070
- });
10071
- }
10072
- /**
10073
- * @returns TeamsWebhook
10074
- * @throws ApiError
10075
- */
10076
- static aiBotV1BotsWebhooksTeamsCreate({
10077
- name,
10078
- org,
10079
- requestBody
10080
- }) {
10081
- return request(OpenAPI, {
10082
- method: 'POST',
10083
- url: '/api/ai-bot/v1/bots/webhooks/{org}/teams/{name}/',
10084
- path: {
10085
- 'name': name,
10086
- 'org': org
10087
- },
10088
- body: requestBody,
10089
- mediaType: 'application/json'
10090
- });
10091
- }
10092
- /**
10093
- * Webhook endpoint to receive and process discord messages.
10094
- * @returns WebexWebhook
10095
- * @throws ApiError
10096
- */
10097
- static aiBotV1BotsWebhooksWebexCreate({
10098
- name,
10099
- org,
10100
- requestBody
10101
- }) {
10102
- return request(OpenAPI, {
10103
- method: 'POST',
10104
- url: '/api/ai-bot/v1/bots/webhooks/{org}/webex/{name}/',
10105
- path: {
10106
- 'name': name,
10107
- 'org': org
10108
- },
10109
- body: requestBody,
10110
- mediaType: 'application/json'
10111
- });
10112
- }
10113
- /**
10114
- * Respond to whatsapp's webhook challenge.
10115
- * Parameters Required include the tenant key (org) and the name of the bot: (name)
10116
- * @returns WhatAppWebHook
10117
- * @throws ApiError
10118
- */
10119
- static aiBotV1BotsWebhooksWhatsappRetrieve({
10120
- name,
10121
- org
10122
- }) {
10123
- return request(OpenAPI, {
10124
- method: 'GET',
10125
- url: '/api/ai-bot/v1/bots/webhooks/{org}/whatsapp/{name}/',
10126
- path: {
10127
- 'name': name,
10128
- 'org': org
10129
- }
10130
- });
10131
- }
10132
- /**
10133
- * Accept and process webhook events from whatsapp.
10134
- * @returns WhatAppWebHook
10135
- * @throws ApiError
10136
- */
10137
- static aiBotV1BotsWebhooksWhatsappCreate({
10138
- name,
10139
- org,
10140
- requestBody
10141
- }) {
10142
- return request(OpenAPI, {
10143
- method: 'POST',
10144
- url: '/api/ai-bot/v1/bots/webhooks/{org}/whatsapp/{name}/',
10145
- path: {
10146
- 'name': name,
10147
- 'org': org
10148
- },
10149
- body: requestBody,
10150
- mediaType: 'application/json'
10151
- });
10152
- }
10153
- }
10154
-
10155
- class AiFinetuningService {
10156
- /**
10157
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10158
- * @returns PaginatedDataSetList
10159
- * @throws ApiError
10160
- */
10161
- static aiFinetuningV1OrgUserDatasetsList({
10162
- org,
10163
- username,
10164
- dateCreated,
10165
- numDataPoints,
10166
- ordering,
10167
- page,
10168
- pageSize,
10169
- retryAttempts,
10170
- search,
10171
- status
10172
- }) {
10173
- return request(OpenAPI, {
10174
- method: 'GET',
10175
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/',
10176
- path: {
10177
- 'org': org,
10178
- 'username': username
10179
- },
10180
- query: {
10181
- 'date_created': dateCreated,
10182
- 'num_data_points': numDataPoints,
10183
- 'ordering': ordering,
10184
- 'page': page,
10185
- 'page_size': pageSize,
10186
- 'retry_attempts': retryAttempts,
10187
- 'search': search,
10188
- 'status': status
10189
- }
10190
- });
10191
- }
10192
- /**
10193
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10194
- * @returns DataSetCreate
10195
- * @throws ApiError
10196
- */
10197
- static aiFinetuningV1OrgUserDatasetsCreate({
10198
- org,
10199
- username,
10200
- requestBody
10201
- }) {
10202
- return request(OpenAPI, {
10203
- method: 'POST',
10204
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/',
10205
- path: {
10206
- 'org': org,
10207
- 'username': username
10208
- },
10209
- body: requestBody,
10210
- mediaType: 'application/json'
10211
- });
10212
- }
10213
- /**
10214
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10215
- * @returns DataSet
10216
- * @throws ApiError
10217
- */
10218
- static aiFinetuningV1OrgUserDatasetsRetrieve({
10219
- id,
10220
- org,
10221
- username
10222
- }) {
10223
- return request(OpenAPI, {
10224
- method: 'GET',
10225
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
10226
- path: {
10227
- 'id': id,
10228
- 'org': org,
10229
- 'username': username
10230
- }
10231
- });
10232
- }
10233
- /**
10234
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10235
- * @returns DataSet
10236
- * @throws ApiError
10237
- */
10238
- static aiFinetuningV1OrgUserDatasetsUpdate({
10239
- id,
10240
- org,
10241
- username,
10242
- requestBody
10243
- }) {
10244
- return request(OpenAPI, {
10245
- method: 'PUT',
10246
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
10247
- path: {
10248
- 'id': id,
10249
- 'org': org,
10250
- 'username': username
10251
- },
10252
- body: requestBody,
10253
- mediaType: 'application/json'
10254
- });
10255
- }
10256
- /**
10257
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10258
- * @returns DataSet
10259
- * @throws ApiError
10260
- */
10261
- static aiFinetuningV1OrgUserDatasetsPartialUpdate({
10262
- id,
10263
- org,
10264
- username,
10265
- requestBody
10266
- }) {
10267
- return request(OpenAPI, {
10268
- method: 'PATCH',
10269
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
10270
- path: {
10271
- 'id': id,
10272
- 'org': org,
10273
- 'username': username
10274
- },
10275
- body: requestBody,
10276
- mediaType: 'application/json'
10277
- });
10278
- }
10279
- /**
10280
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10281
- * @returns void
10282
- * @throws ApiError
10283
- */
10284
- static aiFinetuningV1OrgUserDatasetsDestroy({
10285
- id,
10286
- org,
10287
- username
10288
- }) {
10289
- return request(OpenAPI, {
10290
- method: 'DELETE',
10291
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
10292
- path: {
10293
- 'id': id,
10294
- 'org': org,
10295
- 'username': username
10296
- }
10297
- });
10298
- }
10299
- /**
10300
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10301
- * @returns PaginatedTrainingList
10302
- * @throws ApiError
10303
- */
10304
- static aiFinetuningV1OrgUserTrainingsList({
10305
- org,
10306
- username,
10307
- baseModelName,
10308
- dataset,
10309
- dateCreated,
10310
- fineTunedModel,
10311
- lastModified,
10312
- ordering,
10313
- page,
10314
- pageSize,
10315
- preprocessDataset,
10316
- provider,
10317
- search,
10318
- status
10319
- }) {
10320
- return request(OpenAPI, {
10321
- method: 'GET',
10322
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/',
10323
- path: {
10324
- 'org': org,
10325
- 'username': username
10326
- },
10327
- query: {
10328
- 'base_model_name': baseModelName,
10329
- 'dataset': dataset,
10330
- 'date_created': dateCreated,
10331
- 'fine_tuned_model': fineTunedModel,
10332
- 'last_modified': lastModified,
10333
- 'ordering': ordering,
10334
- 'page': page,
10335
- 'page_size': pageSize,
10336
- 'preprocess_dataset': preprocessDataset,
10337
- 'provider': provider,
10338
- 'search': search,
10339
- 'status': status
10340
- }
10341
- });
10342
- }
10343
- /**
10344
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10345
- * @returns TrainingCreate
10346
- * @throws ApiError
10347
- */
10348
- static aiFinetuningV1OrgUserTrainingsCreate({
10349
- org,
10350
- username,
10351
- requestBody
10352
- }) {
10353
- return request(OpenAPI, {
10354
- method: 'POST',
10355
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/',
10356
- path: {
10357
- 'org': org,
10358
- 'username': username
10359
- },
10360
- body: requestBody,
10361
- mediaType: 'application/json'
10362
- });
10363
- }
10364
- /**
10365
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10366
- * @returns Training
10367
- * @throws ApiError
10368
- */
10369
- static aiFinetuningV1OrgUserTrainingsRetrieve({
10370
- id,
10371
- org,
10372
- username
10373
- }) {
10374
- return request(OpenAPI, {
10375
- method: 'GET',
10376
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
10377
- path: {
10378
- 'id': id,
10379
- 'org': org,
10380
- 'username': username
10381
- }
10382
- });
10383
- }
10384
- /**
10385
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10386
- * @returns TrainingCreate
10387
- * @throws ApiError
10388
- */
10389
- static aiFinetuningV1OrgUserTrainingsUpdate({
10390
- id,
10391
- org,
10392
- username,
10393
- requestBody
10394
- }) {
10395
- return request(OpenAPI, {
10396
- method: 'PUT',
10397
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
10398
- path: {
10399
- 'id': id,
10400
- 'org': org,
10401
- 'username': username
10402
- },
10403
- body: requestBody,
10404
- mediaType: 'application/json'
10405
- });
10406
- }
10407
- /**
10408
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10409
- * @returns TrainingCreate
10410
- * @throws ApiError
10411
- */
10412
- static aiFinetuningV1OrgUserTrainingsPartialUpdate({
10413
- id,
10414
- org,
10415
- username,
10416
- requestBody
10417
- }) {
10418
- return request(OpenAPI, {
10419
- method: 'PATCH',
10420
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
10421
- path: {
10422
- 'id': id,
10423
- 'org': org,
10424
- 'username': username
10425
- },
10426
- body: requestBody,
10427
- mediaType: 'application/json'
10428
- });
10429
- }
10430
- /**
10431
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10432
- * @returns void
10433
- * @throws ApiError
10434
- */
10435
- static aiFinetuningV1OrgUserTrainingsDestroy({
10436
- id,
10437
- org,
10438
- username
10439
- }) {
10440
- return request(OpenAPI, {
10441
- method: 'DELETE',
10442
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
10443
- path: {
10444
- 'id': id,
10445
- 'org': org,
10446
- 'username': username
10447
- }
10448
- });
10449
- }
10450
- /**
10451
- * Retrieves a paginated list of completed fine-tuned models, excluding those without a fine-tuned model.
10452
- * Filtering and pagination is allowed.
10453
- *
10454
- * NB: This is only a helper endpoint. The same functionality can be achieved with the appropriate filters using the
10455
- * training list endpoint.
10456
- * Returns:
10457
- * Response: A paginated response containing the serialized fine-tuned models.
10458
- * @returns Training
10459
- * @throws ApiError
10460
- */
10461
- static aiFinetuningV1OrgUserTrainingsFinetunedModelsRetrieve({
10462
- org,
10463
- username
10464
- }) {
10465
- return request(OpenAPI, {
10466
- method: 'GET',
10467
- url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/finetuned-models/',
10468
- path: {
10469
- 'org': org,
10470
- 'username': username
10471
- }
10472
- });
10473
- }
10474
- }
10475
-
10476
- class AiIndexService {
10477
- /**
10478
- * Retrieve details of a specific document embedding.
10479
- *
10480
- * This endpoint returns detailed information about a specific
10481
- * document embedding identified by its ID.
10482
- *
10483
- * Args:
10484
- * request: The HTTP request.
10485
- * org: Organization key identifier.
10486
- * document_id: The ID of the document embedding to retrieve.
10487
- *
10488
- * Returns:
10489
- * Response: Detailed information about the document embedding.
10490
- *
10491
- * Raises:
10492
- * NotFound: If the specified document embedding does not exist.
10493
- * @returns RetrieverDocumentEmbedding
10494
- * @throws ApiError
10495
- */
10496
- static aiIndexOrgsUsersDocumentsRetrieve({
10497
- documentId,
10498
- org,
10499
- userId
10500
- }) {
10501
- return request(OpenAPI, {
10502
- method: 'GET',
10503
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
10504
- path: {
10505
- 'document_id': documentId,
10506
- 'org': org,
10507
- 'user_id': userId
10508
- },
10509
- errors: {
10510
- 404: `Document not found`
10511
- }
10512
- });
10513
- }
10514
- /**
10515
- * Update a specific document embedding.
10516
- *
10517
- * This endpoint allows updating various properties of a document embedding,
10518
- * including its name, type, pathway, and training status.
10519
- *
10520
- * Args:
10521
- * request: The HTTP request containing the updated document data.
10522
- * org: Organization key identifier.
10523
- * document_id: The ID of the document embedding to update.
10524
- *
10525
- * Returns:
10526
- * Response: The updated document embedding information.
10527
- *
10528
- * Raises:
10529
- * BadRequest: If the provided data is invalid.
10530
- * NotFound: If the specified document embedding does not exist.
10531
- * @returns RetrieverDocumentEmbedding
10532
- * @throws ApiError
10533
- */
10534
- static aiIndexOrgsUsersDocumentsUpdate({
10535
- documentId,
10536
- org,
10537
- userId,
10538
- formData
10539
- }) {
10540
- return request(OpenAPI, {
10541
- method: 'PUT',
10542
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
10543
- path: {
10544
- 'document_id': documentId,
10545
- 'org': org,
10546
- 'user_id': userId
10547
- },
10548
- formData: formData,
10549
- mediaType: 'multipart/form-data',
10550
- errors: {
10551
- 400: `Invalid request data`,
10552
- 404: `Document not found`
10553
- }
10554
- });
10555
- }
10556
- /**
10557
- * Delete a specific document embedding.
10558
- *
10559
- * This endpoint removes a document embedding from the system,
10560
- * including untraining it from any associated pathways.
10561
- *
10562
- * Args:
10563
- * request: The HTTP request.
10564
- * org: Organization key identifier.
10565
- * document_id: The ID of the document embedding to delete.
10566
- *
10567
- * Returns:
10568
- * Response: An empty response with a 204 status code if successful.
10569
- *
10570
- * Raises:
10571
- * NotFound: If the specified document embedding does not exist.
10572
- * @returns void
10573
- * @throws ApiError
10574
- */
10575
- static aiIndexOrgsUsersDocumentsDestroy({
10576
- documentId,
10577
- org,
10578
- userId
10579
- }) {
10580
- return request(OpenAPI, {
10581
- method: 'DELETE',
10582
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
10583
- path: {
10584
- 'document_id': documentId,
10585
- 'org': org,
10586
- 'user_id': userId
10587
- },
10588
- errors: {
10589
- 404: `Document not found`
10590
- }
10591
- });
10592
- }
10593
- /**
10594
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10595
- * @returns DocumentSettingsResponse
10596
- * @throws ApiError
10597
- */
10598
- static aiIndexOrgsUsersDocumentsSettingsRetrieve({
10599
- documentId,
10600
- org,
10601
- userId
10602
- }) {
10603
- return request(OpenAPI, {
10604
- method: 'GET',
10605
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/',
10606
- path: {
10607
- 'document_id': documentId,
10608
- 'org': org,
10609
- 'user_id': userId
10610
- }
10611
- });
10612
- }
10613
- /**
10614
- * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
10615
- * @returns DocumentSettingsResponse
10616
- * @throws ApiError
10617
- */
10618
- static aiIndexOrgsUsersDocumentsSettingsCreate({
10619
- documentId,
10620
- org,
10621
- userId,
10622
- requestBody
10623
- }) {
10624
- return request(OpenAPI, {
10625
- method: 'POST',
10626
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/',
10627
- path: {
10628
- 'document_id': documentId,
10629
- 'org': org,
10630
- 'user_id': userId
10631
- },
10632
- body: requestBody,
10633
- mediaType: 'application/json'
10634
- });
10635
- }
10636
- /**
10637
- * Train a graph-based document through a worker process.
10638
- *
10639
- * This endpoint queues graph-based documents for training through a
10640
- * specialized worker process that handles knowledge graph processing.
10641
- *
10642
- * Args:
10643
- * request: The HTTP request containing the document information.
10644
- * org: Organization key identifier.
10645
- *
10646
- * Returns:
10647
- * Response: A confirmation that the document was queued for training,
10648
- * including a task ID for tracking the progress.
10649
- *
10650
- * Raises:
10651
- * ValidationError: If the request data is invalid.
10652
- * BadRequest: If there was an error processing the document.
10653
- * @returns TrainDocumentViewResponse
10654
- * @throws ApiError
10655
- */
10656
- static aiIndexOrgsUsersDocumentsGraphTrainCreate({
10657
- org,
10658
- userId,
10659
- formData
10660
- }) {
10661
- return request(OpenAPI, {
10662
- method: 'POST',
10663
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/graph-train/',
10664
- path: {
10665
- 'org': org,
10666
- 'user_id': userId
10667
- },
10668
- formData: formData,
10669
- mediaType: 'multipart/form-data',
10670
- errors: {
10671
- 400: `Invalid request data or document processing error`
10672
- }
10673
- });
10674
- }
10675
- /**
10676
- * Description:
10677
- * Retrieves a list of document embeddings for a specific pathway with optional search and pagination.
10678
- *
10679
- * Methods:
10680
- * - GET: Retrieves document embeddings that match the specified search criteria and are paginated according to offset and limit.
10681
- *
10682
- * Parameters:
10683
- * - search (str): Search query to filter document names or URLs.
10684
- * - offset (int): Offset number for pagination.
10685
- * - limit (int): Limit number for pagination.
10686
- *
10687
- * Returns:
10688
- * - GET: A paginated list of document embeddings with their details.
10689
- * {
10690
- * "count": 10,
10691
- * "next": "http://api.example.com/retriever_documents/?offset=10&limit=2",
10692
- * "previous": "http://api.example.com/retriever_documents/?offset=0&limit=2",
10693
- * "results": [
10694
- * {
10695
- * "document_name": "Document2",
10696
- * "platform_key": "example_platform",
10697
- * "pathway": "example_pathway"
10698
- * }
10699
- * ]
10700
- * }
10701
- *
10702
- * Error Responses:
10703
- * - 400 Bad Request: Invalid query parameters.
10704
- * - 404 Not Found: No document embeddings found for the specified criteria.
10705
- * @returns PaginatedRetrieverDocumentEmbeddingList
10706
- * @throws ApiError
10707
- */
10708
- static aiIndexOrgsUsersDocumentsPathwaysList({
10709
- org,
10710
- pathway,
10711
- userId,
10712
- limit,
10713
- offset,
10714
- search
10715
- }) {
10716
- return request(OpenAPI, {
10717
- method: 'GET',
10718
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/pathways/{pathway}/',
10719
- path: {
10720
- 'org': org,
10721
- 'pathway': pathway,
10722
- 'user_id': userId
10723
- },
10724
- query: {
10725
- 'limit': limit,
10726
- 'offset': offset,
10727
- 'search': search
10728
- }
10729
- });
10730
- }
10731
- /**
10732
- * Retrieve resource documents similar to the given query.
10733
- *
10734
- * This endpoint performs a semantic search to find documents that are
10735
- * relevant to the provided query within the specified pathway.
10736
- *
10737
- * Args:
10738
- * request: The HTTP request containing the search query.
10739
- * org: Organization key identifier.
10740
- *
10741
- * Returns:
10742
- * Response: A list of documents relevant to the search query.
10743
- *
10744
- * Raises:
10745
- * ValidationError: If the request data is invalid.
10746
- * @returns RetrieverResponseSearch
10747
- * @throws ApiError
10748
- */
10749
- static aiIndexOrgsUsersDocumentsSearchCreate({
10750
- org,
10751
- userId,
10752
- requestBody
10753
- }) {
10754
- return request(OpenAPI, {
10755
- method: 'POST',
10756
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/search/',
10757
- path: {
10758
- 'org': org,
10759
- 'user_id': userId
10760
- },
10761
- body: requestBody,
10762
- mediaType: 'application/json',
10763
- errors: {
10764
- 400: `Invalid request data`
10765
- }
10766
- });
10767
- }
10768
- /**
10769
- * Retrieve document sources related to a given query.
10770
- *
10771
- * This endpoint performs a semantic search to find document sources
10772
- * that are relevant to the provided query within the specified pathway,
10773
- * and returns them along with confidence levels.
10774
- *
10775
- * Args:
10776
- * request: The HTTP request containing the search query.
10777
- * org: Organization key identifier.
10778
- *
10779
- * Returns:
10780
- * Response: A list of document sources with confidence levels.
10781
- *
10782
- * Raises:
10783
- * ValidationError: If the request data is invalid.
10784
- * @returns RetrieverRequestSearchDocument
10785
- * @throws ApiError
10786
- */
10787
- static aiIndexOrgsUsersDocumentsSourcesCreate({
10788
- org,
10789
- userId,
10790
- requestBody
10791
- }) {
10792
- return request(OpenAPI, {
10793
- method: 'POST',
10794
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/sources/',
10795
- path: {
10796
- 'org': org,
10797
- 'user_id': userId
10798
- },
10799
- body: requestBody,
10800
- mediaType: 'application/json',
10801
- errors: {
10802
- 400: `Invalid request data`
10803
- }
10804
- });
10805
- }
10806
- /**
10807
- * Check the status of a document training task.
10808
- *
10809
- * This endpoint retrieves the current status of an asynchronous
10810
- * document training task that was previously initiated.
10811
- *
10812
- * Args:
10813
- * request: The HTTP request.
10814
- * org: Organization key identifier.
10815
- * task_id: The ID of the training task to check.
10816
- *
10817
- * Returns:
10818
- * Response: The current status of the document training task,
10819
- * which can be "pending", "completed", or "failed".
10820
- * @returns CheckDocumentTrainingStatus
10821
- * @throws ApiError
10822
- */
10823
- static aiIndexOrgsUsersDocumentsTasksRetrieve({
10824
- org,
10825
- taskId,
10826
- userId
10827
- }) {
10828
- return request(OpenAPI, {
10829
- method: 'GET',
10830
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/tasks/{task_id}/',
10831
- path: {
10832
- 'org': org,
10833
- 'task_id': taskId,
10834
- 'user_id': userId
10835
- }
10836
- });
10837
- }
10838
- /**
10839
- * Train a document through a worker process.
10840
- *
10841
- * This endpoint queues larger documents for training through a worker
10842
- * process, which is more suitable for handling documents that would
10843
- * take too long to process directly.
10844
- *
10845
- * Args:
10846
- * request: The HTTP request containing the document information.
10847
- * org: Organization key identifier.
10848
- *
10849
- * Returns:
10850
- * Response: A confirmation that the document was queued for training,
10851
- * including a task ID for tracking the progress.
10852
- *
10853
- * Raises:
10854
- * ValidationError: If the request data is invalid.
10855
- * BadRequest: If there was an error processing the document.
10856
- * @returns TrainDocumentViewResponse
10857
- * @throws ApiError
10858
- */
10859
- static aiIndexOrgsUsersDocumentsTrainCreate({
10860
- org,
10861
- userId,
10862
- formData
10863
- }) {
10864
- return request(OpenAPI, {
10865
- method: 'POST',
10866
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/train/',
10867
- path: {
10868
- 'org': org,
10869
- 'user_id': userId
10870
- },
10871
- formData: formData,
10872
- mediaType: 'multipart/form-data',
10873
- errors: {
10874
- 400: `Invalid request data`
10875
- }
10876
- });
10877
- }
10878
- /**
10879
- * Train a document directly without using a worker.
10880
- *
10881
- * This endpoint is designed for training smaller documents directly
10882
- * without queuing them through a worker process. For larger documents,
10883
- * use the TrainDocumentView endpoint instead.
10884
- *
10885
- * Args:
10886
- * request: The HTTP request containing the document information.
10887
- * org: Organization key identifier.
10888
- *
10889
- * Returns:
10890
- * Response: A confirmation that the document was trained successfully.
10891
- *
10892
- * Raises:
10893
- * ValidationError: If the request data is invalid.
10894
- * BadRequest: If the document training failed.
10895
- * @returns RetreiverTrainViewResponse
10896
- * @throws ApiError
10897
- */
10898
- static aiIndexOrgsUsersDocumentsTrainRetrieverCreate({
10899
- org,
10900
- userId,
10901
- formData
10902
- }) {
10903
- return request(OpenAPI, {
10904
- method: 'POST',
10905
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/train/retriever/',
10906
- path: {
10907
- 'org': org,
10908
- 'user_id': userId
10909
- },
10910
- formData: formData,
10911
- mediaType: 'multipart/form-data',
10912
- errors: {
10913
- 400: `Invalid request data or training failed`
10914
- }
10915
- });
10916
- }
10917
- /**
10918
- * Description:
10919
- * Submit a document file in a chat session. Checks file type, size, and ensures the session exists, then processes the file.
10920
- * Process document for use in a specific chat session.
10921
- * which will be processed and made available for the AI to reference
10922
- * when responding to queries in that session.
10923
- *
10924
- * Methods:
10925
- * - POST: Submits a document or media file for training within a specified chat session.
10926
- *
10927
- * Parameters:
10928
- * - org (str):
10929
- * - session_id (str): UUID of the chat session for which the document is being submitted.
10930
- * - *args, **kwargs: Additional arguments.
10931
- * - file (file): Multipart file input.
10932
- *
10933
- * Returns:
10934
- * - POST: Returns a JSON message with the result of the upload process. Response code 200 on success.
10935
- * {
10936
- * "message": "File processed."
10937
- * }
10938
- *
10939
- * Error Responses:
10940
- * - 400 Bad Request:
10941
- * - "File field is required" if the 'file' parameter is missing.
10942
- * - "invalid file object" if the file object is not valid.
10943
- * - Specific error message if an exception occurs while saving to Redis.
10944
- * - 404 Not Found:
10945
- * - "Session not found" if the provided session_id does not match any existing session.
10946
- * - 413 Request Entity Too Large:
10947
- * - "file is too large" including specific limits for document and media files if the file exceeds size limits.
10948
- *
10949
- * Access Control:
10950
- * Requires authentication with a Bearer token in the Authorization header. The user associated with the session must exist and be authorized for the request.
10951
- * @returns TrainChatSessionDocumentView
10952
- * @throws ApiError
10953
- */
10954
- static aiIndexOrgsUsersDocumentsTrainSessionsCreate({
10955
- org,
10956
- sessionId,
10957
- userId,
10958
- formData
10959
- }) {
10960
- return request(OpenAPI, {
10961
- method: 'POST',
10962
- url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/train/sessions/{session_id}/',
10963
- path: {
10964
- 'org': org,
10965
- 'session_id': sessionId,
10966
- 'user_id': userId
10967
- },
10968
- formData: formData,
10969
- mediaType: 'multipart/form-data',
10970
- errors: {
10971
- 400: `Invalid file or processing error`,
10972
- 413: `File too large`
10973
- }
9577
+ formData: formData,
9578
+ mediaType: 'multipart/form-data',
9579
+ errors: {
9580
+ 400: `Invalid file or processing error`,
9581
+ 413: `File too large`
9582
+ }
10974
9583
  });
10975
9584
  }
10976
9585
  /**
@@ -16485,6 +15094,92 @@ class AiMentorService {
16485
15094
  }
16486
15095
  });
16487
15096
  }
15097
+ /**
15098
+ * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
15099
+ * @returns ShareableMentorLink
15100
+ * @throws ApiError
15101
+ */
15102
+ static aiMentorOrgsUsersMentorsSharableLinkRetrieve({
15103
+ mentor,
15104
+ org,
15105
+ userId
15106
+ }) {
15107
+ return request(OpenAPI, {
15108
+ method: 'GET',
15109
+ url: '/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/sharable-link',
15110
+ path: {
15111
+ 'mentor': mentor,
15112
+ 'org': org,
15113
+ 'user_id': userId
15114
+ }
15115
+ });
15116
+ }
15117
+ /**
15118
+ * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
15119
+ * @returns ShareableMentorLink
15120
+ * @throws ApiError
15121
+ */
15122
+ static aiMentorOrgsUsersMentorsSharableLinkCreate({
15123
+ mentor,
15124
+ org,
15125
+ userId,
15126
+ requestBody
15127
+ }) {
15128
+ return request(OpenAPI, {
15129
+ method: 'POST',
15130
+ url: '/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/sharable-link',
15131
+ path: {
15132
+ 'mentor': mentor,
15133
+ 'org': org,
15134
+ 'user_id': userId
15135
+ },
15136
+ body: requestBody,
15137
+ mediaType: 'application/json'
15138
+ });
15139
+ }
15140
+ /**
15141
+ * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
15142
+ * @returns ShareableMentorLink
15143
+ * @throws ApiError
15144
+ */
15145
+ static aiMentorOrgsUsersMentorsSharableLinkUpdate({
15146
+ mentor,
15147
+ org,
15148
+ userId,
15149
+ requestBody
15150
+ }) {
15151
+ return request(OpenAPI, {
15152
+ method: 'PUT',
15153
+ url: '/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/sharable-link',
15154
+ path: {
15155
+ 'mentor': mentor,
15156
+ 'org': org,
15157
+ 'user_id': userId
15158
+ },
15159
+ body: requestBody,
15160
+ mediaType: 'application/json'
15161
+ });
15162
+ }
15163
+ /**
15164
+ * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
15165
+ * @returns void
15166
+ * @throws ApiError
15167
+ */
15168
+ static aiMentorOrgsUsersMentorsSharableLinkDestroy({
15169
+ mentor,
15170
+ org,
15171
+ userId
15172
+ }) {
15173
+ return request(OpenAPI, {
15174
+ method: 'DELETE',
15175
+ url: '/api/ai-mentor/orgs/{org}/users/{user_id}/mentors/{mentor}/sharable-link',
15176
+ path: {
15177
+ 'mentor': mentor,
15178
+ 'org': org,
15179
+ 'user_id': userId
15180
+ }
15181
+ });
15182
+ }
16488
15183
  /**
16489
15184
  * Retrieve spaced repetition question statistics.
16490
15185
  *
@@ -34978,8 +33673,6 @@ class SkillsService {
34978
33673
 
34979
33674
  exports.AiAccountService = AiAccountService;
34980
33675
  exports.AiAnalyticsService = AiAnalyticsService;
34981
- exports.AiBotService = AiBotService;
34982
- exports.AiFinetuningService = AiFinetuningService;
34983
33676
  exports.AiIndexService = AiIndexService;
34984
33677
  exports.AiMarketingService = AiMarketingService;
34985
33678
  exports.AiMediaService = AiMediaService;