@iblai/iblai-api 3.48.3-core → 3.48.4-ai-plus
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 +19644 -2773
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +19636 -2774
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +19644 -2773
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +320 -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/Bot.d.ts +15 -0
- package/dist/types/models/BotCommand.d.ts +6 -0
- package/dist/types/models/BotCreate.d.ts +12 -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/DataSet.d.ts +21 -0
- package/dist/types/models/DataSetCreate.d.ts +12 -0
- package/dist/types/models/DataSetStatusEnum.d.ts +12 -0
- package/dist/types/models/DateRange.d.ts +4 -0
- package/dist/types/models/DiscordConfig.d.ts +7 -0
- package/dist/types/models/DiscordUserConfig.d.ts +10 -0
- package/dist/types/models/DiscordWebhook.d.ts +6 -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/PaginatedDataSetList.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/PaginatedTrainingList.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/PatchedBotCommand.d.ts +6 -0
- package/dist/types/models/PatchedBotCreate.d.ts +12 -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/PatchedDataSet.d.ts +21 -0
- package/dist/types/models/PatchedDiscordConfig.d.ts +7 -0
- package/dist/types/models/PatchedDiscordUserConfig.d.ts +10 -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/PatchedSlackConfig.d.ts +8 -0
- package/dist/types/models/PatchedSlackUserConfig.d.ts +17 -0
- package/dist/types/models/PatchedSubSection.d.ts +9 -0
- package/dist/types/models/PatchedTeamsConfig.d.ts +7 -0
- package/dist/types/models/PatchedTrainingCreate.d.ts +31 -0
- package/dist/types/models/PatchedUnit.d.ts +11 -0
- package/dist/types/models/PatchedWebexConfig.d.ts +10 -0
- package/dist/types/models/PatchedWhatsappConfig.d.ts +11 -0
- package/dist/types/models/PatchedWhatsappUserConfig.d.ts +10 -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/Provider05cEnum.d.ts +14 -0
- package/dist/types/models/Provider63aEnum.d.ts +6 -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/SlackConfig.d.ts +8 -0
- package/dist/types/models/SlackUserConfig.d.ts +17 -0
- package/dist/types/models/SlackWebhook.d.ts +6 -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/TeamsConfig.d.ts +7 -0
- package/dist/types/models/TeamsWebhook.d.ts +17 -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/Training.d.ts +41 -0
- package/dist/types/models/TrainingCreate.d.ts +31 -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/VoiceProviderEnum.d.ts +10 -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/models/WebexConfig.d.ts +10 -0
- package/dist/types/models/WebexWebhook.d.ts +4 -0
- package/dist/types/models/WhatAppWebHook.d.ts +3 -0
- package/dist/types/models/WhatsappConfig.d.ts +11 -0
- package/dist/types/models/WhatsappUserConfig.d.ts +10 -0
- package/dist/types/services/AiAccountService.d.ts +319 -0
- package/dist/types/services/AiAnalyticsService.d.ts +3899 -0
- package/dist/types/services/AiBotService.d.ts +642 -0
- package/dist/types/services/AiFinetuningService.d.ts +232 -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 +320 -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/Bot.ts +20 -0
- package/src/models/BotCommand.ts +11 -0
- package/src/models/BotCreate.ts +17 -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/DataSet.ts +26 -0
- package/src/models/DataSetCreate.ts +17 -0
- package/src/models/DataSetStatusEnum.ts +16 -0
- package/src/models/DateRange.ts +9 -0
- package/src/models/DiscordConfig.ts +12 -0
- package/src/models/DiscordUserConfig.ts +15 -0
- package/src/models/DiscordWebhook.ts +11 -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/PaginatedDataSetList.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/PaginatedTrainingList.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/PatchedBotCommand.ts +11 -0
- package/src/models/PatchedBotCreate.ts +17 -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/PatchedDataSet.ts +26 -0
- package/src/models/PatchedDiscordConfig.ts +12 -0
- package/src/models/PatchedDiscordUserConfig.ts +15 -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/PatchedSlackConfig.ts +13 -0
- package/src/models/PatchedSlackUserConfig.ts +22 -0
- package/src/models/PatchedSubSection.ts +14 -0
- package/src/models/PatchedTeamsConfig.ts +12 -0
- package/src/models/PatchedTrainingCreate.ts +36 -0
- package/src/models/PatchedUnit.ts +16 -0
- package/src/models/PatchedWebexConfig.ts +15 -0
- package/src/models/PatchedWhatsappConfig.ts +16 -0
- package/src/models/PatchedWhatsappUserConfig.ts +15 -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/Provider05cEnum.ts +18 -0
- package/src/models/Provider63aEnum.ts +10 -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/SlackConfig.ts +13 -0
- package/src/models/SlackUserConfig.ts +22 -0
- package/src/models/SlackWebhook.ts +11 -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/TeamsConfig.ts +12 -0
- package/src/models/TeamsWebhook.ts +22 -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/Training.ts +46 -0
- package/src/models/TrainingCreate.ts +36 -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/VoiceProviderEnum.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/models/WebexConfig.ts +15 -0
- package/src/models/WebexWebhook.ts +9 -0
- package/src/models/WhatAppWebHook.ts +8 -0
- package/src/models/WhatsappConfig.ts +16 -0
- package/src/models/WhatsappUserConfig.ts +15 -0
- package/src/services/AiAccountService.ts +505 -0
- package/src/services/AiAnalyticsService.ts +6439 -0
- package/src/services/AiBotService.ts +1330 -0
- package/src/services/AiFinetuningService.ts +472 -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
|
@@ -2,12 +2,131 @@
|
|
|
2
2
|
/* istanbul ignore file */
|
|
3
3
|
/* tslint:disable */
|
|
4
4
|
/* eslint-disable */
|
|
5
|
+
import type { DocumentSearchResponse } from '../models/DocumentSearchResponse';
|
|
5
6
|
import type { GlobalCatalogSearchResponse } from '../models/GlobalCatalogSearchResponse';
|
|
7
|
+
import type { MentorSearchResponse } from '../models/MentorSearchResponse';
|
|
8
|
+
import type { PromptSearchResponse } from '../models/PromptSearchResponse';
|
|
9
|
+
import type { RecommendedCoursesResponse } from '../models/RecommendedCoursesResponse';
|
|
6
10
|
import type { UserSearchResponse } from '../models/UserSearchResponse';
|
|
7
11
|
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
8
12
|
import { OpenAPI } from '../core/OpenAPI';
|
|
9
13
|
import { request as __request } from '../core/request';
|
|
10
14
|
export class SearchService {
|
|
15
|
+
/**
|
|
16
|
+
* Legacy endpoint for backward compatible mentor search
|
|
17
|
+
* @returns MentorSearchResponse
|
|
18
|
+
* @throws ApiError
|
|
19
|
+
*/
|
|
20
|
+
public static searchAiSearchRetrieve({
|
|
21
|
+
audience,
|
|
22
|
+
category,
|
|
23
|
+
createdBy,
|
|
24
|
+
filterFacet = false,
|
|
25
|
+
id,
|
|
26
|
+
limit = 12,
|
|
27
|
+
llm,
|
|
28
|
+
offset,
|
|
29
|
+
orderBy,
|
|
30
|
+
orderDirection = 'desc',
|
|
31
|
+
page,
|
|
32
|
+
pageSize,
|
|
33
|
+
query,
|
|
34
|
+
tags,
|
|
35
|
+
tenant,
|
|
36
|
+
uniqueId,
|
|
37
|
+
}: {
|
|
38
|
+
/**
|
|
39
|
+
* Filter by target audience
|
|
40
|
+
*/
|
|
41
|
+
audience?: Array<string>,
|
|
42
|
+
/**
|
|
43
|
+
* Filter by mentor category
|
|
44
|
+
*/
|
|
45
|
+
category?: Array<string>,
|
|
46
|
+
/**
|
|
47
|
+
* Filter mentors created by specific user
|
|
48
|
+
*/
|
|
49
|
+
createdBy?: string,
|
|
50
|
+
/**
|
|
51
|
+
* If present, return only facets without results
|
|
52
|
+
*/
|
|
53
|
+
filterFacet?: boolean,
|
|
54
|
+
/**
|
|
55
|
+
* Retrieve a specific mentor by ID
|
|
56
|
+
*/
|
|
57
|
+
id?: number,
|
|
58
|
+
/**
|
|
59
|
+
* Number of results per page
|
|
60
|
+
*/
|
|
61
|
+
limit?: number,
|
|
62
|
+
/**
|
|
63
|
+
* Filter by language model type
|
|
64
|
+
*/
|
|
65
|
+
llm?: Array<string>,
|
|
66
|
+
/**
|
|
67
|
+
* Starting position for pagination
|
|
68
|
+
*/
|
|
69
|
+
offset?: number,
|
|
70
|
+
/**
|
|
71
|
+
* Field to sort results by ('created_at', 'recently_accessed_at')
|
|
72
|
+
*/
|
|
73
|
+
orderBy?: string,
|
|
74
|
+
/**
|
|
75
|
+
* Sort direction ('asc' or 'desc')
|
|
76
|
+
*/
|
|
77
|
+
orderDirection?: string,
|
|
78
|
+
/**
|
|
79
|
+
* Page number (1-based, used with page_size)
|
|
80
|
+
*/
|
|
81
|
+
page?: number,
|
|
82
|
+
/**
|
|
83
|
+
* Number of results per page
|
|
84
|
+
*/
|
|
85
|
+
pageSize?: number,
|
|
86
|
+
/**
|
|
87
|
+
* Search term to filter mentors by name or description
|
|
88
|
+
*/
|
|
89
|
+
query?: string,
|
|
90
|
+
/**
|
|
91
|
+
* Filter by tags
|
|
92
|
+
*/
|
|
93
|
+
tags?: Array<string>,
|
|
94
|
+
/**
|
|
95
|
+
* Filter by tenant/organization
|
|
96
|
+
*/
|
|
97
|
+
tenant?: string,
|
|
98
|
+
/**
|
|
99
|
+
* Retrieve a specific mentor by UUID
|
|
100
|
+
*/
|
|
101
|
+
uniqueId?: string,
|
|
102
|
+
}): CancelablePromise<MentorSearchResponse> {
|
|
103
|
+
return __request(OpenAPI, {
|
|
104
|
+
method: 'GET',
|
|
105
|
+
url: '/api/search/ai-search/',
|
|
106
|
+
query: {
|
|
107
|
+
'audience': audience,
|
|
108
|
+
'category': category,
|
|
109
|
+
'created_by': createdBy,
|
|
110
|
+
'filter_facet': filterFacet,
|
|
111
|
+
'id': id,
|
|
112
|
+
'limit': limit,
|
|
113
|
+
'llm': llm,
|
|
114
|
+
'offset': offset,
|
|
115
|
+
'order_by': orderBy,
|
|
116
|
+
'order_direction': orderDirection,
|
|
117
|
+
'page': page,
|
|
118
|
+
'page_size': pageSize,
|
|
119
|
+
'query': query,
|
|
120
|
+
'tags': tags,
|
|
121
|
+
'tenant': tenant,
|
|
122
|
+
'unique_id': uniqueId,
|
|
123
|
+
},
|
|
124
|
+
errors: {
|
|
125
|
+
400: `Bad request`,
|
|
126
|
+
500: `Server error`,
|
|
127
|
+
},
|
|
128
|
+
});
|
|
129
|
+
}
|
|
11
130
|
/**
|
|
12
131
|
* Search and filter content across the learning catalog.
|
|
13
132
|
*
|
|
@@ -173,69 +292,157 @@ export class SearchService {
|
|
|
173
292
|
* - Results are cached for performance
|
|
174
293
|
* - The 'resources' content type is only included by default if IBL_ENABLE_RESOURCES_IN_FACET is true
|
|
175
294
|
* - For debugging, add ?debug=true to see detailed information about skill matching
|
|
176
|
-
* @param allowSkillSearch Enable skill-based search
|
|
177
|
-
* @param alphabetical Sort alphabetically by name
|
|
178
|
-
* @param certificate Filter by certificate type
|
|
179
|
-
* @param content Content types to include in results
|
|
180
|
-
* @param courseId Filter by specific course ID
|
|
181
|
-
* @param duration Filter by course duration range
|
|
182
|
-
* @param language Filter by content language
|
|
183
|
-
* @param level Filter by difficulty level
|
|
184
|
-
* @param limit Number of results per page
|
|
185
|
-
* @param offset Starting position for pagination
|
|
186
|
-
* @param orderAscending Sort direction
|
|
187
|
-
* @param orderBy Field to sort results by
|
|
188
|
-
* @param pathwayId Filter by specific pathway ID
|
|
189
|
-
* @param price Filter by price/audit status
|
|
190
|
-
* @param programId Filter by specific program ID
|
|
191
|
-
* @param programType Filter by program type
|
|
192
|
-
* @param promotion Filter by promotion status
|
|
193
|
-
* @param query Search term to filter content by name or description
|
|
194
|
-
* @param resourceType Filter by resource type
|
|
195
|
-
* @param returnFacet Include facet data in response
|
|
196
|
-
* @param returnItems Include items in programs/pathways
|
|
197
|
-
* @param selfPaced Filter by course format
|
|
198
|
-
* @param skillId Filter by specific skill ID
|
|
199
|
-
* @param skills Filter by skills
|
|
200
|
-
* @param subject Filter by subject areas
|
|
201
|
-
* @param tags Filter by tags
|
|
202
|
-
* @param tenant Filter by tenant/organization
|
|
203
|
-
* @param topics Filter by topic areas
|
|
204
|
-
* @param updateFacet Force facet update
|
|
205
295
|
* @returns GlobalCatalogSearchResponse
|
|
206
296
|
* @throws ApiError
|
|
207
297
|
*/
|
|
208
|
-
public static searchCatalogRetrieve(
|
|
209
|
-
allowSkillSearch
|
|
210
|
-
alphabetical
|
|
298
|
+
public static searchCatalogRetrieve({
|
|
299
|
+
allowSkillSearch = false,
|
|
300
|
+
alphabetical = false,
|
|
301
|
+
certificate,
|
|
302
|
+
content,
|
|
303
|
+
courseId,
|
|
304
|
+
duration,
|
|
305
|
+
language,
|
|
306
|
+
level,
|
|
307
|
+
limit = 12,
|
|
308
|
+
offset,
|
|
309
|
+
orderAscending = false,
|
|
310
|
+
orderBy,
|
|
311
|
+
pathwayId,
|
|
312
|
+
price,
|
|
313
|
+
programId,
|
|
314
|
+
programType,
|
|
315
|
+
promotion,
|
|
316
|
+
query,
|
|
317
|
+
resourceType,
|
|
318
|
+
returnFacet = true,
|
|
319
|
+
returnItems = false,
|
|
320
|
+
selfPaced,
|
|
321
|
+
skillId,
|
|
322
|
+
skills,
|
|
323
|
+
subject,
|
|
324
|
+
tags,
|
|
325
|
+
tenant,
|
|
326
|
+
topics,
|
|
327
|
+
updateFacet,
|
|
328
|
+
}: {
|
|
329
|
+
/**
|
|
330
|
+
* Enable skill-based search
|
|
331
|
+
*/
|
|
332
|
+
allowSkillSearch?: boolean,
|
|
333
|
+
/**
|
|
334
|
+
* Sort alphabetically by name
|
|
335
|
+
*/
|
|
336
|
+
alphabetical?: boolean,
|
|
337
|
+
/**
|
|
338
|
+
* Filter by certificate type
|
|
339
|
+
*/
|
|
211
340
|
certificate?: Array<string>,
|
|
341
|
+
/**
|
|
342
|
+
* Content types to include in results
|
|
343
|
+
*/
|
|
212
344
|
content?: Array<string>,
|
|
345
|
+
/**
|
|
346
|
+
* Filter by specific course ID
|
|
347
|
+
*/
|
|
213
348
|
courseId?: string,
|
|
349
|
+
/**
|
|
350
|
+
* Filter by course duration range
|
|
351
|
+
*/
|
|
214
352
|
duration?: Array<string>,
|
|
353
|
+
/**
|
|
354
|
+
* Filter by content language
|
|
355
|
+
*/
|
|
215
356
|
language?: Array<string>,
|
|
357
|
+
/**
|
|
358
|
+
* Filter by difficulty level
|
|
359
|
+
*/
|
|
216
360
|
level?: Array<string>,
|
|
217
|
-
|
|
361
|
+
/**
|
|
362
|
+
* Number of results per page
|
|
363
|
+
*/
|
|
364
|
+
limit?: number,
|
|
365
|
+
/**
|
|
366
|
+
* Starting position for pagination
|
|
367
|
+
*/
|
|
218
368
|
offset?: number,
|
|
219
|
-
|
|
369
|
+
/**
|
|
370
|
+
* Sort direction
|
|
371
|
+
*/
|
|
372
|
+
orderAscending?: boolean,
|
|
373
|
+
/**
|
|
374
|
+
* Field to sort results by
|
|
375
|
+
*/
|
|
220
376
|
orderBy?: string,
|
|
377
|
+
/**
|
|
378
|
+
* Filter by specific pathway ID
|
|
379
|
+
*/
|
|
221
380
|
pathwayId?: string,
|
|
381
|
+
/**
|
|
382
|
+
* Filter by price/audit status
|
|
383
|
+
*/
|
|
222
384
|
price?: string,
|
|
385
|
+
/**
|
|
386
|
+
* Filter by specific program ID
|
|
387
|
+
*/
|
|
223
388
|
programId?: string,
|
|
389
|
+
/**
|
|
390
|
+
* Filter by program type
|
|
391
|
+
*/
|
|
224
392
|
programType?: Array<string>,
|
|
393
|
+
/**
|
|
394
|
+
* Filter by promotion status
|
|
395
|
+
*/
|
|
225
396
|
promotion?: Array<string>,
|
|
397
|
+
/**
|
|
398
|
+
* Search term to filter content by name or description
|
|
399
|
+
*/
|
|
226
400
|
query?: string,
|
|
401
|
+
/**
|
|
402
|
+
* Filter by resource type
|
|
403
|
+
*/
|
|
227
404
|
resourceType?: Array<string>,
|
|
228
|
-
|
|
229
|
-
|
|
405
|
+
/**
|
|
406
|
+
* Include facet data in response
|
|
407
|
+
*/
|
|
408
|
+
returnFacet?: boolean,
|
|
409
|
+
/**
|
|
410
|
+
* Include items in programs/pathways
|
|
411
|
+
*/
|
|
412
|
+
returnItems?: boolean,
|
|
413
|
+
/**
|
|
414
|
+
* Filter by course format
|
|
415
|
+
*/
|
|
230
416
|
selfPaced?: Array<string>,
|
|
417
|
+
/**
|
|
418
|
+
* Filter by specific skill ID
|
|
419
|
+
*/
|
|
231
420
|
skillId?: string,
|
|
421
|
+
/**
|
|
422
|
+
* Filter by skills
|
|
423
|
+
*/
|
|
232
424
|
skills?: Array<string>,
|
|
425
|
+
/**
|
|
426
|
+
* Filter by subject areas
|
|
427
|
+
*/
|
|
233
428
|
subject?: Array<string>,
|
|
429
|
+
/**
|
|
430
|
+
* Filter by tags
|
|
431
|
+
*/
|
|
234
432
|
tags?: Array<string>,
|
|
433
|
+
/**
|
|
434
|
+
* Filter by tenant/organization
|
|
435
|
+
*/
|
|
235
436
|
tenant?: Array<string>,
|
|
437
|
+
/**
|
|
438
|
+
* Filter by topic areas
|
|
439
|
+
*/
|
|
236
440
|
topics?: Array<string>,
|
|
441
|
+
/**
|
|
442
|
+
* Force facet update
|
|
443
|
+
*/
|
|
237
444
|
updateFacet?: string,
|
|
238
|
-
): CancelablePromise<GlobalCatalogSearchResponse> {
|
|
445
|
+
}): CancelablePromise<GlobalCatalogSearchResponse> {
|
|
239
446
|
return __request(OpenAPI, {
|
|
240
447
|
method: 'GET',
|
|
241
448
|
url: '/api/search/catalog/',
|
|
@@ -277,274 +484,1322 @@ export class SearchService {
|
|
|
277
484
|
});
|
|
278
485
|
}
|
|
279
486
|
/**
|
|
280
|
-
*
|
|
281
|
-
* If any detail-identifying parameters are present (course_id, program_id, etc.)
|
|
282
|
-
* the detail view is returned; otherwise the aggregated list view is returned.
|
|
283
|
-
* @param username
|
|
284
|
-
* @param allowSkillSearch Enable skill-based search
|
|
285
|
-
* @param alphabetical Sort alphabetically by name
|
|
286
|
-
* @param certificate Filter by certificate type
|
|
287
|
-
* @param content Content types to include in results
|
|
288
|
-
* @param courseId Retrieve a specific course by ID
|
|
289
|
-
* @param duration Filter by course duration range
|
|
290
|
-
* @param language Filter by content language
|
|
291
|
-
* @param level Filter by difficulty level
|
|
292
|
-
* @param limit Number of results per page
|
|
293
|
-
* @param offset Starting position for pagination
|
|
294
|
-
* @param orderAscending Sort direction
|
|
295
|
-
* @param orderBy Field to sort results by
|
|
296
|
-
* @param pathwayId Retrieve a specific pathway by ID
|
|
297
|
-
* @param price Filter by price/audit status
|
|
298
|
-
* @param programId Retrieve a specific program by ID
|
|
299
|
-
* @param programType Filter by program type
|
|
300
|
-
* @param promotion Filter by promotion status
|
|
301
|
-
* @param query Search term to filter content by name or description
|
|
302
|
-
* @param recommended Show only recommended content
|
|
303
|
-
* @param resourceId Retrieve a specific resource by ID
|
|
304
|
-
* @param resourceType Filter by resource type
|
|
305
|
-
* @param returnFacet Include facet data in response
|
|
306
|
-
* @param returnItems Include items in programs/pathways
|
|
307
|
-
* @param roleId Retrieve a specific role by ID
|
|
308
|
-
* @param selfPaced Filter by course format
|
|
309
|
-
* @param skillId Retrieve a specific skill by ID
|
|
310
|
-
* @param skills Filter by skills
|
|
311
|
-
* @param subject Filter by subject areas
|
|
312
|
-
* @param tags Filter by tags
|
|
313
|
-
* @param tenant Filter by tenant/organization
|
|
314
|
-
* @param topics Filter by topic areas
|
|
315
|
-
* @param updateFacet Force facet update
|
|
316
|
-
* @returns any
|
|
317
|
-
* @throws ApiError
|
|
318
|
-
*/
|
|
319
|
-
public static searchPersonalizedCatalogRetrieve(
|
|
320
|
-
username: string,
|
|
321
|
-
allowSkillSearch: boolean = false,
|
|
322
|
-
alphabetical: boolean = false,
|
|
323
|
-
certificate?: Array<string>,
|
|
324
|
-
content?: Array<string>,
|
|
325
|
-
courseId?: string,
|
|
326
|
-
duration?: Array<string>,
|
|
327
|
-
language?: Array<string>,
|
|
328
|
-
level?: Array<string>,
|
|
329
|
-
limit: number = 12,
|
|
330
|
-
offset?: number,
|
|
331
|
-
orderAscending: boolean = false,
|
|
332
|
-
orderBy?: string,
|
|
333
|
-
pathwayId?: string,
|
|
334
|
-
price?: string,
|
|
335
|
-
programId?: string,
|
|
336
|
-
programType?: Array<string>,
|
|
337
|
-
promotion?: Array<string>,
|
|
338
|
-
query?: string,
|
|
339
|
-
recommended: boolean = false,
|
|
340
|
-
resourceId?: string,
|
|
341
|
-
resourceType?: Array<string>,
|
|
342
|
-
returnFacet: boolean = true,
|
|
343
|
-
returnItems: boolean = false,
|
|
344
|
-
roleId?: string,
|
|
345
|
-
selfPaced?: Array<string>,
|
|
346
|
-
skillId?: string,
|
|
347
|
-
skills?: Array<string>,
|
|
348
|
-
subject?: Array<string>,
|
|
349
|
-
tags?: Array<string>,
|
|
350
|
-
tenant?: Array<string>,
|
|
351
|
-
topics?: Array<string>,
|
|
352
|
-
updateFacet?: string,
|
|
353
|
-
): CancelablePromise<Record<string, any>> {
|
|
354
|
-
return __request(OpenAPI, {
|
|
355
|
-
method: 'GET',
|
|
356
|
-
url: '/api/search/personalized-catalog/{username}/',
|
|
357
|
-
path: {
|
|
358
|
-
'username': username,
|
|
359
|
-
},
|
|
360
|
-
query: {
|
|
361
|
-
'allow_skill_search': allowSkillSearch,
|
|
362
|
-
'alphabetical': alphabetical,
|
|
363
|
-
'certificate': certificate,
|
|
364
|
-
'content': content,
|
|
365
|
-
'course_id': courseId,
|
|
366
|
-
'duration': duration,
|
|
367
|
-
'language': language,
|
|
368
|
-
'level': level,
|
|
369
|
-
'limit': limit,
|
|
370
|
-
'offset': offset,
|
|
371
|
-
'order_ascending': orderAscending,
|
|
372
|
-
'order_by': orderBy,
|
|
373
|
-
'pathway_id': pathwayId,
|
|
374
|
-
'price': price,
|
|
375
|
-
'program_id': programId,
|
|
376
|
-
'program_type': programType,
|
|
377
|
-
'promotion': promotion,
|
|
378
|
-
'query': query,
|
|
379
|
-
'recommended': recommended,
|
|
380
|
-
'resource_id': resourceId,
|
|
381
|
-
'resource_type': resourceType,
|
|
382
|
-
'return_facet': returnFacet,
|
|
383
|
-
'return_items': returnItems,
|
|
384
|
-
'role_id': roleId,
|
|
385
|
-
'self_paced': selfPaced,
|
|
386
|
-
'skill_id': skillId,
|
|
387
|
-
'skills': skills,
|
|
388
|
-
'subject': subject,
|
|
389
|
-
'tags': tags,
|
|
390
|
-
'tenant': tenant,
|
|
391
|
-
'topics': topics,
|
|
392
|
-
'update_facet': updateFacet,
|
|
393
|
-
},
|
|
394
|
-
});
|
|
395
|
-
}
|
|
396
|
-
/**
|
|
397
|
-
* Search and filter users within a specific organization/tenant.
|
|
487
|
+
* Search and filter AI mentors across the platform.
|
|
398
488
|
*
|
|
399
|
-
* This endpoint provides a search interface for discovering
|
|
400
|
-
* with support for filtering
|
|
401
|
-
*
|
|
402
|
-
* Path Parameters:
|
|
403
|
-
* org (str): The organization/tenant identifier
|
|
404
|
-
* username (str): The username of the user making the request
|
|
489
|
+
* This endpoint provides a powerful search interface for discovering AI mentors
|
|
490
|
+
* with support for filtering, pagination, and detailed mentor information.
|
|
405
491
|
*
|
|
406
492
|
* Query Parameters:
|
|
407
|
-
* #
|
|
408
|
-
*
|
|
409
|
-
*
|
|
410
|
-
* # Department filtering
|
|
411
|
-
* department_mode (bool, optional): Enable department-based filtering (default: false)
|
|
412
|
-
* user_department (bool, optional): Legacy parameter for department_mode (default: false)
|
|
413
|
-
* department (list, optional): Filter by specific departments
|
|
493
|
+
* # Identification parameters (for detail view)
|
|
494
|
+
* id (int, optional): Retrieve a specific mentor by ID
|
|
495
|
+
* unique_id (uuid, optional): Retrieve a specific mentor by UUID
|
|
414
496
|
*
|
|
415
|
-
* #
|
|
416
|
-
*
|
|
417
|
-
*
|
|
418
|
-
*
|
|
419
|
-
*
|
|
497
|
+
* # Search and filtering parameters
|
|
498
|
+
* query (str, optional): Search term to filter mentors by name or description
|
|
499
|
+
* tenant (str, optional): Filter by tenant/organization
|
|
500
|
+
* llm (list, optional): Filter by language model type
|
|
501
|
+
* audience (list, optional): Filter by target audience
|
|
502
|
+
* category (list, optional): Filter by mentor category
|
|
503
|
+
* tags (list, optional): Filter by tags
|
|
504
|
+
* created_by (str, optional): Filter mentors created by specific user
|
|
420
505
|
*
|
|
421
|
-
* #
|
|
422
|
-
*
|
|
506
|
+
* # Sorting and pagination
|
|
507
|
+
* order_by (str, optional): Field to sort results by ('created_at', 'recently_accessed_at')
|
|
508
|
+
* order_direction (str, optional): Sort direction ('asc' or 'desc', default: 'desc')
|
|
509
|
+
* limit (int, optional): Number of results per page (default: 12, max: 100)
|
|
423
510
|
* offset (int, optional): Starting position for pagination
|
|
424
511
|
*
|
|
425
512
|
* Returns:
|
|
426
|
-
*
|
|
427
|
-
*
|
|
513
|
+
* For detail view (when id or unique_id is provided):
|
|
514
|
+
* A JSON response containing a single mentor's details:
|
|
428
515
|
* {
|
|
429
|
-
* "
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
* "
|
|
441
|
-
* "
|
|
442
|
-
* "
|
|
443
|
-
*
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
516
|
+
* "id": 123,
|
|
517
|
+
* "unique_id": "550e8400-e29b-41d4-a716-446655440000",
|
|
518
|
+
* "name": "Professor Smith",
|
|
519
|
+
* "description": "AI mentor specializing in computer science",
|
|
520
|
+
* "image_url": "https://example.com/images/prof-smith.jpg",
|
|
521
|
+
* "llm": {
|
|
522
|
+
* "id": 1,
|
|
523
|
+
* "name": "GPT-4",
|
|
524
|
+
* "description": "Advanced language model"
|
|
525
|
+
* },
|
|
526
|
+
* "audience": {
|
|
527
|
+
* "id": 2,
|
|
528
|
+
* "name": "College Students",
|
|
529
|
+
* "description": "For university-level learners"
|
|
530
|
+
* },
|
|
531
|
+
* "category": "Computer Science",
|
|
532
|
+
* "tags": ["programming", "algorithms", "data structures"],
|
|
533
|
+
* "created_at": "2023-01-15T12:00:00Z",
|
|
534
|
+
* "recently_accessed_at": "2023-06-20T15:30:00Z",
|
|
535
|
+
* "platform": {
|
|
536
|
+
* "id": 1,
|
|
537
|
+
* "name": "Example University",
|
|
538
|
+
* "key": "example-university"
|
|
448
539
|
* },
|
|
449
|
-
*
|
|
450
|
-
*
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
*
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
*
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
*
|
|
470
|
-
*
|
|
471
|
-
*
|
|
472
|
-
*
|
|
473
|
-
* }
|
|
474
|
-
*
|
|
475
|
-
*
|
|
476
|
-
*
|
|
477
|
-
*
|
|
478
|
-
*
|
|
479
|
-
*
|
|
480
|
-
*
|
|
481
|
-
*
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
540
|
+
* "visibility": "public",
|
|
541
|
+
* "settings": {
|
|
542
|
+
* "temperature": 0.7,
|
|
543
|
+
* "max_tokens": 1024,
|
|
544
|
+
* "system_prompt": "You are Professor Smith, an expert in computer science..."
|
|
545
|
+
* }
|
|
546
|
+
* }
|
|
547
|
+
*
|
|
548
|
+
* For list view:
|
|
549
|
+
* A JSON response containing:
|
|
550
|
+
* {
|
|
551
|
+
* "results": [
|
|
552
|
+
* {
|
|
553
|
+
* "id": 123,
|
|
554
|
+
* "unique_id": "550e8400-e29b-41d4-a716-446655440000",
|
|
555
|
+
* "name": "Professor Smith",
|
|
556
|
+
* "description": "AI mentor specializing in computer science",
|
|
557
|
+
* "image_url": "https://example.com/images/prof-smith.jpg",
|
|
558
|
+
* "llm": {"id": 1, "name": "GPT-4"},
|
|
559
|
+
* "audience": {"id": 2, "name": "College Students"},
|
|
560
|
+
* "category": "Computer Science",
|
|
561
|
+
* "tags": ["programming", "algorithms"],
|
|
562
|
+
* "created_at": "2023-01-15T12:00:00Z",
|
|
563
|
+
* "recently_accessed_at": "2023-06-20T15:30:00Z"
|
|
564
|
+
* },
|
|
565
|
+
* // Additional mentor objects...
|
|
566
|
+
* ],
|
|
567
|
+
* "count": 50,
|
|
568
|
+
* "next": "https://api.example.com/api/search/mentors/?limit=12&offset=12",
|
|
569
|
+
* "previous": null,
|
|
570
|
+
* "current_page": 1,
|
|
571
|
+
* "num_pages": 5,
|
|
572
|
+
* "facets": {
|
|
573
|
+
* "llm": [
|
|
574
|
+
* {"key": "GPT-4", "doc_count": 30},
|
|
575
|
+
* {"key": "Claude", "doc_count": 20}
|
|
576
|
+
* ],
|
|
577
|
+
* "audience": [
|
|
578
|
+
* {"key": "College Students", "doc_count": 35},
|
|
579
|
+
* {"key": "Professionals", "doc_count": 15}
|
|
580
|
+
* ],
|
|
581
|
+
* "category": [
|
|
582
|
+
* {"key": "Computer Science", "doc_count": 25},
|
|
583
|
+
* {"key": "Mathematics", "doc_count": 15},
|
|
584
|
+
* {"key": "Business", "doc_count": 10}
|
|
585
|
+
* ]
|
|
586
|
+
* }
|
|
587
|
+
* }
|
|
588
|
+
*
|
|
589
|
+
* Error Responses:
|
|
590
|
+
* 400 Bad Request: If the request parameters are invalid
|
|
591
|
+
* 404 Not Found: If the requested mentor doesn't exist
|
|
592
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
593
|
+
*
|
|
594
|
+
* Notes:
|
|
595
|
+
* - Results are cached for performance
|
|
596
|
+
* - Public mentors are visible to all users
|
|
597
|
+
* - Private mentors are only visible to authorized users
|
|
598
|
+
* @returns MentorSearchResponse
|
|
599
|
+
* @throws ApiError
|
|
600
|
+
*/
|
|
601
|
+
public static searchMentorsRetrieve({
|
|
602
|
+
audience,
|
|
603
|
+
category,
|
|
604
|
+
createdBy,
|
|
605
|
+
featured,
|
|
606
|
+
id,
|
|
607
|
+
limit = 12,
|
|
608
|
+
llm,
|
|
609
|
+
offset,
|
|
610
|
+
orderBy,
|
|
611
|
+
orderDirection = 'desc',
|
|
612
|
+
query,
|
|
613
|
+
tags,
|
|
614
|
+
tenant,
|
|
615
|
+
uniqueId,
|
|
616
|
+
}: {
|
|
617
|
+
/**
|
|
618
|
+
* Filter by target audience
|
|
619
|
+
*/
|
|
620
|
+
audience?: Array<string>,
|
|
621
|
+
/**
|
|
622
|
+
* Filter by mentor category
|
|
623
|
+
*/
|
|
624
|
+
category?: Array<string>,
|
|
625
|
+
/**
|
|
626
|
+
* Filter mentors created by specific user
|
|
627
|
+
*/
|
|
628
|
+
createdBy?: string,
|
|
629
|
+
/**
|
|
630
|
+
* Filter by featured status
|
|
631
|
+
*/
|
|
632
|
+
featured?: boolean,
|
|
633
|
+
/**
|
|
634
|
+
* Retrieve a specific mentor by ID
|
|
635
|
+
*/
|
|
636
|
+
id?: number,
|
|
637
|
+
/**
|
|
638
|
+
* Number of results per page
|
|
639
|
+
*/
|
|
640
|
+
limit?: number,
|
|
641
|
+
/**
|
|
642
|
+
* Filter by language model type
|
|
643
|
+
*/
|
|
644
|
+
llm?: Array<string>,
|
|
645
|
+
/**
|
|
646
|
+
* Starting position for pagination
|
|
647
|
+
*/
|
|
648
|
+
offset?: number,
|
|
649
|
+
/**
|
|
650
|
+
* Field to sort results by ('created_at', 'recently_accessed_at')
|
|
651
|
+
*/
|
|
652
|
+
orderBy?: string,
|
|
653
|
+
/**
|
|
654
|
+
* Sort direction ('asc' or 'desc')
|
|
655
|
+
*/
|
|
656
|
+
orderDirection?: string,
|
|
657
|
+
/**
|
|
658
|
+
* Search term to filter mentors by name or description
|
|
659
|
+
*/
|
|
660
|
+
query?: string,
|
|
661
|
+
/**
|
|
662
|
+
* Filter by tags
|
|
663
|
+
*/
|
|
664
|
+
tags?: Array<string>,
|
|
665
|
+
/**
|
|
666
|
+
* Filter by tenant/organization
|
|
667
|
+
*/
|
|
668
|
+
tenant?: string,
|
|
669
|
+
/**
|
|
670
|
+
* Retrieve a specific mentor by UUID
|
|
671
|
+
*/
|
|
672
|
+
uniqueId?: string,
|
|
673
|
+
}): CancelablePromise<MentorSearchResponse> {
|
|
674
|
+
return __request(OpenAPI, {
|
|
675
|
+
method: 'GET',
|
|
676
|
+
url: '/api/search/mentors/',
|
|
677
|
+
query: {
|
|
678
|
+
'audience': audience,
|
|
679
|
+
'category': category,
|
|
680
|
+
'created_by': createdBy,
|
|
681
|
+
'featured': featured,
|
|
682
|
+
'id': id,
|
|
683
|
+
'limit': limit,
|
|
684
|
+
'llm': llm,
|
|
685
|
+
'offset': offset,
|
|
686
|
+
'order_by': orderBy,
|
|
687
|
+
'order_direction': orderDirection,
|
|
688
|
+
'query': query,
|
|
689
|
+
'tags': tags,
|
|
690
|
+
'tenant': tenant,
|
|
691
|
+
'unique_id': uniqueId,
|
|
692
|
+
},
|
|
693
|
+
errors: {
|
|
694
|
+
400: `Bad request`,
|
|
695
|
+
500: `Server error`,
|
|
696
|
+
},
|
|
697
|
+
});
|
|
698
|
+
}
|
|
699
|
+
/**
|
|
700
|
+
* Search and filter documents associated with a specific mentor
|
|
701
|
+
* @returns DocumentSearchResponse
|
|
702
|
+
* @throws ApiError
|
|
703
|
+
*/
|
|
704
|
+
public static searchMentorsDocumentsRetrieve({
|
|
705
|
+
mentorUniqueId,
|
|
706
|
+
access,
|
|
707
|
+
documentType,
|
|
708
|
+
limit = 12,
|
|
709
|
+
offset,
|
|
710
|
+
orderBy,
|
|
711
|
+
orderDirection = 'desc',
|
|
712
|
+
platformKey,
|
|
713
|
+
query,
|
|
714
|
+
trainingStatus,
|
|
715
|
+
}: {
|
|
716
|
+
mentorUniqueId: string,
|
|
717
|
+
/**
|
|
718
|
+
* Filter by access level (e.g., 'public', 'private')
|
|
719
|
+
*/
|
|
720
|
+
access?: string,
|
|
721
|
+
/**
|
|
722
|
+
* Filter by document type (e.g., 'pdf', 'text')
|
|
723
|
+
*/
|
|
724
|
+
documentType?: string,
|
|
725
|
+
/**
|
|
726
|
+
* Number of results per page
|
|
727
|
+
*/
|
|
728
|
+
limit?: number,
|
|
729
|
+
/**
|
|
730
|
+
* Starting position for pagination
|
|
731
|
+
*/
|
|
732
|
+
offset?: number,
|
|
733
|
+
/**
|
|
734
|
+
* Field to sort results by ('date_created', 'last_modified', 'document_name')
|
|
735
|
+
*/
|
|
736
|
+
orderBy?: string,
|
|
737
|
+
/**
|
|
738
|
+
* Sort direction ('asc' or 'desc')
|
|
739
|
+
*/
|
|
740
|
+
orderDirection?: string,
|
|
741
|
+
/**
|
|
742
|
+
* Filter by platform key
|
|
743
|
+
*/
|
|
744
|
+
platformKey?: string,
|
|
745
|
+
/**
|
|
746
|
+
* Search term to filter documents by name or content
|
|
747
|
+
*/
|
|
748
|
+
query?: string,
|
|
749
|
+
/**
|
|
750
|
+
* Filter by training status (e.g., 'trained', 'pending')
|
|
751
|
+
*/
|
|
752
|
+
trainingStatus?: string,
|
|
753
|
+
}): CancelablePromise<DocumentSearchResponse> {
|
|
754
|
+
return __request(OpenAPI, {
|
|
755
|
+
method: 'GET',
|
|
756
|
+
url: '/api/search/mentors/{mentor_unique_id}/documents/',
|
|
757
|
+
path: {
|
|
758
|
+
'mentor_unique_id': mentorUniqueId,
|
|
759
|
+
},
|
|
760
|
+
query: {
|
|
761
|
+
'access': access,
|
|
762
|
+
'document_type': documentType,
|
|
763
|
+
'limit': limit,
|
|
764
|
+
'offset': offset,
|
|
765
|
+
'order_by': orderBy,
|
|
766
|
+
'order_direction': orderDirection,
|
|
767
|
+
'platform_key': platformKey,
|
|
768
|
+
'query': query,
|
|
769
|
+
'training_status': trainingStatus,
|
|
770
|
+
},
|
|
771
|
+
errors: {
|
|
772
|
+
400: `Bad request`,
|
|
773
|
+
404: `Mentor not found`,
|
|
774
|
+
500: `Server error`,
|
|
775
|
+
},
|
|
776
|
+
});
|
|
777
|
+
}
|
|
778
|
+
/**
|
|
779
|
+
* Handle GET requests for tenant-specific mentor search.
|
|
780
|
+
*
|
|
781
|
+
* Args:
|
|
782
|
+
* request: HTTP request object
|
|
783
|
+
* org: Tenant/organization key
|
|
784
|
+
* username: Username of the user making the request
|
|
785
|
+
*
|
|
786
|
+
* Returns:
|
|
787
|
+
* Response: DRF Response object with search results
|
|
788
|
+
* @returns MentorSearchResponse
|
|
789
|
+
* @throws ApiError
|
|
790
|
+
*/
|
|
791
|
+
public static searchOrgsUsersMentorsRetrieve({
|
|
792
|
+
org,
|
|
793
|
+
username,
|
|
794
|
+
audience,
|
|
795
|
+
category,
|
|
796
|
+
createdBy,
|
|
797
|
+
featured,
|
|
798
|
+
id,
|
|
799
|
+
limit = 12,
|
|
800
|
+
llm,
|
|
801
|
+
offset,
|
|
802
|
+
orderBy,
|
|
803
|
+
orderDirection = 'desc',
|
|
804
|
+
query,
|
|
805
|
+
tags,
|
|
806
|
+
tenant,
|
|
807
|
+
uniqueId,
|
|
808
|
+
}: {
|
|
809
|
+
org: string,
|
|
810
|
+
username: string,
|
|
811
|
+
/**
|
|
812
|
+
* Filter by target audience
|
|
813
|
+
*/
|
|
814
|
+
audience?: Array<string>,
|
|
815
|
+
/**
|
|
816
|
+
* Filter by mentor category
|
|
817
|
+
*/
|
|
818
|
+
category?: Array<string>,
|
|
819
|
+
/**
|
|
820
|
+
* Filter mentors created by specific user
|
|
821
|
+
*/
|
|
822
|
+
createdBy?: string,
|
|
823
|
+
/**
|
|
824
|
+
* Filter by featured status
|
|
825
|
+
*/
|
|
826
|
+
featured?: boolean,
|
|
827
|
+
/**
|
|
828
|
+
* Retrieve a specific mentor by ID
|
|
829
|
+
*/
|
|
830
|
+
id?: number,
|
|
831
|
+
/**
|
|
832
|
+
* Number of results per page
|
|
833
|
+
*/
|
|
834
|
+
limit?: number,
|
|
835
|
+
/**
|
|
836
|
+
* Filter by language model type
|
|
837
|
+
*/
|
|
838
|
+
llm?: Array<string>,
|
|
839
|
+
/**
|
|
840
|
+
* Starting position for pagination
|
|
841
|
+
*/
|
|
842
|
+
offset?: number,
|
|
843
|
+
/**
|
|
844
|
+
* Field to sort results by ('created_at', 'recently_accessed_at')
|
|
845
|
+
*/
|
|
846
|
+
orderBy?: string,
|
|
847
|
+
/**
|
|
848
|
+
* Sort direction ('asc' or 'desc')
|
|
849
|
+
*/
|
|
850
|
+
orderDirection?: string,
|
|
851
|
+
/**
|
|
852
|
+
* Search term to filter mentors by name or description
|
|
853
|
+
*/
|
|
854
|
+
query?: string,
|
|
855
|
+
/**
|
|
856
|
+
* Filter by tags
|
|
857
|
+
*/
|
|
858
|
+
tags?: Array<string>,
|
|
859
|
+
/**
|
|
860
|
+
* Filter by tenant/organization
|
|
861
|
+
*/
|
|
862
|
+
tenant?: string,
|
|
863
|
+
/**
|
|
864
|
+
* Retrieve a specific mentor by UUID
|
|
865
|
+
*/
|
|
866
|
+
uniqueId?: string,
|
|
867
|
+
}): CancelablePromise<MentorSearchResponse> {
|
|
868
|
+
return __request(OpenAPI, {
|
|
869
|
+
method: 'GET',
|
|
870
|
+
url: '/api/search/orgs/{org}/users/{username}/mentors/',
|
|
871
|
+
path: {
|
|
872
|
+
'org': org,
|
|
873
|
+
'username': username,
|
|
874
|
+
},
|
|
875
|
+
query: {
|
|
876
|
+
'audience': audience,
|
|
877
|
+
'category': category,
|
|
878
|
+
'created_by': createdBy,
|
|
879
|
+
'featured': featured,
|
|
880
|
+
'id': id,
|
|
881
|
+
'limit': limit,
|
|
882
|
+
'llm': llm,
|
|
883
|
+
'offset': offset,
|
|
884
|
+
'order_by': orderBy,
|
|
885
|
+
'order_direction': orderDirection,
|
|
886
|
+
'query': query,
|
|
887
|
+
'tags': tags,
|
|
888
|
+
'tenant': tenant,
|
|
889
|
+
'unique_id': uniqueId,
|
|
890
|
+
},
|
|
891
|
+
errors: {
|
|
892
|
+
400: `Bad request`,
|
|
893
|
+
500: `Server error`,
|
|
894
|
+
},
|
|
895
|
+
});
|
|
896
|
+
}
|
|
897
|
+
/**
|
|
898
|
+
* Search and filter AI prompts for a specific user within a tenant.
|
|
899
|
+
*
|
|
900
|
+
* This endpoint extends the base prompt search functionality but filters results
|
|
901
|
+
* to only show prompts that are available to a specific user within a specific
|
|
902
|
+
* organization/tenant.
|
|
903
|
+
*
|
|
904
|
+
* Path Parameters:
|
|
905
|
+
* org (str): The organization/tenant identifier
|
|
906
|
+
* username (str): The username to filter prompts for
|
|
907
|
+
*
|
|
908
|
+
* Query Parameters:
|
|
909
|
+
* Same as PromptSearchView, plus:
|
|
910
|
+
*
|
|
911
|
+
* # Identification parameters (for detail view)
|
|
912
|
+
* id (int, optional): Retrieve a specific prompt by ID
|
|
913
|
+
*
|
|
914
|
+
* Returns:
|
|
915
|
+
* Same format as PromptSearchView, but filtered to only include prompts
|
|
916
|
+
* that the specified user has access to within the specified organization.
|
|
917
|
+
*
|
|
918
|
+
* Error Responses:
|
|
919
|
+
* 400 Bad Request: If the request parameters are invalid
|
|
920
|
+
* 403 Forbidden: If the requested prompt exists but the user doesn't have access
|
|
921
|
+
* 404 Not Found: If the requested prompt doesn't exist
|
|
922
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
923
|
+
*
|
|
924
|
+
* Access Control:
|
|
925
|
+
* - Results are filtered based on user's permissions within the organization
|
|
926
|
+
* - Private prompts are only visible to authorized users
|
|
927
|
+
* @returns PromptSearchResponse
|
|
928
|
+
* @throws ApiError
|
|
929
|
+
*/
|
|
930
|
+
public static searchOrgsUsersPromptsRetrieve({
|
|
931
|
+
org,
|
|
932
|
+
username,
|
|
933
|
+
alphabetical = false,
|
|
934
|
+
category,
|
|
935
|
+
filterFacet,
|
|
936
|
+
language,
|
|
937
|
+
limit = 10,
|
|
938
|
+
mentor,
|
|
939
|
+
offset,
|
|
940
|
+
orderDirection = 'desc',
|
|
941
|
+
query,
|
|
942
|
+
sortBy,
|
|
943
|
+
style,
|
|
944
|
+
tenant,
|
|
945
|
+
tone,
|
|
946
|
+
}: {
|
|
947
|
+
org: string,
|
|
948
|
+
username: string,
|
|
949
|
+
/**
|
|
950
|
+
* Sort alphabetically
|
|
951
|
+
*/
|
|
952
|
+
alphabetical?: boolean,
|
|
953
|
+
/**
|
|
954
|
+
* Filter by prompt category
|
|
955
|
+
*/
|
|
956
|
+
category?: string,
|
|
957
|
+
/**
|
|
958
|
+
* If true, return only facets without results
|
|
959
|
+
*/
|
|
960
|
+
filterFacet?: boolean,
|
|
961
|
+
/**
|
|
962
|
+
* Filter by prompt language
|
|
963
|
+
*/
|
|
964
|
+
language?: string,
|
|
965
|
+
/**
|
|
966
|
+
* Number of results per page
|
|
967
|
+
*/
|
|
968
|
+
limit?: number,
|
|
969
|
+
/**
|
|
970
|
+
* Filter by mentor UUID
|
|
971
|
+
*/
|
|
972
|
+
mentor?: string,
|
|
973
|
+
/**
|
|
974
|
+
* Starting position for pagination
|
|
975
|
+
*/
|
|
976
|
+
offset?: number,
|
|
977
|
+
/**
|
|
978
|
+
* Sort direction ('asc' or 'desc')
|
|
979
|
+
*/
|
|
980
|
+
orderDirection?: string,
|
|
981
|
+
/**
|
|
982
|
+
* Search term to filter prompts by name or content
|
|
983
|
+
*/
|
|
984
|
+
query?: string,
|
|
985
|
+
/**
|
|
986
|
+
* Field to sort results by
|
|
987
|
+
*/
|
|
988
|
+
sortBy?: string,
|
|
989
|
+
/**
|
|
990
|
+
* Filter by prompt style
|
|
991
|
+
*/
|
|
992
|
+
style?: string,
|
|
993
|
+
/**
|
|
994
|
+
* Filter by tenant/organization
|
|
995
|
+
*/
|
|
996
|
+
tenant?: string,
|
|
997
|
+
/**
|
|
998
|
+
* Filter by prompt tone
|
|
999
|
+
*/
|
|
1000
|
+
tone?: string,
|
|
1001
|
+
}): CancelablePromise<PromptSearchResponse> {
|
|
1002
|
+
return __request(OpenAPI, {
|
|
1003
|
+
method: 'GET',
|
|
1004
|
+
url: '/api/search/orgs/{org}/users/{username}/prompts/',
|
|
1005
|
+
path: {
|
|
1006
|
+
'org': org,
|
|
1007
|
+
'username': username,
|
|
1008
|
+
},
|
|
1009
|
+
query: {
|
|
1010
|
+
'alphabetical': alphabetical,
|
|
1011
|
+
'category': category,
|
|
1012
|
+
'filter_facet': filterFacet,
|
|
1013
|
+
'language': language,
|
|
1014
|
+
'limit': limit,
|
|
1015
|
+
'mentor': mentor,
|
|
1016
|
+
'offset': offset,
|
|
1017
|
+
'order_direction': orderDirection,
|
|
1018
|
+
'query': query,
|
|
1019
|
+
'sort_by': sortBy,
|
|
1020
|
+
'style': style,
|
|
1021
|
+
'tenant': tenant,
|
|
1022
|
+
'tone': tone,
|
|
1023
|
+
},
|
|
1024
|
+
errors: {
|
|
1025
|
+
400: `Bad request`,
|
|
1026
|
+
403: `Forbidden`,
|
|
1027
|
+
404: `Not found`,
|
|
1028
|
+
500: `Server error`,
|
|
1029
|
+
},
|
|
1030
|
+
});
|
|
1031
|
+
}
|
|
1032
|
+
/**
|
|
1033
|
+
* Determine whether to serve a detail view or a list view.
|
|
1034
|
+
* @returns RecommendedCoursesResponse
|
|
1035
|
+
* @throws ApiError
|
|
1036
|
+
*/
|
|
1037
|
+
public static searchOrgsUsersRecommendedRetrieve({
|
|
1038
|
+
org,
|
|
1039
|
+
username,
|
|
1040
|
+
certificate,
|
|
1041
|
+
content,
|
|
1042
|
+
courseId,
|
|
1043
|
+
duration,
|
|
1044
|
+
language,
|
|
1045
|
+
level,
|
|
1046
|
+
limit = 12,
|
|
1047
|
+
offset,
|
|
1048
|
+
pathwayId,
|
|
1049
|
+
price,
|
|
1050
|
+
programId,
|
|
1051
|
+
programType,
|
|
1052
|
+
query,
|
|
1053
|
+
resourceId,
|
|
1054
|
+
resourceType,
|
|
1055
|
+
roleId,
|
|
1056
|
+
selfPaced,
|
|
1057
|
+
skillId,
|
|
1058
|
+
skills,
|
|
1059
|
+
subject,
|
|
1060
|
+
tags,
|
|
1061
|
+
topics,
|
|
1062
|
+
}: {
|
|
1063
|
+
org: string,
|
|
1064
|
+
username: string,
|
|
1065
|
+
/**
|
|
1066
|
+
* Filter by certificate type
|
|
1067
|
+
*/
|
|
1068
|
+
certificate?: Array<string>,
|
|
1069
|
+
/**
|
|
1070
|
+
* Content types to include in recommendations (courses, programs, pathways, skills, roles, resources)
|
|
1071
|
+
*/
|
|
1072
|
+
content?: Array<string>,
|
|
1073
|
+
/**
|
|
1074
|
+
* Retrieve a specific course by ID
|
|
1075
|
+
*/
|
|
1076
|
+
courseId?: string,
|
|
1077
|
+
/**
|
|
1078
|
+
* Filter by course duration range
|
|
1079
|
+
*/
|
|
1080
|
+
duration?: Array<string>,
|
|
1081
|
+
/**
|
|
1082
|
+
* Filter by content language
|
|
1083
|
+
*/
|
|
1084
|
+
language?: Array<string>,
|
|
1085
|
+
/**
|
|
1086
|
+
* Filter by difficulty level
|
|
1087
|
+
*/
|
|
1088
|
+
level?: Array<string>,
|
|
1089
|
+
/**
|
|
1090
|
+
* Number of results per page
|
|
1091
|
+
*/
|
|
1092
|
+
limit?: number,
|
|
1093
|
+
/**
|
|
1094
|
+
* Starting position for pagination
|
|
1095
|
+
*/
|
|
1096
|
+
offset?: number,
|
|
1097
|
+
/**
|
|
1098
|
+
* Retrieve a specific pathway by ID
|
|
1099
|
+
*/
|
|
1100
|
+
pathwayId?: string,
|
|
1101
|
+
/**
|
|
1102
|
+
* Filter by price/audit status
|
|
1103
|
+
*/
|
|
1104
|
+
price?: string,
|
|
1105
|
+
/**
|
|
1106
|
+
* Retrieve a specific program by ID
|
|
1107
|
+
*/
|
|
1108
|
+
programId?: string,
|
|
1109
|
+
/**
|
|
1110
|
+
* Filter by program type
|
|
1111
|
+
*/
|
|
1112
|
+
programType?: Array<string>,
|
|
1113
|
+
/**
|
|
1114
|
+
* Search term to filter content by name or description
|
|
1115
|
+
*/
|
|
1116
|
+
query?: string,
|
|
1117
|
+
/**
|
|
1118
|
+
* Retrieve a specific resource by ID
|
|
1119
|
+
*/
|
|
1120
|
+
resourceId?: string,
|
|
1121
|
+
/**
|
|
1122
|
+
* Filter by resource type
|
|
1123
|
+
*/
|
|
1124
|
+
resourceType?: Array<string>,
|
|
1125
|
+
/**
|
|
1126
|
+
* Retrieve a specific role by ID
|
|
1127
|
+
*/
|
|
1128
|
+
roleId?: string,
|
|
1129
|
+
/**
|
|
1130
|
+
* Filter by course format (self-paced, instructor-led)
|
|
1131
|
+
*/
|
|
1132
|
+
selfPaced?: Array<string>,
|
|
1133
|
+
/**
|
|
1134
|
+
* Retrieve a specific skill by ID
|
|
1135
|
+
*/
|
|
1136
|
+
skillId?: string,
|
|
1137
|
+
/**
|
|
1138
|
+
* Filter by skills
|
|
1139
|
+
*/
|
|
1140
|
+
skills?: Array<string>,
|
|
1141
|
+
/**
|
|
1142
|
+
* Filter by subject areas
|
|
1143
|
+
*/
|
|
1144
|
+
subject?: Array<string>,
|
|
1145
|
+
/**
|
|
1146
|
+
* Filter by tags
|
|
1147
|
+
*/
|
|
1148
|
+
tags?: Array<string>,
|
|
1149
|
+
/**
|
|
1150
|
+
* Filter by topic areas
|
|
1151
|
+
*/
|
|
1152
|
+
topics?: Array<string>,
|
|
1153
|
+
}): CancelablePromise<RecommendedCoursesResponse> {
|
|
1154
|
+
return __request(OpenAPI, {
|
|
1155
|
+
method: 'GET',
|
|
1156
|
+
url: '/api/search/orgs/{org}/users/{username}/recommended/',
|
|
1157
|
+
path: {
|
|
1158
|
+
'org': org,
|
|
1159
|
+
'username': username,
|
|
1160
|
+
},
|
|
1161
|
+
query: {
|
|
1162
|
+
'certificate': certificate,
|
|
1163
|
+
'content': content,
|
|
1164
|
+
'course_id': courseId,
|
|
1165
|
+
'duration': duration,
|
|
1166
|
+
'language': language,
|
|
1167
|
+
'level': level,
|
|
1168
|
+
'limit': limit,
|
|
1169
|
+
'offset': offset,
|
|
1170
|
+
'pathway_id': pathwayId,
|
|
1171
|
+
'price': price,
|
|
1172
|
+
'program_id': programId,
|
|
1173
|
+
'program_type': programType,
|
|
1174
|
+
'query': query,
|
|
1175
|
+
'resource_id': resourceId,
|
|
1176
|
+
'resource_type': resourceType,
|
|
1177
|
+
'role_id': roleId,
|
|
1178
|
+
'self_paced': selfPaced,
|
|
1179
|
+
'skill_id': skillId,
|
|
1180
|
+
'skills': skills,
|
|
1181
|
+
'subject': subject,
|
|
1182
|
+
'tags': tags,
|
|
1183
|
+
'topics': topics,
|
|
1184
|
+
},
|
|
1185
|
+
errors: {
|
|
1186
|
+
400: `Bad request`,
|
|
1187
|
+
404: `User not found`,
|
|
1188
|
+
500: `Server error`,
|
|
1189
|
+
},
|
|
1190
|
+
});
|
|
1191
|
+
}
|
|
1192
|
+
/**
|
|
1193
|
+
* Determine whether to serve a detail view or a list view.
|
|
1194
|
+
* If any detail-identifying parameters are present (course_id, program_id, etc.)
|
|
1195
|
+
* the detail view is returned; otherwise the aggregated list view is returned.
|
|
1196
|
+
* @returns any
|
|
1197
|
+
* @throws ApiError
|
|
1198
|
+
*/
|
|
1199
|
+
public static searchPersonalizedCatalogRetrieve({
|
|
1200
|
+
username,
|
|
1201
|
+
allowSkillSearch = false,
|
|
1202
|
+
alphabetical = false,
|
|
1203
|
+
certificate,
|
|
1204
|
+
content,
|
|
1205
|
+
courseId,
|
|
1206
|
+
duration,
|
|
1207
|
+
language,
|
|
1208
|
+
level,
|
|
1209
|
+
limit = 12,
|
|
1210
|
+
offset,
|
|
1211
|
+
orderAscending = false,
|
|
1212
|
+
orderBy,
|
|
1213
|
+
pathwayId,
|
|
1214
|
+
price,
|
|
1215
|
+
programId,
|
|
1216
|
+
programType,
|
|
1217
|
+
promotion,
|
|
1218
|
+
query,
|
|
1219
|
+
recommended = false,
|
|
1220
|
+
resourceId,
|
|
1221
|
+
resourceType,
|
|
1222
|
+
returnFacet = true,
|
|
1223
|
+
returnItems = false,
|
|
1224
|
+
roleId,
|
|
1225
|
+
selfPaced,
|
|
1226
|
+
skillId,
|
|
1227
|
+
skills,
|
|
1228
|
+
subject,
|
|
1229
|
+
tags,
|
|
1230
|
+
tenant,
|
|
1231
|
+
topics,
|
|
1232
|
+
updateFacet,
|
|
1233
|
+
}: {
|
|
1234
|
+
username: string,
|
|
1235
|
+
/**
|
|
1236
|
+
* Enable skill-based search
|
|
1237
|
+
*/
|
|
1238
|
+
allowSkillSearch?: boolean,
|
|
1239
|
+
/**
|
|
1240
|
+
* Sort alphabetically by name
|
|
1241
|
+
*/
|
|
1242
|
+
alphabetical?: boolean,
|
|
1243
|
+
/**
|
|
1244
|
+
* Filter by certificate type
|
|
1245
|
+
*/
|
|
1246
|
+
certificate?: Array<string>,
|
|
1247
|
+
/**
|
|
1248
|
+
* Content types to include in results
|
|
1249
|
+
*/
|
|
1250
|
+
content?: Array<string>,
|
|
1251
|
+
/**
|
|
1252
|
+
* Retrieve a specific course by ID
|
|
1253
|
+
*/
|
|
1254
|
+
courseId?: string,
|
|
1255
|
+
/**
|
|
1256
|
+
* Filter by course duration range
|
|
1257
|
+
*/
|
|
1258
|
+
duration?: Array<string>,
|
|
1259
|
+
/**
|
|
1260
|
+
* Filter by content language
|
|
1261
|
+
*/
|
|
1262
|
+
language?: Array<string>,
|
|
1263
|
+
/**
|
|
1264
|
+
* Filter by difficulty level
|
|
1265
|
+
*/
|
|
1266
|
+
level?: Array<string>,
|
|
1267
|
+
/**
|
|
1268
|
+
* Number of results per page
|
|
1269
|
+
*/
|
|
1270
|
+
limit?: number,
|
|
1271
|
+
/**
|
|
1272
|
+
* Starting position for pagination
|
|
1273
|
+
*/
|
|
1274
|
+
offset?: number,
|
|
1275
|
+
/**
|
|
1276
|
+
* Sort direction
|
|
1277
|
+
*/
|
|
1278
|
+
orderAscending?: boolean,
|
|
1279
|
+
/**
|
|
1280
|
+
* Field to sort results by
|
|
1281
|
+
*/
|
|
1282
|
+
orderBy?: string,
|
|
1283
|
+
/**
|
|
1284
|
+
* Retrieve a specific pathway by ID
|
|
1285
|
+
*/
|
|
1286
|
+
pathwayId?: string,
|
|
1287
|
+
/**
|
|
1288
|
+
* Filter by price/audit status
|
|
1289
|
+
*/
|
|
1290
|
+
price?: string,
|
|
1291
|
+
/**
|
|
1292
|
+
* Retrieve a specific program by ID
|
|
1293
|
+
*/
|
|
1294
|
+
programId?: string,
|
|
1295
|
+
/**
|
|
1296
|
+
* Filter by program type
|
|
1297
|
+
*/
|
|
1298
|
+
programType?: Array<string>,
|
|
1299
|
+
/**
|
|
1300
|
+
* Filter by promotion status
|
|
1301
|
+
*/
|
|
1302
|
+
promotion?: Array<string>,
|
|
1303
|
+
/**
|
|
1304
|
+
* Search term to filter content by name or description
|
|
1305
|
+
*/
|
|
1306
|
+
query?: string,
|
|
1307
|
+
/**
|
|
1308
|
+
* Show only recommended content
|
|
1309
|
+
*/
|
|
1310
|
+
recommended?: boolean,
|
|
1311
|
+
/**
|
|
1312
|
+
* Retrieve a specific resource by ID
|
|
1313
|
+
*/
|
|
1314
|
+
resourceId?: string,
|
|
1315
|
+
/**
|
|
1316
|
+
* Filter by resource type
|
|
1317
|
+
*/
|
|
1318
|
+
resourceType?: Array<string>,
|
|
1319
|
+
/**
|
|
1320
|
+
* Include facet data in response
|
|
1321
|
+
*/
|
|
1322
|
+
returnFacet?: boolean,
|
|
1323
|
+
/**
|
|
1324
|
+
* Include items in programs/pathways
|
|
1325
|
+
*/
|
|
1326
|
+
returnItems?: boolean,
|
|
1327
|
+
/**
|
|
1328
|
+
* Retrieve a specific role by ID
|
|
1329
|
+
*/
|
|
1330
|
+
roleId?: string,
|
|
1331
|
+
/**
|
|
1332
|
+
* Filter by course format
|
|
1333
|
+
*/
|
|
1334
|
+
selfPaced?: Array<string>,
|
|
1335
|
+
/**
|
|
1336
|
+
* Retrieve a specific skill by ID
|
|
1337
|
+
*/
|
|
1338
|
+
skillId?: string,
|
|
1339
|
+
/**
|
|
1340
|
+
* Filter by skills
|
|
1341
|
+
*/
|
|
1342
|
+
skills?: Array<string>,
|
|
1343
|
+
/**
|
|
1344
|
+
* Filter by subject areas
|
|
1345
|
+
*/
|
|
1346
|
+
subject?: Array<string>,
|
|
1347
|
+
/**
|
|
1348
|
+
* Filter by tags
|
|
1349
|
+
*/
|
|
1350
|
+
tags?: Array<string>,
|
|
1351
|
+
/**
|
|
1352
|
+
* Filter by tenant/organization
|
|
1353
|
+
*/
|
|
1354
|
+
tenant?: Array<string>,
|
|
1355
|
+
/**
|
|
1356
|
+
* Filter by topic areas
|
|
1357
|
+
*/
|
|
1358
|
+
topics?: Array<string>,
|
|
1359
|
+
/**
|
|
1360
|
+
* Force facet update
|
|
1361
|
+
*/
|
|
1362
|
+
updateFacet?: string,
|
|
1363
|
+
}): CancelablePromise<Record<string, any>> {
|
|
1364
|
+
return __request(OpenAPI, {
|
|
1365
|
+
method: 'GET',
|
|
1366
|
+
url: '/api/search/personalized-catalog/{username}/',
|
|
1367
|
+
path: {
|
|
1368
|
+
'username': username,
|
|
1369
|
+
},
|
|
1370
|
+
query: {
|
|
1371
|
+
'allow_skill_search': allowSkillSearch,
|
|
1372
|
+
'alphabetical': alphabetical,
|
|
1373
|
+
'certificate': certificate,
|
|
1374
|
+
'content': content,
|
|
1375
|
+
'course_id': courseId,
|
|
1376
|
+
'duration': duration,
|
|
1377
|
+
'language': language,
|
|
1378
|
+
'level': level,
|
|
1379
|
+
'limit': limit,
|
|
1380
|
+
'offset': offset,
|
|
1381
|
+
'order_ascending': orderAscending,
|
|
1382
|
+
'order_by': orderBy,
|
|
1383
|
+
'pathway_id': pathwayId,
|
|
1384
|
+
'price': price,
|
|
1385
|
+
'program_id': programId,
|
|
1386
|
+
'program_type': programType,
|
|
1387
|
+
'promotion': promotion,
|
|
1388
|
+
'query': query,
|
|
1389
|
+
'recommended': recommended,
|
|
1390
|
+
'resource_id': resourceId,
|
|
1391
|
+
'resource_type': resourceType,
|
|
1392
|
+
'return_facet': returnFacet,
|
|
1393
|
+
'return_items': returnItems,
|
|
1394
|
+
'role_id': roleId,
|
|
1395
|
+
'self_paced': selfPaced,
|
|
1396
|
+
'skill_id': skillId,
|
|
1397
|
+
'skills': skills,
|
|
1398
|
+
'subject': subject,
|
|
1399
|
+
'tags': tags,
|
|
1400
|
+
'tenant': tenant,
|
|
1401
|
+
'topics': topics,
|
|
1402
|
+
'update_facet': updateFacet,
|
|
1403
|
+
},
|
|
1404
|
+
});
|
|
1405
|
+
}
|
|
1406
|
+
/**
|
|
1407
|
+
* Search and filter AI prompts across the platform.
|
|
1408
|
+
*
|
|
1409
|
+
* This endpoint provides a search interface for discovering AI prompts
|
|
1410
|
+
* with support for filtering, pagination, and detailed prompt information.
|
|
1411
|
+
*
|
|
1412
|
+
* Query Parameters:
|
|
1413
|
+
* # Identification parameters (for detail view)
|
|
1414
|
+
* id (int, optional): Retrieve a specific prompt by ID
|
|
1415
|
+
*
|
|
1416
|
+
* # Search and filtering parameters
|
|
1417
|
+
* query (str, optional): Search term to filter prompts by name or content
|
|
1418
|
+
* category (str, optional): Filter by prompt category
|
|
1419
|
+
* language (str, optional): Filter by prompt language
|
|
1420
|
+
* style (str, optional): Filter by writing style
|
|
1421
|
+
* tone (str, optional): Filter by tone
|
|
1422
|
+
* tenant (str, optional): Filter by tenant/organization
|
|
1423
|
+
* mentor (str, optional): Filter by associated mentor (UUID)
|
|
1424
|
+
*
|
|
1425
|
+
* # Sorting and pagination
|
|
1426
|
+
* sort_by (str, optional): Field to sort results by
|
|
1427
|
+
* order_direction (str, optional): Sort direction ('asc' or 'desc', default: 'desc')
|
|
1428
|
+
* alphabetical (bool, optional): Sort alphabetically by name (default: false)
|
|
1429
|
+
* limit (int, optional): Number of results per page (default: 10)
|
|
1430
|
+
* offset (int, optional): Starting position for pagination
|
|
1431
|
+
*
|
|
1432
|
+
* # Special parameters
|
|
1433
|
+
* filter_facet (any, optional): If present, return only facets without results
|
|
1434
|
+
*
|
|
1435
|
+
* Returns:
|
|
1436
|
+
* For detail view (when id is provided):
|
|
1437
|
+
* A JSON response containing a single prompt's details:
|
|
1438
|
+
* {
|
|
1439
|
+
* "id": 456,
|
|
1440
|
+
* "name": "Essay Writing Guide",
|
|
1441
|
+
* "content": "Write a well-structured essay on the following topic: {{topic}}...",
|
|
1442
|
+
* "category": "Academic Writing",
|
|
1443
|
+
* "language": "English",
|
|
1444
|
+
* "style": "Formal",
|
|
1445
|
+
* "tone": "Professional",
|
|
1446
|
+
* "mentor": {
|
|
1447
|
+
* "id": 123,
|
|
1448
|
+
* "unique_id": "550e8400-e29b-41d4-a716-446655440000",
|
|
1449
|
+
* "name": "Professor Smith"
|
|
1450
|
+
* },
|
|
1451
|
+
* "platform": {
|
|
1452
|
+
* "id": 1,
|
|
1453
|
+
* "name": "Example University",
|
|
1454
|
+
* "key": "example-university"
|
|
1455
|
+
* },
|
|
1456
|
+
* "created_at": "2023-02-10T09:15:00Z",
|
|
1457
|
+
* "updated_at": "2023-05-05T14:20:00Z",
|
|
1458
|
+
* "visibility": "public",
|
|
1459
|
+
* "variables": ["topic", "length", "style"]
|
|
1460
|
+
* }
|
|
1461
|
+
*
|
|
1462
|
+
* For list view:
|
|
1463
|
+
* A JSON response containing:
|
|
1464
|
+
* {
|
|
1465
|
+
* "results": [
|
|
1466
|
+
* {
|
|
1467
|
+
* "id": 456,
|
|
1468
|
+
* "name": "Essay Writing Guide",
|
|
1469
|
+
* "content": "Write a well-structured essay on the following topic: {{topic}}...",
|
|
1470
|
+
* "category": "Academic Writing",
|
|
1471
|
+
* "language": "English",
|
|
1472
|
+
* "style": "Formal",
|
|
1473
|
+
* "tone": "Professional",
|
|
1474
|
+
* "mentor": {"id": 123, "name": "Professor Smith"},
|
|
1475
|
+
* "created_at": "2023-02-10T09:15:00Z",
|
|
1476
|
+
* "updated_at": "2023-05-05T14:20:00Z"
|
|
1477
|
+
* },
|
|
1478
|
+
* // Additional prompt objects...
|
|
1479
|
+
* ],
|
|
1480
|
+
* "count": 30,
|
|
1481
|
+
* "next": "?limit=10&offset=10",
|
|
1482
|
+
* "previous": null,
|
|
1483
|
+
* "current_page": 1,
|
|
1484
|
+
* "num_pages": 3,
|
|
1485
|
+
* "facets": {
|
|
1486
|
+
* "category": [
|
|
1487
|
+
* {"key": "Academic Writing", "doc_count": 15},
|
|
1488
|
+
* {"key": "Creative Writing", "doc_count": 10},
|
|
1489
|
+
* {"key": "Technical Documentation", "doc_count": 5}
|
|
1490
|
+
* ],
|
|
1491
|
+
* "language": [
|
|
1492
|
+
* {"key": "English", "doc_count": 25},
|
|
1493
|
+
* {"key": "Spanish", "doc_count": 5}
|
|
1494
|
+
* ],
|
|
1495
|
+
* "style": [
|
|
1496
|
+
* {"key": "Formal", "doc_count": 20},
|
|
1497
|
+
* {"key": "Casual", "doc_count": 10}
|
|
1498
|
+
* ],
|
|
1499
|
+
* "tone": [
|
|
1500
|
+
* {"key": "Professional", "doc_count": 15},
|
|
1501
|
+
* {"key": "Friendly", "doc_count": 10},
|
|
1502
|
+
* {"key": "Technical", "doc_count": 5}
|
|
1503
|
+
* ]
|
|
1504
|
+
* }
|
|
1505
|
+
* }
|
|
1506
|
+
*
|
|
1507
|
+
* Error Responses:
|
|
1508
|
+
* 400 Bad Request: If the request parameters are invalid
|
|
1509
|
+
* 403 Forbidden: If the requested prompt exists but is not publicly available
|
|
1510
|
+
* 404 Not Found: If the requested prompt doesn't exist
|
|
1511
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
1512
|
+
*
|
|
1513
|
+
* Notes:
|
|
1514
|
+
* - Only publicly available prompts are returned by default
|
|
1515
|
+
* - When filtering by mentor, the mentor ID must be a valid UUID
|
|
1516
|
+
* @returns PromptSearchResponse
|
|
1517
|
+
* @throws ApiError
|
|
1518
|
+
*/
|
|
1519
|
+
public static searchPromptsRetrieve({
|
|
1520
|
+
alphabetical = false,
|
|
1521
|
+
category,
|
|
1522
|
+
filterFacet,
|
|
1523
|
+
language,
|
|
1524
|
+
limit = 10,
|
|
1525
|
+
mentor,
|
|
1526
|
+
offset,
|
|
1527
|
+
orderDirection = 'desc',
|
|
1528
|
+
query,
|
|
1529
|
+
sortBy,
|
|
1530
|
+
style,
|
|
1531
|
+
tenant,
|
|
1532
|
+
tone,
|
|
1533
|
+
}: {
|
|
1534
|
+
/**
|
|
1535
|
+
* Sort alphabetically
|
|
1536
|
+
*/
|
|
1537
|
+
alphabetical?: boolean,
|
|
1538
|
+
/**
|
|
1539
|
+
* Filter by prompt category
|
|
1540
|
+
*/
|
|
1541
|
+
category?: string,
|
|
1542
|
+
/**
|
|
1543
|
+
* If true, return only facets without results
|
|
1544
|
+
*/
|
|
1545
|
+
filterFacet?: boolean,
|
|
1546
|
+
/**
|
|
1547
|
+
* Filter by prompt language
|
|
1548
|
+
*/
|
|
1549
|
+
language?: string,
|
|
1550
|
+
/**
|
|
1551
|
+
* Number of results per page
|
|
1552
|
+
*/
|
|
1553
|
+
limit?: number,
|
|
1554
|
+
/**
|
|
1555
|
+
* Filter by mentor UUID
|
|
1556
|
+
*/
|
|
1557
|
+
mentor?: string,
|
|
1558
|
+
/**
|
|
1559
|
+
* Starting position for pagination
|
|
1560
|
+
*/
|
|
1561
|
+
offset?: number,
|
|
1562
|
+
/**
|
|
1563
|
+
* Sort direction ('asc' or 'desc')
|
|
1564
|
+
*/
|
|
1565
|
+
orderDirection?: string,
|
|
1566
|
+
/**
|
|
1567
|
+
* Search term to filter prompts by name or content
|
|
1568
|
+
*/
|
|
1569
|
+
query?: string,
|
|
1570
|
+
/**
|
|
1571
|
+
* Field to sort results by
|
|
1572
|
+
*/
|
|
1573
|
+
sortBy?: string,
|
|
1574
|
+
/**
|
|
1575
|
+
* Filter by prompt style
|
|
1576
|
+
*/
|
|
1577
|
+
style?: string,
|
|
1578
|
+
/**
|
|
1579
|
+
* Filter by tenant/organization
|
|
1580
|
+
*/
|
|
1581
|
+
tenant?: string,
|
|
1582
|
+
/**
|
|
1583
|
+
* Filter by prompt tone
|
|
1584
|
+
*/
|
|
1585
|
+
tone?: string,
|
|
1586
|
+
}): CancelablePromise<PromptSearchResponse> {
|
|
1587
|
+
return __request(OpenAPI, {
|
|
1588
|
+
method: 'GET',
|
|
1589
|
+
url: '/api/search/prompts/',
|
|
1590
|
+
query: {
|
|
1591
|
+
'alphabetical': alphabetical,
|
|
1592
|
+
'category': category,
|
|
1593
|
+
'filter_facet': filterFacet,
|
|
1594
|
+
'language': language,
|
|
1595
|
+
'limit': limit,
|
|
1596
|
+
'mentor': mentor,
|
|
1597
|
+
'offset': offset,
|
|
1598
|
+
'order_direction': orderDirection,
|
|
1599
|
+
'query': query,
|
|
1600
|
+
'sort_by': sortBy,
|
|
1601
|
+
'style': style,
|
|
1602
|
+
'tenant': tenant,
|
|
1603
|
+
'tone': tone,
|
|
1604
|
+
},
|
|
1605
|
+
errors: {
|
|
1606
|
+
400: `Bad request`,
|
|
1607
|
+
500: `Server error`,
|
|
1608
|
+
},
|
|
1609
|
+
});
|
|
1610
|
+
}
|
|
1611
|
+
/**
|
|
1612
|
+
* Search and filter users within a specific organization/tenant.
|
|
1613
|
+
*
|
|
1614
|
+
* This endpoint provides a search interface for discovering users within an organization,
|
|
1615
|
+
* with support for filtering by departments, pagination, and faceted filtering.
|
|
1616
|
+
*
|
|
1617
|
+
* Path Parameters:
|
|
1618
|
+
* org (str): The organization/tenant identifier
|
|
1619
|
+
* username (str): The username of the user making the request
|
|
1620
|
+
*
|
|
1621
|
+
* Query Parameters:
|
|
1622
|
+
* # Search parameters
|
|
1623
|
+
* query (str, optional): Search term to filter users by name, username, or email
|
|
1624
|
+
*
|
|
1625
|
+
* # Department filtering
|
|
1626
|
+
* department_mode (bool, optional): Enable department-based filtering (default: false)
|
|
1627
|
+
* user_department (bool, optional): Legacy parameter for department_mode (default: false)
|
|
1628
|
+
* department (list, optional): Filter by specific departments
|
|
1629
|
+
*
|
|
1630
|
+
* # Additional filters
|
|
1631
|
+
* role (list, optional): Filter by user role
|
|
1632
|
+
* status (list, optional): Filter by user status (active, inactive)
|
|
1633
|
+
* joined_date (list, optional): Filter by join date range
|
|
1634
|
+
* last_login (list, optional): Filter by last login date range
|
|
1635
|
+
*
|
|
1636
|
+
* # Pagination
|
|
1637
|
+
* limit (int, optional): Number of results per page (default: 10)
|
|
1638
|
+
* offset (int, optional): Starting position for pagination
|
|
1639
|
+
*
|
|
1640
|
+
* Returns:
|
|
1641
|
+
* A JSON response containing:
|
|
1642
|
+
* ```
|
|
1643
|
+
* {
|
|
1644
|
+
* "results": [
|
|
1645
|
+
* {
|
|
1646
|
+
* "id": 123,
|
|
1647
|
+
* "username": "john.doe",
|
|
1648
|
+
* "email": "john.doe@example.com",
|
|
1649
|
+
* "first_name": "John",
|
|
1650
|
+
* "last_name": "Doe",
|
|
1651
|
+
* "full_name": "John Doe",
|
|
1652
|
+
* "profile_image": "https://example.com/profiles/john-doe.jpg",
|
|
1653
|
+
* "role": "Student",
|
|
1654
|
+
* "departments": ["Computer Science", "Data Science"],
|
|
1655
|
+
* "status": "active",
|
|
1656
|
+
* "joined_date": "2023-01-15T12:00:00Z",
|
|
1657
|
+
* "last_login": "2023-06-20T15:30:00Z",
|
|
1658
|
+
* "metadata": {
|
|
1659
|
+
* "location": "New York",
|
|
1660
|
+
* "title": "Software Engineer",
|
|
1661
|
+
* "bio": "Experienced software engineer with a passion for education"
|
|
1662
|
+
* }
|
|
1663
|
+
* },
|
|
1664
|
+
* // Additional user objects...
|
|
1665
|
+
* ],
|
|
1666
|
+
* "count": 50,
|
|
1667
|
+
* "next": "https://api.example.com/api/search/users/example-org/admin/?limit=10&offset=10",
|
|
1668
|
+
* "previous": null,
|
|
1669
|
+
* "current_page": 1,
|
|
1670
|
+
* "total_pages": 5,
|
|
1671
|
+
* "facets": {
|
|
1672
|
+
* "role": [
|
|
1673
|
+
* {"key": "Student", "doc_count": 30},
|
|
1674
|
+
* {"key": "Instructor", "doc_count": 15},
|
|
1675
|
+
* {"key": "Admin", "doc_count": 5}
|
|
1676
|
+
* ],
|
|
1677
|
+
* "department": [
|
|
1678
|
+
* {"key": "Computer Science", "doc_count": 20},
|
|
1679
|
+
* {"key": "Data Science", "doc_count": 15},
|
|
1680
|
+
* {"key": "Business", "doc_count": 10},
|
|
1681
|
+
* {"key": "Engineering", "doc_count": 5}
|
|
1682
|
+
* ],
|
|
1683
|
+
* "status": [
|
|
1684
|
+
* {"key": "active", "doc_count": 45},
|
|
1685
|
+
* {"key": "inactive", "doc_count": 5}
|
|
1686
|
+
* ]
|
|
1687
|
+
* }
|
|
1688
|
+
* }
|
|
1689
|
+
* ```
|
|
1690
|
+
* Error Responses:
|
|
1691
|
+
* 400 Bad Request: If the request parameters are invalid
|
|
1692
|
+
* 403 Forbidden: If the user doesn't have department admin privileges (when using department_mode)
|
|
1693
|
+
* 404 Not Found: If the user or organization doesn't exist
|
|
1694
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
1695
|
+
*
|
|
1696
|
+
* Access Control:
|
|
1697
|
+
* - The requesting user must have an active account in the specified organization
|
|
1698
|
+
* - When department_mode is enabled, the user must be an admin of at least one department
|
|
1699
|
+
* - Department filtering restricts results to users in departments where the requesting user is an admin
|
|
1700
|
+
* @returns UserSearchResponse
|
|
1701
|
+
* @throws ApiError
|
|
1702
|
+
*/
|
|
1703
|
+
public static searchUsersOrgsUsersRetrieve({
|
|
1704
|
+
org,
|
|
1705
|
+
username,
|
|
1706
|
+
department,
|
|
1707
|
+
educationDegree,
|
|
1708
|
+
educationFieldOfStudy,
|
|
1709
|
+
educationInstitution,
|
|
1710
|
+
includeMembershipData = false,
|
|
1711
|
+
limit = 10,
|
|
1712
|
+
offset,
|
|
1713
|
+
q,
|
|
1714
|
+
userResumeCompany,
|
|
1715
|
+
userResumeIndustry,
|
|
1716
|
+
userResumeJobTitle,
|
|
1717
|
+
userResumeLocation,
|
|
1718
|
+
userResumeSkills,
|
|
1719
|
+
}: {
|
|
1720
|
+
org: string,
|
|
1721
|
+
username: string,
|
|
1722
|
+
/**
|
|
1723
|
+
* Filter by department names
|
|
1724
|
+
*/
|
|
1725
|
+
department?: Array<string>,
|
|
1726
|
+
/**
|
|
1727
|
+
* Filter by degree
|
|
1728
|
+
*/
|
|
1729
|
+
educationDegree?: string,
|
|
1730
|
+
/**
|
|
1731
|
+
* Filter by field of study
|
|
1732
|
+
*/
|
|
1733
|
+
educationFieldOfStudy?: string,
|
|
1734
|
+
/**
|
|
1735
|
+
* Filter by institution
|
|
1736
|
+
*/
|
|
1737
|
+
educationInstitution?: string,
|
|
1738
|
+
/**
|
|
1739
|
+
* Include user group membership data in results
|
|
1740
|
+
*/
|
|
1741
|
+
includeMembershipData?: boolean,
|
|
1742
|
+
/**
|
|
1743
|
+
* Number of results per page
|
|
1744
|
+
*/
|
|
1745
|
+
limit?: number,
|
|
1746
|
+
/**
|
|
1747
|
+
* Starting position for pagination
|
|
1748
|
+
*/
|
|
1749
|
+
offset?: number,
|
|
1750
|
+
/**
|
|
1751
|
+
* Search term to filter users by name, email, or other attributes
|
|
1752
|
+
*/
|
|
1753
|
+
q?: string,
|
|
1754
|
+
/**
|
|
1755
|
+
* Filter by company
|
|
1756
|
+
*/
|
|
1757
|
+
userResumeCompany?: string,
|
|
1758
|
+
/**
|
|
1759
|
+
* Filter by industry
|
|
1760
|
+
*/
|
|
1761
|
+
userResumeIndustry?: string,
|
|
1762
|
+
/**
|
|
1763
|
+
* Filter by job title
|
|
1764
|
+
*/
|
|
1765
|
+
userResumeJobTitle?: string,
|
|
1766
|
+
/**
|
|
1767
|
+
* Filter by location
|
|
1768
|
+
*/
|
|
1769
|
+
userResumeLocation?: string,
|
|
1770
|
+
/**
|
|
1771
|
+
* Filter by skills
|
|
1772
|
+
*/
|
|
1773
|
+
userResumeSkills?: string,
|
|
1774
|
+
}): CancelablePromise<UserSearchResponse> {
|
|
1775
|
+
return __request(OpenAPI, {
|
|
1776
|
+
method: 'GET',
|
|
1777
|
+
url: '/api/search/users/orgs/{org}/users/{username}/',
|
|
1778
|
+
path: {
|
|
1779
|
+
'org': org,
|
|
1780
|
+
'username': username,
|
|
1781
|
+
},
|
|
1782
|
+
query: {
|
|
1783
|
+
'department': department,
|
|
1784
|
+
'education__degree': educationDegree,
|
|
1785
|
+
'education__field_of_study': educationFieldOfStudy,
|
|
1786
|
+
'education__institution': educationInstitution,
|
|
1787
|
+
'include_membership_data': includeMembershipData,
|
|
1788
|
+
'limit': limit,
|
|
1789
|
+
'offset': offset,
|
|
1790
|
+
'q': q,
|
|
1791
|
+
'user_resume__company': userResumeCompany,
|
|
1792
|
+
'user_resume__industry': userResumeIndustry,
|
|
1793
|
+
'user_resume__job_title': userResumeJobTitle,
|
|
1794
|
+
'user_resume__location': userResumeLocation,
|
|
1795
|
+
'user_resume__skills': userResumeSkills,
|
|
1796
|
+
},
|
|
1797
|
+
errors: {
|
|
1798
|
+
400: `Bad request`,
|
|
1799
|
+
403: `Forbidden`,
|
|
1800
|
+
404: `Not found`,
|
|
1801
|
+
500: `Server error`,
|
|
1802
|
+
},
|
|
1803
|
+
});
|
|
1804
|
+
}
|
|
1805
|
+
}
|