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