@iblai/iblai-api 3.45.10-core → 3.45.11-ai

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 (568) hide show
  1. package/dist/index.cjs.js +15047 -124
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +15041 -125
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +15047 -124
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/index.d.ts +277 -1
  8. package/dist/types/models/AIGeneratedImage.d.ts +13 -0
  9. package/dist/types/models/AIUserProfileMemoryRelation.d.ts +4 -0
  10. package/dist/types/models/AIUserProfileRequest.d.ts +4 -0
  11. package/dist/types/models/APITokenCost.d.ts +14 -0
  12. package/dist/types/models/AccessEnum.d.ts +8 -0
  13. package/dist/types/models/AlignMentorBubbleEnum.d.ts +8 -0
  14. package/dist/types/models/AnalyticsOverview.d.ts +7 -0
  15. package/dist/types/models/Answer.d.ts +11 -0
  16. package/dist/types/models/AssumedKnowledge.d.ts +4 -0
  17. package/dist/types/models/AssumedKnowledgeLevel.d.ts +4 -0
  18. package/dist/types/models/AudioToTextRequest.d.ts +3 -0
  19. package/dist/types/models/AudioToTextResponse.d.ts +3 -0
  20. package/dist/types/models/CallAuthenticationRequest.d.ts +13 -0
  21. package/dist/types/models/CallAuthenticationResponse.d.ts +21 -0
  22. package/dist/types/models/ChatHistory.d.ts +8 -0
  23. package/dist/types/models/ChatHistoryFilterData.d.ts +9 -0
  24. package/dist/types/models/ChatHistoryFilterUser.d.ts +5 -0
  25. package/dist/types/models/ChatHistoryItem.d.ts +5 -0
  26. package/dist/types/models/ChatHistorySessionId.d.ts +3 -0
  27. package/dist/types/models/ChatSessionRequest.d.ts +10 -0
  28. package/dist/types/models/ChatSessionResponse.d.ts +5 -0
  29. package/dist/types/models/CheckDocumentTrainingStatus.d.ts +10 -0
  30. package/dist/types/models/ComponentBlock.d.ts +9 -0
  31. package/dist/types/models/ComponentBlockTypeEnum.d.ts +8 -0
  32. package/dist/types/models/ConversationMessage.d.ts +11 -0
  33. package/dist/types/models/ConversationRating.d.ts +6 -0
  34. package/dist/types/models/ConversationSummary.d.ts +5 -0
  35. package/dist/types/models/ConversationVolume.d.ts +4 -0
  36. package/dist/types/models/Conversations.d.ts +28 -0
  37. package/dist/types/models/Cost.d.ts +3 -0
  38. package/dist/types/models/CostPerTenant.d.ts +6 -0
  39. package/dist/types/models/CourseCreationTask.d.ts +31 -0
  40. package/dist/types/models/CourseCreationTaskFile.d.ts +7 -0
  41. package/dist/types/models/CourseCreationTaskStatusEnum.d.ts +16 -0
  42. package/dist/types/models/CredentialRequest.d.ts +14 -0
  43. package/dist/types/models/CrontabSchedule.d.ts +22 -0
  44. package/dist/types/models/CustomInstructionResponse.d.ts +13 -0
  45. package/dist/types/models/DateRange.d.ts +4 -0
  46. package/dist/types/models/Document.d.ts +41 -0
  47. package/dist/types/models/DocumentFacet.d.ts +17 -0
  48. package/dist/types/models/DocumentSearchResponse.d.ts +35 -0
  49. package/dist/types/models/DocumentSettingsResponse.d.ts +3 -0
  50. package/dist/types/models/EdxCourse.d.ts +11 -0
  51. package/dist/types/models/ElevenlabsCustomVoice.d.ts +4 -0
  52. package/dist/types/models/ElevenlabsCustomVoiceResponse.d.ts +8 -0
  53. package/dist/types/models/EmailPromptDetail.d.ts +13 -0
  54. package/dist/types/models/EmailPromptList.d.ts +11 -0
  55. package/dist/types/models/EmailPromptSummary.d.ts +5 -0
  56. package/dist/types/models/FreeUsageCount.d.ts +3 -0
  57. package/dist/types/models/FullCourse.d.ts +13 -0
  58. package/dist/types/models/GreetingMethodEnum.d.ts +8 -0
  59. package/dist/types/models/GuidedPromptsResponse.d.ts +3 -0
  60. package/dist/types/models/HeygenMarketingVideoDetail.d.ts +8 -0
  61. package/dist/types/models/HeygenMarketingVideoList.d.ts +6 -0
  62. package/dist/types/models/HeygenTemplateRequest.d.ts +5 -0
  63. package/dist/types/models/HeygenTemplateResponseSingle.d.ts +6 -0
  64. package/dist/types/models/HeygenVideoDetail.d.ts +8 -0
  65. package/dist/types/models/HeygenVideoRequest.d.ts +5 -0
  66. package/dist/types/models/IBLAIPlatformMeta.d.ts +3 -0
  67. package/dist/types/models/IBLAIPlatformMetaRequest.d.ts +6 -0
  68. package/dist/types/models/IBLAIPlatformMetaUpdateRequest.d.ts +10 -0
  69. package/dist/types/models/InputQuestion.d.ts +6 -0
  70. package/dist/types/models/IntegrationCredential.d.ts +8 -0
  71. package/dist/types/models/IntialQuestionAnswer.d.ts +3 -0
  72. package/dist/types/models/JobRun.d.ts +11 -0
  73. package/dist/types/models/KindEnum.d.ts +10 -0
  74. package/dist/types/models/LLMCredentialRequest.d.ts +14 -0
  75. package/dist/types/models/LLMCredentialResponse.d.ts +8 -0
  76. package/dist/types/models/LLMModelForTenant.d.ts +6 -0
  77. package/dist/types/models/LLMQuestion.d.ts +15 -0
  78. package/dist/types/models/LLMResponse.d.ts +14 -0
  79. package/dist/types/models/LLMTracesListResponse.d.ts +5 -0
  80. package/dist/types/models/LanguagesView.d.ts +5 -0
  81. package/dist/types/models/LinkCourseRequest.d.ts +3 -0
  82. package/dist/types/models/LinkCourseResponse.d.ts +5 -0
  83. package/dist/types/models/MCPServer.d.ts +21 -0
  84. package/dist/types/models/MemoryComponentData.d.ts +5 -0
  85. package/dist/types/models/MemoryComponentMemory.d.ts +4 -0
  86. package/dist/types/models/MemoryComponentMemoryDetail.d.ts +8 -0
  87. package/dist/types/models/MemoryComponentResponse.d.ts +5 -0
  88. package/dist/types/models/MemoryProgress.d.ts +8 -0
  89. package/dist/types/models/MemoryStatusRequestView.d.ts +6 -0
  90. package/dist/types/models/MemoryStatusView.d.ts +6 -0
  91. package/dist/types/models/Mentor.d.ts +80 -0
  92. package/dist/types/models/MentorAudience.d.ts +5 -0
  93. package/dist/types/models/MentorCategory.d.ts +9 -0
  94. package/dist/types/models/MentorCategoryCreate.d.ts +11 -0
  95. package/dist/types/models/MentorCategoryGroup.d.ts +11 -0
  96. package/dist/types/models/MentorCategoryGroupCreate.d.ts +11 -0
  97. package/dist/types/models/MentorCreate.d.ts +79 -0
  98. package/dist/types/models/MentorCustomVoice.d.ts +4 -0
  99. package/dist/types/models/MentorCustomVoiceResponse.d.ts +4 -0
  100. package/dist/types/models/MentorData.d.ts +7 -0
  101. package/dist/types/models/MentorDetailAnalytics.d.ts +6 -0
  102. package/dist/types/models/MentorEval.d.ts +11 -0
  103. package/dist/types/models/MentorEvalQuestion.d.ts +5 -0
  104. package/dist/types/models/MentorEvalQuestionRequest.d.ts +4 -0
  105. package/dist/types/models/MentorEvalReport.d.ts +10 -0
  106. package/dist/types/models/MentorEvalRequest.d.ts +8 -0
  107. package/dist/types/models/MentorFacet.d.ts +17 -0
  108. package/dist/types/models/MentorFork.d.ts +5 -0
  109. package/dist/types/models/MentorFromTemplateRequest.d.ts +4 -0
  110. package/dist/types/models/MentorFromTemplateWithSettingRequest.d.ts +45 -0
  111. package/dist/types/models/MentorMemorySettingsRequest.d.ts +6 -0
  112. package/dist/types/models/MentorMemorySettingsResponse.d.ts +6 -0
  113. package/dist/types/models/MentorMetadata.d.ts +5 -0
  114. package/dist/types/models/MentorScenario.d.ts +6 -0
  115. package/dist/types/models/MentorScenarioPrompt.d.ts +5 -0
  116. package/dist/types/models/MentorSearchResponse.d.ts +35 -0
  117. package/dist/types/models/MentorSession.d.ts +4 -0
  118. package/dist/types/models/MentorSettings.d.ts +56 -0
  119. package/dist/types/models/MentorSettingsPublic.d.ts +45 -0
  120. package/dist/types/models/MentorSettingsRequest.d.ts +60 -0
  121. package/dist/types/models/MentorVisibilityEnum.d.ts +10 -0
  122. package/dist/types/models/MentorWizard.d.ts +4 -0
  123. package/dist/types/models/MessageStatistics.d.ts +5 -0
  124. package/dist/types/models/MessageView.d.ts +10 -0
  125. package/dist/types/models/MessageViewRequest.d.ts +7 -0
  126. package/dist/types/models/MessageViewUpdatResponse.d.ts +3 -0
  127. package/dist/types/models/Metadata.d.ts +5 -0
  128. package/dist/types/models/MetricChange.d.ts +4 -0
  129. package/dist/types/models/ModelCost.d.ts +4 -0
  130. package/dist/types/models/ModerationLog.d.ts +11 -0
  131. package/dist/types/models/NoChatMessagesFound.d.ts +3 -0
  132. package/dist/types/models/NotificationSource.d.ts +2 -2
  133. package/dist/types/models/{TypeEnum.d.ts → NotificationSourceTypeEnum.d.ts} +1 -1
  134. package/dist/types/models/NullEnum.d.ts +1 -0
  135. package/dist/types/models/PageContent.d.ts +6 -0
  136. package/dist/types/models/PaginatedAIGeneratedImageList.d.ts +7 -0
  137. package/dist/types/models/PaginatedConversationsList.d.ts +7 -0
  138. package/dist/types/models/PaginatedCourseCreationTaskFileList.d.ts +7 -0
  139. package/dist/types/models/PaginatedCourseCreationTaskList.d.ts +7 -0
  140. package/dist/types/models/PaginatedEdxCourseList.d.ts +7 -0
  141. package/dist/types/models/PaginatedEmailPromptListList.d.ts +7 -0
  142. package/dist/types/models/PaginatedHeygenMarketingVideoListList.d.ts +7 -0
  143. package/dist/types/models/PaginatedHeygenTemplateResponseSingleList.d.ts +7 -0
  144. package/dist/types/models/PaginatedJobRunList.d.ts +7 -0
  145. package/dist/types/models/PaginatedMCPServerList.d.ts +7 -0
  146. package/dist/types/models/PaginatedMentorList.d.ts +7 -0
  147. package/dist/types/models/PaginatedModerationLogList.d.ts +7 -0
  148. package/dist/types/models/PaginatedPeriodicAgentList.d.ts +7 -0
  149. package/dist/types/models/PaginatedPeriodicAgentLogList.d.ts +7 -0
  150. package/dist/types/models/PaginatedPlayWrightScriptList.d.ts +7 -0
  151. package/dist/types/models/PaginatedSectionList.d.ts +7 -0
  152. package/dist/types/models/PaginatedSubSectionList.d.ts +7 -0
  153. package/dist/types/models/PaginatedTopicStatisticsResponse.d.ts +7 -0
  154. package/dist/types/models/PaginatedUnitList.d.ts +7 -0
  155. package/dist/types/models/PaginatedUserEdxMemoryList.d.ts +7 -0
  156. package/dist/types/models/PaginatedVoiceList.d.ts +7 -0
  157. package/dist/types/models/PatchedConversations.d.ts +28 -0
  158. package/dist/types/models/PatchedCourseCreationTaskFile.d.ts +7 -0
  159. package/dist/types/models/PatchedCredentialRequest.d.ts +14 -0
  160. package/dist/types/models/PatchedLLMCredentialRequest.d.ts +14 -0
  161. package/dist/types/models/PatchedMCPServer.d.ts +21 -0
  162. package/dist/types/models/PatchedMentorCategoryGroupCreate.d.ts +11 -0
  163. package/dist/types/models/PatchedMentorCreate.d.ts +79 -0
  164. package/dist/types/models/PatchedPeriodicAgentCreate.d.ts +41 -0
  165. package/dist/types/models/PatchedPlayWrightScript.d.ts +12 -0
  166. package/dist/types/models/PatchedPrompt.d.ts +22 -0
  167. package/dist/types/models/PatchedSection.d.ts +9 -0
  168. package/dist/types/models/PatchedSubSection.d.ts +9 -0
  169. package/dist/types/models/PatchedUnit.d.ts +11 -0
  170. package/dist/types/models/PeriodicAgent.d.ts +42 -0
  171. package/dist/types/models/PeriodicAgentCreate.d.ts +41 -0
  172. package/dist/types/models/PeriodicAgentLog.d.ts +11 -0
  173. package/dist/types/models/PeriodicAgentLogStatusEnum.d.ts +10 -0
  174. package/dist/types/models/PeriodicTask.d.ts +21 -0
  175. package/dist/types/models/PieChartData.d.ts +5 -0
  176. package/dist/types/models/PieChartSegment.d.ts +4 -0
  177. package/dist/types/models/PinnedMessageCreate.d.ts +9 -0
  178. package/dist/types/models/PinnedMessageGet.d.ts +7 -0
  179. package/dist/types/models/PinnedMessageRequest.d.ts +6 -0
  180. package/dist/types/models/PlayWrightScript.d.ts +12 -0
  181. package/dist/types/models/PredictiveAnalyticsRequest.d.ts +4 -0
  182. package/dist/types/models/PredictiveAnalyticsResponse.d.ts +4 -0
  183. package/dist/types/models/PreviousAgentStatusEnum.d.ts +12 -0
  184. package/dist/types/models/Prompt.d.ts +22 -0
  185. package/dist/types/models/PromptCategory.d.ts +7 -0
  186. package/dist/types/models/PromptVisibilityEnum.d.ts +10 -0
  187. package/dist/types/models/ProviderEnum.d.ts +10 -0
  188. package/dist/types/models/QuestionCardTag.d.ts +8 -0
  189. package/dist/types/models/QuestionRequest.d.ts +15 -0
  190. package/dist/types/models/QuestionResponse.d.ts +10 -0
  191. package/dist/types/models/RatingEnum.d.ts +8 -0
  192. package/dist/types/models/RatingRecord.d.ts +4 -0
  193. package/dist/types/models/RecentlyAccessedMentor.d.ts +8 -0
  194. package/dist/types/models/RecommendCourseBlock.d.ts +3 -0
  195. package/dist/types/models/RecommendCourseResponse.d.ts +3 -0
  196. package/dist/types/models/RelatedText.d.ts +3 -0
  197. package/dist/types/models/RequestDataVariable.d.ts +14 -0
  198. package/dist/types/models/ResourceScrappedData.d.ts +13 -0
  199. package/dist/types/models/ResourceScrappedDataStatusEnum.d.ts +12 -0
  200. package/dist/types/models/ResponseDataVariable.d.ts +14 -0
  201. package/dist/types/models/RetreiverTrainViewRequest.d.ts +10 -0
  202. package/dist/types/models/RetreiverTrainViewResponse.d.ts +6 -0
  203. package/dist/types/models/RetrieveTask.d.ts +3 -0
  204. package/dist/types/models/RetrieverDocumentEmbedding.d.ts +17 -0
  205. package/dist/types/models/RetrieverDocumentEmbeddingRequest.d.ts +30 -0
  206. package/dist/types/models/RetrieverRequestSearch.d.ts +10 -0
  207. package/dist/types/models/RetrieverRequestSearchDocument.d.ts +10 -0
  208. package/dist/types/models/RetrieverResponseSearch.d.ts +7 -0
  209. package/dist/types/models/ReuestDataVariableList.d.ts +4 -0
  210. package/dist/types/models/RunMentorEval.d.ts +3 -0
  211. package/dist/types/models/ScanWebhookRequest.d.ts +6 -0
  212. package/dist/types/models/ScanWebhookResponse.d.ts +3 -0
  213. package/dist/types/models/Section.d.ts +9 -0
  214. package/dist/types/models/SectionWithChildren.d.ts +11 -0
  215. package/dist/types/models/SeedMentorsView.d.ts +3 -0
  216. package/dist/types/models/SentimentSummary.d.ts +4 -0
  217. package/dist/types/models/SessionBrowserScreenshot.d.ts +8 -0
  218. package/dist/types/models/SessionDetail.d.ts +6 -0
  219. package/dist/types/models/SessionMemoryStorage.d.ts +6 -0
  220. package/dist/types/models/ShellLogs.d.ts +3 -0
  221. package/dist/types/models/SpacedRepetitionLearningPath.d.ts +3 -0
  222. package/dist/types/models/SpacedRepetitionQuestionStats.d.ts +5 -0
  223. package/dist/types/models/StarMentor.d.ts +7 -0
  224. package/dist/types/models/Status6eeEnum.d.ts +12 -0
  225. package/dist/types/models/Step.d.ts +9 -0
  226. package/dist/types/models/StepStatusEnum.d.ts +10 -0
  227. package/dist/types/models/StudentChatMessage.d.ts +4 -0
  228. package/dist/types/models/StylesView.d.ts +4 -0
  229. package/dist/types/models/SubSection.d.ts +9 -0
  230. package/dist/types/models/SubSectionWithChildren.d.ts +11 -0
  231. package/dist/types/models/TagsView.d.ts +5 -0
  232. package/dist/types/models/TargetSystemEnum.d.ts +8 -0
  233. package/dist/types/models/TaskView.d.ts +3 -0
  234. package/dist/types/models/TemplateMentor.d.ts +9 -0
  235. package/dist/types/models/TenantMentorTraces.d.ts +6 -0
  236. package/dist/types/models/ThemeEnum.d.ts +8 -0
  237. package/dist/types/models/TonesView.d.ts +4 -0
  238. package/dist/types/models/ToolResponse.d.ts +11 -0
  239. package/dist/types/models/TopicModel.d.ts +3 -0
  240. package/dist/types/models/TopicRecord.d.ts +4 -0
  241. package/dist/types/models/TopicStatistics.d.ts +7 -0
  242. package/dist/types/models/TopicStatisticsResponse.d.ts +6 -0
  243. package/dist/types/models/TopicSummaryView.d.ts +4 -0
  244. package/dist/types/models/TrainChatSessionDocumentView.d.ts +6 -0
  245. package/dist/types/models/TrainChatSessionDocumentViewRequest.d.ts +6 -0
  246. package/dist/types/models/TrainDocumentViewRequest.d.ts +42 -0
  247. package/dist/types/models/TrainDocumentViewResponse.d.ts +15 -0
  248. package/dist/types/models/TrainingStatusEnum.d.ts +12 -0
  249. package/dist/types/models/TransportEnum.d.ts +8 -0
  250. package/dist/types/models/TrendEntry.d.ts +4 -0
  251. package/dist/types/models/TriggerRequest.d.ts +5 -0
  252. package/dist/types/models/TriggerResponse.d.ts +6 -0
  253. package/dist/types/models/TypeC42Enum.d.ts +8 -0
  254. package/dist/types/models/Unit.d.ts +11 -0
  255. package/dist/types/models/UnitWithChildren.d.ts +13 -0
  256. package/dist/types/models/UseMainCreds.d.ts +3 -0
  257. package/dist/types/models/UserAllChatMemoryView.d.ts +7 -0
  258. package/dist/types/models/UserCatalogItemMemoryView.d.ts +14 -0
  259. package/dist/types/models/UserChatByPeriod.d.ts +4 -0
  260. package/dist/types/models/UserChatFeedback.d.ts +14 -0
  261. package/dist/types/models/UserChatFeedbackCount.d.ts +4 -0
  262. package/dist/types/models/UserChatMemoryStatusRequestView.d.ts +6 -0
  263. package/dist/types/models/UserChatMemoryStatusView.d.ts +6 -0
  264. package/dist/types/models/UserChatMemoryUpdateView.d.ts +10 -0
  265. package/dist/types/models/UserCountRecord.d.ts +4 -0
  266. package/dist/types/models/UserEdxMemory.d.ts +15 -0
  267. package/dist/types/models/UserMemoryContextRequest.d.ts +13 -0
  268. package/dist/types/models/UserMemoryContextResponse.d.ts +12 -0
  269. package/dist/types/models/UserMetric.d.ts +4 -0
  270. package/dist/types/models/UserMetricsResponse.d.ts +7 -0
  271. package/dist/types/models/UserSentimentCountView.d.ts +4 -0
  272. package/dist/types/models/UserTrendByPeriod.d.ts +5 -0
  273. package/dist/types/models/VectorResult.d.ts +8 -0
  274. package/dist/types/models/VideoCaption.d.ts +3 -0
  275. package/dist/types/models/Voice.d.ts +9 -0
  276. package/dist/types/models/WebResource.d.ts +9 -0
  277. package/dist/types/models/WebResourceCard.d.ts +7 -0
  278. package/dist/types/models/WebResourcesQuery.d.ts +3 -0
  279. package/dist/types/services/AiAccountService.d.ts +294 -0
  280. package/dist/types/services/AiAnalyticsService.d.ts +2801 -0
  281. package/dist/types/services/AiIndexService.d.ts +380 -0
  282. package/dist/types/services/AiMarketingService.d.ts +34 -0
  283. package/dist/types/services/AiMediaService.d.ts +118 -0
  284. package/dist/types/services/AiMentorService.d.ts +4235 -0
  285. package/dist/types/services/AiPromptService.d.ts +920 -0
  286. package/dist/types/services/SearchService.d.ts +404 -0
  287. package/package.json +1 -1
  288. package/src/core/OpenAPI.ts +1 -1
  289. package/src/index.ts +277 -1
  290. package/src/models/AIGeneratedImage.ts +18 -0
  291. package/src/models/AIUserProfileMemoryRelation.ts +9 -0
  292. package/src/models/AIUserProfileRequest.ts +9 -0
  293. package/src/models/APITokenCost.ts +19 -0
  294. package/src/models/AccessEnum.ts +12 -0
  295. package/src/models/AlignMentorBubbleEnum.ts +12 -0
  296. package/src/models/AnalyticsOverview.ts +12 -0
  297. package/src/models/Answer.ts +16 -0
  298. package/src/models/AssumedKnowledge.ts +9 -0
  299. package/src/models/AssumedKnowledgeLevel.ts +9 -0
  300. package/src/models/AudioToTextRequest.ts +8 -0
  301. package/src/models/AudioToTextResponse.ts +8 -0
  302. package/src/models/CallAuthenticationRequest.ts +18 -0
  303. package/src/models/CallAuthenticationResponse.ts +26 -0
  304. package/src/models/ChatHistory.ts +13 -0
  305. package/src/models/ChatHistoryFilterData.ts +14 -0
  306. package/src/models/ChatHistoryFilterUser.ts +10 -0
  307. package/src/models/ChatHistoryItem.ts +10 -0
  308. package/src/models/ChatHistorySessionId.ts +8 -0
  309. package/src/models/ChatSessionRequest.ts +15 -0
  310. package/src/models/ChatSessionResponse.ts +10 -0
  311. package/src/models/CheckDocumentTrainingStatus.ts +15 -0
  312. package/src/models/ComponentBlock.ts +14 -0
  313. package/src/models/ComponentBlockTypeEnum.ts +12 -0
  314. package/src/models/ConversationMessage.ts +16 -0
  315. package/src/models/ConversationRating.ts +11 -0
  316. package/src/models/ConversationSummary.ts +10 -0
  317. package/src/models/ConversationVolume.ts +9 -0
  318. package/src/models/Conversations.ts +33 -0
  319. package/src/models/Cost.ts +8 -0
  320. package/src/models/CostPerTenant.ts +11 -0
  321. package/src/models/CourseCreationTask.ts +36 -0
  322. package/src/models/CourseCreationTaskFile.ts +12 -0
  323. package/src/models/CourseCreationTaskStatusEnum.ts +20 -0
  324. package/src/models/CredentialRequest.ts +19 -0
  325. package/src/models/CrontabSchedule.ts +27 -0
  326. package/src/models/CustomInstructionResponse.ts +18 -0
  327. package/src/models/DateRange.ts +9 -0
  328. package/src/models/Document.ts +46 -0
  329. package/src/models/DocumentFacet.ts +22 -0
  330. package/src/models/DocumentSearchResponse.ts +40 -0
  331. package/src/models/DocumentSettingsResponse.ts +8 -0
  332. package/src/models/EdxCourse.ts +16 -0
  333. package/src/models/ElevenlabsCustomVoice.ts +9 -0
  334. package/src/models/ElevenlabsCustomVoiceResponse.ts +13 -0
  335. package/src/models/EmailPromptDetail.ts +18 -0
  336. package/src/models/EmailPromptList.ts +16 -0
  337. package/src/models/EmailPromptSummary.ts +10 -0
  338. package/src/models/FreeUsageCount.ts +8 -0
  339. package/src/models/FullCourse.ts +18 -0
  340. package/src/models/GreetingMethodEnum.ts +12 -0
  341. package/src/models/GuidedPromptsResponse.ts +8 -0
  342. package/src/models/HeygenMarketingVideoDetail.ts +13 -0
  343. package/src/models/HeygenMarketingVideoList.ts +11 -0
  344. package/src/models/HeygenTemplateRequest.ts +10 -0
  345. package/src/models/HeygenTemplateResponseSingle.ts +11 -0
  346. package/src/models/HeygenVideoDetail.ts +13 -0
  347. package/src/models/HeygenVideoRequest.ts +10 -0
  348. package/src/models/IBLAIPlatformMeta.ts +8 -0
  349. package/src/models/IBLAIPlatformMetaRequest.ts +11 -0
  350. package/src/models/IBLAIPlatformMetaUpdateRequest.ts +15 -0
  351. package/src/models/InputQuestion.ts +11 -0
  352. package/src/models/IntegrationCredential.ts +13 -0
  353. package/src/models/IntialQuestionAnswer.ts +8 -0
  354. package/src/models/JobRun.ts +16 -0
  355. package/src/models/KindEnum.ts +14 -0
  356. package/src/models/LLMCredentialRequest.ts +19 -0
  357. package/src/models/LLMCredentialResponse.ts +13 -0
  358. package/src/models/LLMModelForTenant.ts +11 -0
  359. package/src/models/LLMQuestion.ts +20 -0
  360. package/src/models/LLMResponse.ts +19 -0
  361. package/src/models/LLMTracesListResponse.ts +10 -0
  362. package/src/models/LanguagesView.ts +10 -0
  363. package/src/models/LinkCourseRequest.ts +8 -0
  364. package/src/models/LinkCourseResponse.ts +10 -0
  365. package/src/models/MCPServer.ts +26 -0
  366. package/src/models/MemoryComponentData.ts +10 -0
  367. package/src/models/MemoryComponentMemory.ts +9 -0
  368. package/src/models/MemoryComponentMemoryDetail.ts +13 -0
  369. package/src/models/MemoryComponentResponse.ts +10 -0
  370. package/src/models/MemoryProgress.ts +13 -0
  371. package/src/models/MemoryStatusRequestView.ts +11 -0
  372. package/src/models/MemoryStatusView.ts +11 -0
  373. package/src/models/Mentor.ts +85 -0
  374. package/src/models/MentorAudience.ts +10 -0
  375. package/src/models/MentorCategory.ts +14 -0
  376. package/src/models/MentorCategoryCreate.ts +16 -0
  377. package/src/models/MentorCategoryGroup.ts +16 -0
  378. package/src/models/MentorCategoryGroupCreate.ts +16 -0
  379. package/src/models/MentorCreate.ts +84 -0
  380. package/src/models/MentorCustomVoice.ts +9 -0
  381. package/src/models/MentorCustomVoiceResponse.ts +9 -0
  382. package/src/models/MentorData.ts +12 -0
  383. package/src/models/MentorDetailAnalytics.ts +11 -0
  384. package/src/models/MentorEval.ts +16 -0
  385. package/src/models/MentorEvalQuestion.ts +10 -0
  386. package/src/models/MentorEvalQuestionRequest.ts +9 -0
  387. package/src/models/MentorEvalReport.ts +15 -0
  388. package/src/models/MentorEvalRequest.ts +13 -0
  389. package/src/models/MentorFacet.ts +22 -0
  390. package/src/models/MentorFork.ts +10 -0
  391. package/src/models/MentorFromTemplateRequest.ts +9 -0
  392. package/src/models/MentorFromTemplateWithSettingRequest.ts +50 -0
  393. package/src/models/MentorMemorySettingsRequest.ts +11 -0
  394. package/src/models/MentorMemorySettingsResponse.ts +11 -0
  395. package/src/models/MentorMetadata.ts +10 -0
  396. package/src/models/MentorScenario.ts +11 -0
  397. package/src/models/MentorScenarioPrompt.ts +10 -0
  398. package/src/models/MentorSearchResponse.ts +40 -0
  399. package/src/models/MentorSession.ts +9 -0
  400. package/src/models/MentorSettings.ts +61 -0
  401. package/src/models/MentorSettingsPublic.ts +50 -0
  402. package/src/models/MentorSettingsRequest.ts +65 -0
  403. package/src/models/MentorVisibilityEnum.ts +14 -0
  404. package/src/models/MentorWizard.ts +9 -0
  405. package/src/models/MessageStatistics.ts +10 -0
  406. package/src/models/MessageView.ts +15 -0
  407. package/src/models/MessageViewRequest.ts +12 -0
  408. package/src/models/MessageViewUpdatResponse.ts +8 -0
  409. package/src/models/Metadata.ts +10 -0
  410. package/src/models/MetricChange.ts +9 -0
  411. package/src/models/ModelCost.ts +9 -0
  412. package/src/models/ModerationLog.ts +16 -0
  413. package/src/models/NoChatMessagesFound.ts +8 -0
  414. package/src/models/NotificationSource.ts +2 -2
  415. package/src/models/{TypeEnum.ts → NotificationSourceTypeEnum.ts} +1 -1
  416. package/src/models/NullEnum.ts +7 -0
  417. package/src/models/PageContent.ts +11 -0
  418. package/src/models/PaginatedAIGeneratedImageList.ts +12 -0
  419. package/src/models/PaginatedConversationsList.ts +12 -0
  420. package/src/models/PaginatedCourseCreationTaskFileList.ts +12 -0
  421. package/src/models/PaginatedCourseCreationTaskList.ts +12 -0
  422. package/src/models/PaginatedEdxCourseList.ts +12 -0
  423. package/src/models/PaginatedEmailPromptListList.ts +12 -0
  424. package/src/models/PaginatedHeygenMarketingVideoListList.ts +12 -0
  425. package/src/models/PaginatedHeygenTemplateResponseSingleList.ts +12 -0
  426. package/src/models/PaginatedJobRunList.ts +12 -0
  427. package/src/models/PaginatedMCPServerList.ts +12 -0
  428. package/src/models/PaginatedMentorList.ts +12 -0
  429. package/src/models/PaginatedModerationLogList.ts +12 -0
  430. package/src/models/PaginatedPeriodicAgentList.ts +12 -0
  431. package/src/models/PaginatedPeriodicAgentLogList.ts +12 -0
  432. package/src/models/PaginatedPlayWrightScriptList.ts +12 -0
  433. package/src/models/PaginatedSectionList.ts +12 -0
  434. package/src/models/PaginatedSubSectionList.ts +12 -0
  435. package/src/models/PaginatedTopicStatisticsResponse.ts +12 -0
  436. package/src/models/PaginatedUnitList.ts +12 -0
  437. package/src/models/PaginatedUserEdxMemoryList.ts +12 -0
  438. package/src/models/PaginatedVoiceList.ts +12 -0
  439. package/src/models/PatchedConversations.ts +33 -0
  440. package/src/models/PatchedCourseCreationTaskFile.ts +12 -0
  441. package/src/models/PatchedCredentialRequest.ts +19 -0
  442. package/src/models/PatchedLLMCredentialRequest.ts +19 -0
  443. package/src/models/PatchedMCPServer.ts +26 -0
  444. package/src/models/PatchedMentorCategoryGroupCreate.ts +16 -0
  445. package/src/models/PatchedMentorCreate.ts +84 -0
  446. package/src/models/PatchedPeriodicAgentCreate.ts +46 -0
  447. package/src/models/PatchedPlayWrightScript.ts +17 -0
  448. package/src/models/PatchedPrompt.ts +27 -0
  449. package/src/models/PatchedSection.ts +14 -0
  450. package/src/models/PatchedSubSection.ts +14 -0
  451. package/src/models/PatchedUnit.ts +16 -0
  452. package/src/models/PeriodicAgent.ts +47 -0
  453. package/src/models/PeriodicAgentCreate.ts +46 -0
  454. package/src/models/PeriodicAgentLog.ts +16 -0
  455. package/src/models/PeriodicAgentLogStatusEnum.ts +14 -0
  456. package/src/models/PeriodicTask.ts +26 -0
  457. package/src/models/PieChartData.ts +10 -0
  458. package/src/models/PieChartSegment.ts +9 -0
  459. package/src/models/PinnedMessageCreate.ts +14 -0
  460. package/src/models/PinnedMessageGet.ts +12 -0
  461. package/src/models/PinnedMessageRequest.ts +11 -0
  462. package/src/models/PlayWrightScript.ts +17 -0
  463. package/src/models/PredictiveAnalyticsRequest.ts +9 -0
  464. package/src/models/PredictiveAnalyticsResponse.ts +9 -0
  465. package/src/models/PreviousAgentStatusEnum.ts +16 -0
  466. package/src/models/Prompt.ts +27 -0
  467. package/src/models/PromptCategory.ts +12 -0
  468. package/src/models/PromptVisibilityEnum.ts +14 -0
  469. package/src/models/ProviderEnum.ts +14 -0
  470. package/src/models/QuestionCardTag.ts +13 -0
  471. package/src/models/QuestionRequest.ts +20 -0
  472. package/src/models/QuestionResponse.ts +15 -0
  473. package/src/models/RatingEnum.ts +12 -0
  474. package/src/models/RatingRecord.ts +9 -0
  475. package/src/models/RecentlyAccessedMentor.ts +13 -0
  476. package/src/models/RecommendCourseBlock.ts +8 -0
  477. package/src/models/RecommendCourseResponse.ts +8 -0
  478. package/src/models/RelatedText.ts +8 -0
  479. package/src/models/RequestDataVariable.ts +19 -0
  480. package/src/models/ResourceScrappedData.ts +18 -0
  481. package/src/models/ResourceScrappedDataStatusEnum.ts +16 -0
  482. package/src/models/ResponseDataVariable.ts +19 -0
  483. package/src/models/RetreiverTrainViewRequest.ts +15 -0
  484. package/src/models/RetreiverTrainViewResponse.ts +11 -0
  485. package/src/models/RetrieveTask.ts +8 -0
  486. package/src/models/RetrieverDocumentEmbedding.ts +22 -0
  487. package/src/models/RetrieverDocumentEmbeddingRequest.ts +35 -0
  488. package/src/models/RetrieverRequestSearch.ts +15 -0
  489. package/src/models/RetrieverRequestSearchDocument.ts +15 -0
  490. package/src/models/RetrieverResponseSearch.ts +12 -0
  491. package/src/models/ReuestDataVariableList.ts +9 -0
  492. package/src/models/RunMentorEval.ts +8 -0
  493. package/src/models/ScanWebhookRequest.ts +11 -0
  494. package/src/models/ScanWebhookResponse.ts +8 -0
  495. package/src/models/Section.ts +14 -0
  496. package/src/models/SectionWithChildren.ts +16 -0
  497. package/src/models/SeedMentorsView.ts +8 -0
  498. package/src/models/SentimentSummary.ts +9 -0
  499. package/src/models/SessionBrowserScreenshot.ts +13 -0
  500. package/src/models/SessionDetail.ts +11 -0
  501. package/src/models/SessionMemoryStorage.ts +11 -0
  502. package/src/models/ShellLogs.ts +8 -0
  503. package/src/models/SpacedRepetitionLearningPath.ts +8 -0
  504. package/src/models/SpacedRepetitionQuestionStats.ts +10 -0
  505. package/src/models/StarMentor.ts +12 -0
  506. package/src/models/Status6eeEnum.ts +16 -0
  507. package/src/models/Step.ts +14 -0
  508. package/src/models/StepStatusEnum.ts +14 -0
  509. package/src/models/StudentChatMessage.ts +9 -0
  510. package/src/models/StylesView.ts +9 -0
  511. package/src/models/SubSection.ts +14 -0
  512. package/src/models/SubSectionWithChildren.ts +16 -0
  513. package/src/models/TagsView.ts +10 -0
  514. package/src/models/TargetSystemEnum.ts +12 -0
  515. package/src/models/TaskView.ts +8 -0
  516. package/src/models/TemplateMentor.ts +14 -0
  517. package/src/models/TenantMentorTraces.ts +11 -0
  518. package/src/models/ThemeEnum.ts +12 -0
  519. package/src/models/TonesView.ts +9 -0
  520. package/src/models/ToolResponse.ts +16 -0
  521. package/src/models/TopicModel.ts +8 -0
  522. package/src/models/TopicRecord.ts +9 -0
  523. package/src/models/TopicStatistics.ts +12 -0
  524. package/src/models/TopicStatisticsResponse.ts +11 -0
  525. package/src/models/TopicSummaryView.ts +9 -0
  526. package/src/models/TrainChatSessionDocumentView.ts +11 -0
  527. package/src/models/TrainChatSessionDocumentViewRequest.ts +11 -0
  528. package/src/models/TrainDocumentViewRequest.ts +47 -0
  529. package/src/models/TrainDocumentViewResponse.ts +20 -0
  530. package/src/models/TrainingStatusEnum.ts +16 -0
  531. package/src/models/TransportEnum.ts +12 -0
  532. package/src/models/TrendEntry.ts +9 -0
  533. package/src/models/TriggerRequest.ts +10 -0
  534. package/src/models/TriggerResponse.ts +11 -0
  535. package/src/models/TypeC42Enum.ts +12 -0
  536. package/src/models/Unit.ts +16 -0
  537. package/src/models/UnitWithChildren.ts +18 -0
  538. package/src/models/UseMainCreds.ts +8 -0
  539. package/src/models/UserAllChatMemoryView.ts +12 -0
  540. package/src/models/UserCatalogItemMemoryView.ts +19 -0
  541. package/src/models/UserChatByPeriod.ts +9 -0
  542. package/src/models/UserChatFeedback.ts +19 -0
  543. package/src/models/UserChatFeedbackCount.ts +9 -0
  544. package/src/models/UserChatMemoryStatusRequestView.ts +11 -0
  545. package/src/models/UserChatMemoryStatusView.ts +11 -0
  546. package/src/models/UserChatMemoryUpdateView.ts +15 -0
  547. package/src/models/UserCountRecord.ts +9 -0
  548. package/src/models/UserEdxMemory.ts +20 -0
  549. package/src/models/UserMemoryContextRequest.ts +18 -0
  550. package/src/models/UserMemoryContextResponse.ts +17 -0
  551. package/src/models/UserMetric.ts +9 -0
  552. package/src/models/UserMetricsResponse.ts +12 -0
  553. package/src/models/UserSentimentCountView.ts +9 -0
  554. package/src/models/UserTrendByPeriod.ts +10 -0
  555. package/src/models/VectorResult.ts +13 -0
  556. package/src/models/VideoCaption.ts +8 -0
  557. package/src/models/Voice.ts +14 -0
  558. package/src/models/WebResource.ts +14 -0
  559. package/src/models/WebResourceCard.ts +12 -0
  560. package/src/models/WebResourcesQuery.ts +8 -0
  561. package/src/services/AiAccountService.ts +479 -0
  562. package/src/services/AiAnalyticsService.ts +5198 -0
  563. package/src/services/AiIndexService.ts +665 -0
  564. package/src/services/AiMarketingService.ts +87 -0
  565. package/src/services/AiMediaService.ts +273 -0
  566. package/src/services/AiMentorService.ts +7977 -0
  567. package/src/services/AiPromptService.ts +1771 -0
  568. package/src/services/SearchService.ts +973 -261
@@ -2,12 +2,80 @@
2
2
  /* istanbul ignore file */
3
3
  /* tslint:disable */
4
4
  /* eslint-disable */
5
+ import type { DocumentSearchResponse } from '../models/DocumentSearchResponse';
5
6
  import type { GlobalCatalogSearchResponse } from '../models/GlobalCatalogSearchResponse';
7
+ import type { MentorSearchResponse } from '../models/MentorSearchResponse';
6
8
  import type { UserSearchResponse } from '../models/UserSearchResponse';
7
9
  import type { CancelablePromise } from '../core/CancelablePromise';
8
10
  import { OpenAPI } from '../core/OpenAPI';
9
11
  import { request as __request } from '../core/request';
10
12
  export class SearchService {
13
+ /**
14
+ * Legacy endpoint for backward compatible mentor search
15
+ * @param audience Filter by target audience
16
+ * @param category Filter by mentor category
17
+ * @param createdBy Filter mentors created by specific user
18
+ * @param filterFacet If present, return only facets without results
19
+ * @param id Retrieve a specific mentor by ID
20
+ * @param limit Number of results per page
21
+ * @param llm Filter by language model type
22
+ * @param offset Starting position for pagination
23
+ * @param orderBy Field to sort results by ('created_at', 'recently_accessed_at')
24
+ * @param orderDirection Sort direction ('asc' or 'desc')
25
+ * @param page Page number (1-based, used with page_size)
26
+ * @param pageSize Number of results per page
27
+ * @param query Search term to filter mentors by name or description
28
+ * @param tags Filter by tags
29
+ * @param tenant Filter by tenant/organization
30
+ * @param uniqueId Retrieve a specific mentor by UUID
31
+ * @returns MentorSearchResponse
32
+ * @throws ApiError
33
+ */
34
+ public static searchAiSearchRetrieve(
35
+ audience?: Array<string>,
36
+ category?: Array<string>,
37
+ createdBy?: string,
38
+ filterFacet: boolean = false,
39
+ id?: number,
40
+ limit: number = 12,
41
+ llm?: Array<string>,
42
+ offset?: number,
43
+ orderBy?: string,
44
+ orderDirection: string = 'desc',
45
+ page?: number,
46
+ pageSize?: number,
47
+ query?: string,
48
+ tags?: Array<string>,
49
+ tenant?: string,
50
+ uniqueId?: string,
51
+ ): CancelablePromise<MentorSearchResponse> {
52
+ return __request(OpenAPI, {
53
+ method: 'GET',
54
+ url: '/api/search/ai-search/',
55
+ query: {
56
+ 'audience': audience,
57
+ 'category': category,
58
+ 'created_by': createdBy,
59
+ 'filter_facet': filterFacet,
60
+ 'id': id,
61
+ 'limit': limit,
62
+ 'llm': llm,
63
+ 'offset': offset,
64
+ 'order_by': orderBy,
65
+ 'order_direction': orderDirection,
66
+ 'page': page,
67
+ 'page_size': pageSize,
68
+ 'query': query,
69
+ 'tags': tags,
70
+ 'tenant': tenant,
71
+ 'unique_id': uniqueId,
72
+ },
73
+ errors: {
74
+ 400: `Bad request`,
75
+ 500: `Server error`,
76
+ },
77
+ });
78
+ }
11
79
  /**
12
80
  * Search and filter content across the learning catalog.
13
81
  *
@@ -277,274 +345,918 @@ export class SearchService {
277
345
  });
278
346
  }
279
347
  /**
280
- * Determine whether to serve a detail view or a list view.
281
- * If any detail-identifying parameters are present (course_id, program_id, etc.)
282
- * the detail view is returned; otherwise the aggregated list view is returned.
283
- * @param username
284
- * @param allowSkillSearch Enable skill-based search
285
- * @param alphabetical Sort alphabetically by name
286
- * @param certificate Filter by certificate type
287
- * @param content Content types to include in results
288
- * @param courseId Retrieve a specific course by ID
289
- * @param duration Filter by course duration range
290
- * @param language Filter by content language
291
- * @param level Filter by difficulty level
292
- * @param limit Number of results per page
293
- * @param offset Starting position for pagination
294
- * @param orderAscending Sort direction
295
- * @param orderBy Field to sort results by
296
- * @param pathwayId Retrieve a specific pathway by ID
297
- * @param price Filter by price/audit status
298
- * @param programId Retrieve a specific program by ID
299
- * @param programType Filter by program type
300
- * @param promotion Filter by promotion status
301
- * @param query Search term to filter content by name or description
302
- * @param recommended Show only recommended content
303
- * @param resourceId Retrieve a specific resource by ID
304
- * @param resourceType Filter by resource type
305
- * @param returnFacet Include facet data in response
306
- * @param returnItems Include items in programs/pathways
307
- * @param roleId Retrieve a specific role by ID
308
- * @param selfPaced Filter by course format
309
- * @param skillId Retrieve a specific skill by ID
310
- * @param skills Filter by skills
311
- * @param subject Filter by subject areas
312
- * @param tags Filter by tags
313
- * @param tenant Filter by tenant/organization
314
- * @param topics Filter by topic areas
315
- * @param updateFacet Force facet update
316
- * @returns any
317
- * @throws ApiError
318
- */
319
- public static searchPersonalizedCatalogRetrieve(
320
- username: string,
321
- allowSkillSearch: boolean = false,
322
- alphabetical: boolean = false,
323
- certificate?: Array<string>,
324
- content?: Array<string>,
325
- courseId?: string,
326
- duration?: Array<string>,
327
- language?: Array<string>,
328
- level?: Array<string>,
329
- limit: number = 12,
330
- offset?: number,
331
- orderAscending: boolean = false,
332
- orderBy?: string,
333
- pathwayId?: string,
334
- price?: string,
335
- programId?: string,
336
- programType?: Array<string>,
337
- promotion?: Array<string>,
338
- query?: string,
339
- recommended: boolean = false,
340
- resourceId?: string,
341
- resourceType?: Array<string>,
342
- returnFacet: boolean = true,
343
- returnItems: boolean = false,
344
- roleId?: string,
345
- selfPaced?: Array<string>,
346
- skillId?: string,
347
- skills?: Array<string>,
348
- subject?: Array<string>,
349
- tags?: Array<string>,
350
- tenant?: Array<string>,
351
- topics?: Array<string>,
352
- updateFacet?: string,
353
- ): CancelablePromise<Record<string, any>> {
354
- return __request(OpenAPI, {
355
- method: 'GET',
356
- url: '/api/search/personalized-catalog/{username}/',
357
- path: {
358
- 'username': username,
359
- },
360
- query: {
361
- 'allow_skill_search': allowSkillSearch,
362
- 'alphabetical': alphabetical,
363
- 'certificate': certificate,
364
- 'content': content,
365
- 'course_id': courseId,
366
- 'duration': duration,
367
- 'language': language,
368
- 'level': level,
369
- 'limit': limit,
370
- 'offset': offset,
371
- 'order_ascending': orderAscending,
372
- 'order_by': orderBy,
373
- 'pathway_id': pathwayId,
374
- 'price': price,
375
- 'program_id': programId,
376
- 'program_type': programType,
377
- 'promotion': promotion,
378
- 'query': query,
379
- 'recommended': recommended,
380
- 'resource_id': resourceId,
381
- 'resource_type': resourceType,
382
- 'return_facet': returnFacet,
383
- 'return_items': returnItems,
384
- 'role_id': roleId,
385
- 'self_paced': selfPaced,
386
- 'skill_id': skillId,
387
- 'skills': skills,
388
- 'subject': subject,
389
- 'tags': tags,
390
- 'tenant': tenant,
391
- 'topics': topics,
392
- 'update_facet': updateFacet,
393
- },
394
- });
395
- }
396
- /**
397
- * Search and filter users within a specific organization/tenant.
398
- *
399
- * This endpoint provides a search interface for discovering users within an organization,
400
- * with support for filtering by departments, pagination, and faceted filtering.
348
+ * Search and filter AI mentors across the platform.
401
349
  *
402
- * Path Parameters:
403
- * org (str): The organization/tenant identifier
404
- * username (str): The username of the user making the request
350
+ * This endpoint provides a powerful search interface for discovering AI mentors
351
+ * with support for filtering, pagination, and detailed mentor information.
405
352
  *
406
353
  * Query Parameters:
407
- * # Search parameters
408
- * query (str, optional): Search term to filter users by name, username, or email
409
- *
410
- * # Department filtering
411
- * department_mode (bool, optional): Enable department-based filtering (default: false)
412
- * user_department (bool, optional): Legacy parameter for department_mode (default: false)
413
- * department (list, optional): Filter by specific departments
354
+ * # Identification parameters (for detail view)
355
+ * id (int, optional): Retrieve a specific mentor by ID
356
+ * unique_id (uuid, optional): Retrieve a specific mentor by UUID
414
357
  *
415
- * # Additional filters
416
- * role (list, optional): Filter by user role
417
- * status (list, optional): Filter by user status (active, inactive)
418
- * joined_date (list, optional): Filter by join date range
419
- * last_login (list, optional): Filter by last login date range
358
+ * # Search and filtering parameters
359
+ * query (str, optional): Search term to filter mentors by name or description
360
+ * tenant (str, optional): Filter by tenant/organization
361
+ * llm (list, optional): Filter by language model type
362
+ * audience (list, optional): Filter by target audience
363
+ * category (list, optional): Filter by mentor category
364
+ * tags (list, optional): Filter by tags
365
+ * created_by (str, optional): Filter mentors created by specific user
420
366
  *
421
- * # Pagination
422
- * limit (int, optional): Number of results per page (default: 10)
367
+ * # Sorting and pagination
368
+ * order_by (str, optional): Field to sort results by ('created_at', 'recently_accessed_at')
369
+ * order_direction (str, optional): Sort direction ('asc' or 'desc', default: 'desc')
370
+ * limit (int, optional): Number of results per page (default: 12, max: 100)
423
371
  * offset (int, optional): Starting position for pagination
424
372
  *
425
373
  * Returns:
426
- * A JSON response containing:
427
- * ```
374
+ * For detail view (when id or unique_id is provided):
375
+ * A JSON response containing a single mentor's details:
428
376
  * {
429
- * "results": [
430
- * {
431
- * "id": 123,
432
- * "username": "john.doe",
433
- * "email": "john.doe@example.com",
434
- * "first_name": "John",
435
- * "last_name": "Doe",
436
- * "full_name": "John Doe",
437
- * "profile_image": "https://example.com/profiles/john-doe.jpg",
438
- * "role": "Student",
439
- * "departments": ["Computer Science", "Data Science"],
440
- * "status": "active",
441
- * "joined_date": "2023-01-15T12:00:00Z",
442
- * "last_login": "2023-06-20T15:30:00Z",
443
- * "metadata": {
444
- * "location": "New York",
445
- * "title": "Software Engineer",
446
- * "bio": "Experienced software engineer with a passion for education"
447
- * }
377
+ * "id": 123,
378
+ * "unique_id": "550e8400-e29b-41d4-a716-446655440000",
379
+ * "name": "Professor Smith",
380
+ * "description": "AI mentor specializing in computer science",
381
+ * "image_url": "https://example.com/images/prof-smith.jpg",
382
+ * "llm": {
383
+ * "id": 1,
384
+ * "name": "GPT-4",
385
+ * "description": "Advanced language model"
386
+ * },
387
+ * "audience": {
388
+ * "id": 2,
389
+ * "name": "College Students",
390
+ * "description": "For university-level learners"
391
+ * },
392
+ * "category": "Computer Science",
393
+ * "tags": ["programming", "algorithms", "data structures"],
394
+ * "created_at": "2023-01-15T12:00:00Z",
395
+ * "recently_accessed_at": "2023-06-20T15:30:00Z",
396
+ * "platform": {
397
+ * "id": 1,
398
+ * "name": "Example University",
399
+ * "key": "example-university"
448
400
  * },
449
- * // Additional user objects...
450
- * ],
451
- * "count": 50,
452
- * "next": "https://api.example.com/api/search/users/example-org/admin/?limit=10&offset=10",
453
- * "previous": null,
454
- * "current_page": 1,
455
- * "total_pages": 5,
456
- * "facets": {
457
- * "role": [
458
- * {"key": "Student", "doc_count": 30},
459
- * {"key": "Instructor", "doc_count": 15},
460
- * {"key": "Admin", "doc_count": 5}
461
- * ],
462
- * "department": [
463
- * {"key": "Computer Science", "doc_count": 20},
464
- * {"key": "Data Science", "doc_count": 15},
465
- * {"key": "Business", "doc_count": 10},
466
- * {"key": "Engineering", "doc_count": 5}
467
- * ],
468
- * "status": [
469
- * {"key": "active", "doc_count": 45},
470
- * {"key": "inactive", "doc_count": 5}
471
- * ]
472
- * }
473
- * }
474
- * ```
475
- * Error Responses:
476
- * 400 Bad Request: If the request parameters are invalid
477
- * 403 Forbidden: If the user doesn't have department admin privileges (when using department_mode)
478
- * 404 Not Found: If the user or organization doesn't exist
479
- * 500 Internal Server Error: If an unexpected error occurs
480
- *
481
- * Access Control:
482
- * - The requesting user must have an active account in the specified organization
483
- * - When department_mode is enabled, the user must be an admin of at least one department
484
- * - Department filtering restricts results to users in departments where the requesting user is an admin
485
- * @param org
486
- * @param username
487
- * @param department Filter by department names
488
- * @param educationDegree Filter by degree
489
- * @param educationFieldOfStudy Filter by field of study
490
- * @param educationInstitution Filter by institution
491
- * @param includeMembershipData Include user group membership data in results
492
- * @param limit Number of results per page
493
- * @param offset Starting position for pagination
494
- * @param q Search term to filter users by name, email, or other attributes
495
- * @param userResumeCompany Filter by company
496
- * @param userResumeIndustry Filter by industry
497
- * @param userResumeJobTitle Filter by job title
498
- * @param userResumeLocation Filter by location
499
- * @param userResumeSkills Filter by skills
500
- * @returns UserSearchResponse
501
- * @throws ApiError
502
- */
503
- public static searchUsersOrgsUsersRetrieve(
504
- org: string,
505
- username: string,
506
- department?: Array<string>,
507
- educationDegree?: string,
508
- educationFieldOfStudy?: string,
509
- educationInstitution?: string,
510
- includeMembershipData: boolean = false,
511
- limit: number = 10,
512
- offset?: number,
513
- q?: string,
514
- userResumeCompany?: string,
515
- userResumeIndustry?: string,
516
- userResumeJobTitle?: string,
517
- userResumeLocation?: string,
518
- userResumeSkills?: string,
519
- ): CancelablePromise<UserSearchResponse> {
520
- return __request(OpenAPI, {
521
- method: 'GET',
522
- url: '/api/search/users/orgs/{org}/users/{username}/',
523
- path: {
524
- 'org': org,
525
- 'username': username,
526
- },
527
- query: {
528
- 'department': department,
529
- 'education__degree': educationDegree,
530
- 'education__field_of_study': educationFieldOfStudy,
531
- 'education__institution': educationInstitution,
532
- 'include_membership_data': includeMembershipData,
533
- 'limit': limit,
534
- 'offset': offset,
535
- 'q': q,
536
- 'user_resume__company': userResumeCompany,
537
- 'user_resume__industry': userResumeIndustry,
538
- 'user_resume__job_title': userResumeJobTitle,
539
- 'user_resume__location': userResumeLocation,
540
- 'user_resume__skills': userResumeSkills,
541
- },
542
- errors: {
543
- 400: `Bad request`,
544
- 403: `Forbidden`,
545
- 404: `Not found`,
546
- 500: `Server error`,
547
- },
548
- });
549
- }
550
- }
401
+ * "visibility": "public",
402
+ * "settings": {
403
+ * "temperature": 0.7,
404
+ * "max_tokens": 1024,
405
+ * "system_prompt": "You are Professor Smith, an expert in computer science..."
406
+ * }
407
+ * }
408
+ *
409
+ * For list view:
410
+ * A JSON response containing:
411
+ * {
412
+ * "results": [
413
+ * {
414
+ * "id": 123,
415
+ * "unique_id": "550e8400-e29b-41d4-a716-446655440000",
416
+ * "name": "Professor Smith",
417
+ * "description": "AI mentor specializing in computer science",
418
+ * "image_url": "https://example.com/images/prof-smith.jpg",
419
+ * "llm": {"id": 1, "name": "GPT-4"},
420
+ * "audience": {"id": 2, "name": "College Students"},
421
+ * "category": "Computer Science",
422
+ * "tags": ["programming", "algorithms"],
423
+ * "created_at": "2023-01-15T12:00:00Z",
424
+ * "recently_accessed_at": "2023-06-20T15:30:00Z"
425
+ * },
426
+ * // Additional mentor objects...
427
+ * ],
428
+ * "count": 50,
429
+ * "next": "https://api.example.com/api/search/mentors/?limit=12&offset=12",
430
+ * "previous": null,
431
+ * "current_page": 1,
432
+ * "num_pages": 5,
433
+ * "facets": {
434
+ * "llm": [
435
+ * {"key": "GPT-4", "doc_count": 30},
436
+ * {"key": "Claude", "doc_count": 20}
437
+ * ],
438
+ * "audience": [
439
+ * {"key": "College Students", "doc_count": 35},
440
+ * {"key": "Professionals", "doc_count": 15}
441
+ * ],
442
+ * "category": [
443
+ * {"key": "Computer Science", "doc_count": 25},
444
+ * {"key": "Mathematics", "doc_count": 15},
445
+ * {"key": "Business", "doc_count": 10}
446
+ * ]
447
+ * }
448
+ * }
449
+ *
450
+ * Error Responses:
451
+ * 400 Bad Request: If the request parameters are invalid
452
+ * 404 Not Found: If the requested mentor doesn't exist
453
+ * 500 Internal Server Error: If an unexpected error occurs
454
+ *
455
+ * Notes:
456
+ * - Results are cached for performance
457
+ * - Public mentors are visible to all users
458
+ * - Private mentors are only visible to authorized users
459
+ * @param audience Filter by target audience
460
+ * @param category Filter by mentor category
461
+ * @param createdBy Filter mentors created by specific user
462
+ * @param id Retrieve a specific mentor by ID
463
+ * @param limit Number of results per page
464
+ * @param llm Filter by language model type
465
+ * @param offset Starting position for pagination
466
+ * @param orderBy Field to sort results by ('created_at', 'recently_accessed_at')
467
+ * @param orderDirection Sort direction ('asc' or 'desc')
468
+ * @param query Search term to filter mentors by name or description
469
+ * @param tags Filter by tags
470
+ * @param tenant Filter by tenant/organization
471
+ * @param uniqueId Retrieve a specific mentor by UUID
472
+ * @returns MentorSearchResponse
473
+ * @throws ApiError
474
+ */
475
+ public static searchMentorsRetrieve(
476
+ audience?: Array<string>,
477
+ category?: Array<string>,
478
+ createdBy?: string,
479
+ id?: number,
480
+ limit: number = 12,
481
+ llm?: Array<string>,
482
+ offset?: number,
483
+ orderBy?: string,
484
+ orderDirection: string = 'desc',
485
+ query?: string,
486
+ tags?: Array<string>,
487
+ tenant?: string,
488
+ uniqueId?: string,
489
+ ): CancelablePromise<MentorSearchResponse> {
490
+ return __request(OpenAPI, {
491
+ method: 'GET',
492
+ url: '/api/search/mentors/',
493
+ query: {
494
+ 'audience': audience,
495
+ 'category': category,
496
+ 'created_by': createdBy,
497
+ 'id': id,
498
+ 'limit': limit,
499
+ 'llm': llm,
500
+ 'offset': offset,
501
+ 'order_by': orderBy,
502
+ 'order_direction': orderDirection,
503
+ 'query': query,
504
+ 'tags': tags,
505
+ 'tenant': tenant,
506
+ 'unique_id': uniqueId,
507
+ },
508
+ errors: {
509
+ 400: `Bad request`,
510
+ 500: `Server error`,
511
+ },
512
+ });
513
+ }
514
+ /**
515
+ * Search and filter documents associated with a specific mentor
516
+ * @param mentorUniqueId
517
+ * @param access Filter by access level (e.g., 'public', 'private')
518
+ * @param documentType Filter by document type (e.g., 'pdf', 'text')
519
+ * @param limit Number of results per page
520
+ * @param offset Starting position for pagination
521
+ * @param orderBy Field to sort results by ('date_created', 'last_modified', 'document_name')
522
+ * @param orderDirection Sort direction ('asc' or 'desc')
523
+ * @param platformKey Filter by platform key
524
+ * @param query Search term to filter documents by name or content
525
+ * @param trainingStatus Filter by training status (e.g., 'trained', 'pending')
526
+ * @returns DocumentSearchResponse
527
+ * @throws ApiError
528
+ */
529
+ public static searchMentorsDocumentsRetrieve(
530
+ mentorUniqueId: string,
531
+ access?: string,
532
+ documentType?: string,
533
+ limit: number = 12,
534
+ offset?: number,
535
+ orderBy?: string,
536
+ orderDirection: string = 'desc',
537
+ platformKey?: string,
538
+ query?: string,
539
+ trainingStatus?: string,
540
+ ): CancelablePromise<DocumentSearchResponse> {
541
+ return __request(OpenAPI, {
542
+ method: 'GET',
543
+ url: '/api/search/mentors/{mentor_unique_id}/documents/',
544
+ path: {
545
+ 'mentor_unique_id': mentorUniqueId,
546
+ },
547
+ query: {
548
+ 'access': access,
549
+ 'document_type': documentType,
550
+ 'limit': limit,
551
+ 'offset': offset,
552
+ 'order_by': orderBy,
553
+ 'order_direction': orderDirection,
554
+ 'platform_key': platformKey,
555
+ 'query': query,
556
+ 'training_status': trainingStatus,
557
+ },
558
+ errors: {
559
+ 400: `Bad request`,
560
+ 404: `Mentor not found`,
561
+ 500: `Server error`,
562
+ },
563
+ });
564
+ }
565
+ /**
566
+ * Handle GET requests for tenant-specific mentor search.
567
+ *
568
+ * Args:
569
+ * request: HTTP request object
570
+ * org: Tenant/organization key
571
+ * username: Username of the user making the request
572
+ *
573
+ * Returns:
574
+ * Response: DRF Response object with search results
575
+ * @param org
576
+ * @param username
577
+ * @param audience Filter by target audience
578
+ * @param category Filter by mentor category
579
+ * @param createdBy Filter mentors created by specific user
580
+ * @param id Retrieve a specific mentor by ID
581
+ * @param limit Number of results per page
582
+ * @param llm Filter by language model type
583
+ * @param offset Starting position for pagination
584
+ * @param orderBy Field to sort results by ('created_at', 'recently_accessed_at')
585
+ * @param orderDirection Sort direction ('asc' or 'desc')
586
+ * @param query Search term to filter mentors by name or description
587
+ * @param tags Filter by tags
588
+ * @param tenant Filter by tenant/organization
589
+ * @param uniqueId Retrieve a specific mentor by UUID
590
+ * @returns MentorSearchResponse
591
+ * @throws ApiError
592
+ */
593
+ public static searchOrgsUsersMentorsRetrieve(
594
+ org: string,
595
+ username: string,
596
+ audience?: Array<string>,
597
+ category?: Array<string>,
598
+ createdBy?: string,
599
+ id?: number,
600
+ limit: number = 12,
601
+ llm?: Array<string>,
602
+ offset?: number,
603
+ orderBy?: string,
604
+ orderDirection: string = 'desc',
605
+ query?: string,
606
+ tags?: Array<string>,
607
+ tenant?: string,
608
+ uniqueId?: string,
609
+ ): CancelablePromise<MentorSearchResponse> {
610
+ return __request(OpenAPI, {
611
+ method: 'GET',
612
+ url: '/api/search/orgs/{org}/users/{username}/mentors/',
613
+ path: {
614
+ 'org': org,
615
+ 'username': username,
616
+ },
617
+ query: {
618
+ 'audience': audience,
619
+ 'category': category,
620
+ 'created_by': createdBy,
621
+ 'id': id,
622
+ 'limit': limit,
623
+ 'llm': llm,
624
+ 'offset': offset,
625
+ 'order_by': orderBy,
626
+ 'order_direction': orderDirection,
627
+ 'query': query,
628
+ 'tags': tags,
629
+ 'tenant': tenant,
630
+ 'unique_id': uniqueId,
631
+ },
632
+ errors: {
633
+ 400: `Bad request`,
634
+ 500: `Server error`,
635
+ },
636
+ });
637
+ }
638
+ /**
639
+ * Search and filter AI prompts for a specific user within a tenant.
640
+ *
641
+ * This endpoint extends the base prompt search functionality but filters results
642
+ * to only show prompts that are available to a specific user within a specific
643
+ * organization/tenant.
644
+ *
645
+ * Path Parameters:
646
+ * org (str): The organization/tenant identifier
647
+ * username (str): The username to filter prompts for
648
+ *
649
+ * Query Parameters:
650
+ * Same as PromptSearchView, plus:
651
+ *
652
+ * # Identification parameters (for detail view)
653
+ * id (int, optional): Retrieve a specific prompt by ID
654
+ *
655
+ * Returns:
656
+ * Same format as PromptSearchView, but filtered to only include prompts
657
+ * that the specified user has access to within the specified organization.
658
+ *
659
+ * Error Responses:
660
+ * 400 Bad Request: If the request parameters are invalid
661
+ * 403 Forbidden: If the requested prompt exists but the user doesn't have access
662
+ * 404 Not Found: If the requested prompt doesn't exist
663
+ * 500 Internal Server Error: If an unexpected error occurs
664
+ *
665
+ * Access Control:
666
+ * - Results are filtered based on user's permissions within the organization
667
+ * - Private prompts are only visible to authorized users
668
+ * @param org
669
+ * @param username
670
+ * @param alphabetical Sort alphabetically
671
+ * @param category Filter by prompt category
672
+ * @param filterFacet If true, return only facets without results
673
+ * @param language Filter by prompt language
674
+ * @param limit Number of results per page
675
+ * @param mentor Filter by mentor UUID
676
+ * @param offset Starting position for pagination
677
+ * @param orderDirection Sort direction ('asc' or 'desc')
678
+ * @param query Search term to filter prompts by name or content
679
+ * @param sortBy Field to sort results by
680
+ * @param style Filter by prompt style
681
+ * @param tenant Filter by tenant/organization
682
+ * @param tone Filter by prompt tone
683
+ * @returns void
684
+ * @throws ApiError
685
+ */
686
+ public static searchOrgsUsersPromptsRetrieve(
687
+ org: string,
688
+ username: string,
689
+ alphabetical: boolean = false,
690
+ category?: string,
691
+ filterFacet?: boolean,
692
+ language?: string,
693
+ limit: number = 10,
694
+ mentor?: string,
695
+ offset?: number,
696
+ orderDirection: string = 'desc',
697
+ query?: string,
698
+ sortBy?: string,
699
+ style?: string,
700
+ tenant?: string,
701
+ tone?: string,
702
+ ): CancelablePromise<void> {
703
+ return __request(OpenAPI, {
704
+ method: 'GET',
705
+ url: '/api/search/orgs/{org}/users/{username}/prompts/',
706
+ path: {
707
+ 'org': org,
708
+ 'username': username,
709
+ },
710
+ query: {
711
+ 'alphabetical': alphabetical,
712
+ 'category': category,
713
+ 'filter_facet': filterFacet,
714
+ 'language': language,
715
+ 'limit': limit,
716
+ 'mentor': mentor,
717
+ 'offset': offset,
718
+ 'order_direction': orderDirection,
719
+ 'query': query,
720
+ 'sort_by': sortBy,
721
+ 'style': style,
722
+ 'tenant': tenant,
723
+ 'tone': tone,
724
+ },
725
+ errors: {
726
+ 400: `Bad request`,
727
+ 403: `Forbidden`,
728
+ 404: `Not found`,
729
+ 500: `Server error`,
730
+ },
731
+ });
732
+ }
733
+ /**
734
+ * Determine whether to serve a detail view or a list view.
735
+ * @param org
736
+ * @param username
737
+ * @param certificate Filter by certificate type
738
+ * @param content Content types to include in recommendations (courses, programs, pathways, skills, roles, resources)
739
+ * @param courseId Retrieve a specific course by ID
740
+ * @param duration Filter by course duration range
741
+ * @param language Filter by content language
742
+ * @param level Filter by difficulty level
743
+ * @param limit Number of results per page
744
+ * @param offset Starting position for pagination
745
+ * @param pathwayId Retrieve a specific pathway by ID
746
+ * @param price Filter by price/audit status
747
+ * @param programId Retrieve a specific program by ID
748
+ * @param programType Filter by program type
749
+ * @param query Search term to filter content by name or description
750
+ * @param resourceId Retrieve a specific resource by ID
751
+ * @param resourceType Filter by resource type
752
+ * @param roleId Retrieve a specific role by ID
753
+ * @param selfPaced Filter by course format (self-paced, instructor-led)
754
+ * @param skillId Retrieve a specific skill by ID
755
+ * @param skills Filter by skills
756
+ * @param subject Filter by subject areas
757
+ * @param tags Filter by tags
758
+ * @param topics Filter by topic areas
759
+ * @returns void
760
+ * @throws ApiError
761
+ */
762
+ public static searchOrgsUsersRecommendedRetrieve(
763
+ org: string,
764
+ username: string,
765
+ certificate?: Array<string>,
766
+ content?: Array<string>,
767
+ courseId?: string,
768
+ duration?: Array<string>,
769
+ language?: Array<string>,
770
+ level?: Array<string>,
771
+ limit: number = 12,
772
+ offset?: number,
773
+ pathwayId?: string,
774
+ price?: string,
775
+ programId?: string,
776
+ programType?: Array<string>,
777
+ query?: string,
778
+ resourceId?: string,
779
+ resourceType?: Array<string>,
780
+ roleId?: string,
781
+ selfPaced?: Array<string>,
782
+ skillId?: string,
783
+ skills?: Array<string>,
784
+ subject?: Array<string>,
785
+ tags?: Array<string>,
786
+ topics?: Array<string>,
787
+ ): CancelablePromise<void> {
788
+ return __request(OpenAPI, {
789
+ method: 'GET',
790
+ url: '/api/search/orgs/{org}/users/{username}/recommended/',
791
+ path: {
792
+ 'org': org,
793
+ 'username': username,
794
+ },
795
+ query: {
796
+ 'certificate': certificate,
797
+ 'content': content,
798
+ 'course_id': courseId,
799
+ 'duration': duration,
800
+ 'language': language,
801
+ 'level': level,
802
+ 'limit': limit,
803
+ 'offset': offset,
804
+ 'pathway_id': pathwayId,
805
+ 'price': price,
806
+ 'program_id': programId,
807
+ 'program_type': programType,
808
+ 'query': query,
809
+ 'resource_id': resourceId,
810
+ 'resource_type': resourceType,
811
+ 'role_id': roleId,
812
+ 'self_paced': selfPaced,
813
+ 'skill_id': skillId,
814
+ 'skills': skills,
815
+ 'subject': subject,
816
+ 'tags': tags,
817
+ 'topics': topics,
818
+ },
819
+ errors: {
820
+ 400: `Bad request`,
821
+ 404: `User not found`,
822
+ 500: `Server error`,
823
+ },
824
+ });
825
+ }
826
+ /**
827
+ * Determine whether to serve a detail view or a list view.
828
+ * If any detail-identifying parameters are present (course_id, program_id, etc.)
829
+ * the detail view is returned; otherwise the aggregated list view is returned.
830
+ * @param username
831
+ * @param allowSkillSearch Enable skill-based search
832
+ * @param alphabetical Sort alphabetically by name
833
+ * @param certificate Filter by certificate type
834
+ * @param content Content types to include in results
835
+ * @param courseId Retrieve a specific course by ID
836
+ * @param duration Filter by course duration range
837
+ * @param language Filter by content language
838
+ * @param level Filter by difficulty level
839
+ * @param limit Number of results per page
840
+ * @param offset Starting position for pagination
841
+ * @param orderAscending Sort direction
842
+ * @param orderBy Field to sort results by
843
+ * @param pathwayId Retrieve a specific pathway by ID
844
+ * @param price Filter by price/audit status
845
+ * @param programId Retrieve a specific program by ID
846
+ * @param programType Filter by program type
847
+ * @param promotion Filter by promotion status
848
+ * @param query Search term to filter content by name or description
849
+ * @param recommended Show only recommended content
850
+ * @param resourceId Retrieve a specific resource by ID
851
+ * @param resourceType Filter by resource type
852
+ * @param returnFacet Include facet data in response
853
+ * @param returnItems Include items in programs/pathways
854
+ * @param roleId Retrieve a specific role by ID
855
+ * @param selfPaced Filter by course format
856
+ * @param skillId Retrieve a specific skill by ID
857
+ * @param skills Filter by skills
858
+ * @param subject Filter by subject areas
859
+ * @param tags Filter by tags
860
+ * @param tenant Filter by tenant/organization
861
+ * @param topics Filter by topic areas
862
+ * @param updateFacet Force facet update
863
+ * @returns any
864
+ * @throws ApiError
865
+ */
866
+ public static searchPersonalizedCatalogRetrieve(
867
+ username: string,
868
+ allowSkillSearch: boolean = false,
869
+ alphabetical: boolean = false,
870
+ certificate?: Array<string>,
871
+ content?: Array<string>,
872
+ courseId?: string,
873
+ duration?: Array<string>,
874
+ language?: Array<string>,
875
+ level?: Array<string>,
876
+ limit: number = 12,
877
+ offset?: number,
878
+ orderAscending: boolean = false,
879
+ orderBy?: string,
880
+ pathwayId?: string,
881
+ price?: string,
882
+ programId?: string,
883
+ programType?: Array<string>,
884
+ promotion?: Array<string>,
885
+ query?: string,
886
+ recommended: boolean = false,
887
+ resourceId?: string,
888
+ resourceType?: Array<string>,
889
+ returnFacet: boolean = true,
890
+ returnItems: boolean = false,
891
+ roleId?: string,
892
+ selfPaced?: Array<string>,
893
+ skillId?: string,
894
+ skills?: Array<string>,
895
+ subject?: Array<string>,
896
+ tags?: Array<string>,
897
+ tenant?: Array<string>,
898
+ topics?: Array<string>,
899
+ updateFacet?: string,
900
+ ): CancelablePromise<Record<string, any>> {
901
+ return __request(OpenAPI, {
902
+ method: 'GET',
903
+ url: '/api/search/personalized-catalog/{username}/',
904
+ path: {
905
+ 'username': username,
906
+ },
907
+ query: {
908
+ 'allow_skill_search': allowSkillSearch,
909
+ 'alphabetical': alphabetical,
910
+ 'certificate': certificate,
911
+ 'content': content,
912
+ 'course_id': courseId,
913
+ 'duration': duration,
914
+ 'language': language,
915
+ 'level': level,
916
+ 'limit': limit,
917
+ 'offset': offset,
918
+ 'order_ascending': orderAscending,
919
+ 'order_by': orderBy,
920
+ 'pathway_id': pathwayId,
921
+ 'price': price,
922
+ 'program_id': programId,
923
+ 'program_type': programType,
924
+ 'promotion': promotion,
925
+ 'query': query,
926
+ 'recommended': recommended,
927
+ 'resource_id': resourceId,
928
+ 'resource_type': resourceType,
929
+ 'return_facet': returnFacet,
930
+ 'return_items': returnItems,
931
+ 'role_id': roleId,
932
+ 'self_paced': selfPaced,
933
+ 'skill_id': skillId,
934
+ 'skills': skills,
935
+ 'subject': subject,
936
+ 'tags': tags,
937
+ 'tenant': tenant,
938
+ 'topics': topics,
939
+ 'update_facet': updateFacet,
940
+ },
941
+ });
942
+ }
943
+ /**
944
+ * Search and filter AI prompts across the platform.
945
+ *
946
+ * This endpoint provides a search interface for discovering AI prompts
947
+ * with support for filtering, pagination, and detailed prompt information.
948
+ *
949
+ * Query Parameters:
950
+ * # Identification parameters (for detail view)
951
+ * id (int, optional): Retrieve a specific prompt by ID
952
+ *
953
+ * # Search and filtering parameters
954
+ * query (str, optional): Search term to filter prompts by name or content
955
+ * category (str, optional): Filter by prompt category
956
+ * language (str, optional): Filter by prompt language
957
+ * style (str, optional): Filter by writing style
958
+ * tone (str, optional): Filter by tone
959
+ * tenant (str, optional): Filter by tenant/organization
960
+ * mentor (str, optional): Filter by associated mentor (UUID)
961
+ *
962
+ * # Sorting and pagination
963
+ * sort_by (str, optional): Field to sort results by
964
+ * order_direction (str, optional): Sort direction ('asc' or 'desc', default: 'desc')
965
+ * alphabetical (bool, optional): Sort alphabetically by name (default: false)
966
+ * limit (int, optional): Number of results per page (default: 10)
967
+ * offset (int, optional): Starting position for pagination
968
+ *
969
+ * # Special parameters
970
+ * filter_facet (any, optional): If present, return only facets without results
971
+ *
972
+ * Returns:
973
+ * For detail view (when id is provided):
974
+ * A JSON response containing a single prompt's details:
975
+ * {
976
+ * "id": 456,
977
+ * "name": "Essay Writing Guide",
978
+ * "content": "Write a well-structured essay on the following topic: {{topic}}...",
979
+ * "category": "Academic Writing",
980
+ * "language": "English",
981
+ * "style": "Formal",
982
+ * "tone": "Professional",
983
+ * "mentor": {
984
+ * "id": 123,
985
+ * "unique_id": "550e8400-e29b-41d4-a716-446655440000",
986
+ * "name": "Professor Smith"
987
+ * },
988
+ * "platform": {
989
+ * "id": 1,
990
+ * "name": "Example University",
991
+ * "key": "example-university"
992
+ * },
993
+ * "created_at": "2023-02-10T09:15:00Z",
994
+ * "updated_at": "2023-05-05T14:20:00Z",
995
+ * "visibility": "public",
996
+ * "variables": ["topic", "length", "style"]
997
+ * }
998
+ *
999
+ * For list view:
1000
+ * A JSON response containing:
1001
+ * {
1002
+ * "results": [
1003
+ * {
1004
+ * "id": 456,
1005
+ * "name": "Essay Writing Guide",
1006
+ * "content": "Write a well-structured essay on the following topic: {{topic}}...",
1007
+ * "category": "Academic Writing",
1008
+ * "language": "English",
1009
+ * "style": "Formal",
1010
+ * "tone": "Professional",
1011
+ * "mentor": {"id": 123, "name": "Professor Smith"},
1012
+ * "created_at": "2023-02-10T09:15:00Z",
1013
+ * "updated_at": "2023-05-05T14:20:00Z"
1014
+ * },
1015
+ * // Additional prompt objects...
1016
+ * ],
1017
+ * "count": 30,
1018
+ * "next": "?limit=10&offset=10",
1019
+ * "previous": null,
1020
+ * "current_page": 1,
1021
+ * "num_pages": 3,
1022
+ * "facets": {
1023
+ * "category": [
1024
+ * {"key": "Academic Writing", "doc_count": 15},
1025
+ * {"key": "Creative Writing", "doc_count": 10},
1026
+ * {"key": "Technical Documentation", "doc_count": 5}
1027
+ * ],
1028
+ * "language": [
1029
+ * {"key": "English", "doc_count": 25},
1030
+ * {"key": "Spanish", "doc_count": 5}
1031
+ * ],
1032
+ * "style": [
1033
+ * {"key": "Formal", "doc_count": 20},
1034
+ * {"key": "Casual", "doc_count": 10}
1035
+ * ],
1036
+ * "tone": [
1037
+ * {"key": "Professional", "doc_count": 15},
1038
+ * {"key": "Friendly", "doc_count": 10},
1039
+ * {"key": "Technical", "doc_count": 5}
1040
+ * ]
1041
+ * }
1042
+ * }
1043
+ *
1044
+ * Error Responses:
1045
+ * 400 Bad Request: If the request parameters are invalid
1046
+ * 403 Forbidden: If the requested prompt exists but is not publicly available
1047
+ * 404 Not Found: If the requested prompt doesn't exist
1048
+ * 500 Internal Server Error: If an unexpected error occurs
1049
+ *
1050
+ * Notes:
1051
+ * - Only publicly available prompts are returned by default
1052
+ * - When filtering by mentor, the mentor ID must be a valid UUID
1053
+ * @param alphabetical Sort alphabetically
1054
+ * @param category Filter by prompt category
1055
+ * @param filterFacet If true, return only facets without results
1056
+ * @param language Filter by prompt language
1057
+ * @param limit Number of results per page
1058
+ * @param mentor Filter by mentor UUID
1059
+ * @param offset Starting position for pagination
1060
+ * @param orderDirection Sort direction ('asc' or 'desc')
1061
+ * @param query Search term to filter prompts by name or content
1062
+ * @param sortBy Field to sort results by
1063
+ * @param style Filter by prompt style
1064
+ * @param tenant Filter by tenant/organization
1065
+ * @param tone Filter by prompt tone
1066
+ * @returns void
1067
+ * @throws ApiError
1068
+ */
1069
+ public static searchPromptsRetrieve(
1070
+ alphabetical: boolean = false,
1071
+ category?: string,
1072
+ filterFacet?: boolean,
1073
+ language?: string,
1074
+ limit: number = 10,
1075
+ mentor?: string,
1076
+ offset?: number,
1077
+ orderDirection: string = 'desc',
1078
+ query?: string,
1079
+ sortBy?: string,
1080
+ style?: string,
1081
+ tenant?: string,
1082
+ tone?: string,
1083
+ ): CancelablePromise<void> {
1084
+ return __request(OpenAPI, {
1085
+ method: 'GET',
1086
+ url: '/api/search/prompts/',
1087
+ query: {
1088
+ 'alphabetical': alphabetical,
1089
+ 'category': category,
1090
+ 'filter_facet': filterFacet,
1091
+ 'language': language,
1092
+ 'limit': limit,
1093
+ 'mentor': mentor,
1094
+ 'offset': offset,
1095
+ 'order_direction': orderDirection,
1096
+ 'query': query,
1097
+ 'sort_by': sortBy,
1098
+ 'style': style,
1099
+ 'tenant': tenant,
1100
+ 'tone': tone,
1101
+ },
1102
+ errors: {
1103
+ 400: `Bad request`,
1104
+ 500: `Server error`,
1105
+ },
1106
+ });
1107
+ }
1108
+ /**
1109
+ * Search and filter users within a specific organization/tenant.
1110
+ *
1111
+ * This endpoint provides a search interface for discovering users within an organization,
1112
+ * with support for filtering by departments, pagination, and faceted filtering.
1113
+ *
1114
+ * Path Parameters:
1115
+ * org (str): The organization/tenant identifier
1116
+ * username (str): The username of the user making the request
1117
+ *
1118
+ * Query Parameters:
1119
+ * # Search parameters
1120
+ * query (str, optional): Search term to filter users by name, username, or email
1121
+ *
1122
+ * # Department filtering
1123
+ * department_mode (bool, optional): Enable department-based filtering (default: false)
1124
+ * user_department (bool, optional): Legacy parameter for department_mode (default: false)
1125
+ * department (list, optional): Filter by specific departments
1126
+ *
1127
+ * # Additional filters
1128
+ * role (list, optional): Filter by user role
1129
+ * status (list, optional): Filter by user status (active, inactive)
1130
+ * joined_date (list, optional): Filter by join date range
1131
+ * last_login (list, optional): Filter by last login date range
1132
+ *
1133
+ * # Pagination
1134
+ * limit (int, optional): Number of results per page (default: 10)
1135
+ * offset (int, optional): Starting position for pagination
1136
+ *
1137
+ * Returns:
1138
+ * A JSON response containing:
1139
+ * ```
1140
+ * {
1141
+ * "results": [
1142
+ * {
1143
+ * "id": 123,
1144
+ * "username": "john.doe",
1145
+ * "email": "john.doe@example.com",
1146
+ * "first_name": "John",
1147
+ * "last_name": "Doe",
1148
+ * "full_name": "John Doe",
1149
+ * "profile_image": "https://example.com/profiles/john-doe.jpg",
1150
+ * "role": "Student",
1151
+ * "departments": ["Computer Science", "Data Science"],
1152
+ * "status": "active",
1153
+ * "joined_date": "2023-01-15T12:00:00Z",
1154
+ * "last_login": "2023-06-20T15:30:00Z",
1155
+ * "metadata": {
1156
+ * "location": "New York",
1157
+ * "title": "Software Engineer",
1158
+ * "bio": "Experienced software engineer with a passion for education"
1159
+ * }
1160
+ * },
1161
+ * // Additional user objects...
1162
+ * ],
1163
+ * "count": 50,
1164
+ * "next": "https://api.example.com/api/search/users/example-org/admin/?limit=10&offset=10",
1165
+ * "previous": null,
1166
+ * "current_page": 1,
1167
+ * "total_pages": 5,
1168
+ * "facets": {
1169
+ * "role": [
1170
+ * {"key": "Student", "doc_count": 30},
1171
+ * {"key": "Instructor", "doc_count": 15},
1172
+ * {"key": "Admin", "doc_count": 5}
1173
+ * ],
1174
+ * "department": [
1175
+ * {"key": "Computer Science", "doc_count": 20},
1176
+ * {"key": "Data Science", "doc_count": 15},
1177
+ * {"key": "Business", "doc_count": 10},
1178
+ * {"key": "Engineering", "doc_count": 5}
1179
+ * ],
1180
+ * "status": [
1181
+ * {"key": "active", "doc_count": 45},
1182
+ * {"key": "inactive", "doc_count": 5}
1183
+ * ]
1184
+ * }
1185
+ * }
1186
+ * ```
1187
+ * Error Responses:
1188
+ * 400 Bad Request: If the request parameters are invalid
1189
+ * 403 Forbidden: If the user doesn't have department admin privileges (when using department_mode)
1190
+ * 404 Not Found: If the user or organization doesn't exist
1191
+ * 500 Internal Server Error: If an unexpected error occurs
1192
+ *
1193
+ * Access Control:
1194
+ * - The requesting user must have an active account in the specified organization
1195
+ * - When department_mode is enabled, the user must be an admin of at least one department
1196
+ * - Department filtering restricts results to users in departments where the requesting user is an admin
1197
+ * @param org
1198
+ * @param username
1199
+ * @param department Filter by department names
1200
+ * @param educationDegree Filter by degree
1201
+ * @param educationFieldOfStudy Filter by field of study
1202
+ * @param educationInstitution Filter by institution
1203
+ * @param includeMembershipData Include user group membership data in results
1204
+ * @param limit Number of results per page
1205
+ * @param offset Starting position for pagination
1206
+ * @param q Search term to filter users by name, email, or other attributes
1207
+ * @param userResumeCompany Filter by company
1208
+ * @param userResumeIndustry Filter by industry
1209
+ * @param userResumeJobTitle Filter by job title
1210
+ * @param userResumeLocation Filter by location
1211
+ * @param userResumeSkills Filter by skills
1212
+ * @returns UserSearchResponse
1213
+ * @throws ApiError
1214
+ */
1215
+ public static searchUsersOrgsUsersRetrieve(
1216
+ org: string,
1217
+ username: string,
1218
+ department?: Array<string>,
1219
+ educationDegree?: string,
1220
+ educationFieldOfStudy?: string,
1221
+ educationInstitution?: string,
1222
+ includeMembershipData: boolean = false,
1223
+ limit: number = 10,
1224
+ offset?: number,
1225
+ q?: string,
1226
+ userResumeCompany?: string,
1227
+ userResumeIndustry?: string,
1228
+ userResumeJobTitle?: string,
1229
+ userResumeLocation?: string,
1230
+ userResumeSkills?: string,
1231
+ ): CancelablePromise<UserSearchResponse> {
1232
+ return __request(OpenAPI, {
1233
+ method: 'GET',
1234
+ url: '/api/search/users/orgs/{org}/users/{username}/',
1235
+ path: {
1236
+ 'org': org,
1237
+ 'username': username,
1238
+ },
1239
+ query: {
1240
+ 'department': department,
1241
+ 'education__degree': educationDegree,
1242
+ 'education__field_of_study': educationFieldOfStudy,
1243
+ 'education__institution': educationInstitution,
1244
+ 'include_membership_data': includeMembershipData,
1245
+ 'limit': limit,
1246
+ 'offset': offset,
1247
+ 'q': q,
1248
+ 'user_resume__company': userResumeCompany,
1249
+ 'user_resume__industry': userResumeIndustry,
1250
+ 'user_resume__job_title': userResumeJobTitle,
1251
+ 'user_resume__location': userResumeLocation,
1252
+ 'user_resume__skills': userResumeSkills,
1253
+ },
1254
+ errors: {
1255
+ 400: `Bad request`,
1256
+ 403: `Forbidden`,
1257
+ 404: `Not found`,
1258
+ 500: `Server error`,
1259
+ },
1260
+ });
1261
+ }
1262
+ }