@iblai/iblai-api 3.50.1-ai-plus → 3.50.1-core

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