@iblai/iblai-api 3.45.9-core → 3.45.10-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 +16373 -114
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +16365 -115
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +16373 -114
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +316 -5
- 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 +80 -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 +79 -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 +45 -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 +56 -0
- package/dist/types/models/MentorSettingsPublic.d.ts +45 -0
- package/dist/types/models/MentorSettingsRequest.d.ts +60 -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 +79 -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/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/PlatformSkillPointResponse.d.ts +2 -2
- 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/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/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/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 +380 -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/CatalogService.d.ts +13 -17
- package/dist/types/services/SearchService.d.ts +404 -0
- package/package.json +1 -1
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +316 -5
- 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 +85 -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 +84 -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 +50 -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 +61 -0
- package/src/models/MentorSettingsPublic.ts +50 -0
- package/src/models/MentorSettingsRequest.ts +65 -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 +84 -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/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/PlatformSkillPointResponse.ts +2 -2
- 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/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/RecentlyAccessedMentor.ts +13 -0
- package/src/models/RecommendCourseBlock.ts +8 -0
- package/src/models/RecommendCourseResponse.ts +8 -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 +665 -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/CatalogService.ts +13 -17
- package/src/services/SearchService.ts +973 -261
- package/dist/types/models/BlockSkillPointInfoResponse.d.ts +0 -10
- package/dist/types/models/CourseCompletionCatalogResponse.d.ts +0 -11
- package/dist/types/models/CourseSkillPointInfoResponse.d.ts +0 -10
- package/dist/types/models/UserSkillPointInfoResponse.d.ts +0 -10
- package/src/models/BlockSkillPointInfoResponse.ts +0 -15
- package/src/models/CourseCompletionCatalogResponse.ts +0 -16
- package/src/models/CourseSkillPointInfoResponse.ts +0 -15
- package/src/models/UserSkillPointInfoResponse.ts +0 -15
|
@@ -2,7 +2,6 @@ import type { BlankCourseInvitationCreate } from '../models/BlankCourseInvitatio
|
|
|
2
2
|
import type { BlankPlatformInvitationCreate } from '../models/BlankPlatformInvitationCreate';
|
|
3
3
|
import type { BlankProgramInvitationCreate } from '../models/BlankProgramInvitationCreate';
|
|
4
4
|
import type { BlockSkillPointInfoRequest } from '../models/BlockSkillPointInfoRequest';
|
|
5
|
-
import type { BlockSkillPointInfoResponse } from '../models/BlockSkillPointInfoResponse';
|
|
6
5
|
import type { BulkCourseInvitationCreate } from '../models/BulkCourseInvitationCreate';
|
|
7
6
|
import type { BulkCourseInvitationResponse } from '../models/BulkCourseInvitationResponse';
|
|
8
7
|
import type { BulkPlatformInvitationCreate } from '../models/BulkPlatformInvitationCreate';
|
|
@@ -18,7 +17,6 @@ import type { CourseAccessRequestDetail } from '../models/CourseAccessRequestDet
|
|
|
18
17
|
import type { CourseAccessRequestStatusResponse } from '../models/CourseAccessRequestStatusResponse';
|
|
19
18
|
import type { CourseAccessRequestUpdate } from '../models/CourseAccessRequestUpdate';
|
|
20
19
|
import type { CourseCompletion } from '../models/CourseCompletion';
|
|
21
|
-
import type { CourseCompletionCatalogResponse } from '../models/CourseCompletionCatalogResponse';
|
|
22
20
|
import type { CourseCreateUpdate } from '../models/CourseCreateUpdate';
|
|
23
21
|
import type { CourseDeleteResponse } from '../models/CourseDeleteResponse';
|
|
24
22
|
import type { CourseEnrollmentSearchResponse } from '../models/CourseEnrollmentSearchResponse';
|
|
@@ -41,7 +39,6 @@ import type { CourseReviewPaginatedResponse } from '../models/CourseReviewPagina
|
|
|
41
39
|
import type { CourseReviewRequest } from '../models/CourseReviewRequest';
|
|
42
40
|
import type { CourseReviewResponse } from '../models/CourseReviewResponse';
|
|
43
41
|
import type { CourseSkillPointInfoRequest } from '../models/CourseSkillPointInfoRequest';
|
|
44
|
-
import type { CourseSkillPointInfoResponse } from '../models/CourseSkillPointInfoResponse';
|
|
45
42
|
import type { CourseSuggestionBulkCreate } from '../models/CourseSuggestionBulkCreate';
|
|
46
43
|
import type { CourseSuggestionCreate } from '../models/CourseSuggestionCreate';
|
|
47
44
|
import type { CourseSuggestionDetail } from '../models/CourseSuggestionDetail';
|
|
@@ -142,7 +139,6 @@ import type { UserLicenseDetail } from '../models/UserLicenseDetail';
|
|
|
142
139
|
import type { UserLicenseGroupAssignmentCreate } from '../models/UserLicenseGroupAssignmentCreate';
|
|
143
140
|
import type { UserLicenseGroupAssignmentDetail } from '../models/UserLicenseGroupAssignmentDetail';
|
|
144
141
|
import type { UserLicenseUpdate } from '../models/UserLicenseUpdate';
|
|
145
|
-
import type { UserSkillPointInfoResponse } from '../models/UserSkillPointInfoResponse';
|
|
146
142
|
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
147
143
|
export declare class CatalogService {
|
|
148
144
|
/**
|
|
@@ -1882,30 +1878,30 @@ export declare class CatalogService {
|
|
|
1882
1878
|
*/
|
|
1883
1879
|
static catalogMetadataProgramCreate2(field: string, programId: string, requestBody: ProgramMetadataRequest, org?: string, platformKey?: string, programKey?: string): CancelablePromise<ProgramMetadataResponse>;
|
|
1884
1880
|
/**
|
|
1885
|
-
* Retrieve catalog-compatible completion
|
|
1881
|
+
* Retrieve catalog-compatible completion info for user
|
|
1886
1882
|
* @param userId The user identifier
|
|
1887
1883
|
* @param fieldKey Specific field to include in the response
|
|
1888
|
-
* @returns
|
|
1884
|
+
* @returns any
|
|
1889
1885
|
* @throws ApiError
|
|
1890
1886
|
*/
|
|
1891
|
-
static catalogMilestonesCompletionsCourseCatalogRetrieve(userId: number, fieldKey?: string): CancelablePromise<
|
|
1887
|
+
static catalogMilestonesCompletionsCourseCatalogRetrieve(userId: number, fieldKey?: string): CancelablePromise<Record<string, any>>;
|
|
1892
1888
|
/**
|
|
1893
1889
|
* Retrieve completion information for a specific user and course
|
|
1894
1890
|
* @param courseId The course identifier (e.g., 'course-v1:org+code+run')
|
|
1895
1891
|
* @param userId The user identifier
|
|
1896
|
-
* @returns
|
|
1892
|
+
* @returns any
|
|
1897
1893
|
* @throws ApiError
|
|
1898
1894
|
*/
|
|
1899
|
-
static catalogMilestonesCompletionsCourseManageRetrieve(courseId: string, userId: number): CancelablePromise<
|
|
1895
|
+
static catalogMilestonesCompletionsCourseManageRetrieve(courseId: string, userId: number): CancelablePromise<Record<string, any>>;
|
|
1900
1896
|
/**
|
|
1901
1897
|
* Create or update completion information for a specific user and course
|
|
1902
1898
|
* @param courseId The course identifier (e.g., 'course-v1:org+code+run')
|
|
1903
1899
|
* @param userId The user identifier
|
|
1904
1900
|
* @param requestBody
|
|
1905
|
-
* @returns
|
|
1901
|
+
* @returns any
|
|
1906
1902
|
* @throws ApiError
|
|
1907
1903
|
*/
|
|
1908
|
-
static catalogMilestonesCompletionsCourseManageCreate(courseId: string, userId: number, requestBody: CourseCompletion): CancelablePromise<
|
|
1904
|
+
static catalogMilestonesCompletionsCourseManageCreate(courseId: string, userId: number, requestBody: CourseCompletion): CancelablePromise<Record<string, any>>;
|
|
1909
1905
|
/**
|
|
1910
1906
|
* Retrieve pathway completion information
|
|
1911
1907
|
* @param pathwayUuid The unique identifier for the pathway
|
|
@@ -1945,10 +1941,10 @@ export declare class CatalogService {
|
|
|
1945
1941
|
* Retrieve skill point information for a specific block
|
|
1946
1942
|
* @param blockId ID of the block to retrieve skill point information for
|
|
1947
1943
|
* @param getObj If True, returns skill objects instead of skill names as keys
|
|
1948
|
-
* @returns
|
|
1944
|
+
* @returns any
|
|
1949
1945
|
* @throws ApiError
|
|
1950
1946
|
*/
|
|
1951
|
-
static catalogMilestonesSkillPointsBlockRetrieve(blockId: string, getObj?: boolean): CancelablePromise<
|
|
1947
|
+
static catalogMilestonesSkillPointsBlockRetrieve(blockId: string, getObj?: boolean): CancelablePromise<Record<string, any>>;
|
|
1952
1948
|
/**
|
|
1953
1949
|
* Update skill point information for a specific block
|
|
1954
1950
|
* @param blockId ID of the block to retrieve skill point information for
|
|
@@ -1962,10 +1958,10 @@ export declare class CatalogService {
|
|
|
1962
1958
|
* Retrieve skill point information for a specific course
|
|
1963
1959
|
* @param courseId ID of the course to retrieve skill point information for
|
|
1964
1960
|
* @param getObj If True, returns skill objects instead of skill names as keys
|
|
1965
|
-
* @returns
|
|
1961
|
+
* @returns any
|
|
1966
1962
|
* @throws ApiError
|
|
1967
1963
|
*/
|
|
1968
|
-
static catalogMilestonesSkillPointsCourseRetrieve(courseId: string, getObj?: boolean): CancelablePromise<
|
|
1964
|
+
static catalogMilestonesSkillPointsCourseRetrieve(courseId: string, getObj?: boolean): CancelablePromise<Record<string, any>>;
|
|
1969
1965
|
/**
|
|
1970
1966
|
* Update skill point information for a specific course
|
|
1971
1967
|
* @param courseId ID of the course to retrieve skill point information for
|
|
@@ -2028,10 +2024,10 @@ export declare class CatalogService {
|
|
|
2028
2024
|
* Retrieve skill point information for a specific user
|
|
2029
2025
|
* @param userId ID of the user to retrieve skill point information for
|
|
2030
2026
|
* @param username Username to retrieve skill point information for
|
|
2031
|
-
* @returns
|
|
2027
|
+
* @returns any
|
|
2032
2028
|
* @throws ApiError
|
|
2033
2029
|
*/
|
|
2034
|
-
static catalogMilestonesSkillPointsUserRetrieve(userId?: number, username?: string): CancelablePromise<
|
|
2030
|
+
static catalogMilestonesSkillPointsUserRetrieve(userId?: number, username?: string): CancelablePromise<Record<string, any>>;
|
|
2035
2031
|
/**
|
|
2036
2032
|
* Retrieve pathways matching query. Limited parameters.
|
|
2037
2033
|
* @param itemId Item ID associated with the pathway
|
|
@@ -1,7 +1,31 @@
|
|
|
1
|
+
import type { DocumentSearchResponse } from '../models/DocumentSearchResponse';
|
|
1
2
|
import type { GlobalCatalogSearchResponse } from '../models/GlobalCatalogSearchResponse';
|
|
3
|
+
import type { MentorSearchResponse } from '../models/MentorSearchResponse';
|
|
2
4
|
import type { UserSearchResponse } from '../models/UserSearchResponse';
|
|
3
5
|
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
4
6
|
export declare class SearchService {
|
|
7
|
+
/**
|
|
8
|
+
* Legacy endpoint for backward compatible mentor search
|
|
9
|
+
* @param audience Filter by target audience
|
|
10
|
+
* @param category Filter by mentor category
|
|
11
|
+
* @param createdBy Filter mentors created by specific user
|
|
12
|
+
* @param filterFacet If present, return only facets without results
|
|
13
|
+
* @param id Retrieve a specific mentor by ID
|
|
14
|
+
* @param limit Number of results per page
|
|
15
|
+
* @param llm Filter by language model type
|
|
16
|
+
* @param offset Starting position for pagination
|
|
17
|
+
* @param orderBy Field to sort results by ('created_at', 'recently_accessed_at')
|
|
18
|
+
* @param orderDirection Sort direction ('asc' or 'desc')
|
|
19
|
+
* @param page Page number (1-based, used with page_size)
|
|
20
|
+
* @param pageSize Number of results per page
|
|
21
|
+
* @param query Search term to filter mentors by name or description
|
|
22
|
+
* @param tags Filter by tags
|
|
23
|
+
* @param tenant Filter by tenant/organization
|
|
24
|
+
* @param uniqueId Retrieve a specific mentor by UUID
|
|
25
|
+
* @returns MentorSearchResponse
|
|
26
|
+
* @throws ApiError
|
|
27
|
+
*/
|
|
28
|
+
static searchAiSearchRetrieve(audience?: Array<string>, category?: Array<string>, createdBy?: string, filterFacet?: boolean, id?: number, limit?: number, llm?: Array<string>, offset?: number, orderBy?: string, orderDirection?: string, page?: number, pageSize?: number, query?: string, tags?: Array<string>, tenant?: string, uniqueId?: string): CancelablePromise<MentorSearchResponse>;
|
|
5
29
|
/**
|
|
6
30
|
* Search and filter content across the learning catalog.
|
|
7
31
|
*
|
|
@@ -200,6 +224,259 @@ export declare class SearchService {
|
|
|
200
224
|
* @throws ApiError
|
|
201
225
|
*/
|
|
202
226
|
static searchCatalogRetrieve(allowSkillSearch?: boolean, alphabetical?: boolean, certificate?: Array<string>, content?: Array<string>, courseId?: string, duration?: Array<string>, language?: Array<string>, level?: Array<string>, limit?: number, offset?: number, orderAscending?: boolean, orderBy?: string, pathwayId?: string, price?: string, programId?: string, programType?: Array<string>, promotion?: Array<string>, query?: string, resourceType?: Array<string>, returnFacet?: boolean, returnItems?: boolean, selfPaced?: Array<string>, skillId?: string, skills?: Array<string>, subject?: Array<string>, tags?: Array<string>, tenant?: Array<string>, topics?: Array<string>, updateFacet?: string): CancelablePromise<GlobalCatalogSearchResponse>;
|
|
227
|
+
/**
|
|
228
|
+
* Search and filter AI mentors across the platform.
|
|
229
|
+
*
|
|
230
|
+
* This endpoint provides a powerful search interface for discovering AI mentors
|
|
231
|
+
* with support for filtering, pagination, and detailed mentor information.
|
|
232
|
+
*
|
|
233
|
+
* Query Parameters:
|
|
234
|
+
* # Identification parameters (for detail view)
|
|
235
|
+
* id (int, optional): Retrieve a specific mentor by ID
|
|
236
|
+
* unique_id (uuid, optional): Retrieve a specific mentor by UUID
|
|
237
|
+
*
|
|
238
|
+
* # Search and filtering parameters
|
|
239
|
+
* query (str, optional): Search term to filter mentors by name or description
|
|
240
|
+
* tenant (str, optional): Filter by tenant/organization
|
|
241
|
+
* llm (list, optional): Filter by language model type
|
|
242
|
+
* audience (list, optional): Filter by target audience
|
|
243
|
+
* category (list, optional): Filter by mentor category
|
|
244
|
+
* tags (list, optional): Filter by tags
|
|
245
|
+
* created_by (str, optional): Filter mentors created by specific user
|
|
246
|
+
*
|
|
247
|
+
* # Sorting and pagination
|
|
248
|
+
* order_by (str, optional): Field to sort results by ('created_at', 'recently_accessed_at')
|
|
249
|
+
* order_direction (str, optional): Sort direction ('asc' or 'desc', default: 'desc')
|
|
250
|
+
* limit (int, optional): Number of results per page (default: 12, max: 100)
|
|
251
|
+
* offset (int, optional): Starting position for pagination
|
|
252
|
+
*
|
|
253
|
+
* Returns:
|
|
254
|
+
* For detail view (when id or unique_id is provided):
|
|
255
|
+
* A JSON response containing a single mentor's details:
|
|
256
|
+
* {
|
|
257
|
+
* "id": 123,
|
|
258
|
+
* "unique_id": "550e8400-e29b-41d4-a716-446655440000",
|
|
259
|
+
* "name": "Professor Smith",
|
|
260
|
+
* "description": "AI mentor specializing in computer science",
|
|
261
|
+
* "image_url": "https://example.com/images/prof-smith.jpg",
|
|
262
|
+
* "llm": {
|
|
263
|
+
* "id": 1,
|
|
264
|
+
* "name": "GPT-4",
|
|
265
|
+
* "description": "Advanced language model"
|
|
266
|
+
* },
|
|
267
|
+
* "audience": {
|
|
268
|
+
* "id": 2,
|
|
269
|
+
* "name": "College Students",
|
|
270
|
+
* "description": "For university-level learners"
|
|
271
|
+
* },
|
|
272
|
+
* "category": "Computer Science",
|
|
273
|
+
* "tags": ["programming", "algorithms", "data structures"],
|
|
274
|
+
* "created_at": "2023-01-15T12:00:00Z",
|
|
275
|
+
* "recently_accessed_at": "2023-06-20T15:30:00Z",
|
|
276
|
+
* "platform": {
|
|
277
|
+
* "id": 1,
|
|
278
|
+
* "name": "Example University",
|
|
279
|
+
* "key": "example-university"
|
|
280
|
+
* },
|
|
281
|
+
* "visibility": "public",
|
|
282
|
+
* "settings": {
|
|
283
|
+
* "temperature": 0.7,
|
|
284
|
+
* "max_tokens": 1024,
|
|
285
|
+
* "system_prompt": "You are Professor Smith, an expert in computer science..."
|
|
286
|
+
* }
|
|
287
|
+
* }
|
|
288
|
+
*
|
|
289
|
+
* For list view:
|
|
290
|
+
* A JSON response containing:
|
|
291
|
+
* {
|
|
292
|
+
* "results": [
|
|
293
|
+
* {
|
|
294
|
+
* "id": 123,
|
|
295
|
+
* "unique_id": "550e8400-e29b-41d4-a716-446655440000",
|
|
296
|
+
* "name": "Professor Smith",
|
|
297
|
+
* "description": "AI mentor specializing in computer science",
|
|
298
|
+
* "image_url": "https://example.com/images/prof-smith.jpg",
|
|
299
|
+
* "llm": {"id": 1, "name": "GPT-4"},
|
|
300
|
+
* "audience": {"id": 2, "name": "College Students"},
|
|
301
|
+
* "category": "Computer Science",
|
|
302
|
+
* "tags": ["programming", "algorithms"],
|
|
303
|
+
* "created_at": "2023-01-15T12:00:00Z",
|
|
304
|
+
* "recently_accessed_at": "2023-06-20T15:30:00Z"
|
|
305
|
+
* },
|
|
306
|
+
* // Additional mentor objects...
|
|
307
|
+
* ],
|
|
308
|
+
* "count": 50,
|
|
309
|
+
* "next": "https://api.example.com/api/search/mentors/?limit=12&offset=12",
|
|
310
|
+
* "previous": null,
|
|
311
|
+
* "current_page": 1,
|
|
312
|
+
* "num_pages": 5,
|
|
313
|
+
* "facets": {
|
|
314
|
+
* "llm": [
|
|
315
|
+
* {"key": "GPT-4", "doc_count": 30},
|
|
316
|
+
* {"key": "Claude", "doc_count": 20}
|
|
317
|
+
* ],
|
|
318
|
+
* "audience": [
|
|
319
|
+
* {"key": "College Students", "doc_count": 35},
|
|
320
|
+
* {"key": "Professionals", "doc_count": 15}
|
|
321
|
+
* ],
|
|
322
|
+
* "category": [
|
|
323
|
+
* {"key": "Computer Science", "doc_count": 25},
|
|
324
|
+
* {"key": "Mathematics", "doc_count": 15},
|
|
325
|
+
* {"key": "Business", "doc_count": 10}
|
|
326
|
+
* ]
|
|
327
|
+
* }
|
|
328
|
+
* }
|
|
329
|
+
*
|
|
330
|
+
* Error Responses:
|
|
331
|
+
* 400 Bad Request: If the request parameters are invalid
|
|
332
|
+
* 404 Not Found: If the requested mentor doesn't exist
|
|
333
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
334
|
+
*
|
|
335
|
+
* Notes:
|
|
336
|
+
* - Results are cached for performance
|
|
337
|
+
* - Public mentors are visible to all users
|
|
338
|
+
* - Private mentors are only visible to authorized users
|
|
339
|
+
* @param audience Filter by target audience
|
|
340
|
+
* @param category Filter by mentor category
|
|
341
|
+
* @param createdBy Filter mentors created by specific user
|
|
342
|
+
* @param id Retrieve a specific mentor by ID
|
|
343
|
+
* @param limit Number of results per page
|
|
344
|
+
* @param llm Filter by language model type
|
|
345
|
+
* @param offset Starting position for pagination
|
|
346
|
+
* @param orderBy Field to sort results by ('created_at', 'recently_accessed_at')
|
|
347
|
+
* @param orderDirection Sort direction ('asc' or 'desc')
|
|
348
|
+
* @param query Search term to filter mentors by name or description
|
|
349
|
+
* @param tags Filter by tags
|
|
350
|
+
* @param tenant Filter by tenant/organization
|
|
351
|
+
* @param uniqueId Retrieve a specific mentor by UUID
|
|
352
|
+
* @returns MentorSearchResponse
|
|
353
|
+
* @throws ApiError
|
|
354
|
+
*/
|
|
355
|
+
static searchMentorsRetrieve(audience?: Array<string>, category?: Array<string>, createdBy?: string, id?: number, limit?: number, llm?: Array<string>, offset?: number, orderBy?: string, orderDirection?: string, query?: string, tags?: Array<string>, tenant?: string, uniqueId?: string): CancelablePromise<MentorSearchResponse>;
|
|
356
|
+
/**
|
|
357
|
+
* Search and filter documents associated with a specific mentor
|
|
358
|
+
* @param mentorUniqueId
|
|
359
|
+
* @param access Filter by access level (e.g., 'public', 'private')
|
|
360
|
+
* @param documentType Filter by document type (e.g., 'pdf', 'text')
|
|
361
|
+
* @param limit Number of results per page
|
|
362
|
+
* @param offset Starting position for pagination
|
|
363
|
+
* @param orderBy Field to sort results by ('date_created', 'last_modified', 'document_name')
|
|
364
|
+
* @param orderDirection Sort direction ('asc' or 'desc')
|
|
365
|
+
* @param platformKey Filter by platform key
|
|
366
|
+
* @param query Search term to filter documents by name or content
|
|
367
|
+
* @param trainingStatus Filter by training status (e.g., 'trained', 'pending')
|
|
368
|
+
* @returns DocumentSearchResponse
|
|
369
|
+
* @throws ApiError
|
|
370
|
+
*/
|
|
371
|
+
static searchMentorsDocumentsRetrieve(mentorUniqueId: string, access?: string, documentType?: string, limit?: number, offset?: number, orderBy?: string, orderDirection?: string, platformKey?: string, query?: string, trainingStatus?: string): CancelablePromise<DocumentSearchResponse>;
|
|
372
|
+
/**
|
|
373
|
+
* Handle GET requests for tenant-specific mentor search.
|
|
374
|
+
*
|
|
375
|
+
* Args:
|
|
376
|
+
* request: HTTP request object
|
|
377
|
+
* org: Tenant/organization key
|
|
378
|
+
* username: Username of the user making the request
|
|
379
|
+
*
|
|
380
|
+
* Returns:
|
|
381
|
+
* Response: DRF Response object with search results
|
|
382
|
+
* @param org
|
|
383
|
+
* @param username
|
|
384
|
+
* @param audience Filter by target audience
|
|
385
|
+
* @param category Filter by mentor category
|
|
386
|
+
* @param createdBy Filter mentors created by specific user
|
|
387
|
+
* @param id Retrieve a specific mentor by ID
|
|
388
|
+
* @param limit Number of results per page
|
|
389
|
+
* @param llm Filter by language model type
|
|
390
|
+
* @param offset Starting position for pagination
|
|
391
|
+
* @param orderBy Field to sort results by ('created_at', 'recently_accessed_at')
|
|
392
|
+
* @param orderDirection Sort direction ('asc' or 'desc')
|
|
393
|
+
* @param query Search term to filter mentors by name or description
|
|
394
|
+
* @param tags Filter by tags
|
|
395
|
+
* @param tenant Filter by tenant/organization
|
|
396
|
+
* @param uniqueId Retrieve a specific mentor by UUID
|
|
397
|
+
* @returns MentorSearchResponse
|
|
398
|
+
* @throws ApiError
|
|
399
|
+
*/
|
|
400
|
+
static searchOrgsUsersMentorsRetrieve(org: string, username: string, audience?: Array<string>, category?: Array<string>, createdBy?: string, id?: number, limit?: number, llm?: Array<string>, offset?: number, orderBy?: string, orderDirection?: string, query?: string, tags?: Array<string>, tenant?: string, uniqueId?: string): CancelablePromise<MentorSearchResponse>;
|
|
401
|
+
/**
|
|
402
|
+
* Search and filter AI prompts for a specific user within a tenant.
|
|
403
|
+
*
|
|
404
|
+
* This endpoint extends the base prompt search functionality but filters results
|
|
405
|
+
* to only show prompts that are available to a specific user within a specific
|
|
406
|
+
* organization/tenant.
|
|
407
|
+
*
|
|
408
|
+
* Path Parameters:
|
|
409
|
+
* org (str): The organization/tenant identifier
|
|
410
|
+
* username (str): The username to filter prompts for
|
|
411
|
+
*
|
|
412
|
+
* Query Parameters:
|
|
413
|
+
* Same as PromptSearchView, plus:
|
|
414
|
+
*
|
|
415
|
+
* # Identification parameters (for detail view)
|
|
416
|
+
* id (int, optional): Retrieve a specific prompt by ID
|
|
417
|
+
*
|
|
418
|
+
* Returns:
|
|
419
|
+
* Same format as PromptSearchView, but filtered to only include prompts
|
|
420
|
+
* that the specified user has access to within the specified organization.
|
|
421
|
+
*
|
|
422
|
+
* Error Responses:
|
|
423
|
+
* 400 Bad Request: If the request parameters are invalid
|
|
424
|
+
* 403 Forbidden: If the requested prompt exists but the user doesn't have access
|
|
425
|
+
* 404 Not Found: If the requested prompt doesn't exist
|
|
426
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
427
|
+
*
|
|
428
|
+
* Access Control:
|
|
429
|
+
* - Results are filtered based on user's permissions within the organization
|
|
430
|
+
* - Private prompts are only visible to authorized users
|
|
431
|
+
* @param org
|
|
432
|
+
* @param username
|
|
433
|
+
* @param alphabetical Sort alphabetically
|
|
434
|
+
* @param category Filter by prompt category
|
|
435
|
+
* @param filterFacet If true, return only facets without results
|
|
436
|
+
* @param language Filter by prompt language
|
|
437
|
+
* @param limit Number of results per page
|
|
438
|
+
* @param mentor Filter by mentor UUID
|
|
439
|
+
* @param offset Starting position for pagination
|
|
440
|
+
* @param orderDirection Sort direction ('asc' or 'desc')
|
|
441
|
+
* @param query Search term to filter prompts by name or content
|
|
442
|
+
* @param sortBy Field to sort results by
|
|
443
|
+
* @param style Filter by prompt style
|
|
444
|
+
* @param tenant Filter by tenant/organization
|
|
445
|
+
* @param tone Filter by prompt tone
|
|
446
|
+
* @returns void
|
|
447
|
+
* @throws ApiError
|
|
448
|
+
*/
|
|
449
|
+
static searchOrgsUsersPromptsRetrieve(org: string, username: string, alphabetical?: boolean, category?: string, filterFacet?: boolean, language?: string, limit?: number, mentor?: string, offset?: number, orderDirection?: string, query?: string, sortBy?: string, style?: string, tenant?: string, tone?: string): CancelablePromise<void>;
|
|
450
|
+
/**
|
|
451
|
+
* Determine whether to serve a detail view or a list view.
|
|
452
|
+
* @param org
|
|
453
|
+
* @param username
|
|
454
|
+
* @param certificate Filter by certificate type
|
|
455
|
+
* @param content Content types to include in recommendations (courses, programs, pathways, skills, roles, resources)
|
|
456
|
+
* @param courseId Retrieve a specific course by ID
|
|
457
|
+
* @param duration Filter by course duration range
|
|
458
|
+
* @param language Filter by content language
|
|
459
|
+
* @param level Filter by difficulty level
|
|
460
|
+
* @param limit Number of results per page
|
|
461
|
+
* @param offset Starting position for pagination
|
|
462
|
+
* @param pathwayId Retrieve a specific pathway by ID
|
|
463
|
+
* @param price Filter by price/audit status
|
|
464
|
+
* @param programId Retrieve a specific program by ID
|
|
465
|
+
* @param programType Filter by program type
|
|
466
|
+
* @param query Search term to filter content by name or description
|
|
467
|
+
* @param resourceId Retrieve a specific resource by ID
|
|
468
|
+
* @param resourceType Filter by resource type
|
|
469
|
+
* @param roleId Retrieve a specific role by ID
|
|
470
|
+
* @param selfPaced Filter by course format (self-paced, instructor-led)
|
|
471
|
+
* @param skillId Retrieve a specific skill by ID
|
|
472
|
+
* @param skills Filter by skills
|
|
473
|
+
* @param subject Filter by subject areas
|
|
474
|
+
* @param tags Filter by tags
|
|
475
|
+
* @param topics Filter by topic areas
|
|
476
|
+
* @returns void
|
|
477
|
+
* @throws ApiError
|
|
478
|
+
*/
|
|
479
|
+
static searchOrgsUsersRecommendedRetrieve(org: string, username: string, certificate?: Array<string>, content?: Array<string>, courseId?: string, duration?: Array<string>, language?: Array<string>, level?: Array<string>, limit?: number, offset?: number, pathwayId?: string, price?: string, programId?: string, programType?: Array<string>, query?: string, resourceId?: string, resourceType?: Array<string>, roleId?: string, selfPaced?: Array<string>, skillId?: string, skills?: Array<string>, subject?: Array<string>, tags?: Array<string>, topics?: Array<string>): CancelablePromise<void>;
|
|
203
480
|
/**
|
|
204
481
|
* Determine whether to serve a detail view or a list view.
|
|
205
482
|
* If any detail-identifying parameters are present (course_id, program_id, etc.)
|
|
@@ -241,6 +518,133 @@ export declare class SearchService {
|
|
|
241
518
|
* @throws ApiError
|
|
242
519
|
*/
|
|
243
520
|
static searchPersonalizedCatalogRetrieve(username: string, allowSkillSearch?: boolean, alphabetical?: boolean, certificate?: Array<string>, content?: Array<string>, courseId?: string, duration?: Array<string>, language?: Array<string>, level?: Array<string>, limit?: number, offset?: number, orderAscending?: boolean, orderBy?: string, pathwayId?: string, price?: string, programId?: string, programType?: Array<string>, promotion?: Array<string>, query?: string, recommended?: boolean, resourceId?: string, resourceType?: Array<string>, returnFacet?: boolean, returnItems?: boolean, roleId?: string, selfPaced?: Array<string>, skillId?: string, skills?: Array<string>, subject?: Array<string>, tags?: Array<string>, tenant?: Array<string>, topics?: Array<string>, updateFacet?: string): CancelablePromise<Record<string, any>>;
|
|
521
|
+
/**
|
|
522
|
+
* Search and filter AI prompts across the platform.
|
|
523
|
+
*
|
|
524
|
+
* This endpoint provides a search interface for discovering AI prompts
|
|
525
|
+
* with support for filtering, pagination, and detailed prompt information.
|
|
526
|
+
*
|
|
527
|
+
* Query Parameters:
|
|
528
|
+
* # Identification parameters (for detail view)
|
|
529
|
+
* id (int, optional): Retrieve a specific prompt by ID
|
|
530
|
+
*
|
|
531
|
+
* # Search and filtering parameters
|
|
532
|
+
* query (str, optional): Search term to filter prompts by name or content
|
|
533
|
+
* category (str, optional): Filter by prompt category
|
|
534
|
+
* language (str, optional): Filter by prompt language
|
|
535
|
+
* style (str, optional): Filter by writing style
|
|
536
|
+
* tone (str, optional): Filter by tone
|
|
537
|
+
* tenant (str, optional): Filter by tenant/organization
|
|
538
|
+
* mentor (str, optional): Filter by associated mentor (UUID)
|
|
539
|
+
*
|
|
540
|
+
* # Sorting and pagination
|
|
541
|
+
* sort_by (str, optional): Field to sort results by
|
|
542
|
+
* order_direction (str, optional): Sort direction ('asc' or 'desc', default: 'desc')
|
|
543
|
+
* alphabetical (bool, optional): Sort alphabetically by name (default: false)
|
|
544
|
+
* limit (int, optional): Number of results per page (default: 10)
|
|
545
|
+
* offset (int, optional): Starting position for pagination
|
|
546
|
+
*
|
|
547
|
+
* # Special parameters
|
|
548
|
+
* filter_facet (any, optional): If present, return only facets without results
|
|
549
|
+
*
|
|
550
|
+
* Returns:
|
|
551
|
+
* For detail view (when id is provided):
|
|
552
|
+
* A JSON response containing a single prompt's details:
|
|
553
|
+
* {
|
|
554
|
+
* "id": 456,
|
|
555
|
+
* "name": "Essay Writing Guide",
|
|
556
|
+
* "content": "Write a well-structured essay on the following topic: {{topic}}...",
|
|
557
|
+
* "category": "Academic Writing",
|
|
558
|
+
* "language": "English",
|
|
559
|
+
* "style": "Formal",
|
|
560
|
+
* "tone": "Professional",
|
|
561
|
+
* "mentor": {
|
|
562
|
+
* "id": 123,
|
|
563
|
+
* "unique_id": "550e8400-e29b-41d4-a716-446655440000",
|
|
564
|
+
* "name": "Professor Smith"
|
|
565
|
+
* },
|
|
566
|
+
* "platform": {
|
|
567
|
+
* "id": 1,
|
|
568
|
+
* "name": "Example University",
|
|
569
|
+
* "key": "example-university"
|
|
570
|
+
* },
|
|
571
|
+
* "created_at": "2023-02-10T09:15:00Z",
|
|
572
|
+
* "updated_at": "2023-05-05T14:20:00Z",
|
|
573
|
+
* "visibility": "public",
|
|
574
|
+
* "variables": ["topic", "length", "style"]
|
|
575
|
+
* }
|
|
576
|
+
*
|
|
577
|
+
* For list view:
|
|
578
|
+
* A JSON response containing:
|
|
579
|
+
* {
|
|
580
|
+
* "results": [
|
|
581
|
+
* {
|
|
582
|
+
* "id": 456,
|
|
583
|
+
* "name": "Essay Writing Guide",
|
|
584
|
+
* "content": "Write a well-structured essay on the following topic: {{topic}}...",
|
|
585
|
+
* "category": "Academic Writing",
|
|
586
|
+
* "language": "English",
|
|
587
|
+
* "style": "Formal",
|
|
588
|
+
* "tone": "Professional",
|
|
589
|
+
* "mentor": {"id": 123, "name": "Professor Smith"},
|
|
590
|
+
* "created_at": "2023-02-10T09:15:00Z",
|
|
591
|
+
* "updated_at": "2023-05-05T14:20:00Z"
|
|
592
|
+
* },
|
|
593
|
+
* // Additional prompt objects...
|
|
594
|
+
* ],
|
|
595
|
+
* "count": 30,
|
|
596
|
+
* "next": "?limit=10&offset=10",
|
|
597
|
+
* "previous": null,
|
|
598
|
+
* "current_page": 1,
|
|
599
|
+
* "num_pages": 3,
|
|
600
|
+
* "facets": {
|
|
601
|
+
* "category": [
|
|
602
|
+
* {"key": "Academic Writing", "doc_count": 15},
|
|
603
|
+
* {"key": "Creative Writing", "doc_count": 10},
|
|
604
|
+
* {"key": "Technical Documentation", "doc_count": 5}
|
|
605
|
+
* ],
|
|
606
|
+
* "language": [
|
|
607
|
+
* {"key": "English", "doc_count": 25},
|
|
608
|
+
* {"key": "Spanish", "doc_count": 5}
|
|
609
|
+
* ],
|
|
610
|
+
* "style": [
|
|
611
|
+
* {"key": "Formal", "doc_count": 20},
|
|
612
|
+
* {"key": "Casual", "doc_count": 10}
|
|
613
|
+
* ],
|
|
614
|
+
* "tone": [
|
|
615
|
+
* {"key": "Professional", "doc_count": 15},
|
|
616
|
+
* {"key": "Friendly", "doc_count": 10},
|
|
617
|
+
* {"key": "Technical", "doc_count": 5}
|
|
618
|
+
* ]
|
|
619
|
+
* }
|
|
620
|
+
* }
|
|
621
|
+
*
|
|
622
|
+
* Error Responses:
|
|
623
|
+
* 400 Bad Request: If the request parameters are invalid
|
|
624
|
+
* 403 Forbidden: If the requested prompt exists but is not publicly available
|
|
625
|
+
* 404 Not Found: If the requested prompt doesn't exist
|
|
626
|
+
* 500 Internal Server Error: If an unexpected error occurs
|
|
627
|
+
*
|
|
628
|
+
* Notes:
|
|
629
|
+
* - Only publicly available prompts are returned by default
|
|
630
|
+
* - When filtering by mentor, the mentor ID must be a valid UUID
|
|
631
|
+
* @param alphabetical Sort alphabetically
|
|
632
|
+
* @param category Filter by prompt category
|
|
633
|
+
* @param filterFacet If true, return only facets without results
|
|
634
|
+
* @param language Filter by prompt language
|
|
635
|
+
* @param limit Number of results per page
|
|
636
|
+
* @param mentor Filter by mentor UUID
|
|
637
|
+
* @param offset Starting position for pagination
|
|
638
|
+
* @param orderDirection Sort direction ('asc' or 'desc')
|
|
639
|
+
* @param query Search term to filter prompts by name or content
|
|
640
|
+
* @param sortBy Field to sort results by
|
|
641
|
+
* @param style Filter by prompt style
|
|
642
|
+
* @param tenant Filter by tenant/organization
|
|
643
|
+
* @param tone Filter by prompt tone
|
|
644
|
+
* @returns void
|
|
645
|
+
* @throws ApiError
|
|
646
|
+
*/
|
|
647
|
+
static searchPromptsRetrieve(alphabetical?: boolean, category?: string, filterFacet?: boolean, language?: string, limit?: number, mentor?: string, offset?: number, orderDirection?: string, query?: string, sortBy?: string, style?: string, tenant?: string, tone?: string): CancelablePromise<void>;
|
|
244
648
|
/**
|
|
245
649
|
* Search and filter users within a specific organization/tenant.
|
|
246
650
|
*
|
package/package.json
CHANGED
package/src/core/OpenAPI.ts
CHANGED