@iblai/iblai-api 3.48.2-core → 3.48.3-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 +16420 -112
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +16412 -113
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +16420 -112
- 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 +294 -0
- package/dist/types/services/AiAnalyticsService.d.ts +2801 -0
- package/dist/types/services/AiBotService.d.ts +486 -0
- package/dist/types/services/AiFinetuningService.d.ts +162 -0
- package/dist/types/services/AiIndexService.d.ts +400 -0
- package/dist/types/services/AiMarketingService.d.ts +34 -0
- package/dist/types/services/AiMediaService.d.ts +118 -0
- package/dist/types/services/AiMentorService.d.ts +4235 -0
- package/dist/types/services/AiPromptService.d.ts +920 -0
- package/dist/types/services/CoreService.d.ts +10 -5
- package/dist/types/services/SearchService.d.ts +408 -0
- 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 +479 -0
- package/src/services/AiAnalyticsService.ts +5198 -0
- package/src/services/AiBotService.ts +1174 -0
- package/src/services/AiFinetuningService.ts +402 -0
- package/src/services/AiIndexService.ts +693 -0
- package/src/services/AiMarketingService.ts +87 -0
- package/src/services/AiMediaService.ts +273 -0
- package/src/services/AiMentorService.ts +7977 -0
- package/src/services/AiPromptService.ts +1771 -0
- package/src/services/CoreService.ts +25 -0
- package/src/services/SearchService.ts +981 -261
|
@@ -2,12 +2,82 @@
|
|
|
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
|
+
* @param audience Filter by target audience
|
|
18
|
+
* @param category Filter by mentor category
|
|
19
|
+
* @param createdBy Filter mentors created by specific user
|
|
20
|
+
* @param filterFacet If present, return only facets without results
|
|
21
|
+
* @param id Retrieve a specific mentor by ID
|
|
22
|
+
* @param limit Number of results per page
|
|
23
|
+
* @param llm Filter by language model type
|
|
24
|
+
* @param offset Starting position for pagination
|
|
25
|
+
* @param orderBy Field to sort results by ('created_at', 'recently_accessed_at')
|
|
26
|
+
* @param orderDirection Sort direction ('asc' or 'desc')
|
|
27
|
+
* @param page Page number (1-based, used with page_size)
|
|
28
|
+
* @param pageSize Number of results per page
|
|
29
|
+
* @param query Search term to filter mentors by name or description
|
|
30
|
+
* @param tags Filter by tags
|
|
31
|
+
* @param tenant Filter by tenant/organization
|
|
32
|
+
* @param uniqueId Retrieve a specific mentor by UUID
|
|
33
|
+
* @returns MentorSearchResponse
|
|
34
|
+
* @throws ApiError
|
|
35
|
+
*/
|
|
36
|
+
public static searchAiSearchRetrieve(
|
|
37
|
+
audience?: Array<string>,
|
|
38
|
+
category?: Array<string>,
|
|
39
|
+
createdBy?: string,
|
|
40
|
+
filterFacet: boolean = false,
|
|
41
|
+
id?: number,
|
|
42
|
+
limit: number = 12,
|
|
43
|
+
llm?: Array<string>,
|
|
44
|
+
offset?: number,
|
|
45
|
+
orderBy?: string,
|
|
46
|
+
orderDirection: string = 'desc',
|
|
47
|
+
page?: number,
|
|
48
|
+
pageSize?: number,
|
|
49
|
+
query?: string,
|
|
50
|
+
tags?: Array<string>,
|
|
51
|
+
tenant?: string,
|
|
52
|
+
uniqueId?: string,
|
|
53
|
+
): CancelablePromise<MentorSearchResponse> {
|
|
54
|
+
return __request(OpenAPI, {
|
|
55
|
+
method: 'GET',
|
|
56
|
+
url: '/api/search/ai-search/',
|
|
57
|
+
query: {
|
|
58
|
+
'audience': audience,
|
|
59
|
+
'category': category,
|
|
60
|
+
'created_by': createdBy,
|
|
61
|
+
'filter_facet': filterFacet,
|
|
62
|
+
'id': id,
|
|
63
|
+
'limit': limit,
|
|
64
|
+
'llm': llm,
|
|
65
|
+
'offset': offset,
|
|
66
|
+
'order_by': orderBy,
|
|
67
|
+
'order_direction': orderDirection,
|
|
68
|
+
'page': page,
|
|
69
|
+
'page_size': pageSize,
|
|
70
|
+
'query': query,
|
|
71
|
+
'tags': tags,
|
|
72
|
+
'tenant': tenant,
|
|
73
|
+
'unique_id': uniqueId,
|
|
74
|
+
},
|
|
75
|
+
errors: {
|
|
76
|
+
400: `Bad request`,
|
|
77
|
+
500: `Server error`,
|
|
78
|
+
},
|
|
79
|
+
});
|
|
80
|
+
}
|
|
11
81
|
/**
|
|
12
82
|
* Search and filter content across the learning catalog.
|
|
13
83
|
*
|
|
@@ -277,274 +347,924 @@ export class SearchService {
|
|
|
277
347
|
});
|
|
278
348
|
}
|
|
279
349
|
/**
|
|
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.
|
|
398
|
-
*
|
|
399
|
-
* This endpoint provides a search interface for discovering users within an organization,
|
|
400
|
-
* with support for filtering by departments, pagination, and faceted filtering.
|
|
350
|
+
* Search and filter AI mentors across the platform.
|
|
401
351
|
*
|
|
402
|
-
*
|
|
403
|
-
*
|
|
404
|
-
* username (str): The username of the user making the request
|
|
352
|
+
* This endpoint provides a powerful search interface for discovering AI mentors
|
|
353
|
+
* with support for filtering, pagination, and detailed mentor information.
|
|
405
354
|
*
|
|
406
355
|
* 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
|
|
356
|
+
* # Identification parameters (for detail view)
|
|
357
|
+
* id (int, optional): Retrieve a specific mentor by ID
|
|
358
|
+
* unique_id (uuid, optional): Retrieve a specific mentor by UUID
|
|
414
359
|
*
|
|
415
|
-
* #
|
|
416
|
-
*
|
|
417
|
-
*
|
|
418
|
-
*
|
|
419
|
-
*
|
|
360
|
+
* # Search and filtering parameters
|
|
361
|
+
* query (str, optional): Search term to filter mentors by name or description
|
|
362
|
+
* tenant (str, optional): Filter by tenant/organization
|
|
363
|
+
* llm (list, optional): Filter by language model type
|
|
364
|
+
* audience (list, optional): Filter by target audience
|
|
365
|
+
* category (list, optional): Filter by mentor category
|
|
366
|
+
* tags (list, optional): Filter by tags
|
|
367
|
+
* created_by (str, optional): Filter mentors created by specific user
|
|
420
368
|
*
|
|
421
|
-
* #
|
|
422
|
-
*
|
|
369
|
+
* # Sorting and pagination
|
|
370
|
+
* order_by (str, optional): Field to sort results by ('created_at', 'recently_accessed_at')
|
|
371
|
+
* order_direction (str, optional): Sort direction ('asc' or 'desc', default: 'desc')
|
|
372
|
+
* limit (int, optional): Number of results per page (default: 12, max: 100)
|
|
423
373
|
* offset (int, optional): Starting position for pagination
|
|
424
374
|
*
|
|
425
375
|
* Returns:
|
|
426
|
-
*
|
|
427
|
-
*
|
|
376
|
+
* For detail view (when id or unique_id is provided):
|
|
377
|
+
* A JSON response containing a single mentor's details:
|
|
428
378
|
* {
|
|
429
|
-
* "
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
* "
|
|
441
|
-
* "
|
|
442
|
-
* "
|
|
443
|
-
*
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
379
|
+
* "id": 123,
|
|
380
|
+
* "unique_id": "550e8400-e29b-41d4-a716-446655440000",
|
|
381
|
+
* "name": "Professor Smith",
|
|
382
|
+
* "description": "AI mentor specializing in computer science",
|
|
383
|
+
* "image_url": "https://example.com/images/prof-smith.jpg",
|
|
384
|
+
* "llm": {
|
|
385
|
+
* "id": 1,
|
|
386
|
+
* "name": "GPT-4",
|
|
387
|
+
* "description": "Advanced language model"
|
|
388
|
+
* },
|
|
389
|
+
* "audience": {
|
|
390
|
+
* "id": 2,
|
|
391
|
+
* "name": "College Students",
|
|
392
|
+
* "description": "For university-level learners"
|
|
393
|
+
* },
|
|
394
|
+
* "category": "Computer Science",
|
|
395
|
+
* "tags": ["programming", "algorithms", "data structures"],
|
|
396
|
+
* "created_at": "2023-01-15T12:00:00Z",
|
|
397
|
+
* "recently_accessed_at": "2023-06-20T15:30:00Z",
|
|
398
|
+
* "platform": {
|
|
399
|
+
* "id": 1,
|
|
400
|
+
* "name": "Example University",
|
|
401
|
+
* "key": "example-university"
|
|
448
402
|
* },
|
|
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
|
-
|
|
403
|
+
* "visibility": "public",
|
|
404
|
+
* "settings": {
|
|
405
|
+
* "temperature": 0.7,
|
|
406
|
+
* "max_tokens": 1024,
|
|
407
|
+
* "system_prompt": "You are Professor Smith, an expert in computer science..."
|
|
408
|
+
* }
|
|
409
|
+
* }
|
|
410
|
+
*
|
|
411
|
+
* For list view:
|
|
412
|
+
* A JSON response containing:
|
|
413
|
+
* {
|
|
414
|
+
* "results": [
|
|
415
|
+
* {
|
|
416
|
+
* "id": 123,
|
|
417
|
+
* "unique_id": "550e8400-e29b-41d4-a716-446655440000",
|
|
418
|
+
* "name": "Professor Smith",
|
|
419
|
+
* "description": "AI mentor specializing in computer science",
|
|
420
|
+
* "image_url": "https://example.com/images/prof-smith.jpg",
|
|
421
|
+
* "llm": {"id": 1, "name": "GPT-4"},
|
|
422
|
+
* "audience": {"id": 2, "name": "College Students"},
|
|
423
|
+
* "category": "Computer Science",
|
|
424
|
+
* "tags": ["programming", "algorithms"],
|
|
425
|
+
* "created_at": "2023-01-15T12:00:00Z",
|
|
426
|
+
* "recently_accessed_at": "2023-06-20T15:30:00Z"
|
|
427
|
+
* },
|
|
428
|
+
* // Additional mentor objects...
|
|
429
|
+
* ],
|
|
430
|
+
* "count": 50,
|
|
431
|
+
* "next": "https://api.example.com/api/search/mentors/?limit=12&offset=12",
|
|
432
|
+
* "previous": null,
|
|
433
|
+
* "current_page": 1,
|
|
434
|
+
* "num_pages": 5,
|
|
435
|
+
* "facets": {
|
|
436
|
+
* "llm": [
|
|
437
|
+
* {"key": "GPT-4", "doc_count": 30},
|
|
438
|
+
* {"key": "Claude", "doc_count": 20}
|
|
439
|
+
* ],
|
|
440
|
+
* "audience": [
|
|
441
|
+
* {"key": "College Students", "doc_count": 35},
|
|
442
|
+
* {"key": "Professionals", "doc_count": 15}
|
|
443
|
+
* ],
|
|
444
|
+
* "category": [
|
|
445
|
+
* {"key": "Computer Science", "doc_count": 25},
|
|
446
|
+
* {"key": "Mathematics", "doc_count": 15},
|
|
447
|
+
* {"key": "Business", "doc_count": 10}
|
|
448
|
+
* ]
|
|
449
|
+
* }
|
|
450
|
+
* }
|
|
451
|
+
*
|
|
452
|
+
* Error Responses:
|
|
453
|
+
* 400 Bad Request: If the request parameters are invalid
|
|
454
|
+
* 404 Not Found: If the requested mentor doesn't exist
|
|
455
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
456
|
+
*
|
|
457
|
+
* Notes:
|
|
458
|
+
* - Results are cached for performance
|
|
459
|
+
* - Public mentors are visible to all users
|
|
460
|
+
* - Private mentors are only visible to authorized users
|
|
461
|
+
* @param audience Filter by target audience
|
|
462
|
+
* @param category Filter by mentor category
|
|
463
|
+
* @param createdBy Filter mentors created by specific user
|
|
464
|
+
* @param featured Filter by featured status
|
|
465
|
+
* @param id Retrieve a specific mentor by ID
|
|
466
|
+
* @param limit Number of results per page
|
|
467
|
+
* @param llm Filter by language model type
|
|
468
|
+
* @param offset Starting position for pagination
|
|
469
|
+
* @param orderBy Field to sort results by ('created_at', 'recently_accessed_at')
|
|
470
|
+
* @param orderDirection Sort direction ('asc' or 'desc')
|
|
471
|
+
* @param query Search term to filter mentors by name or description
|
|
472
|
+
* @param tags Filter by tags
|
|
473
|
+
* @param tenant Filter by tenant/organization
|
|
474
|
+
* @param uniqueId Retrieve a specific mentor by UUID
|
|
475
|
+
* @returns MentorSearchResponse
|
|
476
|
+
* @throws ApiError
|
|
477
|
+
*/
|
|
478
|
+
public static searchMentorsRetrieve(
|
|
479
|
+
audience?: Array<string>,
|
|
480
|
+
category?: Array<string>,
|
|
481
|
+
createdBy?: string,
|
|
482
|
+
featured?: boolean,
|
|
483
|
+
id?: number,
|
|
484
|
+
limit: number = 12,
|
|
485
|
+
llm?: Array<string>,
|
|
486
|
+
offset?: number,
|
|
487
|
+
orderBy?: string,
|
|
488
|
+
orderDirection: string = 'desc',
|
|
489
|
+
query?: string,
|
|
490
|
+
tags?: Array<string>,
|
|
491
|
+
tenant?: string,
|
|
492
|
+
uniqueId?: string,
|
|
493
|
+
): CancelablePromise<MentorSearchResponse> {
|
|
494
|
+
return __request(OpenAPI, {
|
|
495
|
+
method: 'GET',
|
|
496
|
+
url: '/api/search/mentors/',
|
|
497
|
+
query: {
|
|
498
|
+
'audience': audience,
|
|
499
|
+
'category': category,
|
|
500
|
+
'created_by': createdBy,
|
|
501
|
+
'featured': featured,
|
|
502
|
+
'id': id,
|
|
503
|
+
'limit': limit,
|
|
504
|
+
'llm': llm,
|
|
505
|
+
'offset': offset,
|
|
506
|
+
'order_by': orderBy,
|
|
507
|
+
'order_direction': orderDirection,
|
|
508
|
+
'query': query,
|
|
509
|
+
'tags': tags,
|
|
510
|
+
'tenant': tenant,
|
|
511
|
+
'unique_id': uniqueId,
|
|
512
|
+
},
|
|
513
|
+
errors: {
|
|
514
|
+
400: `Bad request`,
|
|
515
|
+
500: `Server error`,
|
|
516
|
+
},
|
|
517
|
+
});
|
|
518
|
+
}
|
|
519
|
+
/**
|
|
520
|
+
* Search and filter documents associated with a specific mentor
|
|
521
|
+
* @param mentorUniqueId
|
|
522
|
+
* @param access Filter by access level (e.g., 'public', 'private')
|
|
523
|
+
* @param documentType Filter by document type (e.g., 'pdf', 'text')
|
|
524
|
+
* @param limit Number of results per page
|
|
525
|
+
* @param offset Starting position for pagination
|
|
526
|
+
* @param orderBy Field to sort results by ('date_created', 'last_modified', 'document_name')
|
|
527
|
+
* @param orderDirection Sort direction ('asc' or 'desc')
|
|
528
|
+
* @param platformKey Filter by platform key
|
|
529
|
+
* @param query Search term to filter documents by name or content
|
|
530
|
+
* @param trainingStatus Filter by training status (e.g., 'trained', 'pending')
|
|
531
|
+
* @returns DocumentSearchResponse
|
|
532
|
+
* @throws ApiError
|
|
533
|
+
*/
|
|
534
|
+
public static searchMentorsDocumentsRetrieve(
|
|
535
|
+
mentorUniqueId: string,
|
|
536
|
+
access?: string,
|
|
537
|
+
documentType?: string,
|
|
538
|
+
limit: number = 12,
|
|
539
|
+
offset?: number,
|
|
540
|
+
orderBy?: string,
|
|
541
|
+
orderDirection: string = 'desc',
|
|
542
|
+
platformKey?: string,
|
|
543
|
+
query?: string,
|
|
544
|
+
trainingStatus?: string,
|
|
545
|
+
): CancelablePromise<DocumentSearchResponse> {
|
|
546
|
+
return __request(OpenAPI, {
|
|
547
|
+
method: 'GET',
|
|
548
|
+
url: '/api/search/mentors/{mentor_unique_id}/documents/',
|
|
549
|
+
path: {
|
|
550
|
+
'mentor_unique_id': mentorUniqueId,
|
|
551
|
+
},
|
|
552
|
+
query: {
|
|
553
|
+
'access': access,
|
|
554
|
+
'document_type': documentType,
|
|
555
|
+
'limit': limit,
|
|
556
|
+
'offset': offset,
|
|
557
|
+
'order_by': orderBy,
|
|
558
|
+
'order_direction': orderDirection,
|
|
559
|
+
'platform_key': platformKey,
|
|
560
|
+
'query': query,
|
|
561
|
+
'training_status': trainingStatus,
|
|
562
|
+
},
|
|
563
|
+
errors: {
|
|
564
|
+
400: `Bad request`,
|
|
565
|
+
404: `Mentor not found`,
|
|
566
|
+
500: `Server error`,
|
|
567
|
+
},
|
|
568
|
+
});
|
|
569
|
+
}
|
|
570
|
+
/**
|
|
571
|
+
* Handle GET requests for tenant-specific mentor search.
|
|
572
|
+
*
|
|
573
|
+
* Args:
|
|
574
|
+
* request: HTTP request object
|
|
575
|
+
* org: Tenant/organization key
|
|
576
|
+
* username: Username of the user making the request
|
|
577
|
+
*
|
|
578
|
+
* Returns:
|
|
579
|
+
* Response: DRF Response object with search results
|
|
580
|
+
* @param org
|
|
581
|
+
* @param username
|
|
582
|
+
* @param audience Filter by target audience
|
|
583
|
+
* @param category Filter by mentor category
|
|
584
|
+
* @param createdBy Filter mentors created by specific user
|
|
585
|
+
* @param featured Filter by featured status
|
|
586
|
+
* @param id Retrieve a specific mentor by ID
|
|
587
|
+
* @param limit Number of results per page
|
|
588
|
+
* @param llm Filter by language model type
|
|
589
|
+
* @param offset Starting position for pagination
|
|
590
|
+
* @param orderBy Field to sort results by ('created_at', 'recently_accessed_at')
|
|
591
|
+
* @param orderDirection Sort direction ('asc' or 'desc')
|
|
592
|
+
* @param query Search term to filter mentors by name or description
|
|
593
|
+
* @param tags Filter by tags
|
|
594
|
+
* @param tenant Filter by tenant/organization
|
|
595
|
+
* @param uniqueId Retrieve a specific mentor by UUID
|
|
596
|
+
* @returns MentorSearchResponse
|
|
597
|
+
* @throws ApiError
|
|
598
|
+
*/
|
|
599
|
+
public static searchOrgsUsersMentorsRetrieve(
|
|
600
|
+
org: string,
|
|
601
|
+
username: string,
|
|
602
|
+
audience?: Array<string>,
|
|
603
|
+
category?: Array<string>,
|
|
604
|
+
createdBy?: string,
|
|
605
|
+
featured?: boolean,
|
|
606
|
+
id?: number,
|
|
607
|
+
limit: number = 12,
|
|
608
|
+
llm?: Array<string>,
|
|
609
|
+
offset?: number,
|
|
610
|
+
orderBy?: string,
|
|
611
|
+
orderDirection: string = 'desc',
|
|
612
|
+
query?: string,
|
|
613
|
+
tags?: Array<string>,
|
|
614
|
+
tenant?: string,
|
|
615
|
+
uniqueId?: string,
|
|
616
|
+
): CancelablePromise<MentorSearchResponse> {
|
|
617
|
+
return __request(OpenAPI, {
|
|
618
|
+
method: 'GET',
|
|
619
|
+
url: '/api/search/orgs/{org}/users/{username}/mentors/',
|
|
620
|
+
path: {
|
|
621
|
+
'org': org,
|
|
622
|
+
'username': username,
|
|
623
|
+
},
|
|
624
|
+
query: {
|
|
625
|
+
'audience': audience,
|
|
626
|
+
'category': category,
|
|
627
|
+
'created_by': createdBy,
|
|
628
|
+
'featured': featured,
|
|
629
|
+
'id': id,
|
|
630
|
+
'limit': limit,
|
|
631
|
+
'llm': llm,
|
|
632
|
+
'offset': offset,
|
|
633
|
+
'order_by': orderBy,
|
|
634
|
+
'order_direction': orderDirection,
|
|
635
|
+
'query': query,
|
|
636
|
+
'tags': tags,
|
|
637
|
+
'tenant': tenant,
|
|
638
|
+
'unique_id': uniqueId,
|
|
639
|
+
},
|
|
640
|
+
errors: {
|
|
641
|
+
400: `Bad request`,
|
|
642
|
+
500: `Server error`,
|
|
643
|
+
},
|
|
644
|
+
});
|
|
645
|
+
}
|
|
646
|
+
/**
|
|
647
|
+
* Search and filter AI prompts for a specific user within a tenant.
|
|
648
|
+
*
|
|
649
|
+
* This endpoint extends the base prompt search functionality but filters results
|
|
650
|
+
* to only show prompts that are available to a specific user within a specific
|
|
651
|
+
* organization/tenant.
|
|
652
|
+
*
|
|
653
|
+
* Path Parameters:
|
|
654
|
+
* org (str): The organization/tenant identifier
|
|
655
|
+
* username (str): The username to filter prompts for
|
|
656
|
+
*
|
|
657
|
+
* Query Parameters:
|
|
658
|
+
* Same as PromptSearchView, plus:
|
|
659
|
+
*
|
|
660
|
+
* # Identification parameters (for detail view)
|
|
661
|
+
* id (int, optional): Retrieve a specific prompt by ID
|
|
662
|
+
*
|
|
663
|
+
* Returns:
|
|
664
|
+
* Same format as PromptSearchView, but filtered to only include prompts
|
|
665
|
+
* that the specified user has access to within the specified organization.
|
|
666
|
+
*
|
|
667
|
+
* Error Responses:
|
|
668
|
+
* 400 Bad Request: If the request parameters are invalid
|
|
669
|
+
* 403 Forbidden: If the requested prompt exists but the user doesn't have access
|
|
670
|
+
* 404 Not Found: If the requested prompt doesn't exist
|
|
671
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
672
|
+
*
|
|
673
|
+
* Access Control:
|
|
674
|
+
* - Results are filtered based on user's permissions within the organization
|
|
675
|
+
* - Private prompts are only visible to authorized users
|
|
676
|
+
* @param org
|
|
677
|
+
* @param username
|
|
678
|
+
* @param alphabetical Sort alphabetically
|
|
679
|
+
* @param category Filter by prompt category
|
|
680
|
+
* @param filterFacet If true, return only facets without results
|
|
681
|
+
* @param language Filter by prompt language
|
|
682
|
+
* @param limit Number of results per page
|
|
683
|
+
* @param mentor Filter by mentor UUID
|
|
684
|
+
* @param offset Starting position for pagination
|
|
685
|
+
* @param orderDirection Sort direction ('asc' or 'desc')
|
|
686
|
+
* @param query Search term to filter prompts by name or content
|
|
687
|
+
* @param sortBy Field to sort results by
|
|
688
|
+
* @param style Filter by prompt style
|
|
689
|
+
* @param tenant Filter by tenant/organization
|
|
690
|
+
* @param tone Filter by prompt tone
|
|
691
|
+
* @returns PromptSearchResponse
|
|
692
|
+
* @throws ApiError
|
|
693
|
+
*/
|
|
694
|
+
public static searchOrgsUsersPromptsRetrieve(
|
|
695
|
+
org: string,
|
|
696
|
+
username: string,
|
|
697
|
+
alphabetical: boolean = false,
|
|
698
|
+
category?: string,
|
|
699
|
+
filterFacet?: boolean,
|
|
700
|
+
language?: string,
|
|
701
|
+
limit: number = 10,
|
|
702
|
+
mentor?: string,
|
|
703
|
+
offset?: number,
|
|
704
|
+
orderDirection: string = 'desc',
|
|
705
|
+
query?: string,
|
|
706
|
+
sortBy?: string,
|
|
707
|
+
style?: string,
|
|
708
|
+
tenant?: string,
|
|
709
|
+
tone?: string,
|
|
710
|
+
): CancelablePromise<PromptSearchResponse> {
|
|
711
|
+
return __request(OpenAPI, {
|
|
712
|
+
method: 'GET',
|
|
713
|
+
url: '/api/search/orgs/{org}/users/{username}/prompts/',
|
|
714
|
+
path: {
|
|
715
|
+
'org': org,
|
|
716
|
+
'username': username,
|
|
717
|
+
},
|
|
718
|
+
query: {
|
|
719
|
+
'alphabetical': alphabetical,
|
|
720
|
+
'category': category,
|
|
721
|
+
'filter_facet': filterFacet,
|
|
722
|
+
'language': language,
|
|
723
|
+
'limit': limit,
|
|
724
|
+
'mentor': mentor,
|
|
725
|
+
'offset': offset,
|
|
726
|
+
'order_direction': orderDirection,
|
|
727
|
+
'query': query,
|
|
728
|
+
'sort_by': sortBy,
|
|
729
|
+
'style': style,
|
|
730
|
+
'tenant': tenant,
|
|
731
|
+
'tone': tone,
|
|
732
|
+
},
|
|
733
|
+
errors: {
|
|
734
|
+
400: `Bad request`,
|
|
735
|
+
403: `Forbidden`,
|
|
736
|
+
404: `Not found`,
|
|
737
|
+
500: `Server error`,
|
|
738
|
+
},
|
|
739
|
+
});
|
|
740
|
+
}
|
|
741
|
+
/**
|
|
742
|
+
* Determine whether to serve a detail view or a list view.
|
|
743
|
+
* @param org
|
|
744
|
+
* @param username
|
|
745
|
+
* @param certificate Filter by certificate type
|
|
746
|
+
* @param content Content types to include in recommendations (courses, programs, pathways, skills, roles, resources)
|
|
747
|
+
* @param courseId Retrieve a specific course by ID
|
|
748
|
+
* @param duration Filter by course duration range
|
|
749
|
+
* @param language Filter by content language
|
|
750
|
+
* @param level Filter by difficulty level
|
|
751
|
+
* @param limit Number of results per page
|
|
752
|
+
* @param offset Starting position for pagination
|
|
753
|
+
* @param pathwayId Retrieve a specific pathway by ID
|
|
754
|
+
* @param price Filter by price/audit status
|
|
755
|
+
* @param programId Retrieve a specific program by ID
|
|
756
|
+
* @param programType Filter by program type
|
|
757
|
+
* @param query Search term to filter content by name or description
|
|
758
|
+
* @param resourceId Retrieve a specific resource by ID
|
|
759
|
+
* @param resourceType Filter by resource type
|
|
760
|
+
* @param roleId Retrieve a specific role by ID
|
|
761
|
+
* @param selfPaced Filter by course format (self-paced, instructor-led)
|
|
762
|
+
* @param skillId Retrieve a specific skill by ID
|
|
763
|
+
* @param skills Filter by skills
|
|
764
|
+
* @param subject Filter by subject areas
|
|
765
|
+
* @param tags Filter by tags
|
|
766
|
+
* @param topics Filter by topic areas
|
|
767
|
+
* @returns RecommendedCoursesResponse
|
|
768
|
+
* @throws ApiError
|
|
769
|
+
*/
|
|
770
|
+
public static searchOrgsUsersRecommendedRetrieve(
|
|
771
|
+
org: string,
|
|
772
|
+
username: string,
|
|
773
|
+
certificate?: Array<string>,
|
|
774
|
+
content?: Array<string>,
|
|
775
|
+
courseId?: string,
|
|
776
|
+
duration?: Array<string>,
|
|
777
|
+
language?: Array<string>,
|
|
778
|
+
level?: Array<string>,
|
|
779
|
+
limit: number = 12,
|
|
780
|
+
offset?: number,
|
|
781
|
+
pathwayId?: string,
|
|
782
|
+
price?: string,
|
|
783
|
+
programId?: string,
|
|
784
|
+
programType?: Array<string>,
|
|
785
|
+
query?: string,
|
|
786
|
+
resourceId?: string,
|
|
787
|
+
resourceType?: Array<string>,
|
|
788
|
+
roleId?: string,
|
|
789
|
+
selfPaced?: Array<string>,
|
|
790
|
+
skillId?: string,
|
|
791
|
+
skills?: Array<string>,
|
|
792
|
+
subject?: Array<string>,
|
|
793
|
+
tags?: Array<string>,
|
|
794
|
+
topics?: Array<string>,
|
|
795
|
+
): CancelablePromise<RecommendedCoursesResponse> {
|
|
796
|
+
return __request(OpenAPI, {
|
|
797
|
+
method: 'GET',
|
|
798
|
+
url: '/api/search/orgs/{org}/users/{username}/recommended/',
|
|
799
|
+
path: {
|
|
800
|
+
'org': org,
|
|
801
|
+
'username': username,
|
|
802
|
+
},
|
|
803
|
+
query: {
|
|
804
|
+
'certificate': certificate,
|
|
805
|
+
'content': content,
|
|
806
|
+
'course_id': courseId,
|
|
807
|
+
'duration': duration,
|
|
808
|
+
'language': language,
|
|
809
|
+
'level': level,
|
|
810
|
+
'limit': limit,
|
|
811
|
+
'offset': offset,
|
|
812
|
+
'pathway_id': pathwayId,
|
|
813
|
+
'price': price,
|
|
814
|
+
'program_id': programId,
|
|
815
|
+
'program_type': programType,
|
|
816
|
+
'query': query,
|
|
817
|
+
'resource_id': resourceId,
|
|
818
|
+
'resource_type': resourceType,
|
|
819
|
+
'role_id': roleId,
|
|
820
|
+
'self_paced': selfPaced,
|
|
821
|
+
'skill_id': skillId,
|
|
822
|
+
'skills': skills,
|
|
823
|
+
'subject': subject,
|
|
824
|
+
'tags': tags,
|
|
825
|
+
'topics': topics,
|
|
826
|
+
},
|
|
827
|
+
errors: {
|
|
828
|
+
400: `Bad request`,
|
|
829
|
+
404: `User not found`,
|
|
830
|
+
500: `Server error`,
|
|
831
|
+
},
|
|
832
|
+
});
|
|
833
|
+
}
|
|
834
|
+
/**
|
|
835
|
+
* Determine whether to serve a detail view or a list view.
|
|
836
|
+
* If any detail-identifying parameters are present (course_id, program_id, etc.)
|
|
837
|
+
* the detail view is returned; otherwise the aggregated list view is returned.
|
|
838
|
+
* @param username
|
|
839
|
+
* @param allowSkillSearch Enable skill-based search
|
|
840
|
+
* @param alphabetical Sort alphabetically by name
|
|
841
|
+
* @param certificate Filter by certificate type
|
|
842
|
+
* @param content Content types to include in results
|
|
843
|
+
* @param courseId Retrieve a specific course by ID
|
|
844
|
+
* @param duration Filter by course duration range
|
|
845
|
+
* @param language Filter by content language
|
|
846
|
+
* @param level Filter by difficulty level
|
|
847
|
+
* @param limit Number of results per page
|
|
848
|
+
* @param offset Starting position for pagination
|
|
849
|
+
* @param orderAscending Sort direction
|
|
850
|
+
* @param orderBy Field to sort results by
|
|
851
|
+
* @param pathwayId Retrieve a specific pathway by ID
|
|
852
|
+
* @param price Filter by price/audit status
|
|
853
|
+
* @param programId Retrieve a specific program by ID
|
|
854
|
+
* @param programType Filter by program type
|
|
855
|
+
* @param promotion Filter by promotion status
|
|
856
|
+
* @param query Search term to filter content by name or description
|
|
857
|
+
* @param recommended Show only recommended content
|
|
858
|
+
* @param resourceId Retrieve a specific resource by ID
|
|
859
|
+
* @param resourceType Filter by resource type
|
|
860
|
+
* @param returnFacet Include facet data in response
|
|
861
|
+
* @param returnItems Include items in programs/pathways
|
|
862
|
+
* @param roleId Retrieve a specific role by ID
|
|
863
|
+
* @param selfPaced Filter by course format
|
|
864
|
+
* @param skillId Retrieve a specific skill by ID
|
|
865
|
+
* @param skills Filter by skills
|
|
866
|
+
* @param subject Filter by subject areas
|
|
867
|
+
* @param tags Filter by tags
|
|
868
|
+
* @param tenant Filter by tenant/organization
|
|
869
|
+
* @param topics Filter by topic areas
|
|
870
|
+
* @param updateFacet Force facet update
|
|
871
|
+
* @returns any
|
|
872
|
+
* @throws ApiError
|
|
873
|
+
*/
|
|
874
|
+
public static searchPersonalizedCatalogRetrieve(
|
|
875
|
+
username: string,
|
|
876
|
+
allowSkillSearch: boolean = false,
|
|
877
|
+
alphabetical: boolean = false,
|
|
878
|
+
certificate?: Array<string>,
|
|
879
|
+
content?: Array<string>,
|
|
880
|
+
courseId?: string,
|
|
881
|
+
duration?: Array<string>,
|
|
882
|
+
language?: Array<string>,
|
|
883
|
+
level?: Array<string>,
|
|
884
|
+
limit: number = 12,
|
|
885
|
+
offset?: number,
|
|
886
|
+
orderAscending: boolean = false,
|
|
887
|
+
orderBy?: string,
|
|
888
|
+
pathwayId?: string,
|
|
889
|
+
price?: string,
|
|
890
|
+
programId?: string,
|
|
891
|
+
programType?: Array<string>,
|
|
892
|
+
promotion?: Array<string>,
|
|
893
|
+
query?: string,
|
|
894
|
+
recommended: boolean = false,
|
|
895
|
+
resourceId?: string,
|
|
896
|
+
resourceType?: Array<string>,
|
|
897
|
+
returnFacet: boolean = true,
|
|
898
|
+
returnItems: boolean = false,
|
|
899
|
+
roleId?: string,
|
|
900
|
+
selfPaced?: Array<string>,
|
|
901
|
+
skillId?: string,
|
|
902
|
+
skills?: Array<string>,
|
|
903
|
+
subject?: Array<string>,
|
|
904
|
+
tags?: Array<string>,
|
|
905
|
+
tenant?: Array<string>,
|
|
906
|
+
topics?: Array<string>,
|
|
907
|
+
updateFacet?: string,
|
|
908
|
+
): CancelablePromise<Record<string, any>> {
|
|
909
|
+
return __request(OpenAPI, {
|
|
910
|
+
method: 'GET',
|
|
911
|
+
url: '/api/search/personalized-catalog/{username}/',
|
|
912
|
+
path: {
|
|
913
|
+
'username': username,
|
|
914
|
+
},
|
|
915
|
+
query: {
|
|
916
|
+
'allow_skill_search': allowSkillSearch,
|
|
917
|
+
'alphabetical': alphabetical,
|
|
918
|
+
'certificate': certificate,
|
|
919
|
+
'content': content,
|
|
920
|
+
'course_id': courseId,
|
|
921
|
+
'duration': duration,
|
|
922
|
+
'language': language,
|
|
923
|
+
'level': level,
|
|
924
|
+
'limit': limit,
|
|
925
|
+
'offset': offset,
|
|
926
|
+
'order_ascending': orderAscending,
|
|
927
|
+
'order_by': orderBy,
|
|
928
|
+
'pathway_id': pathwayId,
|
|
929
|
+
'price': price,
|
|
930
|
+
'program_id': programId,
|
|
931
|
+
'program_type': programType,
|
|
932
|
+
'promotion': promotion,
|
|
933
|
+
'query': query,
|
|
934
|
+
'recommended': recommended,
|
|
935
|
+
'resource_id': resourceId,
|
|
936
|
+
'resource_type': resourceType,
|
|
937
|
+
'return_facet': returnFacet,
|
|
938
|
+
'return_items': returnItems,
|
|
939
|
+
'role_id': roleId,
|
|
940
|
+
'self_paced': selfPaced,
|
|
941
|
+
'skill_id': skillId,
|
|
942
|
+
'skills': skills,
|
|
943
|
+
'subject': subject,
|
|
944
|
+
'tags': tags,
|
|
945
|
+
'tenant': tenant,
|
|
946
|
+
'topics': topics,
|
|
947
|
+
'update_facet': updateFacet,
|
|
948
|
+
},
|
|
949
|
+
});
|
|
950
|
+
}
|
|
951
|
+
/**
|
|
952
|
+
* Search and filter AI prompts across the platform.
|
|
953
|
+
*
|
|
954
|
+
* This endpoint provides a search interface for discovering AI prompts
|
|
955
|
+
* with support for filtering, pagination, and detailed prompt information.
|
|
956
|
+
*
|
|
957
|
+
* Query Parameters:
|
|
958
|
+
* # Identification parameters (for detail view)
|
|
959
|
+
* id (int, optional): Retrieve a specific prompt by ID
|
|
960
|
+
*
|
|
961
|
+
* # Search and filtering parameters
|
|
962
|
+
* query (str, optional): Search term to filter prompts by name or content
|
|
963
|
+
* category (str, optional): Filter by prompt category
|
|
964
|
+
* language (str, optional): Filter by prompt language
|
|
965
|
+
* style (str, optional): Filter by writing style
|
|
966
|
+
* tone (str, optional): Filter by tone
|
|
967
|
+
* tenant (str, optional): Filter by tenant/organization
|
|
968
|
+
* mentor (str, optional): Filter by associated mentor (UUID)
|
|
969
|
+
*
|
|
970
|
+
* # Sorting and pagination
|
|
971
|
+
* sort_by (str, optional): Field to sort results by
|
|
972
|
+
* order_direction (str, optional): Sort direction ('asc' or 'desc', default: 'desc')
|
|
973
|
+
* alphabetical (bool, optional): Sort alphabetically by name (default: false)
|
|
974
|
+
* limit (int, optional): Number of results per page (default: 10)
|
|
975
|
+
* offset (int, optional): Starting position for pagination
|
|
976
|
+
*
|
|
977
|
+
* # Special parameters
|
|
978
|
+
* filter_facet (any, optional): If present, return only facets without results
|
|
979
|
+
*
|
|
980
|
+
* Returns:
|
|
981
|
+
* For detail view (when id is provided):
|
|
982
|
+
* A JSON response containing a single prompt's details:
|
|
983
|
+
* {
|
|
984
|
+
* "id": 456,
|
|
985
|
+
* "name": "Essay Writing Guide",
|
|
986
|
+
* "content": "Write a well-structured essay on the following topic: {{topic}}...",
|
|
987
|
+
* "category": "Academic Writing",
|
|
988
|
+
* "language": "English",
|
|
989
|
+
* "style": "Formal",
|
|
990
|
+
* "tone": "Professional",
|
|
991
|
+
* "mentor": {
|
|
992
|
+
* "id": 123,
|
|
993
|
+
* "unique_id": "550e8400-e29b-41d4-a716-446655440000",
|
|
994
|
+
* "name": "Professor Smith"
|
|
995
|
+
* },
|
|
996
|
+
* "platform": {
|
|
997
|
+
* "id": 1,
|
|
998
|
+
* "name": "Example University",
|
|
999
|
+
* "key": "example-university"
|
|
1000
|
+
* },
|
|
1001
|
+
* "created_at": "2023-02-10T09:15:00Z",
|
|
1002
|
+
* "updated_at": "2023-05-05T14:20:00Z",
|
|
1003
|
+
* "visibility": "public",
|
|
1004
|
+
* "variables": ["topic", "length", "style"]
|
|
1005
|
+
* }
|
|
1006
|
+
*
|
|
1007
|
+
* For list view:
|
|
1008
|
+
* A JSON response containing:
|
|
1009
|
+
* {
|
|
1010
|
+
* "results": [
|
|
1011
|
+
* {
|
|
1012
|
+
* "id": 456,
|
|
1013
|
+
* "name": "Essay Writing Guide",
|
|
1014
|
+
* "content": "Write a well-structured essay on the following topic: {{topic}}...",
|
|
1015
|
+
* "category": "Academic Writing",
|
|
1016
|
+
* "language": "English",
|
|
1017
|
+
* "style": "Formal",
|
|
1018
|
+
* "tone": "Professional",
|
|
1019
|
+
* "mentor": {"id": 123, "name": "Professor Smith"},
|
|
1020
|
+
* "created_at": "2023-02-10T09:15:00Z",
|
|
1021
|
+
* "updated_at": "2023-05-05T14:20:00Z"
|
|
1022
|
+
* },
|
|
1023
|
+
* // Additional prompt objects...
|
|
1024
|
+
* ],
|
|
1025
|
+
* "count": 30,
|
|
1026
|
+
* "next": "?limit=10&offset=10",
|
|
1027
|
+
* "previous": null,
|
|
1028
|
+
* "current_page": 1,
|
|
1029
|
+
* "num_pages": 3,
|
|
1030
|
+
* "facets": {
|
|
1031
|
+
* "category": [
|
|
1032
|
+
* {"key": "Academic Writing", "doc_count": 15},
|
|
1033
|
+
* {"key": "Creative Writing", "doc_count": 10},
|
|
1034
|
+
* {"key": "Technical Documentation", "doc_count": 5}
|
|
1035
|
+
* ],
|
|
1036
|
+
* "language": [
|
|
1037
|
+
* {"key": "English", "doc_count": 25},
|
|
1038
|
+
* {"key": "Spanish", "doc_count": 5}
|
|
1039
|
+
* ],
|
|
1040
|
+
* "style": [
|
|
1041
|
+
* {"key": "Formal", "doc_count": 20},
|
|
1042
|
+
* {"key": "Casual", "doc_count": 10}
|
|
1043
|
+
* ],
|
|
1044
|
+
* "tone": [
|
|
1045
|
+
* {"key": "Professional", "doc_count": 15},
|
|
1046
|
+
* {"key": "Friendly", "doc_count": 10},
|
|
1047
|
+
* {"key": "Technical", "doc_count": 5}
|
|
1048
|
+
* ]
|
|
1049
|
+
* }
|
|
1050
|
+
* }
|
|
1051
|
+
*
|
|
1052
|
+
* Error Responses:
|
|
1053
|
+
* 400 Bad Request: If the request parameters are invalid
|
|
1054
|
+
* 403 Forbidden: If the requested prompt exists but is not publicly available
|
|
1055
|
+
* 404 Not Found: If the requested prompt doesn't exist
|
|
1056
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
1057
|
+
*
|
|
1058
|
+
* Notes:
|
|
1059
|
+
* - Only publicly available prompts are returned by default
|
|
1060
|
+
* - When filtering by mentor, the mentor ID must be a valid UUID
|
|
1061
|
+
* @param alphabetical Sort alphabetically
|
|
1062
|
+
* @param category Filter by prompt category
|
|
1063
|
+
* @param filterFacet If true, return only facets without results
|
|
1064
|
+
* @param language Filter by prompt language
|
|
1065
|
+
* @param limit Number of results per page
|
|
1066
|
+
* @param mentor Filter by mentor UUID
|
|
1067
|
+
* @param offset Starting position for pagination
|
|
1068
|
+
* @param orderDirection Sort direction ('asc' or 'desc')
|
|
1069
|
+
* @param query Search term to filter prompts by name or content
|
|
1070
|
+
* @param sortBy Field to sort results by
|
|
1071
|
+
* @param style Filter by prompt style
|
|
1072
|
+
* @param tenant Filter by tenant/organization
|
|
1073
|
+
* @param tone Filter by prompt tone
|
|
1074
|
+
* @returns PromptSearchResponse
|
|
1075
|
+
* @throws ApiError
|
|
1076
|
+
*/
|
|
1077
|
+
public static searchPromptsRetrieve(
|
|
1078
|
+
alphabetical: boolean = false,
|
|
1079
|
+
category?: string,
|
|
1080
|
+
filterFacet?: boolean,
|
|
1081
|
+
language?: string,
|
|
1082
|
+
limit: number = 10,
|
|
1083
|
+
mentor?: string,
|
|
1084
|
+
offset?: number,
|
|
1085
|
+
orderDirection: string = 'desc',
|
|
1086
|
+
query?: string,
|
|
1087
|
+
sortBy?: string,
|
|
1088
|
+
style?: string,
|
|
1089
|
+
tenant?: string,
|
|
1090
|
+
tone?: string,
|
|
1091
|
+
): CancelablePromise<PromptSearchResponse> {
|
|
1092
|
+
return __request(OpenAPI, {
|
|
1093
|
+
method: 'GET',
|
|
1094
|
+
url: '/api/search/prompts/',
|
|
1095
|
+
query: {
|
|
1096
|
+
'alphabetical': alphabetical,
|
|
1097
|
+
'category': category,
|
|
1098
|
+
'filter_facet': filterFacet,
|
|
1099
|
+
'language': language,
|
|
1100
|
+
'limit': limit,
|
|
1101
|
+
'mentor': mentor,
|
|
1102
|
+
'offset': offset,
|
|
1103
|
+
'order_direction': orderDirection,
|
|
1104
|
+
'query': query,
|
|
1105
|
+
'sort_by': sortBy,
|
|
1106
|
+
'style': style,
|
|
1107
|
+
'tenant': tenant,
|
|
1108
|
+
'tone': tone,
|
|
1109
|
+
},
|
|
1110
|
+
errors: {
|
|
1111
|
+
400: `Bad request`,
|
|
1112
|
+
500: `Server error`,
|
|
1113
|
+
},
|
|
1114
|
+
});
|
|
1115
|
+
}
|
|
1116
|
+
/**
|
|
1117
|
+
* Search and filter users within a specific organization/tenant.
|
|
1118
|
+
*
|
|
1119
|
+
* This endpoint provides a search interface for discovering users within an organization,
|
|
1120
|
+
* with support for filtering by departments, pagination, and faceted filtering.
|
|
1121
|
+
*
|
|
1122
|
+
* Path Parameters:
|
|
1123
|
+
* org (str): The organization/tenant identifier
|
|
1124
|
+
* username (str): The username of the user making the request
|
|
1125
|
+
*
|
|
1126
|
+
* Query Parameters:
|
|
1127
|
+
* # Search parameters
|
|
1128
|
+
* query (str, optional): Search term to filter users by name, username, or email
|
|
1129
|
+
*
|
|
1130
|
+
* # Department filtering
|
|
1131
|
+
* department_mode (bool, optional): Enable department-based filtering (default: false)
|
|
1132
|
+
* user_department (bool, optional): Legacy parameter for department_mode (default: false)
|
|
1133
|
+
* department (list, optional): Filter by specific departments
|
|
1134
|
+
*
|
|
1135
|
+
* # Additional filters
|
|
1136
|
+
* role (list, optional): Filter by user role
|
|
1137
|
+
* status (list, optional): Filter by user status (active, inactive)
|
|
1138
|
+
* joined_date (list, optional): Filter by join date range
|
|
1139
|
+
* last_login (list, optional): Filter by last login date range
|
|
1140
|
+
*
|
|
1141
|
+
* # Pagination
|
|
1142
|
+
* limit (int, optional): Number of results per page (default: 10)
|
|
1143
|
+
* offset (int, optional): Starting position for pagination
|
|
1144
|
+
*
|
|
1145
|
+
* Returns:
|
|
1146
|
+
* A JSON response containing:
|
|
1147
|
+
* ```
|
|
1148
|
+
* {
|
|
1149
|
+
* "results": [
|
|
1150
|
+
* {
|
|
1151
|
+
* "id": 123,
|
|
1152
|
+
* "username": "john.doe",
|
|
1153
|
+
* "email": "john.doe@example.com",
|
|
1154
|
+
* "first_name": "John",
|
|
1155
|
+
* "last_name": "Doe",
|
|
1156
|
+
* "full_name": "John Doe",
|
|
1157
|
+
* "profile_image": "https://example.com/profiles/john-doe.jpg",
|
|
1158
|
+
* "role": "Student",
|
|
1159
|
+
* "departments": ["Computer Science", "Data Science"],
|
|
1160
|
+
* "status": "active",
|
|
1161
|
+
* "joined_date": "2023-01-15T12:00:00Z",
|
|
1162
|
+
* "last_login": "2023-06-20T15:30:00Z",
|
|
1163
|
+
* "metadata": {
|
|
1164
|
+
* "location": "New York",
|
|
1165
|
+
* "title": "Software Engineer",
|
|
1166
|
+
* "bio": "Experienced software engineer with a passion for education"
|
|
1167
|
+
* }
|
|
1168
|
+
* },
|
|
1169
|
+
* // Additional user objects...
|
|
1170
|
+
* ],
|
|
1171
|
+
* "count": 50,
|
|
1172
|
+
* "next": "https://api.example.com/api/search/users/example-org/admin/?limit=10&offset=10",
|
|
1173
|
+
* "previous": null,
|
|
1174
|
+
* "current_page": 1,
|
|
1175
|
+
* "total_pages": 5,
|
|
1176
|
+
* "facets": {
|
|
1177
|
+
* "role": [
|
|
1178
|
+
* {"key": "Student", "doc_count": 30},
|
|
1179
|
+
* {"key": "Instructor", "doc_count": 15},
|
|
1180
|
+
* {"key": "Admin", "doc_count": 5}
|
|
1181
|
+
* ],
|
|
1182
|
+
* "department": [
|
|
1183
|
+
* {"key": "Computer Science", "doc_count": 20},
|
|
1184
|
+
* {"key": "Data Science", "doc_count": 15},
|
|
1185
|
+
* {"key": "Business", "doc_count": 10},
|
|
1186
|
+
* {"key": "Engineering", "doc_count": 5}
|
|
1187
|
+
* ],
|
|
1188
|
+
* "status": [
|
|
1189
|
+
* {"key": "active", "doc_count": 45},
|
|
1190
|
+
* {"key": "inactive", "doc_count": 5}
|
|
1191
|
+
* ]
|
|
1192
|
+
* }
|
|
1193
|
+
* }
|
|
1194
|
+
* ```
|
|
1195
|
+
* Error Responses:
|
|
1196
|
+
* 400 Bad Request: If the request parameters are invalid
|
|
1197
|
+
* 403 Forbidden: If the user doesn't have department admin privileges (when using department_mode)
|
|
1198
|
+
* 404 Not Found: If the user or organization doesn't exist
|
|
1199
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
1200
|
+
*
|
|
1201
|
+
* Access Control:
|
|
1202
|
+
* - The requesting user must have an active account in the specified organization
|
|
1203
|
+
* - When department_mode is enabled, the user must be an admin of at least one department
|
|
1204
|
+
* - Department filtering restricts results to users in departments where the requesting user is an admin
|
|
1205
|
+
* @param org
|
|
1206
|
+
* @param username
|
|
1207
|
+
* @param department Filter by department names
|
|
1208
|
+
* @param educationDegree Filter by degree
|
|
1209
|
+
* @param educationFieldOfStudy Filter by field of study
|
|
1210
|
+
* @param educationInstitution Filter by institution
|
|
1211
|
+
* @param includeMembershipData Include user group membership data in results
|
|
1212
|
+
* @param limit Number of results per page
|
|
1213
|
+
* @param offset Starting position for pagination
|
|
1214
|
+
* @param q Search term to filter users by name, email, or other attributes
|
|
1215
|
+
* @param userResumeCompany Filter by company
|
|
1216
|
+
* @param userResumeIndustry Filter by industry
|
|
1217
|
+
* @param userResumeJobTitle Filter by job title
|
|
1218
|
+
* @param userResumeLocation Filter by location
|
|
1219
|
+
* @param userResumeSkills Filter by skills
|
|
1220
|
+
* @returns UserSearchResponse
|
|
1221
|
+
* @throws ApiError
|
|
1222
|
+
*/
|
|
1223
|
+
public static searchUsersOrgsUsersRetrieve(
|
|
1224
|
+
org: string,
|
|
1225
|
+
username: string,
|
|
1226
|
+
department?: Array<string>,
|
|
1227
|
+
educationDegree?: string,
|
|
1228
|
+
educationFieldOfStudy?: string,
|
|
1229
|
+
educationInstitution?: string,
|
|
1230
|
+
includeMembershipData: boolean = false,
|
|
1231
|
+
limit: number = 10,
|
|
1232
|
+
offset?: number,
|
|
1233
|
+
q?: string,
|
|
1234
|
+
userResumeCompany?: string,
|
|
1235
|
+
userResumeIndustry?: string,
|
|
1236
|
+
userResumeJobTitle?: string,
|
|
1237
|
+
userResumeLocation?: string,
|
|
1238
|
+
userResumeSkills?: string,
|
|
1239
|
+
): CancelablePromise<UserSearchResponse> {
|
|
1240
|
+
return __request(OpenAPI, {
|
|
1241
|
+
method: 'GET',
|
|
1242
|
+
url: '/api/search/users/orgs/{org}/users/{username}/',
|
|
1243
|
+
path: {
|
|
1244
|
+
'org': org,
|
|
1245
|
+
'username': username,
|
|
1246
|
+
},
|
|
1247
|
+
query: {
|
|
1248
|
+
'department': department,
|
|
1249
|
+
'education__degree': educationDegree,
|
|
1250
|
+
'education__field_of_study': educationFieldOfStudy,
|
|
1251
|
+
'education__institution': educationInstitution,
|
|
1252
|
+
'include_membership_data': includeMembershipData,
|
|
1253
|
+
'limit': limit,
|
|
1254
|
+
'offset': offset,
|
|
1255
|
+
'q': q,
|
|
1256
|
+
'user_resume__company': userResumeCompany,
|
|
1257
|
+
'user_resume__industry': userResumeIndustry,
|
|
1258
|
+
'user_resume__job_title': userResumeJobTitle,
|
|
1259
|
+
'user_resume__location': userResumeLocation,
|
|
1260
|
+
'user_resume__skills': userResumeSkills,
|
|
1261
|
+
},
|
|
1262
|
+
errors: {
|
|
1263
|
+
400: `Bad request`,
|
|
1264
|
+
403: `Forbidden`,
|
|
1265
|
+
404: `Not found`,
|
|
1266
|
+
500: `Server error`,
|
|
1267
|
+
},
|
|
1268
|
+
});
|
|
1269
|
+
}
|
|
1270
|
+
}
|