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