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