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