@iblai/iblai-api 4.6.2-ai-plus → 4.6.2-dev-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 (714) hide show
  1. package/dist/index.cjs.js +10782 -28650
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +10783 -28643
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +10782 -28650
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/index.d.ts +2 -348
  8. package/dist/types/models/{StripeCheckoutSessionRequestModeEnum.d.ts → ModeEnum.d.ts} +1 -1
  9. package/dist/types/models/NotificationSource.d.ts +2 -2
  10. package/dist/types/models/StripeCheckoutSessionRequest.d.ts +2 -2
  11. package/dist/types/models/{NotificationSourceTypeEnum.d.ts → TypeEnum.d.ts} +1 -1
  12. package/dist/types/services/AiAnalyticsService.d.ts +0 -3934
  13. package/dist/types/services/SearchService.d.ts +0 -730
  14. package/package.json +1 -1
  15. package/src/core/OpenAPI.ts +1 -1
  16. package/src/index.ts +2 -348
  17. package/src/models/{StripeCheckoutSessionRequestModeEnum.ts → ModeEnum.ts} +1 -1
  18. package/src/models/NotificationSource.ts +2 -2
  19. package/src/models/StripeCheckoutSessionRequest.ts +2 -2
  20. package/src/models/{NotificationSourceTypeEnum.ts → TypeEnum.ts} +1 -1
  21. package/src/services/AiAnalyticsService.ts +3604 -10156
  22. package/src/services/SearchService.ts +398 -1446
  23. package/dist/types/models/AIGeneratedImage.d.ts +0 -13
  24. package/dist/types/models/AIUserProfileMemoryRelation.d.ts +0 -4
  25. package/dist/types/models/AIUserProfileRequest.d.ts +0 -4
  26. package/dist/types/models/AccessEnum.d.ts +0 -8
  27. package/dist/types/models/AlignMentorBubbleEnum.d.ts +0 -8
  28. package/dist/types/models/AnalyticsOverview.d.ts +0 -7
  29. package/dist/types/models/Answer.d.ts +0 -11
  30. package/dist/types/models/AssumedKnowledge.d.ts +0 -4
  31. package/dist/types/models/AssumedKnowledgeLevel.d.ts +0 -4
  32. package/dist/types/models/AudioToTextRequest.d.ts +0 -3
  33. package/dist/types/models/AudioToTextResponse.d.ts +0 -3
  34. package/dist/types/models/AutoMemoryPrompt.d.ts +0 -4
  35. package/dist/types/models/Bot.d.ts +0 -15
  36. package/dist/types/models/BotCommand.d.ts +0 -6
  37. package/dist/types/models/BotCreate.d.ts +0 -12
  38. package/dist/types/models/CallAuthenticationRequest.d.ts +0 -13
  39. package/dist/types/models/CallAuthenticationResponse.d.ts +0 -21
  40. package/dist/types/models/CallConfiguration.d.ts +0 -26
  41. package/dist/types/models/CallConfigurationModeEnum.d.ts +0 -8
  42. package/dist/types/models/ChatHistory.d.ts +0 -8
  43. package/dist/types/models/ChatHistoryFilterData.d.ts +0 -9
  44. package/dist/types/models/ChatHistoryFilterUser.d.ts +0 -5
  45. package/dist/types/models/ChatHistoryItem.d.ts +0 -5
  46. package/dist/types/models/ChatHistorySessionId.d.ts +0 -3
  47. package/dist/types/models/ChatSessionRequest.d.ts +0 -14
  48. package/dist/types/models/ChatSessionResponse.d.ts +0 -5
  49. package/dist/types/models/CheckDocumentTrainingStatus.d.ts +0 -10
  50. package/dist/types/models/ComponentBlock.d.ts +0 -9
  51. package/dist/types/models/ComponentBlockTypeEnum.d.ts +0 -8
  52. package/dist/types/models/ConnectedService.d.ts +0 -9
  53. package/dist/types/models/ConnectedServiceProviderEnum.d.ts +0 -6
  54. package/dist/types/models/ConversationMessage.d.ts +0 -11
  55. package/dist/types/models/ConversationRating.d.ts +0 -6
  56. package/dist/types/models/ConversationSummary.d.ts +0 -5
  57. package/dist/types/models/ConversationVolume.d.ts +0 -4
  58. package/dist/types/models/Conversations.d.ts +0 -28
  59. package/dist/types/models/Cost.d.ts +0 -3
  60. package/dist/types/models/CostPerTenant.d.ts +0 -6
  61. package/dist/types/models/CourseCreationTask.d.ts +0 -31
  62. package/dist/types/models/CourseCreationTaskFile.d.ts +0 -7
  63. package/dist/types/models/CourseCreationTaskStatusEnum.d.ts +0 -16
  64. package/dist/types/models/CrawlerPatternTypeEnum.d.ts +0 -8
  65. package/dist/types/models/CredentialRequest.d.ts +0 -14
  66. package/dist/types/models/CrontabSchedule.d.ts +0 -22
  67. package/dist/types/models/CustomInstructionResponse.d.ts +0 -13
  68. package/dist/types/models/DataSet.d.ts +0 -21
  69. package/dist/types/models/DataSetCreate.d.ts +0 -12
  70. package/dist/types/models/DataSetStatusEnum.d.ts +0 -12
  71. package/dist/types/models/DateRange.d.ts +0 -4
  72. package/dist/types/models/DiscordConfig.d.ts +0 -7
  73. package/dist/types/models/DiscordUserConfig.d.ts +0 -10
  74. package/dist/types/models/DiscordWebhook.d.ts +0 -6
  75. package/dist/types/models/Document.d.ts +0 -41
  76. package/dist/types/models/DocumentFacet.d.ts +0 -17
  77. package/dist/types/models/DocumentSearchResponse.d.ts +0 -35
  78. package/dist/types/models/DocumentSettingsResponse.d.ts +0 -3
  79. package/dist/types/models/EdxCourse.d.ts +0 -11
  80. package/dist/types/models/ElevenlabsCustomVoice.d.ts +0 -4
  81. package/dist/types/models/ElevenlabsCustomVoiceResponse.d.ts +0 -8
  82. package/dist/types/models/EmailPromptDetail.d.ts +0 -13
  83. package/dist/types/models/EmailPromptList.d.ts +0 -11
  84. package/dist/types/models/EmailPromptSummary.d.ts +0 -5
  85. package/dist/types/models/FreeUsageCount.d.ts +0 -3
  86. package/dist/types/models/FullCourse.d.ts +0 -13
  87. package/dist/types/models/GreetingMethodEnum.d.ts +0 -8
  88. package/dist/types/models/GuidedPrompt.d.ts +0 -4
  89. package/dist/types/models/GuidedPromptsResponse.d.ts +0 -5
  90. package/dist/types/models/HeygenMarketingVideoDetail.d.ts +0 -8
  91. package/dist/types/models/HeygenMarketingVideoList.d.ts +0 -6
  92. package/dist/types/models/HeygenTemplateRequest.d.ts +0 -5
  93. package/dist/types/models/HeygenTemplateResponseSingle.d.ts +0 -6
  94. package/dist/types/models/HeygenVideoDetail.d.ts +0 -8
  95. package/dist/types/models/HeygenVideoRequest.d.ts +0 -5
  96. package/dist/types/models/HumanSupportTicket.d.ts +0 -21
  97. package/dist/types/models/HumanSupportTicketStatusEnum.d.ts +0 -10
  98. package/dist/types/models/InputQuestion.d.ts +0 -6
  99. package/dist/types/models/IntegrationCredential.d.ts +0 -8
  100. package/dist/types/models/IntegrationCredentialSchema.d.ts +0 -4
  101. package/dist/types/models/IntialQuestionAnswer.d.ts +0 -3
  102. package/dist/types/models/JobRun.d.ts +0 -11
  103. package/dist/types/models/KindEnum.d.ts +0 -10
  104. package/dist/types/models/LLMCredentialRequest.d.ts +0 -14
  105. package/dist/types/models/LLMCredentialResponse.d.ts +0 -8
  106. package/dist/types/models/LLMCredentialSchema.d.ts +0 -4
  107. package/dist/types/models/LLMModelForTenant.d.ts +0 -6
  108. package/dist/types/models/LLMQuestion.d.ts +0 -15
  109. package/dist/types/models/LLMResponse.d.ts +0 -14
  110. package/dist/types/models/LLMTracesListResponse.d.ts +0 -5
  111. package/dist/types/models/LanguagesView.d.ts +0 -5
  112. package/dist/types/models/LinkCourseRequest.d.ts +0 -3
  113. package/dist/types/models/LinkCourseResponse.d.ts +0 -5
  114. package/dist/types/models/LlmProviderEnum.d.ts +0 -8
  115. package/dist/types/models/MCPServer.d.ts +0 -21
  116. package/dist/types/models/MemoryComponentData.d.ts +0 -5
  117. package/dist/types/models/MemoryComponentMemory.d.ts +0 -4
  118. package/dist/types/models/MemoryComponentMemoryDetail.d.ts +0 -8
  119. package/dist/types/models/MemoryComponentResponse.d.ts +0 -5
  120. package/dist/types/models/MemoryProgress.d.ts +0 -8
  121. package/dist/types/models/MemoryStatusRequestView.d.ts +0 -6
  122. package/dist/types/models/MemoryStatusView.d.ts +0 -6
  123. package/dist/types/models/Mentor.d.ts +0 -87
  124. package/dist/types/models/MentorAudience.d.ts +0 -5
  125. package/dist/types/models/MentorCategory.d.ts +0 -9
  126. package/dist/types/models/MentorCategoryCreate.d.ts +0 -11
  127. package/dist/types/models/MentorCategoryGroup.d.ts +0 -11
  128. package/dist/types/models/MentorCategoryGroupCreate.d.ts +0 -11
  129. package/dist/types/models/MentorCreate.d.ts +0 -84
  130. package/dist/types/models/MentorCustomVoice.d.ts +0 -4
  131. package/dist/types/models/MentorCustomVoiceResponse.d.ts +0 -4
  132. package/dist/types/models/MentorData.d.ts +0 -7
  133. package/dist/types/models/MentorDetailAnalytics.d.ts +0 -6
  134. package/dist/types/models/MentorEval.d.ts +0 -11
  135. package/dist/types/models/MentorEvalQuestion.d.ts +0 -5
  136. package/dist/types/models/MentorEvalQuestionRequest.d.ts +0 -4
  137. package/dist/types/models/MentorEvalReport.d.ts +0 -10
  138. package/dist/types/models/MentorEvalRequest.d.ts +0 -8
  139. package/dist/types/models/MentorFacet.d.ts +0 -17
  140. package/dist/types/models/MentorFork.d.ts +0 -5
  141. package/dist/types/models/MentorFromTemplateWithSettingRequest.d.ts +0 -47
  142. package/dist/types/models/MentorMemorySettingsRequest.d.ts +0 -6
  143. package/dist/types/models/MentorMemorySettingsResponse.d.ts +0 -6
  144. package/dist/types/models/MentorMetadata.d.ts +0 -5
  145. package/dist/types/models/MentorScenario.d.ts +0 -6
  146. package/dist/types/models/MentorScenarioPrompt.d.ts +0 -5
  147. package/dist/types/models/MentorSearchResponse.d.ts +0 -35
  148. package/dist/types/models/MentorSession.d.ts +0 -4
  149. package/dist/types/models/MentorSettings.d.ts +0 -76
  150. package/dist/types/models/MentorSettingsPublic.d.ts +0 -52
  151. package/dist/types/models/MentorSettingsRequest.d.ts +0 -62
  152. package/dist/types/models/MentorVisibilityEnum.d.ts +0 -10
  153. package/dist/types/models/MentorWizard.d.ts +0 -4
  154. package/dist/types/models/MessageStatistics.d.ts +0 -5
  155. package/dist/types/models/MessageView.d.ts +0 -10
  156. package/dist/types/models/MessageViewRequest.d.ts +0 -7
  157. package/dist/types/models/MessageViewUpdatResponse.d.ts +0 -3
  158. package/dist/types/models/Metadata.d.ts +0 -5
  159. package/dist/types/models/MetricChange.d.ts +0 -4
  160. package/dist/types/models/ModelCost.d.ts +0 -4
  161. package/dist/types/models/ModerationLog.d.ts +0 -11
  162. package/dist/types/models/NoChatMessagesFound.d.ts +0 -3
  163. package/dist/types/models/NullEnum.d.ts +0 -1
  164. package/dist/types/models/OAuthStartResponse.d.ts +0 -3
  165. package/dist/types/models/Observation.d.ts +0 -31
  166. package/dist/types/models/PageContent.d.ts +0 -6
  167. package/dist/types/models/PaginatedAIGeneratedImageList.d.ts +0 -7
  168. package/dist/types/models/PaginatedConversationsList.d.ts +0 -7
  169. package/dist/types/models/PaginatedCourseCreationTaskFileList.d.ts +0 -7
  170. package/dist/types/models/PaginatedCourseCreationTaskList.d.ts +0 -7
  171. package/dist/types/models/PaginatedDataSetList.d.ts +0 -7
  172. package/dist/types/models/PaginatedEdxCourseList.d.ts +0 -7
  173. package/dist/types/models/PaginatedEmailPromptListList.d.ts +0 -7
  174. package/dist/types/models/PaginatedHeygenMarketingVideoListList.d.ts +0 -7
  175. package/dist/types/models/PaginatedHeygenTemplateResponseSingleList.d.ts +0 -7
  176. package/dist/types/models/PaginatedHumanSupportTicketList.d.ts +0 -7
  177. package/dist/types/models/PaginatedJobRunList.d.ts +0 -7
  178. package/dist/types/models/PaginatedMCPServerList.d.ts +0 -7
  179. package/dist/types/models/PaginatedMentorList.d.ts +0 -7
  180. package/dist/types/models/PaginatedModerationLogList.d.ts +0 -7
  181. package/dist/types/models/PaginatedObservationList.d.ts +0 -7
  182. package/dist/types/models/PaginatedPeriodicAgentList.d.ts +0 -7
  183. package/dist/types/models/PaginatedPeriodicAgentLogList.d.ts +0 -7
  184. package/dist/types/models/PaginatedPlayWrightScriptList.d.ts +0 -7
  185. package/dist/types/models/PaginatedRetrieverDocumentEmbeddingList.d.ts +0 -7
  186. package/dist/types/models/PaginatedSectionList.d.ts +0 -7
  187. package/dist/types/models/PaginatedSubSectionList.d.ts +0 -7
  188. package/dist/types/models/PaginatedTicketMessageList.d.ts +0 -7
  189. package/dist/types/models/PaginatedTopicStatisticsResponse.d.ts +0 -7
  190. package/dist/types/models/PaginatedTraceList.d.ts +0 -7
  191. package/dist/types/models/PaginatedTrainingList.d.ts +0 -7
  192. package/dist/types/models/PaginatedUnitList.d.ts +0 -7
  193. package/dist/types/models/PaginatedUserEdxMemoryList.d.ts +0 -7
  194. package/dist/types/models/PaginatedUserMemoryList.d.ts +0 -7
  195. package/dist/types/models/PaginatedVoiceList.d.ts +0 -7
  196. package/dist/types/models/PatchedBotCommand.d.ts +0 -6
  197. package/dist/types/models/PatchedBotCreate.d.ts +0 -12
  198. package/dist/types/models/PatchedCallConfiguration.d.ts +0 -26
  199. package/dist/types/models/PatchedConversations.d.ts +0 -28
  200. package/dist/types/models/PatchedCourseCreationTaskFile.d.ts +0 -7
  201. package/dist/types/models/PatchedCredentialRequest.d.ts +0 -14
  202. package/dist/types/models/PatchedDataSet.d.ts +0 -21
  203. package/dist/types/models/PatchedDiscordConfig.d.ts +0 -7
  204. package/dist/types/models/PatchedDiscordUserConfig.d.ts +0 -10
  205. package/dist/types/models/PatchedHumanSupportTicket.d.ts +0 -21
  206. package/dist/types/models/PatchedLLMCredentialRequest.d.ts +0 -14
  207. package/dist/types/models/PatchedMCPServer.d.ts +0 -21
  208. package/dist/types/models/PatchedMentorCategoryGroupCreate.d.ts +0 -11
  209. package/dist/types/models/PatchedMentorCreate.d.ts +0 -84
  210. package/dist/types/models/PatchedPeriodicAgentCreate.d.ts +0 -41
  211. package/dist/types/models/PatchedPlayWrightScript.d.ts +0 -12
  212. package/dist/types/models/PatchedPrompt.d.ts +0 -22
  213. package/dist/types/models/PatchedSection.d.ts +0 -9
  214. package/dist/types/models/PatchedSlackConfig.d.ts +0 -8
  215. package/dist/types/models/PatchedSlackUserConfig.d.ts +0 -17
  216. package/dist/types/models/PatchedSubSection.d.ts +0 -9
  217. package/dist/types/models/PatchedTeamsConfig.d.ts +0 -7
  218. package/dist/types/models/PatchedTicketMessage.d.ts +0 -10
  219. package/dist/types/models/PatchedTrainingCreate.d.ts +0 -31
  220. package/dist/types/models/PatchedUnit.d.ts +0 -11
  221. package/dist/types/models/PatchedWebexConfig.d.ts +0 -10
  222. package/dist/types/models/PatchedWhatsappConfig.d.ts +0 -11
  223. package/dist/types/models/PatchedWhatsappUserConfig.d.ts +0 -10
  224. package/dist/types/models/PeriodicAgent.d.ts +0 -42
  225. package/dist/types/models/PeriodicAgentCreate.d.ts +0 -41
  226. package/dist/types/models/PeriodicAgentLog.d.ts +0 -11
  227. package/dist/types/models/PeriodicAgentLogStatusEnum.d.ts +0 -10
  228. package/dist/types/models/PeriodicTask.d.ts +0 -21
  229. package/dist/types/models/PieChartData.d.ts +0 -5
  230. package/dist/types/models/PieChartSegment.d.ts +0 -4
  231. package/dist/types/models/PinnedMessageCreate.d.ts +0 -9
  232. package/dist/types/models/PinnedMessageGet.d.ts +0 -7
  233. package/dist/types/models/PinnedMessageRequest.d.ts +0 -6
  234. package/dist/types/models/PlayWrightScript.d.ts +0 -12
  235. package/dist/types/models/PredictiveAnalyticsRequest.d.ts +0 -4
  236. package/dist/types/models/PredictiveAnalyticsResponse.d.ts +0 -4
  237. package/dist/types/models/PreviousAgentStatusEnum.d.ts +0 -12
  238. package/dist/types/models/Prompt.d.ts +0 -22
  239. package/dist/types/models/PromptCategory.d.ts +0 -7
  240. package/dist/types/models/PromptFacet.d.ts +0 -17
  241. package/dist/types/models/PromptSearchResponse.d.ts +0 -35
  242. package/dist/types/models/PromptVisibilityEnum.d.ts +0 -10
  243. package/dist/types/models/Provider05cEnum.d.ts +0 -14
  244. package/dist/types/models/Provider637Enum.d.ts +0 -10
  245. package/dist/types/models/Provider63aEnum.d.ts +0 -6
  246. package/dist/types/models/QuestionCardTag.d.ts +0 -8
  247. package/dist/types/models/QuestionRequest.d.ts +0 -15
  248. package/dist/types/models/QuestionResponse.d.ts +0 -10
  249. package/dist/types/models/RatingEnum.d.ts +0 -8
  250. package/dist/types/models/RatingRecord.d.ts +0 -4
  251. package/dist/types/models/RecentlyAccessedMentor.d.ts +0 -8
  252. package/dist/types/models/RecommendCourseBlock.d.ts +0 -3
  253. package/dist/types/models/RecommendCourseResponse.d.ts +0 -3
  254. package/dist/types/models/RecommendedCoursesResponse.d.ts +0 -33
  255. package/dist/types/models/RelatedText.d.ts +0 -3
  256. package/dist/types/models/RequestDataVariable.d.ts +0 -14
  257. package/dist/types/models/ResourceScrappedData.d.ts +0 -13
  258. package/dist/types/models/ResourceScrappedDataStatusEnum.d.ts +0 -12
  259. package/dist/types/models/ResponseDataVariable.d.ts +0 -14
  260. package/dist/types/models/RetreiverTrainViewRequest.d.ts +0 -10
  261. package/dist/types/models/RetreiverTrainViewResponse.d.ts +0 -6
  262. package/dist/types/models/RetrieveTask.d.ts +0 -3
  263. package/dist/types/models/RetrieverDocumentEmbedding.d.ts +0 -28
  264. package/dist/types/models/RetrieverDocumentEmbeddingRequest.d.ts +0 -66
  265. package/dist/types/models/RetrieverRequestSearch.d.ts +0 -10
  266. package/dist/types/models/RetrieverRequestSearchDocument.d.ts +0 -10
  267. package/dist/types/models/RetrieverResponseSearch.d.ts +0 -7
  268. package/dist/types/models/ReuestDataVariableList.d.ts +0 -4
  269. package/dist/types/models/RunMentorEval.d.ts +0 -3
  270. package/dist/types/models/ScanWebhookRequest.d.ts +0 -6
  271. package/dist/types/models/ScanWebhookResponse.d.ts +0 -3
  272. package/dist/types/models/Section.d.ts +0 -9
  273. package/dist/types/models/SectionWithChildren.d.ts +0 -11
  274. package/dist/types/models/SeedMentorsView.d.ts +0 -3
  275. package/dist/types/models/SentimentSummary.d.ts +0 -4
  276. package/dist/types/models/ServiceEnum.d.ts +0 -10
  277. package/dist/types/models/SessionBrowserScreenshot.d.ts +0 -8
  278. package/dist/types/models/SessionDetail.d.ts +0 -6
  279. package/dist/types/models/SessionMemoryAttachment.d.ts +0 -3
  280. package/dist/types/models/SessionMemoryStorage.d.ts +0 -6
  281. package/dist/types/models/ShareableMentorLink.d.ts +0 -8
  282. package/dist/types/models/ShellLogs.d.ts +0 -3
  283. package/dist/types/models/SlackConfig.d.ts +0 -8
  284. package/dist/types/models/SlackUserConfig.d.ts +0 -17
  285. package/dist/types/models/SlackWebhook.d.ts +0 -6
  286. package/dist/types/models/SpacedRepetitionLearningPath.d.ts +0 -3
  287. package/dist/types/models/SpacedRepetitionQuestionStats.d.ts +0 -5
  288. package/dist/types/models/StarMentor.d.ts +0 -7
  289. package/dist/types/models/Status6eeEnum.d.ts +0 -12
  290. package/dist/types/models/Step.d.ts +0 -9
  291. package/dist/types/models/StepStatusEnum.d.ts +0 -10
  292. package/dist/types/models/SttProviderEnum.d.ts +0 -12
  293. package/dist/types/models/StudentChatMessage.d.ts +0 -4
  294. package/dist/types/models/StylesView.d.ts +0 -4
  295. package/dist/types/models/SubSection.d.ts +0 -9
  296. package/dist/types/models/SubSectionWithChildren.d.ts +0 -11
  297. package/dist/types/models/TagsView.d.ts +0 -5
  298. package/dist/types/models/TargetSystemEnum.d.ts +0 -8
  299. package/dist/types/models/TaskView.d.ts +0 -3
  300. package/dist/types/models/TeamsConfig.d.ts +0 -7
  301. package/dist/types/models/TeamsWebhook.d.ts +0 -17
  302. package/dist/types/models/TemplateMentor.d.ts +0 -9
  303. package/dist/types/models/TenantMentorTraces.d.ts +0 -6
  304. package/dist/types/models/ThemeEnum.d.ts +0 -8
  305. package/dist/types/models/TicketMessage.d.ts +0 -10
  306. package/dist/types/models/TonesView.d.ts +0 -4
  307. package/dist/types/models/ToolResponse.d.ts +0 -12
  308. package/dist/types/models/TopicModel.d.ts +0 -3
  309. package/dist/types/models/TopicRecord.d.ts +0 -4
  310. package/dist/types/models/TopicStatistics.d.ts +0 -7
  311. package/dist/types/models/TopicStatisticsResponse.d.ts +0 -6
  312. package/dist/types/models/TopicSummaryView.d.ts +0 -4
  313. package/dist/types/models/Trace.d.ts +0 -17
  314. package/dist/types/models/TrainChatSessionDocumentView.d.ts +0 -6
  315. package/dist/types/models/TrainChatSessionDocumentViewRequest.d.ts +0 -6
  316. package/dist/types/models/TrainDocumentViewRequest.d.ts +0 -70
  317. package/dist/types/models/TrainDocumentViewResponse.d.ts +0 -15
  318. package/dist/types/models/Training.d.ts +0 -41
  319. package/dist/types/models/TrainingCreate.d.ts +0 -31
  320. package/dist/types/models/TrainingStatusEnum.d.ts +0 -12
  321. package/dist/types/models/TransportEnum.d.ts +0 -8
  322. package/dist/types/models/TrendEntry.d.ts +0 -4
  323. package/dist/types/models/TriggerRequest.d.ts +0 -5
  324. package/dist/types/models/TriggerResponse.d.ts +0 -6
  325. package/dist/types/models/TtsProviderEnum.d.ts +0 -10
  326. package/dist/types/models/TypeC42Enum.d.ts +0 -8
  327. package/dist/types/models/Unit.d.ts +0 -11
  328. package/dist/types/models/UnitWithChildren.d.ts +0 -13
  329. package/dist/types/models/UseMainCreds.d.ts +0 -3
  330. package/dist/types/models/UserAllChatMemoryView.d.ts +0 -7
  331. package/dist/types/models/UserCatalogItemMemoryView.d.ts +0 -14
  332. package/dist/types/models/UserChatByPeriod.d.ts +0 -4
  333. package/dist/types/models/UserChatFeedback.d.ts +0 -15
  334. package/dist/types/models/UserChatFeedbackCount.d.ts +0 -4
  335. package/dist/types/models/UserChatMemoryStatusRequestView.d.ts +0 -6
  336. package/dist/types/models/UserChatMemoryStatusView.d.ts +0 -6
  337. package/dist/types/models/UserChatMemoryUpdateView.d.ts +0 -10
  338. package/dist/types/models/UserCountRecord.d.ts +0 -4
  339. package/dist/types/models/UserEdxMemory.d.ts +0 -15
  340. package/dist/types/models/UserMemory.d.ts +0 -17
  341. package/dist/types/models/UserMemoryContextRequest.d.ts +0 -13
  342. package/dist/types/models/UserMemoryContextResponse.d.ts +0 -12
  343. package/dist/types/models/UserMemoryEntry.d.ts +0 -7
  344. package/dist/types/models/UserMemoryEntryRequest.d.ts +0 -5
  345. package/dist/types/models/UserMemoryRequest.d.ts +0 -12
  346. package/dist/types/models/UserMetric.d.ts +0 -4
  347. package/dist/types/models/UserMetricsResponse.d.ts +0 -7
  348. package/dist/types/models/UserSentimentCountView.d.ts +0 -4
  349. package/dist/types/models/UserTrendByPeriod.d.ts +0 -5
  350. package/dist/types/models/VectorResult.d.ts +0 -8
  351. package/dist/types/models/VideoCaption.d.ts +0 -3
  352. package/dist/types/models/Voice.d.ts +0 -9
  353. package/dist/types/models/WebResource.d.ts +0 -9
  354. package/dist/types/models/WebResourceCard.d.ts +0 -7
  355. package/dist/types/models/WebResourcesQuery.d.ts +0 -3
  356. package/dist/types/models/WebexConfig.d.ts +0 -10
  357. package/dist/types/models/WebexWebhook.d.ts +0 -4
  358. package/dist/types/models/WhatAppWebHook.d.ts +0 -3
  359. package/dist/types/models/WhatsappConfig.d.ts +0 -11
  360. package/dist/types/models/WhatsappUserConfig.d.ts +0 -10
  361. package/dist/types/services/AiAccountService.d.ts +0 -419
  362. package/dist/types/services/AiBotService.d.ts +0 -642
  363. package/dist/types/services/AiFinetuningService.d.ts +0 -232
  364. package/dist/types/services/AiIndexService.d.ts +0 -384
  365. package/dist/types/services/AiMarketingService.d.ts +0 -38
  366. package/dist/types/services/AiMediaService.d.ts +0 -122
  367. package/dist/types/services/AiMentorService.d.ts +0 -5402
  368. package/dist/types/services/AiPromptService.d.ts +0 -1035
  369. package/src/models/AIGeneratedImage.ts +0 -18
  370. package/src/models/AIUserProfileMemoryRelation.ts +0 -9
  371. package/src/models/AIUserProfileRequest.ts +0 -9
  372. package/src/models/AccessEnum.ts +0 -12
  373. package/src/models/AlignMentorBubbleEnum.ts +0 -12
  374. package/src/models/AnalyticsOverview.ts +0 -12
  375. package/src/models/Answer.ts +0 -16
  376. package/src/models/AssumedKnowledge.ts +0 -9
  377. package/src/models/AssumedKnowledgeLevel.ts +0 -9
  378. package/src/models/AudioToTextRequest.ts +0 -8
  379. package/src/models/AudioToTextResponse.ts +0 -8
  380. package/src/models/AutoMemoryPrompt.ts +0 -9
  381. package/src/models/Bot.ts +0 -20
  382. package/src/models/BotCommand.ts +0 -11
  383. package/src/models/BotCreate.ts +0 -17
  384. package/src/models/CallAuthenticationRequest.ts +0 -18
  385. package/src/models/CallAuthenticationResponse.ts +0 -26
  386. package/src/models/CallConfiguration.ts +0 -31
  387. package/src/models/CallConfigurationModeEnum.ts +0 -12
  388. package/src/models/ChatHistory.ts +0 -13
  389. package/src/models/ChatHistoryFilterData.ts +0 -14
  390. package/src/models/ChatHistoryFilterUser.ts +0 -10
  391. package/src/models/ChatHistoryItem.ts +0 -10
  392. package/src/models/ChatHistorySessionId.ts +0 -8
  393. package/src/models/ChatSessionRequest.ts +0 -19
  394. package/src/models/ChatSessionResponse.ts +0 -10
  395. package/src/models/CheckDocumentTrainingStatus.ts +0 -15
  396. package/src/models/ComponentBlock.ts +0 -14
  397. package/src/models/ComponentBlockTypeEnum.ts +0 -12
  398. package/src/models/ConnectedService.ts +0 -14
  399. package/src/models/ConnectedServiceProviderEnum.ts +0 -10
  400. package/src/models/ConversationMessage.ts +0 -16
  401. package/src/models/ConversationRating.ts +0 -11
  402. package/src/models/ConversationSummary.ts +0 -10
  403. package/src/models/ConversationVolume.ts +0 -9
  404. package/src/models/Conversations.ts +0 -33
  405. package/src/models/Cost.ts +0 -8
  406. package/src/models/CostPerTenant.ts +0 -11
  407. package/src/models/CourseCreationTask.ts +0 -36
  408. package/src/models/CourseCreationTaskFile.ts +0 -12
  409. package/src/models/CourseCreationTaskStatusEnum.ts +0 -20
  410. package/src/models/CrawlerPatternTypeEnum.ts +0 -12
  411. package/src/models/CredentialRequest.ts +0 -19
  412. package/src/models/CrontabSchedule.ts +0 -27
  413. package/src/models/CustomInstructionResponse.ts +0 -18
  414. package/src/models/DataSet.ts +0 -26
  415. package/src/models/DataSetCreate.ts +0 -17
  416. package/src/models/DataSetStatusEnum.ts +0 -16
  417. package/src/models/DateRange.ts +0 -9
  418. package/src/models/DiscordConfig.ts +0 -12
  419. package/src/models/DiscordUserConfig.ts +0 -15
  420. package/src/models/DiscordWebhook.ts +0 -11
  421. package/src/models/Document.ts +0 -46
  422. package/src/models/DocumentFacet.ts +0 -22
  423. package/src/models/DocumentSearchResponse.ts +0 -40
  424. package/src/models/DocumentSettingsResponse.ts +0 -8
  425. package/src/models/EdxCourse.ts +0 -16
  426. package/src/models/ElevenlabsCustomVoice.ts +0 -9
  427. package/src/models/ElevenlabsCustomVoiceResponse.ts +0 -13
  428. package/src/models/EmailPromptDetail.ts +0 -18
  429. package/src/models/EmailPromptList.ts +0 -16
  430. package/src/models/EmailPromptSummary.ts +0 -10
  431. package/src/models/FreeUsageCount.ts +0 -8
  432. package/src/models/FullCourse.ts +0 -18
  433. package/src/models/GreetingMethodEnum.ts +0 -12
  434. package/src/models/GuidedPrompt.ts +0 -9
  435. package/src/models/GuidedPromptsResponse.ts +0 -10
  436. package/src/models/HeygenMarketingVideoDetail.ts +0 -13
  437. package/src/models/HeygenMarketingVideoList.ts +0 -11
  438. package/src/models/HeygenTemplateRequest.ts +0 -10
  439. package/src/models/HeygenTemplateResponseSingle.ts +0 -11
  440. package/src/models/HeygenVideoDetail.ts +0 -13
  441. package/src/models/HeygenVideoRequest.ts +0 -10
  442. package/src/models/HumanSupportTicket.ts +0 -26
  443. package/src/models/HumanSupportTicketStatusEnum.ts +0 -14
  444. package/src/models/InputQuestion.ts +0 -11
  445. package/src/models/IntegrationCredential.ts +0 -13
  446. package/src/models/IntegrationCredentialSchema.ts +0 -9
  447. package/src/models/IntialQuestionAnswer.ts +0 -8
  448. package/src/models/JobRun.ts +0 -16
  449. package/src/models/KindEnum.ts +0 -14
  450. package/src/models/LLMCredentialRequest.ts +0 -19
  451. package/src/models/LLMCredentialResponse.ts +0 -13
  452. package/src/models/LLMCredentialSchema.ts +0 -9
  453. package/src/models/LLMModelForTenant.ts +0 -11
  454. package/src/models/LLMQuestion.ts +0 -20
  455. package/src/models/LLMResponse.ts +0 -19
  456. package/src/models/LLMTracesListResponse.ts +0 -10
  457. package/src/models/LanguagesView.ts +0 -10
  458. package/src/models/LinkCourseRequest.ts +0 -8
  459. package/src/models/LinkCourseResponse.ts +0 -10
  460. package/src/models/LlmProviderEnum.ts +0 -12
  461. package/src/models/MCPServer.ts +0 -26
  462. package/src/models/MemoryComponentData.ts +0 -10
  463. package/src/models/MemoryComponentMemory.ts +0 -9
  464. package/src/models/MemoryComponentMemoryDetail.ts +0 -13
  465. package/src/models/MemoryComponentResponse.ts +0 -10
  466. package/src/models/MemoryProgress.ts +0 -13
  467. package/src/models/MemoryStatusRequestView.ts +0 -11
  468. package/src/models/MemoryStatusView.ts +0 -11
  469. package/src/models/Mentor.ts +0 -92
  470. package/src/models/MentorAudience.ts +0 -10
  471. package/src/models/MentorCategory.ts +0 -14
  472. package/src/models/MentorCategoryCreate.ts +0 -16
  473. package/src/models/MentorCategoryGroup.ts +0 -16
  474. package/src/models/MentorCategoryGroupCreate.ts +0 -16
  475. package/src/models/MentorCreate.ts +0 -89
  476. package/src/models/MentorCustomVoice.ts +0 -9
  477. package/src/models/MentorCustomVoiceResponse.ts +0 -9
  478. package/src/models/MentorData.ts +0 -12
  479. package/src/models/MentorDetailAnalytics.ts +0 -11
  480. package/src/models/MentorEval.ts +0 -16
  481. package/src/models/MentorEvalQuestion.ts +0 -10
  482. package/src/models/MentorEvalQuestionRequest.ts +0 -9
  483. package/src/models/MentorEvalReport.ts +0 -15
  484. package/src/models/MentorEvalRequest.ts +0 -13
  485. package/src/models/MentorFacet.ts +0 -22
  486. package/src/models/MentorFork.ts +0 -10
  487. package/src/models/MentorFromTemplateWithSettingRequest.ts +0 -52
  488. package/src/models/MentorMemorySettingsRequest.ts +0 -11
  489. package/src/models/MentorMemorySettingsResponse.ts +0 -11
  490. package/src/models/MentorMetadata.ts +0 -10
  491. package/src/models/MentorScenario.ts +0 -11
  492. package/src/models/MentorScenarioPrompt.ts +0 -10
  493. package/src/models/MentorSearchResponse.ts +0 -40
  494. package/src/models/MentorSession.ts +0 -9
  495. package/src/models/MentorSettings.ts +0 -81
  496. package/src/models/MentorSettingsPublic.ts +0 -57
  497. package/src/models/MentorSettingsRequest.ts +0 -67
  498. package/src/models/MentorVisibilityEnum.ts +0 -14
  499. package/src/models/MentorWizard.ts +0 -9
  500. package/src/models/MessageStatistics.ts +0 -10
  501. package/src/models/MessageView.ts +0 -15
  502. package/src/models/MessageViewRequest.ts +0 -12
  503. package/src/models/MessageViewUpdatResponse.ts +0 -8
  504. package/src/models/Metadata.ts +0 -10
  505. package/src/models/MetricChange.ts +0 -9
  506. package/src/models/ModelCost.ts +0 -9
  507. package/src/models/ModerationLog.ts +0 -16
  508. package/src/models/NoChatMessagesFound.ts +0 -8
  509. package/src/models/NullEnum.ts +0 -7
  510. package/src/models/OAuthStartResponse.ts +0 -8
  511. package/src/models/Observation.ts +0 -36
  512. package/src/models/PageContent.ts +0 -11
  513. package/src/models/PaginatedAIGeneratedImageList.ts +0 -12
  514. package/src/models/PaginatedConversationsList.ts +0 -12
  515. package/src/models/PaginatedCourseCreationTaskFileList.ts +0 -12
  516. package/src/models/PaginatedCourseCreationTaskList.ts +0 -12
  517. package/src/models/PaginatedDataSetList.ts +0 -12
  518. package/src/models/PaginatedEdxCourseList.ts +0 -12
  519. package/src/models/PaginatedEmailPromptListList.ts +0 -12
  520. package/src/models/PaginatedHeygenMarketingVideoListList.ts +0 -12
  521. package/src/models/PaginatedHeygenTemplateResponseSingleList.ts +0 -12
  522. package/src/models/PaginatedHumanSupportTicketList.ts +0 -12
  523. package/src/models/PaginatedJobRunList.ts +0 -12
  524. package/src/models/PaginatedMCPServerList.ts +0 -12
  525. package/src/models/PaginatedMentorList.ts +0 -12
  526. package/src/models/PaginatedModerationLogList.ts +0 -12
  527. package/src/models/PaginatedObservationList.ts +0 -12
  528. package/src/models/PaginatedPeriodicAgentList.ts +0 -12
  529. package/src/models/PaginatedPeriodicAgentLogList.ts +0 -12
  530. package/src/models/PaginatedPlayWrightScriptList.ts +0 -12
  531. package/src/models/PaginatedRetrieverDocumentEmbeddingList.ts +0 -12
  532. package/src/models/PaginatedSectionList.ts +0 -12
  533. package/src/models/PaginatedSubSectionList.ts +0 -12
  534. package/src/models/PaginatedTicketMessageList.ts +0 -12
  535. package/src/models/PaginatedTopicStatisticsResponse.ts +0 -12
  536. package/src/models/PaginatedTraceList.ts +0 -12
  537. package/src/models/PaginatedTrainingList.ts +0 -12
  538. package/src/models/PaginatedUnitList.ts +0 -12
  539. package/src/models/PaginatedUserEdxMemoryList.ts +0 -12
  540. package/src/models/PaginatedUserMemoryList.ts +0 -12
  541. package/src/models/PaginatedVoiceList.ts +0 -12
  542. package/src/models/PatchedBotCommand.ts +0 -11
  543. package/src/models/PatchedBotCreate.ts +0 -17
  544. package/src/models/PatchedCallConfiguration.ts +0 -31
  545. package/src/models/PatchedConversations.ts +0 -33
  546. package/src/models/PatchedCourseCreationTaskFile.ts +0 -12
  547. package/src/models/PatchedCredentialRequest.ts +0 -19
  548. package/src/models/PatchedDataSet.ts +0 -26
  549. package/src/models/PatchedDiscordConfig.ts +0 -12
  550. package/src/models/PatchedDiscordUserConfig.ts +0 -15
  551. package/src/models/PatchedHumanSupportTicket.ts +0 -26
  552. package/src/models/PatchedLLMCredentialRequest.ts +0 -19
  553. package/src/models/PatchedMCPServer.ts +0 -26
  554. package/src/models/PatchedMentorCategoryGroupCreate.ts +0 -16
  555. package/src/models/PatchedMentorCreate.ts +0 -89
  556. package/src/models/PatchedPeriodicAgentCreate.ts +0 -46
  557. package/src/models/PatchedPlayWrightScript.ts +0 -17
  558. package/src/models/PatchedPrompt.ts +0 -27
  559. package/src/models/PatchedSection.ts +0 -14
  560. package/src/models/PatchedSlackConfig.ts +0 -13
  561. package/src/models/PatchedSlackUserConfig.ts +0 -22
  562. package/src/models/PatchedSubSection.ts +0 -14
  563. package/src/models/PatchedTeamsConfig.ts +0 -12
  564. package/src/models/PatchedTicketMessage.ts +0 -15
  565. package/src/models/PatchedTrainingCreate.ts +0 -36
  566. package/src/models/PatchedUnit.ts +0 -16
  567. package/src/models/PatchedWebexConfig.ts +0 -15
  568. package/src/models/PatchedWhatsappConfig.ts +0 -16
  569. package/src/models/PatchedWhatsappUserConfig.ts +0 -15
  570. package/src/models/PeriodicAgent.ts +0 -47
  571. package/src/models/PeriodicAgentCreate.ts +0 -46
  572. package/src/models/PeriodicAgentLog.ts +0 -16
  573. package/src/models/PeriodicAgentLogStatusEnum.ts +0 -14
  574. package/src/models/PeriodicTask.ts +0 -26
  575. package/src/models/PieChartData.ts +0 -10
  576. package/src/models/PieChartSegment.ts +0 -9
  577. package/src/models/PinnedMessageCreate.ts +0 -14
  578. package/src/models/PinnedMessageGet.ts +0 -12
  579. package/src/models/PinnedMessageRequest.ts +0 -11
  580. package/src/models/PlayWrightScript.ts +0 -17
  581. package/src/models/PredictiveAnalyticsRequest.ts +0 -9
  582. package/src/models/PredictiveAnalyticsResponse.ts +0 -9
  583. package/src/models/PreviousAgentStatusEnum.ts +0 -16
  584. package/src/models/Prompt.ts +0 -27
  585. package/src/models/PromptCategory.ts +0 -12
  586. package/src/models/PromptFacet.ts +0 -22
  587. package/src/models/PromptSearchResponse.ts +0 -40
  588. package/src/models/PromptVisibilityEnum.ts +0 -14
  589. package/src/models/Provider05cEnum.ts +0 -18
  590. package/src/models/Provider637Enum.ts +0 -14
  591. package/src/models/Provider63aEnum.ts +0 -10
  592. package/src/models/QuestionCardTag.ts +0 -13
  593. package/src/models/QuestionRequest.ts +0 -20
  594. package/src/models/QuestionResponse.ts +0 -15
  595. package/src/models/RatingEnum.ts +0 -12
  596. package/src/models/RatingRecord.ts +0 -9
  597. package/src/models/RecentlyAccessedMentor.ts +0 -13
  598. package/src/models/RecommendCourseBlock.ts +0 -8
  599. package/src/models/RecommendCourseResponse.ts +0 -8
  600. package/src/models/RecommendedCoursesResponse.ts +0 -38
  601. package/src/models/RelatedText.ts +0 -8
  602. package/src/models/RequestDataVariable.ts +0 -19
  603. package/src/models/ResourceScrappedData.ts +0 -18
  604. package/src/models/ResourceScrappedDataStatusEnum.ts +0 -16
  605. package/src/models/ResponseDataVariable.ts +0 -19
  606. package/src/models/RetreiverTrainViewRequest.ts +0 -15
  607. package/src/models/RetreiverTrainViewResponse.ts +0 -11
  608. package/src/models/RetrieveTask.ts +0 -8
  609. package/src/models/RetrieverDocumentEmbedding.ts +0 -33
  610. package/src/models/RetrieverDocumentEmbeddingRequest.ts +0 -71
  611. package/src/models/RetrieverRequestSearch.ts +0 -15
  612. package/src/models/RetrieverRequestSearchDocument.ts +0 -15
  613. package/src/models/RetrieverResponseSearch.ts +0 -12
  614. package/src/models/ReuestDataVariableList.ts +0 -9
  615. package/src/models/RunMentorEval.ts +0 -8
  616. package/src/models/ScanWebhookRequest.ts +0 -11
  617. package/src/models/ScanWebhookResponse.ts +0 -8
  618. package/src/models/Section.ts +0 -14
  619. package/src/models/SectionWithChildren.ts +0 -16
  620. package/src/models/SeedMentorsView.ts +0 -8
  621. package/src/models/SentimentSummary.ts +0 -9
  622. package/src/models/ServiceEnum.ts +0 -14
  623. package/src/models/SessionBrowserScreenshot.ts +0 -13
  624. package/src/models/SessionDetail.ts +0 -11
  625. package/src/models/SessionMemoryAttachment.ts +0 -8
  626. package/src/models/SessionMemoryStorage.ts +0 -11
  627. package/src/models/ShareableMentorLink.ts +0 -13
  628. package/src/models/ShellLogs.ts +0 -8
  629. package/src/models/SlackConfig.ts +0 -13
  630. package/src/models/SlackUserConfig.ts +0 -22
  631. package/src/models/SlackWebhook.ts +0 -11
  632. package/src/models/SpacedRepetitionLearningPath.ts +0 -8
  633. package/src/models/SpacedRepetitionQuestionStats.ts +0 -10
  634. package/src/models/StarMentor.ts +0 -12
  635. package/src/models/Status6eeEnum.ts +0 -16
  636. package/src/models/Step.ts +0 -14
  637. package/src/models/StepStatusEnum.ts +0 -14
  638. package/src/models/SttProviderEnum.ts +0 -16
  639. package/src/models/StudentChatMessage.ts +0 -9
  640. package/src/models/StylesView.ts +0 -9
  641. package/src/models/SubSection.ts +0 -14
  642. package/src/models/SubSectionWithChildren.ts +0 -16
  643. package/src/models/TagsView.ts +0 -10
  644. package/src/models/TargetSystemEnum.ts +0 -12
  645. package/src/models/TaskView.ts +0 -8
  646. package/src/models/TeamsConfig.ts +0 -12
  647. package/src/models/TeamsWebhook.ts +0 -22
  648. package/src/models/TemplateMentor.ts +0 -14
  649. package/src/models/TenantMentorTraces.ts +0 -11
  650. package/src/models/ThemeEnum.ts +0 -12
  651. package/src/models/TicketMessage.ts +0 -15
  652. package/src/models/TonesView.ts +0 -9
  653. package/src/models/ToolResponse.ts +0 -17
  654. package/src/models/TopicModel.ts +0 -8
  655. package/src/models/TopicRecord.ts +0 -9
  656. package/src/models/TopicStatistics.ts +0 -12
  657. package/src/models/TopicStatisticsResponse.ts +0 -11
  658. package/src/models/TopicSummaryView.ts +0 -9
  659. package/src/models/Trace.ts +0 -22
  660. package/src/models/TrainChatSessionDocumentView.ts +0 -11
  661. package/src/models/TrainChatSessionDocumentViewRequest.ts +0 -11
  662. package/src/models/TrainDocumentViewRequest.ts +0 -75
  663. package/src/models/TrainDocumentViewResponse.ts +0 -20
  664. package/src/models/Training.ts +0 -46
  665. package/src/models/TrainingCreate.ts +0 -36
  666. package/src/models/TrainingStatusEnum.ts +0 -16
  667. package/src/models/TransportEnum.ts +0 -12
  668. package/src/models/TrendEntry.ts +0 -9
  669. package/src/models/TriggerRequest.ts +0 -10
  670. package/src/models/TriggerResponse.ts +0 -11
  671. package/src/models/TtsProviderEnum.ts +0 -14
  672. package/src/models/TypeC42Enum.ts +0 -12
  673. package/src/models/Unit.ts +0 -16
  674. package/src/models/UnitWithChildren.ts +0 -18
  675. package/src/models/UseMainCreds.ts +0 -8
  676. package/src/models/UserAllChatMemoryView.ts +0 -12
  677. package/src/models/UserCatalogItemMemoryView.ts +0 -19
  678. package/src/models/UserChatByPeriod.ts +0 -9
  679. package/src/models/UserChatFeedback.ts +0 -20
  680. package/src/models/UserChatFeedbackCount.ts +0 -9
  681. package/src/models/UserChatMemoryStatusRequestView.ts +0 -11
  682. package/src/models/UserChatMemoryStatusView.ts +0 -11
  683. package/src/models/UserChatMemoryUpdateView.ts +0 -15
  684. package/src/models/UserCountRecord.ts +0 -9
  685. package/src/models/UserEdxMemory.ts +0 -20
  686. package/src/models/UserMemory.ts +0 -22
  687. package/src/models/UserMemoryContextRequest.ts +0 -18
  688. package/src/models/UserMemoryContextResponse.ts +0 -17
  689. package/src/models/UserMemoryEntry.ts +0 -12
  690. package/src/models/UserMemoryEntryRequest.ts +0 -10
  691. package/src/models/UserMemoryRequest.ts +0 -17
  692. package/src/models/UserMetric.ts +0 -9
  693. package/src/models/UserMetricsResponse.ts +0 -12
  694. package/src/models/UserSentimentCountView.ts +0 -9
  695. package/src/models/UserTrendByPeriod.ts +0 -10
  696. package/src/models/VectorResult.ts +0 -13
  697. package/src/models/VideoCaption.ts +0 -8
  698. package/src/models/Voice.ts +0 -14
  699. package/src/models/WebResource.ts +0 -14
  700. package/src/models/WebResourceCard.ts +0 -12
  701. package/src/models/WebResourcesQuery.ts +0 -8
  702. package/src/models/WebexConfig.ts +0 -15
  703. package/src/models/WebexWebhook.ts +0 -9
  704. package/src/models/WhatAppWebHook.ts +0 -8
  705. package/src/models/WhatsappConfig.ts +0 -16
  706. package/src/models/WhatsappUserConfig.ts +0 -15
  707. package/src/services/AiAccountService.ts +0 -673
  708. package/src/services/AiBotService.ts +0 -1330
  709. package/src/services/AiFinetuningService.ts +0 -472
  710. package/src/services/AiIndexService.ts +0 -676
  711. package/src/services/AiMarketingService.ts +0 -96
  712. package/src/services/AiMediaService.ts +0 -289
  713. package/src/services/AiMentorService.ts +0 -10023
  714. package/src/services/AiPromptService.ts +0 -1985
@@ -1,17 +1,9 @@
1
1
  import type { ActiveUsersList } from '../models/ActiveUsersList';
2
2
  import type { ActiveUsersPerCourse } from '../models/ActiveUsersPerCourse';
3
3
  import type { ActivityAPI } from '../models/ActivityAPI';
4
- import type { AnalyticsOverview } from '../models/AnalyticsOverview';
5
4
  import type { Average } from '../models/Average';
6
5
  import type { AverageOvertime } from '../models/AverageOvertime';
7
6
  import type { AvgCourseGradeWithCutoff } from '../models/AvgCourseGradeWithCutoff';
8
- import type { ChatHistoryFilterData } from '../models/ChatHistoryFilterData';
9
- import type { ConversationMessage } from '../models/ConversationMessage';
10
- import type { Conversations } from '../models/Conversations';
11
- import type { ConversationSummary } from '../models/ConversationSummary';
12
- import type { ConversationVolume } from '../models/ConversationVolume';
13
- import type { Cost } from '../models/Cost';
14
- import type { CostPerTenant } from '../models/CostPerTenant';
15
7
  import type { Count } from '../models/Count';
16
8
  import type { CourseCompletionPerCourse } from '../models/CourseCompletionPerCourse';
17
9
  import type { CourseCompletionSummaryOvertime } from '../models/CourseCompletionSummaryOvertime';
@@ -22,21 +14,10 @@ import type { EngagementPerCourse } from '../models/EngagementPerCourse';
22
14
  import type { Enrollments } from '../models/Enrollments';
23
15
  import type { EnrollmentsPerUser } from '../models/EnrollmentsPerUser';
24
16
  import type { GradingPerUser } from '../models/GradingPerUser';
25
- import type { GroupList } from '../models/GroupList';
26
17
  import type { LearnerInformationAPI } from '../models/LearnerInformationAPI';
27
- import type { LLMTracesListResponse } from '../models/LLMTracesListResponse';
28
- import type { MentorDetailAnalytics } from '../models/MentorDetailAnalytics';
29
- import type { MessageStatistics } from '../models/MessageStatistics';
30
- import type { ModelCost } from '../models/ModelCost';
31
18
  import type { NewPerLearnerList } from '../models/NewPerLearnerList';
32
- import type { Observation } from '../models/Observation';
33
19
  import type { OvertimeWithChangeInfo } from '../models/OvertimeWithChangeInfo';
34
20
  import type { OverTimeWithTotal } from '../models/OverTimeWithTotal';
35
- import type { PaginatedConversationsList } from '../models/PaginatedConversationsList';
36
- import type { PaginatedObservationList } from '../models/PaginatedObservationList';
37
- import type { PaginatedTopicStatisticsResponse } from '../models/PaginatedTopicStatisticsResponse';
38
- import type { PaginatedTraceList } from '../models/PaginatedTraceList';
39
- import type { PatchedConversations } from '../models/PatchedConversations';
40
21
  import type { PerformanceGradesPerCourse } from '../models/PerformanceGradesPerCourse';
41
22
  import type { PerlearnerCourseProgress } from '../models/PerlearnerCourseProgress';
42
23
  import type { PerLearnerCourseVideosWatched } from '../models/PerLearnerCourseVideosWatched';
@@ -47,28 +28,12 @@ import type { PerlearnerGradingPerCourseAPI } from '../models/PerlearnerGradingP
47
28
  import type { PerLearnerLastAccess } from '../models/PerLearnerLastAccess';
48
29
  import type { PerLearnerTimeSpentInCourseTree } from '../models/PerLearnerTimeSpentInCourseTree';
49
30
  import type { PerlearnerUserList } from '../models/PerlearnerUserList';
50
- import type { PieChartData } from '../models/PieChartData';
51
- import type { RatingRecord } from '../models/RatingRecord';
52
- import type { SentimentSummary } from '../models/SentimentSummary';
53
- import type { StudentChatMessage } from '../models/StudentChatMessage';
54
- import type { TenantMentorTraces } from '../models/TenantMentorTraces';
55
31
  import type { TimeDetail } from '../models/TimeDetail';
56
32
  import type { TimeSpentByUsersInCourse } from '../models/TimeSpentByUsersInCourse';
57
33
  import type { TimeSpentPerCourse } from '../models/TimeSpentPerCourse';
58
34
  import type { TimeSpentPerUserResponse } from '../models/TimeSpentPerUserResponse';
59
35
  import type { TimeSpentUpdateRequest } from '../models/TimeSpentUpdateRequest';
60
36
  import type { TimeSpentUpdateResponse } from '../models/TimeSpentUpdateResponse';
61
- import type { TopicRecord } from '../models/TopicRecord';
62
- import type { TopicStatisticsResponse } from '../models/TopicStatisticsResponse';
63
- import type { TopicSummaryView } from '../models/TopicSummaryView';
64
- import type { Trace } from '../models/Trace';
65
- import type { TrendEntry } from '../models/TrendEntry';
66
- import type { UserChatByPeriod } from '../models/UserChatByPeriod';
67
- import type { UserChatFeedbackCount } from '../models/UserChatFeedbackCount';
68
- import type { UserCountRecord } from '../models/UserCountRecord';
69
- import type { UserMetricsResponse } from '../models/UserMetricsResponse';
70
- import type { UserSentimentCountView } from '../models/UserSentimentCountView';
71
- import type { UserTrendByPeriod } from '../models/UserTrendByPeriod';
72
37
  import type { Value } from '../models/Value';
73
38
  import type { VideoEngagementPerCourse } from '../models/VideoEngagementPerCourse';
74
39
  import type { VideosCount } from '../models/VideosCount';
@@ -78,3905 +43,6 @@ import type { WatchedVideosPerCourse } from '../models/WatchedVideosPerCourse';
78
43
  import type { WatchedVideosPerUser } from '../models/WatchedVideosPerUser';
79
44
  import type { CancelablePromise } from '../core/CancelablePromise';
80
45
  export declare class AiAnalyticsService {
81
- /**
82
- * Get active user counts over time.
83
- *
84
- * This endpoint provides daily counts of active users (users with known activity)
85
- * over a specified time period.
86
- *
87
- * Query Parameters:
88
- * start_date (str, optional): Start date for the time range (ISO format)
89
- * end_date (str, optional): End date for the time range (ISO format)
90
- *
91
- * Returns:
92
- * Daily active user counts over the specified time period, with change metrics
93
- * compared to previous periods.
94
- *
95
- * Default time range is the last 7 days if no dates are specified.
96
- *
97
- * An active user is defined as a user with any activity within the past 30 days.
98
- * @returns OvertimeWithChangeInfo
99
- * @throws ApiError
100
- */
101
- static aiAnalyticsAudienceOrgsActiveUsersOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
102
- org: string;
103
- /**
104
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
105
- */
106
- departmentId?: number;
107
- /**
108
- * end date. ISO 8601
109
- */
110
- endDate?: string;
111
- /**
112
- * Format
113
- *
114
- * * `json` - json
115
- */
116
- format?: 'json';
117
- /**
118
- * Include main platform data
119
- */
120
- includeMainPlatform?: boolean;
121
- /**
122
- * start date. ISO 8601
123
- */
124
- startDate?: string;
125
- }): CancelablePromise<OvertimeWithChangeInfo>;
126
- /**
127
- * Get active user counts on a per-course basis.
128
- *
129
- * This endpoint provides counts of active users for each course within
130
- * the specified date range.
131
- *
132
- * Query Parameters:
133
- * start_date (str, optional): Start date for filtering (ISO format)
134
- * end_date (str, optional): End date for filtering (ISO format)
135
- *
136
- * Returns:
137
- * A list of courses with their active user counts.
138
- *
139
- * Default time range is the last 7 days if no dates are specified.
140
- * @returns ActiveUsersPerCourse
141
- * @throws ApiError
142
- */
143
- static aiAnalyticsAudienceOrgsActiveUsersPerCourseRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
144
- org: string;
145
- /**
146
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
147
- */
148
- departmentId?: number;
149
- /**
150
- * end date. ISO 8601
151
- */
152
- endDate?: string;
153
- /**
154
- * Format
155
- *
156
- * * `json` - json
157
- */
158
- format?: 'json';
159
- /**
160
- * Include main platform data
161
- */
162
- includeMainPlatform?: boolean;
163
- /**
164
- * start date. ISO 8601
165
- */
166
- startDate?: string;
167
- }): CancelablePromise<ActiveUsersPerCourse>;
168
- /**
169
- * Get a list of active users with activity metrics.
170
- *
171
- * This endpoint provides a paginated list of users who have had activity
172
- * within the specified date range.
173
- *
174
- * Query Parameters:
175
- * start_date (str, optional): Start date for filtering (ISO format)
176
- * end_date (str, optional): End date for filtering (ISO format)
177
- * course_id (str, optional): Filter by course ID
178
- * page (int, optional): Page number for pagination
179
- * length (int, optional): Number of items per page
180
- *
181
- * Returns:
182
- * A paginated list of active users with their activity metrics.
183
- *
184
- * Default time range is the last 7 days if no dates are specified.
185
- * @returns ActiveUsersList
186
- * @throws ApiError
187
- */
188
- static aiAnalyticsAudienceOrgsActiveUsersUsersRetrieve({ org, departmentId, format, includeMainPlatform, length, page, }: {
189
- org: string;
190
- /**
191
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
192
- */
193
- departmentId?: number;
194
- /**
195
- * Format
196
- *
197
- * * `json` - json
198
- */
199
- format?: 'json';
200
- /**
201
- * Include main platform data
202
- */
203
- includeMainPlatform?: boolean;
204
- /**
205
- * Size of data to return
206
- */
207
- length?: number;
208
- /**
209
- * Page offset
210
- */
211
- page?: number;
212
- }): CancelablePromise<ActiveUsersList>;
213
- /**
214
- * Get enrollment or unenrollment counts over time.
215
- *
216
- * This endpoint provides daily counts of new enrollments or unenrollments
217
- * over a specified time period.
218
- *
219
- * Query Parameters:
220
- * start_date (str, optional): Start date for the time range (ISO format)
221
- * end_date (str, optional): End date for the time range (ISO format)
222
- * course_id (str, optional): Filter by course ID
223
- * active (bool): Get enrollments when true, unenrollments when false
224
- *
225
- * Returns:
226
- * Daily counts over the specified time period, with change metrics
227
- * compared to previous periods.
228
- *
229
- * Default time range is the last 7 days if no dates are specified.
230
- * @returns OvertimeWithChangeInfo
231
- * @throws ApiError
232
- */
233
- static aiAnalyticsAudienceOrgsEnrollmentsCoursesOverTimeRetrieve({ courseId, org, active, departmentId, endDate, format, includeMainPlatform, startDate, }: {
234
- courseId: string;
235
- org: string;
236
- /**
237
- * Any of `y`, `yes`, `true`. set to false or no for unenrollments
238
- *
239
- * * `y` - y
240
- * * `yes` - yes
241
- * * `true` - true
242
- * * `True` - True
243
- * * `n` - n
244
- * * `no` - no
245
- * * `false` - false
246
- * * `False` - False
247
- */
248
- active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
249
- /**
250
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
251
- */
252
- departmentId?: number;
253
- /**
254
- * end date. ISO 8601
255
- */
256
- endDate?: string;
257
- /**
258
- * Format
259
- *
260
- * * `json` - json
261
- */
262
- format?: 'json';
263
- /**
264
- * Include main platform data
265
- */
266
- includeMainPlatform?: boolean;
267
- /**
268
- * start date. ISO 8601
269
- */
270
- startDate?: string;
271
- }): CancelablePromise<OvertimeWithChangeInfo>;
272
- /**
273
- * List users enrolled in a specific course.
274
- *
275
- * This endpoint provides a list of users who are enrolled or unenrolled
276
- * in a specified course.
277
- *
278
- * Query Parameters:
279
- * course_id (str): The course ID to get enrollments for
280
- * active (bool): Filter for active enrollments when true, inactive when false
281
- * page (int, optional): Page number for pagination
282
- * length (int, optional): Number of items per page
283
- *
284
- * Returns:
285
- * A paginated list of users with:
286
- * - Username
287
- * - Full name
288
- * - Email
289
- * - Enrollment timestamp
290
- * @returns EnrollmentsPerUser
291
- * @throws ApiError
292
- */
293
- static aiAnalyticsAudienceOrgsEnrollmentsCoursesUsersRetrieve({ courseId, org, active, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
294
- courseId: string;
295
- org: string;
296
- /**
297
- * Any of `y`, `yes`, `true`. set to false or no for unenrollments
298
- *
299
- * * `y` - y
300
- * * `yes` - yes
301
- * * `true` - true
302
- * * `True` - True
303
- * * `n` - n
304
- * * `no` - no
305
- * * `false` - false
306
- * * `False` - False
307
- */
308
- active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
309
- /**
310
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
311
- */
312
- departmentId?: number;
313
- /**
314
- * end date. ISO 8601
315
- */
316
- endDate?: string;
317
- /**
318
- * Format
319
- *
320
- * * `json` - json
321
- */
322
- format?: 'json';
323
- /**
324
- * Include main platform data
325
- */
326
- includeMainPlatform?: boolean;
327
- /**
328
- * Size of data to return
329
- */
330
- length?: number;
331
- /**
332
- * Page offset
333
- */
334
- page?: number;
335
- /**
336
- * start date. ISO 8601
337
- */
338
- startDate?: string;
339
- }): CancelablePromise<EnrollmentsPerUser>;
340
- /**
341
- * Get enrollment or unenrollment counts over time.
342
- *
343
- * This endpoint provides daily counts of new enrollments or unenrollments
344
- * over a specified time period.
345
- *
346
- * Query Parameters:
347
- * start_date (str, optional): Start date for the time range (ISO format)
348
- * end_date (str, optional): End date for the time range (ISO format)
349
- * course_id (str, optional): Filter by course ID
350
- * active (bool): Get enrollments when true, unenrollments when false
351
- *
352
- * Returns:
353
- * Daily counts over the specified time period, with change metrics
354
- * compared to previous periods.
355
- *
356
- * Default time range is the last 7 days if no dates are specified.
357
- * @returns OvertimeWithChangeInfo
358
- * @throws ApiError
359
- */
360
- static aiAnalyticsAudienceOrgsEnrollmentsOverTimeRetrieve({ org, active, departmentId, endDate, format, includeMainPlatform, startDate, }: {
361
- org: string;
362
- /**
363
- * Any of `y`, `yes`, `true`. set to false or no for unenrollments
364
- *
365
- * * `y` - y
366
- * * `yes` - yes
367
- * * `true` - true
368
- * * `True` - True
369
- * * `n` - n
370
- * * `no` - no
371
- * * `false` - false
372
- * * `False` - False
373
- */
374
- active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
375
- /**
376
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
377
- */
378
- departmentId?: number;
379
- /**
380
- * end date. ISO 8601
381
- */
382
- endDate?: string;
383
- /**
384
- * Format
385
- *
386
- * * `json` - json
387
- */
388
- format?: 'json';
389
- /**
390
- * Include main platform data
391
- */
392
- includeMainPlatform?: boolean;
393
- /**
394
- * start date. ISO 8601
395
- */
396
- startDate?: string;
397
- }): CancelablePromise<OvertimeWithChangeInfo>;
398
- /**
399
- * List enrollment statistics on a per-course basis.
400
- *
401
- * This endpoint provides enrollment counts for all courses, with options
402
- * to filter for active or inactive enrollments and to include time-based data.
403
- *
404
- * Query Parameters:
405
- * active (bool): Filter for active enrollments when true, inactive when false
406
- * start_date (str, optional): Start date for time-based filtering (ISO format)
407
- * end_date (str, optional): End date for time-based filtering (ISO format)
408
- * page (int, optional): Page number for pagination
409
- * length (int, optional): Number of items per page
410
- *
411
- * Returns:
412
- * A paginated list of courses with their enrollment counts and percentages.
413
- * @returns Enrollments
414
- * @throws ApiError
415
- */
416
- static aiAnalyticsAudienceOrgsEnrollmentsPerCourseRetrieve({ org, active, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
417
- org: string;
418
- /**
419
- * Any of `y`, `yes`, `true`. set to false or no for unenrollments
420
- *
421
- * * `y` - y
422
- * * `yes` - yes
423
- * * `true` - true
424
- * * `True` - True
425
- * * `n` - n
426
- * * `no` - no
427
- * * `false` - false
428
- * * `False` - False
429
- */
430
- active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
431
- /**
432
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
433
- */
434
- departmentId?: number;
435
- /**
436
- * end date. ISO 8601
437
- */
438
- endDate?: string;
439
- /**
440
- * Format
441
- *
442
- * * `json` - json
443
- */
444
- format?: 'json';
445
- /**
446
- * Include main platform data
447
- */
448
- includeMainPlatform?: boolean;
449
- /**
450
- * Size of data to return
451
- */
452
- length?: number;
453
- /**
454
- * Page offset
455
- */
456
- page?: number;
457
- /**
458
- * start date. ISO 8601
459
- */
460
- startDate?: string;
461
- }): CancelablePromise<Enrollments>;
462
- /**
463
- * List all learners on the platform with aggregated metrics.
464
- *
465
- * This endpoint returns a paginated list of all learners with key metrics including:
466
- * - Enrollment counts
467
- * - Completion counts
468
- * - Time spent on platform
469
- *
470
- * Query Parameters:
471
- * page (int): Page number for pagination
472
- * length (int): Number of items per page
473
- * search (str): Filter learners by username, email, or name
474
- *
475
- * Returns:
476
- * A paginated list of learners with their associated metrics.
477
- * @returns PerlearnerUserList
478
- * @throws ApiError
479
- */
480
- static aiAnalyticsAudienceOrgsRegisteredUsersRetrieve({ org, departmentId, format, includeMainPlatform, length, page, search, }: {
481
- org: string;
482
- /**
483
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
484
- */
485
- departmentId?: number;
486
- /**
487
- * Format
488
- *
489
- * * `json` - json
490
- */
491
- format?: 'json';
492
- /**
493
- * Include main platform data
494
- */
495
- includeMainPlatform?: boolean;
496
- /**
497
- * Size of data to return
498
- */
499
- length?: number;
500
- /**
501
- * Page offset
502
- */
503
- page?: number;
504
- /**
505
- * Search string for learner
506
- */
507
- search?: string;
508
- }): CancelablePromise<PerlearnerUserList>;
509
- /**
510
- * Get registered user counts over time.
511
- *
512
- * This endpoint provides daily counts of new user registrations over a
513
- * specified time period.
514
- *
515
- * Query Parameters:
516
- * start_date (str, optional): Start date for the time range (ISO format)
517
- * end_date (str, optional): End date for the time range (ISO format)
518
- *
519
- * Returns:
520
- * Daily registration counts over the specified time period, with change metrics
521
- * compared to previous periods.
522
- *
523
- * Default time range is the last 7 days if no dates are specified.
524
- * @returns OvertimeWithChangeInfo
525
- * @throws ApiError
526
- */
527
- static aiAnalyticsAudienceOrgsRegisteredUsersOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
528
- org: string;
529
- /**
530
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
531
- */
532
- departmentId?: number;
533
- /**
534
- * end date. ISO 8601
535
- */
536
- endDate?: string;
537
- /**
538
- * Format
539
- *
540
- * * `json` - json
541
- */
542
- format?: 'json';
543
- /**
544
- * Include main platform data
545
- */
546
- includeMainPlatform?: boolean;
547
- /**
548
- * start date. ISO 8601
549
- */
550
- startDate?: string;
551
- }): CancelablePromise<OvertimeWithChangeInfo>;
552
- /**
553
- * List enrollment statistics on a per-course basis.
554
- *
555
- * This endpoint provides enrollment counts for all courses, with options
556
- * to filter for active or inactive enrollments and to include time-based data.
557
- *
558
- * Query Parameters:
559
- * active (bool): Filter for active enrollments when true, inactive when false
560
- * start_date (str, optional): Start date for time-based filtering (ISO format)
561
- * end_date (str, optional): End date for time-based filtering (ISO format)
562
- * page (int, optional): Page number for pagination
563
- * length (int, optional): Number of items per page
564
- *
565
- * Returns:
566
- * A paginated list of courses with their enrollment counts and percentages.
567
- * @returns Enrollments
568
- * @throws ApiError
569
- */
570
- static aiAnalyticsAudienceOrgsRegisteredUsersPerCourseRetrieve({ org, active, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
571
- org: string;
572
- /**
573
- * Any of `y`, `yes`, `true`. set to false or no for unenrollments
574
- *
575
- * * `y` - y
576
- * * `yes` - yes
577
- * * `true` - true
578
- * * `True` - True
579
- * * `n` - n
580
- * * `no` - no
581
- * * `false` - false
582
- * * `False` - False
583
- */
584
- active?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
585
- /**
586
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
587
- */
588
- departmentId?: number;
589
- /**
590
- * end date. ISO 8601
591
- */
592
- endDate?: string;
593
- /**
594
- * Format
595
- *
596
- * * `json` - json
597
- */
598
- format?: 'json';
599
- /**
600
- * Include main platform data
601
- */
602
- includeMainPlatform?: boolean;
603
- /**
604
- * Size of data to return
605
- */
606
- length?: number;
607
- /**
608
- * Page offset
609
- */
610
- page?: number;
611
- /**
612
- * start date. ISO 8601
613
- */
614
- startDate?: string;
615
- }): CancelablePromise<Enrollments>;
616
- /**
617
- * Retrieve paginated LLM usage costs aggregated by tenant.
618
- * @returns CostPerTenant
619
- * @throws ApiError
620
- */
621
- static aiAnalyticsCostsPertenantList({ endDate, startDate, }: {
622
- endDate: string;
623
- startDate: string;
624
- }): CancelablePromise<Array<CostPerTenant>>;
625
- /**
626
- * Get a list of departments with metrics and filtering options.
627
- *
628
- * This endpoint provides a paginated list of departments with aggregated metrics
629
- * about learner performance, course completions, and skill acquisition.
630
- *
631
- * Query Parameters:
632
- * page (int, optional): Page number for pagination
633
- * length (int, optional): Number of items per page
634
- * program (str, optional): Filter by program
635
- * pathway (str, optional): Filter by pathway
636
- * departments (list, optional): Filter by department ids
637
- * department_id (str, optional): Filter by department id
638
- * location (str, optional): Filter by location
639
- * is_enrolled (bool, optional): Filter for departments with enrolled users
640
- * start_date (date, optional): Filter by learner join date (start range)
641
- * end_date (date, optional): Filter by learner join date (end range)
642
- *
643
- * Returns:
644
- * A paginated list of departments with comprehensive metrics.
645
- * @returns GroupList
646
- * @throws ApiError
647
- */
648
- static aiAnalyticsDepartmentsOrgsRetrieve({ org, departmentId, departments, endDate, format, includeMainPlatform, isEnrolled, length, location, page, pathway, program, startDate, }: {
649
- org: string;
650
- /**
651
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
652
- */
653
- departmentId?: number;
654
- /**
655
- * Departments search string. Single string or list of strings. e.g 'sample_department' or `['department', 'another department']`
656
- */
657
- departments?: Array<string>;
658
- /**
659
- * Filter by learners date_joined. Start date. ISO 8601
660
- */
661
- endDate?: string;
662
- /**
663
- * Format
664
- *
665
- * * `json` - json
666
- */
667
- format?: 'json';
668
- /**
669
- * Include main platform data
670
- */
671
- includeMainPlatform?: boolean;
672
- /**
673
- * Filter for users who have at least an enro;lment
674
- */
675
- isEnrolled?: boolean | null;
676
- /**
677
- * Size of data to return
678
- */
679
- length?: number;
680
- /**
681
- * Location search string
682
- */
683
- location?: string;
684
- /**
685
- * Page offset
686
- */
687
- page?: number;
688
- /**
689
- * Pathway string
690
- */
691
- pathway?: string;
692
- /**
693
- * Program search string
694
- */
695
- program?: string;
696
- /**
697
- * Filter by learners date_joined. Start date. ISO 8601
698
- */
699
- startDate?: string;
700
- }): CancelablePromise<GroupList>;
701
- /**
702
- * Get engagement metrics on a per-course basis.
703
- *
704
- * This endpoint provides a paginated list of courses with engagement metrics
705
- * including activity counts, time spent, and interaction data.
706
- *
707
- * Query Parameters:
708
- * page (int, optional): Page number for pagination
709
- * length (int, optional): Number of items per page
710
- *
711
- * Returns:
712
- * A paginated list of courses with their engagement metrics.
713
- * @returns EngagementPerCourse
714
- * @throws ApiError
715
- */
716
- static aiAnalyticsEngagementOrgsActivityRetrieve({ org, departmentId, format, includeMainPlatform, length, page, }: {
717
- org: string;
718
- /**
719
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
720
- */
721
- departmentId?: number;
722
- /**
723
- * Format
724
- *
725
- * * `json` - json
726
- */
727
- format?: 'json';
728
- /**
729
- * Include main platform data
730
- */
731
- includeMainPlatform?: boolean;
732
- /**
733
- * Size of data to return
734
- */
735
- length?: number;
736
- /**
737
- * Page offset
738
- */
739
- page?: number;
740
- }): CancelablePromise<EngagementPerCourse>;
741
- /**
742
- * Completion count per user per course across the platform
743
- *
744
- * Query Params
745
- * 1. start_date e.g 2020-10-01
746
- * 2. end_date e.g 2020-10-10
747
- *
748
- * Default result when no query param is added is last_7_days (today inclusive)
749
- * @returns OvertimeWithChangeInfo
750
- * @throws ApiError
751
- */
752
- static aiAnalyticsEngagementOrgsCourseCompletionOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
753
- org: string;
754
- /**
755
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
756
- */
757
- departmentId?: number;
758
- /**
759
- * end date. ISO 8601
760
- */
761
- endDate?: string;
762
- /**
763
- * Format
764
- *
765
- * * `json` - json
766
- */
767
- format?: 'json';
768
- /**
769
- * Include main platform data
770
- */
771
- includeMainPlatform?: boolean;
772
- /**
773
- * start date. ISO 8601
774
- */
775
- startDate?: string;
776
- }): CancelablePromise<OvertimeWithChangeInfo>;
777
- /**
778
- * List course completion metrics on a per-course basis.
779
- *
780
- * This endpoint provides a paginated table of courses with enrollment and
781
- * completion statistics for each course.
782
- *
783
- * Returns:
784
- * A paginated list of courses with:
785
- * - Course identification (ID and name)
786
- * - Enrollment count
787
- * - Completion count
788
- * - Average completion rate
789
- * @returns CourseCompletionPerCourse
790
- * @throws ApiError
791
- */
792
- static aiAnalyticsEngagementOrgsCourseCompletionPerCourseRetrieve({ org, departmentId, format, includeMainPlatform, length, page, }: {
793
- org: string;
794
- /**
795
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
796
- */
797
- departmentId?: number;
798
- /**
799
- * Format
800
- *
801
- * * `json` - json
802
- */
803
- format?: 'json';
804
- /**
805
- * Include main platform data
806
- */
807
- includeMainPlatform?: boolean;
808
- /**
809
- * Size of data to return
810
- */
811
- length?: number;
812
- /**
813
- * Page offset
814
- */
815
- page?: number;
816
- }): CancelablePromise<CourseCompletionPerCourse>;
817
- /**
818
- * Average time spent in secs on a per-day basis
819
- *
820
- * Query Params
821
- * 1. start_date e.g 2020-10-01
822
- * 2. end_date e.g 2020-10-10
823
- * 3. course_id <optional>
824
- *
825
- * Default result when no query param is added is last_7_days (today inclusive)
826
- * @returns AverageOvertime
827
- * @throws ApiError
828
- */
829
- static aiAnalyticsEngagementOrgsCoursesTimeAverageRetrieve({ courseId, org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
830
- courseId: string;
831
- org: string;
832
- /**
833
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
834
- */
835
- departmentId?: number;
836
- /**
837
- * end date. ISO 8601
838
- */
839
- endDate?: string;
840
- /**
841
- * Format
842
- *
843
- * * `json` - json
844
- */
845
- format?: 'json';
846
- /**
847
- * Include main platform data
848
- */
849
- includeMainPlatform?: boolean;
850
- /**
851
- * start date. ISO 8601
852
- */
853
- startDate?: string;
854
- }): CancelablePromise<AverageOvertime>;
855
- /**
856
- * Time spent per course in secs in a tree like form
857
- *
858
- * Kwargs
859
- * course_id e.g course-v1:Org+Course4+Run
860
- *
861
- * Query Params
862
- * 1. start_date <optional> e.g 2020-10-01
863
- * 2. end_date <optional> e.g 2020-10-10
864
- * @returns TimeDetail
865
- * @throws ApiError
866
- */
867
- static aiAnalyticsEngagementOrgsCoursesTimeDetailRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
868
- courseId: string;
869
- org: string;
870
- /**
871
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
872
- */
873
- departmentId?: number;
874
- /**
875
- * Format
876
- *
877
- * * `json` - json
878
- */
879
- format?: 'json';
880
- /**
881
- * Include main platform data
882
- */
883
- includeMainPlatform?: boolean;
884
- }): CancelablePromise<TimeDetail>;
885
- /**
886
- * Time spent per course in secs on a per-day basis
887
- *
888
- * Query Params
889
- * 1. start_date e.g 2020-10-01
890
- * 2. end_date e.g 2020-10-10
891
- * Kwargs
892
- * 3. course_id
893
- *
894
- * Default result when no query param is added is last_7_days (today inclusive)
895
- * @returns OverTimeWithTotal
896
- * @throws ApiError
897
- */
898
- static aiAnalyticsEngagementOrgsCoursesTimeOverTimeRetrieve({ courseId, org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
899
- courseId: string;
900
- org: string;
901
- /**
902
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
903
- */
904
- departmentId?: number;
905
- /**
906
- * end date. ISO 8601
907
- */
908
- endDate?: string;
909
- /**
910
- * Format
911
- *
912
- * * `json` - json
913
- */
914
- format?: 'json';
915
- /**
916
- * Include main platform data
917
- */
918
- includeMainPlatform?: boolean;
919
- /**
920
- * start date. ISO 8601
921
- */
922
- startDate?: string;
923
- }): CancelablePromise<OverTimeWithTotal>;
924
- /**
925
- * Time spent by users in a course
926
- *
927
- * Query Params
928
- * course_id e.g course-v1:Org+Course4+Run
929
- * @returns TimeSpentByUsersInCourse
930
- * @throws ApiError
931
- */
932
- static aiAnalyticsEngagementOrgsCoursesTimeUsersRetrieve({ courseId, org, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
933
- courseId: string;
934
- org: string;
935
- /**
936
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
937
- */
938
- departmentId?: number;
939
- /**
940
- * end date. ISO 8601
941
- */
942
- endDate?: string;
943
- /**
944
- * Format
945
- *
946
- * * `json` - json
947
- */
948
- format?: 'json';
949
- /**
950
- * Include main platform data
951
- */
952
- includeMainPlatform?: boolean;
953
- /**
954
- * Size of data to return
955
- */
956
- length?: number;
957
- /**
958
- * Page offset
959
- */
960
- page?: number;
961
- /**
962
- * start date. ISO 8601
963
- */
964
- startDate?: string;
965
- }): CancelablePromise<TimeSpentByUsersInCourse>;
966
- /**
967
- * Time spent within a course in ordered hierarchical format
968
- *
969
- * Kwargs
970
- * 1. course_id e.g course-v1:Org+Course4+Run
971
- * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
972
- * Query Params
973
- * 3. start_date <optional> e.g 2020-10-01
974
- * 4. end_date <optional> e.g 2020-10-10
975
- * @returns PerLearnerTimeSpentInCourseTree
976
- * @throws ApiError
977
- */
978
- static aiAnalyticsEngagementOrgsCoursesTimeUsersDetailRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
979
- courseId: string;
980
- org: string; /**
981
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
982
- */
983
- departmentId?: number; /**
984
- * end date. ISO 8601
985
- */
986
- endDate?: string; /**
987
- * Format
988
- *
989
- * * `json` - json
990
- */
991
- format?: 'json'; /**
992
- * Include main platform data
993
- */
994
- includeMainPlatform?: boolean; /**
995
- * start date. ISO 8601
996
- */
997
- startDate?: string;
998
- }): CancelablePromise<PerLearnerTimeSpentInCourseTree>;
999
- /**
1000
- * Time spent in secs on a per-day basis
1001
- *
1002
- * Query Params
1003
- * 1. course_id <optional> e.g course-v1:Org+Course4+Run
1004
- * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
1005
- * 3. start_date e.g 2020-10-01
1006
- * 4. end_date e.g 2020-10-10
1007
- *
1008
- * Default result when no query param is added is last_7_days (today inclusive)
1009
- * @returns OverTimeWithTotal
1010
- * @throws ApiError
1011
- */
1012
- static aiAnalyticsEngagementOrgsCoursesTimeUsersOverTimeRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
1013
- courseId: string;
1014
- org: string; /**
1015
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1016
- */
1017
- departmentId?: number; /**
1018
- * end date. ISO 8601
1019
- */
1020
- endDate?: string; /**
1021
- * Format
1022
- *
1023
- * * `json` - json
1024
- */
1025
- format?: 'json'; /**
1026
- * Include main platform data
1027
- */
1028
- includeMainPlatform?: boolean; /**
1029
- * start date. ISO 8601
1030
- */
1031
- startDate?: string;
1032
- }): CancelablePromise<OverTimeWithTotal>;
1033
- /**
1034
- * Get video engagement metrics for a specific course.
1035
- *
1036
- * This endpoint provides detailed video engagement statistics for a single course,
1037
- * including view counts, completion rates, and time spent on videos.
1038
- *
1039
- * Query Parameters:
1040
- * course_id (str): The course ID to get video engagement data for
1041
- *
1042
- * Returns:
1043
- * Detailed video engagement metrics for the specified course.
1044
- * @returns VideosSpecificCourse
1045
- * @throws ApiError
1046
- */
1047
- static aiAnalyticsEngagementOrgsCoursesVideosRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
1048
- courseId: string;
1049
- org: string;
1050
- /**
1051
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1052
- */
1053
- departmentId?: number;
1054
- /**
1055
- * Format
1056
- *
1057
- * * `json` - json
1058
- */
1059
- format?: 'json';
1060
- /**
1061
- * Include main platform data
1062
- */
1063
- includeMainPlatform?: boolean;
1064
- }): CancelablePromise<VideosSpecificCourse>;
1065
- /**
1066
- * Get video watch counts over time.
1067
- *
1068
- * This endpoint provides daily counts of videos watched over a specified time period,
1069
- * with options to filter by course or user.
1070
- *
1071
- * Query Parameters:
1072
- * start_date (str, optional): Start date for the time range (ISO format)
1073
- * end_date (str, optional): End date for the time range (ISO format)
1074
- * course_id (str, optional): Filter by course ID
1075
- * user_id (str, optional): Filter by username or email
1076
- *
1077
- * Returns:
1078
- * Daily video watch counts over the specified time period.
1079
- *
1080
- * Default time range is the last 7 days if no dates are specified.
1081
- *
1082
- * Access Control:
1083
- * - Platform admins can access any video watch data
1084
- * - Learners can access their own video watch data
1085
- * @returns OverTimeWithTotal
1086
- * @throws ApiError
1087
- */
1088
- static aiAnalyticsEngagementOrgsCoursesVideosOverTimeRetrieve({ courseId, org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
1089
- courseId: string;
1090
- org: string;
1091
- /**
1092
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1093
- */
1094
- departmentId?: number;
1095
- /**
1096
- * end date. ISO 8601
1097
- */
1098
- endDate?: string;
1099
- /**
1100
- * Format
1101
- *
1102
- * * `json` - json
1103
- */
1104
- format?: 'json';
1105
- /**
1106
- * Include main platform data
1107
- */
1108
- includeMainPlatform?: boolean;
1109
- /**
1110
- * start date. ISO 8601
1111
- */
1112
- startDate?: string;
1113
- }): CancelablePromise<OverTimeWithTotal>;
1114
- /**
1115
- * Get a summary of video watch statistics for a specific course.
1116
- *
1117
- * This endpoint provides a structured summary of video watch data for a course,
1118
- * organized in a tree-like format by course sections and subsections.
1119
- *
1120
- * Query Parameters:
1121
- * course_id (str): The course ID to get video summary for
1122
- *
1123
- * Returns:
1124
- * A hierarchical structure of video watch data for the course, including:
1125
- * - Section and subsection organization
1126
- * - Video identification and metadata
1127
- * - Watch counts and completion rates
1128
- * @returns VideosInCourseSummary
1129
- * @throws ApiError
1130
- */
1131
- static aiAnalyticsEngagementOrgsCoursesVideosSummaryRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
1132
- courseId: string;
1133
- org: string;
1134
- /**
1135
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1136
- */
1137
- departmentId?: number;
1138
- /**
1139
- * Format
1140
- *
1141
- * * `json` - json
1142
- */
1143
- format?: 'json';
1144
- /**
1145
- * Include main platform data
1146
- */
1147
- includeMainPlatform?: boolean;
1148
- }): CancelablePromise<VideosInCourseSummary>;
1149
- /**
1150
- * List of users' videos completed records for a specific course
1151
- *
1152
- * Kwargs
1153
- * course_id e.g course-v1:Org+Course4+Run
1154
- * @returns WatchedVideosPerUser
1155
- * @throws ApiError
1156
- */
1157
- static aiAnalyticsEngagementOrgsCoursesVideosUsersRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
1158
- courseId: string;
1159
- org: string;
1160
- /**
1161
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1162
- */
1163
- departmentId?: number;
1164
- /**
1165
- * Format
1166
- *
1167
- * * `json` - json
1168
- */
1169
- format?: 'json';
1170
- /**
1171
- * Include main platform data
1172
- */
1173
- includeMainPlatform?: boolean;
1174
- }): CancelablePromise<WatchedVideosPerUser>;
1175
- /**
1176
- * Average time spent by a learner in enrolled courses. Gives a rough estimate of whats the average time
1177
- * that would be spent by a learner in a course
1178
- *
1179
- * Query Params
1180
- * 1. start_date e.g 2020-10-01
1181
- * 2. end_date e.g 2020-10-10
1182
- * @returns AverageOvertime
1183
- * @throws ApiError
1184
- */
1185
- static aiAnalyticsEngagementOrgsTimeAveragePerlearnerPercourseRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
1186
- org: string;
1187
- /**
1188
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1189
- */
1190
- departmentId?: number;
1191
- /**
1192
- * end date. ISO 8601
1193
- */
1194
- endDate?: string;
1195
- /**
1196
- * Format
1197
- *
1198
- * * `json` - json
1199
- */
1200
- format?: 'json';
1201
- /**
1202
- * Include main platform data
1203
- */
1204
- includeMainPlatform?: boolean;
1205
- /**
1206
- * start date. ISO 8601
1207
- */
1208
- startDate?: string;
1209
- }): CancelablePromise<AverageOvertime>;
1210
- /**
1211
- * Average time spent in secs on a per-day basis
1212
- *
1213
- * Query Params
1214
- * 1. start_date e.g 2020-10-01
1215
- * 2. end_date e.g 2020-10-10
1216
- * 3. course_id <optional>
1217
- *
1218
- * Default result when no query param is added is last_7_days (today inclusive)
1219
- * @returns AverageOvertime
1220
- * @throws ApiError
1221
- */
1222
- static aiAnalyticsEngagementOrgsTimeAverageWithOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
1223
- org: string;
1224
- /**
1225
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1226
- */
1227
- departmentId?: number;
1228
- /**
1229
- * end date. ISO 8601
1230
- */
1231
- endDate?: string;
1232
- /**
1233
- * Format
1234
- *
1235
- * * `json` - json
1236
- */
1237
- format?: 'json';
1238
- /**
1239
- * Include main platform data
1240
- */
1241
- includeMainPlatform?: boolean;
1242
- /**
1243
- * start date. ISO 8601
1244
- */
1245
- startDate?: string;
1246
- }): CancelablePromise<AverageOvertime>;
1247
- /**
1248
- * Get time spent on the platform over time.
1249
- *
1250
- * This endpoint provides daily time spent values (in seconds) across the
1251
- * platform over a specified time period.
1252
- *
1253
- * Query Parameters:
1254
- * start_date (str, optional): Start date for the time range (ISO format)
1255
- * end_date (str, optional): End date for the time range (ISO format)
1256
- *
1257
- * Returns:
1258
- * Daily time spent values over the specified time period, with change metrics
1259
- * compared to previous periods.
1260
- *
1261
- * Default time range is the last 7 days if no dates are specified.
1262
- * @returns OvertimeWithChangeInfo
1263
- * @throws ApiError
1264
- */
1265
- static aiAnalyticsEngagementOrgsTimeOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
1266
- org: string;
1267
- /**
1268
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1269
- */
1270
- departmentId?: number;
1271
- /**
1272
- * end date. ISO 8601
1273
- */
1274
- endDate?: string;
1275
- /**
1276
- * Format
1277
- *
1278
- * * `json` - json
1279
- */
1280
- format?: 'json';
1281
- /**
1282
- * Include main platform data
1283
- */
1284
- includeMainPlatform?: boolean;
1285
- /**
1286
- * start date. ISO 8601
1287
- */
1288
- startDate?: string;
1289
- }): CancelablePromise<OvertimeWithChangeInfo>;
1290
- /**
1291
- * Get time spent statistics on a per-course basis.
1292
- *
1293
- * This endpoint provides a paginated list of courses with the total time
1294
- * spent by users in each course.
1295
- *
1296
- * Query Parameters:
1297
- * start_date (str, optional): Start date for filtering (ISO format)
1298
- * end_date (str, optional): End date for filtering (ISO format)
1299
- * page (int, optional): Page number for pagination
1300
- * length (int, optional): Number of items per page
1301
- *
1302
- * Returns:
1303
- * A paginated list of courses with:
1304
- * - Course identification (ID and name)
1305
- * - Total time spent (in seconds)
1306
- * - Formatted time spent (human-readable)
1307
- * - Percentage of total platform time
1308
- * @returns TimeSpentPerCourse
1309
- * @throws ApiError
1310
- */
1311
- static aiAnalyticsEngagementOrgsTimePerCourseRetrieve({ org, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
1312
- org: string;
1313
- /**
1314
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1315
- */
1316
- departmentId?: number;
1317
- /**
1318
- * end date. ISO 8601
1319
- */
1320
- endDate?: string;
1321
- /**
1322
- * Format
1323
- *
1324
- * * `json` - json
1325
- */
1326
- format?: 'json';
1327
- /**
1328
- * Include main platform data
1329
- */
1330
- includeMainPlatform?: boolean;
1331
- /**
1332
- * Size of data to return
1333
- */
1334
- length?: number;
1335
- /**
1336
- * Page offset
1337
- */
1338
- page?: number;
1339
- /**
1340
- * start date. ISO 8601
1341
- */
1342
- startDate?: string;
1343
- }): CancelablePromise<TimeSpentPerCourse>;
1344
- /**
1345
- * Get video engagement metrics on a per-course basis.
1346
- *
1347
- * This endpoint provides a paginated list of courses with video engagement metrics
1348
- * including view counts, completion rates, and time spent on videos.
1349
- *
1350
- * Query Parameters:
1351
- * page (int, optional): Page number for pagination
1352
- * length (int, optional): Number of items per page
1353
- *
1354
- * Returns:
1355
- * A paginated list of courses with their video engagement metrics.
1356
- * @returns VideoEngagementPerCourse
1357
- * @throws ApiError
1358
- */
1359
- static aiAnalyticsEngagementOrgsVideosRetrieve({ org, departmentId, format, includeMainPlatform, length, page, }: {
1360
- org: string;
1361
- /**
1362
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1363
- */
1364
- departmentId?: number;
1365
- /**
1366
- * Format
1367
- *
1368
- * * `json` - json
1369
- */
1370
- format?: 'json';
1371
- /**
1372
- * Include main platform data
1373
- */
1374
- includeMainPlatform?: boolean;
1375
- /**
1376
- * Size of data to return
1377
- */
1378
- length?: number;
1379
- /**
1380
- * Page offset
1381
- */
1382
- page?: number;
1383
- }): CancelablePromise<VideoEngagementPerCourse>;
1384
- /**
1385
- * Get video watch counts over time.
1386
- *
1387
- * This endpoint provides daily counts of videos watched over a specified time period,
1388
- * with options to filter by course or user.
1389
- *
1390
- * Query Parameters:
1391
- * start_date (str, optional): Start date for the time range (ISO format)
1392
- * end_date (str, optional): End date for the time range (ISO format)
1393
- * course_id (str, optional): Filter by course ID
1394
- * user_id (str, optional): Filter by username or email
1395
- *
1396
- * Returns:
1397
- * Daily video watch counts over the specified time period.
1398
- *
1399
- * Default time range is the last 7 days if no dates are specified.
1400
- *
1401
- * Access Control:
1402
- * - Platform admins can access any video watch data
1403
- * - Learners can access their own video watch data
1404
- * @returns OverTimeWithTotal
1405
- * @throws ApiError
1406
- */
1407
- static aiAnalyticsEngagementOrgsVideosOverTimeRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
1408
- org: string;
1409
- /**
1410
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
1411
- */
1412
- departmentId?: number;
1413
- /**
1414
- * end date. ISO 8601
1415
- */
1416
- endDate?: string;
1417
- /**
1418
- * Format
1419
- *
1420
- * * `json` - json
1421
- */
1422
- format?: 'json';
1423
- /**
1424
- * Include main platform data
1425
- */
1426
- includeMainPlatform?: boolean;
1427
- /**
1428
- * start date. ISO 8601
1429
- */
1430
- startDate?: string;
1431
- }): CancelablePromise<OverTimeWithTotal>;
1432
- /**
1433
- * Retrieve average message counts per session over time.
1434
- *
1435
- * This endpoint returns data on the average number of messages exchanged in each
1436
- * conversation session within a specified date range, with options for filtering
1437
- * by mentor and aggregating by different time periods (hourly, daily, weekly).
1438
- *
1439
- * Args:
1440
- * request: The HTTP request containing filter query parameters.
1441
- * org: Organization key identifier.
1442
- *
1443
- * Returns:
1444
- * Response: Time series of average message counts and session totals.
1445
- *
1446
- * Raises:
1447
- * NotFound: If the specified organization does not exist.
1448
- * BadRequest: If the provided parameters are invalid.
1449
- *
1450
- * Query Parameters:
1451
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1452
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1453
- * mentor_id (str): Filter by mentor unique ID.
1454
- * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
1455
- * @returns MessageStatistics
1456
- * @throws ApiError
1457
- */
1458
- static aiAnalyticsOrgsUsersAverageMessagesPerSessionList({ endDate, org, startDate, userId, aggregation, groupBy, mentorId, }: {
1459
- /**
1460
- * End date for filtering (YYYY-MM-DD)
1461
- */
1462
- endDate: string;
1463
- org: string;
1464
- /**
1465
- * Start date for filtering (YYYY-MM-DD)
1466
- */
1467
- startDate: string;
1468
- userId: string;
1469
- /**
1470
- * Time aggregation level (hourly, daily, weekly)
1471
- */
1472
- aggregation?: 'daily' | 'hourly' | 'weekly';
1473
- groupBy?: string;
1474
- /**
1475
- * Filter by mentor unique ID
1476
- */
1477
- mentorId?: string;
1478
- }): CancelablePromise<Array<MessageStatistics>>;
1479
- /**
1480
- * API viewset for retrieving and filtering chat message history.
1481
- *
1482
- * This viewset provides endpoints for retrieving chat message history
1483
- * within an organization, with extensive filtering options by date range,
1484
- * user, topic, mentor, and sentiment.
1485
- *
1486
- * Permissions:
1487
- * - Restricted to platform administrators only
1488
- * @returns PaginatedConversationsList
1489
- * @throws ApiError
1490
- */
1491
- static aiAnalyticsOrgsUsersChatHistoryList({ org, userId, endDate, filterUserId, mentor, page, pageSize, sentiment, startDate, topics, }: {
1492
- org: string;
1493
- endDate?: string;
1494
- filterUserId?: string;
1495
- mentor?: string; /**
1496
- * A page number within the paginated result set.
1497
- */
1498
- page?: number; /**
1499
- * Number of results to return per page.
1500
- */
1501
- pageSize?: number;
1502
- sentiment?: string;
1503
- startDate?: string;
1504
- topics?: string;
1505
- }): CancelablePromise<PaginatedConversationsList>;
1506
- /**
1507
- * API viewset for retrieving and filtering chat message history.
1508
- *
1509
- * This viewset provides endpoints for retrieving chat message history
1510
- * within an organization, with extensive filtering options by date range,
1511
- * user, topic, mentor, and sentiment.
1512
- *
1513
- * Permissions:
1514
- * - Restricted to platform administrators only
1515
- * @returns Conversations
1516
- * @throws ApiError
1517
- */
1518
- static aiAnalyticsOrgsUsersChatHistoryCreate({ org, userId, requestBody, endDate, filterUserId, mentor, sentiment, startDate, topics, }: {
1519
- org: string;
1520
- requestBody: Conversations;
1521
- endDate?: string;
1522
- filterUserId?: string;
1523
- mentor?: string;
1524
- sentiment?: string;
1525
- startDate?: string;
1526
- topics?: string;
1527
- }): CancelablePromise<Conversations>;
1528
- /**
1529
- * Retrieve filter options for chat message history.
1530
- *
1531
- * This endpoint returns data on available filter options for the chat message
1532
- * history endpoint, including topics, date ranges (weekly or monthly),
1533
- * sentiments, and users who have chat history.
1534
- *
1535
- * Args:
1536
- * request: The HTTP request containing query parameters.
1537
- * org: Organization key identifier.
1538
- *
1539
- * Returns:
1540
- * Response: Available filter options for chat message history.
1541
- *
1542
- * Raises:
1543
- * NotFound: If the specified organization does not exist.
1544
- *
1545
- * Query Parameters:
1546
- * monthly_range (bool): Whether to return monthly or weekly date ranges.
1547
- * mentor_id (str): Filter users by those who have chatted with a specific mentor.
1548
- * @returns ChatHistoryFilterData
1549
- * @throws ApiError
1550
- */
1551
- static aiAnalyticsOrgsUsersChatHistoryFilterRetrieve({ org, userId, endDate, mentorId, monthlyRange, startDate, }: {
1552
- org: string;
1553
- endDate?: string;
1554
- mentorId?: string;
1555
- monthlyRange?: boolean;
1556
- startDate?: string;
1557
- }): CancelablePromise<ChatHistoryFilterData>;
1558
- /**
1559
- * API viewset for retrieving and filtering chat message history.
1560
- *
1561
- * This viewset provides endpoints for retrieving chat message history
1562
- * within an organization, with extensive filtering options by date range,
1563
- * user, topic, mentor, and sentiment.
1564
- *
1565
- * Permissions:
1566
- * - Restricted to platform administrators only
1567
- * @returns Conversations
1568
- * @throws ApiError
1569
- */
1570
- static aiAnalyticsOrgsUsersChatHistoryRetrieve({ id, org, userId, endDate, filterUserId, mentor, sentiment, startDate, topics, }: {
1571
- id: string;
1572
- org: string;
1573
- endDate?: string;
1574
- filterUserId?: string;
1575
- mentor?: string;
1576
- sentiment?: string;
1577
- startDate?: string;
1578
- topics?: string;
1579
- }): CancelablePromise<Conversations>;
1580
- /**
1581
- * API viewset for retrieving and filtering chat message history.
1582
- *
1583
- * This viewset provides endpoints for retrieving chat message history
1584
- * within an organization, with extensive filtering options by date range,
1585
- * user, topic, mentor, and sentiment.
1586
- *
1587
- * Permissions:
1588
- * - Restricted to platform administrators only
1589
- * @returns Conversations
1590
- * @throws ApiError
1591
- */
1592
- static aiAnalyticsOrgsUsersChatHistoryUpdate({ id, org, userId, requestBody, endDate, filterUserId, mentor, sentiment, startDate, topics, }: {
1593
- id: string;
1594
- org: string;
1595
- requestBody: Conversations;
1596
- endDate?: string;
1597
- filterUserId?: string;
1598
- mentor?: string;
1599
- sentiment?: string;
1600
- startDate?: string;
1601
- topics?: string;
1602
- }): CancelablePromise<Conversations>;
1603
- /**
1604
- * API viewset for retrieving and filtering chat message history.
1605
- *
1606
- * This viewset provides endpoints for retrieving chat message history
1607
- * within an organization, with extensive filtering options by date range,
1608
- * user, topic, mentor, and sentiment.
1609
- *
1610
- * Permissions:
1611
- * - Restricted to platform administrators only
1612
- * @returns Conversations
1613
- * @throws ApiError
1614
- */
1615
- static aiAnalyticsOrgsUsersChatHistoryPartialUpdate({ id, org, userId, endDate, filterUserId, mentor, sentiment, startDate, topics, requestBody, }: {
1616
- id: string;
1617
- org: string;
1618
- endDate?: string;
1619
- filterUserId?: string;
1620
- mentor?: string;
1621
- sentiment?: string;
1622
- startDate?: string;
1623
- topics?: string;
1624
- requestBody?: PatchedConversations;
1625
- }): CancelablePromise<Conversations>;
1626
- /**
1627
- * API viewset for retrieving and filtering chat message history.
1628
- *
1629
- * This viewset provides endpoints for retrieving chat message history
1630
- * within an organization, with extensive filtering options by date range,
1631
- * user, topic, mentor, and sentiment.
1632
- *
1633
- * Permissions:
1634
- * - Restricted to platform administrators only
1635
- * @returns void
1636
- * @throws ApiError
1637
- */
1638
- static aiAnalyticsOrgsUsersChatHistoryDestroy({ id, org, userId, endDate, filterUserId, mentor, sentiment, startDate, topics, }: {
1639
- id: string;
1640
- org: string;
1641
- endDate?: string;
1642
- filterUserId?: string;
1643
- mentor?: string;
1644
- sentiment?: string;
1645
- startDate?: string;
1646
- topics?: string;
1647
- }): CancelablePromise<void>;
1648
- /**
1649
- * Retrieve conversation volume data over time.
1650
- *
1651
- * This endpoint returns data on the number of conversations that occurred
1652
- * within a specified date range, with options for different time aggregations
1653
- * (hourly, daily, weekly). Results can be filtered by mentor.
1654
- *
1655
- * Args:
1656
- * request: The HTTP request containing filter query parameters.
1657
- * org: Organization key identifier.
1658
- * user_id: User identifier (not used in the implementation).
1659
- *
1660
- * Returns:
1661
- * Response: Time series data of conversation counts.
1662
- *
1663
- * Raises:
1664
- * NotFound: If the specified organization does not exist.
1665
- * BadRequest: If the provided parameters are invalid.
1666
- *
1667
- * Query Parameters:
1668
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1669
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1670
- * mentor_id (str): Filter by mentor unique ID.
1671
- * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
1672
- * @returns ConversationVolume
1673
- * @throws ApiError
1674
- */
1675
- static aiAnalyticsOrgsUsersConversationList({ endDate, org, startDate, userId, aggregation, mentorId, }: {
1676
- /**
1677
- * End date for filtering (YYYY-MM-DD)
1678
- */
1679
- endDate: string;
1680
- org: string;
1681
- /**
1682
- * Start date for filtering (YYYY-MM-DD)
1683
- */
1684
- startDate: string;
1685
- userId: string;
1686
- /**
1687
- * Time aggregation level (hourly, daily, weekly)
1688
- */
1689
- aggregation?: 'daily' | 'hourly' | 'weekly';
1690
- /**
1691
- * Filter by mentor unique ID
1692
- */
1693
- mentorId?: string;
1694
- }): CancelablePromise<Array<ConversationVolume>>;
1695
- /**
1696
- * Retrieve a summary of conversation metrics.
1697
- *
1698
- * This endpoint returns aggregated metrics about conversations within an organization,
1699
- * including:
1700
- * - Total number of conversations
1701
- * - Total number of human messages
1702
- * - Total number of AI messages
1703
- *
1704
- * Results can be filtered by mentor.
1705
- *
1706
- * Args:
1707
- * request: The HTTP request containing filter query parameters.
1708
- * org: Organization key identifier.
1709
- *
1710
- * Returns:
1711
- * Response: Summary of conversation metrics.
1712
- *
1713
- * Raises:
1714
- * NotFound: If the specified organization does not exist.
1715
- *
1716
- * Query Parameters:
1717
- * mentor_id (str): Filter by mentor unique ID.
1718
- * @returns ConversationSummary
1719
- * @throws ApiError
1720
- */
1721
- static aiAnalyticsOrgsUsersConversationSummaryRetrieve({ org, userId, groupBy, mentorId, }: {
1722
- org: string;
1723
- groupBy?: string; /**
1724
- * Filter by mentor unique ID
1725
- */
1726
- mentorId?: string;
1727
- }): CancelablePromise<ConversationSummary>;
1728
- /**
1729
- * Retrieve the model costs for a tenant
1730
- *
1731
- * Filter parameters for period are start_date and enddate
1732
- *
1733
- * Accessible to tenant Admins only.
1734
- * @returns ModelCost
1735
- * @throws ApiError
1736
- */
1737
- static aiAnalyticsOrgsUsersCostsModelRetrieve({ endDate, org, startDate, userId, }: {
1738
- endDate: string;
1739
- org: string;
1740
- startDate: string;
1741
- }): CancelablePromise<ModelCost>;
1742
- /**
1743
- * Retrieve LLM usage costs aggregated by mentor.
1744
- *
1745
- * This endpoint returns data on the total cost of LLM usage for each mentor
1746
- * within a specified date range, with pagination support. The costs are
1747
- * calculated by summing the costs of all observations associated with
1748
- * traces from the mentor's sessions.
1749
- *
1750
- * Args:
1751
- * request: The HTTP request containing filter query parameters.
1752
- * org: Organization key identifier.
1753
- *
1754
- * Returns:
1755
- * Response: Paginated list of mentors with their total LLM usage costs.
1756
- *
1757
- * Raises:
1758
- * NotFound: If the specified organization does not exist.
1759
- * BadRequest: If the provided parameters are invalid.
1760
- *
1761
- * Query Parameters:
1762
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1763
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1764
- * limit (int): Number of results per page - default: 5.
1765
- * offset (int): Offset for pagination - default: 0.
1766
- * @returns TenantMentorTraces
1767
- * @throws ApiError
1768
- */
1769
- static aiAnalyticsOrgsUsersCostsPermentorRetrieve({ endDate, org, startDate, userId, }: {
1770
- endDate: string;
1771
- org: string;
1772
- startDate: string;
1773
- }): CancelablePromise<TenantMentorTraces>;
1774
- /**
1775
- * Retrieve LLM usage costs aggregated by user.
1776
- *
1777
- * This endpoint returns data on the total cost of LLM usage for each user
1778
- * within a specified date range, with pagination support. The costs are
1779
- * calculated by summing the costs of all observations associated with
1780
- * traces from the user's sessions.
1781
- *
1782
- * Args:
1783
- * request: The HTTP request containing filter query parameters.
1784
- * org: Organization key identifier.
1785
- *
1786
- * Returns:
1787
- * Response: Paginated list of users with their total LLM usage costs.
1788
- *
1789
- * Raises:
1790
- * NotFound: If the specified organization does not exist.
1791
- * BadRequest: If the provided parameters are invalid.
1792
- *
1793
- * Query Parameters:
1794
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1795
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1796
- * limit (int): Number of results per page - default: 10.
1797
- * offset (int): Offset for pagination - default: 0.
1798
- * @returns LLMTracesListResponse
1799
- * @throws ApiError
1800
- */
1801
- static aiAnalyticsOrgsUsersCostsPeruserRetrieve({ endDate, org, startDate, userId, }: {
1802
- endDate: string;
1803
- org: string;
1804
- startDate: string;
1805
- }): CancelablePromise<LLMTracesListResponse>;
1806
- /**
1807
- * Retrieve summary statistics about mentors.
1808
- *
1809
- * This endpoint returns aggregated statistics about mentors within an organization,
1810
- * including total mentors, active mentors (mentors with at least one session),
1811
- * questions answered, and ratings.
1812
- *
1813
- * Args:
1814
- * request: The HTTP request.
1815
- * org: Organization key identifier.
1816
- *
1817
- * Returns:
1818
- * Response: Summary statistics about mentors.
1819
- *
1820
- * Raises:
1821
- * NotFound: If the specified organization does not exist.
1822
- * @returns MentorDetailAnalytics
1823
- * @throws ApiError
1824
- */
1825
- static aiAnalyticsOrgsUsersMentorDetailRetrieve({ org, userId, }: {
1826
- org: string;
1827
- }): CancelablePromise<MentorDetailAnalytics>;
1828
- /**
1829
- * Retrieve summary statistics about mentors.
1830
- *
1831
- * This endpoint returns aggregated statistics about mentors within an organization,
1832
- * including total mentors, active mentors (mentors with at least one session),
1833
- * questions answered, and ratings.
1834
- *
1835
- * Args:
1836
- * request: The HTTP request.
1837
- * org: Organization key identifier.
1838
- *
1839
- * Returns:
1840
- * Response: Summary statistics about mentors.
1841
- *
1842
- * Raises:
1843
- * NotFound: If the specified organization does not exist.
1844
- * @returns MentorDetailAnalytics
1845
- * @throws ApiError
1846
- */
1847
- static aiAnalyticsOrgsUsersMentorSummaryRetrieve({ org, userId, }: {
1848
- org: string;
1849
- }): CancelablePromise<MentorDetailAnalytics>;
1850
- /**
1851
- * Retrieve LLM usage costs for a specific mentor.
1852
- *
1853
- * This endpoint returns data on the total cost of LLM usage for a specific mentor
1854
- * within a specified date range. The cost is calculated by summing the costs
1855
- * of all observations associated with traces from the tenant's sessions.
1856
- *
1857
- * Args:
1858
- * request: The HTTP request containing filter query parameters.
1859
- * org: Organization key identifier.
1860
- * mentor_unique_id: User key identifier.
1861
- *
1862
- * Returns:
1863
- * Response: Total LLM usage cost for the specified tenant.
1864
- *
1865
- * Raises:
1866
- * NotFound: If the specified organization does not exist.
1867
- * BadRequest: If the provided parameters are invalid.
1868
- *
1869
- * Query Parameters:
1870
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1871
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1872
- * @returns Cost
1873
- * @throws ApiError
1874
- */
1875
- static aiAnalyticsOrgsUsersMentorsCostRetrieve({ endDate, mentorUniqueId, org, startDate, userId, }: {
1876
- endDate: string;
1877
- mentorUniqueId: string;
1878
- org: string;
1879
- startDate: string;
1880
- }): CancelablePromise<Cost>;
1881
- /**
1882
- * Retrieve the most discussed topics over time.
1883
- *
1884
- * This endpoint returns data on the frequency of topics discussed in conversations
1885
- * within a specified date range, with options for filtering by mentor and
1886
- * aggregating by different time periods (hourly, daily, weekly).
1887
- *
1888
- * Args:
1889
- * request: The HTTP request containing filter query parameters.
1890
- * org: Organization key identifier.
1891
- *
1892
- * Returns:
1893
- * Response: List of topics with their conversation counts, ordered by frequency.
1894
- *
1895
- * Raises:
1896
- * NotFound: If the specified organization does not exist.
1897
- * BadRequest: If the provided parameters are invalid.
1898
- *
1899
- * Query Parameters:
1900
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
1901
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
1902
- * mentor_id (str): Filter by mentor unique ID.
1903
- * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
1904
- * @returns TopicRecord
1905
- * @throws ApiError
1906
- */
1907
- static aiAnalyticsOrgsUsersMostDiscussedTopicsList({ endDate, org, startDate, userId, aggregation, groupBy, mentorId, }: {
1908
- /**
1909
- * End date for filtering (YYYY-MM-DD)
1910
- */
1911
- endDate: string;
1912
- org: string;
1913
- /**
1914
- * Start date for filtering (YYYY-MM-DD)
1915
- */
1916
- startDate: string;
1917
- userId: string;
1918
- /**
1919
- * Time aggregation level (hourly, daily, weekly)
1920
- */
1921
- aggregation?: 'daily' | 'hourly' | 'weekly';
1922
- groupBy?: string;
1923
- /**
1924
- * Filter by mentor unique ID
1925
- */
1926
- mentorId?: string;
1927
- }): CancelablePromise<Array<TopicRecord>>;
1928
- /**
1929
- * Viewset for retrieving and listing Langfuse observations.
1930
- *
1931
- * This viewset provides read-only access to Langfuse observations data for platform admins.
1932
- * Observations represent detailed tracking of AI model interactions and responses.
1933
- *
1934
- * Permissions:
1935
- * - Restricted to platform administrators only
1936
- * @returns PaginatedObservationList
1937
- * @throws ApiError
1938
- */
1939
- static aiAnalyticsOrgsUsersObservationsList({ org, userId, limit, offset, ordering, search, }: {
1940
- org: string; /**
1941
- * Number of results to return per page.
1942
- */
1943
- limit?: number; /**
1944
- * The initial index from which to return the results.
1945
- */
1946
- offset?: number; /**
1947
- * Which field to use when ordering the results.
1948
- */
1949
- ordering?: string; /**
1950
- * A search term.
1951
- */
1952
- search?: string;
1953
- }): CancelablePromise<PaginatedObservationList>;
1954
- /**
1955
- * Viewset for retrieving and listing Langfuse observations.
1956
- *
1957
- * This viewset provides read-only access to Langfuse observations data for platform admins.
1958
- * Observations represent detailed tracking of AI model interactions and responses.
1959
- *
1960
- * Permissions:
1961
- * - Restricted to platform administrators only
1962
- * @returns Observation
1963
- * @throws ApiError
1964
- */
1965
- static aiAnalyticsOrgsUsersObservationsRetrieve({ id, org, userId, }: {
1966
- id: string;
1967
- org: string;
1968
- }): CancelablePromise<Observation>;
1969
- /**
1970
- * Retrieve an overview of key analytics metrics.
1971
- *
1972
- * This endpoint returns a comprehensive overview of key analytics metrics
1973
- * for an organization, including:
1974
- * - Conversation volume: Total sessions and month-over-month change
1975
- * - Users: Total unique users and month-over-month change
1976
- * - Topics: Total unique topics and month-over-month change
1977
- * - User ratings: Total ratings and month-over-month change
1978
- *
1979
- * Results can be filtered by mentor.
1980
- *
1981
- * Args:
1982
- * request: The HTTP request containing filter query parameters.
1983
- * org: Organization key identifier.
1984
- * user_id: User identifier (not used in the implementation).
1985
- *
1986
- * Returns:
1987
- * Response: Overview of key analytics metrics with month-over-month changes.
1988
- *
1989
- * Raises:
1990
- * NotFound: If the specified organization does not exist.
1991
- *
1992
- * Query Parameters:
1993
- * mentor_id (str): Filter analytics by mentor unique ID.
1994
- * @returns AnalyticsOverview
1995
- * @throws ApiError
1996
- */
1997
- static aiAnalyticsOrgsUsersOverviewSummaryRetrieve({ org, userId, groupBy, mentorId, }: {
1998
- org: string;
1999
- groupBy?: string; /**
2000
- * Filter analytics by mentor unique ID
2001
- */
2002
- mentorId?: string;
2003
- }): CancelablePromise<AnalyticsOverview>;
2004
- /**
2005
- * Retrieve user rating metrics over time.
2006
- *
2007
- * This endpoint returns data on the number of user ratings submitted
2008
- * within a specified date range, aggregated by day or hour.
2009
- *
2010
- * Args:
2011
- * request: The HTTP request containing filter query parameters.
2012
- * org: Organization key identifier.
2013
- *
2014
- * Returns:
2015
- * Response: Time series of rating counts aggregated by day or hour.
2016
- *
2017
- * Raises:
2018
- * NotFound: If the specified organization does not exist.
2019
- * BadRequest: If the provided parameters are invalid.
2020
- *
2021
- * Query Parameters:
2022
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2023
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2024
- * group_by (str): Aggregation level (day or hour) - default: day.
2025
- * @returns RatingRecord
2026
- * @throws ApiError
2027
- */
2028
- static aiAnalyticsOrgsUsersRatingSummaryList({ endDate, org, startDate, userId, groupBy, }: {
2029
- /**
2030
- * End date for filtering (YYYY-MM-DD)
2031
- */
2032
- endDate: string;
2033
- org: string;
2034
- /**
2035
- * Start date for filtering (YYYY-MM-DD)
2036
- */
2037
- startDate: string;
2038
- userId: string;
2039
- /**
2040
- * Aggregation level (day or hour)
2041
- */
2042
- groupBy?: 'day' | 'hour';
2043
- }): CancelablePromise<Array<RatingRecord>>;
2044
- /**
2045
- * Retrieve trends of registered users over time.
2046
- *
2047
- * This endpoint returns data on the number of new user registrations
2048
- * within a specified date range, with options for different time aggregations
2049
- * (hourly, daily, weekly, monthly). The data is backfilled to ensure
2050
- * continuous time series even for periods with zero registrations.
2051
- *
2052
- * Args:
2053
- * request: The HTTP request containing filter query parameters.
2054
- * org: Organization key identifier.
2055
- *
2056
- * Returns:
2057
- * Response: Time series of user registration counts.
2058
- *
2059
- * Raises:
2060
- * NotFound: If the specified organization does not exist.
2061
- * BadRequest: If the provided parameters are invalid.
2062
- *
2063
- * Query Parameters:
2064
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2065
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2066
- * aggregation (str): Time aggregation level (hourly, daily, weekly, monthly) - default: daily.
2067
- * @returns TrendEntry
2068
- * @throws ApiError
2069
- */
2070
- static aiAnalyticsOrgsUsersRegisteredUsersTrendList({ endDate, org, startDate, userId, aggregation, groupBy, }: {
2071
- /**
2072
- * End date for filtering (YYYY-MM-DD)
2073
- */
2074
- endDate: string;
2075
- org: string;
2076
- /**
2077
- * Start date for filtering (YYYY-MM-DD)
2078
- */
2079
- startDate: string;
2080
- userId: string;
2081
- /**
2082
- * Time aggregation level (hourly, daily, weekly, monthly)
2083
- */
2084
- aggregation?: 'daily' | 'hourly' | 'monthly' | 'weekly';
2085
- groupBy?: string;
2086
- }): CancelablePromise<Array<TrendEntry>>;
2087
- /**
2088
- * Retrieve user sentiment counts over time.
2089
- *
2090
- * This endpoint returns data on the number of user sentiment entries
2091
- * within a specified time period, aggregated by date.
2092
- *
2093
- * Args:
2094
- * request: The HTTP request containing filter query parameters.
2095
- * org: Organization key identifier.
2096
- * user_id: User identifier.
2097
- *
2098
- * Returns:
2099
- * Response: Time series data of sentiment counts.
2100
- *
2101
- * Raises:
2102
- * NotFound: If the specified organization does not exist.
2103
- * ValidationError: If the provided query parameters are invalid.
2104
- *
2105
- * Query Parameters:
2106
- * period (str): Time period filter (today, yesterday, 7d, 30d, 90d) - default: 7d.
2107
- * @returns UserSentimentCountView
2108
- * @throws ApiError
2109
- */
2110
- static aiAnalyticsOrgsUsersSentimentCountList({ org, userId, period, }: {
2111
- org: string;
2112
- period?: string;
2113
- }): CancelablePromise<Array<UserSentimentCountView>>;
2114
- /**
2115
- * Retrieve LLM usage costs for a specific tenant.
2116
- *
2117
- * This endpoint returns data on the total cost of LLM usage for a specific tenant
2118
- * within a specified date range. The cost is calculated by summing the costs
2119
- * of all observations associated with traces from the tenant's sessions.
2120
- *
2121
- * Args:
2122
- * request: The HTTP request containing filter query parameters.
2123
- * org: Organization key identifier.
2124
- *
2125
- * Returns:
2126
- * Response: Total LLM usage cost for the specified tenant.
2127
- *
2128
- * Raises:
2129
- * NotFound: If the specified organization does not exist.
2130
- * BadRequest: If the provided parameters are invalid.
2131
- *
2132
- * Query Parameters:
2133
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2134
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2135
- * @returns Cost
2136
- * @throws ApiError
2137
- */
2138
- static aiAnalyticsOrgsUsersTenantCostRetrieve({ endDate, org, startDate, userId, }: {
2139
- endDate: string;
2140
- org: string;
2141
- startDate: string;
2142
- }): CancelablePromise<Cost>;
2143
- /**
2144
- * Retrieve the most engaged students based on chat message count.
2145
- *
2146
- * This endpoint returns data on the top 20 students with the highest number of
2147
- * chat messages, with optional filtering by mentor and date range.
2148
- *
2149
- * Args:
2150
- * request: The HTTP request containing filter query parameters.
2151
- * org: Organization key identifier.
2152
- * user_id: User identifier (not used in the implementation).
2153
- *
2154
- * Returns:
2155
- * Response: List of top students with their chat message counts.
2156
- *
2157
- * Raises:
2158
- * NotFound: If the specified organization does not exist.
2159
- * BadRequest: If the provided parameters are invalid.
2160
- *
2161
- * Query Parameters:
2162
- * mentor_id (str): Filter by mentor unique ID.
2163
- * start_date (str): Start date for filtering (YYYY-MM-DD).
2164
- * end_date (str): End date for filtering (YYYY-MM-DD).
2165
- * @returns StudentChatMessage
2166
- * @throws ApiError
2167
- */
2168
- static aiAnalyticsOrgsUsersTopStudentsByChatMessagesList({ org, userId, groupBy, }: {
2169
- org: string;
2170
- groupBy?: string;
2171
- }): CancelablePromise<Array<StudentChatMessage>>;
2172
- /**
2173
- * Retrieve aggregated topic statistics.
2174
- *
2175
- * This endpoint returns statistical information about topics within an organization,
2176
- * including total topics, new topics, and percentage changes compared to the
2177
- * previous month. Results can be filtered by mentor.
2178
- *
2179
- * Args:
2180
- * request: The HTTP request containing filter query parameters.
2181
- * org: Organization key identifier.
2182
- *
2183
- * Returns:
2184
- * Response: Statistical information about topics.
2185
- *
2186
- * Raises:
2187
- * NotFound: If the specified organization or mentor does not exist.
2188
- *
2189
- * Query Parameters:
2190
- * mentor_id (str): Filter statistics by mentor unique ID.
2191
- * @returns TopicStatisticsResponse
2192
- * @throws ApiError
2193
- */
2194
- static aiAnalyticsOrgsUsersTopicOverviewRetrieve({ org, userId, mentorId, }: {
2195
- org: string; /**
2196
- * Filter statistics by mentor unique ID
2197
- */
2198
- mentorId?: string;
2199
- }): CancelablePromise<TopicStatisticsResponse>;
2200
- /**
2201
- * Retrieve paginated statistics about topics.
2202
- *
2203
- * This endpoint returns detailed statistics about topics, including:
2204
- * - Number of conversations related to each topic
2205
- * - Total message count for each topic
2206
- * - Average sentiment of conversations about each topic
2207
- * - Average user rating for conversations about each topic
2208
- *
2209
- * Results can be filtered by mentor and date range, and are paginated.
2210
- *
2211
- * Args:
2212
- * request: The HTTP request containing filter query parameters.
2213
- * org: Organization key identifier.
2214
- *
2215
- * Returns:
2216
- * Response: Paginated list of topic statistics.
2217
- *
2218
- * Raises:
2219
- * NotFound: If the specified organization or mentor does not exist.
2220
- * BadRequest: If the provided parameters are invalid.
2221
- *
2222
- * Query Parameters:
2223
- * start_date (str): Start date for filtering (YYYY-MM-DD).
2224
- * end_date (str): End date for filtering (YYYY-MM-DD).
2225
- * mentor_id (str): Filter by mentor unique ID.
2226
- * page (int): Page number for pagination - default: 1.
2227
- * page_size (int): Number of results per page - default: 20.
2228
- * @returns PaginatedTopicStatisticsResponse
2229
- * @throws ApiError
2230
- */
2231
- static aiAnalyticsOrgsUsersTopicStatisticsRetrieve({ org, userId, endDate, groupBy, mentorId, page, pageSize, startDate, }: {
2232
- org: string; /**
2233
- * End date for filtering (YYYY-MM-DD)
2234
- */
2235
- endDate?: string;
2236
- groupBy?: string;
2237
- /**
2238
- * Filter by mentor unique ID
2239
- */
2240
- mentorId?: string;
2241
- /**
2242
- * Page number for pagination
2243
- */
2244
- page?: number;
2245
- /**
2246
- * Number of results per page
2247
- */
2248
- pageSize?: number;
2249
- /**
2250
- * Start date for filtering (YYYY-MM-DD)
2251
- */
2252
- startDate?: string;
2253
- }): CancelablePromise<PaginatedTopicStatisticsResponse>;
2254
- /**
2255
- * Retrieve a summary of the most frequent topics.
2256
- *
2257
- * This endpoint returns a summary of the top 10 topics discussed in chat sessions,
2258
- * ordered by conversation count. Results can be filtered by mentor and date range.
2259
- *
2260
- * Args:
2261
- * request: The HTTP request containing filter query parameters.
2262
- * org: Organization key identifier.
2263
- *
2264
- * Returns:
2265
- * Response: A list of the top 10 topics with their conversation counts.
2266
- *
2267
- * Raises:
2268
- * NotFound: If the specified organization does not exist.
2269
- * BadRequest: If the provided date format is invalid.
2270
- *
2271
- * Query Parameters:
2272
- * mentor_id (str): Filter by mentor unique ID.
2273
- * start_date (str): Start date for filtering (YYYY-MM-DD).
2274
- * end_date (str): End date for filtering (YYYY-MM-DD).
2275
- * @returns TopicSummaryView
2276
- * @throws ApiError
2277
- */
2278
- static aiAnalyticsOrgsUsersTopicsSummaryList({ org, userId, endDate, startDate, }: {
2279
- org: string;
2280
- endDate?: string;
2281
- startDate?: string;
2282
- }): CancelablePromise<Array<TopicSummaryView>>;
2283
- /**
2284
- * Retrieve the total number of users interacting with mentors over time.
2285
- *
2286
- * This endpoint returns data on the number of unique users who interacted with
2287
- * mentors each day or hour within a specified date range, with optional
2288
- * filtering by specific mentor. If no date range is provided, the last 30 days
2289
- * are used by default.
2290
- *
2291
- * Args:
2292
- * request: The HTTP request containing filter query parameters.
2293
- * org: Organization key identifier.
2294
- *
2295
- * Returns:
2296
- * Response: Time series of unique user counts.
2297
- *
2298
- * Raises:
2299
- * NotFound: If the specified organization or mentor does not exist.
2300
- * BadRequest: If the provided parameters are invalid.
2301
- *
2302
- * Query Parameters:
2303
- * start_date (str): Start date for filtering (YYYY-MM-DD) - defaults to 30 days ago.
2304
- * end_date (str): End date for filtering (YYYY-MM-DD) - defaults to today.
2305
- * aggregation (str): Time aggregation level (hourly, daily) - default: daily.
2306
- * mentor_id (str): Filter by mentor unique ID.
2307
- * @returns UserChatByPeriod
2308
- * @throws ApiError
2309
- */
2310
- static aiAnalyticsOrgsUsersTotalUsersByMentorList({ org, userId, aggregation, endDate, groupBy, mentorId, startDate, }: {
2311
- org: string; /**
2312
- * Time aggregation level (hourly, daily)
2313
- */
2314
- aggregation?: 'daily' | 'hourly';
2315
- /**
2316
- * End date for filtering (YYYY-MM-DD)
2317
- */
2318
- endDate?: string;
2319
- groupBy?: string;
2320
- /**
2321
- * Filter by mentor unique ID
2322
- */
2323
- mentorId?: string;
2324
- /**
2325
- * Start date for filtering (YYYY-MM-DD)
2326
- */
2327
- startDate?: string;
2328
- }): CancelablePromise<Array<UserChatByPeriod>>;
2329
- /**
2330
- * Viewset for retrieving and listing Langfuse traces.
2331
- *
2332
- * This viewset provides read-only access to Langfuse traces data for platform admins.
2333
- * Traces represent high-level tracking of user interactions and AI responses.
2334
- *
2335
- * Permissions:
2336
- * - Restricted to platform administrators only
2337
- * @returns PaginatedTraceList
2338
- * @throws ApiError
2339
- */
2340
- static aiAnalyticsOrgsUsersTracesList({ org, userId, limit, offset, ordering, search, }: {
2341
- org: string; /**
2342
- * Number of results to return per page.
2343
- */
2344
- limit?: number; /**
2345
- * The initial index from which to return the results.
2346
- */
2347
- offset?: number; /**
2348
- * Which field to use when ordering the results.
2349
- */
2350
- ordering?: string; /**
2351
- * A search term.
2352
- */
2353
- search?: string;
2354
- }): CancelablePromise<PaginatedTraceList>;
2355
- /**
2356
- * Viewset for retrieving and listing Langfuse traces.
2357
- *
2358
- * This viewset provides read-only access to Langfuse traces data for platform admins.
2359
- * Traces represent high-level tracking of user interactions and AI responses.
2360
- *
2361
- * Permissions:
2362
- * - Restricted to platform administrators only
2363
- * @returns Trace
2364
- * @throws ApiError
2365
- */
2366
- static aiAnalyticsOrgsUsersTracesRetrieve({ id, org, userId, }: {
2367
- id: string;
2368
- org: string;
2369
- }): CancelablePromise<Trace>;
2370
- /**
2371
- * Retrieve message data from conversations.
2372
- *
2373
- * This endpoint returns data on messages within conversations, with options
2374
- * for filtering by date range, topics, and mentor.
2375
- *
2376
- * Args:
2377
- * request: The HTTP request containing filter query parameters.
2378
- * org: Organization key identifier.
2379
- * user_id: User identifier (not used in the implementation).
2380
- *
2381
- * Returns:
2382
- * Response: A list of conversation message data.
2383
- *
2384
- * Raises:
2385
- * NotFound: If the specified organization does not exist.
2386
- * ValidationError: If the provided query parameters are invalid.
2387
- *
2388
- * Query Parameters:
2389
- * start_date (str): Start date for filtering (YYYY-MM-DD).
2390
- * end_date (str): End date for filtering (YYYY-MM-DD).
2391
- * topics (str): Comma-separated list of topics to filter by.
2392
- * mentor (str): Filter by mentor unique ID.
2393
- * @returns ConversationMessage
2394
- * @throws ApiError
2395
- */
2396
- static aiAnalyticsOrgsUsersTranscriptsList({ org, userId, endDate, mentor, startDate, topics, }: {
2397
- org: string;
2398
- endDate?: string;
2399
- mentor?: string;
2400
- startDate?: string;
2401
- topics?: string;
2402
- }): CancelablePromise<Array<ConversationMessage>>;
2403
- /**
2404
- * Retrieve daily user engagement metrics with mentors.
2405
- *
2406
- * This endpoint returns data on the number of unique users who interact with
2407
- * mentors each day within a specified date range.
2408
- *
2409
- * Args:
2410
- * request: The HTTP request containing filter query parameters.
2411
- * org: Organization key identifier.
2412
- *
2413
- * Returns:
2414
- * Response: Daily time series of unique user counts.
2415
- *
2416
- * Raises:
2417
- * NotFound: If the specified organization does not exist.
2418
- * BadRequest: If the provided parameters are invalid.
2419
- *
2420
- * Query Parameters:
2421
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2422
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2423
- * @returns UserCountRecord
2424
- * @throws ApiError
2425
- */
2426
- static aiAnalyticsOrgsUsersUsageSummaryList({ endDate, org, startDate, userId, groupBy, }: {
2427
- /**
2428
- * End date for filtering (YYYY-MM-DD)
2429
- */
2430
- endDate: string;
2431
- org: string;
2432
- /**
2433
- * Start date for filtering (YYYY-MM-DD)
2434
- */
2435
- startDate: string;
2436
- userId: string;
2437
- groupBy?: string;
2438
- }): CancelablePromise<Array<UserCountRecord>>;
2439
- /**
2440
- * Retrieve user cohort trends over time.
2441
- *
2442
- * This endpoint returns data on the distribution of new versus veteran users
2443
- * over time, with options for different time aggregations and filtering by mentor.
2444
- * New users are those who registered within the specified date range, while
2445
- * veteran users are those who registered before the date range but were active
2446
- * during it.
2447
- *
2448
- * Args:
2449
- * request: The HTTP request containing filter query parameters.
2450
- * org: Organization key identifier.
2451
- *
2452
- * Returns:
2453
- * Response: Time series of new and veteran user counts.
2454
- *
2455
- * Raises:
2456
- * NotFound: If the specified organization does not exist.
2457
- * BadRequest: If the provided parameters are invalid.
2458
- *
2459
- * Query Parameters:
2460
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2461
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2462
- * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
2463
- * mentor_id (str): Filter by mentor unique ID.
2464
- * @returns UserTrendByPeriod
2465
- * @throws ApiError
2466
- */
2467
- static aiAnalyticsOrgsUsersUserCohortsOverTimeRetrieve({ endDate, org, startDate, userId, aggregation, mentorId, }: {
2468
- /**
2469
- * End date for filtering (YYYY-MM-DD)
2470
- */
2471
- endDate: string;
2472
- org: string;
2473
- /**
2474
- * Start date for filtering (YYYY-MM-DD)
2475
- */
2476
- startDate: string;
2477
- userId: string;
2478
- /**
2479
- * Time aggregation level (hourly, daily, weekly)
2480
- */
2481
- aggregation?: 'daily' | 'hourly' | 'weekly';
2482
- /**
2483
- * Filter by mentor unique ID
2484
- */
2485
- mentorId?: string;
2486
- }): CancelablePromise<UserTrendByPeriod>;
2487
- /**
2488
- * Retrieve LLM usage costs for a specific user.
2489
- *
2490
- * This endpoint returns data on the total cost of LLM usage for a specific user
2491
- * within a specified date range. The cost is calculated by summing the costs
2492
- * of all observations associated with traces from the tenant's sessions.
2493
- *
2494
- * Args:
2495
- * request: The HTTP request containing filter query parameters.
2496
- * org: Organization key identifier.
2497
- * user_id: User key identifier.
2498
- *
2499
- * Returns:
2500
- * Response: Total LLM usage cost for the specified tenant.
2501
- *
2502
- * Raises:
2503
- * NotFound: If the specified organization does not exist.
2504
- * BadRequest: If the provided parameters are invalid.
2505
- *
2506
- * Query Parameters:
2507
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2508
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2509
- * @returns Cost
2510
- * @throws ApiError
2511
- */
2512
- static aiAnalyticsOrgsUsersUserCostRetrieve({ endDate, org, startDate, userId, username, }: {
2513
- endDate: string;
2514
- org: string;
2515
- startDate: string;
2516
- username: string;
2517
- }): CancelablePromise<Cost>;
2518
- /**
2519
- * Retrieve aggregated user chat feedback counts.
2520
- *
2521
- * This endpoint returns data on the number of user chat feedback entries
2522
- * within a specified date range, with options for different time aggregations
2523
- * (hourly, daily, weekly). Results can be filtered by mentor.
2524
- *
2525
- * Args:
2526
- * request: The HTTP request containing filter query parameters.
2527
- * org: Organization key identifier.
2528
- *
2529
- * Returns:
2530
- * Response: Time series data of feedback counts.
2531
- *
2532
- * Raises:
2533
- * NotFound: If the specified organization does not exist.
2534
- * BadRequest: If the provided parameters are invalid.
2535
- *
2536
- * Query Parameters:
2537
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2538
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2539
- * mentor_id (str): Filter by mentor unique ID.
2540
- * aggregation (str): Time aggregation level (hourly, daily, weekly) - default: daily.
2541
- * @returns UserChatFeedbackCount
2542
- * @throws ApiError
2543
- */
2544
- static aiAnalyticsOrgsUsersUserFeedbackList({ endDate, org, startDate, userId, aggregation, mentorId, }: {
2545
- /**
2546
- * End date for filtering (YYYY-MM-DD)
2547
- */
2548
- endDate: string;
2549
- org: string;
2550
- /**
2551
- * Start date for filtering (YYYY-MM-DD)
2552
- */
2553
- startDate: string;
2554
- userId: string;
2555
- /**
2556
- * Time aggregation level (hourly, daily, weekly)
2557
- */
2558
- aggregation?: 'daily' | 'hourly' | 'weekly';
2559
- /**
2560
- * Filter by mentor unique ID
2561
- */
2562
- mentorId?: string;
2563
- }): CancelablePromise<Array<UserChatFeedbackCount>>;
2564
- /**
2565
- * Retrieve comprehensive user metrics.
2566
- *
2567
- * This endpoint returns data on various user metrics with month-over-month
2568
- * change calculations:
2569
- * - Registered users: Total users registered on the platform
2570
- * - New users: Users who joined in the current month
2571
- * - Unique users: Distinct users who have had sessions
2572
- * - Veteran users: Users who have been active for at least 6 months
2573
- *
2574
- * Results can be filtered by mentor.
2575
- *
2576
- * Args:
2577
- * request: The HTTP request containing filter query parameters.
2578
- * org: Organization key identifier.
2579
- *
2580
- * Returns:
2581
- * Response: Comprehensive user metrics with month-over-month changes.
2582
- *
2583
- * Raises:
2584
- * NotFound: If the specified organization does not exist.
2585
- *
2586
- * Query Parameters:
2587
- * mentor_id (str): Filter metrics by mentor unique ID.
2588
- * @returns UserMetricsResponse
2589
- * @throws ApiError
2590
- */
2591
- static aiAnalyticsOrgsUsersUserMetricsRetrieve({ org, userId, groupBy, mentorId, }: {
2592
- org: string;
2593
- groupBy?: string; /**
2594
- * Filter metrics by mentor unique ID
2595
- */
2596
- mentorId?: string;
2597
- }): CancelablePromise<UserMetricsResponse>;
2598
- /**
2599
- * Retrieve user distribution data for pie charts.
2600
- *
2601
- * This endpoint returns data on the distribution of new versus returning users
2602
- * within a specified date range, including both counts and percentages,
2603
- * suitable for pie chart visualization.
2604
- *
2605
- * Args:
2606
- * request: The HTTP request containing filter query parameters.
2607
- * org: Organization key identifier.
2608
- *
2609
- * Returns:
2610
- * Response: Distribution of new versus returning users with counts and percentages.
2611
- *
2612
- * Raises:
2613
- * NotFound: If the specified organization does not exist.
2614
- * BadRequest: If the provided parameters are invalid.
2615
- *
2616
- * Query Parameters:
2617
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2618
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2619
- * mentor_id (str): Filter by mentor unique ID.
2620
- * @returns PieChartData
2621
- * @throws ApiError
2622
- */
2623
- static aiAnalyticsOrgsUsersUserMetricsPieChartRetrieve({ endDate, org, startDate, userId, mentorId, }: {
2624
- /**
2625
- * End date for filtering (YYYY-MM-DD)
2626
- */
2627
- endDate: string;
2628
- org: string;
2629
- /**
2630
- * Start date for filtering (YYYY-MM-DD)
2631
- */
2632
- startDate: string;
2633
- userId: string;
2634
- /**
2635
- * Filter by mentor unique ID
2636
- */
2637
- mentorId?: string;
2638
- }): CancelablePromise<PieChartData>;
2639
- /**
2640
- * Retrieve user sentiment distribution.
2641
- *
2642
- * This endpoint returns data on the distribution of user sentiments (positive,
2643
- * negative, neutral) within a specified date range, expressed as percentages.
2644
- *
2645
- * Args:
2646
- * request: The HTTP request containing filter query parameters.
2647
- * org: Organization key identifier.
2648
- *
2649
- * Returns:
2650
- * Response: Sentiment distribution percentages and total sentiment count.
2651
- *
2652
- * Raises:
2653
- * NotFound: If the specified organization does not exist.
2654
- * BadRequest: If the provided parameters are invalid.
2655
- *
2656
- * Query Parameters:
2657
- * start_date (str): Start date for filtering (YYYY-MM-DD) - required.
2658
- * end_date (str): End date for filtering (YYYY-MM-DD) - required.
2659
- * @returns SentimentSummary
2660
- * @throws ApiError
2661
- */
2662
- static aiAnalyticsOrgsUsersUserSentimentRetrieve({ endDate, org, startDate, userId, groupBy, }: {
2663
- /**
2664
- * End date for filtering (YYYY-MM-DD)
2665
- */
2666
- endDate: string;
2667
- org: string;
2668
- /**
2669
- * Start date for filtering (YYYY-MM-DD)
2670
- */
2671
- startDate: string;
2672
- userId: string;
2673
- groupBy?: string;
2674
- }): CancelablePromise<SentimentSummary>;
2675
- /**
2676
- * Get active user counts over time.
2677
- *
2678
- * This endpoint provides daily counts of active users (users with known activity)
2679
- * over a specified time period.
2680
- *
2681
- * Query Parameters:
2682
- * start_date (str, optional): Start date for the time range (ISO format)
2683
- * end_date (str, optional): End date for the time range (ISO format)
2684
- *
2685
- * Returns:
2686
- * Daily active user counts over the specified time period, with change metrics
2687
- * compared to previous periods.
2688
- *
2689
- * Default time range is the last 7 days if no dates are specified.
2690
- *
2691
- * An active user is defined as a user with any activity within the past 30 days.
2692
- * @returns OvertimeWithChangeInfo
2693
- * @throws ApiError
2694
- */
2695
- static aiAnalyticsOverviewOrgsActiveUsersRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
2696
- org: string;
2697
- /**
2698
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2699
- */
2700
- departmentId?: number;
2701
- /**
2702
- * end date. ISO 8601
2703
- */
2704
- endDate?: string;
2705
- /**
2706
- * Format
2707
- *
2708
- * * `json` - json
2709
- */
2710
- format?: 'json';
2711
- /**
2712
- * Include main platform data
2713
- */
2714
- includeMainPlatform?: boolean;
2715
- /**
2716
- * start date. ISO 8601
2717
- */
2718
- startDate?: string;
2719
- }): CancelablePromise<OvertimeWithChangeInfo>;
2720
- /**
2721
- * Get average grade value for platform, course, or user.
2722
- *
2723
- * This endpoint returns the average grade at different levels:
2724
- * - Platform level: Average grade across all courses
2725
- * - Course level: Average grade for a specific course
2726
- * - Learner level: Average grade for a specific learner
2727
- * - Course-learner level: Grade for a specific learner in a specific course
2728
- *
2729
- * Query Parameters:
2730
- * course_id (str, optional): Filter by course ID
2731
- * learner_id (str, optional): Filter by username or email
2732
- *
2733
- * Returns:
2734
- * The average grade value based on the specified filters.
2735
- *
2736
- * Access Control:
2737
- * - Platform admins can access any grade data
2738
- * - Learners can access their own grade data
2739
- * @returns Average
2740
- * @throws ApiError
2741
- */
2742
- static aiAnalyticsOverviewOrgsAverageGradeRetrieve({ org, departmentId, format, includeMainPlatform, }: {
2743
- org: string;
2744
- /**
2745
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2746
- */
2747
- departmentId?: number;
2748
- /**
2749
- * Format
2750
- *
2751
- * * `json` - json
2752
- */
2753
- format?: 'json';
2754
- /**
2755
- * Include main platform data
2756
- */
2757
- includeMainPlatform?: boolean;
2758
- }): CancelablePromise<Average>;
2759
- /**
2760
- * Get course completion summary metrics over time.
2761
- *
2762
- * This endpoint provides completion statistics across the platform over a
2763
- * specified time period, including daily completion counts and overall metrics.
2764
- *
2765
- * Query Parameters:
2766
- * start_date (str): Start date for the time range (ISO format)
2767
- * end_date (str): End date for the time range (ISO format)
2768
- *
2769
- * Returns:
2770
- * Completion data including:
2771
- * - Daily completion counts over time
2772
- * - Total unique user count
2773
- * - Total completion count
2774
- * - Completion percentage
2775
- * - Change metrics compared to previous periods
2776
- *
2777
- * Default time range is the last 7 days if no dates are specified.
2778
- * @returns CourseCompletionSummaryOvertime
2779
- * @throws ApiError
2780
- */
2781
- static aiAnalyticsOverviewOrgsCoursesCompletionsRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
2782
- org: string;
2783
- /**
2784
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2785
- */
2786
- departmentId?: number;
2787
- /**
2788
- * end date. ISO 8601
2789
- */
2790
- endDate?: string;
2791
- /**
2792
- * Format
2793
- *
2794
- * * `json` - json
2795
- */
2796
- format?: 'json';
2797
- /**
2798
- * Include main platform data
2799
- */
2800
- includeMainPlatform?: boolean;
2801
- /**
2802
- * start date. ISO 8601
2803
- */
2804
- startDate?: string;
2805
- }): CancelablePromise<CourseCompletionSummaryOvertime>;
2806
- /**
2807
- * List all learners on the platform with aggregated metrics.
2808
- *
2809
- * This endpoint returns a paginated list of all learners with key metrics including:
2810
- * - Enrollment counts
2811
- * - Completion counts
2812
- * - Time spent on platform
2813
- *
2814
- * Query Parameters:
2815
- * page (int): Page number for pagination
2816
- * length (int): Number of items per page
2817
- * search (str): Filter learners by username, email, or name
2818
- *
2819
- * Returns:
2820
- * A paginated list of learners with their associated metrics.
2821
- * @returns PerlearnerUserList
2822
- * @throws ApiError
2823
- */
2824
- static aiAnalyticsOverviewOrgsLearnersRetrieve({ org, departmentId, format, includeMainPlatform, length, page, search, }: {
2825
- org: string;
2826
- /**
2827
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2828
- */
2829
- departmentId?: number;
2830
- /**
2831
- * Format
2832
- *
2833
- * * `json` - json
2834
- */
2835
- format?: 'json';
2836
- /**
2837
- * Include main platform data
2838
- */
2839
- includeMainPlatform?: boolean;
2840
- /**
2841
- * Size of data to return
2842
- */
2843
- length?: number;
2844
- /**
2845
- * Page offset
2846
- */
2847
- page?: number;
2848
- /**
2849
- * Search string for learner
2850
- */
2851
- search?: string;
2852
- }): CancelablePromise<PerlearnerUserList>;
2853
- /**
2854
- * Get time spent statistics on a per-course basis.
2855
- *
2856
- * This endpoint provides a paginated list of courses with the total time
2857
- * spent by users in each course.
2858
- *
2859
- * Query Parameters:
2860
- * start_date (str, optional): Start date for filtering (ISO format)
2861
- * end_date (str, optional): End date for filtering (ISO format)
2862
- * page (int, optional): Page number for pagination
2863
- * length (int, optional): Number of items per page
2864
- *
2865
- * Returns:
2866
- * A paginated list of courses with:
2867
- * - Course identification (ID and name)
2868
- * - Total time spent (in seconds)
2869
- * - Formatted time spent (human-readable)
2870
- * - Percentage of total platform time
2871
- * @returns TimeSpentPerCourse
2872
- * @throws ApiError
2873
- */
2874
- static aiAnalyticsOverviewOrgsMostActiveCoursesRetrieve({ org, departmentId, endDate, format, includeMainPlatform, length, page, startDate, }: {
2875
- org: string;
2876
- /**
2877
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2878
- */
2879
- departmentId?: number;
2880
- /**
2881
- * end date. ISO 8601
2882
- */
2883
- endDate?: string;
2884
- /**
2885
- * Format
2886
- *
2887
- * * `json` - json
2888
- */
2889
- format?: 'json';
2890
- /**
2891
- * Include main platform data
2892
- */
2893
- includeMainPlatform?: boolean;
2894
- /**
2895
- * Size of data to return
2896
- */
2897
- length?: number;
2898
- /**
2899
- * Page offset
2900
- */
2901
- page?: number;
2902
- /**
2903
- * start date. ISO 8601
2904
- */
2905
- startDate?: string;
2906
- }): CancelablePromise<TimeSpentPerCourse>;
2907
- /**
2908
- * Get registered user counts over time.
2909
- *
2910
- * This endpoint provides daily counts of new user registrations over a
2911
- * specified time period.
2912
- *
2913
- * Query Parameters:
2914
- * start_date (str, optional): Start date for the time range (ISO format)
2915
- * end_date (str, optional): End date for the time range (ISO format)
2916
- *
2917
- * Returns:
2918
- * Daily registration counts over the specified time period, with change metrics
2919
- * compared to previous periods.
2920
- *
2921
- * Default time range is the last 7 days if no dates are specified.
2922
- * @returns OvertimeWithChangeInfo
2923
- * @throws ApiError
2924
- */
2925
- static aiAnalyticsOverviewOrgsRegisteredUsersRetrieve({ org, departmentId, endDate, format, includeMainPlatform, startDate, }: {
2926
- org: string;
2927
- /**
2928
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2929
- */
2930
- departmentId?: number;
2931
- /**
2932
- * end date. ISO 8601
2933
- */
2934
- endDate?: string;
2935
- /**
2936
- * Format
2937
- *
2938
- * * `json` - json
2939
- */
2940
- format?: 'json';
2941
- /**
2942
- * Include main platform data
2943
- */
2944
- includeMainPlatform?: boolean;
2945
- /**
2946
- * start date. ISO 8601
2947
- */
2948
- startDate?: string;
2949
- }): CancelablePromise<OvertimeWithChangeInfo>;
2950
- /**
2951
- * Get average grade value for platform, course, or user.
2952
- *
2953
- * This endpoint returns the average grade at different levels:
2954
- * - Platform level: Average grade across all courses
2955
- * - Course level: Average grade for a specific course
2956
- * - Learner level: Average grade for a specific learner
2957
- * - Course-learner level: Grade for a specific learner in a specific course
2958
- *
2959
- * Query Parameters:
2960
- * course_id (str, optional): Filter by course ID
2961
- * learner_id (str, optional): Filter by username or email
2962
- *
2963
- * Returns:
2964
- * The average grade value based on the specified filters.
2965
- *
2966
- * Access Control:
2967
- * - Platform admins can access any grade data
2968
- * - Learners can access their own grade data
2969
- * @returns Average
2970
- * @throws ApiError
2971
- */
2972
- static aiAnalyticsPerformanceOrgsCoursesGradingAverageRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
2973
- courseId: string;
2974
- org: string;
2975
- /**
2976
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
2977
- */
2978
- departmentId?: number;
2979
- /**
2980
- * Format
2981
- *
2982
- * * `json` - json
2983
- */
2984
- format?: 'json';
2985
- /**
2986
- * Include main platform data
2987
- */
2988
- includeMainPlatform?: boolean;
2989
- }): CancelablePromise<Average>;
2990
- /**
2991
- * Returns average course grade and grade cuttoff
2992
- *
2993
- * e.g
2994
- * ```
2995
- * {
2996
- * "data": {
2997
- * "grade_cutoffs": {
2998
- * "A": 90,
2999
- * "B": 80,
3000
- * "C": 70,
3001
- * },
3002
- * "average_grade": 50.0,
3003
- * }
3004
- * }
3005
- * ```
3006
- *
3007
- * Kwargs
3008
- * course_id
3009
- * @returns AvgCourseGradeWithCutoff
3010
- * @throws ApiError
3011
- */
3012
- static aiAnalyticsPerformanceOrgsCoursesGradingAverageWithCutoffRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
3013
- courseId: string;
3014
- org: string;
3015
- /**
3016
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3017
- */
3018
- departmentId?: number;
3019
- /**
3020
- * Format
3021
- *
3022
- * * `json` - json
3023
- */
3024
- format?: 'json';
3025
- /**
3026
- * Include main platform data
3027
- */
3028
- includeMainPlatform?: boolean;
3029
- }): CancelablePromise<AvgCourseGradeWithCutoff>;
3030
- /**
3031
- * Grading summary for the entire course overview in a tree-like format
3032
- *
3033
- * Kwargs
3034
- * course_id <required>
3035
- * @returns CourseGradingDetail
3036
- * @throws ApiError
3037
- */
3038
- static aiAnalyticsPerformanceOrgsCoursesGradingDetailRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
3039
- courseId: string;
3040
- org: string;
3041
- /**
3042
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3043
- */
3044
- departmentId?: number;
3045
- /**
3046
- * Format
3047
- *
3048
- * * `json` - json
3049
- */
3050
- format?: 'json';
3051
- /**
3052
- * Include main platform data
3053
- */
3054
- includeMainPlatform?: boolean;
3055
- }): CancelablePromise<CourseGradingDetail>;
3056
- /**
3057
- * Grading information per enrolled user in a course
3058
- *
3059
- * Kwargs
3060
- * course_id <required>
3061
- * @returns GradingPerUser
3062
- * @throws ApiError
3063
- */
3064
- static aiAnalyticsPerformanceOrgsCoursesGradingPerLearnerRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
3065
- courseId: string;
3066
- org: string;
3067
- /**
3068
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3069
- */
3070
- departmentId?: number;
3071
- /**
3072
- * Format
3073
- *
3074
- * * `json` - json
3075
- */
3076
- format?: 'json';
3077
- /**
3078
- * Include main platform data
3079
- */
3080
- includeMainPlatform?: boolean;
3081
- }): CancelablePromise<GradingPerUser>;
3082
- /**
3083
- * Returns average grades across various assignment types in a course
3084
- *
3085
- * Query Params
3086
- * course_id
3087
- *
3088
- * Returns:
3089
- * dict
3090
- * {
3091
- * "data": [
3092
- * {
3093
- * "assignment_type': <str>,
3094
- * "weight": <float>,
3095
- * "average_weighted_grade": <float>,
3096
- * "average_section_grade": <float>
3097
- * }, ...
3098
- * ]
3099
- * }
3100
- * @returns CourseGradeSummary
3101
- * @throws ApiError
3102
- */
3103
- static aiAnalyticsPerformanceOrgsCoursesGradingSummaryRetrieve({ courseId, org, departmentId, format, includeMainPlatform, }: {
3104
- courseId: string;
3105
- org: string;
3106
- /**
3107
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3108
- */
3109
- departmentId?: number;
3110
- /**
3111
- * Format
3112
- *
3113
- * * `json` - json
3114
- */
3115
- format?: 'json';
3116
- /**
3117
- * Include main platform data
3118
- */
3119
- includeMainPlatform?: boolean;
3120
- }): CancelablePromise<CourseGradeSummary>;
3121
- /**
3122
- * Get average grade value for platform, course, or user.
3123
- *
3124
- * This endpoint returns the average grade at different levels:
3125
- * - Platform level: Average grade across all courses
3126
- * - Course level: Average grade for a specific course
3127
- * - Learner level: Average grade for a specific learner
3128
- * - Course-learner level: Grade for a specific learner in a specific course
3129
- *
3130
- * Query Parameters:
3131
- * course_id (str, optional): Filter by course ID
3132
- * learner_id (str, optional): Filter by username or email
3133
- *
3134
- * Returns:
3135
- * The average grade value based on the specified filters.
3136
- *
3137
- * Access Control:
3138
- * - Platform admins can access any grade data
3139
- * - Learners can access their own grade data
3140
- * @returns Average
3141
- * @throws ApiError
3142
- */
3143
- static aiAnalyticsPerformanceOrgsGradingAverageRetrieve({ org, departmentId, format, includeMainPlatform, }: {
3144
- org: string;
3145
- /**
3146
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3147
- */
3148
- departmentId?: number;
3149
- /**
3150
- * Format
3151
- *
3152
- * * `json` - json
3153
- */
3154
- format?: 'json';
3155
- /**
3156
- * Include main platform data
3157
- */
3158
- includeMainPlatform?: boolean;
3159
- }): CancelablePromise<Average>;
3160
- /**
3161
- * List grade-related performance data for all courses.
3162
- *
3163
- * This endpoint provides a comprehensive view of grade performance across
3164
- * courses, including enrollment counts, pass rates, and average grades.
3165
- *
3166
- * Returns:
3167
- * A paginated list of courses with:
3168
- * - Course identification (ID and name)
3169
- * - Enrollment count
3170
- * - Number of students who passed
3171
- * - Average grade
3172
- * @returns PerformanceGradesPerCourse
3173
- * @throws ApiError
3174
- */
3175
- static aiAnalyticsPerformanceOrgsGradingPerCourseRetrieve({ org, departmentId, format, includeMainPlatform, length, page, }: {
3176
- org: string;
3177
- /**
3178
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3179
- */
3180
- departmentId?: number;
3181
- /**
3182
- * Format
3183
- *
3184
- * * `json` - json
3185
- */
3186
- format?: 'json';
3187
- /**
3188
- * Include main platform data
3189
- */
3190
- includeMainPlatform?: boolean;
3191
- /**
3192
- * Size of data to return
3193
- */
3194
- length?: number;
3195
- /**
3196
- * Page offset
3197
- */
3198
- page?: number;
3199
- }): CancelablePromise<PerformanceGradesPerCourse>;
3200
- /**
3201
- * Enhanced API endpoint for listing learners with comprehensive filtering.
3202
- *
3203
- * This endpoint provides a paginated list of learners with detailed metrics
3204
- * and supports advanced filtering options. It uses DM token authentication
3205
- * and respects department-based access controls.
3206
- *
3207
- * Query Parameters:
3208
- * page (int): Page number for pagination
3209
- * length (int): Number of items per page
3210
- * search (str): Filter by username, email, or full name
3211
- * program (str): Filter by program
3212
- * location (str): Filter by location
3213
- * is_enrolled (bool): Filter for users with enrollments
3214
- * platform (str): Filter by platform
3215
- * start_date (date): Filter by join date (start range)
3216
- * end_date (date): Filter by join date (end range)
3217
- *
3218
- * Returns:
3219
- * A paginated list of learners with comprehensive metrics including:
3220
- * - Course enrollments and completions
3221
- * - Time spent on platform
3222
- * - Pathway progress
3223
- * - Certificate and skill information
3224
- * - Location data
3225
- *
3226
- * Access Control:
3227
- * - Platform admins can see all learners
3228
- * - Department admins can only see learners in their departments
3229
- * @returns NewPerLearnerList
3230
- * @throws ApiError
3231
- */
3232
- static aiAnalyticsPerlearnerOrgsLearnersRetrieve({ org, departmentId, endDate, format, includeMainPlatform, isEnrolled, length, location, page, platform, program, search, startDate, }: {
3233
- org: string;
3234
- /**
3235
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3236
- */
3237
- departmentId?: number;
3238
- /**
3239
- * Learner date_joined end date. ISO 8601
3240
- */
3241
- endDate?: string;
3242
- /**
3243
- * Format
3244
- *
3245
- * * `json` - json
3246
- */
3247
- format?: 'json';
3248
- /**
3249
- * Include main platform data
3250
- */
3251
- includeMainPlatform?: boolean;
3252
- /**
3253
- * Filter for users who have at least an enrollment
3254
- */
3255
- isEnrolled?: boolean | null;
3256
- /**
3257
- * Size of data to return
3258
- */
3259
- length?: number;
3260
- /**
3261
- * Location search string
3262
- */
3263
- location?: string;
3264
- /**
3265
- * Page offset
3266
- */
3267
- page?: number;
3268
- /**
3269
- * Platform search string
3270
- */
3271
- platform?: string;
3272
- /**
3273
- * Program search string
3274
- */
3275
- program?: string;
3276
- /**
3277
- * Search string for learner. email, username or full name
3278
- */
3279
- search?: string;
3280
- /**
3281
- * Learner date_joined start date. ISO 8601
3282
- */
3283
- startDate?: string;
3284
- }): CancelablePromise<NewPerLearnerList>;
3285
- /**
3286
- * List all learners on the platform with aggregated metrics.
3287
- *
3288
- * This endpoint returns a paginated list of all learners with key metrics including:
3289
- * - Enrollment counts
3290
- * - Completion counts
3291
- * - Time spent on platform
3292
- *
3293
- * Query Parameters:
3294
- * page (int): Page number for pagination
3295
- * length (int): Number of items per page
3296
- * search (str): Filter learners by username, email, or name
3297
- *
3298
- * Returns:
3299
- * A paginated list of learners with their associated metrics.
3300
- * @returns PerlearnerUserList
3301
- * @throws ApiError
3302
- */
3303
- static aiAnalyticsPerlearnerOrgsUsersRetrieve({ org, departmentId, format, includeMainPlatform, length, page, search, }: {
3304
- org: string;
3305
- /**
3306
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3307
- */
3308
- departmentId?: number;
3309
- /**
3310
- * Format
3311
- *
3312
- * * `json` - json
3313
- */
3314
- format?: 'json';
3315
- /**
3316
- * Include main platform data
3317
- */
3318
- includeMainPlatform?: boolean;
3319
- /**
3320
- * Size of data to return
3321
- */
3322
- length?: number;
3323
- /**
3324
- * Page offset
3325
- */
3326
- page?: number;
3327
- /**
3328
- * Search string for learner
3329
- */
3330
- search?: string;
3331
- }): CancelablePromise<PerlearnerUserList>;
3332
- /**
3333
- * Provides information on user enrollments
3334
- *
3335
- * Params
3336
- * user_id e.g developer@ibleducation.com| developer
3337
- * @returns ActivityAPI
3338
- * @throws ApiError
3339
- */
3340
- static aiAnalyticsPerlearnerOrgsUsersActivityRetrieve({ org, userId, departmentId, format, includeMainPlatform, }: {
3341
- org: string; /**
3342
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3343
- */
3344
- departmentId?: number; /**
3345
- * Format
3346
- *
3347
- * * `json` - json
3348
- */
3349
- format?: 'json'; /**
3350
- * Include main platform data
3351
- */
3352
- includeMainPlatform?: boolean;
3353
- }): CancelablePromise<ActivityAPI>;
3354
- /**
3355
- * Provides about a learner current grade in a course with the course cut
3356
- * Kwargs
3357
- * 1. course_id e.g course-v1:Org+Course4+Run
3358
- * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
3359
- * @returns PerlearnerGradeWithCutOff
3360
- * @throws ApiError
3361
- */
3362
- static aiAnalyticsPerlearnerOrgsUsersCoursesGradingCutoffsRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3363
- courseId: string;
3364
- org: string; /**
3365
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3366
- */
3367
- departmentId?: number; /**
3368
- * end date. ISO 8601
3369
- */
3370
- endDate?: string; /**
3371
- * Format
3372
- *
3373
- * * `json` - json
3374
- */
3375
- format?: 'json'; /**
3376
- * Include main platform data
3377
- */
3378
- includeMainPlatform?: boolean; /**
3379
- * start date. ISO 8601
3380
- */
3381
- startDate?: string;
3382
- }): CancelablePromise<PerlearnerGradeWithCutOff>;
3383
- /**
3384
- * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
3385
- * @returns DetailedGradeView
3386
- * @throws ApiError
3387
- */
3388
- static aiAnalyticsPerlearnerOrgsUsersCoursesGradingDetailRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3389
- courseId: string;
3390
- org: string; /**
3391
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3392
- */
3393
- departmentId?: number; /**
3394
- * end date. ISO 8601
3395
- */
3396
- endDate?: string; /**
3397
- * Format
3398
- *
3399
- * * `json` - json
3400
- */
3401
- format?: 'json'; /**
3402
- * Include main platform data
3403
- */
3404
- includeMainPlatform?: boolean; /**
3405
- * start date. ISO 8601
3406
- */
3407
- startDate?: string;
3408
- }): CancelablePromise<DetailedGradeView>;
3409
- /**
3410
- * Query Params
3411
- * 1. course_id e.g course-v1:Org+Course4+Run
3412
- * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
3413
- * @returns PerlearnerGradeSummary
3414
- * @throws ApiError
3415
- */
3416
- static aiAnalyticsPerlearnerOrgsUsersCoursesGradingSummaryRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3417
- courseId: string;
3418
- org: string; /**
3419
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3420
- */
3421
- departmentId?: number; /**
3422
- * end date. ISO 8601
3423
- */
3424
- endDate?: string; /**
3425
- * Format
3426
- *
3427
- * * `json` - json
3428
- */
3429
- format?: 'json'; /**
3430
- * Include main platform data
3431
- */
3432
- includeMainPlatform?: boolean; /**
3433
- * start date. ISO 8601
3434
- */
3435
- startDate?: string;
3436
- }): CancelablePromise<PerlearnerGradeSummary>;
3437
- /**
3438
- * Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days for a learner in a course
3439
- * @returns Value
3440
- * @throws ApiError
3441
- */
3442
- static aiAnalyticsPerlearnerOrgsUsersCoursesOverviewEngagementIndexRetrieve({ courseId, org, userId, }: {
3443
- courseId: string;
3444
- org: string;
3445
- }): CancelablePromise<Value>;
3446
- /**
3447
- * Provides about a learner current grade in a course with the course cut
3448
- * Kwargs
3449
- * 1. course_id e.g course-v1:Org+Course4+Run
3450
- * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
3451
- * @returns PerlearnerGradeWithCutOff
3452
- * @throws ApiError
3453
- */
3454
- static aiAnalyticsPerlearnerOrgsUsersCoursesOverviewGradeRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3455
- courseId: string;
3456
- org: string; /**
3457
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3458
- */
3459
- departmentId?: number; /**
3460
- * end date. ISO 8601
3461
- */
3462
- endDate?: string; /**
3463
- * Format
3464
- *
3465
- * * `json` - json
3466
- */
3467
- format?: 'json'; /**
3468
- * Include main platform data
3469
- */
3470
- includeMainPlatform?: boolean; /**
3471
- * start date. ISO 8601
3472
- */
3473
- startDate?: string;
3474
- }): CancelablePromise<PerlearnerGradeWithCutOff>;
3475
- /**
3476
- * Evaluates performance index for platform, per course, per user and per user-per course
3477
- *
3478
- * Query Params
3479
- * course_id <optional>
3480
- * learner_id <optional>
3481
- * @returns Value
3482
- * @throws ApiError
3483
- */
3484
- static aiAnalyticsPerlearnerOrgsUsersCoursesOverviewPerformanceIndexRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3485
- courseId: string;
3486
- org: string; /**
3487
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3488
- */
3489
- departmentId?: number; /**
3490
- * end date. ISO 8601
3491
- */
3492
- endDate?: string; /**
3493
- * Format
3494
- *
3495
- * * `json` - json
3496
- */
3497
- format?: 'json'; /**
3498
- * Include main platform data
3499
- */
3500
- includeMainPlatform?: boolean; /**
3501
- * start date. ISO 8601
3502
- */
3503
- startDate?: string;
3504
- }): CancelablePromise<Value>;
3505
- /**
3506
- * Time spent within a course in secs on a per-day basis
3507
- *
3508
- * Kwargs
3509
- * 1. course_id e.g course-v1:Org+Course4+Run
3510
- * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
3511
- * Query Params
3512
- * 3. start_date e.g 2020-10-01
3513
- * 4. end_date e.g 2020-10-10
3514
- *
3515
- * Default result when no query param is added is last_7_days (today inclusive)
3516
- * @returns OverTimeWithTotal
3517
- * @throws ApiError
3518
- */
3519
- static aiAnalyticsPerlearnerOrgsUsersCoursesOverviewTimeOverTimeRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3520
- courseId: string;
3521
- org: string; /**
3522
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3523
- */
3524
- departmentId?: number; /**
3525
- * end date. ISO 8601
3526
- */
3527
- endDate?: string; /**
3528
- * Format
3529
- *
3530
- * * `json` - json
3531
- */
3532
- format?: 'json'; /**
3533
- * Include main platform data
3534
- */
3535
- includeMainPlatform?: boolean; /**
3536
- * start date. ISO 8601
3537
- */
3538
- startDate?: string;
3539
- }): CancelablePromise<OverTimeWithTotal>;
3540
- /**
3541
- * List of videos within a course a learner has watched
3542
- *
3543
- * Kwargs
3544
- * 1. course_id e.g course-v1:Org+Course4+Run
3545
- * 2. user_id e.g developer@ibleducation.com or dev123 (username|email)
3546
- *
3547
- * Default result when no query param is added is [], 0
3548
- * @returns PerLearnerCourseVideosWatched
3549
- * @throws ApiError
3550
- */
3551
- static aiAnalyticsPerlearnerOrgsUsersCoursesVideosRetrieve({ courseId, org, userId, departmentId, format, includeMainPlatform, }: {
3552
- courseId: string;
3553
- org: string; /**
3554
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3555
- */
3556
- departmentId?: number; /**
3557
- * Format
3558
- *
3559
- * * `json` - json
3560
- */
3561
- format?: 'json'; /**
3562
- * Include main platform data
3563
- */
3564
- includeMainPlatform?: boolean;
3565
- }): CancelablePromise<PerLearnerCourseVideosWatched>;
3566
- /**
3567
- * Get video watch counts over time.
3568
- *
3569
- * This endpoint provides daily counts of videos watched over a specified time period,
3570
- * with options to filter by course or user.
3571
- *
3572
- * Query Parameters:
3573
- * start_date (str, optional): Start date for the time range (ISO format)
3574
- * end_date (str, optional): End date for the time range (ISO format)
3575
- * course_id (str, optional): Filter by course ID
3576
- * user_id (str, optional): Filter by username or email
3577
- *
3578
- * Returns:
3579
- * Daily video watch counts over the specified time period.
3580
- *
3581
- * Default time range is the last 7 days if no dates are specified.
3582
- *
3583
- * Access Control:
3584
- * - Platform admins can access any video watch data
3585
- * - Learners can access their own video watch data
3586
- * @returns OverTimeWithTotal
3587
- * @throws ApiError
3588
- */
3589
- static aiAnalyticsPerlearnerOrgsUsersCoursesVideosOverTimeRetrieve({ courseId, org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3590
- courseId: string;
3591
- org: string; /**
3592
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3593
- */
3594
- departmentId?: number; /**
3595
- * end date. ISO 8601
3596
- */
3597
- endDate?: string; /**
3598
- * Format
3599
- *
3600
- * * `json` - json
3601
- */
3602
- format?: 'json'; /**
3603
- * Include main platform data
3604
- */
3605
- includeMainPlatform?: boolean; /**
3606
- * start date. ISO 8601
3607
- */
3608
- startDate?: string;
3609
- }): CancelablePromise<OverTimeWithTotal>;
3610
- /**
3611
- * Summary Grading Information for a learner on a per-enrollment basis
3612
- *
3613
- * Query Params
3614
- * 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
3615
- * @returns PerlearnerGradingPerCourseAPI
3616
- * @throws ApiError
3617
- */
3618
- static aiAnalyticsPerlearnerOrgsUsersGradesPerCourseRetrieve({ org, userId, departmentId, format, includeMainPlatform, }: {
3619
- org: string; /**
3620
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3621
- */
3622
- departmentId?: number; /**
3623
- * Format
3624
- *
3625
- * * `json` - json
3626
- */
3627
- format?: 'json'; /**
3628
- * Include main platform data
3629
- */
3630
- includeMainPlatform?: boolean;
3631
- }): CancelablePromise<PerlearnerGradingPerCourseAPI>;
3632
- /**
3633
- * Retrieve detailed information about a specific learner.
3634
- *
3635
- * This endpoint returns personal and activity information about a learner,
3636
- * including profile data, activity metrics, and location information.
3637
- *
3638
- * Path Parameters:
3639
- * user_id (str): The username or email of the learner
3640
- *
3641
- * Query Parameters:
3642
- * meta (bool): Include additional analytics information when true
3643
- *
3644
- * Returns:
3645
- * Detailed learner information including:
3646
- * - Profile data (username, name, email)
3647
- * - Registration and activity dates
3648
- * - Activity metrics (assessments, time spent, videos watched)
3649
- * - Location and browser information (when available)
3650
- *
3651
- * Access Control:
3652
- * - Platform admins can access any learner
3653
- * - Learners can access their own information
3654
- * - Department admins can access learners in their departments
3655
- * @returns LearnerInformationAPI
3656
- * @throws ApiError
3657
- */
3658
- static aiAnalyticsPerlearnerOrgsUsersInfoRetrieve({ org, userId, departmentId, format, includeMainPlatform, meta, search, }: {
3659
- org: string; /**
3660
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3661
- */
3662
- departmentId?: number; /**
3663
- * Format
3664
- *
3665
- * * `json` - json
3666
- */
3667
- format?: 'json'; /**
3668
- * Include main platform data
3669
- */
3670
- includeMainPlatform?: boolean; /**
3671
- * Include extra analytics information?
3672
- *
3673
- * * `y` - y
3674
- * * `yes` - yes
3675
- * * `true` - true
3676
- * * `True` - True
3677
- * * `n` - n
3678
- * * `no` - no
3679
- * * `false` - false
3680
- * * `False` - False
3681
- */
3682
- meta?: 'y' | 'yes' | 'true' | 'True' | 'n' | 'no' | 'false' | 'False';
3683
- search?: string;
3684
- }): CancelablePromise<LearnerInformationAPI>;
3685
- /**
3686
- * Last course accessed by a learner, includes upto unit information as well
3687
- * @returns PerLearnerLastAccess
3688
- * @throws ApiError
3689
- */
3690
- static aiAnalyticsPerlearnerOrgsUsersLastAccessRetrieve({ org, userId, departmentId, format, includeMainPlatform, }: {
3691
- org: string; /**
3692
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3693
- */
3694
- departmentId?: number; /**
3695
- * Format
3696
- *
3697
- * * `json` - json
3698
- */
3699
- format?: 'json'; /**
3700
- * Include main platform data
3701
- */
3702
- includeMainPlatform?: boolean;
3703
- }): CancelablePromise<PerLearnerLastAccess>;
3704
- /**
3705
- * Average of days with atleast an activity within ENGAGEMENT_INDEX_PERIOD consecutive days
3706
- * @returns Value
3707
- * @throws ApiError
3708
- */
3709
- static aiAnalyticsPerlearnerOrgsUsersOverviewEngagementIndexRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3710
- org: string; /**
3711
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3712
- */
3713
- departmentId?: number; /**
3714
- * end date. ISO 8601
3715
- */
3716
- endDate?: string; /**
3717
- * Format
3718
- *
3719
- * * `json` - json
3720
- */
3721
- format?: 'json'; /**
3722
- * Include main platform data
3723
- */
3724
- includeMainPlatform?: boolean; /**
3725
- * start date. ISO 8601
3726
- */
3727
- startDate?: string;
3728
- }): CancelablePromise<Value>;
3729
- /**
3730
- * Get average grade value for platform, course, or user.
3731
- *
3732
- * This endpoint returns the average grade at different levels:
3733
- * - Platform level: Average grade across all courses
3734
- * - Course level: Average grade for a specific course
3735
- * - Learner level: Average grade for a specific learner
3736
- * - Course-learner level: Grade for a specific learner in a specific course
3737
- *
3738
- * Query Parameters:
3739
- * course_id (str, optional): Filter by course ID
3740
- * learner_id (str, optional): Filter by username or email
3741
- *
3742
- * Returns:
3743
- * The average grade value based on the specified filters.
3744
- *
3745
- * Access Control:
3746
- * - Platform admins can access any grade data
3747
- * - Learners can access their own grade data
3748
- * @returns Average
3749
- * @throws ApiError
3750
- */
3751
- static aiAnalyticsPerlearnerOrgsUsersOverviewGradesAverageRetrieve({ org, userId, departmentId, format, includeMainPlatform, }: {
3752
- org: string; /**
3753
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3754
- */
3755
- departmentId?: number; /**
3756
- * Format
3757
- *
3758
- * * `json` - json
3759
- */
3760
- format?: 'json'; /**
3761
- * Include main platform data
3762
- */
3763
- includeMainPlatform?: boolean;
3764
- }): CancelablePromise<Average>;
3765
- /**
3766
- * Evaluates performance index for platform, per course, per user and per user-per course
3767
- *
3768
- * Query Params
3769
- * course_id <optional>
3770
- * learner_id <optional>
3771
- * @returns Value
3772
- * @throws ApiError
3773
- */
3774
- static aiAnalyticsPerlearnerOrgsUsersOverviewPerformanceIndexRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3775
- org: string; /**
3776
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3777
- */
3778
- departmentId?: number; /**
3779
- * end date. ISO 8601
3780
- */
3781
- endDate?: string; /**
3782
- * Format
3783
- *
3784
- * * `json` - json
3785
- */
3786
- format?: 'json'; /**
3787
- * Include main platform data
3788
- */
3789
- includeMainPlatform?: boolean; /**
3790
- * start date. ISO 8601
3791
- */
3792
- startDate?: string;
3793
- }): CancelablePromise<Value>;
3794
- /**
3795
- * Time spent in secs on a per-day basis
3796
- *
3797
- * Query Params
3798
- * 1. course_id <optional> e.g course-v1:Org+Course4+Run
3799
- * 2. user_id <optional> e.g developer@ibleducation.com or dev123 (username|email)
3800
- * 3. start_date e.g 2020-10-01
3801
- * 4. end_date e.g 2020-10-10
3802
- *
3803
- * Default result when no query param is added is last_7_days (today inclusive)
3804
- * @returns OverTimeWithTotal
3805
- * @throws ApiError
3806
- */
3807
- static aiAnalyticsPerlearnerOrgsUsersOverviewTimeOverTimeRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3808
- org: string; /**
3809
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3810
- */
3811
- departmentId?: number; /**
3812
- * end date. ISO 8601
3813
- */
3814
- endDate?: string; /**
3815
- * Format
3816
- *
3817
- * * `json` - json
3818
- */
3819
- format?: 'json'; /**
3820
- * Include main platform data
3821
- */
3822
- includeMainPlatform?: boolean; /**
3823
- * start date. ISO 8601
3824
- */
3825
- startDate?: string;
3826
- }): CancelablePromise<OverTimeWithTotal>;
3827
- /**
3828
- * Get video watch counts over time.
3829
- *
3830
- * This endpoint provides daily counts of videos watched over a specified time period,
3831
- * with options to filter by course or user.
3832
- *
3833
- * Query Parameters:
3834
- * start_date (str, optional): Start date for the time range (ISO format)
3835
- * end_date (str, optional): End date for the time range (ISO format)
3836
- * course_id (str, optional): Filter by course ID
3837
- * user_id (str, optional): Filter by username or email
3838
- *
3839
- * Returns:
3840
- * Daily video watch counts over the specified time period.
3841
- *
3842
- * Default time range is the last 7 days if no dates are specified.
3843
- *
3844
- * Access Control:
3845
- * - Platform admins can access any video watch data
3846
- * - Learners can access their own video watch data
3847
- * @returns OverTimeWithTotal
3848
- * @throws ApiError
3849
- */
3850
- static aiAnalyticsPerlearnerOrgsUsersVideosOverTimeRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3851
- org: string; /**
3852
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3853
- */
3854
- departmentId?: number; /**
3855
- * end date. ISO 8601
3856
- */
3857
- endDate?: string; /**
3858
- * Format
3859
- *
3860
- * * `json` - json
3861
- */
3862
- format?: 'json'; /**
3863
- * Include main platform data
3864
- */
3865
- includeMainPlatform?: boolean; /**
3866
- * start date. ISO 8601
3867
- */
3868
- startDate?: string;
3869
- }): CancelablePromise<OverTimeWithTotal>;
3870
- /**
3871
- * Summary Videos watched data for a learner per enrollment
3872
- *
3873
- * Query Params
3874
- * 1. user_id e.g developer@ibleducation.com or dev123 (username|email)
3875
- * @returns PerlearnerEngagementVideosWatchedPerCourse
3876
- * @throws ApiError
3877
- */
3878
- static aiAnalyticsPerlearnerOrgsUsersVideosPerCourseRetrieve({ org, userId, departmentId, endDate, format, includeMainPlatform, startDate, }: {
3879
- org: string; /**
3880
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3881
- */
3882
- departmentId?: number; /**
3883
- * end date. ISO 8601
3884
- */
3885
- endDate?: string; /**
3886
- * Format
3887
- *
3888
- * * `json` - json
3889
- */
3890
- format?: 'json'; /**
3891
- * Include main platform data
3892
- */
3893
- includeMainPlatform?: boolean; /**
3894
- * start date. ISO 8601
3895
- */
3896
- startDate?: string;
3897
- }): CancelablePromise<PerlearnerEngagementVideosWatchedPerCourse>;
3898
- /**
3899
- * Get a list of user groups with metrics and filtering options.
3900
- *
3901
- * This endpoint provides a paginated list of user groups with aggregated metrics
3902
- * about learner performance, course completions, and skill acquisition.
3903
- *
3904
- * This endpoint uses DM token authentication and respects department-based
3905
- * access controls.
3906
- *
3907
- * Query Parameters:
3908
- * page (int, optional): Page number for pagination
3909
- * length (int, optional): Number of items per page
3910
- * program (str, optional): Filter by program
3911
- * pathway (str, optional): Filter by pathway
3912
- * groups (list, optional): Filter by group names
3913
- * location (str, optional): Filter by location
3914
- * is_enrolled (bool, optional): Filter for groups with enrolled users
3915
- * start_date (date, optional): Filter by learner join date (start range)
3916
- * end_date (date, optional): Filter by learner join date (end range)
3917
- *
3918
- * Returns:
3919
- * A paginated list of user groups with comprehensive metrics.
3920
- *
3921
- * Access Control:
3922
- * - Platform admins can see all groups
3923
- * - Department admins can only see groups in their departments
3924
- * @returns GroupList
3925
- * @throws ApiError
3926
- */
3927
- static aiAnalyticsUserGroupsOrgsRetrieve({ org, departmentId, endDate, format, groups, includeMainPlatform, isEnrolled, length, location, page, pathway, program, startDate, }: {
3928
- org: string;
3929
- /**
3930
- * When `department_mode=1` is passed, it allows to filter data for only user content groups for the specified department
3931
- */
3932
- departmentId?: number;
3933
- /**
3934
- * Filter by learners date_joined. Start date. ISO 8601
3935
- */
3936
- endDate?: string;
3937
- /**
3938
- * Format
3939
- *
3940
- * * `json` - json
3941
- */
3942
- format?: 'json';
3943
- /**
3944
- * Groups search string. Single string or list of strings. e.g 'sample_group' or `['group', 'another group']`
3945
- */
3946
- groups?: Array<string>;
3947
- /**
3948
- * Include main platform data
3949
- */
3950
- includeMainPlatform?: boolean;
3951
- /**
3952
- * Filter for users who have at least an enrollment
3953
- */
3954
- isEnrolled?: boolean | null;
3955
- /**
3956
- * Size of data to return
3957
- */
3958
- length?: number;
3959
- /**
3960
- * Location search string
3961
- */
3962
- location?: string;
3963
- /**
3964
- * Page offset
3965
- */
3966
- page?: number;
3967
- /**
3968
- * Pathway string
3969
- */
3970
- pathway?: string;
3971
- /**
3972
- * Program search string
3973
- */
3974
- program?: string;
3975
- /**
3976
- * Filter by learners date_joined. Start date. ISO 8601
3977
- */
3978
- startDate?: string;
3979
- }): CancelablePromise<GroupList>;
3980
46
  /**
3981
47
  * Update time spent tracking data from client-side events.
3982
48
  *