@iblai/iblai-api 3.38.2-core → 3.38.3-ai-plus

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 (616) hide show
  1. package/dist/index.cjs.js +15699 -62
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +15692 -63
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +15699 -62
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/index.d.ts +301 -1
  8. package/dist/types/models/AIGeneratedImage.d.ts +13 -0
  9. package/dist/types/models/APITokenCost.d.ts +14 -0
  10. package/dist/types/models/AccessEnum.d.ts +8 -0
  11. package/dist/types/models/AlignMentorBubbleEnum.d.ts +8 -0
  12. package/dist/types/models/AnalyticsOverview.d.ts +7 -0
  13. package/dist/types/models/Answer.d.ts +11 -0
  14. package/dist/types/models/AssumedKnowledge.d.ts +4 -0
  15. package/dist/types/models/AssumedKnowledgeLevel.d.ts +4 -0
  16. package/dist/types/models/AudioToTextRequest.d.ts +3 -0
  17. package/dist/types/models/AudioToTextResponse.d.ts +3 -0
  18. package/dist/types/models/Bot.d.ts +15 -0
  19. package/dist/types/models/BotCommand.d.ts +6 -0
  20. package/dist/types/models/BotCreate.d.ts +12 -0
  21. package/dist/types/models/CallAuthenticationRequest.d.ts +13 -0
  22. package/dist/types/models/CallAuthenticationResponse.d.ts +21 -0
  23. package/dist/types/models/ChatHistory.d.ts +8 -0
  24. package/dist/types/models/ChatHistoryFilterData.d.ts +9 -0
  25. package/dist/types/models/ChatHistoryFilterUser.d.ts +5 -0
  26. package/dist/types/models/ChatHistoryItem.d.ts +5 -0
  27. package/dist/types/models/ChatHistorySessionId.d.ts +3 -0
  28. package/dist/types/models/ChatSessionRequest.d.ts +10 -0
  29. package/dist/types/models/ChatSessionResponse.d.ts +5 -0
  30. package/dist/types/models/CheckDocumentTrainingStatus.d.ts +10 -0
  31. package/dist/types/models/ComponentBlock.d.ts +9 -0
  32. package/dist/types/models/ComponentBlockTypeEnum.d.ts +8 -0
  33. package/dist/types/models/ConversationMessage.d.ts +11 -0
  34. package/dist/types/models/ConversationRating.d.ts +6 -0
  35. package/dist/types/models/ConversationSummary.d.ts +5 -0
  36. package/dist/types/models/ConversationVolume.d.ts +4 -0
  37. package/dist/types/models/Conversations.d.ts +28 -0
  38. package/dist/types/models/Cost.d.ts +3 -0
  39. package/dist/types/models/CostPerTenant.d.ts +6 -0
  40. package/dist/types/models/CourseCreationTask.d.ts +31 -0
  41. package/dist/types/models/CourseCreationTaskFile.d.ts +7 -0
  42. package/dist/types/models/CourseCreationTaskStatusEnum.d.ts +16 -0
  43. package/dist/types/models/CredentialRequest.d.ts +14 -0
  44. package/dist/types/models/CrontabSchedule.d.ts +22 -0
  45. package/dist/types/models/CustomInstructionResponse.d.ts +13 -0
  46. package/dist/types/models/DataSet.d.ts +21 -0
  47. package/dist/types/models/DataSetCreate.d.ts +12 -0
  48. package/dist/types/models/DataSetStatusEnum.d.ts +12 -0
  49. package/dist/types/models/DateRange.d.ts +4 -0
  50. package/dist/types/models/DiscordConfig.d.ts +7 -0
  51. package/dist/types/models/DiscordUserConfig.d.ts +10 -0
  52. package/dist/types/models/DiscordWebhook.d.ts +6 -0
  53. package/dist/types/models/EdxCourse.d.ts +11 -0
  54. package/dist/types/models/ElevenlabsCustomVoice.d.ts +4 -0
  55. package/dist/types/models/ElevenlabsCustomVoiceResponse.d.ts +8 -0
  56. package/dist/types/models/EmailPromptDetail.d.ts +13 -0
  57. package/dist/types/models/EmailPromptList.d.ts +11 -0
  58. package/dist/types/models/EmailPromptSummary.d.ts +5 -0
  59. package/dist/types/models/FreeUsageCount.d.ts +3 -0
  60. package/dist/types/models/FullCourse.d.ts +13 -0
  61. package/dist/types/models/GreetingMethodEnum.d.ts +8 -0
  62. package/dist/types/models/GuidedPromptsResponse.d.ts +3 -0
  63. package/dist/types/models/HeygenMarketingVideoDetail.d.ts +8 -0
  64. package/dist/types/models/HeygenMarketingVideoList.d.ts +6 -0
  65. package/dist/types/models/IBLAIPlatformMeta.d.ts +3 -0
  66. package/dist/types/models/IBLAIPlatformMetaRequest.d.ts +6 -0
  67. package/dist/types/models/IBLAIPlatformMetaUpdateRequest.d.ts +10 -0
  68. package/dist/types/models/InputQuestion.d.ts +6 -0
  69. package/dist/types/models/IntegrationCredential.d.ts +8 -0
  70. package/dist/types/models/IntialQuestionAnswer.d.ts +3 -0
  71. package/dist/types/models/JobRun.d.ts +11 -0
  72. package/dist/types/models/KindEnum.d.ts +10 -0
  73. package/dist/types/models/LLMCredentialRequest.d.ts +14 -0
  74. package/dist/types/models/LLMCredentialResponse.d.ts +8 -0
  75. package/dist/types/models/LLMModelForTenant.d.ts +6 -0
  76. package/dist/types/models/LLMQuestion.d.ts +15 -0
  77. package/dist/types/models/LLMResponse.d.ts +14 -0
  78. package/dist/types/models/LLMTracesListResponse.d.ts +5 -0
  79. package/dist/types/models/LanguagesView.d.ts +5 -0
  80. package/dist/types/models/LinkCourseRequest.d.ts +3 -0
  81. package/dist/types/models/LinkCourseResponse.d.ts +5 -0
  82. package/dist/types/models/MCPServer.d.ts +21 -0
  83. package/dist/types/models/MemoryComponentData.d.ts +5 -0
  84. package/dist/types/models/MemoryComponentMemory.d.ts +4 -0
  85. package/dist/types/models/MemoryComponentMemoryDetail.d.ts +8 -0
  86. package/dist/types/models/MemoryComponentResponse.d.ts +5 -0
  87. package/dist/types/models/MemoryProgress.d.ts +8 -0
  88. package/dist/types/models/MemoryStatusRequestView.d.ts +6 -0
  89. package/dist/types/models/MemoryStatusView.d.ts +6 -0
  90. package/dist/types/models/Mentor.d.ts +80 -0
  91. package/dist/types/models/MentorAudience.d.ts +5 -0
  92. package/dist/types/models/MentorCategory.d.ts +9 -0
  93. package/dist/types/models/MentorCategoryCreate.d.ts +11 -0
  94. package/dist/types/models/MentorCategoryGroup.d.ts +11 -0
  95. package/dist/types/models/MentorCategoryGroupCreate.d.ts +11 -0
  96. package/dist/types/models/MentorCreate.d.ts +79 -0
  97. package/dist/types/models/MentorCustomVoice.d.ts +4 -0
  98. package/dist/types/models/MentorCustomVoiceResponse.d.ts +4 -0
  99. package/dist/types/models/MentorData.d.ts +7 -0
  100. package/dist/types/models/MentorDetailAnalytics.d.ts +6 -0
  101. package/dist/types/models/MentorEval.d.ts +11 -0
  102. package/dist/types/models/MentorEvalQuestion.d.ts +5 -0
  103. package/dist/types/models/MentorEvalQuestionRequest.d.ts +4 -0
  104. package/dist/types/models/MentorEvalReport.d.ts +10 -0
  105. package/dist/types/models/MentorEvalRequest.d.ts +8 -0
  106. package/dist/types/models/MentorFork.d.ts +5 -0
  107. package/dist/types/models/MentorFromTemplateRequest.d.ts +4 -0
  108. package/dist/types/models/MentorFromTemplateWithSettingRequest.d.ts +43 -0
  109. package/dist/types/models/MentorMemorySettingsRequest.d.ts +6 -0
  110. package/dist/types/models/MentorMemorySettingsResponse.d.ts +6 -0
  111. package/dist/types/models/MentorMetadata.d.ts +5 -0
  112. package/dist/types/models/MentorScenario.d.ts +6 -0
  113. package/dist/types/models/MentorScenarioPrompt.d.ts +5 -0
  114. package/dist/types/models/MentorSession.d.ts +4 -0
  115. package/dist/types/models/MentorSettings.d.ts +54 -0
  116. package/dist/types/models/MentorSettingsPublic.d.ts +43 -0
  117. package/dist/types/models/MentorSettingsRequest.d.ts +58 -0
  118. package/dist/types/models/MentorVisibilityEnum.d.ts +10 -0
  119. package/dist/types/models/MentorWizard.d.ts +4 -0
  120. package/dist/types/models/MessageStatistics.d.ts +5 -0
  121. package/dist/types/models/MessageView.d.ts +10 -0
  122. package/dist/types/models/MessageViewRequest.d.ts +7 -0
  123. package/dist/types/models/MessageViewUpdatResponse.d.ts +3 -0
  124. package/dist/types/models/Metadata.d.ts +5 -0
  125. package/dist/types/models/MetricChange.d.ts +4 -0
  126. package/dist/types/models/ModelCost.d.ts +4 -0
  127. package/dist/types/models/ModerationLog.d.ts +11 -0
  128. package/dist/types/models/NoChatMessagesFound.d.ts +3 -0
  129. package/dist/types/models/NotificationSource.d.ts +2 -2
  130. package/dist/types/models/{TypeEnum.d.ts → NotificationSourceTypeEnum.d.ts} +1 -1
  131. package/dist/types/models/NullEnum.d.ts +1 -0
  132. package/dist/types/models/PageContent.d.ts +6 -0
  133. package/dist/types/models/PaginatedAIGeneratedImageList.d.ts +7 -0
  134. package/dist/types/models/PaginatedConversationsList.d.ts +7 -0
  135. package/dist/types/models/PaginatedCourseCreationTaskFileList.d.ts +7 -0
  136. package/dist/types/models/PaginatedCourseCreationTaskList.d.ts +7 -0
  137. package/dist/types/models/PaginatedDataSetList.d.ts +7 -0
  138. package/dist/types/models/PaginatedEdxCourseList.d.ts +7 -0
  139. package/dist/types/models/PaginatedEmailPromptListList.d.ts +7 -0
  140. package/dist/types/models/PaginatedHeygenMarketingVideoListList.d.ts +7 -0
  141. package/dist/types/models/PaginatedJobRunList.d.ts +7 -0
  142. package/dist/types/models/PaginatedMCPServerList.d.ts +7 -0
  143. package/dist/types/models/PaginatedMentorList.d.ts +7 -0
  144. package/dist/types/models/PaginatedModerationLogList.d.ts +7 -0
  145. package/dist/types/models/PaginatedPeriodicAgentList.d.ts +7 -0
  146. package/dist/types/models/PaginatedPeriodicAgentLogList.d.ts +7 -0
  147. package/dist/types/models/PaginatedPlayWrightScriptList.d.ts +7 -0
  148. package/dist/types/models/PaginatedSectionList.d.ts +7 -0
  149. package/dist/types/models/PaginatedSubSectionList.d.ts +7 -0
  150. package/dist/types/models/PaginatedTopicStatisticsResponse.d.ts +7 -0
  151. package/dist/types/models/PaginatedTrainingList.d.ts +7 -0
  152. package/dist/types/models/PaginatedUnitList.d.ts +7 -0
  153. package/dist/types/models/PaginatedUserEdxMemoryList.d.ts +7 -0
  154. package/dist/types/models/PaginatedVoiceList.d.ts +7 -0
  155. package/dist/types/models/PatchedBotCommand.d.ts +6 -0
  156. package/dist/types/models/PatchedBotCreate.d.ts +12 -0
  157. package/dist/types/models/PatchedConversations.d.ts +28 -0
  158. package/dist/types/models/PatchedCourseCreationTaskFile.d.ts +7 -0
  159. package/dist/types/models/PatchedCredentialRequest.d.ts +14 -0
  160. package/dist/types/models/PatchedDataSet.d.ts +21 -0
  161. package/dist/types/models/PatchedDiscordConfig.d.ts +7 -0
  162. package/dist/types/models/PatchedDiscordUserConfig.d.ts +10 -0
  163. package/dist/types/models/PatchedLLMCredentialRequest.d.ts +14 -0
  164. package/dist/types/models/PatchedMCPServer.d.ts +21 -0
  165. package/dist/types/models/PatchedMentorCategoryGroupCreate.d.ts +11 -0
  166. package/dist/types/models/PatchedMentorCreate.d.ts +79 -0
  167. package/dist/types/models/PatchedPeriodicAgentCreate.d.ts +41 -0
  168. package/dist/types/models/PatchedPlayWrightScript.d.ts +12 -0
  169. package/dist/types/models/PatchedPrompt.d.ts +22 -0
  170. package/dist/types/models/PatchedSection.d.ts +9 -0
  171. package/dist/types/models/PatchedSlackConfig.d.ts +8 -0
  172. package/dist/types/models/PatchedSlackUserConfig.d.ts +17 -0
  173. package/dist/types/models/PatchedSubSection.d.ts +9 -0
  174. package/dist/types/models/PatchedTeamsConfig.d.ts +7 -0
  175. package/dist/types/models/PatchedTrainingCreate.d.ts +31 -0
  176. package/dist/types/models/PatchedUnit.d.ts +11 -0
  177. package/dist/types/models/PatchedWebexConfig.d.ts +10 -0
  178. package/dist/types/models/PatchedWhatsappConfig.d.ts +11 -0
  179. package/dist/types/models/PatchedWhatsappUserConfig.d.ts +10 -0
  180. package/dist/types/models/PeriodicAgent.d.ts +42 -0
  181. package/dist/types/models/PeriodicAgentCreate.d.ts +41 -0
  182. package/dist/types/models/PeriodicAgentLog.d.ts +11 -0
  183. package/dist/types/models/PeriodicAgentLogStatusEnum.d.ts +10 -0
  184. package/dist/types/models/PeriodicTask.d.ts +21 -0
  185. package/dist/types/models/PieChartData.d.ts +5 -0
  186. package/dist/types/models/PieChartSegment.d.ts +4 -0
  187. package/dist/types/models/PinnedMessageCreate.d.ts +9 -0
  188. package/dist/types/models/PinnedMessageGet.d.ts +7 -0
  189. package/dist/types/models/PinnedMessageRequest.d.ts +6 -0
  190. package/dist/types/models/PlayWrightScript.d.ts +12 -0
  191. package/dist/types/models/PredictiveAnalyticsRequest.d.ts +4 -0
  192. package/dist/types/models/PredictiveAnalyticsResponse.d.ts +4 -0
  193. package/dist/types/models/PreviousAgentStatusEnum.d.ts +12 -0
  194. package/dist/types/models/Prompt.d.ts +22 -0
  195. package/dist/types/models/PromptCategory.d.ts +7 -0
  196. package/dist/types/models/PromptVisibilityEnum.d.ts +10 -0
  197. package/dist/types/models/Provider05cEnum.d.ts +14 -0
  198. package/dist/types/models/Provider63aEnum.d.ts +6 -0
  199. package/dist/types/models/QuestionCardTag.d.ts +8 -0
  200. package/dist/types/models/QuestionRequest.d.ts +15 -0
  201. package/dist/types/models/QuestionResponse.d.ts +10 -0
  202. package/dist/types/models/RatingEnum.d.ts +8 -0
  203. package/dist/types/models/RatingRecord.d.ts +4 -0
  204. package/dist/types/models/RecentlyAccessedMentor.d.ts +8 -0
  205. package/dist/types/models/RecommendCourseBlock.d.ts +3 -0
  206. package/dist/types/models/RecommendCourseResponse.d.ts +3 -0
  207. package/dist/types/models/RelatedText.d.ts +3 -0
  208. package/dist/types/models/RequestDataVariable.d.ts +14 -0
  209. package/dist/types/models/ResourceScrappedData.d.ts +13 -0
  210. package/dist/types/models/ResourceScrappedDataStatusEnum.d.ts +12 -0
  211. package/dist/types/models/ResponseDataVariable.d.ts +14 -0
  212. package/dist/types/models/RetreiverTrainViewRequest.d.ts +10 -0
  213. package/dist/types/models/RetreiverTrainViewResponse.d.ts +6 -0
  214. package/dist/types/models/RetrieveTask.d.ts +3 -0
  215. package/dist/types/models/RetrieverDocumentEmbedding.d.ts +17 -0
  216. package/dist/types/models/RetrieverDocumentEmbeddingRequest.d.ts +30 -0
  217. package/dist/types/models/RetrieverRequestSearch.d.ts +10 -0
  218. package/dist/types/models/RetrieverRequestSearchDocument.d.ts +10 -0
  219. package/dist/types/models/RetrieverResponseSearch.d.ts +7 -0
  220. package/dist/types/models/ReuestDataVariableList.d.ts +4 -0
  221. package/dist/types/models/RunMentorEval.d.ts +3 -0
  222. package/dist/types/models/ScanWebhookRequest.d.ts +6 -0
  223. package/dist/types/models/ScanWebhookResponse.d.ts +3 -0
  224. package/dist/types/models/Section.d.ts +9 -0
  225. package/dist/types/models/SectionWithChildren.d.ts +11 -0
  226. package/dist/types/models/SeedMentorsView.d.ts +3 -0
  227. package/dist/types/models/SentimentSummary.d.ts +4 -0
  228. package/dist/types/models/SessionBrowserScreenshot.d.ts +8 -0
  229. package/dist/types/models/SessionDetail.d.ts +6 -0
  230. package/dist/types/models/SessionMemoryStorage.d.ts +6 -0
  231. package/dist/types/models/ShellLogs.d.ts +3 -0
  232. package/dist/types/models/SlackConfig.d.ts +8 -0
  233. package/dist/types/models/SlackUserConfig.d.ts +17 -0
  234. package/dist/types/models/SlackWebhook.d.ts +6 -0
  235. package/dist/types/models/SpacedRepetitionLearningPath.d.ts +3 -0
  236. package/dist/types/models/SpacedRepetitionQuestionStats.d.ts +5 -0
  237. package/dist/types/models/StarMentor.d.ts +7 -0
  238. package/dist/types/models/Status6eeEnum.d.ts +12 -0
  239. package/dist/types/models/Step.d.ts +9 -0
  240. package/dist/types/models/StepStatusEnum.d.ts +10 -0
  241. package/dist/types/models/StudentChatMessage.d.ts +4 -0
  242. package/dist/types/models/StylesView.d.ts +4 -0
  243. package/dist/types/models/SubSection.d.ts +9 -0
  244. package/dist/types/models/SubSectionWithChildren.d.ts +11 -0
  245. package/dist/types/models/TagsView.d.ts +5 -0
  246. package/dist/types/models/TargetSystemEnum.d.ts +8 -0
  247. package/dist/types/models/TaskView.d.ts +3 -0
  248. package/dist/types/models/TeamsConfig.d.ts +7 -0
  249. package/dist/types/models/TeamsWebhook.d.ts +17 -0
  250. package/dist/types/models/TemplateMentor.d.ts +9 -0
  251. package/dist/types/models/TenantMentorTraces.d.ts +6 -0
  252. package/dist/types/models/ThemeEnum.d.ts +8 -0
  253. package/dist/types/models/TonesView.d.ts +4 -0
  254. package/dist/types/models/ToolResponse.d.ts +9 -0
  255. package/dist/types/models/TopicModel.d.ts +3 -0
  256. package/dist/types/models/TopicRecord.d.ts +4 -0
  257. package/dist/types/models/TopicStatistics.d.ts +7 -0
  258. package/dist/types/models/TopicStatisticsResponse.d.ts +6 -0
  259. package/dist/types/models/TopicSummaryView.d.ts +4 -0
  260. package/dist/types/models/TrainChatSessionDocumentView.d.ts +6 -0
  261. package/dist/types/models/TrainChatSessionDocumentViewRequest.d.ts +6 -0
  262. package/dist/types/models/TrainDocumentViewRequest.d.ts +42 -0
  263. package/dist/types/models/TrainDocumentViewResponse.d.ts +14 -0
  264. package/dist/types/models/Training.d.ts +41 -0
  265. package/dist/types/models/TrainingCreate.d.ts +31 -0
  266. package/dist/types/models/TrainingStatusEnum.d.ts +12 -0
  267. package/dist/types/models/TransportEnum.d.ts +8 -0
  268. package/dist/types/models/TrendEntry.d.ts +4 -0
  269. package/dist/types/models/TriggerRequest.d.ts +5 -0
  270. package/dist/types/models/TriggerResponse.d.ts +6 -0
  271. package/dist/types/models/TypeC42Enum.d.ts +8 -0
  272. package/dist/types/models/Unit.d.ts +11 -0
  273. package/dist/types/models/UnitWithChildren.d.ts +13 -0
  274. package/dist/types/models/UseMainCreds.d.ts +3 -0
  275. package/dist/types/models/UserAllChatMemoryView.d.ts +7 -0
  276. package/dist/types/models/UserCatalogItemMemoryView.d.ts +14 -0
  277. package/dist/types/models/UserChatByPeriod.d.ts +4 -0
  278. package/dist/types/models/UserChatFeedback.d.ts +14 -0
  279. package/dist/types/models/UserChatFeedbackCount.d.ts +4 -0
  280. package/dist/types/models/UserChatMemoryStatusRequestView.d.ts +6 -0
  281. package/dist/types/models/UserChatMemoryStatusView.d.ts +6 -0
  282. package/dist/types/models/UserChatMemoryUpdateView.d.ts +10 -0
  283. package/dist/types/models/UserCountRecord.d.ts +4 -0
  284. package/dist/types/models/UserEdxMemory.d.ts +15 -0
  285. package/dist/types/models/UserMemoryContextRequest.d.ts +13 -0
  286. package/dist/types/models/UserMemoryContextResponse.d.ts +12 -0
  287. package/dist/types/models/UserMetric.d.ts +4 -0
  288. package/dist/types/models/UserMetricsResponse.d.ts +7 -0
  289. package/dist/types/models/UserSentimentCountView.d.ts +4 -0
  290. package/dist/types/models/UserTrendByPeriod.d.ts +5 -0
  291. package/dist/types/models/VectorResult.d.ts +8 -0
  292. package/dist/types/models/Voice.d.ts +9 -0
  293. package/dist/types/models/VoiceProviderEnum.d.ts +10 -0
  294. package/dist/types/models/WebResource.d.ts +9 -0
  295. package/dist/types/models/WebResourceCard.d.ts +7 -0
  296. package/dist/types/models/WebResourcesQuery.d.ts +3 -0
  297. package/dist/types/models/WebexConfig.d.ts +10 -0
  298. package/dist/types/models/WebexWebhook.d.ts +4 -0
  299. package/dist/types/models/WhatAppWebHook.d.ts +3 -0
  300. package/dist/types/models/WhatsappConfig.d.ts +11 -0
  301. package/dist/types/models/WhatsappUserConfig.d.ts +10 -0
  302. package/dist/types/services/AiAccountService.d.ts +294 -0
  303. package/dist/types/services/AiAnalyticsService.d.ts +2801 -0
  304. package/dist/types/services/AiBotService.d.ts +486 -0
  305. package/dist/types/services/AiFinetuningService.d.ts +162 -0
  306. package/dist/types/services/AiIndexService.d.ts +344 -0
  307. package/dist/types/services/AiMarketingService.d.ts +34 -0
  308. package/dist/types/services/AiMentorService.d.ts +4194 -0
  309. package/dist/types/services/AiPromptService.d.ts +879 -0
  310. package/dist/types/services/SearchService.d.ts +299 -0
  311. package/package.json +1 -1
  312. package/src/core/OpenAPI.ts +1 -1
  313. package/src/index.ts +301 -1
  314. package/src/models/AIGeneratedImage.ts +18 -0
  315. package/src/models/APITokenCost.ts +19 -0
  316. package/src/models/AccessEnum.ts +12 -0
  317. package/src/models/AlignMentorBubbleEnum.ts +12 -0
  318. package/src/models/AnalyticsOverview.ts +12 -0
  319. package/src/models/Answer.ts +16 -0
  320. package/src/models/AssumedKnowledge.ts +9 -0
  321. package/src/models/AssumedKnowledgeLevel.ts +9 -0
  322. package/src/models/AudioToTextRequest.ts +8 -0
  323. package/src/models/AudioToTextResponse.ts +8 -0
  324. package/src/models/Bot.ts +20 -0
  325. package/src/models/BotCommand.ts +11 -0
  326. package/src/models/BotCreate.ts +17 -0
  327. package/src/models/CallAuthenticationRequest.ts +18 -0
  328. package/src/models/CallAuthenticationResponse.ts +26 -0
  329. package/src/models/ChatHistory.ts +13 -0
  330. package/src/models/ChatHistoryFilterData.ts +14 -0
  331. package/src/models/ChatHistoryFilterUser.ts +10 -0
  332. package/src/models/ChatHistoryItem.ts +10 -0
  333. package/src/models/ChatHistorySessionId.ts +8 -0
  334. package/src/models/ChatSessionRequest.ts +15 -0
  335. package/src/models/ChatSessionResponse.ts +10 -0
  336. package/src/models/CheckDocumentTrainingStatus.ts +15 -0
  337. package/src/models/ComponentBlock.ts +14 -0
  338. package/src/models/ComponentBlockTypeEnum.ts +12 -0
  339. package/src/models/ConversationMessage.ts +16 -0
  340. package/src/models/ConversationRating.ts +11 -0
  341. package/src/models/ConversationSummary.ts +10 -0
  342. package/src/models/ConversationVolume.ts +9 -0
  343. package/src/models/Conversations.ts +33 -0
  344. package/src/models/Cost.ts +8 -0
  345. package/src/models/CostPerTenant.ts +11 -0
  346. package/src/models/CourseCreationTask.ts +36 -0
  347. package/src/models/CourseCreationTaskFile.ts +12 -0
  348. package/src/models/CourseCreationTaskStatusEnum.ts +20 -0
  349. package/src/models/CredentialRequest.ts +19 -0
  350. package/src/models/CrontabSchedule.ts +27 -0
  351. package/src/models/CustomInstructionResponse.ts +18 -0
  352. package/src/models/DataSet.ts +26 -0
  353. package/src/models/DataSetCreate.ts +17 -0
  354. package/src/models/DataSetStatusEnum.ts +16 -0
  355. package/src/models/DateRange.ts +9 -0
  356. package/src/models/DiscordConfig.ts +12 -0
  357. package/src/models/DiscordUserConfig.ts +15 -0
  358. package/src/models/DiscordWebhook.ts +11 -0
  359. package/src/models/EdxCourse.ts +16 -0
  360. package/src/models/ElevenlabsCustomVoice.ts +9 -0
  361. package/src/models/ElevenlabsCustomVoiceResponse.ts +13 -0
  362. package/src/models/EmailPromptDetail.ts +18 -0
  363. package/src/models/EmailPromptList.ts +16 -0
  364. package/src/models/EmailPromptSummary.ts +10 -0
  365. package/src/models/FreeUsageCount.ts +8 -0
  366. package/src/models/FullCourse.ts +18 -0
  367. package/src/models/GreetingMethodEnum.ts +12 -0
  368. package/src/models/GuidedPromptsResponse.ts +8 -0
  369. package/src/models/HeygenMarketingVideoDetail.ts +13 -0
  370. package/src/models/HeygenMarketingVideoList.ts +11 -0
  371. package/src/models/IBLAIPlatformMeta.ts +8 -0
  372. package/src/models/IBLAIPlatformMetaRequest.ts +11 -0
  373. package/src/models/IBLAIPlatformMetaUpdateRequest.ts +15 -0
  374. package/src/models/InputQuestion.ts +11 -0
  375. package/src/models/IntegrationCredential.ts +13 -0
  376. package/src/models/IntialQuestionAnswer.ts +8 -0
  377. package/src/models/JobRun.ts +16 -0
  378. package/src/models/KindEnum.ts +14 -0
  379. package/src/models/LLMCredentialRequest.ts +19 -0
  380. package/src/models/LLMCredentialResponse.ts +13 -0
  381. package/src/models/LLMModelForTenant.ts +11 -0
  382. package/src/models/LLMQuestion.ts +20 -0
  383. package/src/models/LLMResponse.ts +19 -0
  384. package/src/models/LLMTracesListResponse.ts +10 -0
  385. package/src/models/LanguagesView.ts +10 -0
  386. package/src/models/LinkCourseRequest.ts +8 -0
  387. package/src/models/LinkCourseResponse.ts +10 -0
  388. package/src/models/MCPServer.ts +26 -0
  389. package/src/models/MemoryComponentData.ts +10 -0
  390. package/src/models/MemoryComponentMemory.ts +9 -0
  391. package/src/models/MemoryComponentMemoryDetail.ts +13 -0
  392. package/src/models/MemoryComponentResponse.ts +10 -0
  393. package/src/models/MemoryProgress.ts +13 -0
  394. package/src/models/MemoryStatusRequestView.ts +11 -0
  395. package/src/models/MemoryStatusView.ts +11 -0
  396. package/src/models/Mentor.ts +85 -0
  397. package/src/models/MentorAudience.ts +10 -0
  398. package/src/models/MentorCategory.ts +14 -0
  399. package/src/models/MentorCategoryCreate.ts +16 -0
  400. package/src/models/MentorCategoryGroup.ts +16 -0
  401. package/src/models/MentorCategoryGroupCreate.ts +16 -0
  402. package/src/models/MentorCreate.ts +84 -0
  403. package/src/models/MentorCustomVoice.ts +9 -0
  404. package/src/models/MentorCustomVoiceResponse.ts +9 -0
  405. package/src/models/MentorData.ts +12 -0
  406. package/src/models/MentorDetailAnalytics.ts +11 -0
  407. package/src/models/MentorEval.ts +16 -0
  408. package/src/models/MentorEvalQuestion.ts +10 -0
  409. package/src/models/MentorEvalQuestionRequest.ts +9 -0
  410. package/src/models/MentorEvalReport.ts +15 -0
  411. package/src/models/MentorEvalRequest.ts +13 -0
  412. package/src/models/MentorFork.ts +10 -0
  413. package/src/models/MentorFromTemplateRequest.ts +9 -0
  414. package/src/models/MentorFromTemplateWithSettingRequest.ts +48 -0
  415. package/src/models/MentorMemorySettingsRequest.ts +11 -0
  416. package/src/models/MentorMemorySettingsResponse.ts +11 -0
  417. package/src/models/MentorMetadata.ts +10 -0
  418. package/src/models/MentorScenario.ts +11 -0
  419. package/src/models/MentorScenarioPrompt.ts +10 -0
  420. package/src/models/MentorSession.ts +9 -0
  421. package/src/models/MentorSettings.ts +59 -0
  422. package/src/models/MentorSettingsPublic.ts +48 -0
  423. package/src/models/MentorSettingsRequest.ts +63 -0
  424. package/src/models/MentorVisibilityEnum.ts +14 -0
  425. package/src/models/MentorWizard.ts +9 -0
  426. package/src/models/MessageStatistics.ts +10 -0
  427. package/src/models/MessageView.ts +15 -0
  428. package/src/models/MessageViewRequest.ts +12 -0
  429. package/src/models/MessageViewUpdatResponse.ts +8 -0
  430. package/src/models/Metadata.ts +10 -0
  431. package/src/models/MetricChange.ts +9 -0
  432. package/src/models/ModelCost.ts +9 -0
  433. package/src/models/ModerationLog.ts +16 -0
  434. package/src/models/NoChatMessagesFound.ts +8 -0
  435. package/src/models/NotificationSource.ts +2 -2
  436. package/src/models/{TypeEnum.ts → NotificationSourceTypeEnum.ts} +1 -1
  437. package/src/models/NullEnum.ts +7 -0
  438. package/src/models/PageContent.ts +11 -0
  439. package/src/models/PaginatedAIGeneratedImageList.ts +12 -0
  440. package/src/models/PaginatedConversationsList.ts +12 -0
  441. package/src/models/PaginatedCourseCreationTaskFileList.ts +12 -0
  442. package/src/models/PaginatedCourseCreationTaskList.ts +12 -0
  443. package/src/models/PaginatedDataSetList.ts +12 -0
  444. package/src/models/PaginatedEdxCourseList.ts +12 -0
  445. package/src/models/PaginatedEmailPromptListList.ts +12 -0
  446. package/src/models/PaginatedHeygenMarketingVideoListList.ts +12 -0
  447. package/src/models/PaginatedJobRunList.ts +12 -0
  448. package/src/models/PaginatedMCPServerList.ts +12 -0
  449. package/src/models/PaginatedMentorList.ts +12 -0
  450. package/src/models/PaginatedModerationLogList.ts +12 -0
  451. package/src/models/PaginatedPeriodicAgentList.ts +12 -0
  452. package/src/models/PaginatedPeriodicAgentLogList.ts +12 -0
  453. package/src/models/PaginatedPlayWrightScriptList.ts +12 -0
  454. package/src/models/PaginatedSectionList.ts +12 -0
  455. package/src/models/PaginatedSubSectionList.ts +12 -0
  456. package/src/models/PaginatedTopicStatisticsResponse.ts +12 -0
  457. package/src/models/PaginatedTrainingList.ts +12 -0
  458. package/src/models/PaginatedUnitList.ts +12 -0
  459. package/src/models/PaginatedUserEdxMemoryList.ts +12 -0
  460. package/src/models/PaginatedVoiceList.ts +12 -0
  461. package/src/models/PatchedBotCommand.ts +11 -0
  462. package/src/models/PatchedBotCreate.ts +17 -0
  463. package/src/models/PatchedConversations.ts +33 -0
  464. package/src/models/PatchedCourseCreationTaskFile.ts +12 -0
  465. package/src/models/PatchedCredentialRequest.ts +19 -0
  466. package/src/models/PatchedDataSet.ts +26 -0
  467. package/src/models/PatchedDiscordConfig.ts +12 -0
  468. package/src/models/PatchedDiscordUserConfig.ts +15 -0
  469. package/src/models/PatchedLLMCredentialRequest.ts +19 -0
  470. package/src/models/PatchedMCPServer.ts +26 -0
  471. package/src/models/PatchedMentorCategoryGroupCreate.ts +16 -0
  472. package/src/models/PatchedMentorCreate.ts +84 -0
  473. package/src/models/PatchedPeriodicAgentCreate.ts +46 -0
  474. package/src/models/PatchedPlayWrightScript.ts +17 -0
  475. package/src/models/PatchedPrompt.ts +27 -0
  476. package/src/models/PatchedSection.ts +14 -0
  477. package/src/models/PatchedSlackConfig.ts +13 -0
  478. package/src/models/PatchedSlackUserConfig.ts +22 -0
  479. package/src/models/PatchedSubSection.ts +14 -0
  480. package/src/models/PatchedTeamsConfig.ts +12 -0
  481. package/src/models/PatchedTrainingCreate.ts +36 -0
  482. package/src/models/PatchedUnit.ts +16 -0
  483. package/src/models/PatchedWebexConfig.ts +15 -0
  484. package/src/models/PatchedWhatsappConfig.ts +16 -0
  485. package/src/models/PatchedWhatsappUserConfig.ts +15 -0
  486. package/src/models/PeriodicAgent.ts +47 -0
  487. package/src/models/PeriodicAgentCreate.ts +46 -0
  488. package/src/models/PeriodicAgentLog.ts +16 -0
  489. package/src/models/PeriodicAgentLogStatusEnum.ts +14 -0
  490. package/src/models/PeriodicTask.ts +26 -0
  491. package/src/models/PieChartData.ts +10 -0
  492. package/src/models/PieChartSegment.ts +9 -0
  493. package/src/models/PinnedMessageCreate.ts +14 -0
  494. package/src/models/PinnedMessageGet.ts +12 -0
  495. package/src/models/PinnedMessageRequest.ts +11 -0
  496. package/src/models/PlayWrightScript.ts +17 -0
  497. package/src/models/PredictiveAnalyticsRequest.ts +9 -0
  498. package/src/models/PredictiveAnalyticsResponse.ts +9 -0
  499. package/src/models/PreviousAgentStatusEnum.ts +16 -0
  500. package/src/models/Prompt.ts +27 -0
  501. package/src/models/PromptCategory.ts +12 -0
  502. package/src/models/PromptVisibilityEnum.ts +14 -0
  503. package/src/models/Provider05cEnum.ts +18 -0
  504. package/src/models/Provider63aEnum.ts +10 -0
  505. package/src/models/QuestionCardTag.ts +13 -0
  506. package/src/models/QuestionRequest.ts +20 -0
  507. package/src/models/QuestionResponse.ts +15 -0
  508. package/src/models/RatingEnum.ts +12 -0
  509. package/src/models/RatingRecord.ts +9 -0
  510. package/src/models/RecentlyAccessedMentor.ts +13 -0
  511. package/src/models/RecommendCourseBlock.ts +8 -0
  512. package/src/models/RecommendCourseResponse.ts +8 -0
  513. package/src/models/RelatedText.ts +8 -0
  514. package/src/models/RequestDataVariable.ts +19 -0
  515. package/src/models/ResourceScrappedData.ts +18 -0
  516. package/src/models/ResourceScrappedDataStatusEnum.ts +16 -0
  517. package/src/models/ResponseDataVariable.ts +19 -0
  518. package/src/models/RetreiverTrainViewRequest.ts +15 -0
  519. package/src/models/RetreiverTrainViewResponse.ts +11 -0
  520. package/src/models/RetrieveTask.ts +8 -0
  521. package/src/models/RetrieverDocumentEmbedding.ts +22 -0
  522. package/src/models/RetrieverDocumentEmbeddingRequest.ts +35 -0
  523. package/src/models/RetrieverRequestSearch.ts +15 -0
  524. package/src/models/RetrieverRequestSearchDocument.ts +15 -0
  525. package/src/models/RetrieverResponseSearch.ts +12 -0
  526. package/src/models/ReuestDataVariableList.ts +9 -0
  527. package/src/models/RunMentorEval.ts +8 -0
  528. package/src/models/ScanWebhookRequest.ts +11 -0
  529. package/src/models/ScanWebhookResponse.ts +8 -0
  530. package/src/models/Section.ts +14 -0
  531. package/src/models/SectionWithChildren.ts +16 -0
  532. package/src/models/SeedMentorsView.ts +8 -0
  533. package/src/models/SentimentSummary.ts +9 -0
  534. package/src/models/SessionBrowserScreenshot.ts +13 -0
  535. package/src/models/SessionDetail.ts +11 -0
  536. package/src/models/SessionMemoryStorage.ts +11 -0
  537. package/src/models/ShellLogs.ts +8 -0
  538. package/src/models/SlackConfig.ts +13 -0
  539. package/src/models/SlackUserConfig.ts +22 -0
  540. package/src/models/SlackWebhook.ts +11 -0
  541. package/src/models/SpacedRepetitionLearningPath.ts +8 -0
  542. package/src/models/SpacedRepetitionQuestionStats.ts +10 -0
  543. package/src/models/StarMentor.ts +12 -0
  544. package/src/models/Status6eeEnum.ts +16 -0
  545. package/src/models/Step.ts +14 -0
  546. package/src/models/StepStatusEnum.ts +14 -0
  547. package/src/models/StudentChatMessage.ts +9 -0
  548. package/src/models/StylesView.ts +9 -0
  549. package/src/models/SubSection.ts +14 -0
  550. package/src/models/SubSectionWithChildren.ts +16 -0
  551. package/src/models/TagsView.ts +10 -0
  552. package/src/models/TargetSystemEnum.ts +12 -0
  553. package/src/models/TaskView.ts +8 -0
  554. package/src/models/TeamsConfig.ts +12 -0
  555. package/src/models/TeamsWebhook.ts +22 -0
  556. package/src/models/TemplateMentor.ts +14 -0
  557. package/src/models/TenantMentorTraces.ts +11 -0
  558. package/src/models/ThemeEnum.ts +12 -0
  559. package/src/models/TonesView.ts +9 -0
  560. package/src/models/ToolResponse.ts +14 -0
  561. package/src/models/TopicModel.ts +8 -0
  562. package/src/models/TopicRecord.ts +9 -0
  563. package/src/models/TopicStatistics.ts +12 -0
  564. package/src/models/TopicStatisticsResponse.ts +11 -0
  565. package/src/models/TopicSummaryView.ts +9 -0
  566. package/src/models/TrainChatSessionDocumentView.ts +11 -0
  567. package/src/models/TrainChatSessionDocumentViewRequest.ts +11 -0
  568. package/src/models/TrainDocumentViewRequest.ts +47 -0
  569. package/src/models/TrainDocumentViewResponse.ts +19 -0
  570. package/src/models/Training.ts +46 -0
  571. package/src/models/TrainingCreate.ts +36 -0
  572. package/src/models/TrainingStatusEnum.ts +16 -0
  573. package/src/models/TransportEnum.ts +12 -0
  574. package/src/models/TrendEntry.ts +9 -0
  575. package/src/models/TriggerRequest.ts +10 -0
  576. package/src/models/TriggerResponse.ts +11 -0
  577. package/src/models/TypeC42Enum.ts +12 -0
  578. package/src/models/Unit.ts +16 -0
  579. package/src/models/UnitWithChildren.ts +18 -0
  580. package/src/models/UseMainCreds.ts +8 -0
  581. package/src/models/UserAllChatMemoryView.ts +12 -0
  582. package/src/models/UserCatalogItemMemoryView.ts +19 -0
  583. package/src/models/UserChatByPeriod.ts +9 -0
  584. package/src/models/UserChatFeedback.ts +19 -0
  585. package/src/models/UserChatFeedbackCount.ts +9 -0
  586. package/src/models/UserChatMemoryStatusRequestView.ts +11 -0
  587. package/src/models/UserChatMemoryStatusView.ts +11 -0
  588. package/src/models/UserChatMemoryUpdateView.ts +15 -0
  589. package/src/models/UserCountRecord.ts +9 -0
  590. package/src/models/UserEdxMemory.ts +20 -0
  591. package/src/models/UserMemoryContextRequest.ts +18 -0
  592. package/src/models/UserMemoryContextResponse.ts +17 -0
  593. package/src/models/UserMetric.ts +9 -0
  594. package/src/models/UserMetricsResponse.ts +12 -0
  595. package/src/models/UserSentimentCountView.ts +9 -0
  596. package/src/models/UserTrendByPeriod.ts +10 -0
  597. package/src/models/VectorResult.ts +13 -0
  598. package/src/models/Voice.ts +14 -0
  599. package/src/models/VoiceProviderEnum.ts +14 -0
  600. package/src/models/WebResource.ts +14 -0
  601. package/src/models/WebResourceCard.ts +12 -0
  602. package/src/models/WebResourcesQuery.ts +8 -0
  603. package/src/models/WebexConfig.ts +15 -0
  604. package/src/models/WebexWebhook.ts +9 -0
  605. package/src/models/WhatAppWebHook.ts +8 -0
  606. package/src/models/WhatsappConfig.ts +16 -0
  607. package/src/models/WhatsappUserConfig.ts +15 -0
  608. package/src/services/AiAccountService.ts +479 -0
  609. package/src/services/AiAnalyticsService.ts +5198 -0
  610. package/src/services/AiBotService.ts +1174 -0
  611. package/src/services/AiFinetuningService.ts +402 -0
  612. package/src/services/AiIndexService.ts +598 -0
  613. package/src/services/AiMarketingService.ts +87 -0
  614. package/src/services/AiMentorService.ts +7895 -0
  615. package/src/services/AiPromptService.ts +1676 -0
  616. package/src/services/SearchService.ts +603 -151
@@ -0,0 +1,4194 @@
1
+ import type { AIGeneratedImage } from '../models/AIGeneratedImage';
2
+ import type { AssumedKnowledge } from '../models/AssumedKnowledge';
3
+ import type { AudioToTextRequest } from '../models/AudioToTextRequest';
4
+ import type { AudioToTextResponse } from '../models/AudioToTextResponse';
5
+ import type { CallAuthenticationRequest } from '../models/CallAuthenticationRequest';
6
+ import type { CallAuthenticationResponse } from '../models/CallAuthenticationResponse';
7
+ import type { ChatHistoryItem } from '../models/ChatHistoryItem';
8
+ import type { ChatHistorySessionId } from '../models/ChatHistorySessionId';
9
+ import type { ChatSessionRequest } from '../models/ChatSessionRequest';
10
+ import type { ChatSessionResponse } from '../models/ChatSessionResponse';
11
+ import type { CourseCreationTask } from '../models/CourseCreationTask';
12
+ import type { CourseCreationTaskFile } from '../models/CourseCreationTaskFile';
13
+ import type { CustomInstructionResponse } from '../models/CustomInstructionResponse';
14
+ import type { EdxCourse } from '../models/EdxCourse';
15
+ import type { ElevenlabsCustomVoice } from '../models/ElevenlabsCustomVoice';
16
+ import type { ElevenlabsCustomVoiceResponse } from '../models/ElevenlabsCustomVoiceResponse';
17
+ import type { EmailPromptDetail } from '../models/EmailPromptDetail';
18
+ import type { EmailPromptSummary } from '../models/EmailPromptSummary';
19
+ import type { FreeUsageCount } from '../models/FreeUsageCount';
20
+ import type { FullCourse } from '../models/FullCourse';
21
+ import type { JobRun } from '../models/JobRun';
22
+ import type { LinkCourseRequest } from '../models/LinkCourseRequest';
23
+ import type { LinkCourseResponse } from '../models/LinkCourseResponse';
24
+ import type { LLMModelForTenant } from '../models/LLMModelForTenant';
25
+ import type { LLMResponse } from '../models/LLMResponse';
26
+ import type { MCPServer } from '../models/MCPServer';
27
+ import type { MemoryComponentMemoryDetail } from '../models/MemoryComponentMemoryDetail';
28
+ import type { MemoryComponentResponse } from '../models/MemoryComponentResponse';
29
+ import type { MemoryProgress } from '../models/MemoryProgress';
30
+ import type { Mentor } from '../models/Mentor';
31
+ import type { MentorAudience } from '../models/MentorAudience';
32
+ import type { MentorCategory } from '../models/MentorCategory';
33
+ import type { MentorCategoryCreate } from '../models/MentorCategoryCreate';
34
+ import type { MentorCategoryGroup } from '../models/MentorCategoryGroup';
35
+ import type { MentorCategoryGroupCreate } from '../models/MentorCategoryGroupCreate';
36
+ import type { MentorCreate } from '../models/MentorCreate';
37
+ import type { MentorCustomVoice } from '../models/MentorCustomVoice';
38
+ import type { MentorCustomVoiceResponse } from '../models/MentorCustomVoiceResponse';
39
+ import type { MentorEval } from '../models/MentorEval';
40
+ import type { MentorEvalReport } from '../models/MentorEvalReport';
41
+ import type { MentorEvalRequest } from '../models/MentorEvalRequest';
42
+ import type { MentorFork } from '../models/MentorFork';
43
+ import type { MentorFromTemplateRequest } from '../models/MentorFromTemplateRequest';
44
+ import type { MentorFromTemplateWithSettingRequest } from '../models/MentorFromTemplateWithSettingRequest';
45
+ import type { MentorMemorySettingsRequest } from '../models/MentorMemorySettingsRequest';
46
+ import type { MentorMemorySettingsResponse } from '../models/MentorMemorySettingsResponse';
47
+ import type { MentorMetadata } from '../models/MentorMetadata';
48
+ import type { MentorScenario } from '../models/MentorScenario';
49
+ import type { MentorSettings } from '../models/MentorSettings';
50
+ import type { MentorSettingsPublic } from '../models/MentorSettingsPublic';
51
+ import type { MentorSettingsRequest } from '../models/MentorSettingsRequest';
52
+ import type { MentorWizard } from '../models/MentorWizard';
53
+ import type { MessageView } from '../models/MessageView';
54
+ import type { MessageViewRequest } from '../models/MessageViewRequest';
55
+ import type { MessageViewUpdatResponse } from '../models/MessageViewUpdatResponse';
56
+ import type { ModerationLog } from '../models/ModerationLog';
57
+ import type { PaginatedAIGeneratedImageList } from '../models/PaginatedAIGeneratedImageList';
58
+ import type { PaginatedCourseCreationTaskFileList } from '../models/PaginatedCourseCreationTaskFileList';
59
+ import type { PaginatedCourseCreationTaskList } from '../models/PaginatedCourseCreationTaskList';
60
+ import type { PaginatedEdxCourseList } from '../models/PaginatedEdxCourseList';
61
+ import type { PaginatedEmailPromptListList } from '../models/PaginatedEmailPromptListList';
62
+ import type { PaginatedJobRunList } from '../models/PaginatedJobRunList';
63
+ import type { PaginatedMCPServerList } from '../models/PaginatedMCPServerList';
64
+ import type { PaginatedMentorList } from '../models/PaginatedMentorList';
65
+ import type { PaginatedModerationLogList } from '../models/PaginatedModerationLogList';
66
+ import type { PaginatedPeriodicAgentList } from '../models/PaginatedPeriodicAgentList';
67
+ import type { PaginatedPeriodicAgentLogList } from '../models/PaginatedPeriodicAgentLogList';
68
+ import type { PaginatedPlayWrightScriptList } from '../models/PaginatedPlayWrightScriptList';
69
+ import type { PaginatedSectionList } from '../models/PaginatedSectionList';
70
+ import type { PaginatedSubSectionList } from '../models/PaginatedSubSectionList';
71
+ import type { PaginatedUnitList } from '../models/PaginatedUnitList';
72
+ import type { PaginatedUserEdxMemoryList } from '../models/PaginatedUserEdxMemoryList';
73
+ import type { PaginatedVoiceList } from '../models/PaginatedVoiceList';
74
+ import type { PatchedCourseCreationTaskFile } from '../models/PatchedCourseCreationTaskFile';
75
+ import type { PatchedMCPServer } from '../models/PatchedMCPServer';
76
+ import type { PatchedMentorCategoryGroupCreate } from '../models/PatchedMentorCategoryGroupCreate';
77
+ import type { PatchedMentorCreate } from '../models/PatchedMentorCreate';
78
+ import type { PatchedPeriodicAgentCreate } from '../models/PatchedPeriodicAgentCreate';
79
+ import type { PatchedPlayWrightScript } from '../models/PatchedPlayWrightScript';
80
+ import type { PatchedSection } from '../models/PatchedSection';
81
+ import type { PatchedSubSection } from '../models/PatchedSubSection';
82
+ import type { PatchedUnit } from '../models/PatchedUnit';
83
+ import type { PeriodicAgent } from '../models/PeriodicAgent';
84
+ import type { PeriodicAgentCreate } from '../models/PeriodicAgentCreate';
85
+ import type { PeriodicAgentLog } from '../models/PeriodicAgentLog';
86
+ import type { PinnedMessageCreate } from '../models/PinnedMessageCreate';
87
+ import type { PinnedMessageGet } from '../models/PinnedMessageGet';
88
+ import type { PinnedMessageRequest } from '../models/PinnedMessageRequest';
89
+ import type { PlayWrightScript } from '../models/PlayWrightScript';
90
+ import type { PredictiveAnalyticsRequest } from '../models/PredictiveAnalyticsRequest';
91
+ import type { PredictiveAnalyticsResponse } from '../models/PredictiveAnalyticsResponse';
92
+ import type { QuestionCardTag } from '../models/QuestionCardTag';
93
+ import type { QuestionRequest } from '../models/QuestionRequest';
94
+ import type { QuestionResponse } from '../models/QuestionResponse';
95
+ import type { RecentlyAccessedMentor } from '../models/RecentlyAccessedMentor';
96
+ import type { RecommendCourseBlock } from '../models/RecommendCourseBlock';
97
+ import type { RecommendCourseResponse } from '../models/RecommendCourseResponse';
98
+ import type { RelatedText } from '../models/RelatedText';
99
+ import type { RetrieveTask } from '../models/RetrieveTask';
100
+ import type { RunMentorEval } from '../models/RunMentorEval';
101
+ import type { Section } from '../models/Section';
102
+ import type { SeedMentorsView } from '../models/SeedMentorsView';
103
+ import type { SessionBrowserScreenshot } from '../models/SessionBrowserScreenshot';
104
+ import type { SessionDetail } from '../models/SessionDetail';
105
+ import type { SessionMemoryStorage } from '../models/SessionMemoryStorage';
106
+ import type { ShellLogs } from '../models/ShellLogs';
107
+ import type { SpacedRepetitionLearningPath } from '../models/SpacedRepetitionLearningPath';
108
+ import type { SpacedRepetitionQuestionStats } from '../models/SpacedRepetitionQuestionStats';
109
+ import type { StarMentor } from '../models/StarMentor';
110
+ import type { SubSection } from '../models/SubSection';
111
+ import type { TaskView } from '../models/TaskView';
112
+ import type { TemplateMentor } from '../models/TemplateMentor';
113
+ import type { ToolResponse } from '../models/ToolResponse';
114
+ import type { TriggerRequest } from '../models/TriggerRequest';
115
+ import type { TriggerResponse } from '../models/TriggerResponse';
116
+ import type { Unit } from '../models/Unit';
117
+ import type { UserChatFeedback } from '../models/UserChatFeedback';
118
+ import type { UserEdxMemory } from '../models/UserEdxMemory';
119
+ import type { VectorResult } from '../models/VectorResult';
120
+ import type { Voice } from '../models/Voice';
121
+ import type { WebResource } from '../models/WebResource';
122
+ import type { WebResourcesQuery } from '../models/WebResourcesQuery';
123
+ import type { CancelablePromise } from '../core/CancelablePromise';
124
+ export declare class AiMentorService {
125
+ /**
126
+ * List all triggers for an organization.
127
+ *
128
+ * Args:
129
+ * request: The HTTP request.
130
+ * org: The organization/tenant identifier.
131
+ *
132
+ * Returns:
133
+ * Response: A list of trigger slugs for the organization.
134
+ *
135
+ * Raises:
136
+ * BadRequest: If the request is invalid.
137
+ * @param org
138
+ * @returns any List of trigger slugs
139
+ * @throws ApiError
140
+ */
141
+ static aiMentorOrgsAllTriggersRetrieve(org: string): CancelablePromise<any>;
142
+ /**
143
+ * Retrieve a list of emails in a mentor's inbox.
144
+ *
145
+ * The list can be filtered using the 'search' query parameter to search
146
+ * for specific terms in the email content or subject.
147
+ *
148
+ * Args:
149
+ * mentor: The unique identifier of the mentor.
150
+ *
151
+ * Returns:
152
+ * Response: A paginated list of emails in the mentor's inbox.
153
+ *
154
+ * Raises:
155
+ * NotFound: If the specified mentor does not exist.
156
+ * @param mentor
157
+ * @param org
158
+ * @param page A page number within the paginated result set.
159
+ * @param pageSize Number of results to return per page.
160
+ * @param search Search term to filter emails by content or subject
161
+ * @returns PaginatedEmailPromptListList
162
+ * @throws ApiError
163
+ */
164
+ static aiMentorOrgsMentorsEmailInboxList(mentor: string, org: string, page?: number, pageSize?: number, search?: string): CancelablePromise<PaginatedEmailPromptListList>;
165
+ /**
166
+ * Retrieve a summary of a mentor's email inbox.
167
+ *
168
+ * Args:
169
+ * request: The HTTP request.
170
+ * mentor: The unique identifier of the mentor.
171
+ *
172
+ * Returns:
173
+ * Response: A summary of the mentor's email inbox statistics.
174
+ *
175
+ * Raises:
176
+ * NotFound: If the specified mentor does not exist.
177
+ * @param mentor
178
+ * @param org
179
+ * @returns EmailPromptSummary
180
+ * @throws ApiError
181
+ */
182
+ static aiMentorOrgsMentorsEmailInboxSummaryRetrieve(mentor: string, org: string): CancelablePromise<EmailPromptSummary>;
183
+ /**
184
+ * Retrieve details of a specific email in a mentor's inbox.
185
+ *
186
+ * Args:
187
+ * request: The HTTP request.
188
+ * email_prompt_id: The ID of the email to retrieve.
189
+ *
190
+ * Returns:
191
+ * Response: The detailed information about the email.
192
+ *
193
+ * Raises:
194
+ * NotFound: If the specified email does not exist.
195
+ * @param emailPromptId
196
+ * @param mentor
197
+ * @param org
198
+ * @returns EmailPromptDetail
199
+ * @throws ApiError
200
+ */
201
+ static aiMentorOrgsMentorsEmailInboxRetrieve(emailPromptId: number, mentor: string, org: string): CancelablePromise<EmailPromptDetail>;
202
+ /**
203
+ * API endpoint to link mentor with a course and enable guided mode.
204
+ *
205
+ * Permissions:
206
+ * - Accessible to tenant admins.
207
+ * @param mentor
208
+ * @param org
209
+ * @returns LinkCourseResponse
210
+ * @throws ApiError
211
+ */
212
+ static aiMentorOrgsMentorsLinkCourseRetrieve(mentor: string, org: string): CancelablePromise<LinkCourseResponse>;
213
+ /**
214
+ * API endpoint to link mentor with a course and enable guided mode.
215
+ *
216
+ * Permissions:
217
+ * - Accessible to tenant admins.
218
+ * @param mentor
219
+ * @param org
220
+ * @param requestBody
221
+ * @returns LinkCourseResponse
222
+ * @throws ApiError
223
+ */
224
+ static aiMentorOrgsMentorsLinkCourseCreate(mentor: string, org: string, requestBody: LinkCourseRequest): CancelablePromise<LinkCourseResponse>;
225
+ /**
226
+ * Create or update metadata for a mentor.
227
+ *
228
+ * Args:
229
+ * request: The HTTP request containing the metadata.
230
+ * org: The organization/tenant identifier.
231
+ *
232
+ * Returns:
233
+ * Response: The created or updated mentor metadata.
234
+ *
235
+ * Raises:
236
+ * BadRequest: If the provided data is invalid.
237
+ * @param org
238
+ * @param requestBody
239
+ * @returns MentorMetadata
240
+ * @throws ApiError
241
+ */
242
+ static aiMentorOrgsMetadataCreate(org: string, requestBody: MentorMetadata): CancelablePromise<MentorMetadata>;
243
+ /**
244
+ * Retrieve existing questions.
245
+ *
246
+ * Args:
247
+ * request: The HTTP request.
248
+ *
249
+ * Returns:
250
+ * Response: The existing questions.
251
+ * @param org
252
+ * @returns any No response body
253
+ * @throws ApiError
254
+ */
255
+ static aiMentorOrgsQuizCustomizerRetrieve(org: string): CancelablePromise<any>;
256
+ /**
257
+ * Generate follow-up questions based on initial questions.
258
+ *
259
+ * Args:
260
+ * request: The HTTP request containing the initial questions.
261
+ *
262
+ * Returns:
263
+ * Response: The generated follow-up questions.
264
+ *
265
+ * Raises:
266
+ * BadRequest: If the provided data is invalid.
267
+ * @param org
268
+ * @param requestBody
269
+ * @returns QuestionResponse
270
+ * @throws ApiError
271
+ */
272
+ static aiMentorOrgsQuizCustomizerCreate(org: string, requestBody: QuestionRequest): CancelablePromise<QuestionResponse>;
273
+ /**
274
+ * Retrieve or create a chat session with a mentor.
275
+ *
276
+ * Passing `null` as `tools` results in using all tools assigned to the mentor.
277
+ * To specify that no tools be used, pass an empty list.
278
+ *
279
+ * Args:
280
+ * request: HTTP request containing mentor details.
281
+ * org: Organization key identifier.
282
+ * user_id (optional): Username for authentication (if required by the mentor).
283
+ *
284
+ * Returns:
285
+ * Response: JSON object containing the session ID.
286
+ *
287
+ * Raises:
288
+ * Http404: If the mentor is not found.
289
+ * ValidationError: If the username is invalid.
290
+ * ValidationError: If one or more tool slugs are invalid.
291
+ * @param org
292
+ * @param requestBody
293
+ * @returns ChatSessionResponse
294
+ * @throws ApiError
295
+ */
296
+ static aiMentorOrgsSessionsCreate(org: string, requestBody: ChatSessionRequest): CancelablePromise<ChatSessionResponse>;
297
+ /**
298
+ * Create or modify a trigger.
299
+ *
300
+ * Args:
301
+ * request: The HTTP request containing the trigger data.
302
+ * org: The organization/tenant identifier.
303
+ *
304
+ * Returns:
305
+ * Response: The created or updated trigger details.
306
+ *
307
+ * Raises:
308
+ * BadRequest: If the provided data is invalid or missing required parameters.
309
+ * @param org
310
+ * @param requestBody
311
+ * @returns TriggerResponse
312
+ * @throws ApiError
313
+ */
314
+ static aiMentorOrgsTriggerCreate(org: string, requestBody: TriggerRequest): CancelablePromise<TriggerResponse>;
315
+ /**
316
+ * Retrieve available trigger templates.
317
+ *
318
+ * Args:
319
+ * request: The HTTP request.
320
+ * org: The organization/tenant identifier.
321
+ *
322
+ * Returns:
323
+ * Response: A dictionary of available trigger templates and their required parameters.
324
+ *
325
+ * Raises:
326
+ * BadRequest: If the request is invalid.
327
+ * @param org
328
+ * @returns any Dictionary of trigger templates and their required parameters
329
+ * @throws ApiError
330
+ */
331
+ static aiMentorOrgsTriggerTemplatesRetrieve(org: string): CancelablePromise<any>;
332
+ /**
333
+ * Retrieve details of a specific trigger.
334
+ *
335
+ * Args:
336
+ * request: The HTTP request.
337
+ * org: The organization/tenant identifier.
338
+ * slug: The unique slug identifier of the trigger.
339
+ *
340
+ * Returns:
341
+ * Response: The details of the specified trigger.
342
+ *
343
+ * Raises:
344
+ * Http404: If the specified trigger does not exist.
345
+ * @param org
346
+ * @param slug
347
+ * @returns TriggerResponse
348
+ * @throws ApiError
349
+ */
350
+ static aiMentorOrgsTriggerRetrieve(org: string, slug: string): CancelablePromise<TriggerResponse>;
351
+ /**
352
+ * Delete a specific trigger.
353
+ *
354
+ * Args:
355
+ * request: The HTTP request.
356
+ * org: The organization/tenant identifier.
357
+ * slug: The unique slug identifier of the trigger to delete.
358
+ *
359
+ * Returns:
360
+ * Response: A confirmation of the deletion status.
361
+ *
362
+ * Raises:
363
+ * BadRequest: If the specified trigger does not exist.
364
+ * @param org
365
+ * @param slug
366
+ * @returns any Trigger successfully deleted
367
+ * @throws ApiError
368
+ */
369
+ static aiMentorOrgsTriggerDeletionCreate(org: string, slug: string): CancelablePromise<any>;
370
+ /**
371
+ * Retrieve a list of mentors.
372
+ *
373
+ * Returns:
374
+ * - List of mentors matching the filters.
375
+ * @param org
376
+ * @param userId
377
+ * @param departmentId Department to filter by
378
+ * @param filterBy Filter options include, date, name, default is date
379
+ * @param metadataKey Metadata key to be queried with
380
+ * @param metadataValue Metadata value to be filter for
381
+ * @param page A page number within the paginated result set.
382
+ * @param pageSize Number of results to return per page.
383
+ * @param returnSessionInformation Declares if session information should be included in the mentor data
384
+ * @param visibility visibility type to be queried with
385
+ * @returns PaginatedMentorList
386
+ * @throws ApiError
387
+ */
388
+ static aiMentorOrgsUsersList(org: string, userId: string, departmentId?: number, filterBy?: string, metadataKey?: string, metadataValue?: string, page?: number, pageSize?: number, returnSessionInformation?: boolean, visibility?: string): CancelablePromise<PaginatedMentorList>;
389
+ /**
390
+ * Create a new mentor.
391
+ *
392
+ * Body Parameters:
393
+ * - name: Mentor name.
394
+ * - unique_id: Unique identifier.
395
+ * - platform_key: Associated platform.
396
+ * - metadata: Additional mentor attributes.
397
+ * @param org
398
+ * @param userId
399
+ * @param requestBody
400
+ * @param departmentId Department to filter by
401
+ * @param filterBy Filter options include, date, name, default is date
402
+ * @param metadataKey Metadata key to be queried with
403
+ * @param metadataValue Metadata value to be filter for
404
+ * @param returnSessionInformation Declares if session information should be included in the mentor data
405
+ * @param visibility visibility type to be queried with
406
+ * @returns Mentor
407
+ * @throws ApiError
408
+ */
409
+ static aiMentorOrgsUsersCreate(org: string, userId: string, requestBody: MentorCreate, departmentId?: number, filterBy?: string, metadataKey?: string, metadataValue?: string, returnSessionInformation?: boolean, visibility?: string): CancelablePromise<Mentor>;
410
+ /**
411
+ * API ViewSet for managing mentors.
412
+ *
413
+ * Provides endpoints to retrieve, create, update, and delete mentor data.
414
+ *
415
+ * Permissions:
416
+ * - Accessible to both tenant admins and students.
417
+ * @param name
418
+ * @param org
419
+ * @param userId
420
+ * @param departmentId Department to filter by
421
+ * @param filterBy Filter options include, date, name, default is date
422
+ * @param metadataKey Metadata key to be queried with
423
+ * @param metadataValue Metadata value to be filter for
424
+ * @param returnSessionInformation Declares if session information should be included in the mentor data
425
+ * @param visibility visibility type to be queried with
426
+ * @returns Mentor
427
+ * @throws ApiError
428
+ */
429
+ static aiMentorOrgsUsersRetrieve(name: string, org: string, userId: string, departmentId?: number, filterBy?: string, metadataKey?: string, metadataValue?: string, returnSessionInformation?: boolean, visibility?: string): CancelablePromise<Mentor>;
430
+ /**
431
+ * Update a mentor's details.
432
+ * @param name
433
+ * @param org
434
+ * @param userId
435
+ * @param requestBody
436
+ * @param departmentId Department to filter by
437
+ * @param filterBy Filter options include, date, name, default is date
438
+ * @param metadataKey Metadata key to be queried with
439
+ * @param metadataValue Metadata value to be filter for
440
+ * @param returnSessionInformation Declares if session information should be included in the mentor data
441
+ * @param visibility visibility type to be queried with
442
+ * @returns Mentor
443
+ * @throws ApiError
444
+ */
445
+ static aiMentorOrgsUsersUpdate(name: string, org: string, userId: string, requestBody: MentorCreate, departmentId?: number, filterBy?: string, metadataKey?: string, metadataValue?: string, returnSessionInformation?: boolean, visibility?: string): CancelablePromise<Mentor>;
446
+ /**
447
+ * API ViewSet for managing mentors.
448
+ *
449
+ * Provides endpoints to retrieve, create, update, and delete mentor data.
450
+ *
451
+ * Permissions:
452
+ * - Accessible to both tenant admins and students.
453
+ * @param name
454
+ * @param org
455
+ * @param userId
456
+ * @param departmentId Department to filter by
457
+ * @param filterBy Filter options include, date, name, default is date
458
+ * @param metadataKey Metadata key to be queried with
459
+ * @param metadataValue Metadata value to be filter for
460
+ * @param returnSessionInformation Declares if session information should be included in the mentor data
461
+ * @param visibility visibility type to be queried with
462
+ * @param requestBody
463
+ * @returns MentorCreate
464
+ * @throws ApiError
465
+ */
466
+ static aiMentorOrgsUsersPartialUpdate(name: string, org: string, userId: string, departmentId?: number, filterBy?: string, metadataKey?: string, metadataValue?: string, returnSessionInformation?: boolean, visibility?: string, requestBody?: PatchedMentorCreate): CancelablePromise<MentorCreate>;
467
+ /**
468
+ * Soft delete a mentor.
469
+ * @param name
470
+ * @param org
471
+ * @param userId
472
+ * @param departmentId Department to filter by
473
+ * @param filterBy Filter options include, date, name, default is date
474
+ * @param metadataKey Metadata key to be queried with
475
+ * @param metadataValue Metadata value to be filter for
476
+ * @param returnSessionInformation Declares if session information should be included in the mentor data
477
+ * @param visibility visibility type to be queried with
478
+ * @returns void
479
+ * @throws ApiError
480
+ */
481
+ static aiMentorOrgsUsersDestroy(name: string, org: string, userId: string, departmentId?: number, filterBy?: string, metadataKey?: string, metadataValue?: string, returnSessionInformation?: boolean, visibility?: string): CancelablePromise<void>;
482
+ /**
483
+ * Endpoint to view and delete AI generated images for a user.
484
+ *
485
+ * AI Generated images are images generated during chat with AI. They are cached to allow retrieval and deletion.
486
+ *
487
+ * optional filtering parameters allowed are
488
+ * - username: The username of the user for which this image was stored.
489
+ * - provider: The provider used to generate the image. eg. openai, nvidia (nim), replicate.
490
+ * - model: the text to image model on the provider used to generate the image.
491
+ *
492
+ * This endpoint is accessible to both students and platform admins.
493
+ * @param org
494
+ * @param userId
495
+ * @param model
496
+ * @param ordering Which field to use when ordering the results.
497
+ * @param page A page number within the paginated result set.
498
+ * @param pageSize Number of results to return per page.
499
+ * @param provider
500
+ * @param search A search term.
501
+ * @param username
502
+ * @returns PaginatedAIGeneratedImageList
503
+ * @throws ApiError
504
+ */
505
+ static aiMentorOrgsUsersAiGeneratedImagesList(org: string, userId: string, model?: string, ordering?: string, page?: number, pageSize?: number, provider?: string, search?: string, username?: string): CancelablePromise<PaginatedAIGeneratedImageList>;
506
+ /**
507
+ * Endpoint to view and delete AI generated images for a user.
508
+ *
509
+ * AI Generated images are images generated during chat with AI. They are cached to allow retrieval and deletion.
510
+ *
511
+ * optional filtering parameters allowed are
512
+ * - username: The username of the user for which this image was stored.
513
+ * - provider: The provider used to generate the image. eg. openai, nvidia (nim), replicate.
514
+ * - model: the text to image model on the provider used to generate the image.
515
+ *
516
+ * This endpoint is accessible to both students and platform admins.
517
+ * @param id A unique integer value identifying this ai generated image.
518
+ * @param org
519
+ * @param userId
520
+ * @returns AIGeneratedImage
521
+ * @throws ApiError
522
+ */
523
+ static aiMentorOrgsUsersAiGeneratedImagesRetrieve(id: number, org: string, userId: string): CancelablePromise<AIGeneratedImage>;
524
+ /**
525
+ * Endpoint to view and delete AI generated images for a user.
526
+ *
527
+ * AI Generated images are images generated during chat with AI. They are cached to allow retrieval and deletion.
528
+ *
529
+ * optional filtering parameters allowed are
530
+ * - username: The username of the user for which this image was stored.
531
+ * - provider: The provider used to generate the image. eg. openai, nvidia (nim), replicate.
532
+ * - model: the text to image model on the provider used to generate the image.
533
+ *
534
+ * This endpoint is accessible to both students and platform admins.
535
+ * @param id A unique integer value identifying this ai generated image.
536
+ * @param org
537
+ * @param userId
538
+ * @returns void
539
+ * @throws ApiError
540
+ */
541
+ static aiMentorOrgsUsersAiGeneratedImagesDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
542
+ /**
543
+ * Retrieve assumed knowledge levels.
544
+ *
545
+ * Args:
546
+ * request: The HTTP request.
547
+ * org: The organization/tenant identifier.
548
+ * user_id: The ID of the user to retrieve assumed knowledge for.
549
+ *
550
+ * Returns:
551
+ * Response: The assumed knowledge levels for different categories.
552
+ *
553
+ * Raises:
554
+ * NotFound: If no assumed knowledge exists for the user.
555
+ * @param org
556
+ * @param userId
557
+ * @returns AssumedKnowledge
558
+ * @throws ApiError
559
+ */
560
+ static aiMentorOrgsUsersAssumedKnowledgeRetrieve(org: string, userId: string): CancelablePromise<AssumedKnowledge>;
561
+ /**
562
+ * Update assumed knowledge levels.
563
+ *
564
+ * Args:
565
+ * request: The HTTP request containing the updated knowledge levels.
566
+ * org: The organization/tenant identifier.
567
+ * user_id: The ID of the user to update assumed knowledge for.
568
+ *
569
+ * Returns:
570
+ * Response: The updated assumed knowledge levels.
571
+ *
572
+ * Raises:
573
+ * BadRequest: If the provided data is invalid.
574
+ * @param org
575
+ * @param userId
576
+ * @param requestBody
577
+ * @returns AssumedKnowledge
578
+ * @throws ApiError
579
+ */
580
+ static aiMentorOrgsUsersAssumedKnowledgeCreate(org: string, userId: string, requestBody: AssumedKnowledge): CancelablePromise<AssumedKnowledge>;
581
+ /**
582
+ * Convert an uploaded audio file to text.
583
+ *
584
+ * Args:
585
+ * request: The HTTP request containing the audio file.
586
+ * org: The organization/tenant identifier.
587
+ * user_id: The ID of the user uploading the audio.
588
+ *
589
+ * Returns:
590
+ * Response: The transcribed text from the audio file.
591
+ *
592
+ * Raises:
593
+ * BadRequest: If the audio file is invalid or cannot be processed.
594
+ * NotFound: If the API key for the tenant is not found.
595
+ * @param org
596
+ * @param userId
597
+ * @param formData
598
+ * @returns AudioToTextResponse
599
+ * @throws ApiError
600
+ */
601
+ static aiMentorOrgsUsersAudioToTextCreate(org: string, userId: string, formData: AudioToTextRequest): CancelablePromise<AudioToTextResponse>;
602
+ /**
603
+ * This endpoint list available template mentors for a tenant
604
+ *
605
+ * Returns:
606
+ *
607
+ * 200 : List of Tool objects
608
+ * @param org
609
+ * @param userId
610
+ * @returns TemplateMentor
611
+ * @throws ApiError
612
+ */
613
+ static aiMentorOrgsUsersAvailableTemplateMentorsRetrieve(org: string, userId: string): CancelablePromise<TemplateMentor>;
614
+ /**
615
+ * Retrieve a list of Mentor Category Groups.
616
+ * @param org
617
+ * @param userId
618
+ * @param audience
619
+ * @param audienceName
620
+ * @param ordering Which field to use when ordering the results.
621
+ * @param search A search term.
622
+ * @returns MentorCategoryGroup
623
+ * @throws ApiError
624
+ */
625
+ static aiMentorOrgsUsersCategoryGroupsList(org: string, userId: string, audience?: number, audienceName?: string, ordering?: string, search?: string): CancelablePromise<Array<MentorCategoryGroup>>;
626
+ /**
627
+ * Create a new Mentor Category Group. Only accessible to Platform Admins.
628
+ * @param org
629
+ * @param userId
630
+ * @param requestBody
631
+ * @returns MentorCategoryGroup
632
+ * @throws ApiError
633
+ */
634
+ static aiMentorOrgsUsersCategoryGroupsCreate(org: string, userId: string, requestBody: MentorCategoryGroupCreate): CancelablePromise<MentorCategoryGroup>;
635
+ /**
636
+ * Mentor Category Groups offer parent grouping for mentor category objects.
637
+ *
638
+ * The parameter `audience` is deprecated and is currently left behind for backward compatibility.
639
+ *
640
+ * Permissions:
641
+ * GET: Accessible to both Platform Admins and Students
642
+ * POST, DELETE, PATCH, PUT: Accessible to only Platform Admins
643
+ * @param id A unique integer value identifying this mentor category group.
644
+ * @param org
645
+ * @param userId
646
+ * @returns MentorCategoryGroup
647
+ * @throws ApiError
648
+ */
649
+ static aiMentorOrgsUsersCategoryGroupsRetrieve(id: number, org: string, userId: string): CancelablePromise<MentorCategoryGroup>;
650
+ /**
651
+ * Mentor Category Groups offer parent grouping for mentor category objects.
652
+ *
653
+ * The parameter `audience` is deprecated and is currently left behind for backward compatibility.
654
+ *
655
+ * Permissions:
656
+ * GET: Accessible to both Platform Admins and Students
657
+ * POST, DELETE, PATCH, PUT: Accessible to only Platform Admins
658
+ * @param id A unique integer value identifying this mentor category group.
659
+ * @param org
660
+ * @param userId
661
+ * @param requestBody
662
+ * @returns MentorCategoryGroupCreate
663
+ * @throws ApiError
664
+ */
665
+ static aiMentorOrgsUsersCategoryGroupsUpdate(id: number, org: string, userId: string, requestBody: MentorCategoryGroupCreate): CancelablePromise<MentorCategoryGroupCreate>;
666
+ /**
667
+ * Mentor Category Groups offer parent grouping for mentor category objects.
668
+ *
669
+ * The parameter `audience` is deprecated and is currently left behind for backward compatibility.
670
+ *
671
+ * Permissions:
672
+ * GET: Accessible to both Platform Admins and Students
673
+ * POST, DELETE, PATCH, PUT: Accessible to only Platform Admins
674
+ * @param id A unique integer value identifying this mentor category group.
675
+ * @param org
676
+ * @param userId
677
+ * @param requestBody
678
+ * @returns MentorCategoryGroupCreate
679
+ * @throws ApiError
680
+ */
681
+ static aiMentorOrgsUsersCategoryGroupsPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedMentorCategoryGroupCreate): CancelablePromise<MentorCategoryGroupCreate>;
682
+ /**
683
+ * Mentor Category Groups offer parent grouping for mentor category objects.
684
+ *
685
+ * The parameter `audience` is deprecated and is currently left behind for backward compatibility.
686
+ *
687
+ * Permissions:
688
+ * GET: Accessible to both Platform Admins and Students
689
+ * POST, DELETE, PATCH, PUT: Accessible to only Platform Admins
690
+ * @param id A unique integer value identifying this mentor category group.
691
+ * @param org
692
+ * @param userId
693
+ * @returns void
694
+ * @throws ApiError
695
+ */
696
+ static aiMentorOrgsUsersCategoryGroupsDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
697
+ /**
698
+ * Retrieve and clean up vector results from a specific session.
699
+ *
700
+ * This endpoint retrieves the documents last used by the mentor to answer
701
+ * the most recent query from the user in the specified session, and cleans
702
+ * them to remove any inappropriate content.
703
+ *
704
+ * Args:
705
+ * request: The HTTP request.
706
+ * org: The organization/tenant identifier.
707
+ * user_id: The ID of the user making the request.
708
+ * session_id: The ID of the session to retrieve vector results from.
709
+ *
710
+ * Returns:
711
+ * Response: The cleaned vector results.
712
+ *
713
+ * Raises:
714
+ * BadRequest: If the API key for the cleaning provider is not found.
715
+ * NotFound: If no vector results are found for the session.
716
+ * @param org
717
+ * @param sessionId
718
+ * @param userId
719
+ * @returns VectorResult
720
+ * @throws ApiError
721
+ */
722
+ static aiMentorOrgsUsersCleanVectorResultsList(org: string, sessionId: string, userId: string): CancelablePromise<Array<VectorResult>>;
723
+ /**
724
+ * Clean up provided vector results.
725
+ *
726
+ * This endpoint allows users to submit specific vector results for cleaning,
727
+ * which is useful when there are particular documents that need to be processed.
728
+ *
729
+ * Args:
730
+ * request: The HTTP request containing the vector results to clean.
731
+ * org: The organization/tenant identifier.
732
+ * user_id: The ID of the user making the request.
733
+ *
734
+ * Returns:
735
+ * Response: The cleaned vector results.
736
+ *
737
+ * Raises:
738
+ * BadRequest: If the API key for the cleaning provider is not found or the provided data is invalid.
739
+ * @param org
740
+ * @param sessionId
741
+ * @param userId
742
+ * @param requestBody
743
+ * @returns VectorResult
744
+ * @throws ApiError
745
+ */
746
+ static aiMentorOrgsUsersCleanVectorResultsCreate(org: string, sessionId: string, userId: string, requestBody: Array<VectorResult>): CancelablePromise<Array<VectorResult>>;
747
+ /**
748
+ * Delete User Chat History
749
+ * Endpoint to clear a user's chat history.
750
+ * @param org
751
+ * @param userId
752
+ * @returns void
753
+ * @throws ApiError
754
+ */
755
+ static aiMentorOrgsUsersClearChathistoryDestroy(org: string, userId: string): CancelablePromise<void>;
756
+ /**
757
+ * Endpoint to fetch update and delete files associated with course creation tasks.
758
+ * @param org
759
+ * @param userId
760
+ * @param page A page number within the paginated result set.
761
+ * @param pageSize Number of results to return per page.
762
+ * @returns PaginatedCourseCreationTaskFileList
763
+ * @throws ApiError
764
+ */
765
+ static aiMentorOrgsUsersCourseCreationTaskFilesList(org: string, userId: string, page?: number, pageSize?: number): CancelablePromise<PaginatedCourseCreationTaskFileList>;
766
+ /**
767
+ * Endpoint to fetch update and delete files associated with course creation tasks.
768
+ * @param org
769
+ * @param userId
770
+ * @param formData
771
+ * @returns CourseCreationTaskFile
772
+ * @throws ApiError
773
+ */
774
+ static aiMentorOrgsUsersCourseCreationTaskFilesCreate(org: string, userId: string, formData: CourseCreationTaskFile): CancelablePromise<CourseCreationTaskFile>;
775
+ /**
776
+ * Endpoint to fetch update and delete files associated with course creation tasks.
777
+ * @param id A unique integer value identifying this course creation task file.
778
+ * @param org
779
+ * @param userId
780
+ * @returns CourseCreationTaskFile
781
+ * @throws ApiError
782
+ */
783
+ static aiMentorOrgsUsersCourseCreationTaskFilesRetrieve(id: number, org: string, userId: string): CancelablePromise<CourseCreationTaskFile>;
784
+ /**
785
+ * Endpoint to fetch update and delete files associated with course creation tasks.
786
+ * @param id A unique integer value identifying this course creation task file.
787
+ * @param org
788
+ * @param userId
789
+ * @param formData
790
+ * @returns CourseCreationTaskFile
791
+ * @throws ApiError
792
+ */
793
+ static aiMentorOrgsUsersCourseCreationTaskFilesUpdate(id: number, org: string, userId: string, formData: CourseCreationTaskFile): CancelablePromise<CourseCreationTaskFile>;
794
+ /**
795
+ * Endpoint to fetch update and delete files associated with course creation tasks.
796
+ * @param id A unique integer value identifying this course creation task file.
797
+ * @param org
798
+ * @param userId
799
+ * @param formData
800
+ * @returns CourseCreationTaskFile
801
+ * @throws ApiError
802
+ */
803
+ static aiMentorOrgsUsersCourseCreationTaskFilesPartialUpdate(id: number, org: string, userId: string, formData?: PatchedCourseCreationTaskFile): CancelablePromise<CourseCreationTaskFile>;
804
+ /**
805
+ * Endpoint to fetch update and delete files associated with course creation tasks.
806
+ * @param id A unique integer value identifying this course creation task file.
807
+ * @param org
808
+ * @param userId
809
+ * @returns void
810
+ * @throws ApiError
811
+ */
812
+ static aiMentorOrgsUsersCourseCreationTaskFilesDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
813
+ /**
814
+ * Create, retrieve and delete course creation tasks
815
+ *
816
+ * Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
817
+ *
818
+ * The course is created entirely by an ai model (as specified in your inputs).
819
+ *
820
+ * The llm decides on the content of the course based on the name, description, target audience and other parameters.
821
+ * Bigger and newer models tend to outperform smaller once.
822
+ *
823
+ * Clear and unambiguous parameters are more likely to produce better results.
824
+ * @param org
825
+ * @param userId
826
+ * @param page A page number within the paginated result set.
827
+ * @param pageSize Number of results to return per page.
828
+ * @returns PaginatedCourseCreationTaskList
829
+ * @throws ApiError
830
+ */
831
+ static aiMentorOrgsUsersCourseCreationTasksList(org: string, userId: string, page?: number, pageSize?: number): CancelablePromise<PaginatedCourseCreationTaskList>;
832
+ /**
833
+ * Create, retrieve and delete course creation tasks
834
+ *
835
+ * Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
836
+ *
837
+ * The course is created entirely by an ai model (as specified in your inputs).
838
+ *
839
+ * The llm decides on the content of the course based on the name, description, target audience and other parameters.
840
+ * Bigger and newer models tend to outperform smaller once.
841
+ *
842
+ * Clear and unambiguous parameters are more likely to produce better results.
843
+ * @param org
844
+ * @param userId
845
+ * @param formData
846
+ * @returns CourseCreationTask
847
+ * @throws ApiError
848
+ */
849
+ static aiMentorOrgsUsersCourseCreationTasksCreate(org: string, userId: string, formData: CourseCreationTask): CancelablePromise<CourseCreationTask>;
850
+ /**
851
+ * Create, retrieve and delete course creation tasks
852
+ *
853
+ * Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
854
+ *
855
+ * The course is created entirely by an ai model (as specified in your inputs).
856
+ *
857
+ * The llm decides on the content of the course based on the name, description, target audience and other parameters.
858
+ * Bigger and newer models tend to outperform smaller once.
859
+ *
860
+ * Clear and unambiguous parameters are more likely to produce better results.
861
+ * @param id A unique integer value identifying this course creation task.
862
+ * @param org
863
+ * @param userId
864
+ * @returns CourseCreationTask
865
+ * @throws ApiError
866
+ */
867
+ static aiMentorOrgsUsersCourseCreationTasksRetrieve(id: number, org: string, userId: string): CancelablePromise<CourseCreationTask>;
868
+ /**
869
+ * Create, retrieve and delete course creation tasks
870
+ *
871
+ * Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
872
+ *
873
+ * The course is created entirely by an ai model (as specified in your inputs).
874
+ *
875
+ * The llm decides on the content of the course based on the name, description, target audience and other parameters.
876
+ * Bigger and newer models tend to outperform smaller once.
877
+ *
878
+ * Clear and unambiguous parameters are more likely to produce better results.
879
+ * @param id A unique integer value identifying this course creation task.
880
+ * @param org
881
+ * @param userId
882
+ * @returns void
883
+ * @throws ApiError
884
+ */
885
+ static aiMentorOrgsUsersCourseCreationTasksDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
886
+ /**
887
+ * Cancel a course creation task run.
888
+ * ** Conditions Required **:
889
+ * The task must be running or pending.
890
+ * ** Response **:
891
+ * - 200: The course creation task is successfully cancelled.
892
+ * - 400: The course creation task is not in a running or pending state.
893
+ * @param id A unique integer value identifying this course creation task.
894
+ * @param org
895
+ * @param userId
896
+ * @returns CourseCreationTask
897
+ * @throws ApiError
898
+ */
899
+ static aiMentorOrgsUsersCourseCreationTasksCancelRetrieve(id: number, org: string, userId: string): CancelablePromise<CourseCreationTask>;
900
+ /**
901
+ * This is intended for stepwise approach of course creation.
902
+ *
903
+ * Use this to intiate generating an outline of the course.
904
+ * @param id A unique integer value identifying this course creation task.
905
+ * @param org
906
+ * @param userId
907
+ * @returns FullCourse
908
+ * @throws ApiError
909
+ */
910
+ static aiMentorOrgsUsersCourseCreationTasksCreateCourseOutlineRetrieve(id: number, org: string, userId: string): CancelablePromise<FullCourse>;
911
+ /**
912
+ * This is intended for stepwise approach of course creation.
913
+ *
914
+ * Use this to intiate generating an outline of the course.
915
+ * @param id A unique integer value identifying this course creation task.
916
+ * @param org
917
+ * @param userId
918
+ * @param formData
919
+ * @returns FullCourse
920
+ * @throws ApiError
921
+ */
922
+ static aiMentorOrgsUsersCourseCreationTasksCreateCourseOutlineCreate(id: number, org: string, userId: string, formData: CourseCreationTask): CancelablePromise<FullCourse>;
923
+ /**
924
+ * Kick start the course creation task.
925
+ * This endpoint should be called once the files for a course creation task has
926
+ * been successfully uploaded.
927
+ *
928
+ * ** Conditions Required **:
929
+ * - The course creation task must be in a pending state or failed state.
930
+ *
931
+ * ** Response **:
932
+ * - 200: The course creation task is successfully started.
933
+ * - 400: The course creation task is not in a pending state.
934
+ * @param id A unique integer value identifying this course creation task.
935
+ * @param org
936
+ * @param userId
937
+ * @returns CourseCreationTask
938
+ * @throws ApiError
939
+ */
940
+ static aiMentorOrgsUsersCourseCreationTasksStartRetrieve(id: number, org: string, userId: string): CancelablePromise<CourseCreationTask>;
941
+ /**
942
+ * API viewset for managing course units.
943
+ *
944
+ * This viewset allows platform administrators to retrieve and manage
945
+ * units within course subsections, and generate content for them.
946
+ *
947
+ * Permissions:
948
+ * - Restricted to platform administrators only
949
+ * @param org
950
+ * @param userId
951
+ * @param course
952
+ * @param ordering Which field to use when ordering the results.
953
+ * @param page A page number within the paginated result set.
954
+ * @param pageSize Number of results to return per page.
955
+ * @param search A search term.
956
+ * @param section
957
+ * @param subsection
958
+ * @param task
959
+ * @returns PaginatedUnitList
960
+ * @throws ApiError
961
+ */
962
+ static aiMentorOrgsUsersCourseCreationComponentList(org: string, userId: string, course?: number, ordering?: string, page?: number, pageSize?: number, search?: string, section?: number, subsection?: number, task?: number): CancelablePromise<PaginatedUnitList>;
963
+ /**
964
+ * API viewset for managing course units.
965
+ *
966
+ * This viewset allows platform administrators to retrieve and manage
967
+ * units within course subsections, and generate content for them.
968
+ *
969
+ * Permissions:
970
+ * - Restricted to platform administrators only
971
+ * @param org
972
+ * @param userId
973
+ * @param requestBody
974
+ * @returns Unit
975
+ * @throws ApiError
976
+ */
977
+ static aiMentorOrgsUsersCourseCreationComponentCreate(org: string, userId: string, requestBody: Unit): CancelablePromise<Unit>;
978
+ /**
979
+ * API viewset for managing course units.
980
+ *
981
+ * This viewset allows platform administrators to retrieve and manage
982
+ * units within course subsections, and generate content for them.
983
+ *
984
+ * Permissions:
985
+ * - Restricted to platform administrators only
986
+ * @param id A unique integer value identifying this unit.
987
+ * @param org
988
+ * @param userId
989
+ * @returns Unit
990
+ * @throws ApiError
991
+ */
992
+ static aiMentorOrgsUsersCourseCreationComponentRetrieve(id: number, org: string, userId: string): CancelablePromise<Unit>;
993
+ /**
994
+ * API viewset for managing course units.
995
+ *
996
+ * This viewset allows platform administrators to retrieve and manage
997
+ * units within course subsections, and generate content for them.
998
+ *
999
+ * Permissions:
1000
+ * - Restricted to platform administrators only
1001
+ * @param id A unique integer value identifying this unit.
1002
+ * @param org
1003
+ * @param userId
1004
+ * @param requestBody
1005
+ * @returns Unit
1006
+ * @throws ApiError
1007
+ */
1008
+ static aiMentorOrgsUsersCourseCreationComponentUpdate(id: number, org: string, userId: string, requestBody: Unit): CancelablePromise<Unit>;
1009
+ /**
1010
+ * API viewset for managing course units.
1011
+ *
1012
+ * This viewset allows platform administrators to retrieve and manage
1013
+ * units within course subsections, and generate content for them.
1014
+ *
1015
+ * Permissions:
1016
+ * - Restricted to platform administrators only
1017
+ * @param id A unique integer value identifying this unit.
1018
+ * @param org
1019
+ * @param userId
1020
+ * @param requestBody
1021
+ * @returns Unit
1022
+ * @throws ApiError
1023
+ */
1024
+ static aiMentorOrgsUsersCourseCreationComponentPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedUnit): CancelablePromise<Unit>;
1025
+ /**
1026
+ * API viewset for managing course units.
1027
+ *
1028
+ * This viewset allows platform administrators to retrieve and manage
1029
+ * units within course subsections, and generate content for them.
1030
+ *
1031
+ * Permissions:
1032
+ * - Restricted to platform administrators only
1033
+ * @param id A unique integer value identifying this unit.
1034
+ * @param org
1035
+ * @param userId
1036
+ * @returns void
1037
+ * @throws ApiError
1038
+ */
1039
+ static aiMentorOrgsUsersCourseCreationComponentDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
1040
+ /**
1041
+ * Generate draft content for a specific unit.
1042
+ *
1043
+ * This action starts a background task to create draft content
1044
+ * for the specified unit using AI.
1045
+ *
1046
+ * Args:
1047
+ * request: The HTTP request.
1048
+ * pk: The primary key of the unit to generate content for.
1049
+ *
1050
+ * Returns:
1051
+ * Response: A confirmation that the content generation task has been started.
1052
+ *
1053
+ * Raises:
1054
+ * NotFound: If the specified unit does not exist.
1055
+ * @param id A unique integer value identifying this unit.
1056
+ * @param org
1057
+ * @param userId
1058
+ * @returns any Content creation started successfully
1059
+ * @throws ApiError
1060
+ */
1061
+ static aiMentorOrgsUsersCourseCreationComponentDraftContentRetrieve(id: number, org: string, userId: string): CancelablePromise<any>;
1062
+ /**
1063
+ * Generate draft content for a specific unit.
1064
+ *
1065
+ * This action starts a background task to create draft content
1066
+ * for the specified unit using AI.
1067
+ *
1068
+ * Args:
1069
+ * request: The HTTP request.
1070
+ * pk: The primary key of the unit to generate content for.
1071
+ *
1072
+ * Returns:
1073
+ * Response: A confirmation that the content generation task has been started.
1074
+ *
1075
+ * Raises:
1076
+ * NotFound: If the specified unit does not exist.
1077
+ * @param id A unique integer value identifying this unit.
1078
+ * @param org
1079
+ * @param userId
1080
+ * @param requestBody
1081
+ * @returns any Content creation started successfully
1082
+ * @throws ApiError
1083
+ */
1084
+ static aiMentorOrgsUsersCourseCreationComponentDraftContentCreate(id: number, org: string, userId: string, requestBody: Unit): CancelablePromise<any>;
1085
+ /**
1086
+ * API viewset for managing EdX courses.
1087
+ *
1088
+ * This viewset allows platform administrators to retrieve, delete, and
1089
+ * perform various operations on EdX courses that were created through
1090
+ * course creation tasks.
1091
+ *
1092
+ * Permissions:
1093
+ * - Restricted to platform administrators only
1094
+ * @param org
1095
+ * @param userId
1096
+ * @param ordering Which field to use when ordering the results.
1097
+ * @param page A page number within the paginated result set.
1098
+ * @param pageSize Number of results to return per page.
1099
+ * @param search A search term.
1100
+ * @param task
1101
+ * @returns PaginatedEdxCourseList
1102
+ * @throws ApiError
1103
+ */
1104
+ static aiMentorOrgsUsersCourseCreationCourseList(org: string, userId: string, ordering?: string, page?: number, pageSize?: number, search?: string, task?: number): CancelablePromise<PaginatedEdxCourseList>;
1105
+ /**
1106
+ * API viewset for managing EdX courses.
1107
+ *
1108
+ * This viewset allows platform administrators to retrieve, delete, and
1109
+ * perform various operations on EdX courses that were created through
1110
+ * course creation tasks.
1111
+ *
1112
+ * Permissions:
1113
+ * - Restricted to platform administrators only
1114
+ * @param id A unique integer value identifying this edx course.
1115
+ * @param org
1116
+ * @param userId
1117
+ * @returns EdxCourse
1118
+ * @throws ApiError
1119
+ */
1120
+ static aiMentorOrgsUsersCourseCreationCourseRetrieve(id: number, org: string, userId: string): CancelablePromise<EdxCourse>;
1121
+ /**
1122
+ * API viewset for managing EdX courses.
1123
+ *
1124
+ * This viewset allows platform administrators to retrieve, delete, and
1125
+ * perform various operations on EdX courses that were created through
1126
+ * course creation tasks.
1127
+ *
1128
+ * Permissions:
1129
+ * - Restricted to platform administrators only
1130
+ * @param id A unique integer value identifying this edx course.
1131
+ * @param org
1132
+ * @param userId
1133
+ * @returns void
1134
+ * @throws ApiError
1135
+ */
1136
+ static aiMentorOrgsUsersCourseCreationCourseDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
1137
+ /**
1138
+ * Generate draft content for all units in a course.
1139
+ *
1140
+ * This action starts a background task to create draft content
1141
+ * for all units in the course using AI.
1142
+ *
1143
+ * Args:
1144
+ * request: The HTTP request.
1145
+ * pk: The primary key of the course to generate content for.
1146
+ *
1147
+ * Returns:
1148
+ * Response: A confirmation that the content generation task has been started.
1149
+ *
1150
+ * Raises:
1151
+ * NotFound: If the specified course does not exist.
1152
+ * @param id A unique integer value identifying this edx course.
1153
+ * @param org
1154
+ * @param userId
1155
+ * @returns any Content creation started successfully
1156
+ * @throws ApiError
1157
+ */
1158
+ static aiMentorOrgsUsersCourseCreationCourseDraftContentForAllUnitsRetrieve(id: number, org: string, userId: string): CancelablePromise<any>;
1159
+ /**
1160
+ * Retrieve the full structure of a course.
1161
+ *
1162
+ * This action returns the complete hierarchical structure of the course,
1163
+ * including all sections, subsections, units, and components.
1164
+ *
1165
+ * Args:
1166
+ * request: The HTTP request.
1167
+ * pk: The primary key of the course to retrieve.
1168
+ *
1169
+ * Returns:
1170
+ * Response: The full structure of the course.
1171
+ *
1172
+ * Raises:
1173
+ * NotFound: If the specified course does not exist.
1174
+ * @param id A unique integer value identifying this edx course.
1175
+ * @param org
1176
+ * @param userId
1177
+ * @returns FullCourse
1178
+ * @throws ApiError
1179
+ */
1180
+ static aiMentorOrgsUsersCourseCreationCourseFullStructureRetrieve(id: number, org: string, userId: string): CancelablePromise<FullCourse>;
1181
+ /**
1182
+ * Load existing course structure from OpenEdX.
1183
+ *
1184
+ * This action starts a background task to pull the course structure
1185
+ * from the EdX platform into the database.
1186
+ *
1187
+ * Args:
1188
+ * request: The HTTP request.
1189
+ * pk: The primary key of the course to load.
1190
+ *
1191
+ * Returns:
1192
+ * Response: A confirmation that the load task has been started.
1193
+ *
1194
+ * Raises:
1195
+ * NotFound: If the specified course does not exist.
1196
+ * @param id A unique integer value identifying this edx course.
1197
+ * @param org
1198
+ * @param userId
1199
+ * @returns any Course load started successfully
1200
+ * @throws ApiError
1201
+ */
1202
+ static aiMentorOrgsUsersCourseCreationCourseLoadFromEdxRetrieve(id: number, org: string, userId: string): CancelablePromise<any>;
1203
+ /**
1204
+ * Synchronize the course structure to EdX.
1205
+ *
1206
+ * This action starts a background task to push the course structure
1207
+ * from the database to the EdX platform.
1208
+ *
1209
+ * Args:
1210
+ * request: The HTTP request.
1211
+ * pk: The primary key of the course to synchronize.
1212
+ *
1213
+ * Returns:
1214
+ * Response: A confirmation that the sync task has been started.
1215
+ *
1216
+ * Raises:
1217
+ * NotFound: If the specified course does not exist.
1218
+ * @param id A unique integer value identifying this edx course.
1219
+ * @param org
1220
+ * @param userId
1221
+ * @returns any Course sync started successfully
1222
+ * @throws ApiError
1223
+ */
1224
+ static aiMentorOrgsUsersCourseCreationCourseSyncToEdxRetrieve(id: number, org: string, userId: string): CancelablePromise<any>;
1225
+ /**
1226
+ * Endpoint to fetch update and delete files associated with course creation tasks.
1227
+ * @param org
1228
+ * @param userId
1229
+ * @param page A page number within the paginated result set.
1230
+ * @param pageSize Number of results to return per page.
1231
+ * @returns PaginatedCourseCreationTaskFileList
1232
+ * @throws ApiError
1233
+ */
1234
+ static aiMentorOrgsUsersCourseCreationFilesList(org: string, userId: string, page?: number, pageSize?: number): CancelablePromise<PaginatedCourseCreationTaskFileList>;
1235
+ /**
1236
+ * Endpoint to fetch update and delete files associated with course creation tasks.
1237
+ * @param org
1238
+ * @param userId
1239
+ * @param formData
1240
+ * @returns CourseCreationTaskFile
1241
+ * @throws ApiError
1242
+ */
1243
+ static aiMentorOrgsUsersCourseCreationFilesCreate(org: string, userId: string, formData: CourseCreationTaskFile): CancelablePromise<CourseCreationTaskFile>;
1244
+ /**
1245
+ * Endpoint to fetch update and delete files associated with course creation tasks.
1246
+ * @param id A unique integer value identifying this course creation task file.
1247
+ * @param org
1248
+ * @param userId
1249
+ * @returns CourseCreationTaskFile
1250
+ * @throws ApiError
1251
+ */
1252
+ static aiMentorOrgsUsersCourseCreationFilesRetrieve(id: number, org: string, userId: string): CancelablePromise<CourseCreationTaskFile>;
1253
+ /**
1254
+ * Endpoint to fetch update and delete files associated with course creation tasks.
1255
+ * @param id A unique integer value identifying this course creation task file.
1256
+ * @param org
1257
+ * @param userId
1258
+ * @param formData
1259
+ * @returns CourseCreationTaskFile
1260
+ * @throws ApiError
1261
+ */
1262
+ static aiMentorOrgsUsersCourseCreationFilesUpdate(id: number, org: string, userId: string, formData: CourseCreationTaskFile): CancelablePromise<CourseCreationTaskFile>;
1263
+ /**
1264
+ * Endpoint to fetch update and delete files associated with course creation tasks.
1265
+ * @param id A unique integer value identifying this course creation task file.
1266
+ * @param org
1267
+ * @param userId
1268
+ * @param formData
1269
+ * @returns CourseCreationTaskFile
1270
+ * @throws ApiError
1271
+ */
1272
+ static aiMentorOrgsUsersCourseCreationFilesPartialUpdate(id: number, org: string, userId: string, formData?: PatchedCourseCreationTaskFile): CancelablePromise<CourseCreationTaskFile>;
1273
+ /**
1274
+ * Endpoint to fetch update and delete files associated with course creation tasks.
1275
+ * @param id A unique integer value identifying this course creation task file.
1276
+ * @param org
1277
+ * @param userId
1278
+ * @returns void
1279
+ * @throws ApiError
1280
+ */
1281
+ static aiMentorOrgsUsersCourseCreationFilesDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
1282
+ /**
1283
+ * API viewset for managing course sections.
1284
+ *
1285
+ * This viewset allows platform administrators to retrieve and manage
1286
+ * sections within EdX courses.
1287
+ *
1288
+ * Permissions:
1289
+ * - Restricted to platform administrators only
1290
+ * @param org
1291
+ * @param userId
1292
+ * @param course
1293
+ * @param ordering Which field to use when ordering the results.
1294
+ * @param page A page number within the paginated result set.
1295
+ * @param pageSize Number of results to return per page.
1296
+ * @param search A search term.
1297
+ * @param task
1298
+ * @returns PaginatedSectionList
1299
+ * @throws ApiError
1300
+ */
1301
+ static aiMentorOrgsUsersCourseCreationSectionList(org: string, userId: string, course?: number, ordering?: string, page?: number, pageSize?: number, search?: string, task?: number): CancelablePromise<PaginatedSectionList>;
1302
+ /**
1303
+ * API viewset for managing course sections.
1304
+ *
1305
+ * This viewset allows platform administrators to retrieve and manage
1306
+ * sections within EdX courses.
1307
+ *
1308
+ * Permissions:
1309
+ * - Restricted to platform administrators only
1310
+ * @param org
1311
+ * @param userId
1312
+ * @param requestBody
1313
+ * @returns Section
1314
+ * @throws ApiError
1315
+ */
1316
+ static aiMentorOrgsUsersCourseCreationSectionCreate(org: string, userId: string, requestBody: Section): CancelablePromise<Section>;
1317
+ /**
1318
+ * API viewset for managing course sections.
1319
+ *
1320
+ * This viewset allows platform administrators to retrieve and manage
1321
+ * sections within EdX courses.
1322
+ *
1323
+ * Permissions:
1324
+ * - Restricted to platform administrators only
1325
+ * @param id A unique integer value identifying this section.
1326
+ * @param org
1327
+ * @param userId
1328
+ * @returns Section
1329
+ * @throws ApiError
1330
+ */
1331
+ static aiMentorOrgsUsersCourseCreationSectionRetrieve(id: number, org: string, userId: string): CancelablePromise<Section>;
1332
+ /**
1333
+ * API viewset for managing course sections.
1334
+ *
1335
+ * This viewset allows platform administrators to retrieve and manage
1336
+ * sections within EdX courses.
1337
+ *
1338
+ * Permissions:
1339
+ * - Restricted to platform administrators only
1340
+ * @param id A unique integer value identifying this section.
1341
+ * @param org
1342
+ * @param userId
1343
+ * @param requestBody
1344
+ * @returns Section
1345
+ * @throws ApiError
1346
+ */
1347
+ static aiMentorOrgsUsersCourseCreationSectionUpdate(id: number, org: string, userId: string, requestBody: Section): CancelablePromise<Section>;
1348
+ /**
1349
+ * API viewset for managing course sections.
1350
+ *
1351
+ * This viewset allows platform administrators to retrieve and manage
1352
+ * sections within EdX courses.
1353
+ *
1354
+ * Permissions:
1355
+ * - Restricted to platform administrators only
1356
+ * @param id A unique integer value identifying this section.
1357
+ * @param org
1358
+ * @param userId
1359
+ * @param requestBody
1360
+ * @returns Section
1361
+ * @throws ApiError
1362
+ */
1363
+ static aiMentorOrgsUsersCourseCreationSectionPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedSection): CancelablePromise<Section>;
1364
+ /**
1365
+ * API viewset for managing course sections.
1366
+ *
1367
+ * This viewset allows platform administrators to retrieve and manage
1368
+ * sections within EdX courses.
1369
+ *
1370
+ * Permissions:
1371
+ * - Restricted to platform administrators only
1372
+ * @param id A unique integer value identifying this section.
1373
+ * @param org
1374
+ * @param userId
1375
+ * @returns void
1376
+ * @throws ApiError
1377
+ */
1378
+ static aiMentorOrgsUsersCourseCreationSectionDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
1379
+ /**
1380
+ * API viewset for managing course subsections.
1381
+ *
1382
+ * This viewset allows platform administrators to retrieve and manage
1383
+ * subsections within course sections.
1384
+ *
1385
+ * Permissions:
1386
+ * - Restricted to platform administrators only
1387
+ * @param org
1388
+ * @param userId
1389
+ * @param course
1390
+ * @param ordering Which field to use when ordering the results.
1391
+ * @param page A page number within the paginated result set.
1392
+ * @param pageSize Number of results to return per page.
1393
+ * @param search A search term.
1394
+ * @param section
1395
+ * @param task
1396
+ * @returns PaginatedSubSectionList
1397
+ * @throws ApiError
1398
+ */
1399
+ static aiMentorOrgsUsersCourseCreationSubsectionList(org: string, userId: string, course?: number, ordering?: string, page?: number, pageSize?: number, search?: string, section?: number, task?: number): CancelablePromise<PaginatedSubSectionList>;
1400
+ /**
1401
+ * API viewset for managing course subsections.
1402
+ *
1403
+ * This viewset allows platform administrators to retrieve and manage
1404
+ * subsections within course sections.
1405
+ *
1406
+ * Permissions:
1407
+ * - Restricted to platform administrators only
1408
+ * @param org
1409
+ * @param userId
1410
+ * @param requestBody
1411
+ * @returns SubSection
1412
+ * @throws ApiError
1413
+ */
1414
+ static aiMentorOrgsUsersCourseCreationSubsectionCreate(org: string, userId: string, requestBody: SubSection): CancelablePromise<SubSection>;
1415
+ /**
1416
+ * API viewset for managing course subsections.
1417
+ *
1418
+ * This viewset allows platform administrators to retrieve and manage
1419
+ * subsections within course sections.
1420
+ *
1421
+ * Permissions:
1422
+ * - Restricted to platform administrators only
1423
+ * @param id A unique integer value identifying this sub section.
1424
+ * @param org
1425
+ * @param userId
1426
+ * @returns SubSection
1427
+ * @throws ApiError
1428
+ */
1429
+ static aiMentorOrgsUsersCourseCreationSubsectionRetrieve(id: number, org: string, userId: string): CancelablePromise<SubSection>;
1430
+ /**
1431
+ * API viewset for managing course subsections.
1432
+ *
1433
+ * This viewset allows platform administrators to retrieve and manage
1434
+ * subsections within course sections.
1435
+ *
1436
+ * Permissions:
1437
+ * - Restricted to platform administrators only
1438
+ * @param id A unique integer value identifying this sub section.
1439
+ * @param org
1440
+ * @param userId
1441
+ * @param requestBody
1442
+ * @returns SubSection
1443
+ * @throws ApiError
1444
+ */
1445
+ static aiMentorOrgsUsersCourseCreationSubsectionUpdate(id: number, org: string, userId: string, requestBody: SubSection): CancelablePromise<SubSection>;
1446
+ /**
1447
+ * API viewset for managing course subsections.
1448
+ *
1449
+ * This viewset allows platform administrators to retrieve and manage
1450
+ * subsections within course sections.
1451
+ *
1452
+ * Permissions:
1453
+ * - Restricted to platform administrators only
1454
+ * @param id A unique integer value identifying this sub section.
1455
+ * @param org
1456
+ * @param userId
1457
+ * @param requestBody
1458
+ * @returns SubSection
1459
+ * @throws ApiError
1460
+ */
1461
+ static aiMentorOrgsUsersCourseCreationSubsectionPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedSubSection): CancelablePromise<SubSection>;
1462
+ /**
1463
+ * API viewset for managing course subsections.
1464
+ *
1465
+ * This viewset allows platform administrators to retrieve and manage
1466
+ * subsections within course sections.
1467
+ *
1468
+ * Permissions:
1469
+ * - Restricted to platform administrators only
1470
+ * @param id A unique integer value identifying this sub section.
1471
+ * @param org
1472
+ * @param userId
1473
+ * @returns void
1474
+ * @throws ApiError
1475
+ */
1476
+ static aiMentorOrgsUsersCourseCreationSubsectionDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
1477
+ /**
1478
+ * Create, retrieve and delete course creation tasks
1479
+ *
1480
+ * Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
1481
+ *
1482
+ * The course is created entirely by an ai model (as specified in your inputs).
1483
+ *
1484
+ * The llm decides on the content of the course based on the name, description, target audience and other parameters.
1485
+ * Bigger and newer models tend to outperform smaller once.
1486
+ *
1487
+ * Clear and unambiguous parameters are more likely to produce better results.
1488
+ * @param org
1489
+ * @param userId
1490
+ * @param page A page number within the paginated result set.
1491
+ * @param pageSize Number of results to return per page.
1492
+ * @returns PaginatedCourseCreationTaskList
1493
+ * @throws ApiError
1494
+ */
1495
+ static aiMentorOrgsUsersCourseCreationTasksList2(org: string, userId: string, page?: number, pageSize?: number): CancelablePromise<PaginatedCourseCreationTaskList>;
1496
+ /**
1497
+ * Create, retrieve and delete course creation tasks
1498
+ *
1499
+ * Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
1500
+ *
1501
+ * The course is created entirely by an ai model (as specified in your inputs).
1502
+ *
1503
+ * The llm decides on the content of the course based on the name, description, target audience and other parameters.
1504
+ * Bigger and newer models tend to outperform smaller once.
1505
+ *
1506
+ * Clear and unambiguous parameters are more likely to produce better results.
1507
+ * @param org
1508
+ * @param userId
1509
+ * @param formData
1510
+ * @returns CourseCreationTask
1511
+ * @throws ApiError
1512
+ */
1513
+ static aiMentorOrgsUsersCourseCreationTasksCreate2(org: string, userId: string, formData: CourseCreationTask): CancelablePromise<CourseCreationTask>;
1514
+ /**
1515
+ * Create, retrieve and delete course creation tasks
1516
+ *
1517
+ * Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
1518
+ *
1519
+ * The course is created entirely by an ai model (as specified in your inputs).
1520
+ *
1521
+ * The llm decides on the content of the course based on the name, description, target audience and other parameters.
1522
+ * Bigger and newer models tend to outperform smaller once.
1523
+ *
1524
+ * Clear and unambiguous parameters are more likely to produce better results.
1525
+ * @param id A unique integer value identifying this course creation task.
1526
+ * @param org
1527
+ * @param userId
1528
+ * @returns CourseCreationTask
1529
+ * @throws ApiError
1530
+ */
1531
+ static aiMentorOrgsUsersCourseCreationTasksRetrieve2(id: number, org: string, userId: string): CancelablePromise<CourseCreationTask>;
1532
+ /**
1533
+ * Create, retrieve and delete course creation tasks
1534
+ *
1535
+ * Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
1536
+ *
1537
+ * The course is created entirely by an ai model (as specified in your inputs).
1538
+ *
1539
+ * The llm decides on the content of the course based on the name, description, target audience and other parameters.
1540
+ * Bigger and newer models tend to outperform smaller once.
1541
+ *
1542
+ * Clear and unambiguous parameters are more likely to produce better results.
1543
+ * @param id A unique integer value identifying this course creation task.
1544
+ * @param org
1545
+ * @param userId
1546
+ * @returns void
1547
+ * @throws ApiError
1548
+ */
1549
+ static aiMentorOrgsUsersCourseCreationTasksDestroy2(id: number, org: string, userId: string): CancelablePromise<void>;
1550
+ /**
1551
+ * Cancel a course creation task run.
1552
+ * ** Conditions Required **:
1553
+ * The task must be running or pending.
1554
+ * ** Response **:
1555
+ * - 200: The course creation task is successfully cancelled.
1556
+ * - 400: The course creation task is not in a running or pending state.
1557
+ * @param id A unique integer value identifying this course creation task.
1558
+ * @param org
1559
+ * @param userId
1560
+ * @returns CourseCreationTask
1561
+ * @throws ApiError
1562
+ */
1563
+ static aiMentorOrgsUsersCourseCreationTasksCancelRetrieve2(id: number, org: string, userId: string): CancelablePromise<CourseCreationTask>;
1564
+ /**
1565
+ * This is intended for stepwise approach of course creation.
1566
+ *
1567
+ * Use this to intiate generating an outline of the course.
1568
+ * @param id A unique integer value identifying this course creation task.
1569
+ * @param org
1570
+ * @param userId
1571
+ * @returns FullCourse
1572
+ * @throws ApiError
1573
+ */
1574
+ static aiMentorOrgsUsersCourseCreationTasksCreateCourseOutlineRetrieve2(id: number, org: string, userId: string): CancelablePromise<FullCourse>;
1575
+ /**
1576
+ * This is intended for stepwise approach of course creation.
1577
+ *
1578
+ * Use this to intiate generating an outline of the course.
1579
+ * @param id A unique integer value identifying this course creation task.
1580
+ * @param org
1581
+ * @param userId
1582
+ * @param formData
1583
+ * @returns FullCourse
1584
+ * @throws ApiError
1585
+ */
1586
+ static aiMentorOrgsUsersCourseCreationTasksCreateCourseOutlineCreate2(id: number, org: string, userId: string, formData: CourseCreationTask): CancelablePromise<FullCourse>;
1587
+ /**
1588
+ * Kick start the course creation task.
1589
+ * This endpoint should be called once the files for a course creation task has
1590
+ * been successfully uploaded.
1591
+ *
1592
+ * ** Conditions Required **:
1593
+ * - The course creation task must be in a pending state or failed state.
1594
+ *
1595
+ * ** Response **:
1596
+ * - 200: The course creation task is successfully started.
1597
+ * - 400: The course creation task is not in a pending state.
1598
+ * @param id A unique integer value identifying this course creation task.
1599
+ * @param org
1600
+ * @param userId
1601
+ * @returns CourseCreationTask
1602
+ * @throws ApiError
1603
+ */
1604
+ static aiMentorOrgsUsersCourseCreationTasksStartRetrieve2(id: number, org: string, userId: string): CancelablePromise<CourseCreationTask>;
1605
+ /**
1606
+ * API viewset for managing course units.
1607
+ *
1608
+ * This viewset allows platform administrators to retrieve and manage
1609
+ * units within course subsections, and generate content for them.
1610
+ *
1611
+ * Permissions:
1612
+ * - Restricted to platform administrators only
1613
+ * @param org
1614
+ * @param userId
1615
+ * @param course
1616
+ * @param ordering Which field to use when ordering the results.
1617
+ * @param page A page number within the paginated result set.
1618
+ * @param pageSize Number of results to return per page.
1619
+ * @param search A search term.
1620
+ * @param section
1621
+ * @param subsection
1622
+ * @param task
1623
+ * @returns PaginatedUnitList
1624
+ * @throws ApiError
1625
+ */
1626
+ static aiMentorOrgsUsersCourseCreationUnitList(org: string, userId: string, course?: number, ordering?: string, page?: number, pageSize?: number, search?: string, section?: number, subsection?: number, task?: number): CancelablePromise<PaginatedUnitList>;
1627
+ /**
1628
+ * API viewset for managing course units.
1629
+ *
1630
+ * This viewset allows platform administrators to retrieve and manage
1631
+ * units within course subsections, and generate content for them.
1632
+ *
1633
+ * Permissions:
1634
+ * - Restricted to platform administrators only
1635
+ * @param org
1636
+ * @param userId
1637
+ * @param requestBody
1638
+ * @returns Unit
1639
+ * @throws ApiError
1640
+ */
1641
+ static aiMentorOrgsUsersCourseCreationUnitCreate(org: string, userId: string, requestBody: Unit): CancelablePromise<Unit>;
1642
+ /**
1643
+ * API viewset for managing course units.
1644
+ *
1645
+ * This viewset allows platform administrators to retrieve and manage
1646
+ * units within course subsections, and generate content for them.
1647
+ *
1648
+ * Permissions:
1649
+ * - Restricted to platform administrators only
1650
+ * @param id A unique integer value identifying this unit.
1651
+ * @param org
1652
+ * @param userId
1653
+ * @returns Unit
1654
+ * @throws ApiError
1655
+ */
1656
+ static aiMentorOrgsUsersCourseCreationUnitRetrieve(id: number, org: string, userId: string): CancelablePromise<Unit>;
1657
+ /**
1658
+ * API viewset for managing course units.
1659
+ *
1660
+ * This viewset allows platform administrators to retrieve and manage
1661
+ * units within course subsections, and generate content for them.
1662
+ *
1663
+ * Permissions:
1664
+ * - Restricted to platform administrators only
1665
+ * @param id A unique integer value identifying this unit.
1666
+ * @param org
1667
+ * @param userId
1668
+ * @param requestBody
1669
+ * @returns Unit
1670
+ * @throws ApiError
1671
+ */
1672
+ static aiMentorOrgsUsersCourseCreationUnitUpdate(id: number, org: string, userId: string, requestBody: Unit): CancelablePromise<Unit>;
1673
+ /**
1674
+ * API viewset for managing course units.
1675
+ *
1676
+ * This viewset allows platform administrators to retrieve and manage
1677
+ * units within course subsections, and generate content for them.
1678
+ *
1679
+ * Permissions:
1680
+ * - Restricted to platform administrators only
1681
+ * @param id A unique integer value identifying this unit.
1682
+ * @param org
1683
+ * @param userId
1684
+ * @param requestBody
1685
+ * @returns Unit
1686
+ * @throws ApiError
1687
+ */
1688
+ static aiMentorOrgsUsersCourseCreationUnitPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedUnit): CancelablePromise<Unit>;
1689
+ /**
1690
+ * API viewset for managing course units.
1691
+ *
1692
+ * This viewset allows platform administrators to retrieve and manage
1693
+ * units within course subsections, and generate content for them.
1694
+ *
1695
+ * Permissions:
1696
+ * - Restricted to platform administrators only
1697
+ * @param id A unique integer value identifying this unit.
1698
+ * @param org
1699
+ * @param userId
1700
+ * @returns void
1701
+ * @throws ApiError
1702
+ */
1703
+ static aiMentorOrgsUsersCourseCreationUnitDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
1704
+ /**
1705
+ * Generate draft content for a specific unit.
1706
+ *
1707
+ * This action starts a background task to create draft content
1708
+ * for the specified unit using AI.
1709
+ *
1710
+ * Args:
1711
+ * request: The HTTP request.
1712
+ * pk: The primary key of the unit to generate content for.
1713
+ *
1714
+ * Returns:
1715
+ * Response: A confirmation that the content generation task has been started.
1716
+ *
1717
+ * Raises:
1718
+ * NotFound: If the specified unit does not exist.
1719
+ * @param id A unique integer value identifying this unit.
1720
+ * @param org
1721
+ * @param userId
1722
+ * @returns any Content creation started successfully
1723
+ * @throws ApiError
1724
+ */
1725
+ static aiMentorOrgsUsersCourseCreationUnitDraftContentRetrieve(id: number, org: string, userId: string): CancelablePromise<any>;
1726
+ /**
1727
+ * Generate draft content for a specific unit.
1728
+ *
1729
+ * This action starts a background task to create draft content
1730
+ * for the specified unit using AI.
1731
+ *
1732
+ * Args:
1733
+ * request: The HTTP request.
1734
+ * pk: The primary key of the unit to generate content for.
1735
+ *
1736
+ * Returns:
1737
+ * Response: A confirmation that the content generation task has been started.
1738
+ *
1739
+ * Raises:
1740
+ * NotFound: If the specified unit does not exist.
1741
+ * @param id A unique integer value identifying this unit.
1742
+ * @param org
1743
+ * @param userId
1744
+ * @param requestBody
1745
+ * @returns any Content creation started successfully
1746
+ * @throws ApiError
1747
+ */
1748
+ static aiMentorOrgsUsersCourseCreationUnitDraftContentCreate(id: number, org: string, userId: string, requestBody: Unit): CancelablePromise<any>;
1749
+ /**
1750
+ * Create a new mentor using the wizard interface.
1751
+ *
1752
+ * Args:
1753
+ * request: The HTTP request containing the mentor data.
1754
+ * org: The organization/tenant identifier.
1755
+ * user_id: The ID of the user creating the mentor.
1756
+ *
1757
+ * Returns:
1758
+ * Response: The created mentor.
1759
+ *
1760
+ * Raises:
1761
+ * BadRequest: If the provided data is invalid.
1762
+ * @param org
1763
+ * @param userId
1764
+ * @param requestBody
1765
+ * @returns Mentor
1766
+ * @throws ApiError
1767
+ */
1768
+ static aiMentorOrgsUsersCreateMentorWizardCreate(org: string, userId: string, requestBody: MentorWizard): CancelablePromise<Mentor>;
1769
+ /**
1770
+ * Retrieve custom instructions for a specific user.
1771
+ *
1772
+ * Args:
1773
+ * request: The HTTP request.
1774
+ * org: The organization/tenant identifier.
1775
+ * user_id: The ID of the user to retrieve custom instructions for.
1776
+ *
1777
+ * Returns:
1778
+ * Response: The custom instructions for the user.
1779
+ *
1780
+ * Raises:
1781
+ * NotFound: If no custom instructions exist for the user.
1782
+ * @param org
1783
+ * @param userId
1784
+ * @returns CustomInstructionResponse
1785
+ * @throws ApiError
1786
+ */
1787
+ static aiMentorOrgsUsersCustomInstructionRetrieve(org: string, userId: string): CancelablePromise<CustomInstructionResponse>;
1788
+ /**
1789
+ * Create a new custom instruction for a user.
1790
+ *
1791
+ * Args:
1792
+ * request: The HTTP request containing the custom instruction data.
1793
+ * org: The organization/tenant identifier.
1794
+ * user_id: The ID of the user to create custom instructions for.
1795
+ *
1796
+ * Returns:
1797
+ * Response: The created custom instruction.
1798
+ *
1799
+ * Raises:
1800
+ * BadRequest: If the provided data is invalid.
1801
+ * @param org
1802
+ * @param userId
1803
+ * @param requestBody
1804
+ * @returns CustomInstructionResponse
1805
+ * @throws ApiError
1806
+ */
1807
+ static aiMentorOrgsUsersCustomInstructionCreate(org: string, userId: string, requestBody?: CustomInstructionResponse): CancelablePromise<CustomInstructionResponse>;
1808
+ /**
1809
+ * Update an existing custom instruction for a user.
1810
+ *
1811
+ * Args:
1812
+ * request: The HTTP request containing the updated custom instruction data.
1813
+ * org: The organization/tenant identifier.
1814
+ * user_id: The ID of the user to update custom instructions for.
1815
+ *
1816
+ * Returns:
1817
+ * Response: The updated custom instruction.
1818
+ *
1819
+ * Raises:
1820
+ * BadRequest: If the provided data is invalid.
1821
+ * NotFound: If no custom instruction exists for the user.
1822
+ * @param org
1823
+ * @param userId
1824
+ * @param requestBody
1825
+ * @returns CustomInstructionResponse
1826
+ * @throws ApiError
1827
+ */
1828
+ static aiMentorOrgsUsersCustomInstructionUpdate(org: string, userId: string, requestBody?: CustomInstructionResponse): CancelablePromise<CustomInstructionResponse>;
1829
+ /**
1830
+ * Retrieves the chat history for a user if the export task is ready.
1831
+ *
1832
+ * This Endpoint to download user chathistory.
1833
+ *
1834
+ * Accessible to tenant admins and students.
1835
+ *
1836
+ * Returns:
1837
+ *
1838
+ * 200: When task is not ready.
1839
+ *
1840
+ * 200: chat history object
1841
+ *
1842
+ * 400: When data is not valid.
1843
+ * @param org
1844
+ * @param taskId
1845
+ * @param userId
1846
+ * @param toCsv Choose download in csv or not
1847
+ * @returns ChatHistoryItem
1848
+ * @throws ApiError
1849
+ */
1850
+ static aiMentorOrgsUsersDownloadsTasksRetrieve(org: string, taskId: string, userId: string, toCsv?: boolean): CancelablePromise<ChatHistoryItem>;
1851
+ /**
1852
+ * Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with.
1853
+ * This information is passed to the corresponding mentor so the mentor has context information
1854
+ * about the course and unit that the user last interracted with.
1855
+ *
1856
+ * There can be only one UserEdxMemory instance per student and course_id.
1857
+ *
1858
+ * Url Args:
1859
+ * org (str): The organization's platform key.
1860
+ * user_id (str): The username identifier of the individual.
1861
+ *
1862
+ * Returns:
1863
+ *
1864
+ * 200: A paginated list of UserEdxMemory objects
1865
+ *
1866
+ * Examples:
1867
+ *
1868
+ * - List all memories
1869
+ * GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/
1870
+ *
1871
+ * Request: None
1872
+ * Response: {
1873
+ * "count": 0,
1874
+ * "next": null,
1875
+ * "previous": null,
1876
+ * "results": [{
1877
+ * "student": 1,
1878
+ * "course_id": "course-v1:main+CARBON+2024_Fall",
1879
+ * "data": {},
1880
+ * "date_created": "2024-06-25T15:30:26.257140",
1881
+ * "last_modified": "2024-06-25T15:30:26.257140"
1882
+ * }]
1883
+ * }
1884
+ * - Get a single UserEdxMemory object
1885
+ * GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/
1886
+ *
1887
+ * Request: None
1888
+ * Response: {
1889
+ * "student": 1,
1890
+ * "course_id": "course-v1:main+CARBON+2024_Fall",
1891
+ * "data": {},
1892
+ * "date_created": "2024-06-25T15:30:26.257140",
1893
+ * "last_modified": "2024-06-25T15:30:26.257140"
1894
+ * }
1895
+ * @param org
1896
+ * @param userId
1897
+ * @param courseId
1898
+ * @param ordering Which field to use when ordering the results.
1899
+ * @param page A page number within the paginated result set.
1900
+ * @param pageSize Number of results to return per page.
1901
+ * @param student edX user ID
1902
+ * @param username
1903
+ * @returns PaginatedUserEdxMemoryList
1904
+ * @throws ApiError
1905
+ */
1906
+ static aiMentorOrgsUsersEdxMemoryList(org: string, userId: string, courseId?: string, ordering?: string, page?: number, pageSize?: number, student?: number, username?: string): CancelablePromise<PaginatedUserEdxMemoryList>;
1907
+ /**
1908
+ * Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with.
1909
+ * This information is passed to the corresponding mentor so the mentor has context information
1910
+ * about the course and unit that the user last interracted with.
1911
+ *
1912
+ * There can be only one UserEdxMemory instance per student and course_id.
1913
+ *
1914
+ * Url Args:
1915
+ * org (str): The organization's platform key.
1916
+ * user_id (str): The username identifier of the individual.
1917
+ *
1918
+ * Returns:
1919
+ *
1920
+ * 200: A paginated list of UserEdxMemory objects
1921
+ *
1922
+ * Examples:
1923
+ *
1924
+ * - List all memories
1925
+ * GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/
1926
+ *
1927
+ * Request: None
1928
+ * Response: {
1929
+ * "count": 0,
1930
+ * "next": null,
1931
+ * "previous": null,
1932
+ * "results": [{
1933
+ * "student": 1,
1934
+ * "course_id": "course-v1:main+CARBON+2024_Fall",
1935
+ * "data": {},
1936
+ * "date_created": "2024-06-25T15:30:26.257140",
1937
+ * "last_modified": "2024-06-25T15:30:26.257140"
1938
+ * }]
1939
+ * }
1940
+ * - Get a single UserEdxMemory object
1941
+ * GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/
1942
+ *
1943
+ * Request: None
1944
+ * Response: {
1945
+ * "student": 1,
1946
+ * "course_id": "course-v1:main+CARBON+2024_Fall",
1947
+ * "data": {},
1948
+ * "date_created": "2024-06-25T15:30:26.257140",
1949
+ * "last_modified": "2024-06-25T15:30:26.257140"
1950
+ * }
1951
+ * @param id A unique integer value identifying this user edx memory.
1952
+ * @param org
1953
+ * @param userId
1954
+ * @returns UserEdxMemory
1955
+ * @throws ApiError
1956
+ */
1957
+ static aiMentorOrgsUsersEdxMemoryRetrieve(id: number, org: string, userId: string): CancelablePromise<UserEdxMemory>;
1958
+ /**
1959
+ * Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with.
1960
+ * This information is passed to the corresponding mentor so the mentor has context information
1961
+ * about the course and unit that the user last interracted with.
1962
+ *
1963
+ * There can be only one UserEdxMemory instance per student and course_id.
1964
+ *
1965
+ * Url Args:
1966
+ * org (str): The organization's platform key.
1967
+ * user_id (str): The username identifier of the individual.
1968
+ *
1969
+ * Returns:
1970
+ *
1971
+ * 200: A paginated list of UserEdxMemory objects
1972
+ *
1973
+ * Examples:
1974
+ *
1975
+ * - List all memories
1976
+ * GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/
1977
+ *
1978
+ * Request: None
1979
+ * Response: {
1980
+ * "count": 0,
1981
+ * "next": null,
1982
+ * "previous": null,
1983
+ * "results": [{
1984
+ * "student": 1,
1985
+ * "course_id": "course-v1:main+CARBON+2024_Fall",
1986
+ * "data": {},
1987
+ * "date_created": "2024-06-25T15:30:26.257140",
1988
+ * "last_modified": "2024-06-25T15:30:26.257140"
1989
+ * }]
1990
+ * }
1991
+ * - Get a single UserEdxMemory object
1992
+ * GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/
1993
+ *
1994
+ * Request: None
1995
+ * Response: {
1996
+ * "student": 1,
1997
+ * "course_id": "course-v1:main+CARBON+2024_Fall",
1998
+ * "data": {},
1999
+ * "date_created": "2024-06-25T15:30:26.257140",
2000
+ * "last_modified": "2024-06-25T15:30:26.257140"
2001
+ * }
2002
+ * @param id A unique integer value identifying this user edx memory.
2003
+ * @param org
2004
+ * @param userId
2005
+ * @returns void
2006
+ * @throws ApiError
2007
+ */
2008
+ static aiMentorOrgsUsersEdxMemoryDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
2009
+ /**
2010
+ * Retrieve a list of Elevenlabs voices available to a user.
2011
+ *
2012
+ * This endpoint returns both custom voices created by the user
2013
+ * and premade voices available to all users.
2014
+ *
2015
+ * Args:
2016
+ * request: The HTTP request.
2017
+ * org: The organization/tenant identifier.
2018
+ * user_id: The ID of the user to retrieve voices for.
2019
+ *
2020
+ * Returns:
2021
+ * Response: A list of available Elevenlabs voices.
2022
+ *
2023
+ * Raises:
2024
+ * NotFound: If the specified user does not exist.
2025
+ * @param org
2026
+ * @param userId
2027
+ * @returns ElevenlabsCustomVoiceResponse
2028
+ * @throws ApiError
2029
+ */
2030
+ static aiMentorOrgsUsersElevenlabsVoiceList(org: string, userId: string): CancelablePromise<Array<ElevenlabsCustomVoiceResponse>>;
2031
+ /**
2032
+ * Create a new custom Elevenlabs voice.
2033
+ *
2034
+ * This endpoint allows users to upload audio files to create a custom voice
2035
+ * that can be used with the Elevenlabs text-to-speech service.
2036
+ *
2037
+ * Note: The audio files' total length should be longer than 1 minute and
2038
+ * the total size should be smaller than 11 MiB.
2039
+ *
2040
+ * Args:
2041
+ * request: The HTTP request containing the voice name and audio files.
2042
+ * org: The organization/tenant identifier.
2043
+ * user_id: The ID of the user creating the voice.
2044
+ *
2045
+ * Returns:
2046
+ * Response: The created voice configuration.
2047
+ *
2048
+ * Raises:
2049
+ * BadRequest: If the provided data is invalid, credentials are not found, or there's an API error.
2050
+ * @param org
2051
+ * @param userId
2052
+ * @param formData
2053
+ * @returns ElevenlabsCustomVoiceResponse
2054
+ * @throws ApiError
2055
+ */
2056
+ static aiMentorOrgsUsersElevenlabsVoiceCreate(org: string, userId: string, formData: ElevenlabsCustomVoice): CancelablePromise<ElevenlabsCustomVoiceResponse>;
2057
+ /**
2058
+ * Delete an existing Elevenlabs voice configuration.
2059
+ *
2060
+ * This endpoint removes a custom voice configuration both from the local database
2061
+ * and from the Elevenlabs remote API if applicable.
2062
+ *
2063
+ * Args:
2064
+ * request: The HTTP request.
2065
+ * org: The organization/tenant identifier.
2066
+ * user_id: The ID of the user who owns the voice.
2067
+ * voice_name: The name of the voice to delete.
2068
+ *
2069
+ * Returns:
2070
+ * Response: A confirmation of the deletion.
2071
+ *
2072
+ * Raises:
2073
+ * BadRequest: If the Elevenlabs credentials are not found or there's an API error.
2074
+ * @param org
2075
+ * @param userId
2076
+ * @param voiceName
2077
+ * @returns any Voice successfully deleted
2078
+ * @throws ApiError
2079
+ */
2080
+ static aiMentorOrgsUsersElevenlabsVoiceDestroy(org: string, userId: string, voiceName: string): CancelablePromise<any>;
2081
+ /**
2082
+ * Initiates a background task to export the user's chat history.
2083
+ *
2084
+ * Returns:
2085
+ *
2086
+ * 200: task id.
2087
+ * @param org
2088
+ * @param userId
2089
+ * @returns TaskView
2090
+ * @throws ApiError
2091
+ */
2092
+ static aiMentorOrgsUsersExportChathistoryCreate(org: string, userId: string): CancelablePromise<TaskView>;
2093
+ /**
2094
+ * Retrieve the count of free usage credits available to a user.
2095
+ *
2096
+ * Args:
2097
+ * request: The HTTP request.
2098
+ * org: The organization/tenant identifier.
2099
+ * user_id: The ID of the user to check free usage for.
2100
+ *
2101
+ * Returns:
2102
+ * Response: The count of free usage credits available.
2103
+ *
2104
+ * Raises:
2105
+ * NotFound: If the specified user does not exist.
2106
+ * @param org
2107
+ * @param userId
2108
+ * @returns FreeUsageCount
2109
+ * @throws ApiError
2110
+ */
2111
+ static aiMentorOrgsUsersFreeUsageCountRetrieve(org: string, userId: string): CancelablePromise<FreeUsageCount>;
2112
+ /**
2113
+ * List all MCP servers.
2114
+ *
2115
+ * Returns a paginated list of MCP servers that can be filtered by platform
2116
+ * and searched by name or URL.
2117
+ * @param org
2118
+ * @param userId
2119
+ * @param page A page number within the paginated result set.
2120
+ * @param pageSize Number of results to return per page.
2121
+ * @param platform
2122
+ * @param search A search term.
2123
+ * @returns PaginatedMCPServerList
2124
+ * @throws ApiError
2125
+ */
2126
+ static aiMentorOrgsUsersMcpServersList(org: string, userId: string, page?: number, pageSize?: number, platform?: number, search?: string): CancelablePromise<PaginatedMCPServerList>;
2127
+ /**
2128
+ * ViewSet for MCP Servers.
2129
+ *
2130
+ * Allows platform admins to list, create, retrieve, update, and delete MCP servers.
2131
+ *
2132
+ * Permissions:
2133
+ * - Accessible to tenant admins.
2134
+ * @param org
2135
+ * @param userId
2136
+ * @param requestBody
2137
+ * @returns MCPServer
2138
+ * @throws ApiError
2139
+ */
2140
+ static aiMentorOrgsUsersMcpServersCreate(org: string, userId: string, requestBody: MCPServer): CancelablePromise<MCPServer>;
2141
+ /**
2142
+ * ViewSet for MCP Servers.
2143
+ *
2144
+ * Allows platform admins to list, create, retrieve, update, and delete MCP servers.
2145
+ *
2146
+ * Permissions:
2147
+ * - Accessible to tenant admins.
2148
+ * @param id A unique integer value identifying this mcp server.
2149
+ * @param org
2150
+ * @param userId
2151
+ * @returns MCPServer
2152
+ * @throws ApiError
2153
+ */
2154
+ static aiMentorOrgsUsersMcpServersRetrieve(id: number, org: string, userId: string): CancelablePromise<MCPServer>;
2155
+ /**
2156
+ * ViewSet for MCP Servers.
2157
+ *
2158
+ * Allows platform admins to list, create, retrieve, update, and delete MCP servers.
2159
+ *
2160
+ * Permissions:
2161
+ * - Accessible to tenant admins.
2162
+ * @param id A unique integer value identifying this mcp server.
2163
+ * @param org
2164
+ * @param userId
2165
+ * @param requestBody
2166
+ * @returns MCPServer
2167
+ * @throws ApiError
2168
+ */
2169
+ static aiMentorOrgsUsersMcpServersUpdate(id: number, org: string, userId: string, requestBody: MCPServer): CancelablePromise<MCPServer>;
2170
+ /**
2171
+ * ViewSet for MCP Servers.
2172
+ *
2173
+ * Allows platform admins to list, create, retrieve, update, and delete MCP servers.
2174
+ *
2175
+ * Permissions:
2176
+ * - Accessible to tenant admins.
2177
+ * @param id A unique integer value identifying this mcp server.
2178
+ * @param org
2179
+ * @param userId
2180
+ * @param requestBody
2181
+ * @returns MCPServer
2182
+ * @throws ApiError
2183
+ */
2184
+ static aiMentorOrgsUsersMcpServersPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedMCPServer): CancelablePromise<MCPServer>;
2185
+ /**
2186
+ * ViewSet for MCP Servers.
2187
+ *
2188
+ * Allows platform admins to list, create, retrieve, update, and delete MCP servers.
2189
+ *
2190
+ * Permissions:
2191
+ * - Accessible to tenant admins.
2192
+ * @param id A unique integer value identifying this mcp server.
2193
+ * @param org
2194
+ * @param userId
2195
+ * @returns void
2196
+ * @throws ApiError
2197
+ */
2198
+ static aiMentorOrgsUsersMcpServersDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
2199
+ /**
2200
+ * Retrieve details of a specific user chat feedback entry.
2201
+ *
2202
+ * Args:
2203
+ * request: The HTTP request.
2204
+ * org: The organization/tenant identifier.
2205
+ * feedback_id: The ID of the feedback entry to retrieve.
2206
+ *
2207
+ * Returns:
2208
+ * Response: The feedback entry details.
2209
+ *
2210
+ * Raises:
2211
+ * NotFound: If the specified feedback entry does not exist.
2212
+ * @param feedbackId
2213
+ * @param org
2214
+ * @param userId
2215
+ * @returns UserChatFeedback
2216
+ * @throws ApiError
2217
+ */
2218
+ static aiMentorOrgsUsersMentorFeedbackRetrieve(feedbackId: number, org: string, userId: string): CancelablePromise<UserChatFeedback>;
2219
+ /**
2220
+ * Update an existing user chat feedback entry.
2221
+ *
2222
+ * Args:
2223
+ * request: The HTTP request containing the updated feedback data.
2224
+ * org: The organization/tenant identifier.
2225
+ * feedback_id: The ID of the feedback entry to update.
2226
+ *
2227
+ * Returns:
2228
+ * Response: The updated feedback entry.
2229
+ *
2230
+ * Raises:
2231
+ * NotFound: If the specified feedback entry does not exist.
2232
+ * BadRequest: If the provided data is invalid or the mentor does not exist.
2233
+ * @param feedbackId
2234
+ * @param org
2235
+ * @param userId
2236
+ * @param requestBody
2237
+ * @returns UserChatFeedback
2238
+ * @throws ApiError
2239
+ */
2240
+ static aiMentorOrgsUsersMentorFeedbackUpdate(feedbackId: number, org: string, userId: string, requestBody: UserChatFeedback): CancelablePromise<UserChatFeedback>;
2241
+ /**
2242
+ * Create a new user chat feedback entry.
2243
+ *
2244
+ * Args:
2245
+ * request: The HTTP request containing the feedback data.
2246
+ * org: The organization/tenant identifier.
2247
+ *
2248
+ * Returns:
2249
+ * Response: The created feedback entry.
2250
+ *
2251
+ * Raises:
2252
+ * BadRequest: If the provided data is invalid or the mentor does not exist.
2253
+ * @param org
2254
+ * @param userId
2255
+ * @param requestBody
2256
+ * @returns UserChatFeedback
2257
+ * @throws ApiError
2258
+ */
2259
+ static aiMentorOrgsUsersMentorFeedbackCreateCreate(org: string, userId: string, requestBody: UserChatFeedback): CancelablePromise<UserChatFeedback>;
2260
+ /**
2261
+ * View to create a mentor from a template
2262
+ *
2263
+ * Accessible to only tenant admins.
2264
+ * @param org
2265
+ * @param userId
2266
+ * @param requestBody
2267
+ * @returns Mentor
2268
+ * @throws ApiError
2269
+ */
2270
+ static aiMentorOrgsUsersMentorFromTemplateCreate(org: string, userId: string, requestBody: MentorFromTemplateRequest): CancelablePromise<Mentor>;
2271
+ /**
2272
+ * Retrieve available LLMs for a user.
2273
+ * @param org
2274
+ * @param userId
2275
+ * @returns LLMResponse
2276
+ * @throws ApiError
2277
+ */
2278
+ static aiMentorOrgsUsersMentorLlmsList(org: string, userId: string): CancelablePromise<Array<LLMResponse>>;
2279
+ /**
2280
+ * Retrieve the list of available mentor tools.
2281
+ * @param org
2282
+ * @param userId
2283
+ * @returns ToolResponse
2284
+ * @throws ApiError
2285
+ */
2286
+ static aiMentorOrgsUsersMentorToolsList(org: string, userId: string): CancelablePromise<Array<ToolResponse>>;
2287
+ /**
2288
+ * View to create a mentor from a template with settings.
2289
+ *
2290
+ * Accessible to tenant admins only.
2291
+ * @param org
2292
+ * @param userId
2293
+ * @param formData
2294
+ * @returns Mentor
2295
+ * @throws ApiError
2296
+ */
2297
+ static aiMentorOrgsUsersMentorWithSettingsCreate(org: string, userId: string, formData: MentorFromTemplateWithSettingRequest): CancelablePromise<Mentor>;
2298
+ /**
2299
+ * Retrieve the list of mentor audiences.
2300
+ *
2301
+ * Returns:
2302
+ * - 200: List of mentor audiences.
2303
+ * @param org
2304
+ * @param userId
2305
+ * @returns MentorAudience
2306
+ * @throws ApiError
2307
+ */
2308
+ static aiMentorOrgsUsersMentorAudienceList(org: string, userId: string): CancelablePromise<Array<MentorAudience>>;
2309
+ /**
2310
+ * Create a new mentor audience.
2311
+ *
2312
+ * Accessible to tenant admins only.
2313
+ *
2314
+ * Returns:
2315
+ * - 201: Created mentor audience.
2316
+ * - 401: Unauthorized.
2317
+ * @param org
2318
+ * @param userId
2319
+ * @param requestBody
2320
+ * @returns MentorAudience
2321
+ * @throws ApiError
2322
+ */
2323
+ static aiMentorOrgsUsersMentorAudienceCreate(org: string, userId: string, requestBody: MentorAudience): CancelablePromise<MentorAudience>;
2324
+ /**
2325
+ * Delete a mentor audience.
2326
+ *
2327
+ * Accessible to tenant admins only.
2328
+ *
2329
+ * Returns:
2330
+ * - 204: No content.
2331
+ * - 400: Bad request if audience name is missing.
2332
+ * - 404: Not found if audience does not exist.
2333
+ * - 401: Unauthorized.
2334
+ * @param org
2335
+ * @param userId
2336
+ * @returns void
2337
+ * @throws ApiError
2338
+ */
2339
+ static aiMentorOrgsUsersMentorAudienceDestroy(org: string, userId: string): CancelablePromise<void>;
2340
+ /**
2341
+ * Retrieve a list of mentor categories.
2342
+ *
2343
+ * Returns:
2344
+ * 200: A list of mentor categories.
2345
+ * @param org
2346
+ * @param userId
2347
+ * @returns MentorCategory
2348
+ * @throws ApiError
2349
+ */
2350
+ static aiMentorOrgsUsersMentorCategoriesList(org: string, userId: string): CancelablePromise<Array<MentorCategory>>;
2351
+ /**
2352
+ * Create a new mentor category.
2353
+ *
2354
+ * Accessible only to tenant admins.
2355
+ *
2356
+ * Returns:
2357
+ * 200: Details of the created mentor category.
2358
+ * @param org
2359
+ * @param userId
2360
+ * @param requestBody
2361
+ * @returns MentorCategory
2362
+ * @throws ApiError
2363
+ */
2364
+ static aiMentorOrgsUsersMentorCategoriesCreate(org: string, userId: string, requestBody: MentorCategoryCreate): CancelablePromise<MentorCategory>;
2365
+ /**
2366
+ * Delete a mentor category.
2367
+ *
2368
+ * Accessible only to tenant admins.
2369
+ *
2370
+ * Returns:
2371
+ * 204: "No content" when Delete succeeded.
2372
+ * 400: Bad request data received
2373
+ * @param org
2374
+ * @param userId
2375
+ * @returns void
2376
+ * @throws ApiError
2377
+ */
2378
+ static aiMentorOrgsUsersMentorCategoriesDestroy(org: string, userId: string): CancelablePromise<void>;
2379
+ /**
2380
+ * Seed initial mentors in a tenant.
2381
+ *
2382
+ * Args:
2383
+ * request: The HTTP request.
2384
+ * org: The organization/tenant identifier.
2385
+ * user_id: The ID of the user initiating the seeding.
2386
+ *
2387
+ * Returns:
2388
+ * Response: A success message with details about the seeded mentors.
2389
+ *
2390
+ * Raises:
2391
+ * BadRequest: If the seeding process fails.
2392
+ * @param org
2393
+ * @param userId
2394
+ * @returns SeedMentorsView
2395
+ * @throws ApiError
2396
+ */
2397
+ static aiMentorOrgsUsersMentorSeedRetrieve(org: string, userId: string): CancelablePromise<SeedMentorsView>;
2398
+ /**
2399
+ * Retrieve details of a specific mentor by slug or name.
2400
+ * @param mentor
2401
+ * @param org
2402
+ * @param userId
2403
+ * @returns Mentor
2404
+ * @throws ApiError
2405
+ */
2406
+ static aiMentorOrgsUsersMentorsRetrieve(mentor: string, org: string, userId: string): CancelablePromise<Mentor>;
2407
+ /**
2408
+ * Retrieve tools available for a particular mentor.
2409
+ * @param mentor
2410
+ * @param org
2411
+ * @param userId
2412
+ * @returns ToolResponse
2413
+ * @throws ApiError
2414
+ */
2415
+ static aiMentorOrgsUsersMentorsAvailableToolsList(mentor: string, org: string, userId: string): CancelablePromise<Array<ToolResponse>>;
2416
+ /**
2417
+ * Generate IBL Call Pro authentication parameters for audio calls.
2418
+ *
2419
+ * This endpoint creates the necessary authentication tokens and parameters
2420
+ * for connecting to a IBL Call Pro room for audio communication with a mentor.
2421
+ *
2422
+ * Args:
2423
+ * request: The HTTP request object containing the required parameters.
2424
+ * org: The organization/tenant identifier.
2425
+ * user_id: The ID of the user requesting authentication.
2426
+ *
2427
+ * Returns:
2428
+ * Response: IBL Call Pro authentication parameters including URL, room name,
2429
+ * participant name, and authentication token.
2430
+ *
2431
+ * Raises:
2432
+ * ValidationError: If the request parameters are invalid.
2433
+ * BadRequest: If the IBL Call Pro credentials are not properly configured.
2434
+ * @param mentor
2435
+ * @param org
2436
+ * @param userId
2437
+ * @param requestBody
2438
+ * @returns CallAuthenticationResponse
2439
+ * @throws ApiError
2440
+ */
2441
+ static aiMentorOrgsUsersMentorsCreateCallCredentialsCreate(mentor: string, org: string, userId: string, requestBody: CallAuthenticationRequest): CancelablePromise<CallAuthenticationResponse>;
2442
+ /**
2443
+ * Retrieve memory components for a specific mentor.
2444
+ *
2445
+ * Args:
2446
+ * request: The HTTP request.
2447
+ * org: The organization/tenant identifier.
2448
+ * user_id: The ID of the user making the request.
2449
+ * mentor: The identifier of the mentor to retrieve memory for.
2450
+ *
2451
+ * Returns:
2452
+ * Response: The memory components for the mentor.
2453
+ *
2454
+ * Raises:
2455
+ * NotFound: If the specified mentor or memory does not exist.
2456
+ * @param mentor
2457
+ * @param org
2458
+ * @param userId
2459
+ * @returns MemoryComponentResponse
2460
+ * @throws ApiError
2461
+ */
2462
+ static aiMentorOrgsUsersMentorsCurrentMemoryRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MemoryComponentResponse>;
2463
+ /**
2464
+ * Update memory components for a specific mentor.
2465
+ *
2466
+ * Args:
2467
+ * request: The HTTP request containing the updated memory data.
2468
+ * org: The organization/tenant identifier.
2469
+ * user_id: The ID of the user making the request.
2470
+ * mentor: The identifier of the mentor to update memory for.
2471
+ *
2472
+ * Returns:
2473
+ * Response: The updated memory components for the mentor.
2474
+ *
2475
+ * Raises:
2476
+ * BadRequest: If the provided data is invalid.
2477
+ * NotFound: If the specified mentor does not exist.
2478
+ * @param mentor
2479
+ * @param org
2480
+ * @param userId
2481
+ * @param requestBody
2482
+ * @returns QuestionResponse
2483
+ * @throws ApiError
2484
+ */
2485
+ static aiMentorOrgsUsersMentorsCurrentMemoryUpdate(mentor: string, org: string, userId: string, requestBody: QuestionRequest): CancelablePromise<QuestionResponse>;
2486
+ /**
2487
+ * Retrieve the current custom voice settings for a mentor.
2488
+ *
2489
+ * Args:
2490
+ * request: The HTTP request.
2491
+ * org: The organization/tenant identifier.
2492
+ * user_id: The ID of the user who owns the mentor link.
2493
+ * mentor: The unique identifier of the mentor.
2494
+ *
2495
+ * Returns:
2496
+ * Response: The current custom voice settings.
2497
+ *
2498
+ * Raises:
2499
+ * NotFound: If the specified mentor or student does not exist.
2500
+ * @param mentor
2501
+ * @param org
2502
+ * @param userId
2503
+ * @returns MentorCustomVoiceResponse
2504
+ * @throws ApiError
2505
+ */
2506
+ static aiMentorOrgsUsersMentorsCustomVoiceRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MentorCustomVoiceResponse>;
2507
+ /**
2508
+ * Set a custom voice for a mentor.
2509
+ *
2510
+ * This endpoint allows setting a custom voice for a specific mentor,
2511
+ * either using the default voice provider or Elevenlabs.
2512
+ *
2513
+ * Args:
2514
+ * request: The HTTP request containing the voice provider and name.
2515
+ * org: The organization/tenant identifier.
2516
+ * user_id: The ID of the user who owns the mentor link.
2517
+ * mentor: The unique identifier of the mentor.
2518
+ *
2519
+ * Returns:
2520
+ * Response: The updated custom voice settings.
2521
+ *
2522
+ * Raises:
2523
+ * BadRequest: If the provided data is invalid or the voice does not exist.
2524
+ * NotFound: If the mentor or student does not exist.
2525
+ * @param mentor
2526
+ * @param org
2527
+ * @param userId
2528
+ * @param requestBody
2529
+ * @returns MentorCustomVoiceResponse
2530
+ * @throws ApiError
2531
+ */
2532
+ static aiMentorOrgsUsersMentorsCustomVoiceCreate(mentor: string, org: string, userId: string, requestBody: MentorCustomVoice): CancelablePromise<MentorCustomVoiceResponse>;
2533
+ /**
2534
+ * Generate audio from text using a mentor's custom voice.
2535
+ *
2536
+ * This endpoint converts the provided text to speech using the
2537
+ * custom voice configured for the specified mentor.
2538
+ *
2539
+ * Args:
2540
+ * request: The HTTP request containing the text to convert.
2541
+ * org: The organization/tenant identifier.
2542
+ * user_id: The ID of the user who owns the mentor link.
2543
+ * mentor: The unique identifier of the mentor.
2544
+ *
2545
+ * Returns:
2546
+ * Response: An MP3 audio file of the synthesized speech.
2547
+ *
2548
+ * Raises:
2549
+ * BadRequest: If the text is empty, credentials are not found, or custom voice is not set.
2550
+ * NotFound: If the mentor or student does not exist.
2551
+ * @param mentor
2552
+ * @param org
2553
+ * @param userId
2554
+ * @param formData
2555
+ * @returns any MP3 audio file
2556
+ * @throws ApiError
2557
+ */
2558
+ static aiMentorOrgsUsersMentorsCustomVoiceTtsCreate(mentor: string, org: string, userId: string, formData?: Record<string, any>): CancelablePromise<any>;
2559
+ /**
2560
+ * Update scenarios for a specific mentor.
2561
+ *
2562
+ * Args:
2563
+ * request: The HTTP request containing the updated scenarios.
2564
+ * org: The organization/tenant identifier.
2565
+ * user_id: The ID of the user making the request.
2566
+ * mentor: The identifier of the mentor to update scenarios for.
2567
+ *
2568
+ * Returns:
2569
+ * Response: The updated scenarios for the mentor.
2570
+ *
2571
+ * Raises:
2572
+ * BadRequest: If the provided data is invalid.
2573
+ * NotFound: If the specified mentor does not exist.
2574
+ * @param mentor
2575
+ * @param org
2576
+ * @param userId
2577
+ * @param requestBody
2578
+ * @returns MentorScenario
2579
+ * @throws ApiError
2580
+ */
2581
+ static aiMentorOrgsUsersMentorsEditScenariosUpdate(mentor: string, org: string, userId: string, requestBody: MentorScenario): CancelablePromise<MentorScenario>;
2582
+ /**
2583
+ * Fork (clone) an existing mentor.
2584
+ *
2585
+ * Args:
2586
+ * request: The HTTP request containing the fork parameters.
2587
+ * org: The organization/tenant identifier.
2588
+ * mentor: The identifier of the mentor to fork.
2589
+ * user_id: The ID of the user initiating the fork.
2590
+ *
2591
+ * Returns:
2592
+ * Response: The newly created forked mentor.
2593
+ *
2594
+ * Raises:
2595
+ * BadRequest: If the provided data is invalid or the fork operation fails.
2596
+ * NotFound: If the specified mentor does not exist.
2597
+ * @param mentor
2598
+ * @param org
2599
+ * @param userId
2600
+ * @param requestBody
2601
+ * @returns Mentor
2602
+ * @throws ApiError
2603
+ */
2604
+ static aiMentorOrgsUsersMentorsForkCreate(mentor: string, org: string, userId: string, requestBody: MentorFork): CancelablePromise<Mentor>;
2605
+ /**
2606
+ * Retrieve memory history entries for a specific mentor and user.
2607
+ *
2608
+ * Args:
2609
+ * request: The HTTP request.
2610
+ * org: The organization/tenant identifier.
2611
+ * user_id: The ID of the user to retrieve memory history for.
2612
+ * mentor: The identifier of the mentor to retrieve memory history for.
2613
+ *
2614
+ * Returns:
2615
+ * Response: The memory history entries for the mentor and user.
2616
+ *
2617
+ * Raises:
2618
+ * NotFound: If the specified mentor or memory history does not exist.
2619
+ * @param mentor
2620
+ * @param org
2621
+ * @param userId
2622
+ * @returns MemoryComponentMemoryDetail
2623
+ * @throws ApiError
2624
+ */
2625
+ static aiMentorOrgsUsersMentorsHistoricalMemoryRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MemoryComponentMemoryDetail>;
2626
+ /**
2627
+ * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
2628
+ * @param mentor
2629
+ * @param org
2630
+ * @param userId
2631
+ * @returns MemoryProgress
2632
+ * @throws ApiError
2633
+ */
2634
+ static aiMentorOrgsUsersMentorsMemoryProgressRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MemoryProgress>;
2635
+ /**
2636
+ * Retrieve memory settings for a specific mentor.
2637
+ *
2638
+ * Args:
2639
+ * request: The HTTP request.
2640
+ * org: The organization/tenant identifier.
2641
+ * user_id: The ID of the user making the request.
2642
+ * mentor: The identifier of the mentor to retrieve settings for.
2643
+ *
2644
+ * Returns:
2645
+ * Response: The memory settings for the mentor.
2646
+ *
2647
+ * Raises:
2648
+ * NotFound: If the specified mentor or settings do not exist.
2649
+ * @param mentor
2650
+ * @param org
2651
+ * @param userId
2652
+ * @returns MentorMemorySettingsResponse
2653
+ * @throws ApiError
2654
+ */
2655
+ static aiMentorOrgsUsersMentorsMemorySettingsRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MentorMemorySettingsResponse>;
2656
+ /**
2657
+ * Endpoint for mentor memory item settings.
2658
+ *
2659
+ * Accessible to platform admins and superusers.
2660
+ *
2661
+ * Returns:
2662
+ *
2663
+ * 200: Change mentor memory component item.
2664
+ *
2665
+ * 400: When request is not valid.
2666
+ * @param mentor
2667
+ * @param org
2668
+ * @param userId
2669
+ * @param requestBody
2670
+ * @returns MentorMemorySettingsResponse
2671
+ * @throws ApiError
2672
+ */
2673
+ static aiMentorOrgsUsersMentorsMemorySettingsCreate(mentor: string, org: string, userId: string, requestBody?: MentorMemorySettingsRequest): CancelablePromise<MentorMemorySettingsResponse>;
2674
+ /**
2675
+ * Retrieve evaluation criteria for a specific mentor.
2676
+ *
2677
+ * Args:
2678
+ * request: The HTTP request.
2679
+ * org: The organization/tenant identifier.
2680
+ * user_id: The ID of the user making the request.
2681
+ * mentor: The identifier of the mentor to retrieve evaluations for.
2682
+ *
2683
+ * Returns:
2684
+ * Response: The evaluation criteria for the mentor.
2685
+ *
2686
+ * Raises:
2687
+ * NotFound: If the specified mentor or evaluations do not exist.
2688
+ * @param mentor
2689
+ * @param org
2690
+ * @param userId
2691
+ * @returns MentorEval
2692
+ * @throws ApiError
2693
+ */
2694
+ static aiMentorOrgsUsersMentorsMentorEvalRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MentorEval>;
2695
+ /**
2696
+ * Create or update evaluation criteria for a specific mentor.
2697
+ *
2698
+ * Args:
2699
+ * request: The HTTP request containing the evaluation data.
2700
+ * org: The organization/tenant identifier.
2701
+ * user_id: The ID of the user making the request.
2702
+ * mentor: The identifier of the mentor to create/update evaluations for.
2703
+ *
2704
+ * Returns:
2705
+ * Response: The created or updated evaluation criteria.
2706
+ *
2707
+ * Raises:
2708
+ * BadRequest: If the provided data is invalid or the mentor does not exist.
2709
+ * @param mentor
2710
+ * @param org
2711
+ * @param userId
2712
+ * @param requestBody
2713
+ * @returns MentorEval
2714
+ * @throws ApiError
2715
+ */
2716
+ static aiMentorOrgsUsersMentorsMentorEvalCreate(mentor: string, org: string, userId: string, requestBody?: MentorEvalRequest): CancelablePromise<MentorEval>;
2717
+ /**
2718
+ * Run an evaluation for a specific mentor.
2719
+ *
2720
+ * Args:
2721
+ * request: The HTTP request containing the evaluation ID.
2722
+ * org: The organization/tenant identifier.
2723
+ * user_id: The ID of the user making the request.
2724
+ * mentor: The identifier of the mentor to evaluate.
2725
+ *
2726
+ * Returns:
2727
+ * Response: The ID of the generated evaluation report.
2728
+ *
2729
+ * Raises:
2730
+ * BadRequest: If the evaluation ID is invalid or the mentor does not match.
2731
+ * @param mentor
2732
+ * @param org
2733
+ * @param userId
2734
+ * @param requestBody
2735
+ * @returns any Evaluation execution started successfully
2736
+ * @throws ApiError
2737
+ */
2738
+ static aiMentorOrgsUsersMentorsMentorEvalExecutionCreate(mentor: string, org: string, userId: string, requestBody: RunMentorEval): CancelablePromise<any>;
2739
+ /**
2740
+ * Retrieve public mentor settings.
2741
+ *
2742
+ * Args:
2743
+ * request: HTTP request instance.
2744
+ * user_id: The ID of the user requesting settings.
2745
+ * mentor: The mentor identifier (name, slug, or unique_id).
2746
+ * org: The organization key.
2747
+ *
2748
+ * Returns:
2749
+ * Response containing the mentor settings or an error message.
2750
+ * @param mentor
2751
+ * @param org
2752
+ * @param userId
2753
+ * @returns MentorSettingsPublic
2754
+ * @throws ApiError
2755
+ */
2756
+ static aiMentorOrgsUsersMentorsPublicSettingsRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MentorSettingsPublic>;
2757
+ /**
2758
+ * Retrieve a specific evaluation report.
2759
+ *
2760
+ * Args:
2761
+ * request: The HTTP request.
2762
+ * org: The organization/tenant identifier.
2763
+ * user_id: The ID of the user making the request.
2764
+ * mentor: The identifier of the mentor that was evaluated.
2765
+ * report_id: The ID of the evaluation report to retrieve.
2766
+ *
2767
+ * Returns:
2768
+ * Response: The detailed evaluation report.
2769
+ *
2770
+ * Raises:
2771
+ * BadRequest: If the report does not exist, does not match the mentor, or is still being generated.
2772
+ * @param mentor
2773
+ * @param org
2774
+ * @param reportId
2775
+ * @param userId
2776
+ * @returns MentorEvalReport
2777
+ * @throws ApiError
2778
+ */
2779
+ static aiMentorOrgsUsersMentorsReportsMentorEvalReportRetrieve(mentor: string, org: string, reportId: number, userId: string): CancelablePromise<MentorEvalReport>;
2780
+ /**
2781
+ * Retrieve available scenarios for a specific mentor.
2782
+ *
2783
+ * Args:
2784
+ * request: The HTTP request.
2785
+ * org: The organization/tenant identifier.
2786
+ * user_id: The ID of the user making the request.
2787
+ * mentor: The identifier of the mentor to retrieve scenarios for.
2788
+ *
2789
+ * Returns:
2790
+ * Response: The available scenarios for the mentor.
2791
+ *
2792
+ * Raises:
2793
+ * NotFound: If the specified mentor or scenarios do not exist.
2794
+ * @param mentor
2795
+ * @param org
2796
+ * @param userId
2797
+ * @returns MentorScenario
2798
+ * @throws ApiError
2799
+ */
2800
+ static aiMentorOrgsUsersMentorsScenariosRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MentorScenario>;
2801
+ /**
2802
+ * Retrieve Mentor Settings
2803
+ * Fetch the settings of a mentor within an organization. Only accessible to tenant admins.
2804
+ * @param mentor
2805
+ * @param org
2806
+ * @param userId
2807
+ * @param departmentId Department to authorize users by
2808
+ * @returns MentorSettingsPublic
2809
+ * @throws ApiError
2810
+ */
2811
+ static aiMentorOrgsUsersMentorsSettingsRetrieve(mentor: string, org: string, userId: string, departmentId?: number): CancelablePromise<MentorSettingsPublic>;
2812
+ /**
2813
+ * Update Mentor Settings
2814
+ * Update various mentor settings including system prompts, tool permissions, and UI configurations.
2815
+ * @param mentor
2816
+ * @param org
2817
+ * @param userId
2818
+ * @param departmentId Department to authorize users by
2819
+ * @param formData
2820
+ * @returns MentorSettings
2821
+ * @throws ApiError
2822
+ */
2823
+ static aiMentorOrgsUsersMentorsSettingsUpdate(mentor: string, org: string, userId: string, departmentId?: number, formData?: MentorSettingsRequest): CancelablePromise<MentorSettings>;
2824
+ /**
2825
+ * Retrieve spaced repetition question statistics.
2826
+ *
2827
+ * Args:
2828
+ * request: The HTTP request.
2829
+ * org: The organization/tenant identifier.
2830
+ * user_id: The ID of the user to retrieve statistics for.
2831
+ * mentor: The unique identifier of the mentor.
2832
+ *
2833
+ * Returns:
2834
+ * Response: Statistics about the user's performance on spaced repetition questions.
2835
+ *
2836
+ * Raises:
2837
+ * NotFound: If the mentor or student does not exist.
2838
+ * @param mentor
2839
+ * @param org
2840
+ * @param userId
2841
+ * @returns SpacedRepetitionQuestionStats
2842
+ * @throws ApiError
2843
+ */
2844
+ static aiMentorOrgsUsersMentorsSpacedRepetitionQuestionStatsRetrieve(mentor: string, org: string, userId: string): CancelablePromise<SpacedRepetitionQuestionStats>;
2845
+ /**
2846
+ * Retrieve a list of learning paths associated with a specific mentor and student.
2847
+ *
2848
+ * This endpoint uses the memory component to establish the learning context for a student
2849
+ * under the guidance of a mentor. It verifies that the provided organization identifier matches
2850
+ * the mentor's platform key, and then retrieves learning path tags associated with the student's
2851
+ * question cards. Each tag is annotated with the total number of question cards and the count of
2852
+ * cards with successful repetitions (i.e., correct answers). The learning paths are ordered by the
2853
+ * number of correct answers and limited to the top five entries.
2854
+ *
2855
+ * Args:
2856
+ * request: The HTTP request containing the necessary context.
2857
+ * org (str): The organization identifier/platform key.
2858
+ * user_id (str): The username of the student.
2859
+ * mentor (str): The unique identifier of the mentor.
2860
+ * *args: Additional positional arguments.
2861
+ * **kwargs: Additional keyword arguments.
2862
+ *
2863
+ * Returns:
2864
+ * Resp200onse: memory component detail infomrmation
2865
+ *
2866
+ * Raises:
2867
+ * NotFound: If the memory component for the specified mentor and student cannot be found,
2868
+ * or if the organization identifier does not match the mentor's platform key.
2869
+ * @param mentor
2870
+ * @param org
2871
+ * @param userId
2872
+ * @returns QuestionCardTag
2873
+ * @throws ApiError
2874
+ */
2875
+ static aiMentorOrgsUsersMentorsSpacedRepetitionRecommendedPathsList(mentor: string, org: string, userId: string): CancelablePromise<Array<QuestionCardTag>>;
2876
+ /**
2877
+ * Set a specific learning path for spaced repetition.
2878
+ *
2879
+ * Args:
2880
+ * request: The HTTP request containing the learning path.
2881
+ * org: The organization/tenant identifier.
2882
+ * user_id: The ID of the user to set the learning path for.
2883
+ * mentor: The unique identifier of the mentor.
2884
+ *
2885
+ * Returns:
2886
+ * Response: The set learning path.
2887
+ *
2888
+ * Raises:
2889
+ * BadRequest: If the provided data is invalid.
2890
+ * NotFound: If the learning path, mentor, or student does not exist.
2891
+ * @param mentor
2892
+ * @param org
2893
+ * @param userId
2894
+ * @param requestBody
2895
+ * @returns SpacedRepetitionLearningPath
2896
+ * @throws ApiError
2897
+ */
2898
+ static aiMentorOrgsUsersMentorsSpacedRepetitionRecommendedPathsUpdate(mentor: string, org: string, userId: string, requestBody: SpacedRepetitionLearningPath): CancelablePromise<SpacedRepetitionLearningPath>;
2899
+ /**
2900
+ * Endpoint for getting the star status of a mentor.
2901
+ *
2902
+ * Accessible to students and admins.
2903
+ *
2904
+ *
2905
+ * Returns:
2906
+ *
2907
+ * 200: Star status.
2908
+ *
2909
+ * 400: When request is not valid.
2910
+ * @param mentor
2911
+ * @param org
2912
+ * @param userId
2913
+ * @returns StarMentor
2914
+ * @throws ApiError
2915
+ */
2916
+ static aiMentorOrgsUsersMentorsStarRetrieve(mentor: string, org: string, userId: string): CancelablePromise<StarMentor>;
2917
+ /**
2918
+ * Endpoint for starring a mentor.
2919
+ *
2920
+ * Accessible to students and admins.
2921
+ *
2922
+ *
2923
+ * Returns:
2924
+ *
2925
+ * 200: Star status.
2926
+ *
2927
+ * 400: When request is not valid.
2928
+ * @param mentor
2929
+ * @param org
2930
+ * @param userId
2931
+ * @returns StarMentor
2932
+ * @throws ApiError
2933
+ */
2934
+ static aiMentorOrgsUsersMentorsStarCreate(mentor: string, org: string, userId: string): CancelablePromise<StarMentor>;
2935
+ /**
2936
+ * Remove a mentor from a user's starred list.
2937
+ *
2938
+ * Args:
2939
+ * request: The HTTP request.
2940
+ * org: The organization/tenant identifier.
2941
+ * user_id: The ID of the user unstarring the mentor.
2942
+ * mentor: The identifier of the mentor to unstar.
2943
+ *
2944
+ * Returns:
2945
+ * Response: The updated star status of the mentor.
2946
+ *
2947
+ * Raises:
2948
+ * NotFound: If the specified mentor or student does not exist.
2949
+ * BadRequest: If the request is invalid.
2950
+ * @param mentor
2951
+ * @param org
2952
+ * @param userId
2953
+ * @returns StarMentor
2954
+ * @throws ApiError
2955
+ */
2956
+ static aiMentorOrgsUsersMentorsUnstarCreate(mentor: string, org: string, userId: string): CancelablePromise<StarMentor>;
2957
+ /**
2958
+ * Retrieve metadata for a mentor.
2959
+ *
2960
+ * Args:
2961
+ * request: The HTTP request.
2962
+ * org: The organization/tenant identifier.
2963
+ * user_id: The ID of the user making the request.
2964
+ *
2965
+ * Returns:
2966
+ * Response: The mentor metadata.
2967
+ *
2968
+ * Raises:
2969
+ * NotFound: If no metadata exists for the specified mentor.
2970
+ * @param org
2971
+ * @param userId
2972
+ * @returns MentorMetadata
2973
+ * @throws ApiError
2974
+ */
2975
+ static aiMentorOrgsUsersMetadataRetrieve(org: string, userId: string): CancelablePromise<MentorMetadata>;
2976
+ /**
2977
+ * Endpoint to view and delete Moderation Logs for a tenant.
2978
+ *
2979
+ * These can be filtered by username, platform_key and mentor id
2980
+ *
2981
+ *
2982
+ * A search query can be conducted to search through the prompts and reason for the moderation catch event.
2983
+ * @param org
2984
+ * @param userId
2985
+ * @param mentor
2986
+ * @param ordering Which field to use when ordering the results.
2987
+ * @param page A page number within the paginated result set.
2988
+ * @param pageSize Number of results to return per page.
2989
+ * @param platformKey
2990
+ * @param search A search term.
2991
+ * @param targetSystem * `Safety System` - Safety System
2992
+ * * `Moderation System` - Moderation System
2993
+ * @param username
2994
+ * @returns PaginatedModerationLogList
2995
+ * @throws ApiError
2996
+ */
2997
+ static aiMentorOrgsUsersModerationLogsList(org: string, userId: string, mentor?: number, ordering?: string, page?: number, pageSize?: number, platformKey?: string, search?: string, targetSystem?: 'Moderation System' | 'Safety System', username?: string): CancelablePromise<PaginatedModerationLogList>;
2998
+ /**
2999
+ * Endpoint to view and delete Moderation Logs for a tenant.
3000
+ *
3001
+ * These can be filtered by username, platform_key and mentor id
3002
+ *
3003
+ *
3004
+ * A search query can be conducted to search through the prompts and reason for the moderation catch event.
3005
+ * @param id A unique integer value identifying this moderation log.
3006
+ * @param org
3007
+ * @param userId
3008
+ * @returns ModerationLog
3009
+ * @throws ApiError
3010
+ */
3011
+ static aiMentorOrgsUsersModerationLogsRetrieve(id: number, org: string, userId: string): CancelablePromise<ModerationLog>;
3012
+ /**
3013
+ * Endpoint to view and delete Moderation Logs for a tenant.
3014
+ *
3015
+ * These can be filtered by username, platform_key and mentor id
3016
+ *
3017
+ *
3018
+ * A search query can be conducted to search through the prompts and reason for the moderation catch event.
3019
+ * @param id A unique integer value identifying this moderation log.
3020
+ * @param org
3021
+ * @param userId
3022
+ * @returns void
3023
+ * @throws ApiError
3024
+ */
3025
+ static aiMentorOrgsUsersModerationLogsDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
3026
+ /**
3027
+ * Endpoint to view logs for periodic agent runs.
3028
+ *
3029
+ * These logs contain the full mentor output for each run for debugging.
3030
+ * Logs are ordered from newest to oldest. However this can be changed.
3031
+ *
3032
+ * You can also filter logs for a PeriodicAgent by passing the `periodic_agent` query parameter in the URL.
3033
+ * @param org
3034
+ * @param userId
3035
+ * @param ordering Which field to use when ordering the results.
3036
+ * @param page A page number within the paginated result set.
3037
+ * @param pageSize Number of results to return per page.
3038
+ * @param parentMentorId
3039
+ * @param parentSessionId
3040
+ * @param periodicAgent
3041
+ * @param search A search term.
3042
+ * @param status * `success` - Success
3043
+ * * `error` - Error
3044
+ * * `running` - Running
3045
+ * @param username
3046
+ * @returns PaginatedPeriodicAgentLogList
3047
+ * @throws ApiError
3048
+ */
3049
+ static aiMentorOrgsUsersPeriodicAgentLogsList(org: string, userId: string, ordering?: string, page?: number, pageSize?: number, parentMentorId?: string, parentSessionId?: string, periodicAgent?: number, search?: string, status?: 'error' | 'running' | 'success', username?: string): CancelablePromise<PaginatedPeriodicAgentLogList>;
3050
+ /**
3051
+ * Endpoint to view logs for periodic agent runs.
3052
+ *
3053
+ * These logs contain the full mentor output for each run for debugging.
3054
+ * Logs are ordered from newest to oldest. However this can be changed.
3055
+ *
3056
+ * You can also filter logs for a PeriodicAgent by passing the `periodic_agent` query parameter in the URL.
3057
+ * @param id A unique integer value identifying this periodic agent log.
3058
+ * @param org
3059
+ * @param userId
3060
+ * @returns PeriodicAgentLog
3061
+ * @throws ApiError
3062
+ */
3063
+ static aiMentorOrgsUsersPeriodicAgentLogsRetrieve(id: number, org: string, userId: string): CancelablePromise<PeriodicAgentLog>;
3064
+ /**
3065
+ * Endpoint to create and view, update and delete periodic agents.
3066
+ *
3067
+ * Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any)
3068
+ * as well as a cron schedule to trigger the periodic agent.
3069
+ *
3070
+ * Access to these are restricted to platform admins and tenant administrators
3071
+ *
3072
+ * Session information for running the periodic agent will be generated with the credentials of the
3073
+ * user (platform administrator) who created the agent.
3074
+ *
3075
+ * A Periodic Agent is allowed to have a `callback_url` and `callback_secret`.
3076
+ * When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp
3077
+ * of the run will be made to the callback_url provided.
3078
+ * Here is the payload structure:
3079
+ * ```
3080
+ * {
3081
+ * "timestamp": "timestamp when the run completed",
3082
+ * "status": "status of the periodic agent",
3083
+ * "prompt": "input prompt to agent,
3084
+ * "agent_output": "...final response of agent",
3085
+ * "log": "... full agent run log",
3086
+ * "log_id": periodic agent log id.,
3087
+ * }
3088
+ * ```
3089
+ * The payload is encrypted using the `callback_secret` provided.
3090
+ *
3091
+ * You can validate the payload using the X-Hub-Signature-256 signature header for request data.
3092
+ * This is a Sha256 encoded HMAC hex digest of the payload body.
3093
+ *
3094
+ * ```python
3095
+ * import hmac
3096
+ * import haslib
3097
+ *
3098
+ * def validate_payload(request: HttpRequest, callback_secret: str):
3099
+ * # Get the X-Hub-Signature-256 header from the request
3100
+ * received_signature = request.META.get("HTTP_X_HUB_SIGNATURE_256", "")
3101
+ *
3102
+ * if not received_signature.startswith("sha256="):
3103
+ * # Invalid signature format
3104
+ * return False
3105
+ *
3106
+ * received_signature = received_signature[len("sha256=") :]
3107
+ *
3108
+ * try:
3109
+ * # Get the raw request body
3110
+ * payload = request.body
3111
+ *
3112
+ * # Compute the expected signature using the app_secret
3113
+ * expected_signature = hmac.new(
3114
+ * callback_secret.encode(), payload, hashlib.sha256
3115
+ * ).hexdigest()
3116
+ *
3117
+ * if hmac.compare_digest(received_signature, expected_signature):
3118
+ * # Signatures match, the payload is genuine
3119
+ * return True
3120
+ * else:
3121
+ * # Signatures don't match
3122
+ * return False
3123
+ * except Exception as e:
3124
+ * # Handle any errors that may occur during validation
3125
+ * return False
3126
+ *
3127
+ * ```
3128
+ * @param org
3129
+ * @param userId
3130
+ * @param enabled
3131
+ * @param ordering Which field to use when ordering the results.
3132
+ * @param page A page number within the paginated result set.
3133
+ * @param pageSize Number of results to return per page.
3134
+ * @param parentMentorId
3135
+ * @param parentSessionId
3136
+ * @param previousAgent
3137
+ * @param previousAgentStatus The status that the previous agent must be in before this agent gets scheduled.
3138
+ *
3139
+ * * `success` - Success
3140
+ * * `error` - Error
3141
+ * * `running` - Running
3142
+ * * `pending` - Pending
3143
+ * @param search A search term.
3144
+ * @param status * `success` - Success
3145
+ * * `error` - Error
3146
+ * * `running` - Running
3147
+ * * `pending` - Pending
3148
+ * @param title
3149
+ * @param username
3150
+ * @returns PaginatedPeriodicAgentList
3151
+ * @throws ApiError
3152
+ */
3153
+ static aiMentorOrgsUsersPeriodicAgentsList(org: string, userId: string, enabled?: boolean, ordering?: string, page?: number, pageSize?: number, parentMentorId?: number, parentSessionId?: string, previousAgent?: number, previousAgentStatus?: 'error' | 'pending' | 'running' | 'success', search?: string, status?: 'error' | 'pending' | 'running' | 'success', title?: string, username?: string): CancelablePromise<PaginatedPeriodicAgentList>;
3154
+ /**
3155
+ * Endpoint to create and view, update and delete periodic agents.
3156
+ *
3157
+ * Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any)
3158
+ * as well as a cron schedule to trigger the periodic agent.
3159
+ *
3160
+ * Access to these are restricted to platform admins and tenant administrators
3161
+ *
3162
+ * Session information for running the periodic agent will be generated with the credentials of the
3163
+ * user (platform administrator) who created the agent.
3164
+ *
3165
+ * A Periodic Agent is allowed to have a `callback_url` and `callback_secret`.
3166
+ * When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp
3167
+ * of the run will be made to the callback_url provided.
3168
+ * Here is the payload structure:
3169
+ * ```
3170
+ * {
3171
+ * "timestamp": "timestamp when the run completed",
3172
+ * "status": "status of the periodic agent",
3173
+ * "prompt": "input prompt to agent,
3174
+ * "agent_output": "...final response of agent",
3175
+ * "log": "... full agent run log",
3176
+ * "log_id": periodic agent log id.,
3177
+ * }
3178
+ * ```
3179
+ * The payload is encrypted using the `callback_secret` provided.
3180
+ *
3181
+ * You can validate the payload using the X-Hub-Signature-256 signature header for request data.
3182
+ * This is a Sha256 encoded HMAC hex digest of the payload body.
3183
+ *
3184
+ * ```python
3185
+ * import hmac
3186
+ * import haslib
3187
+ *
3188
+ * def validate_payload(request: HttpRequest, callback_secret: str):
3189
+ * # Get the X-Hub-Signature-256 header from the request
3190
+ * received_signature = request.META.get("HTTP_X_HUB_SIGNATURE_256", "")
3191
+ *
3192
+ * if not received_signature.startswith("sha256="):
3193
+ * # Invalid signature format
3194
+ * return False
3195
+ *
3196
+ * received_signature = received_signature[len("sha256=") :]
3197
+ *
3198
+ * try:
3199
+ * # Get the raw request body
3200
+ * payload = request.body
3201
+ *
3202
+ * # Compute the expected signature using the app_secret
3203
+ * expected_signature = hmac.new(
3204
+ * callback_secret.encode(), payload, hashlib.sha256
3205
+ * ).hexdigest()
3206
+ *
3207
+ * if hmac.compare_digest(received_signature, expected_signature):
3208
+ * # Signatures match, the payload is genuine
3209
+ * return True
3210
+ * else:
3211
+ * # Signatures don't match
3212
+ * return False
3213
+ * except Exception as e:
3214
+ * # Handle any errors that may occur during validation
3215
+ * return False
3216
+ *
3217
+ * ```
3218
+ * @param org
3219
+ * @param userId
3220
+ * @param requestBody
3221
+ * @returns PeriodicAgentCreate
3222
+ * @throws ApiError
3223
+ */
3224
+ static aiMentorOrgsUsersPeriodicAgentsCreate(org: string, userId: string, requestBody: PeriodicAgentCreate): CancelablePromise<PeriodicAgentCreate>;
3225
+ /**
3226
+ * Endpoint to create and view, update and delete periodic agents.
3227
+ *
3228
+ * Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any)
3229
+ * as well as a cron schedule to trigger the periodic agent.
3230
+ *
3231
+ * Access to these are restricted to platform admins and tenant administrators
3232
+ *
3233
+ * Session information for running the periodic agent will be generated with the credentials of the
3234
+ * user (platform administrator) who created the agent.
3235
+ *
3236
+ * A Periodic Agent is allowed to have a `callback_url` and `callback_secret`.
3237
+ * When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp
3238
+ * of the run will be made to the callback_url provided.
3239
+ * Here is the payload structure:
3240
+ * ```
3241
+ * {
3242
+ * "timestamp": "timestamp when the run completed",
3243
+ * "status": "status of the periodic agent",
3244
+ * "prompt": "input prompt to agent,
3245
+ * "agent_output": "...final response of agent",
3246
+ * "log": "... full agent run log",
3247
+ * "log_id": periodic agent log id.,
3248
+ * }
3249
+ * ```
3250
+ * The payload is encrypted using the `callback_secret` provided.
3251
+ *
3252
+ * You can validate the payload using the X-Hub-Signature-256 signature header for request data.
3253
+ * This is a Sha256 encoded HMAC hex digest of the payload body.
3254
+ *
3255
+ * ```python
3256
+ * import hmac
3257
+ * import haslib
3258
+ *
3259
+ * def validate_payload(request: HttpRequest, callback_secret: str):
3260
+ * # Get the X-Hub-Signature-256 header from the request
3261
+ * received_signature = request.META.get("HTTP_X_HUB_SIGNATURE_256", "")
3262
+ *
3263
+ * if not received_signature.startswith("sha256="):
3264
+ * # Invalid signature format
3265
+ * return False
3266
+ *
3267
+ * received_signature = received_signature[len("sha256=") :]
3268
+ *
3269
+ * try:
3270
+ * # Get the raw request body
3271
+ * payload = request.body
3272
+ *
3273
+ * # Compute the expected signature using the app_secret
3274
+ * expected_signature = hmac.new(
3275
+ * callback_secret.encode(), payload, hashlib.sha256
3276
+ * ).hexdigest()
3277
+ *
3278
+ * if hmac.compare_digest(received_signature, expected_signature):
3279
+ * # Signatures match, the payload is genuine
3280
+ * return True
3281
+ * else:
3282
+ * # Signatures don't match
3283
+ * return False
3284
+ * except Exception as e:
3285
+ * # Handle any errors that may occur during validation
3286
+ * return False
3287
+ *
3288
+ * ```
3289
+ * @param id A unique integer value identifying this periodic agent.
3290
+ * @param org
3291
+ * @param userId
3292
+ * @returns PeriodicAgent
3293
+ * @throws ApiError
3294
+ */
3295
+ static aiMentorOrgsUsersPeriodicAgentsRetrieve(id: number, org: string, userId: string): CancelablePromise<PeriodicAgent>;
3296
+ /**
3297
+ * Endpoint to create and view, update and delete periodic agents.
3298
+ *
3299
+ * Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any)
3300
+ * as well as a cron schedule to trigger the periodic agent.
3301
+ *
3302
+ * Access to these are restricted to platform admins and tenant administrators
3303
+ *
3304
+ * Session information for running the periodic agent will be generated with the credentials of the
3305
+ * user (platform administrator) who created the agent.
3306
+ *
3307
+ * A Periodic Agent is allowed to have a `callback_url` and `callback_secret`.
3308
+ * When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp
3309
+ * of the run will be made to the callback_url provided.
3310
+ * Here is the payload structure:
3311
+ * ```
3312
+ * {
3313
+ * "timestamp": "timestamp when the run completed",
3314
+ * "status": "status of the periodic agent",
3315
+ * "prompt": "input prompt to agent,
3316
+ * "agent_output": "...final response of agent",
3317
+ * "log": "... full agent run log",
3318
+ * "log_id": periodic agent log id.,
3319
+ * }
3320
+ * ```
3321
+ * The payload is encrypted using the `callback_secret` provided.
3322
+ *
3323
+ * You can validate the payload using the X-Hub-Signature-256 signature header for request data.
3324
+ * This is a Sha256 encoded HMAC hex digest of the payload body.
3325
+ *
3326
+ * ```python
3327
+ * import hmac
3328
+ * import haslib
3329
+ *
3330
+ * def validate_payload(request: HttpRequest, callback_secret: str):
3331
+ * # Get the X-Hub-Signature-256 header from the request
3332
+ * received_signature = request.META.get("HTTP_X_HUB_SIGNATURE_256", "")
3333
+ *
3334
+ * if not received_signature.startswith("sha256="):
3335
+ * # Invalid signature format
3336
+ * return False
3337
+ *
3338
+ * received_signature = received_signature[len("sha256=") :]
3339
+ *
3340
+ * try:
3341
+ * # Get the raw request body
3342
+ * payload = request.body
3343
+ *
3344
+ * # Compute the expected signature using the app_secret
3345
+ * expected_signature = hmac.new(
3346
+ * callback_secret.encode(), payload, hashlib.sha256
3347
+ * ).hexdigest()
3348
+ *
3349
+ * if hmac.compare_digest(received_signature, expected_signature):
3350
+ * # Signatures match, the payload is genuine
3351
+ * return True
3352
+ * else:
3353
+ * # Signatures don't match
3354
+ * return False
3355
+ * except Exception as e:
3356
+ * # Handle any errors that may occur during validation
3357
+ * return False
3358
+ *
3359
+ * ```
3360
+ * @param id A unique integer value identifying this periodic agent.
3361
+ * @param org
3362
+ * @param userId
3363
+ * @param requestBody
3364
+ * @returns PeriodicAgentCreate
3365
+ * @throws ApiError
3366
+ */
3367
+ static aiMentorOrgsUsersPeriodicAgentsUpdate(id: number, org: string, userId: string, requestBody: PeriodicAgentCreate): CancelablePromise<PeriodicAgentCreate>;
3368
+ /**
3369
+ * Endpoint to create and view, update and delete periodic agents.
3370
+ *
3371
+ * Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any)
3372
+ * as well as a cron schedule to trigger the periodic agent.
3373
+ *
3374
+ * Access to these are restricted to platform admins and tenant administrators
3375
+ *
3376
+ * Session information for running the periodic agent will be generated with the credentials of the
3377
+ * user (platform administrator) who created the agent.
3378
+ *
3379
+ * A Periodic Agent is allowed to have a `callback_url` and `callback_secret`.
3380
+ * When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp
3381
+ * of the run will be made to the callback_url provided.
3382
+ * Here is the payload structure:
3383
+ * ```
3384
+ * {
3385
+ * "timestamp": "timestamp when the run completed",
3386
+ * "status": "status of the periodic agent",
3387
+ * "prompt": "input prompt to agent,
3388
+ * "agent_output": "...final response of agent",
3389
+ * "log": "... full agent run log",
3390
+ * "log_id": periodic agent log id.,
3391
+ * }
3392
+ * ```
3393
+ * The payload is encrypted using the `callback_secret` provided.
3394
+ *
3395
+ * You can validate the payload using the X-Hub-Signature-256 signature header for request data.
3396
+ * This is a Sha256 encoded HMAC hex digest of the payload body.
3397
+ *
3398
+ * ```python
3399
+ * import hmac
3400
+ * import haslib
3401
+ *
3402
+ * def validate_payload(request: HttpRequest, callback_secret: str):
3403
+ * # Get the X-Hub-Signature-256 header from the request
3404
+ * received_signature = request.META.get("HTTP_X_HUB_SIGNATURE_256", "")
3405
+ *
3406
+ * if not received_signature.startswith("sha256="):
3407
+ * # Invalid signature format
3408
+ * return False
3409
+ *
3410
+ * received_signature = received_signature[len("sha256=") :]
3411
+ *
3412
+ * try:
3413
+ * # Get the raw request body
3414
+ * payload = request.body
3415
+ *
3416
+ * # Compute the expected signature using the app_secret
3417
+ * expected_signature = hmac.new(
3418
+ * callback_secret.encode(), payload, hashlib.sha256
3419
+ * ).hexdigest()
3420
+ *
3421
+ * if hmac.compare_digest(received_signature, expected_signature):
3422
+ * # Signatures match, the payload is genuine
3423
+ * return True
3424
+ * else:
3425
+ * # Signatures don't match
3426
+ * return False
3427
+ * except Exception as e:
3428
+ * # Handle any errors that may occur during validation
3429
+ * return False
3430
+ *
3431
+ * ```
3432
+ * @param id A unique integer value identifying this periodic agent.
3433
+ * @param org
3434
+ * @param userId
3435
+ * @param requestBody
3436
+ * @returns PeriodicAgentCreate
3437
+ * @throws ApiError
3438
+ */
3439
+ static aiMentorOrgsUsersPeriodicAgentsPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedPeriodicAgentCreate): CancelablePromise<PeriodicAgentCreate>;
3440
+ /**
3441
+ * Endpoint to create and view, update and delete periodic agents.
3442
+ *
3443
+ * Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any)
3444
+ * as well as a cron schedule to trigger the periodic agent.
3445
+ *
3446
+ * Access to these are restricted to platform admins and tenant administrators
3447
+ *
3448
+ * Session information for running the periodic agent will be generated with the credentials of the
3449
+ * user (platform administrator) who created the agent.
3450
+ *
3451
+ * A Periodic Agent is allowed to have a `callback_url` and `callback_secret`.
3452
+ * When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp
3453
+ * of the run will be made to the callback_url provided.
3454
+ * Here is the payload structure:
3455
+ * ```
3456
+ * {
3457
+ * "timestamp": "timestamp when the run completed",
3458
+ * "status": "status of the periodic agent",
3459
+ * "prompt": "input prompt to agent,
3460
+ * "agent_output": "...final response of agent",
3461
+ * "log": "... full agent run log",
3462
+ * "log_id": periodic agent log id.,
3463
+ * }
3464
+ * ```
3465
+ * The payload is encrypted using the `callback_secret` provided.
3466
+ *
3467
+ * You can validate the payload using the X-Hub-Signature-256 signature header for request data.
3468
+ * This is a Sha256 encoded HMAC hex digest of the payload body.
3469
+ *
3470
+ * ```python
3471
+ * import hmac
3472
+ * import haslib
3473
+ *
3474
+ * def validate_payload(request: HttpRequest, callback_secret: str):
3475
+ * # Get the X-Hub-Signature-256 header from the request
3476
+ * received_signature = request.META.get("HTTP_X_HUB_SIGNATURE_256", "")
3477
+ *
3478
+ * if not received_signature.startswith("sha256="):
3479
+ * # Invalid signature format
3480
+ * return False
3481
+ *
3482
+ * received_signature = received_signature[len("sha256=") :]
3483
+ *
3484
+ * try:
3485
+ * # Get the raw request body
3486
+ * payload = request.body
3487
+ *
3488
+ * # Compute the expected signature using the app_secret
3489
+ * expected_signature = hmac.new(
3490
+ * callback_secret.encode(), payload, hashlib.sha256
3491
+ * ).hexdigest()
3492
+ *
3493
+ * if hmac.compare_digest(received_signature, expected_signature):
3494
+ * # Signatures match, the payload is genuine
3495
+ * return True
3496
+ * else:
3497
+ * # Signatures don't match
3498
+ * return False
3499
+ * except Exception as e:
3500
+ * # Handle any errors that may occur during validation
3501
+ * return False
3502
+ *
3503
+ * ```
3504
+ * @param id A unique integer value identifying this periodic agent.
3505
+ * @param org
3506
+ * @param userId
3507
+ * @returns void
3508
+ * @throws ApiError
3509
+ */
3510
+ static aiMentorOrgsUsersPeriodicAgentsDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
3511
+ /**
3512
+ * Retrieve pinned messages for a user.
3513
+ *
3514
+ * Args:
3515
+ * request: The HTTP request.
3516
+ * org: Organization key identifier.
3517
+ * user_id: The username of the student.
3518
+ *
3519
+ * Returns:
3520
+ * Response: Paginated list of pinned messages.
3521
+ *
3522
+ * Raises:
3523
+ * NotFound: If the student or session does not exist.
3524
+ * @param org
3525
+ * @param sessionId Session id of the message to pin
3526
+ * @param userId
3527
+ * @returns PinnedMessageGet
3528
+ * @throws ApiError
3529
+ */
3530
+ static aiMentorOrgsUsersPinMessageList(org: string, sessionId: string, userId: string): CancelablePromise<Array<PinnedMessageGet>>;
3531
+ /**
3532
+ * Create a pinned message for a user session.
3533
+ *
3534
+ * Args:
3535
+ * request: The HTTP request containing session details.
3536
+ * org: Organization key identifier.
3537
+ * user_id: The username of the student.
3538
+ *
3539
+ * Returns:
3540
+ * Response: Status 201 on success.
3541
+ *
3542
+ * Raises:
3543
+ * NotFound: If the student does not exist.
3544
+ * ValidationError: If request data is invalid.
3545
+ * @param org
3546
+ * @param userId
3547
+ * @param requestBody
3548
+ * @returns PinnedMessageCreate
3549
+ * @throws ApiError
3550
+ */
3551
+ static aiMentorOrgsUsersPinMessageCreate(org: string, userId: string, requestBody: PinnedMessageRequest): CancelablePromise<PinnedMessageCreate>;
3552
+ /**
3553
+ * Delete a pinned message for a user.
3554
+ *
3555
+ * Args:
3556
+ * request: The HTTP request containing session details.
3557
+ * org: Organization key identifier.
3558
+ * user_id: The username of the student.
3559
+ *
3560
+ * Returns:
3561
+ * Response: Status 204 on success.
3562
+ *
3563
+ * Raises:
3564
+ * NotFound: If the student or pinned message does not exist.
3565
+ * ValidationError: If request data is invalid.
3566
+ * @param org
3567
+ * @param userId
3568
+ * @returns void
3569
+ * @throws ApiError
3570
+ */
3571
+ static aiMentorOrgsUsersPinMessageDestroy(org: string, userId: string): CancelablePromise<void>;
3572
+ /**
3573
+ * Endpoints for viewing jobs and their status
3574
+ * A job run refers to a task with steps that an agent is going to undertake.
3575
+ * You can filter job runs by their status.
3576
+ * Note that for a single user and a specified session, at most only one JobRun instance
3577
+ * is active at any point in time.
3578
+ * @param org
3579
+ * @param userId
3580
+ * @param active
3581
+ * @param ordering Which field to use when ordering the results.
3582
+ * @param page A page number within the paginated result set.
3583
+ * @param pageSize Number of results to return per page.
3584
+ * @param search A search term.
3585
+ * @param session
3586
+ * @returns PaginatedJobRunList
3587
+ * @throws ApiError
3588
+ */
3589
+ static aiMentorOrgsUsersPlannedJobsList(org: string, userId: string, active?: boolean, ordering?: string, page?: number, pageSize?: number, search?: string, session?: string): CancelablePromise<PaginatedJobRunList>;
3590
+ /**
3591
+ * Endpoints for viewing jobs and their status
3592
+ * A job run refers to a task with steps that an agent is going to undertake.
3593
+ * You can filter job runs by their status.
3594
+ * Note that for a single user and a specified session, at most only one JobRun instance
3595
+ * is active at any point in time.
3596
+ * @param id A unique integer value identifying this job run.
3597
+ * @param org
3598
+ * @param userId
3599
+ * @returns JobRun
3600
+ * @throws ApiError
3601
+ */
3602
+ static aiMentorOrgsUsersPlannedJobsRetrieve(id: number, org: string, userId: string): CancelablePromise<JobRun>;
3603
+ /**
3604
+ * Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
3605
+ * @param org
3606
+ * @param userId
3607
+ * @param isPublic
3608
+ * @param ordering Which field to use when ordering the results.
3609
+ * @param page A page number within the paginated result set.
3610
+ * @param pageSize Number of results to return per page.
3611
+ * @param search A search term.
3612
+ * @param student edX user ID
3613
+ * @returns PaginatedPlayWrightScriptList
3614
+ * @throws ApiError
3615
+ */
3616
+ static aiMentorOrgsUsersPlaywrightScriptsList(org: string, userId: string, isPublic?: boolean, ordering?: string, page?: number, pageSize?: number, search?: string, student?: number): CancelablePromise<PaginatedPlayWrightScriptList>;
3617
+ /**
3618
+ * Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
3619
+ * @param org
3620
+ * @param userId
3621
+ * @param requestBody
3622
+ * @returns PlayWrightScript
3623
+ * @throws ApiError
3624
+ */
3625
+ static aiMentorOrgsUsersPlaywrightScriptsCreate(org: string, userId: string, requestBody: PlayWrightScript): CancelablePromise<PlayWrightScript>;
3626
+ /**
3627
+ * Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
3628
+ * @param id A unique integer value identifying this play wright script.
3629
+ * @param org
3630
+ * @param userId
3631
+ * @returns PlayWrightScript
3632
+ * @throws ApiError
3633
+ */
3634
+ static aiMentorOrgsUsersPlaywrightScriptsRetrieve(id: number, org: string, userId: string): CancelablePromise<PlayWrightScript>;
3635
+ /**
3636
+ * Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
3637
+ * @param id A unique integer value identifying this play wright script.
3638
+ * @param org
3639
+ * @param userId
3640
+ * @param requestBody
3641
+ * @returns PlayWrightScript
3642
+ * @throws ApiError
3643
+ */
3644
+ static aiMentorOrgsUsersPlaywrightScriptsUpdate(id: number, org: string, userId: string, requestBody: PlayWrightScript): CancelablePromise<PlayWrightScript>;
3645
+ /**
3646
+ * Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
3647
+ * @param id A unique integer value identifying this play wright script.
3648
+ * @param org
3649
+ * @param userId
3650
+ * @param requestBody
3651
+ * @returns PlayWrightScript
3652
+ * @throws ApiError
3653
+ */
3654
+ static aiMentorOrgsUsersPlaywrightScriptsPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedPlayWrightScript): CancelablePromise<PlayWrightScript>;
3655
+ /**
3656
+ * Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
3657
+ * @param id A unique integer value identifying this play wright script.
3658
+ * @param org
3659
+ * @param userId
3660
+ * @returns void
3661
+ * @throws ApiError
3662
+ */
3663
+ static aiMentorOrgsUsersPlaywrightScriptsDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
3664
+ /**
3665
+ * Retrieve predictive analytics based on historical data variables.
3666
+ *
3667
+ * Args:
3668
+ * request: HTTP request containing predictive analytics input.
3669
+ * org: Organization key identifier.
3670
+ *
3671
+ * Returns:
3672
+ * - 200: Object containing predicted data.
3673
+ * - 400: When AI response cannot be loaded into JSON.
3674
+ * - 404: When OpenAI key for the tenant is not set.
3675
+ * - 429: When OpenAI request exceeds the rate limit.
3676
+ *
3677
+ * Example:
3678
+ * **POST** `/api/ai-prompt/orgs/main/users/johndoe/predictive-analytics/`
3679
+ * @param org
3680
+ * @param userId
3681
+ * @param requestBody
3682
+ * @returns PredictiveAnalyticsResponse
3683
+ * @throws ApiError
3684
+ */
3685
+ static aiMentorOrgsUsersPredictiveAnalyticsCreate(org: string, userId: string, requestBody: PredictiveAnalyticsRequest): CancelablePromise<PredictiveAnalyticsResponse>;
3686
+ /**
3687
+ * Retrieves recent chat messages based on provided query parameters.
3688
+ *
3689
+ * Returns:
3690
+ * 200: Paginated List of chat messages.
3691
+ * 400: Invalid query parameters.
3692
+ * @param org
3693
+ * @param userId
3694
+ * @returns any No response body
3695
+ * @throws ApiError
3696
+ */
3697
+ static aiMentorOrgsUsersRecentMessagesRetrieve(org: string, userId: string): CancelablePromise<any>;
3698
+ /**
3699
+ * Endpoint for listing most recently accessed mentors.
3700
+ *
3701
+ * Accessible to students and admins.
3702
+ *
3703
+ *
3704
+ * Returns:
3705
+ *
3706
+ * 200: List of most recently accessed mentors.
3707
+ *
3708
+ * 400: When request is not valid.
3709
+ * @param org
3710
+ * @param userId
3711
+ * @returns RecentlyAccessedMentor
3712
+ * @throws ApiError
3713
+ */
3714
+ static aiMentorOrgsUsersRecentlyAccessedMentorsList(org: string, userId: string): CancelablePromise<Array<RecentlyAccessedMentor>>;
3715
+ /**
3716
+ * Retrieve recommended courses for a specific user.
3717
+ *
3718
+ * Args:
3719
+ * request: The HTTP request containing query parameters.
3720
+ * org: The organization/tenant identifier.
3721
+ * user_id: The ID of the user to get recommendations for.
3722
+ *
3723
+ * Returns:
3724
+ * Response: A list of recommended courses.
3725
+ *
3726
+ * Raises:
3727
+ * BadRequest: If the query parameters are invalid.
3728
+ * NotFound: If the OpenAI API key for the tenant is not found.
3729
+ * TooManyRequests: If rate limits are exceeded.
3730
+ * ServerError: If there's an error processing the AI response.
3731
+ * @param org
3732
+ * @param userId
3733
+ * @param includeLearnerSkills Include available learner skills for search
3734
+ * @param includeMainCourses Include courses from the main tenant
3735
+ * @param rankByDifficulty Rank by course difficulty
3736
+ * @param returnCourseData Return course data
3737
+ * @param returnNumber Number of courses to return
3738
+ * @param searchTerms Terms to be searched
3739
+ * @returns RecommendCourseResponse
3740
+ * @throws ApiError
3741
+ */
3742
+ static aiMentorOrgsUsersRecommendCoursesRetrieve(org: string, userId: string, includeLearnerSkills?: boolean, includeMainCourses?: boolean, rankByDifficulty?: boolean, returnCourseData?: boolean, returnNumber?: number, searchTerms?: string): CancelablePromise<RecommendCourseResponse>;
3743
+ /**
3744
+ * Retrieve recommended course blocks for a specific user.
3745
+ *
3746
+ * Args:
3747
+ * request: The HTTP request containing query parameters.
3748
+ * org: The organization/tenant identifier.
3749
+ * user_id: The ID of the user to get recommendations for.
3750
+ *
3751
+ * Returns:
3752
+ * Response: A list of recommended course blocks.
3753
+ *
3754
+ * Raises:
3755
+ * BadRequest: If the query parameters are invalid.
3756
+ * @param org
3757
+ * @param userId
3758
+ * @param includeLearnerSkills Include available learner skills for search
3759
+ * @param includeMainCourses Include courses from the main tenant
3760
+ * @param rankByDifficulty Rank by course difficulty
3761
+ * @param returnCourseData Return course data
3762
+ * @param returnNumber Number of courses to return
3763
+ * @param searchTerms Terms to be searched
3764
+ * @returns RecommendCourseBlock
3765
+ * @throws ApiError
3766
+ */
3767
+ static aiMentorOrgsUsersRecommendCoursesBlockRetrieve(org: string, userId: string, includeLearnerSkills?: boolean, includeMainCourses?: boolean, rankByDifficulty?: boolean, returnCourseData?: boolean, returnNumber?: number, searchTerms?: string): CancelablePromise<RecommendCourseBlock>;
3768
+ /**
3769
+ * Search for web resources based on a query.
3770
+ *
3771
+ * Args:
3772
+ * request: The HTTP request containing the search query.
3773
+ * org: The organization/tenant identifier.
3774
+ * user_id: The ID of the user making the request.
3775
+ *
3776
+ * Returns:
3777
+ * Response: A list of web resources matching the query.
3778
+ *
3779
+ * Raises:
3780
+ * ValidationError: If the search fails or returns no results.
3781
+ * @param org
3782
+ * @param userId
3783
+ * @param requestBody
3784
+ * @returns WebResource
3785
+ * @throws ApiError
3786
+ */
3787
+ static aiMentorOrgsUsersResourcesWebCreate(org: string, userId: string, requestBody: WebResourcesQuery): CancelablePromise<Array<WebResource>>;
3788
+ /**
3789
+ * Endpoint to view and delete Safety System Logs for a tenant.
3790
+ *
3791
+ * These can be filtered by username, platform_key and mentor id
3792
+ *
3793
+ *
3794
+ * A search query can be conducted to search through the prompts and reason for the moderation catch event.
3795
+ * @param org
3796
+ * @param userId
3797
+ * @param mentor
3798
+ * @param ordering Which field to use when ordering the results.
3799
+ * @param page A page number within the paginated result set.
3800
+ * @param pageSize Number of results to return per page.
3801
+ * @param platformKey
3802
+ * @param search A search term.
3803
+ * @param targetSystem * `Safety System` - Safety System
3804
+ * * `Moderation System` - Moderation System
3805
+ * @param username
3806
+ * @returns PaginatedModerationLogList
3807
+ * @throws ApiError
3808
+ */
3809
+ static aiMentorOrgsUsersSafetyLogsList(org: string, userId: string, mentor?: number, ordering?: string, page?: number, pageSize?: number, platformKey?: string, search?: string, targetSystem?: 'Moderation System' | 'Safety System', username?: string): CancelablePromise<PaginatedModerationLogList>;
3810
+ /**
3811
+ * Endpoint to view and delete Safety System Logs for a tenant.
3812
+ *
3813
+ * These can be filtered by username, platform_key and mentor id
3814
+ *
3815
+ *
3816
+ * A search query can be conducted to search through the prompts and reason for the moderation catch event.
3817
+ * @param id A unique integer value identifying this moderation log.
3818
+ * @param org
3819
+ * @param userId
3820
+ * @returns ModerationLog
3821
+ * @throws ApiError
3822
+ */
3823
+ static aiMentorOrgsUsersSafetyLogsRetrieve(id: number, org: string, userId: string): CancelablePromise<ModerationLog>;
3824
+ /**
3825
+ * Endpoint to view and delete Safety System Logs for a tenant.
3826
+ *
3827
+ * These can be filtered by username, platform_key and mentor id
3828
+ *
3829
+ *
3830
+ * A search query can be conducted to search through the prompts and reason for the moderation catch event.
3831
+ * @param id A unique integer value identifying this moderation log.
3832
+ * @param org
3833
+ * @param userId
3834
+ * @returns void
3835
+ * @throws ApiError
3836
+ */
3837
+ static aiMentorOrgsUsersSafetyLogsDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
3838
+ /**
3839
+ * Retrieve session details including message counts and timestamps.
3840
+ *
3841
+ * Query Parameters:
3842
+ * page (optional, int): Page number for pagination.
3843
+ *
3844
+ * Returns:
3845
+ * - 200: Paginated list of session details.
3846
+ * - 404: Session not found.
3847
+ * @param mentor
3848
+ * @param org
3849
+ * @param userId
3850
+ * @param page Page number for pagination
3851
+ * @returns SessionDetail
3852
+ * @throws ApiError
3853
+ */
3854
+ static aiMentorOrgsUsersSessionDetailMentorsList(mentor: string, org: string, userId: string, page?: number): CancelablePromise<Array<SessionDetail>>;
3855
+ /**
3856
+ * Retrieve user sessions filtered by start date and end date.
3857
+ *
3858
+ * Query Parameters:
3859
+ * start_date (optional, ISO format): Start date for filtering sessions.
3860
+ * end_date (optional, ISO format): End date for filtering sessions.
3861
+ *
3862
+ * Returns:
3863
+ * - 200: List of session IDs with insertion timestamps.
3864
+ * - 400: Invalid request parameters.
3865
+ * @param org
3866
+ * @param userId
3867
+ * @param endDate
3868
+ * @param startDate
3869
+ * @returns ChatHistorySessionId
3870
+ * @throws ApiError
3871
+ */
3872
+ static aiMentorOrgsUsersSessionidList(org: string, userId: string, endDate?: string, startDate?: string): CancelablePromise<Array<ChatHistorySessionId>>;
3873
+ /**
3874
+ * Retrieve or create a chat session with a mentor.
3875
+ *
3876
+ * Passing `null` as `tools` results in using all tools assigned to the mentor.
3877
+ * To specify that no tools be used, pass an empty list.
3878
+ *
3879
+ * Args:
3880
+ * request: HTTP request containing mentor details.
3881
+ * org: Organization key identifier.
3882
+ * user_id (optional): Username for authentication (if required by the mentor).
3883
+ *
3884
+ * Returns:
3885
+ * Response: JSON object containing the session ID.
3886
+ *
3887
+ * Raises:
3888
+ * Http404: If the mentor is not found.
3889
+ * ValidationError: If the username is invalid.
3890
+ * ValidationError: If one or more tool slugs are invalid.
3891
+ * @param org
3892
+ * @param userId
3893
+ * @param requestBody
3894
+ * @returns ChatSessionResponse
3895
+ * @throws ApiError
3896
+ */
3897
+ static aiMentorOrgsUsersSessionsCreate(org: string, userId: string, requestBody: ChatSessionRequest): CancelablePromise<ChatSessionResponse>;
3898
+ /**
3899
+ * Retrieve Chat Messages
3900
+ * Fetches chat messages for a specific session.
3901
+ * @param org
3902
+ * @param sessionId
3903
+ * @param userId
3904
+ * @param share
3905
+ * @returns MessageView
3906
+ * @throws ApiError
3907
+ */
3908
+ static aiMentorOrgsUsersSessionsRetrieve(org: string, sessionId: string, userId: string, share?: boolean): CancelablePromise<MessageView>;
3909
+ /**
3910
+ * Update the title of a chat session and its tools
3911
+ * @param org
3912
+ * @param sessionId
3913
+ * @param userId
3914
+ * @param requestBody
3915
+ * @returns MessageViewUpdatResponse
3916
+ * @throws ApiError
3917
+ */
3918
+ static aiMentorOrgsUsersSessionsUpdate(org: string, sessionId: string, userId: string, requestBody?: MessageViewRequest): CancelablePromise<MessageViewUpdatResponse>;
3919
+ /**
3920
+ * Deletes all messages in a chat session.
3921
+ * @param org
3922
+ * @param sessionId
3923
+ * @param userId
3924
+ * @returns void
3925
+ * @throws ApiError
3926
+ */
3927
+ static aiMentorOrgsUsersSessionsDestroy(org: string, sessionId: string, userId: string): CancelablePromise<void>;
3928
+ /**
3929
+ * Endpoint to fetch the logs of a session.
3930
+ * Logs are cached for up to 1 hour of their creation: accessing the logs after an hour will result in an empty data.
3931
+ *
3932
+ * This is intentional and made to avoid cases where logs bloat our in-memory db.
3933
+ *
3934
+ * Accessible to tenant admins and students.
3935
+ *
3936
+ * Url Args:
3937
+ * org (str): The organization's platform key.
3938
+ * user_id (str): The username identifier of the individual.
3939
+ * session_id (str): The session id.
3940
+ *
3941
+ * Returns:
3942
+ *
3943
+ * 200: a SessionBrowserScreenshot object
3944
+ * @param org
3945
+ * @param sessionId
3946
+ * @param userId
3947
+ * @returns SessionBrowserScreenshot
3948
+ * @throws ApiError
3949
+ */
3950
+ static aiMentorOrgsUsersSessionsBrowserScreenshotRetrieve(org: string, sessionId: string, userId: string): CancelablePromise<SessionBrowserScreenshot>;
3951
+ /**
3952
+ * Retrieves the chat history for a session as a plain text file.
3953
+ *
3954
+ * Returns:
3955
+ * 200: txt file containing coversation
3956
+ * @param org
3957
+ * @param sessionId
3958
+ * @param userId
3959
+ * @returns any No response body
3960
+ * @throws ApiError
3961
+ */
3962
+ static aiMentorOrgsUsersSessionsDownloadSessionRetrieve(org: string, sessionId: string, userId: string): CancelablePromise<any>;
3963
+ /**
3964
+ * Retrieve memory data for a specific session.
3965
+ *
3966
+ * This endpoint returns the memory components (knowledge gaps, lessons learned,
3967
+ * help requests) that were generated during the specified chat session.
3968
+ *
3969
+ * Args:
3970
+ * org: The organization/tenant identifier.
3971
+ * user_id: The ID of the user who owns the session.
3972
+ * session_id: The ID of the session to retrieve memory for.
3973
+ *
3974
+ * Returns:
3975
+ * Response: The memory data associated with the session.
3976
+ *
3977
+ * Raises:
3978
+ * NotFound: If the session does not exist or does not belong to the user.
3979
+ * @param org
3980
+ * @param sessionId
3981
+ * @param userId
3982
+ * @returns SessionMemoryStorage
3983
+ * @throws ApiError
3984
+ */
3985
+ static aiMentorOrgsUsersSessionsMemoryRetrieve(org: string, sessionId: string, userId: string): CancelablePromise<SessionMemoryStorage>;
3986
+ /**
3987
+ * Retrieve shell logs for a specific session.
3988
+ *
3989
+ * Args:
3990
+ * request: The HTTP request.
3991
+ * org: The organization/tenant identifier.
3992
+ * user_id: The ID of the user who owns the session.
3993
+ * session_id: The ID of the session to retrieve logs for.
3994
+ *
3995
+ * Returns:
3996
+ * Response: The shell logs for the specified session.
3997
+ *
3998
+ * Raises:
3999
+ * NotFound: If the specified session does not exist.
4000
+ * @param org
4001
+ * @param sessionId
4002
+ * @param userId
4003
+ * @returns ShellLogs
4004
+ * @throws ApiError
4005
+ */
4006
+ static aiMentorOrgsUsersSessionsShellLogsRetrieve(org: string, sessionId: string, userId: string): CancelablePromise<ShellLogs>;
4007
+ /**
4008
+ * Retrieve a list of related questions based on a chat session.
4009
+ * @param org
4010
+ * @param sessionId
4011
+ * @param userId
4012
+ * @param numQuestions
4013
+ * @returns RelatedText
4014
+ * @throws ApiError
4015
+ */
4016
+ static aiMentorOrgsUsersSessionsSuggestionList(org: string, sessionId: string, userId: string, numQuestions?: number): CancelablePromise<Array<RelatedText>>;
4017
+ /**
4018
+ * Retrieves the chat history for a given session if the export task is ready.
4019
+ *
4020
+ * Returns:
4021
+ *
4022
+ * 200: When task is not ready.
4023
+ *
4024
+ * 200: chat history object
4025
+ *
4026
+ * 400: When data is not valid.
4027
+ * @param org
4028
+ * @param sessionId
4029
+ * @param taskId
4030
+ * @param userId
4031
+ * @param toCsv Choose download in csv or not
4032
+ * @returns ChatHistoryItem
4033
+ * @throws ApiError
4034
+ */
4035
+ static aiMentorOrgsUsersSessionsTasksRetrieve(org: string, sessionId: string, taskId: string, userId: string, toCsv?: boolean): CancelablePromise<ChatHistoryItem>;
4036
+ /**
4037
+ * Retrieve all LLM models assigned to a specific tenant.
4038
+ *
4039
+ * Args:
4040
+ * request: The HTTP request.
4041
+ * org: The unique identifier of the tenant.
4042
+ *
4043
+ * Returns:
4044
+ * Response: A list of LLM models assigned to the tenant.
4045
+ *
4046
+ * Raises:
4047
+ * NotFound: If the specified tenant does not have any associated models.
4048
+ * ValidationError: If an unexpected error occurs.
4049
+ * @param org
4050
+ * @param userId
4051
+ * @returns LLMModelForTenant
4052
+ * @throws ApiError
4053
+ */
4054
+ static aiMentorOrgsUsersSettingsTenantLlmList(org: string, userId: string): CancelablePromise<Array<LLMModelForTenant>>;
4055
+ /**
4056
+ * Create or update an LLM model for a tenant.
4057
+ *
4058
+ * Accessible only to tenant administrators.
4059
+ *
4060
+ * Args:
4061
+ * request: The HTTP request containing LLM model details.
4062
+ * org: The unique identifier of the tenant.
4063
+ *
4064
+ * Returns:
4065
+ * Response: Details of the newly created or updated LLM model.
4066
+ *
4067
+ * Raises:
4068
+ * ValidationError: If request data is invalid.
4069
+ * NotFound: If the tenant does not exist.
4070
+ * @param org
4071
+ * @param userId
4072
+ * @param requestBody
4073
+ * @returns LLMModelForTenant
4074
+ * @throws ApiError
4075
+ */
4076
+ static aiMentorOrgsUsersSettingsTenantLlmCreate(org: string, userId: string, requestBody: LLMModelForTenant): CancelablePromise<LLMModelForTenant>;
4077
+ /**
4078
+ * Retrieve a list of mentors starred by a specific user.
4079
+ *
4080
+ * Args:
4081
+ * request: The HTTP request.
4082
+ * org: The organization/tenant identifier.
4083
+ * user_id: The ID of the user to retrieve starred mentors for.
4084
+ *
4085
+ * Returns:
4086
+ * Response: A list of the user's starred mentors, sorted by most recently accessed.
4087
+ *
4088
+ * Raises:
4089
+ * NotFound: If the specified student does not exist.
4090
+ * BadRequest: If the request is invalid.
4091
+ * @param org
4092
+ * @param userId
4093
+ * @returns StarMentor
4094
+ * @throws ApiError
4095
+ */
4096
+ static aiMentorOrgsUsersStarredMentorsList(org: string, userId: string): CancelablePromise<Array<StarMentor>>;
4097
+ /**
4098
+ * Retrieves the status of a task using its task ID.
4099
+ *
4100
+ * Accessible to both tenant admins and students.
4101
+ *
4102
+ * Returns:
4103
+ *
4104
+ * 200: task id
4105
+ * @param org
4106
+ * @param taskId
4107
+ * @param userId
4108
+ * @returns RetrieveTask
4109
+ * @throws ApiError
4110
+ */
4111
+ static aiMentorOrgsUsersTasksRetrieve(org: string, taskId: string, userId: string): CancelablePromise<RetrieveTask>;
4112
+ /**
4113
+ * Export chat history for a session.
4114
+ *
4115
+ * Returns:
4116
+ * 200: Task ID for the export operation.
4117
+ * @param org
4118
+ * @param sessionId
4119
+ * @param userId
4120
+ * @param requestBody
4121
+ * @returns TaskView
4122
+ * @throws ApiError
4123
+ */
4124
+ static aiMentorOrgsUsersTasksSessionsCreate(org: string, sessionId: string, userId: string, requestBody: TaskView): CancelablePromise<TaskView>;
4125
+ /**
4126
+ * Retrieve a list of available voice options.
4127
+ *
4128
+ * Args:
4129
+ * request: The HTTP request.
4130
+ *
4131
+ * Returns:
4132
+ * Response: A list of available voice options.
4133
+ *
4134
+ * Raises:
4135
+ * NotFound: If no voice options are available.
4136
+ * @param org
4137
+ * @param userId
4138
+ * @param ordering Which field to use when ordering the results.
4139
+ * @param page A page number within the paginated result set.
4140
+ * @param pageSize Number of results to return per page.
4141
+ * @param provider * `openai` - Openai
4142
+ * * `google` - Google
4143
+ * * `elevenlabs` - Elevenlabs
4144
+ * @param search A search term.
4145
+ * @returns PaginatedVoiceList
4146
+ * @throws ApiError
4147
+ */
4148
+ static aiMentorOrgsUsersVoicesList(org: string, userId: string, ordering?: string, page?: number, pageSize?: number, provider?: 'elevenlabs' | 'google' | 'openai', search?: string): CancelablePromise<PaginatedVoiceList>;
4149
+ /**
4150
+ * Retrieve details of a specific voice option.
4151
+ *
4152
+ * Args:
4153
+ * request: The HTTP request.
4154
+ * pk: The primary key of the voice option to retrieve.
4155
+ *
4156
+ * Returns:
4157
+ * Response: The details of the specified voice option.
4158
+ *
4159
+ * Raises:
4160
+ * NotFound: If the specified voice option does not exist.
4161
+ * @param id A unique integer value identifying this voice.
4162
+ * @param org
4163
+ * @param userId
4164
+ * @returns Voice
4165
+ * @throws ApiError
4166
+ */
4167
+ static aiMentorOrgsUsersVoicesRetrieve(id: number, org: string, userId: string): CancelablePromise<Voice>;
4168
+ /**
4169
+ * @param org
4170
+ * @param slug
4171
+ * @returns any No response body
4172
+ * @throws ApiError
4173
+ */
4174
+ static aiMentorOrgsWebhooksAzureTriggerCreate(org: string, slug: string): CancelablePromise<any>;
4175
+ /**
4176
+ * Handle incoming POST requests from GitHub webhook for pull requests.
4177
+ *
4178
+ * Args:
4179
+ * request: The HTTP request object containing the webhook payload.
4180
+ * org: the organizaion name.
4181
+ *
4182
+ * Returns:
4183
+ * Response: A response indicating the result of processing the webhook event.
4184
+ * @param org
4185
+ * @returns any No response body
4186
+ * @throws ApiError
4187
+ */
4188
+ static aiMentorOrgsWebhooksGithubPullrequestCreate(org: string): CancelablePromise<any>;
4189
+ /**
4190
+ * @returns any No response body
4191
+ * @throws ApiError
4192
+ */
4193
+ static aiMentorWebhooksAzureEmailchatCreate(): CancelablePromise<any>;
4194
+ }