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