@iblai/iblai-api 3.35.0-core → 3.35.1-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 (536) hide show
  1. package/dist/index.cjs.js +11563 -224
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +11558 -225
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +11563 -224
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/index.d.ts +259 -2
  8. package/dist/types/models/AIGeneratedImage.d.ts +13 -0
  9. package/dist/types/models/APITokenCost.d.ts +14 -0
  10. package/dist/types/models/AccessEnum.d.ts +8 -0
  11. package/dist/types/models/AlignMentorBubbleEnum.d.ts +8 -0
  12. package/dist/types/models/AnalyticsOverview.d.ts +7 -0
  13. package/dist/types/models/Answer.d.ts +11 -0
  14. package/dist/types/models/AssumedKnowledge.d.ts +4 -0
  15. package/dist/types/models/AssumedKnowledgeLevel.d.ts +4 -0
  16. package/dist/types/models/AudioToTextRequest.d.ts +3 -0
  17. package/dist/types/models/AudioToTextResponse.d.ts +3 -0
  18. package/dist/types/models/CallAuthenticationRequest.d.ts +13 -0
  19. package/dist/types/models/CallAuthenticationResponse.d.ts +21 -0
  20. package/dist/types/models/ChatHistory.d.ts +8 -0
  21. package/dist/types/models/ChatHistoryFilterData.d.ts +9 -0
  22. package/dist/types/models/ChatHistoryFilterUser.d.ts +5 -0
  23. package/dist/types/models/ChatHistoryItem.d.ts +5 -0
  24. package/dist/types/models/ChatHistorySessionId.d.ts +3 -0
  25. package/dist/types/models/ChatSessionRequest.d.ts +10 -0
  26. package/dist/types/models/ChatSessionResponse.d.ts +5 -0
  27. package/dist/types/models/CheckDocumentTrainingStatus.d.ts +10 -0
  28. package/dist/types/models/ComponentBlock.d.ts +9 -0
  29. package/dist/types/models/ComponentBlockTypeEnum.d.ts +8 -0
  30. package/dist/types/models/ConversationMessage.d.ts +11 -0
  31. package/dist/types/models/ConversationRating.d.ts +6 -0
  32. package/dist/types/models/ConversationSummary.d.ts +5 -0
  33. package/dist/types/models/ConversationVolume.d.ts +4 -0
  34. package/dist/types/models/Conversations.d.ts +28 -0
  35. package/dist/types/models/Cost.d.ts +3 -0
  36. package/dist/types/models/CostPerTenant.d.ts +6 -0
  37. package/dist/types/models/CourseCreationTask.d.ts +31 -0
  38. package/dist/types/models/CourseCreationTaskFile.d.ts +7 -0
  39. package/dist/types/models/CourseCreationTaskStatusEnum.d.ts +16 -0
  40. package/dist/types/models/CredentialRequest.d.ts +14 -0
  41. package/dist/types/models/CrontabSchedule.d.ts +22 -0
  42. package/dist/types/models/CustomInstructionResponse.d.ts +13 -0
  43. package/dist/types/models/DateRange.d.ts +4 -0
  44. package/dist/types/models/EdxCourse.d.ts +11 -0
  45. package/dist/types/models/ElevenlabsCustomVoice.d.ts +4 -0
  46. package/dist/types/models/ElevenlabsCustomVoiceResponse.d.ts +8 -0
  47. package/dist/types/models/EmailPromptDetail.d.ts +13 -0
  48. package/dist/types/models/EmailPromptList.d.ts +11 -0
  49. package/dist/types/models/EmailPromptSummary.d.ts +5 -0
  50. package/dist/types/models/FreeUsageCount.d.ts +3 -0
  51. package/dist/types/models/FullCourse.d.ts +13 -0
  52. package/dist/types/models/GreetingMethodEnum.d.ts +8 -0
  53. package/dist/types/models/GuidedPromptsResponse.d.ts +3 -0
  54. package/dist/types/models/HeygenMarketingVideoDetail.d.ts +8 -0
  55. package/dist/types/models/HeygenMarketingVideoList.d.ts +6 -0
  56. package/dist/types/models/IBLAIPlatformMeta.d.ts +3 -0
  57. package/dist/types/models/IBLAIPlatformMetaRequest.d.ts +6 -0
  58. package/dist/types/models/IBLAIPlatformMetaUpdateRequest.d.ts +10 -0
  59. package/dist/types/models/InputQuestion.d.ts +6 -0
  60. package/dist/types/models/IntegrationCredential.d.ts +8 -0
  61. package/dist/types/models/IntialQuestionAnswer.d.ts +3 -0
  62. package/dist/types/models/JobRun.d.ts +11 -0
  63. package/dist/types/models/KindEnum.d.ts +10 -0
  64. package/dist/types/models/LLMCredentialRequest.d.ts +14 -0
  65. package/dist/types/models/LLMCredentialResponse.d.ts +8 -0
  66. package/dist/types/models/LLMModelForTenant.d.ts +6 -0
  67. package/dist/types/models/LLMQuestion.d.ts +15 -0
  68. package/dist/types/models/LLMResponse.d.ts +14 -0
  69. package/dist/types/models/LLMTracesListResponse.d.ts +5 -0
  70. package/dist/types/models/LanguagesView.d.ts +5 -0
  71. package/dist/types/models/LinkCourseRequest.d.ts +3 -0
  72. package/dist/types/models/LinkCourseResponse.d.ts +5 -0
  73. package/dist/types/models/MemoryComponentData.d.ts +5 -0
  74. package/dist/types/models/MemoryComponentMemory.d.ts +4 -0
  75. package/dist/types/models/MemoryComponentMemoryDetail.d.ts +8 -0
  76. package/dist/types/models/MemoryComponentResponse.d.ts +5 -0
  77. package/dist/types/models/MemoryProgress.d.ts +8 -0
  78. package/dist/types/models/MemoryStatusRequestView.d.ts +6 -0
  79. package/dist/types/models/MemoryStatusView.d.ts +6 -0
  80. package/dist/types/models/Mentor.d.ts +75 -0
  81. package/dist/types/models/MentorAudience.d.ts +5 -0
  82. package/dist/types/models/MentorCategory.d.ts +9 -0
  83. package/dist/types/models/MentorCategoryCreate.d.ts +11 -0
  84. package/dist/types/models/MentorCategoryGroup.d.ts +11 -0
  85. package/dist/types/models/MentorCategoryGroupCreate.d.ts +11 -0
  86. package/dist/types/models/MentorCreate.d.ts +74 -0
  87. package/dist/types/models/MentorCustomVoice.d.ts +4 -0
  88. package/dist/types/models/MentorCustomVoiceResponse.d.ts +4 -0
  89. package/dist/types/models/MentorData.d.ts +7 -0
  90. package/dist/types/models/MentorDetailAnalytics.d.ts +6 -0
  91. package/dist/types/models/MentorEval.d.ts +11 -0
  92. package/dist/types/models/MentorEvalQuestion.d.ts +5 -0
  93. package/dist/types/models/MentorEvalQuestionRequest.d.ts +4 -0
  94. package/dist/types/models/MentorEvalReport.d.ts +10 -0
  95. package/dist/types/models/MentorEvalRequest.d.ts +8 -0
  96. package/dist/types/models/MentorFork.d.ts +5 -0
  97. package/dist/types/models/MentorFromTemplateRequest.d.ts +4 -0
  98. package/dist/types/models/MentorFromTemplateWithSettingRequest.d.ts +42 -0
  99. package/dist/types/models/MentorMemorySettingsRequest.d.ts +6 -0
  100. package/dist/types/models/MentorMemorySettingsResponse.d.ts +6 -0
  101. package/dist/types/models/MentorMetadata.d.ts +5 -0
  102. package/dist/types/models/MentorScenario.d.ts +6 -0
  103. package/dist/types/models/MentorScenarioPrompt.d.ts +5 -0
  104. package/dist/types/models/MentorSession.d.ts +4 -0
  105. package/dist/types/models/MentorSettings.d.ts +47 -0
  106. package/dist/types/models/MentorSettingsPublic.d.ts +40 -0
  107. package/dist/types/models/MentorSettingsRequest.d.ts +51 -0
  108. package/dist/types/models/MentorVisibilityEnum.d.ts +10 -0
  109. package/dist/types/models/MentorWizard.d.ts +4 -0
  110. package/dist/types/models/MessageStatistics.d.ts +5 -0
  111. package/dist/types/models/MessageView.d.ts +10 -0
  112. package/dist/types/models/MessageViewRequest.d.ts +7 -0
  113. package/dist/types/models/MessageViewUpdatResponse.d.ts +3 -0
  114. package/dist/types/models/Metadata.d.ts +5 -0
  115. package/dist/types/models/MetricChange.d.ts +4 -0
  116. package/dist/types/models/ModelCost.d.ts +4 -0
  117. package/dist/types/models/ModerationLog.d.ts +11 -0
  118. package/dist/types/models/NoChatMessagesFound.d.ts +3 -0
  119. package/dist/types/models/Notification.d.ts +2 -2
  120. package/dist/types/models/NotificationSource.d.ts +2 -2
  121. package/dist/types/models/{TypeEnum.d.ts → NotificationSourceTypeEnum.d.ts} +1 -1
  122. package/dist/types/models/{StatusEnum.d.ts → NotificationStatusEnum.d.ts} +1 -1
  123. package/dist/types/models/NullEnum.d.ts +1 -0
  124. package/dist/types/models/PageContent.d.ts +6 -0
  125. package/dist/types/models/PaginatedAIGeneratedImageList.d.ts +7 -0
  126. package/dist/types/models/PaginatedConversationsList.d.ts +7 -0
  127. package/dist/types/models/PaginatedCourseCreationTaskFileList.d.ts +7 -0
  128. package/dist/types/models/PaginatedCourseCreationTaskList.d.ts +7 -0
  129. package/dist/types/models/PaginatedEdxCourseList.d.ts +7 -0
  130. package/dist/types/models/PaginatedEmailPromptListList.d.ts +7 -0
  131. package/dist/types/models/PaginatedHeygenMarketingVideoListList.d.ts +7 -0
  132. package/dist/types/models/PaginatedJobRunList.d.ts +7 -0
  133. package/dist/types/models/PaginatedMentorList.d.ts +7 -0
  134. package/dist/types/models/PaginatedModerationLogList.d.ts +7 -0
  135. package/dist/types/models/PaginatedPeriodicAgentList.d.ts +7 -0
  136. package/dist/types/models/PaginatedPeriodicAgentLogList.d.ts +7 -0
  137. package/dist/types/models/PaginatedPlayWrightScriptList.d.ts +7 -0
  138. package/dist/types/models/PaginatedSectionList.d.ts +7 -0
  139. package/dist/types/models/PaginatedSubSectionList.d.ts +7 -0
  140. package/dist/types/models/PaginatedTopicStatisticsResponse.d.ts +7 -0
  141. package/dist/types/models/PaginatedUnitList.d.ts +7 -0
  142. package/dist/types/models/PaginatedUserEdxMemoryList.d.ts +7 -0
  143. package/dist/types/models/PaginatedVoiceList.d.ts +7 -0
  144. package/dist/types/models/PatchedConversations.d.ts +28 -0
  145. package/dist/types/models/PatchedCourseCreationTaskFile.d.ts +7 -0
  146. package/dist/types/models/PatchedCredentialRequest.d.ts +14 -0
  147. package/dist/types/models/PatchedLLMCredentialRequest.d.ts +14 -0
  148. package/dist/types/models/PatchedMentorCategoryGroupCreate.d.ts +11 -0
  149. package/dist/types/models/PatchedMentorCreate.d.ts +74 -0
  150. package/dist/types/models/PatchedNotification.d.ts +2 -2
  151. package/dist/types/models/PatchedPeriodicAgentCreate.d.ts +41 -0
  152. package/dist/types/models/PatchedPlayWrightScript.d.ts +12 -0
  153. package/dist/types/models/PatchedPrompt.d.ts +22 -0
  154. package/dist/types/models/PatchedSection.d.ts +9 -0
  155. package/dist/types/models/PatchedSubSection.d.ts +9 -0
  156. package/dist/types/models/PatchedUnit.d.ts +11 -0
  157. package/dist/types/models/PeriodicAgent.d.ts +42 -0
  158. package/dist/types/models/PeriodicAgentCreate.d.ts +41 -0
  159. package/dist/types/models/PeriodicAgentLog.d.ts +11 -0
  160. package/dist/types/models/PeriodicAgentLogStatusEnum.d.ts +10 -0
  161. package/dist/types/models/PeriodicTask.d.ts +21 -0
  162. package/dist/types/models/PieChartData.d.ts +5 -0
  163. package/dist/types/models/PieChartSegment.d.ts +4 -0
  164. package/dist/types/models/PinnedMessageCreate.d.ts +9 -0
  165. package/dist/types/models/PinnedMessageGet.d.ts +7 -0
  166. package/dist/types/models/PinnedMessageRequest.d.ts +6 -0
  167. package/dist/types/models/PlayWrightScript.d.ts +12 -0
  168. package/dist/types/models/PredictiveAnalyticsRequest.d.ts +4 -0
  169. package/dist/types/models/PredictiveAnalyticsResponse.d.ts +4 -0
  170. package/dist/types/models/PreviousAgentStatusEnum.d.ts +12 -0
  171. package/dist/types/models/Prompt.d.ts +22 -0
  172. package/dist/types/models/PromptCategory.d.ts +7 -0
  173. package/dist/types/models/PromptVisibilityEnum.d.ts +10 -0
  174. package/dist/types/models/ProviderEnum.d.ts +10 -0
  175. package/dist/types/models/QuestionCardTag.d.ts +8 -0
  176. package/dist/types/models/QuestionRequest.d.ts +15 -0
  177. package/dist/types/models/QuestionResponse.d.ts +10 -0
  178. package/dist/types/models/RatingEnum.d.ts +8 -0
  179. package/dist/types/models/RatingRecord.d.ts +4 -0
  180. package/dist/types/models/RecentlyAccessedMentor.d.ts +8 -0
  181. package/dist/types/models/RecommendCourseBlock.d.ts +3 -0
  182. package/dist/types/models/RecommendCourseResponse.d.ts +3 -0
  183. package/dist/types/models/RelatedText.d.ts +3 -0
  184. package/dist/types/models/RequestDataVariable.d.ts +14 -0
  185. package/dist/types/models/ResourceScrappedData.d.ts +13 -0
  186. package/dist/types/models/ResourceScrappedDataStatusEnum.d.ts +12 -0
  187. package/dist/types/models/ResponseDataVariable.d.ts +14 -0
  188. package/dist/types/models/RetreiverTrainViewRequest.d.ts +10 -0
  189. package/dist/types/models/RetreiverTrainViewResponse.d.ts +6 -0
  190. package/dist/types/models/RetrieveTask.d.ts +3 -0
  191. package/dist/types/models/RetrieverDocumentEmbedding.d.ts +17 -0
  192. package/dist/types/models/RetrieverDocumentEmbeddingRequest.d.ts +30 -0
  193. package/dist/types/models/RetrieverRequestSearch.d.ts +10 -0
  194. package/dist/types/models/RetrieverRequestSearchDocument.d.ts +10 -0
  195. package/dist/types/models/RetrieverResponseSearch.d.ts +7 -0
  196. package/dist/types/models/ReuestDataVariableList.d.ts +4 -0
  197. package/dist/types/models/RunMentorEval.d.ts +3 -0
  198. package/dist/types/models/ScanWebhookRequest.d.ts +6 -0
  199. package/dist/types/models/ScanWebhookResponse.d.ts +3 -0
  200. package/dist/types/models/Section.d.ts +9 -0
  201. package/dist/types/models/SectionWithChildren.d.ts +11 -0
  202. package/dist/types/models/SeedMentorsView.d.ts +3 -0
  203. package/dist/types/models/SentimentSummary.d.ts +4 -0
  204. package/dist/types/models/SessionBrowserScreenshot.d.ts +8 -0
  205. package/dist/types/models/SessionDetail.d.ts +6 -0
  206. package/dist/types/models/SessionMemoryStorage.d.ts +6 -0
  207. package/dist/types/models/ShellLogs.d.ts +3 -0
  208. package/dist/types/models/SpacedRepetitionLearningPath.d.ts +3 -0
  209. package/dist/types/models/SpacedRepetitionQuestionStats.d.ts +5 -0
  210. package/dist/types/models/StarMentor.d.ts +7 -0
  211. package/dist/types/models/Status6eeEnum.d.ts +12 -0
  212. package/dist/types/models/Step.d.ts +9 -0
  213. package/dist/types/models/StepStatusEnum.d.ts +10 -0
  214. package/dist/types/models/StudentChatMessage.d.ts +4 -0
  215. package/dist/types/models/StylesView.d.ts +4 -0
  216. package/dist/types/models/SubSection.d.ts +9 -0
  217. package/dist/types/models/SubSectionWithChildren.d.ts +11 -0
  218. package/dist/types/models/TagsView.d.ts +5 -0
  219. package/dist/types/models/TargetSystemEnum.d.ts +8 -0
  220. package/dist/types/models/TaskView.d.ts +3 -0
  221. package/dist/types/models/TemplateMentor.d.ts +9 -0
  222. package/dist/types/models/TenantMentorTraces.d.ts +6 -0
  223. package/dist/types/models/ThemeEnum.d.ts +8 -0
  224. package/dist/types/models/TonesView.d.ts +4 -0
  225. package/dist/types/models/ToolResponse.d.ts +9 -0
  226. package/dist/types/models/TopicModel.d.ts +3 -0
  227. package/dist/types/models/TopicRecord.d.ts +4 -0
  228. package/dist/types/models/TopicStatistics.d.ts +7 -0
  229. package/dist/types/models/TopicStatisticsResponse.d.ts +6 -0
  230. package/dist/types/models/TopicSummaryView.d.ts +4 -0
  231. package/dist/types/models/TrainChatSessionDocumentView.d.ts +6 -0
  232. package/dist/types/models/TrainChatSessionDocumentViewRequest.d.ts +6 -0
  233. package/dist/types/models/TrainDocumentViewRequest.d.ts +42 -0
  234. package/dist/types/models/TrainDocumentViewResponse.d.ts +14 -0
  235. package/dist/types/models/TrainingStatusEnum.d.ts +12 -0
  236. package/dist/types/models/TrendEntry.d.ts +4 -0
  237. package/dist/types/models/TriggerRequest.d.ts +5 -0
  238. package/dist/types/models/TriggerResponse.d.ts +6 -0
  239. package/dist/types/models/TypeC42Enum.d.ts +8 -0
  240. package/dist/types/models/Unit.d.ts +11 -0
  241. package/dist/types/models/UnitWithChildren.d.ts +13 -0
  242. package/dist/types/models/UseMainCreds.d.ts +3 -0
  243. package/dist/types/models/UserAllChatMemoryView.d.ts +7 -0
  244. package/dist/types/models/UserCatalogItemMemoryView.d.ts +14 -0
  245. package/dist/types/models/UserChatByPeriod.d.ts +4 -0
  246. package/dist/types/models/UserChatFeedback.d.ts +14 -0
  247. package/dist/types/models/UserChatFeedbackCount.d.ts +4 -0
  248. package/dist/types/models/UserChatMemoryStatusRequestView.d.ts +6 -0
  249. package/dist/types/models/UserChatMemoryStatusView.d.ts +6 -0
  250. package/dist/types/models/UserChatMemoryUpdateView.d.ts +10 -0
  251. package/dist/types/models/UserCountRecord.d.ts +4 -0
  252. package/dist/types/models/UserEdxMemory.d.ts +15 -0
  253. package/dist/types/models/UserMemoryContextRequest.d.ts +13 -0
  254. package/dist/types/models/UserMemoryContextResponse.d.ts +12 -0
  255. package/dist/types/models/UserMetric.d.ts +4 -0
  256. package/dist/types/models/UserMetricsResponse.d.ts +7 -0
  257. package/dist/types/models/UserSentimentCountView.d.ts +4 -0
  258. package/dist/types/models/UserTrendByPeriod.d.ts +5 -0
  259. package/dist/types/models/VectorResult.d.ts +8 -0
  260. package/dist/types/models/Voice.d.ts +9 -0
  261. package/dist/types/models/WebResource.d.ts +9 -0
  262. package/dist/types/models/WebResourceCard.d.ts +7 -0
  263. package/dist/types/models/WebResourcesQuery.d.ts +3 -0
  264. package/dist/types/services/AiAccountService.d.ts +294 -0
  265. package/dist/types/services/AiAnalyticsService.d.ts +1056 -0
  266. package/dist/types/services/AiIndexService.d.ts +344 -0
  267. package/dist/types/services/AiMarketingService.d.ts +34 -0
  268. package/dist/types/services/AiMentorService.d.ts +4096 -0
  269. package/dist/types/services/AiPromptService.d.ts +879 -0
  270. package/dist/types/services/SearchService.d.ts +354 -159
  271. package/package.json +1 -1
  272. package/src/core/OpenAPI.ts +1 -1
  273. package/src/index.ts +259 -2
  274. package/src/models/AIGeneratedImage.ts +18 -0
  275. package/src/models/APITokenCost.ts +19 -0
  276. package/src/models/AccessEnum.ts +12 -0
  277. package/src/models/AlignMentorBubbleEnum.ts +12 -0
  278. package/src/models/AnalyticsOverview.ts +12 -0
  279. package/src/models/Answer.ts +16 -0
  280. package/src/models/AssumedKnowledge.ts +9 -0
  281. package/src/models/AssumedKnowledgeLevel.ts +9 -0
  282. package/src/models/AudioToTextRequest.ts +8 -0
  283. package/src/models/AudioToTextResponse.ts +8 -0
  284. package/src/models/CallAuthenticationRequest.ts +18 -0
  285. package/src/models/CallAuthenticationResponse.ts +26 -0
  286. package/src/models/ChatHistory.ts +13 -0
  287. package/src/models/ChatHistoryFilterData.ts +14 -0
  288. package/src/models/ChatHistoryFilterUser.ts +10 -0
  289. package/src/models/ChatHistoryItem.ts +10 -0
  290. package/src/models/ChatHistorySessionId.ts +8 -0
  291. package/src/models/ChatSessionRequest.ts +15 -0
  292. package/src/models/ChatSessionResponse.ts +10 -0
  293. package/src/models/CheckDocumentTrainingStatus.ts +15 -0
  294. package/src/models/ComponentBlock.ts +14 -0
  295. package/src/models/ComponentBlockTypeEnum.ts +12 -0
  296. package/src/models/ConversationMessage.ts +16 -0
  297. package/src/models/ConversationRating.ts +11 -0
  298. package/src/models/ConversationSummary.ts +10 -0
  299. package/src/models/ConversationVolume.ts +9 -0
  300. package/src/models/Conversations.ts +33 -0
  301. package/src/models/Cost.ts +8 -0
  302. package/src/models/CostPerTenant.ts +11 -0
  303. package/src/models/CourseCreationTask.ts +36 -0
  304. package/src/models/CourseCreationTaskFile.ts +12 -0
  305. package/src/models/CourseCreationTaskStatusEnum.ts +20 -0
  306. package/src/models/CredentialRequest.ts +19 -0
  307. package/src/models/CrontabSchedule.ts +27 -0
  308. package/src/models/CustomInstructionResponse.ts +18 -0
  309. package/src/models/DateRange.ts +9 -0
  310. package/src/models/EdxCourse.ts +16 -0
  311. package/src/models/ElevenlabsCustomVoice.ts +9 -0
  312. package/src/models/ElevenlabsCustomVoiceResponse.ts +13 -0
  313. package/src/models/EmailPromptDetail.ts +18 -0
  314. package/src/models/EmailPromptList.ts +16 -0
  315. package/src/models/EmailPromptSummary.ts +10 -0
  316. package/src/models/FreeUsageCount.ts +8 -0
  317. package/src/models/FullCourse.ts +18 -0
  318. package/src/models/GreetingMethodEnum.ts +12 -0
  319. package/src/models/GuidedPromptsResponse.ts +8 -0
  320. package/src/models/HeygenMarketingVideoDetail.ts +13 -0
  321. package/src/models/HeygenMarketingVideoList.ts +11 -0
  322. package/src/models/IBLAIPlatformMeta.ts +8 -0
  323. package/src/models/IBLAIPlatformMetaRequest.ts +11 -0
  324. package/src/models/IBLAIPlatformMetaUpdateRequest.ts +15 -0
  325. package/src/models/InputQuestion.ts +11 -0
  326. package/src/models/IntegrationCredential.ts +13 -0
  327. package/src/models/IntialQuestionAnswer.ts +8 -0
  328. package/src/models/JobRun.ts +16 -0
  329. package/src/models/KindEnum.ts +14 -0
  330. package/src/models/LLMCredentialRequest.ts +19 -0
  331. package/src/models/LLMCredentialResponse.ts +13 -0
  332. package/src/models/LLMModelForTenant.ts +11 -0
  333. package/src/models/LLMQuestion.ts +20 -0
  334. package/src/models/LLMResponse.ts +19 -0
  335. package/src/models/LLMTracesListResponse.ts +10 -0
  336. package/src/models/LanguagesView.ts +10 -0
  337. package/src/models/LinkCourseRequest.ts +8 -0
  338. package/src/models/LinkCourseResponse.ts +10 -0
  339. package/src/models/MemoryComponentData.ts +10 -0
  340. package/src/models/MemoryComponentMemory.ts +9 -0
  341. package/src/models/MemoryComponentMemoryDetail.ts +13 -0
  342. package/src/models/MemoryComponentResponse.ts +10 -0
  343. package/src/models/MemoryProgress.ts +13 -0
  344. package/src/models/MemoryStatusRequestView.ts +11 -0
  345. package/src/models/MemoryStatusView.ts +11 -0
  346. package/src/models/Mentor.ts +80 -0
  347. package/src/models/MentorAudience.ts +10 -0
  348. package/src/models/MentorCategory.ts +14 -0
  349. package/src/models/MentorCategoryCreate.ts +16 -0
  350. package/src/models/MentorCategoryGroup.ts +16 -0
  351. package/src/models/MentorCategoryGroupCreate.ts +16 -0
  352. package/src/models/MentorCreate.ts +79 -0
  353. package/src/models/MentorCustomVoice.ts +9 -0
  354. package/src/models/MentorCustomVoiceResponse.ts +9 -0
  355. package/src/models/MentorData.ts +12 -0
  356. package/src/models/MentorDetailAnalytics.ts +11 -0
  357. package/src/models/MentorEval.ts +16 -0
  358. package/src/models/MentorEvalQuestion.ts +10 -0
  359. package/src/models/MentorEvalQuestionRequest.ts +9 -0
  360. package/src/models/MentorEvalReport.ts +15 -0
  361. package/src/models/MentorEvalRequest.ts +13 -0
  362. package/src/models/MentorFork.ts +10 -0
  363. package/src/models/MentorFromTemplateRequest.ts +9 -0
  364. package/src/models/MentorFromTemplateWithSettingRequest.ts +47 -0
  365. package/src/models/MentorMemorySettingsRequest.ts +11 -0
  366. package/src/models/MentorMemorySettingsResponse.ts +11 -0
  367. package/src/models/MentorMetadata.ts +10 -0
  368. package/src/models/MentorScenario.ts +11 -0
  369. package/src/models/MentorScenarioPrompt.ts +10 -0
  370. package/src/models/MentorSession.ts +9 -0
  371. package/src/models/MentorSettings.ts +52 -0
  372. package/src/models/MentorSettingsPublic.ts +45 -0
  373. package/src/models/MentorSettingsRequest.ts +56 -0
  374. package/src/models/MentorVisibilityEnum.ts +14 -0
  375. package/src/models/MentorWizard.ts +9 -0
  376. package/src/models/MessageStatistics.ts +10 -0
  377. package/src/models/MessageView.ts +15 -0
  378. package/src/models/MessageViewRequest.ts +12 -0
  379. package/src/models/MessageViewUpdatResponse.ts +8 -0
  380. package/src/models/Metadata.ts +10 -0
  381. package/src/models/MetricChange.ts +9 -0
  382. package/src/models/ModelCost.ts +9 -0
  383. package/src/models/ModerationLog.ts +16 -0
  384. package/src/models/NoChatMessagesFound.ts +8 -0
  385. package/src/models/Notification.ts +2 -2
  386. package/src/models/NotificationSource.ts +2 -2
  387. package/src/models/{TypeEnum.ts → NotificationSourceTypeEnum.ts} +1 -1
  388. package/src/models/{StatusEnum.ts → NotificationStatusEnum.ts} +1 -1
  389. package/src/models/NullEnum.ts +7 -0
  390. package/src/models/PageContent.ts +11 -0
  391. package/src/models/PaginatedAIGeneratedImageList.ts +12 -0
  392. package/src/models/PaginatedConversationsList.ts +12 -0
  393. package/src/models/PaginatedCourseCreationTaskFileList.ts +12 -0
  394. package/src/models/PaginatedCourseCreationTaskList.ts +12 -0
  395. package/src/models/PaginatedEdxCourseList.ts +12 -0
  396. package/src/models/PaginatedEmailPromptListList.ts +12 -0
  397. package/src/models/PaginatedHeygenMarketingVideoListList.ts +12 -0
  398. package/src/models/PaginatedJobRunList.ts +12 -0
  399. package/src/models/PaginatedMentorList.ts +12 -0
  400. package/src/models/PaginatedModerationLogList.ts +12 -0
  401. package/src/models/PaginatedPeriodicAgentList.ts +12 -0
  402. package/src/models/PaginatedPeriodicAgentLogList.ts +12 -0
  403. package/src/models/PaginatedPlayWrightScriptList.ts +12 -0
  404. package/src/models/PaginatedSectionList.ts +12 -0
  405. package/src/models/PaginatedSubSectionList.ts +12 -0
  406. package/src/models/PaginatedTopicStatisticsResponse.ts +12 -0
  407. package/src/models/PaginatedUnitList.ts +12 -0
  408. package/src/models/PaginatedUserEdxMemoryList.ts +12 -0
  409. package/src/models/PaginatedVoiceList.ts +12 -0
  410. package/src/models/PatchedConversations.ts +33 -0
  411. package/src/models/PatchedCourseCreationTaskFile.ts +12 -0
  412. package/src/models/PatchedCredentialRequest.ts +19 -0
  413. package/src/models/PatchedLLMCredentialRequest.ts +19 -0
  414. package/src/models/PatchedMentorCategoryGroupCreate.ts +16 -0
  415. package/src/models/PatchedMentorCreate.ts +79 -0
  416. package/src/models/PatchedNotification.ts +2 -2
  417. package/src/models/PatchedPeriodicAgentCreate.ts +46 -0
  418. package/src/models/PatchedPlayWrightScript.ts +17 -0
  419. package/src/models/PatchedPrompt.ts +27 -0
  420. package/src/models/PatchedSection.ts +14 -0
  421. package/src/models/PatchedSubSection.ts +14 -0
  422. package/src/models/PatchedUnit.ts +16 -0
  423. package/src/models/PeriodicAgent.ts +47 -0
  424. package/src/models/PeriodicAgentCreate.ts +46 -0
  425. package/src/models/PeriodicAgentLog.ts +16 -0
  426. package/src/models/PeriodicAgentLogStatusEnum.ts +14 -0
  427. package/src/models/PeriodicTask.ts +26 -0
  428. package/src/models/PieChartData.ts +10 -0
  429. package/src/models/PieChartSegment.ts +9 -0
  430. package/src/models/PinnedMessageCreate.ts +14 -0
  431. package/src/models/PinnedMessageGet.ts +12 -0
  432. package/src/models/PinnedMessageRequest.ts +11 -0
  433. package/src/models/PlayWrightScript.ts +17 -0
  434. package/src/models/PredictiveAnalyticsRequest.ts +9 -0
  435. package/src/models/PredictiveAnalyticsResponse.ts +9 -0
  436. package/src/models/PreviousAgentStatusEnum.ts +16 -0
  437. package/src/models/Prompt.ts +27 -0
  438. package/src/models/PromptCategory.ts +12 -0
  439. package/src/models/PromptVisibilityEnum.ts +14 -0
  440. package/src/models/ProviderEnum.ts +14 -0
  441. package/src/models/QuestionCardTag.ts +13 -0
  442. package/src/models/QuestionRequest.ts +20 -0
  443. package/src/models/QuestionResponse.ts +15 -0
  444. package/src/models/RatingEnum.ts +12 -0
  445. package/src/models/RatingRecord.ts +9 -0
  446. package/src/models/RecentlyAccessedMentor.ts +13 -0
  447. package/src/models/RecommendCourseBlock.ts +8 -0
  448. package/src/models/RecommendCourseResponse.ts +8 -0
  449. package/src/models/RelatedText.ts +8 -0
  450. package/src/models/RequestDataVariable.ts +19 -0
  451. package/src/models/ResourceScrappedData.ts +18 -0
  452. package/src/models/ResourceScrappedDataStatusEnum.ts +16 -0
  453. package/src/models/ResponseDataVariable.ts +19 -0
  454. package/src/models/RetreiverTrainViewRequest.ts +15 -0
  455. package/src/models/RetreiverTrainViewResponse.ts +11 -0
  456. package/src/models/RetrieveTask.ts +8 -0
  457. package/src/models/RetrieverDocumentEmbedding.ts +22 -0
  458. package/src/models/RetrieverDocumentEmbeddingRequest.ts +35 -0
  459. package/src/models/RetrieverRequestSearch.ts +15 -0
  460. package/src/models/RetrieverRequestSearchDocument.ts +15 -0
  461. package/src/models/RetrieverResponseSearch.ts +12 -0
  462. package/src/models/ReuestDataVariableList.ts +9 -0
  463. package/src/models/RunMentorEval.ts +8 -0
  464. package/src/models/ScanWebhookRequest.ts +11 -0
  465. package/src/models/ScanWebhookResponse.ts +8 -0
  466. package/src/models/Section.ts +14 -0
  467. package/src/models/SectionWithChildren.ts +16 -0
  468. package/src/models/SeedMentorsView.ts +8 -0
  469. package/src/models/SentimentSummary.ts +9 -0
  470. package/src/models/SessionBrowserScreenshot.ts +13 -0
  471. package/src/models/SessionDetail.ts +11 -0
  472. package/src/models/SessionMemoryStorage.ts +11 -0
  473. package/src/models/ShellLogs.ts +8 -0
  474. package/src/models/SpacedRepetitionLearningPath.ts +8 -0
  475. package/src/models/SpacedRepetitionQuestionStats.ts +10 -0
  476. package/src/models/StarMentor.ts +12 -0
  477. package/src/models/Status6eeEnum.ts +16 -0
  478. package/src/models/Step.ts +14 -0
  479. package/src/models/StepStatusEnum.ts +14 -0
  480. package/src/models/StudentChatMessage.ts +9 -0
  481. package/src/models/StylesView.ts +9 -0
  482. package/src/models/SubSection.ts +14 -0
  483. package/src/models/SubSectionWithChildren.ts +16 -0
  484. package/src/models/TagsView.ts +10 -0
  485. package/src/models/TargetSystemEnum.ts +12 -0
  486. package/src/models/TaskView.ts +8 -0
  487. package/src/models/TemplateMentor.ts +14 -0
  488. package/src/models/TenantMentorTraces.ts +11 -0
  489. package/src/models/ThemeEnum.ts +12 -0
  490. package/src/models/TonesView.ts +9 -0
  491. package/src/models/ToolResponse.ts +14 -0
  492. package/src/models/TopicModel.ts +8 -0
  493. package/src/models/TopicRecord.ts +9 -0
  494. package/src/models/TopicStatistics.ts +12 -0
  495. package/src/models/TopicStatisticsResponse.ts +11 -0
  496. package/src/models/TopicSummaryView.ts +9 -0
  497. package/src/models/TrainChatSessionDocumentView.ts +11 -0
  498. package/src/models/TrainChatSessionDocumentViewRequest.ts +11 -0
  499. package/src/models/TrainDocumentViewRequest.ts +47 -0
  500. package/src/models/TrainDocumentViewResponse.ts +19 -0
  501. package/src/models/TrainingStatusEnum.ts +16 -0
  502. package/src/models/TrendEntry.ts +9 -0
  503. package/src/models/TriggerRequest.ts +10 -0
  504. package/src/models/TriggerResponse.ts +11 -0
  505. package/src/models/TypeC42Enum.ts +12 -0
  506. package/src/models/Unit.ts +16 -0
  507. package/src/models/UnitWithChildren.ts +18 -0
  508. package/src/models/UseMainCreds.ts +8 -0
  509. package/src/models/UserAllChatMemoryView.ts +12 -0
  510. package/src/models/UserCatalogItemMemoryView.ts +19 -0
  511. package/src/models/UserChatByPeriod.ts +9 -0
  512. package/src/models/UserChatFeedback.ts +19 -0
  513. package/src/models/UserChatFeedbackCount.ts +9 -0
  514. package/src/models/UserChatMemoryStatusRequestView.ts +11 -0
  515. package/src/models/UserChatMemoryStatusView.ts +11 -0
  516. package/src/models/UserChatMemoryUpdateView.ts +15 -0
  517. package/src/models/UserCountRecord.ts +9 -0
  518. package/src/models/UserEdxMemory.ts +20 -0
  519. package/src/models/UserMemoryContextRequest.ts +18 -0
  520. package/src/models/UserMemoryContextResponse.ts +17 -0
  521. package/src/models/UserMetric.ts +9 -0
  522. package/src/models/UserMetricsResponse.ts +12 -0
  523. package/src/models/UserSentimentCountView.ts +9 -0
  524. package/src/models/UserTrendByPeriod.ts +10 -0
  525. package/src/models/VectorResult.ts +13 -0
  526. package/src/models/Voice.ts +14 -0
  527. package/src/models/WebResource.ts +14 -0
  528. package/src/models/WebResourceCard.ts +12 -0
  529. package/src/models/WebResourcesQuery.ts +8 -0
  530. package/src/services/AiAccountService.ts +479 -0
  531. package/src/services/AiAnalyticsService.ts +1923 -0
  532. package/src/services/AiIndexService.ts +598 -0
  533. package/src/services/AiMarketingService.ts +87 -0
  534. package/src/services/AiMentorService.ts +7678 -0
  535. package/src/services/AiPromptService.ts +1676 -0
  536. package/src/services/SearchService.ts +761 -286
@@ -7,303 +7,778 @@ import { OpenAPI } from '../core/OpenAPI';
7
7
  import { request as __request } from '../core/request';
8
8
  export class SearchService {
9
9
  /**
10
- * Search and filter content across the learning catalog.
11
- *
12
- * This endpoint provides a powerful search interface for discovering content across
13
- * multiple content types (courses, programs, pathways, skills, roles, resources).
14
- * It supports full-text search, faceted filtering, and pagination.
10
+ * Legacy endpoint for backward compatible mentor search
11
+ * @param audience Filter by target audience
12
+ * @param category Filter by mentor category
13
+ * @param createdBy Filter mentors created by specific user
14
+ * @param filterFacet If present, return only facets without results
15
+ * @param id Retrieve a specific mentor by ID
16
+ * @param limit Number of results per page
17
+ * @param llm Filter by language model type
18
+ * @param offset Starting position for pagination
19
+ * @param orderBy Field to sort results by ('created_at', 'recently_accessed_at')
20
+ * @param orderDirection Sort direction ('asc' or 'desc')
21
+ * @param page Page number (1-based, used with page_size)
22
+ * @param pageSize Number of results per page
23
+ * @param query Search term to filter mentors by name or description
24
+ * @param tags Filter by tags
25
+ * @param tenant Filter by tenant/organization
26
+ * @param uniqueId Retrieve a specific mentor by UUID
27
+ * @returns any
28
+ * @throws ApiError
29
+ */
30
+ public static searchAiSearchRetrieve(
31
+ audience?: Array<string>,
32
+ category?: Array<string>,
33
+ createdBy?: string,
34
+ filterFacet: boolean = false,
35
+ id?: number,
36
+ limit: number = 12,
37
+ llm?: Array<string>,
38
+ offset?: number,
39
+ orderBy?: string,
40
+ orderDirection: string = 'desc',
41
+ page?: number,
42
+ pageSize?: number,
43
+ query?: string,
44
+ tags?: Array<string>,
45
+ tenant?: string,
46
+ uniqueId?: string,
47
+ ): CancelablePromise<Record<string, any>> {
48
+ return __request(OpenAPI, {
49
+ method: 'GET',
50
+ url: '/api/search/ai-search/',
51
+ query: {
52
+ 'audience': audience,
53
+ 'category': category,
54
+ 'created_by': createdBy,
55
+ 'filter_facet': filterFacet,
56
+ 'id': id,
57
+ 'limit': limit,
58
+ 'llm': llm,
59
+ 'offset': offset,
60
+ 'order_by': orderBy,
61
+ 'order_direction': orderDirection,
62
+ 'page': page,
63
+ 'page_size': pageSize,
64
+ 'query': query,
65
+ 'tags': tags,
66
+ 'tenant': tenant,
67
+ 'unique_id': uniqueId,
68
+ },
69
+ });
70
+ }
71
+ /**
72
+ * Search and filter content across the learning catalog
73
+ * @param allowSkillSearch Enable skill-based search
74
+ * @param alphabetical Sort alphabetically by name
75
+ * @param certificate Filter by certificate type
76
+ * @param content Content types to include in results
77
+ * @param courseId Filter by specific course ID
78
+ * @param duration Filter by course duration range
79
+ * @param language Filter by content language
80
+ * @param level Filter by difficulty level
81
+ * @param limit Number of results per page
82
+ * @param offset Starting position for pagination
83
+ * @param orderAscending Sort direction
84
+ * @param orderBy Field to sort results by
85
+ * @param pathwayId Filter by specific pathway ID
86
+ * @param price Filter by price/audit status
87
+ * @param programId Filter by specific program ID
88
+ * @param programType Filter by program type
89
+ * @param promotion Filter by promotion status
90
+ * @param query Search term to filter content by name or description
91
+ * @param resourceType Filter by resource type
92
+ * @param returnFacet Include facet data in response
93
+ * @param returnItems Include items in programs/pathways
94
+ * @param selfPaced Filter by course format
95
+ * @param skillId Filter by specific skill ID
96
+ * @param skills Filter by skills
97
+ * @param subject Filter by subject areas
98
+ * @param tags Filter by tags
99
+ * @param tenant Filter by tenant/organization
100
+ * @param topics Filter by topic areas
101
+ * @param updateFacet Force facet update
102
+ * @returns any
103
+ * @throws ApiError
104
+ */
105
+ public static searchCatalogRetrieve(
106
+ allowSkillSearch: boolean = false,
107
+ alphabetical: boolean = false,
108
+ certificate?: Array<string>,
109
+ content?: Array<string>,
110
+ courseId?: string,
111
+ duration?: Array<string>,
112
+ language?: Array<string>,
113
+ level?: Array<string>,
114
+ limit: number = 12,
115
+ offset?: number,
116
+ orderAscending: boolean = false,
117
+ orderBy?: string,
118
+ pathwayId?: string,
119
+ price?: string,
120
+ programId?: string,
121
+ programType?: Array<string>,
122
+ promotion?: Array<string>,
123
+ query?: string,
124
+ resourceType?: Array<string>,
125
+ returnFacet: boolean = true,
126
+ returnItems: boolean = false,
127
+ selfPaced?: Array<string>,
128
+ skillId?: string,
129
+ skills?: Array<string>,
130
+ subject?: Array<string>,
131
+ tags?: Array<string>,
132
+ tenant?: Array<string>,
133
+ topics?: Array<string>,
134
+ updateFacet?: string,
135
+ ): CancelablePromise<Record<string, any>> {
136
+ return __request(OpenAPI, {
137
+ method: 'GET',
138
+ url: '/api/search/catalog/',
139
+ query: {
140
+ 'allow_skill_search': allowSkillSearch,
141
+ 'alphabetical': alphabetical,
142
+ 'certificate': certificate,
143
+ 'content': content,
144
+ 'course_id': courseId,
145
+ 'duration': duration,
146
+ 'language': language,
147
+ 'level': level,
148
+ 'limit': limit,
149
+ 'offset': offset,
150
+ 'order_ascending': orderAscending,
151
+ 'order_by': orderBy,
152
+ 'pathway_id': pathwayId,
153
+ 'price': price,
154
+ 'program_id': programId,
155
+ 'program_type': programType,
156
+ 'promotion': promotion,
157
+ 'query': query,
158
+ 'resource_type': resourceType,
159
+ 'return_facet': returnFacet,
160
+ 'return_items': returnItems,
161
+ 'self_paced': selfPaced,
162
+ 'skill_id': skillId,
163
+ 'skills': skills,
164
+ 'subject': subject,
165
+ 'tags': tags,
166
+ 'tenant': tenant,
167
+ 'topics': topics,
168
+ 'update_facet': updateFacet,
169
+ },
170
+ });
171
+ }
172
+ /**
173
+ * Get AI mentors based on search criteria
174
+ * @param audience Filter by target audience
175
+ * @param category Filter by mentor category
176
+ * @param createdBy Filter mentors created by specific user
177
+ * @param id Retrieve a specific mentor by ID
178
+ * @param limit Number of results per page
179
+ * @param llm Filter by language model type
180
+ * @param offset Starting position for pagination
181
+ * @param orderBy Field to sort results by ('created_at', 'recently_accessed_at')
182
+ * @param orderDirection Sort direction ('asc' or 'desc')
183
+ * @param query Search term to filter mentors by name or description
184
+ * @param tags Filter by tags
185
+ * @param tenant Filter by tenant/organization
186
+ * @param uniqueId Retrieve a specific mentor by UUID
187
+ * @returns any
188
+ * @throws ApiError
189
+ */
190
+ public static searchMentorsRetrieve(
191
+ audience?: Array<string>,
192
+ category?: Array<string>,
193
+ createdBy?: string,
194
+ id?: number,
195
+ limit: number = 12,
196
+ llm?: Array<string>,
197
+ offset?: number,
198
+ orderBy?: string,
199
+ orderDirection: string = 'desc',
200
+ query?: string,
201
+ tags?: Array<string>,
202
+ tenant?: string,
203
+ uniqueId?: string,
204
+ ): CancelablePromise<Record<string, any>> {
205
+ return __request(OpenAPI, {
206
+ method: 'GET',
207
+ url: '/api/search/mentors/',
208
+ query: {
209
+ 'audience': audience,
210
+ 'category': category,
211
+ 'created_by': createdBy,
212
+ 'id': id,
213
+ 'limit': limit,
214
+ 'llm': llm,
215
+ 'offset': offset,
216
+ 'order_by': orderBy,
217
+ 'order_direction': orderDirection,
218
+ 'query': query,
219
+ 'tags': tags,
220
+ 'tenant': tenant,
221
+ 'unique_id': uniqueId,
222
+ },
223
+ });
224
+ }
225
+ /**
226
+ * Search and filter documents associated with a specific mentor.
15
227
  *
16
- * Query Parameters:
17
- * query (str, optional): Search term to filter content by name or description
18
- * content (list, optional): Content types to include in results
19
- * (courses, programs, pathways, skills, roles, resources)
20
- * Default: ["programs", "courses", "pathways", "skills"]
228
+ * This endpoint allows searching and filtering documents that are linked to a
229
+ * particular mentor, with support for pagination, sorting, and faceted filtering.
21
230
  *
22
- * # Filtering parameters
23
- * course_id (str, optional): Filter by specific course ID
24
- * program_id (str, optional): Filter by specific program ID
25
- * pathway_id (str, optional): Filter by specific pathway ID
26
- * skill_id (str, optional): Filter by specific skill ID
27
- * subject (list, optional): Filter by subject areas
28
- * tenant (list, optional): Filter by tenant/organization
29
- * topics (list, optional): Filter by topic areas
30
- * tags (list, optional): Filter by tags
31
- * level (list, optional): Filter by difficulty level
32
- * self_paced (list, optional): Filter by course format (self-paced, instructor-led)
33
- * promotion (list, optional): Filter by promotion status
34
- * language (list, optional): Filter by content language
35
- * certificate (list, optional): Filter by certificate type
36
- * program_type (list, optional): Filter by program type
37
- * duration (list, optional): Filter by course duration range
38
- * price (str, optional): Filter by price/audit status
39
- * resource_type (list, optional): Filter by resource type
40
- * skills (list, optional): Filter by skills
231
+ * Path Parameters:
232
+ * mentor_unique_id (uuid): The unique identifier of the mentor
41
233
  *
42
- * # Sorting and pagination
43
- * order_by (str, optional): Field to sort results by
44
- * order_ascending (bool, optional): Sort direction (default: false)
45
- * alphabetical (bool, optional): Sort alphabetically by name (default: false)
234
+ * Query Parameters:
235
+ * query (str, optional): Search term to filter documents by name or content
236
+ * document_type (str, optional): Filter by document type (e.g., 'pdf', 'text')
237
+ * access (str, optional): Filter by access level (e.g., 'public', 'private')
238
+ * training_status (str, optional): Filter by training status (e.g., 'trained', 'pending')
239
+ * platform_key (str, optional): Filter by platform key
240
+ * order_by (str, optional): Field to sort results by ('date_created', 'last_modified', 'document_name')
241
+ * order_direction (str, optional): Sort direction ('asc' or 'desc', default: 'desc')
46
242
  * limit (int, optional): Number of results per page (default: 12, max: 100)
47
243
  * offset (int, optional): Starting position for pagination
48
244
  *
49
- * # Response options
50
- * return_facet (bool, optional): Include facet data in response (default: true)
51
- * return_items (bool, optional): Include items in programs/pathways (default: false)
52
- * allow_skill_search (bool, optional): Enable skill-based search (default: false)
53
- * update_facet (str, optional): Force facet update
54
- *
55
245
  * Returns:
56
246
  * A JSON response containing:
57
- * - results: List of content items with metadata
58
- * - count: Total number of matching items
59
- * - next: URL for the next page of results (if available)
60
- * - previous: URL for the previous page of results (if available)
61
- * - current_page: Current page number
62
- * - total_pages: Total number of pages
63
- * - facets: Aggregated counts for each filter category (if requested)
64
- *
65
- * Each content item contains type-specific fields:
66
- * - Courses:
67
247
  * {
68
- * "id": 123,
69
- * "type": "course",
70
- * "course_id": "CS101",
71
- * "name": "Introduction to Computer Science",
72
- * "description": "Learn the fundamentals of computer science",
73
- * "short_description": "CS fundamentals",
74
- * "image_url": "https://example.com/images/cs101.jpg",
75
- * "level": "Beginner",
76
- * "subject": "Computer Science",
77
- * "topics": ["Programming", "Algorithms"],
78
- * "tags": ["python", "coding"],
79
- * "language": "English",
80
- * "tenant": "example-university",
81
- * "self_paced": true,
82
- * "duration": "6 weeks",
83
- * "certificate": "Professional Certificate",
84
- * "price": "Free",
85
- * "skills": [
86
- * {"id": 1, "name": "Python Programming"},
87
- * {"id": 2, "name": "Algorithms"}
88
- * ],
89
- * "url": "https://example.com/courses/cs101"
90
- * }
91
- *
92
- * - Programs:
248
+ * "results": [
93
249
  * {
94
- * "id": 456,
95
- * "type": "program",
96
- * "program_id": "PROG123",
97
- * "name": "Data Science Program",
98
- * "description": "Comprehensive data science curriculum",
99
- * "short_description": "Learn data science",
100
- * "image_url": "https://example.com/images/datascience.jpg",
101
- * "level": "Intermediate",
102
- * "subject": "Data Science",
103
- * "topics": ["Machine Learning", "Statistics"],
104
- * "program_type": "Professional Certificate",
105
- * "courses": [
106
- * {"id": 123, "name": "Introduction to Python"},
107
- * {"id": 124, "name": "Statistics for Data Science"}
108
- * ],
109
- * "url": "https://example.com/programs/prog123"
250
+ * "id": 789,
251
+ * "document_name": "Introduction to Algorithms.pdf",
252
+ * "document_type": "pdf",
253
+ * "access": "public",
254
+ * "training_status": "trained",
255
+ * "date_created": "2023-03-15T10:30:00Z",
256
+ * "last_modified": "2023-04-20T14:45:00Z",
257
+ * "url": "https://example.com/documents/intro-algorithms.pdf",
258
+ * "metadata": {
259
+ * "page_count": 45,
260
+ * "author": "John Smith",
261
+ * "keywords": ["algorithms", "computer science", "data structures"],
262
+ * "description": "Comprehensive introduction to fundamental algorithms"
110
263
  * }
111
- *
112
- * - Pathways:
113
- * {
114
- * "id": 789,
115
- * "type": "pathway",
116
- * "pathway_id": "PATH456",
117
- * "name": "Software Engineering Career Path",
118
- * "description": "Complete pathway to become a software engineer",
119
- * "image_url": "https://example.com/images/swe-path.jpg",
120
- * "programs": [
121
- * {"id": 456, "name": "Programming Fundamentals"},
122
- * {"id": 457, "name": "Web Development"}
264
+ * },
265
+ * // Additional document objects...
266
+ * ],
267
+ * "count": 25,
268
+ * "next": "https://api.example.com/api/search/mentors/550e8400-e29b-41d4-a716-446655440000/documents/?limit=12&offset=12",
269
+ * "previous": null,
270
+ * "current_page": 1,
271
+ * "total_pages": 3,
272
+ * "facets": {
273
+ * "document_type": [
274
+ * {"key": "pdf", "doc_count": 15},
275
+ * {"key": "text", "doc_count": 5},
276
+ * {"key": "docx", "doc_count": 5}
123
277
  * ],
124
- * "url": "https://example.com/pathways/path456"
125
- * }
126
- *
127
- * - Skills:
128
- * {
129
- * "id": 321,
130
- * "type": "skill",
131
- * "name": "Machine Learning",
132
- * "description": "Building systems that learn from data",
133
- * "courses": [
134
- * {"id": 125, "name": "Machine Learning Fundamentals"}
135
- * ],
136
- * "related_skills": [
137
- * {"id": 322, "name": "Deep Learning"}
138
- * ]
139
- * }
140
- *
141
- * - Roles:
142
- * {
143
- * "id": 654,
144
- * "type": "role",
145
- * "name": "Data Scientist",
146
- * "description": "Professional who analyzes and interprets complex data",
147
- * "skills": [
148
- * {"id": 321, "name": "Machine Learning"},
149
- * {"id": 323, "name": "Data Analysis"}
150
- * ],
151
- * "recommended_courses": [
152
- * {"id": 125, "name": "Machine Learning Fundamentals"}
153
- * ]
154
- * }
155
- *
156
- * - Resources:
157
- * {
158
- * "id": 987,
159
- * "type": "resource",
160
- * "name": "Python Cheat Sheet",
161
- * "description": "Quick reference guide for Python",
162
- * "resource_type": "PDF",
163
- * "url": "https://example.com/resources/python-cheatsheet.pdf",
164
- * "topics": ["Programming", "Python"]
165
- * }
166
- *
167
- * Error Responses:
168
- * 500 Internal Server Error: If an unexpected error occurs during processing
169
- *
170
- * Notes:
171
- * - Results are cached for performance
172
- * - The 'resources' content type is only included by default if IBL_ENABLE_RESOURCES_IN_FACET is true
173
- * - For debugging, add ?debug=true to see detailed information about skill matching
174
- * @returns any No response body
175
- * @throws ApiError
176
- */
177
- public static searchCatalogRetrieve(): CancelablePromise<any> {
178
- return __request(OpenAPI, {
179
- method: 'GET',
180
- url: '/api/search/catalog/',
181
- });
182
- }
183
- /**
184
- * Determine whether to serve a detail view or a list view.
185
- * If any detail-identifying parameters are present (course_id, program_id, etc.)
186
- * the detail view is returned; otherwise the aggregated list view is returned.
187
- * @param username
188
- * @returns any No response body
189
- * @throws ApiError
190
- */
191
- public static searchPersonalizedCatalogRetrieve(
192
- username: string,
193
- ): CancelablePromise<any> {
194
- return __request(OpenAPI, {
195
- method: 'GET',
196
- url: '/api/search/personalized-catalog/{username}/',
197
- path: {
198
- 'username': username,
199
- },
200
- });
201
- }
202
- /**
203
- * Search and filter users within a specific organization/tenant.
204
- *
205
- * This endpoint provides a search interface for discovering users within an organization,
206
- * with support for filtering by departments, pagination, and faceted filtering.
207
- *
208
- * Path Parameters:
209
- * org (str): The organization/tenant identifier
210
- * username (str): The username of the user making the request
211
- *
212
- * Query Parameters:
213
- * # Search parameters
214
- * query (str, optional): Search term to filter users by name, username, or email
215
- *
216
- * # Department filtering
217
- * department_mode (bool, optional): Enable department-based filtering (default: false)
218
- * user_department (bool, optional): Legacy parameter for department_mode (default: false)
219
- * department (list, optional): Filter by specific departments
220
- *
221
- * # Additional filters
222
- * role (list, optional): Filter by user role
223
- * status (list, optional): Filter by user status (active, inactive)
224
- * joined_date (list, optional): Filter by join date range
225
- * last_login (list, optional): Filter by last login date range
226
- *
227
- * # Pagination
228
- * limit (int, optional): Number of results per page (default: 10)
229
- * offset (int, optional): Starting position for pagination
230
- *
231
- * Returns:
232
- * A JSON response containing:
233
- * ```
278
+ * "access": [
279
+ * {"key": "public", "doc_count": 20},
280
+ * {"key": "private", "doc_count": 5}
281
+ * ],
282
+ * "training_status": [
283
+ * {"key": "trained", "doc_count": 18},
284
+ * {"key": "pending", "doc_count": 5},
285
+ * {"key": "failed", "doc_count": 2}
286
+ * ]
287
+ * }
288
+ * }
289
+ *
290
+ * Error Responses:
291
+ * 400 Bad Request: If the request parameters are invalid
292
+ * 404 Not Found: If the mentor doesn't exist
293
+ * 500 Internal Server Error: If an unexpected error occurs during processing
294
+ *
295
+ * Access Control:
296
+ * - Requires platform membership
297
+ * - Only documents associated with the specified mentor are returned
298
+ * - Access level filtering respects user permissions
299
+ * @param mentorUniqueId
300
+ * @returns any No response body
301
+ * @throws ApiError
302
+ */
303
+ public static searchMentorsDocumentsRetrieve(
304
+ mentorUniqueId: string,
305
+ ): CancelablePromise<any> {
306
+ return __request(OpenAPI, {
307
+ method: 'GET',
308
+ url: '/api/search/mentors/{mentor_unique_id}/documents/',
309
+ path: {
310
+ 'mentor_unique_id': mentorUniqueId,
311
+ },
312
+ });
313
+ }
314
+ /**
315
+ * Get AI mentors for a specific tenant and user
316
+ * @param org
317
+ * @param username
318
+ * @param audience Filter by target audience
319
+ * @param category Filter by mentor category
320
+ * @param createdBy Filter mentors created by specific user
321
+ * @param id Retrieve a specific mentor by ID
322
+ * @param limit Number of results per page
323
+ * @param llm Filter by language model type
324
+ * @param offset Starting position for pagination
325
+ * @param orderBy Field to sort results by ('created_at', 'recently_accessed_at')
326
+ * @param orderDirection Sort direction ('asc' or 'desc')
327
+ * @param query Search term to filter mentors by name or description
328
+ * @param tags Filter by tags
329
+ * @param tenant Filter by tenant/organization
330
+ * @param uniqueId Retrieve a specific mentor by UUID
331
+ * @returns any
332
+ * @throws ApiError
333
+ */
334
+ public static searchOrgsUsersMentorsRetrieve(
335
+ org: string,
336
+ username: string,
337
+ audience?: Array<string>,
338
+ category?: Array<string>,
339
+ createdBy?: string,
340
+ id?: number,
341
+ limit: number = 12,
342
+ llm?: Array<string>,
343
+ offset?: number,
344
+ orderBy?: string,
345
+ orderDirection: string = 'desc',
346
+ query?: string,
347
+ tags?: Array<string>,
348
+ tenant?: string,
349
+ uniqueId?: string,
350
+ ): CancelablePromise<Record<string, any>> {
351
+ return __request(OpenAPI, {
352
+ method: 'GET',
353
+ url: '/api/search/orgs/{org}/users/{username}/mentors/',
354
+ path: {
355
+ 'org': org,
356
+ 'username': username,
357
+ },
358
+ query: {
359
+ 'audience': audience,
360
+ 'category': category,
361
+ 'created_by': createdBy,
362
+ 'id': id,
363
+ 'limit': limit,
364
+ 'llm': llm,
365
+ 'offset': offset,
366
+ 'order_by': orderBy,
367
+ 'order_direction': orderDirection,
368
+ 'query': query,
369
+ 'tags': tags,
370
+ 'tenant': tenant,
371
+ 'unique_id': uniqueId,
372
+ },
373
+ });
374
+ }
375
+ /**
376
+ * Search and filter AI prompts for a specific user within a tenant.
377
+ *
378
+ * This endpoint extends the base prompt search functionality but filters results
379
+ * to only show prompts that are available to a specific user within a specific
380
+ * organization/tenant.
381
+ *
382
+ * Path Parameters:
383
+ * org (str): The organization/tenant identifier
384
+ * username (str): The username to filter prompts for
385
+ *
386
+ * Query Parameters:
387
+ * Same as PromptSearchView, plus:
388
+ *
389
+ * # Identification parameters (for detail view)
390
+ * id (int, optional): Retrieve a specific prompt by ID
391
+ *
392
+ * Returns:
393
+ * Same format as PromptSearchView, but filtered to only include prompts
394
+ * that the specified user has access to within the specified organization.
395
+ *
396
+ * Error Responses:
397
+ * 400 Bad Request: If the request parameters are invalid
398
+ * 403 Forbidden: If the requested prompt exists but the user doesn't have access
399
+ * 404 Not Found: If the requested prompt doesn't exist
400
+ * 500 Internal Server Error: If an unexpected error occurs
401
+ *
402
+ * Access Control:
403
+ * - Results are filtered based on user's permissions within the organization
404
+ * - Private prompts are only visible to authorized users
405
+ * @param org
406
+ * @param username
407
+ * @returns any No response body
408
+ * @throws ApiError
409
+ */
410
+ public static searchOrgsUsersPromptsRetrieve(
411
+ org: string,
412
+ username: string,
413
+ ): CancelablePromise<any> {
414
+ return __request(OpenAPI, {
415
+ method: 'GET',
416
+ url: '/api/search/orgs/{org}/users/{username}/prompts/',
417
+ path: {
418
+ 'org': org,
419
+ 'username': username,
420
+ },
421
+ });
422
+ }
423
+ /**
424
+ * Determine whether to serve a detail view or a list view.
425
+ * @param org
426
+ * @param username
427
+ * @returns any No response body
428
+ * @throws ApiError
429
+ */
430
+ public static searchOrgsUsersRecommendedRetrieve(
431
+ org: string,
432
+ username: string,
433
+ ): CancelablePromise<any> {
434
+ return __request(OpenAPI, {
435
+ method: 'GET',
436
+ url: '/api/search/orgs/{org}/users/{username}/recommended/',
437
+ path: {
438
+ 'org': org,
439
+ 'username': username,
440
+ },
441
+ });
442
+ }
443
+ /**
444
+ * Get personalized content for a specific user
445
+ * @param username
446
+ * @param allowSkillSearch Enable skill-based search
447
+ * @param alphabetical Sort alphabetically by name
448
+ * @param certificate Filter by certificate type
449
+ * @param content Content types to include in results
450
+ * @param courseId Retrieve a specific course by ID
451
+ * @param duration Filter by course duration range
452
+ * @param language Filter by content language
453
+ * @param level Filter by difficulty level
454
+ * @param limit Number of results per page
455
+ * @param offset Starting position for pagination
456
+ * @param orderAscending Sort direction
457
+ * @param orderBy Field to sort results by
458
+ * @param pathwayId Retrieve a specific pathway by ID
459
+ * @param price Filter by price/audit status
460
+ * @param programId Retrieve a specific program by ID
461
+ * @param programType Filter by program type
462
+ * @param promotion Filter by promotion status
463
+ * @param query Search term to filter content by name or description
464
+ * @param recommended Show only recommended content
465
+ * @param resourceId Retrieve a specific resource by ID
466
+ * @param resourceType Filter by resource type
467
+ * @param returnFacet Include facet data in response
468
+ * @param returnItems Include items in programs/pathways
469
+ * @param roleId Retrieve a specific role by ID
470
+ * @param selfPaced Filter by course format
471
+ * @param skillId Retrieve a specific skill by ID
472
+ * @param skills Filter by skills
473
+ * @param subject Filter by subject areas
474
+ * @param tags Filter by tags
475
+ * @param tenant Filter by tenant/organization
476
+ * @param topics Filter by topic areas
477
+ * @param updateFacet Force facet update
478
+ * @returns any
479
+ * @throws ApiError
480
+ */
481
+ public static searchPersonalizedCatalogRetrieve(
482
+ username: string,
483
+ allowSkillSearch: boolean = false,
484
+ alphabetical: boolean = false,
485
+ certificate?: Array<string>,
486
+ content?: Array<string>,
487
+ courseId?: string,
488
+ duration?: Array<string>,
489
+ language?: Array<string>,
490
+ level?: Array<string>,
491
+ limit: number = 12,
492
+ offset?: number,
493
+ orderAscending: boolean = false,
494
+ orderBy?: string,
495
+ pathwayId?: string,
496
+ price?: string,
497
+ programId?: string,
498
+ programType?: Array<string>,
499
+ promotion?: Array<string>,
500
+ query?: string,
501
+ recommended: boolean = false,
502
+ resourceId?: string,
503
+ resourceType?: Array<string>,
504
+ returnFacet: boolean = true,
505
+ returnItems: boolean = false,
506
+ roleId?: string,
507
+ selfPaced?: Array<string>,
508
+ skillId?: string,
509
+ skills?: Array<string>,
510
+ subject?: Array<string>,
511
+ tags?: Array<string>,
512
+ tenant?: Array<string>,
513
+ topics?: Array<string>,
514
+ updateFacet?: string,
515
+ ): CancelablePromise<Record<string, any>> {
516
+ return __request(OpenAPI, {
517
+ method: 'GET',
518
+ url: '/api/search/personalized-catalog/{username}/',
519
+ path: {
520
+ 'username': username,
521
+ },
522
+ query: {
523
+ 'allow_skill_search': allowSkillSearch,
524
+ 'alphabetical': alphabetical,
525
+ 'certificate': certificate,
526
+ 'content': content,
527
+ 'course_id': courseId,
528
+ 'duration': duration,
529
+ 'language': language,
530
+ 'level': level,
531
+ 'limit': limit,
532
+ 'offset': offset,
533
+ 'order_ascending': orderAscending,
534
+ 'order_by': orderBy,
535
+ 'pathway_id': pathwayId,
536
+ 'price': price,
537
+ 'program_id': programId,
538
+ 'program_type': programType,
539
+ 'promotion': promotion,
540
+ 'query': query,
541
+ 'recommended': recommended,
542
+ 'resource_id': resourceId,
543
+ 'resource_type': resourceType,
544
+ 'return_facet': returnFacet,
545
+ 'return_items': returnItems,
546
+ 'role_id': roleId,
547
+ 'self_paced': selfPaced,
548
+ 'skill_id': skillId,
549
+ 'skills': skills,
550
+ 'subject': subject,
551
+ 'tags': tags,
552
+ 'tenant': tenant,
553
+ 'topics': topics,
554
+ 'update_facet': updateFacet,
555
+ },
556
+ });
557
+ }
558
+ /**
559
+ * Search and filter AI prompts across the platform.
560
+ *
561
+ * This endpoint provides a search interface for discovering AI prompts
562
+ * with support for filtering, pagination, and detailed prompt information.
563
+ *
564
+ * Query Parameters:
565
+ * # Identification parameters (for detail view)
566
+ * id (int, optional): Retrieve a specific prompt by ID
567
+ *
568
+ * # Search and filtering parameters
569
+ * query (str, optional): Search term to filter prompts by name or content
570
+ * category (str, optional): Filter by prompt category
571
+ * language (str, optional): Filter by prompt language
572
+ * style (str, optional): Filter by writing style
573
+ * tone (str, optional): Filter by tone
574
+ * tenant (str, optional): Filter by tenant/organization
575
+ * mentor (str, optional): Filter by associated mentor (UUID)
576
+ *
577
+ * # Sorting and pagination
578
+ * sort_by (str, optional): Field to sort results by
579
+ * order_direction (str, optional): Sort direction ('asc' or 'desc', default: 'desc')
580
+ * alphabetical (bool, optional): Sort alphabetically by name (default: false)
581
+ * limit (int, optional): Number of results per page (default: 10)
582
+ * offset (int, optional): Starting position for pagination
583
+ *
584
+ * # Special parameters
585
+ * filter_facet (any, optional): If present, return only facets without results
586
+ *
587
+ * Returns:
588
+ * For detail view (when id is provided):
589
+ * A JSON response containing a single prompt's details:
590
+ * {
591
+ * "id": 456,
592
+ * "name": "Essay Writing Guide",
593
+ * "content": "Write a well-structured essay on the following topic: {{topic}}...",
594
+ * "category": "Academic Writing",
595
+ * "language": "English",
596
+ * "style": "Formal",
597
+ * "tone": "Professional",
598
+ * "mentor": {
599
+ * "id": 123,
600
+ * "unique_id": "550e8400-e29b-41d4-a716-446655440000",
601
+ * "name": "Professor Smith"
602
+ * },
603
+ * "platform": {
604
+ * "id": 1,
605
+ * "name": "Example University",
606
+ * "key": "example-university"
607
+ * },
608
+ * "created_at": "2023-02-10T09:15:00Z",
609
+ * "updated_at": "2023-05-05T14:20:00Z",
610
+ * "visibility": "public",
611
+ * "variables": ["topic", "length", "style"]
612
+ * }
613
+ *
614
+ * For list view:
615
+ * A JSON response containing:
616
+ * {
617
+ * "results": [
234
618
  * {
235
- * "results": [
236
- * {
237
- * "id": 123,
238
- * "username": "john.doe",
239
- * "email": "john.doe@example.com",
240
- * "first_name": "John",
241
- * "last_name": "Doe",
242
- * "full_name": "John Doe",
243
- * "profile_image": "https://example.com/profiles/john-doe.jpg",
244
- * "role": "Student",
245
- * "departments": ["Computer Science", "Data Science"],
246
- * "status": "active",
247
- * "joined_date": "2023-01-15T12:00:00Z",
248
- * "last_login": "2023-06-20T15:30:00Z",
249
- * "metadata": {
250
- * "location": "New York",
251
- * "title": "Software Engineer",
252
- * "bio": "Experienced software engineer with a passion for education"
253
- * }
254
- * },
255
- * // Additional user objects...
619
+ * "id": 456,
620
+ * "name": "Essay Writing Guide",
621
+ * "content": "Write a well-structured essay on the following topic: {{topic}}...",
622
+ * "category": "Academic Writing",
623
+ * "language": "English",
624
+ * "style": "Formal",
625
+ * "tone": "Professional",
626
+ * "mentor": {"id": 123, "name": "Professor Smith"},
627
+ * "created_at": "2023-02-10T09:15:00Z",
628
+ * "updated_at": "2023-05-05T14:20:00Z"
629
+ * },
630
+ * // Additional prompt objects...
631
+ * ],
632
+ * "count": 30,
633
+ * "next": "?limit=10&offset=10",
634
+ * "previous": null,
635
+ * "current_page": 1,
636
+ * "num_pages": 3,
637
+ * "facets": {
638
+ * "category": [
639
+ * {"key": "Academic Writing", "doc_count": 15},
640
+ * {"key": "Creative Writing", "doc_count": 10},
641
+ * {"key": "Technical Documentation", "doc_count": 5}
642
+ * ],
643
+ * "language": [
644
+ * {"key": "English", "doc_count": 25},
645
+ * {"key": "Spanish", "doc_count": 5}
256
646
  * ],
257
- * "count": 50,
258
- * "next": "https://api.example.com/api/search/users/example-org/admin/?limit=10&offset=10",
259
- * "previous": null,
260
- * "current_page": 1,
261
- * "total_pages": 5,
262
- * "facets": {
263
- * "role": [
264
- * {"key": "Student", "doc_count": 30},
265
- * {"key": "Instructor", "doc_count": 15},
266
- * {"key": "Admin", "doc_count": 5}
267
- * ],
268
- * "department": [
269
- * {"key": "Computer Science", "doc_count": 20},
270
- * {"key": "Data Science", "doc_count": 15},
271
- * {"key": "Business", "doc_count": 10},
272
- * {"key": "Engineering", "doc_count": 5}
273
- * ],
274
- * "status": [
275
- * {"key": "active", "doc_count": 45},
276
- * {"key": "inactive", "doc_count": 5}
277
- * ]
278
- * }
279
- * }
280
- * ```
281
- * Error Responses:
282
- * 400 Bad Request: If the request parameters are invalid
283
- * 403 Forbidden: If the user doesn't have department admin privileges (when using department_mode)
284
- * 404 Not Found: If the user or organization doesn't exist
285
- * 500 Internal Server Error: If an unexpected error occurs
286
- *
287
- * Access Control:
288
- * - The requesting user must have an active account in the specified organization
289
- * - When department_mode is enabled, the user must be an admin of at least one department
290
- * - Department filtering restricts results to users in departments where the requesting user is an admin
291
- * @param org
292
- * @param username
293
- * @returns any No response body
294
- * @throws ApiError
295
- */
296
- public static searchUsersOrgsUsersRetrieve(
297
- org: string,
298
- username: string,
299
- ): CancelablePromise<any> {
300
- return __request(OpenAPI, {
301
- method: 'GET',
302
- url: '/api/search/users/orgs/{org}/users/{username}/',
303
- path: {
304
- 'org': org,
305
- 'username': username,
306
- },
307
- });
308
- }
309
- }
647
+ * "style": [
648
+ * {"key": "Formal", "doc_count": 20},
649
+ * {"key": "Casual", "doc_count": 10}
650
+ * ],
651
+ * "tone": [
652
+ * {"key": "Professional", "doc_count": 15},
653
+ * {"key": "Friendly", "doc_count": 10},
654
+ * {"key": "Technical", "doc_count": 5}
655
+ * ]
656
+ * }
657
+ * }
658
+ *
659
+ * Error Responses:
660
+ * 400 Bad Request: If the request parameters are invalid
661
+ * 403 Forbidden: If the requested prompt exists but is not publicly available
662
+ * 404 Not Found: If the requested prompt doesn't exist
663
+ * 500 Internal Server Error: If an unexpected error occurs
664
+ *
665
+ * Notes:
666
+ * - Only publicly available prompts are returned by default
667
+ * - When filtering by mentor, the mentor ID must be a valid UUID
668
+ * @returns any No response body
669
+ * @throws ApiError
670
+ */
671
+ public static searchPromptsRetrieve(): CancelablePromise<any> {
672
+ return __request(OpenAPI, {
673
+ method: 'GET',
674
+ url: '/api/search/prompts/',
675
+ });
676
+ }
677
+ /**
678
+ * Search and filter users within a specific organization/tenant.
679
+ *
680
+ * This endpoint provides a search interface for discovering users within an organization,
681
+ * with support for filtering by departments, pagination, and faceted filtering.
682
+ *
683
+ * Path Parameters:
684
+ * org (str): The organization/tenant identifier
685
+ * username (str): The username of the user making the request
686
+ *
687
+ * Query Parameters:
688
+ * # Search parameters
689
+ * query (str, optional): Search term to filter users by name, username, or email
690
+ *
691
+ * # Department filtering
692
+ * department_mode (bool, optional): Enable department-based filtering (default: false)
693
+ * user_department (bool, optional): Legacy parameter for department_mode (default: false)
694
+ * department (list, optional): Filter by specific departments
695
+ *
696
+ * # Additional filters
697
+ * role (list, optional): Filter by user role
698
+ * status (list, optional): Filter by user status (active, inactive)
699
+ * joined_date (list, optional): Filter by join date range
700
+ * last_login (list, optional): Filter by last login date range
701
+ *
702
+ * # Pagination
703
+ * limit (int, optional): Number of results per page (default: 10)
704
+ * offset (int, optional): Starting position for pagination
705
+ *
706
+ * Returns:
707
+ * A JSON response containing:
708
+ * ```
709
+ * {
710
+ * "results": [
711
+ * {
712
+ * "id": 123,
713
+ * "username": "john.doe",
714
+ * "email": "john.doe@example.com",
715
+ * "first_name": "John",
716
+ * "last_name": "Doe",
717
+ * "full_name": "John Doe",
718
+ * "profile_image": "https://example.com/profiles/john-doe.jpg",
719
+ * "role": "Student",
720
+ * "departments": ["Computer Science", "Data Science"],
721
+ * "status": "active",
722
+ * "joined_date": "2023-01-15T12:00:00Z",
723
+ * "last_login": "2023-06-20T15:30:00Z",
724
+ * "metadata": {
725
+ * "location": "New York",
726
+ * "title": "Software Engineer",
727
+ * "bio": "Experienced software engineer with a passion for education"
728
+ * }
729
+ * },
730
+ * // Additional user objects...
731
+ * ],
732
+ * "count": 50,
733
+ * "next": "https://api.example.com/api/search/users/example-org/admin/?limit=10&offset=10",
734
+ * "previous": null,
735
+ * "current_page": 1,
736
+ * "total_pages": 5,
737
+ * "facets": {
738
+ * "role": [
739
+ * {"key": "Student", "doc_count": 30},
740
+ * {"key": "Instructor", "doc_count": 15},
741
+ * {"key": "Admin", "doc_count": 5}
742
+ * ],
743
+ * "department": [
744
+ * {"key": "Computer Science", "doc_count": 20},
745
+ * {"key": "Data Science", "doc_count": 15},
746
+ * {"key": "Business", "doc_count": 10},
747
+ * {"key": "Engineering", "doc_count": 5}
748
+ * ],
749
+ * "status": [
750
+ * {"key": "active", "doc_count": 45},
751
+ * {"key": "inactive", "doc_count": 5}
752
+ * ]
753
+ * }
754
+ * }
755
+ * ```
756
+ * Error Responses:
757
+ * 400 Bad Request: If the request parameters are invalid
758
+ * 403 Forbidden: If the user doesn't have department admin privileges (when using department_mode)
759
+ * 404 Not Found: If the user or organization doesn't exist
760
+ * 500 Internal Server Error: If an unexpected error occurs
761
+ *
762
+ * Access Control:
763
+ * - The requesting user must have an active account in the specified organization
764
+ * - When department_mode is enabled, the user must be an admin of at least one department
765
+ * - Department filtering restricts results to users in departments where the requesting user is an admin
766
+ * @param org
767
+ * @param username
768
+ * @returns any No response body
769
+ * @throws ApiError
770
+ */
771
+ public static searchUsersOrgsUsersRetrieve(
772
+ org: string,
773
+ username: string,
774
+ ): CancelablePromise<any> {
775
+ return __request(OpenAPI, {
776
+ method: 'GET',
777
+ url: '/api/search/users/orgs/{org}/users/{username}/',
778
+ path: {
779
+ 'org': org,
780
+ 'username': username,
781
+ },
782
+ });
783
+ }
784
+ }