@iblai/iblai-api 3.48.0-ai-plus → 3.48.1-core
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 +119 -16407
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +120 -16399
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +119 -16407
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +1 -319
- package/dist/types/models/NotificationSource.d.ts +2 -2
- package/dist/types/models/{NotificationSourceTypeEnum.d.ts → TypeEnum.d.ts} +1 -1
- package/dist/types/services/SearchService.d.ts +0 -408
- package/package.json +1 -1
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +1 -319
- package/src/models/NotificationSource.ts +2 -2
- package/src/models/{NotificationSourceTypeEnum.ts → TypeEnum.ts} +1 -1
- package/src/services/SearchService.ts +261 -981
- package/dist/types/models/AIGeneratedImage.d.ts +0 -13
- package/dist/types/models/AIUserProfileMemoryRelation.d.ts +0 -4
- package/dist/types/models/AIUserProfileRequest.d.ts +0 -4
- package/dist/types/models/APITokenCost.d.ts +0 -14
- package/dist/types/models/AccessEnum.d.ts +0 -8
- package/dist/types/models/AlignMentorBubbleEnum.d.ts +0 -8
- package/dist/types/models/AnalyticsOverview.d.ts +0 -7
- package/dist/types/models/Answer.d.ts +0 -11
- package/dist/types/models/AssumedKnowledge.d.ts +0 -4
- package/dist/types/models/AssumedKnowledgeLevel.d.ts +0 -4
- package/dist/types/models/AudioToTextRequest.d.ts +0 -3
- package/dist/types/models/AudioToTextResponse.d.ts +0 -3
- package/dist/types/models/Bot.d.ts +0 -15
- package/dist/types/models/BotCommand.d.ts +0 -6
- package/dist/types/models/BotCreate.d.ts +0 -12
- package/dist/types/models/CallAuthenticationRequest.d.ts +0 -13
- package/dist/types/models/CallAuthenticationResponse.d.ts +0 -21
- package/dist/types/models/ChatHistory.d.ts +0 -8
- package/dist/types/models/ChatHistoryFilterData.d.ts +0 -9
- package/dist/types/models/ChatHistoryFilterUser.d.ts +0 -5
- package/dist/types/models/ChatHistoryItem.d.ts +0 -5
- package/dist/types/models/ChatHistorySessionId.d.ts +0 -3
- package/dist/types/models/ChatSessionRequest.d.ts +0 -10
- package/dist/types/models/ChatSessionResponse.d.ts +0 -5
- package/dist/types/models/CheckDocumentTrainingStatus.d.ts +0 -10
- package/dist/types/models/ComponentBlock.d.ts +0 -9
- package/dist/types/models/ComponentBlockTypeEnum.d.ts +0 -8
- package/dist/types/models/ConversationMessage.d.ts +0 -11
- package/dist/types/models/ConversationRating.d.ts +0 -6
- package/dist/types/models/ConversationSummary.d.ts +0 -5
- package/dist/types/models/ConversationVolume.d.ts +0 -4
- package/dist/types/models/Conversations.d.ts +0 -28
- package/dist/types/models/Cost.d.ts +0 -3
- package/dist/types/models/CostPerTenant.d.ts +0 -6
- package/dist/types/models/CourseCreationTask.d.ts +0 -31
- package/dist/types/models/CourseCreationTaskFile.d.ts +0 -7
- package/dist/types/models/CourseCreationTaskStatusEnum.d.ts +0 -16
- package/dist/types/models/CredentialRequest.d.ts +0 -14
- package/dist/types/models/CrontabSchedule.d.ts +0 -22
- package/dist/types/models/CustomInstructionResponse.d.ts +0 -13
- package/dist/types/models/DataSet.d.ts +0 -21
- package/dist/types/models/DataSetCreate.d.ts +0 -12
- package/dist/types/models/DataSetStatusEnum.d.ts +0 -12
- package/dist/types/models/DateRange.d.ts +0 -4
- package/dist/types/models/DiscordConfig.d.ts +0 -7
- package/dist/types/models/DiscordUserConfig.d.ts +0 -10
- package/dist/types/models/DiscordWebhook.d.ts +0 -6
- package/dist/types/models/Document.d.ts +0 -41
- package/dist/types/models/DocumentFacet.d.ts +0 -17
- package/dist/types/models/DocumentSearchResponse.d.ts +0 -35
- package/dist/types/models/DocumentSettingsResponse.d.ts +0 -3
- package/dist/types/models/EdxCourse.d.ts +0 -11
- package/dist/types/models/ElevenlabsCustomVoice.d.ts +0 -4
- package/dist/types/models/ElevenlabsCustomVoiceResponse.d.ts +0 -8
- package/dist/types/models/EmailPromptDetail.d.ts +0 -13
- package/dist/types/models/EmailPromptList.d.ts +0 -11
- package/dist/types/models/EmailPromptSummary.d.ts +0 -5
- package/dist/types/models/FreeUsageCount.d.ts +0 -3
- package/dist/types/models/FullCourse.d.ts +0 -13
- package/dist/types/models/GreetingMethodEnum.d.ts +0 -8
- package/dist/types/models/GuidedPromptsResponse.d.ts +0 -3
- package/dist/types/models/HeygenMarketingVideoDetail.d.ts +0 -8
- package/dist/types/models/HeygenMarketingVideoList.d.ts +0 -6
- package/dist/types/models/HeygenTemplateRequest.d.ts +0 -5
- package/dist/types/models/HeygenTemplateResponseSingle.d.ts +0 -6
- package/dist/types/models/HeygenVideoDetail.d.ts +0 -8
- package/dist/types/models/HeygenVideoRequest.d.ts +0 -5
- package/dist/types/models/IBLAIPlatformMeta.d.ts +0 -3
- package/dist/types/models/IBLAIPlatformMetaRequest.d.ts +0 -6
- package/dist/types/models/IBLAIPlatformMetaUpdateRequest.d.ts +0 -10
- package/dist/types/models/InputQuestion.d.ts +0 -6
- package/dist/types/models/IntegrationCredential.d.ts +0 -8
- package/dist/types/models/IntialQuestionAnswer.d.ts +0 -3
- package/dist/types/models/JobRun.d.ts +0 -11
- package/dist/types/models/KindEnum.d.ts +0 -10
- package/dist/types/models/LLMCredentialRequest.d.ts +0 -14
- package/dist/types/models/LLMCredentialResponse.d.ts +0 -8
- package/dist/types/models/LLMModelForTenant.d.ts +0 -6
- package/dist/types/models/LLMQuestion.d.ts +0 -15
- package/dist/types/models/LLMResponse.d.ts +0 -14
- package/dist/types/models/LLMTracesListResponse.d.ts +0 -5
- package/dist/types/models/LanguagesView.d.ts +0 -5
- package/dist/types/models/LinkCourseRequest.d.ts +0 -3
- package/dist/types/models/LinkCourseResponse.d.ts +0 -5
- package/dist/types/models/MCPServer.d.ts +0 -21
- package/dist/types/models/MemoryComponentData.d.ts +0 -5
- package/dist/types/models/MemoryComponentMemory.d.ts +0 -4
- package/dist/types/models/MemoryComponentMemoryDetail.d.ts +0 -8
- package/dist/types/models/MemoryComponentResponse.d.ts +0 -5
- package/dist/types/models/MemoryProgress.d.ts +0 -8
- package/dist/types/models/MemoryStatusRequestView.d.ts +0 -6
- package/dist/types/models/MemoryStatusView.d.ts +0 -6
- package/dist/types/models/Mentor.d.ts +0 -80
- package/dist/types/models/MentorAudience.d.ts +0 -5
- package/dist/types/models/MentorCategory.d.ts +0 -9
- package/dist/types/models/MentorCategoryCreate.d.ts +0 -11
- package/dist/types/models/MentorCategoryGroup.d.ts +0 -11
- package/dist/types/models/MentorCategoryGroupCreate.d.ts +0 -11
- package/dist/types/models/MentorCreate.d.ts +0 -79
- package/dist/types/models/MentorCustomVoice.d.ts +0 -4
- package/dist/types/models/MentorCustomVoiceResponse.d.ts +0 -4
- package/dist/types/models/MentorData.d.ts +0 -7
- package/dist/types/models/MentorDetailAnalytics.d.ts +0 -6
- package/dist/types/models/MentorEval.d.ts +0 -11
- package/dist/types/models/MentorEvalQuestion.d.ts +0 -5
- package/dist/types/models/MentorEvalQuestionRequest.d.ts +0 -4
- package/dist/types/models/MentorEvalReport.d.ts +0 -10
- package/dist/types/models/MentorEvalRequest.d.ts +0 -8
- package/dist/types/models/MentorFacet.d.ts +0 -17
- package/dist/types/models/MentorFork.d.ts +0 -5
- package/dist/types/models/MentorFromTemplateRequest.d.ts +0 -4
- package/dist/types/models/MentorFromTemplateWithSettingRequest.d.ts +0 -45
- package/dist/types/models/MentorMemorySettingsRequest.d.ts +0 -6
- package/dist/types/models/MentorMemorySettingsResponse.d.ts +0 -6
- package/dist/types/models/MentorMetadata.d.ts +0 -5
- package/dist/types/models/MentorScenario.d.ts +0 -6
- package/dist/types/models/MentorScenarioPrompt.d.ts +0 -5
- package/dist/types/models/MentorSearchResponse.d.ts +0 -35
- package/dist/types/models/MentorSession.d.ts +0 -4
- package/dist/types/models/MentorSettings.d.ts +0 -56
- package/dist/types/models/MentorSettingsPublic.d.ts +0 -45
- package/dist/types/models/MentorSettingsRequest.d.ts +0 -60
- package/dist/types/models/MentorVisibilityEnum.d.ts +0 -10
- package/dist/types/models/MentorWizard.d.ts +0 -4
- package/dist/types/models/MessageStatistics.d.ts +0 -5
- package/dist/types/models/MessageView.d.ts +0 -10
- package/dist/types/models/MessageViewRequest.d.ts +0 -7
- package/dist/types/models/MessageViewUpdatResponse.d.ts +0 -3
- package/dist/types/models/Metadata.d.ts +0 -5
- package/dist/types/models/MetricChange.d.ts +0 -4
- package/dist/types/models/ModelCost.d.ts +0 -4
- package/dist/types/models/ModerationLog.d.ts +0 -11
- package/dist/types/models/NoChatMessagesFound.d.ts +0 -3
- package/dist/types/models/NullEnum.d.ts +0 -1
- package/dist/types/models/PageContent.d.ts +0 -6
- package/dist/types/models/PaginatedAIGeneratedImageList.d.ts +0 -7
- package/dist/types/models/PaginatedConversationsList.d.ts +0 -7
- package/dist/types/models/PaginatedCourseCreationTaskFileList.d.ts +0 -7
- package/dist/types/models/PaginatedCourseCreationTaskList.d.ts +0 -7
- package/dist/types/models/PaginatedDataSetList.d.ts +0 -7
- package/dist/types/models/PaginatedEdxCourseList.d.ts +0 -7
- package/dist/types/models/PaginatedEmailPromptListList.d.ts +0 -7
- package/dist/types/models/PaginatedHeygenMarketingVideoListList.d.ts +0 -7
- package/dist/types/models/PaginatedHeygenTemplateResponseSingleList.d.ts +0 -7
- package/dist/types/models/PaginatedJobRunList.d.ts +0 -7
- package/dist/types/models/PaginatedMCPServerList.d.ts +0 -7
- package/dist/types/models/PaginatedMentorList.d.ts +0 -7
- package/dist/types/models/PaginatedModerationLogList.d.ts +0 -7
- package/dist/types/models/PaginatedPeriodicAgentList.d.ts +0 -7
- package/dist/types/models/PaginatedPeriodicAgentLogList.d.ts +0 -7
- package/dist/types/models/PaginatedPlayWrightScriptList.d.ts +0 -7
- package/dist/types/models/PaginatedSectionList.d.ts +0 -7
- package/dist/types/models/PaginatedSubSectionList.d.ts +0 -7
- package/dist/types/models/PaginatedTopicStatisticsResponse.d.ts +0 -7
- package/dist/types/models/PaginatedTrainingList.d.ts +0 -7
- package/dist/types/models/PaginatedUnitList.d.ts +0 -7
- package/dist/types/models/PaginatedUserEdxMemoryList.d.ts +0 -7
- package/dist/types/models/PaginatedVoiceList.d.ts +0 -7
- package/dist/types/models/PatchedBotCommand.d.ts +0 -6
- package/dist/types/models/PatchedBotCreate.d.ts +0 -12
- package/dist/types/models/PatchedConversations.d.ts +0 -28
- package/dist/types/models/PatchedCourseCreationTaskFile.d.ts +0 -7
- package/dist/types/models/PatchedCredentialRequest.d.ts +0 -14
- package/dist/types/models/PatchedDataSet.d.ts +0 -21
- package/dist/types/models/PatchedDiscordConfig.d.ts +0 -7
- package/dist/types/models/PatchedDiscordUserConfig.d.ts +0 -10
- package/dist/types/models/PatchedLLMCredentialRequest.d.ts +0 -14
- package/dist/types/models/PatchedMCPServer.d.ts +0 -21
- package/dist/types/models/PatchedMentorCategoryGroupCreate.d.ts +0 -11
- package/dist/types/models/PatchedMentorCreate.d.ts +0 -79
- package/dist/types/models/PatchedPeriodicAgentCreate.d.ts +0 -41
- package/dist/types/models/PatchedPlayWrightScript.d.ts +0 -12
- package/dist/types/models/PatchedPrompt.d.ts +0 -22
- package/dist/types/models/PatchedSection.d.ts +0 -9
- package/dist/types/models/PatchedSlackConfig.d.ts +0 -8
- package/dist/types/models/PatchedSlackUserConfig.d.ts +0 -17
- package/dist/types/models/PatchedSubSection.d.ts +0 -9
- package/dist/types/models/PatchedTeamsConfig.d.ts +0 -7
- package/dist/types/models/PatchedTrainingCreate.d.ts +0 -31
- package/dist/types/models/PatchedUnit.d.ts +0 -11
- package/dist/types/models/PatchedWebexConfig.d.ts +0 -10
- package/dist/types/models/PatchedWhatsappConfig.d.ts +0 -11
- package/dist/types/models/PatchedWhatsappUserConfig.d.ts +0 -10
- package/dist/types/models/PeriodicAgent.d.ts +0 -42
- package/dist/types/models/PeriodicAgentCreate.d.ts +0 -41
- package/dist/types/models/PeriodicAgentLog.d.ts +0 -11
- package/dist/types/models/PeriodicAgentLogStatusEnum.d.ts +0 -10
- package/dist/types/models/PeriodicTask.d.ts +0 -21
- package/dist/types/models/PieChartData.d.ts +0 -5
- package/dist/types/models/PieChartSegment.d.ts +0 -4
- package/dist/types/models/PinnedMessageCreate.d.ts +0 -9
- package/dist/types/models/PinnedMessageGet.d.ts +0 -7
- package/dist/types/models/PinnedMessageRequest.d.ts +0 -6
- package/dist/types/models/PlayWrightScript.d.ts +0 -12
- package/dist/types/models/PredictiveAnalyticsRequest.d.ts +0 -4
- package/dist/types/models/PredictiveAnalyticsResponse.d.ts +0 -4
- package/dist/types/models/PreviousAgentStatusEnum.d.ts +0 -12
- package/dist/types/models/Prompt.d.ts +0 -22
- package/dist/types/models/PromptCategory.d.ts +0 -7
- package/dist/types/models/PromptFacet.d.ts +0 -17
- package/dist/types/models/PromptSearchResponse.d.ts +0 -35
- package/dist/types/models/PromptVisibilityEnum.d.ts +0 -10
- package/dist/types/models/Provider05cEnum.d.ts +0 -14
- package/dist/types/models/Provider63aEnum.d.ts +0 -6
- package/dist/types/models/QuestionCardTag.d.ts +0 -8
- package/dist/types/models/QuestionRequest.d.ts +0 -15
- package/dist/types/models/QuestionResponse.d.ts +0 -10
- package/dist/types/models/RatingEnum.d.ts +0 -8
- package/dist/types/models/RatingRecord.d.ts +0 -4
- package/dist/types/models/RecentlyAccessedMentor.d.ts +0 -8
- package/dist/types/models/RecommendCourseBlock.d.ts +0 -3
- package/dist/types/models/RecommendCourseResponse.d.ts +0 -3
- package/dist/types/models/RecommendedCoursesResponse.d.ts +0 -33
- package/dist/types/models/RelatedText.d.ts +0 -3
- package/dist/types/models/RequestDataVariable.d.ts +0 -14
- package/dist/types/models/ResourceScrappedData.d.ts +0 -13
- package/dist/types/models/ResourceScrappedDataStatusEnum.d.ts +0 -12
- package/dist/types/models/ResponseDataVariable.d.ts +0 -14
- package/dist/types/models/RetreiverTrainViewRequest.d.ts +0 -10
- package/dist/types/models/RetreiverTrainViewResponse.d.ts +0 -6
- package/dist/types/models/RetrieveTask.d.ts +0 -3
- package/dist/types/models/RetrieverDocumentEmbedding.d.ts +0 -17
- package/dist/types/models/RetrieverDocumentEmbeddingRequest.d.ts +0 -30
- package/dist/types/models/RetrieverRequestSearch.d.ts +0 -10
- package/dist/types/models/RetrieverRequestSearchDocument.d.ts +0 -10
- package/dist/types/models/RetrieverResponseSearch.d.ts +0 -7
- package/dist/types/models/ReuestDataVariableList.d.ts +0 -4
- package/dist/types/models/RunMentorEval.d.ts +0 -3
- package/dist/types/models/ScanWebhookRequest.d.ts +0 -6
- package/dist/types/models/ScanWebhookResponse.d.ts +0 -3
- package/dist/types/models/Section.d.ts +0 -9
- package/dist/types/models/SectionWithChildren.d.ts +0 -11
- package/dist/types/models/SeedMentorsView.d.ts +0 -3
- package/dist/types/models/SentimentSummary.d.ts +0 -4
- package/dist/types/models/SessionBrowserScreenshot.d.ts +0 -8
- package/dist/types/models/SessionDetail.d.ts +0 -6
- package/dist/types/models/SessionMemoryStorage.d.ts +0 -6
- package/dist/types/models/ShellLogs.d.ts +0 -3
- package/dist/types/models/SlackConfig.d.ts +0 -8
- package/dist/types/models/SlackUserConfig.d.ts +0 -17
- package/dist/types/models/SlackWebhook.d.ts +0 -6
- package/dist/types/models/SpacedRepetitionLearningPath.d.ts +0 -3
- package/dist/types/models/SpacedRepetitionQuestionStats.d.ts +0 -5
- package/dist/types/models/StarMentor.d.ts +0 -7
- package/dist/types/models/Status6eeEnum.d.ts +0 -12
- package/dist/types/models/Step.d.ts +0 -9
- package/dist/types/models/StepStatusEnum.d.ts +0 -10
- package/dist/types/models/StudentChatMessage.d.ts +0 -4
- package/dist/types/models/StylesView.d.ts +0 -4
- package/dist/types/models/SubSection.d.ts +0 -9
- package/dist/types/models/SubSectionWithChildren.d.ts +0 -11
- package/dist/types/models/TagsView.d.ts +0 -5
- package/dist/types/models/TargetSystemEnum.d.ts +0 -8
- package/dist/types/models/TaskView.d.ts +0 -3
- package/dist/types/models/TeamsConfig.d.ts +0 -7
- package/dist/types/models/TeamsWebhook.d.ts +0 -17
- package/dist/types/models/TemplateMentor.d.ts +0 -9
- package/dist/types/models/TenantMentorTraces.d.ts +0 -6
- package/dist/types/models/ThemeEnum.d.ts +0 -8
- package/dist/types/models/TonesView.d.ts +0 -4
- package/dist/types/models/ToolResponse.d.ts +0 -11
- package/dist/types/models/TopicModel.d.ts +0 -3
- package/dist/types/models/TopicRecord.d.ts +0 -4
- package/dist/types/models/TopicStatistics.d.ts +0 -7
- package/dist/types/models/TopicStatisticsResponse.d.ts +0 -6
- package/dist/types/models/TopicSummaryView.d.ts +0 -4
- package/dist/types/models/TrainChatSessionDocumentView.d.ts +0 -6
- package/dist/types/models/TrainChatSessionDocumentViewRequest.d.ts +0 -6
- package/dist/types/models/TrainDocumentViewRequest.d.ts +0 -42
- package/dist/types/models/TrainDocumentViewResponse.d.ts +0 -15
- package/dist/types/models/Training.d.ts +0 -41
- package/dist/types/models/TrainingCreate.d.ts +0 -31
- package/dist/types/models/TrainingStatusEnum.d.ts +0 -12
- package/dist/types/models/TransportEnum.d.ts +0 -8
- package/dist/types/models/TrendEntry.d.ts +0 -4
- package/dist/types/models/TriggerRequest.d.ts +0 -5
- package/dist/types/models/TriggerResponse.d.ts +0 -6
- package/dist/types/models/TypeC42Enum.d.ts +0 -8
- package/dist/types/models/Unit.d.ts +0 -11
- package/dist/types/models/UnitWithChildren.d.ts +0 -13
- package/dist/types/models/UseMainCreds.d.ts +0 -3
- package/dist/types/models/UserAllChatMemoryView.d.ts +0 -7
- package/dist/types/models/UserCatalogItemMemoryView.d.ts +0 -14
- package/dist/types/models/UserChatByPeriod.d.ts +0 -4
- package/dist/types/models/UserChatFeedback.d.ts +0 -14
- package/dist/types/models/UserChatFeedbackCount.d.ts +0 -4
- package/dist/types/models/UserChatMemoryStatusRequestView.d.ts +0 -6
- package/dist/types/models/UserChatMemoryStatusView.d.ts +0 -6
- package/dist/types/models/UserChatMemoryUpdateView.d.ts +0 -10
- package/dist/types/models/UserCountRecord.d.ts +0 -4
- package/dist/types/models/UserEdxMemory.d.ts +0 -15
- package/dist/types/models/UserMemoryContextRequest.d.ts +0 -13
- package/dist/types/models/UserMemoryContextResponse.d.ts +0 -12
- package/dist/types/models/UserMetric.d.ts +0 -4
- package/dist/types/models/UserMetricsResponse.d.ts +0 -7
- package/dist/types/models/UserSentimentCountView.d.ts +0 -4
- package/dist/types/models/UserTrendByPeriod.d.ts +0 -5
- package/dist/types/models/VectorResult.d.ts +0 -8
- package/dist/types/models/VideoCaption.d.ts +0 -3
- package/dist/types/models/Voice.d.ts +0 -9
- package/dist/types/models/VoiceProviderEnum.d.ts +0 -10
- package/dist/types/models/WebResource.d.ts +0 -9
- package/dist/types/models/WebResourceCard.d.ts +0 -7
- package/dist/types/models/WebResourcesQuery.d.ts +0 -3
- package/dist/types/models/WebexConfig.d.ts +0 -10
- package/dist/types/models/WebexWebhook.d.ts +0 -4
- package/dist/types/models/WhatAppWebHook.d.ts +0 -3
- package/dist/types/models/WhatsappConfig.d.ts +0 -11
- package/dist/types/models/WhatsappUserConfig.d.ts +0 -10
- package/dist/types/services/AiAccountService.d.ts +0 -294
- package/dist/types/services/AiAnalyticsService.d.ts +0 -2801
- package/dist/types/services/AiBotService.d.ts +0 -486
- package/dist/types/services/AiFinetuningService.d.ts +0 -162
- package/dist/types/services/AiIndexService.d.ts +0 -400
- package/dist/types/services/AiMarketingService.d.ts +0 -34
- package/dist/types/services/AiMediaService.d.ts +0 -118
- package/dist/types/services/AiMentorService.d.ts +0 -4235
- package/dist/types/services/AiPromptService.d.ts +0 -920
- package/src/models/AIGeneratedImage.ts +0 -18
- package/src/models/AIUserProfileMemoryRelation.ts +0 -9
- package/src/models/AIUserProfileRequest.ts +0 -9
- package/src/models/APITokenCost.ts +0 -19
- package/src/models/AccessEnum.ts +0 -12
- package/src/models/AlignMentorBubbleEnum.ts +0 -12
- package/src/models/AnalyticsOverview.ts +0 -12
- package/src/models/Answer.ts +0 -16
- package/src/models/AssumedKnowledge.ts +0 -9
- package/src/models/AssumedKnowledgeLevel.ts +0 -9
- package/src/models/AudioToTextRequest.ts +0 -8
- package/src/models/AudioToTextResponse.ts +0 -8
- package/src/models/Bot.ts +0 -20
- package/src/models/BotCommand.ts +0 -11
- package/src/models/BotCreate.ts +0 -17
- package/src/models/CallAuthenticationRequest.ts +0 -18
- package/src/models/CallAuthenticationResponse.ts +0 -26
- package/src/models/ChatHistory.ts +0 -13
- package/src/models/ChatHistoryFilterData.ts +0 -14
- package/src/models/ChatHistoryFilterUser.ts +0 -10
- package/src/models/ChatHistoryItem.ts +0 -10
- package/src/models/ChatHistorySessionId.ts +0 -8
- package/src/models/ChatSessionRequest.ts +0 -15
- package/src/models/ChatSessionResponse.ts +0 -10
- package/src/models/CheckDocumentTrainingStatus.ts +0 -15
- package/src/models/ComponentBlock.ts +0 -14
- package/src/models/ComponentBlockTypeEnum.ts +0 -12
- package/src/models/ConversationMessage.ts +0 -16
- package/src/models/ConversationRating.ts +0 -11
- package/src/models/ConversationSummary.ts +0 -10
- package/src/models/ConversationVolume.ts +0 -9
- package/src/models/Conversations.ts +0 -33
- package/src/models/Cost.ts +0 -8
- package/src/models/CostPerTenant.ts +0 -11
- package/src/models/CourseCreationTask.ts +0 -36
- package/src/models/CourseCreationTaskFile.ts +0 -12
- package/src/models/CourseCreationTaskStatusEnum.ts +0 -20
- package/src/models/CredentialRequest.ts +0 -19
- package/src/models/CrontabSchedule.ts +0 -27
- package/src/models/CustomInstructionResponse.ts +0 -18
- package/src/models/DataSet.ts +0 -26
- package/src/models/DataSetCreate.ts +0 -17
- package/src/models/DataSetStatusEnum.ts +0 -16
- package/src/models/DateRange.ts +0 -9
- package/src/models/DiscordConfig.ts +0 -12
- package/src/models/DiscordUserConfig.ts +0 -15
- package/src/models/DiscordWebhook.ts +0 -11
- package/src/models/Document.ts +0 -46
- package/src/models/DocumentFacet.ts +0 -22
- package/src/models/DocumentSearchResponse.ts +0 -40
- package/src/models/DocumentSettingsResponse.ts +0 -8
- package/src/models/EdxCourse.ts +0 -16
- package/src/models/ElevenlabsCustomVoice.ts +0 -9
- package/src/models/ElevenlabsCustomVoiceResponse.ts +0 -13
- package/src/models/EmailPromptDetail.ts +0 -18
- package/src/models/EmailPromptList.ts +0 -16
- package/src/models/EmailPromptSummary.ts +0 -10
- package/src/models/FreeUsageCount.ts +0 -8
- package/src/models/FullCourse.ts +0 -18
- package/src/models/GreetingMethodEnum.ts +0 -12
- package/src/models/GuidedPromptsResponse.ts +0 -8
- package/src/models/HeygenMarketingVideoDetail.ts +0 -13
- package/src/models/HeygenMarketingVideoList.ts +0 -11
- package/src/models/HeygenTemplateRequest.ts +0 -10
- package/src/models/HeygenTemplateResponseSingle.ts +0 -11
- package/src/models/HeygenVideoDetail.ts +0 -13
- package/src/models/HeygenVideoRequest.ts +0 -10
- package/src/models/IBLAIPlatformMeta.ts +0 -8
- package/src/models/IBLAIPlatformMetaRequest.ts +0 -11
- package/src/models/IBLAIPlatformMetaUpdateRequest.ts +0 -15
- package/src/models/InputQuestion.ts +0 -11
- package/src/models/IntegrationCredential.ts +0 -13
- package/src/models/IntialQuestionAnswer.ts +0 -8
- package/src/models/JobRun.ts +0 -16
- package/src/models/KindEnum.ts +0 -14
- package/src/models/LLMCredentialRequest.ts +0 -19
- package/src/models/LLMCredentialResponse.ts +0 -13
- package/src/models/LLMModelForTenant.ts +0 -11
- package/src/models/LLMQuestion.ts +0 -20
- package/src/models/LLMResponse.ts +0 -19
- package/src/models/LLMTracesListResponse.ts +0 -10
- package/src/models/LanguagesView.ts +0 -10
- package/src/models/LinkCourseRequest.ts +0 -8
- package/src/models/LinkCourseResponse.ts +0 -10
- package/src/models/MCPServer.ts +0 -26
- package/src/models/MemoryComponentData.ts +0 -10
- package/src/models/MemoryComponentMemory.ts +0 -9
- package/src/models/MemoryComponentMemoryDetail.ts +0 -13
- package/src/models/MemoryComponentResponse.ts +0 -10
- package/src/models/MemoryProgress.ts +0 -13
- package/src/models/MemoryStatusRequestView.ts +0 -11
- package/src/models/MemoryStatusView.ts +0 -11
- package/src/models/Mentor.ts +0 -85
- package/src/models/MentorAudience.ts +0 -10
- package/src/models/MentorCategory.ts +0 -14
- package/src/models/MentorCategoryCreate.ts +0 -16
- package/src/models/MentorCategoryGroup.ts +0 -16
- package/src/models/MentorCategoryGroupCreate.ts +0 -16
- package/src/models/MentorCreate.ts +0 -84
- package/src/models/MentorCustomVoice.ts +0 -9
- package/src/models/MentorCustomVoiceResponse.ts +0 -9
- package/src/models/MentorData.ts +0 -12
- package/src/models/MentorDetailAnalytics.ts +0 -11
- package/src/models/MentorEval.ts +0 -16
- package/src/models/MentorEvalQuestion.ts +0 -10
- package/src/models/MentorEvalQuestionRequest.ts +0 -9
- package/src/models/MentorEvalReport.ts +0 -15
- package/src/models/MentorEvalRequest.ts +0 -13
- package/src/models/MentorFacet.ts +0 -22
- package/src/models/MentorFork.ts +0 -10
- package/src/models/MentorFromTemplateRequest.ts +0 -9
- package/src/models/MentorFromTemplateWithSettingRequest.ts +0 -50
- package/src/models/MentorMemorySettingsRequest.ts +0 -11
- package/src/models/MentorMemorySettingsResponse.ts +0 -11
- package/src/models/MentorMetadata.ts +0 -10
- package/src/models/MentorScenario.ts +0 -11
- package/src/models/MentorScenarioPrompt.ts +0 -10
- package/src/models/MentorSearchResponse.ts +0 -40
- package/src/models/MentorSession.ts +0 -9
- package/src/models/MentorSettings.ts +0 -61
- package/src/models/MentorSettingsPublic.ts +0 -50
- package/src/models/MentorSettingsRequest.ts +0 -65
- package/src/models/MentorVisibilityEnum.ts +0 -14
- package/src/models/MentorWizard.ts +0 -9
- package/src/models/MessageStatistics.ts +0 -10
- package/src/models/MessageView.ts +0 -15
- package/src/models/MessageViewRequest.ts +0 -12
- package/src/models/MessageViewUpdatResponse.ts +0 -8
- package/src/models/Metadata.ts +0 -10
- package/src/models/MetricChange.ts +0 -9
- package/src/models/ModelCost.ts +0 -9
- package/src/models/ModerationLog.ts +0 -16
- package/src/models/NoChatMessagesFound.ts +0 -8
- package/src/models/NullEnum.ts +0 -7
- package/src/models/PageContent.ts +0 -11
- package/src/models/PaginatedAIGeneratedImageList.ts +0 -12
- package/src/models/PaginatedConversationsList.ts +0 -12
- package/src/models/PaginatedCourseCreationTaskFileList.ts +0 -12
- package/src/models/PaginatedCourseCreationTaskList.ts +0 -12
- package/src/models/PaginatedDataSetList.ts +0 -12
- package/src/models/PaginatedEdxCourseList.ts +0 -12
- package/src/models/PaginatedEmailPromptListList.ts +0 -12
- package/src/models/PaginatedHeygenMarketingVideoListList.ts +0 -12
- package/src/models/PaginatedHeygenTemplateResponseSingleList.ts +0 -12
- package/src/models/PaginatedJobRunList.ts +0 -12
- package/src/models/PaginatedMCPServerList.ts +0 -12
- package/src/models/PaginatedMentorList.ts +0 -12
- package/src/models/PaginatedModerationLogList.ts +0 -12
- package/src/models/PaginatedPeriodicAgentList.ts +0 -12
- package/src/models/PaginatedPeriodicAgentLogList.ts +0 -12
- package/src/models/PaginatedPlayWrightScriptList.ts +0 -12
- package/src/models/PaginatedSectionList.ts +0 -12
- package/src/models/PaginatedSubSectionList.ts +0 -12
- package/src/models/PaginatedTopicStatisticsResponse.ts +0 -12
- package/src/models/PaginatedTrainingList.ts +0 -12
- package/src/models/PaginatedUnitList.ts +0 -12
- package/src/models/PaginatedUserEdxMemoryList.ts +0 -12
- package/src/models/PaginatedVoiceList.ts +0 -12
- package/src/models/PatchedBotCommand.ts +0 -11
- package/src/models/PatchedBotCreate.ts +0 -17
- package/src/models/PatchedConversations.ts +0 -33
- package/src/models/PatchedCourseCreationTaskFile.ts +0 -12
- package/src/models/PatchedCredentialRequest.ts +0 -19
- package/src/models/PatchedDataSet.ts +0 -26
- package/src/models/PatchedDiscordConfig.ts +0 -12
- package/src/models/PatchedDiscordUserConfig.ts +0 -15
- package/src/models/PatchedLLMCredentialRequest.ts +0 -19
- package/src/models/PatchedMCPServer.ts +0 -26
- package/src/models/PatchedMentorCategoryGroupCreate.ts +0 -16
- package/src/models/PatchedMentorCreate.ts +0 -84
- package/src/models/PatchedPeriodicAgentCreate.ts +0 -46
- package/src/models/PatchedPlayWrightScript.ts +0 -17
- package/src/models/PatchedPrompt.ts +0 -27
- package/src/models/PatchedSection.ts +0 -14
- package/src/models/PatchedSlackConfig.ts +0 -13
- package/src/models/PatchedSlackUserConfig.ts +0 -22
- package/src/models/PatchedSubSection.ts +0 -14
- package/src/models/PatchedTeamsConfig.ts +0 -12
- package/src/models/PatchedTrainingCreate.ts +0 -36
- package/src/models/PatchedUnit.ts +0 -16
- package/src/models/PatchedWebexConfig.ts +0 -15
- package/src/models/PatchedWhatsappConfig.ts +0 -16
- package/src/models/PatchedWhatsappUserConfig.ts +0 -15
- package/src/models/PeriodicAgent.ts +0 -47
- package/src/models/PeriodicAgentCreate.ts +0 -46
- package/src/models/PeriodicAgentLog.ts +0 -16
- package/src/models/PeriodicAgentLogStatusEnum.ts +0 -14
- package/src/models/PeriodicTask.ts +0 -26
- package/src/models/PieChartData.ts +0 -10
- package/src/models/PieChartSegment.ts +0 -9
- package/src/models/PinnedMessageCreate.ts +0 -14
- package/src/models/PinnedMessageGet.ts +0 -12
- package/src/models/PinnedMessageRequest.ts +0 -11
- package/src/models/PlayWrightScript.ts +0 -17
- package/src/models/PredictiveAnalyticsRequest.ts +0 -9
- package/src/models/PredictiveAnalyticsResponse.ts +0 -9
- package/src/models/PreviousAgentStatusEnum.ts +0 -16
- package/src/models/Prompt.ts +0 -27
- package/src/models/PromptCategory.ts +0 -12
- package/src/models/PromptFacet.ts +0 -22
- package/src/models/PromptSearchResponse.ts +0 -40
- package/src/models/PromptVisibilityEnum.ts +0 -14
- package/src/models/Provider05cEnum.ts +0 -18
- package/src/models/Provider63aEnum.ts +0 -10
- package/src/models/QuestionCardTag.ts +0 -13
- package/src/models/QuestionRequest.ts +0 -20
- package/src/models/QuestionResponse.ts +0 -15
- package/src/models/RatingEnum.ts +0 -12
- package/src/models/RatingRecord.ts +0 -9
- package/src/models/RecentlyAccessedMentor.ts +0 -13
- package/src/models/RecommendCourseBlock.ts +0 -8
- package/src/models/RecommendCourseResponse.ts +0 -8
- package/src/models/RecommendedCoursesResponse.ts +0 -38
- package/src/models/RelatedText.ts +0 -8
- package/src/models/RequestDataVariable.ts +0 -19
- package/src/models/ResourceScrappedData.ts +0 -18
- package/src/models/ResourceScrappedDataStatusEnum.ts +0 -16
- package/src/models/ResponseDataVariable.ts +0 -19
- package/src/models/RetreiverTrainViewRequest.ts +0 -15
- package/src/models/RetreiverTrainViewResponse.ts +0 -11
- package/src/models/RetrieveTask.ts +0 -8
- package/src/models/RetrieverDocumentEmbedding.ts +0 -22
- package/src/models/RetrieverDocumentEmbeddingRequest.ts +0 -35
- package/src/models/RetrieverRequestSearch.ts +0 -15
- package/src/models/RetrieverRequestSearchDocument.ts +0 -15
- package/src/models/RetrieverResponseSearch.ts +0 -12
- package/src/models/ReuestDataVariableList.ts +0 -9
- package/src/models/RunMentorEval.ts +0 -8
- package/src/models/ScanWebhookRequest.ts +0 -11
- package/src/models/ScanWebhookResponse.ts +0 -8
- package/src/models/Section.ts +0 -14
- package/src/models/SectionWithChildren.ts +0 -16
- package/src/models/SeedMentorsView.ts +0 -8
- package/src/models/SentimentSummary.ts +0 -9
- package/src/models/SessionBrowserScreenshot.ts +0 -13
- package/src/models/SessionDetail.ts +0 -11
- package/src/models/SessionMemoryStorage.ts +0 -11
- package/src/models/ShellLogs.ts +0 -8
- package/src/models/SlackConfig.ts +0 -13
- package/src/models/SlackUserConfig.ts +0 -22
- package/src/models/SlackWebhook.ts +0 -11
- package/src/models/SpacedRepetitionLearningPath.ts +0 -8
- package/src/models/SpacedRepetitionQuestionStats.ts +0 -10
- package/src/models/StarMentor.ts +0 -12
- package/src/models/Status6eeEnum.ts +0 -16
- package/src/models/Step.ts +0 -14
- package/src/models/StepStatusEnum.ts +0 -14
- package/src/models/StudentChatMessage.ts +0 -9
- package/src/models/StylesView.ts +0 -9
- package/src/models/SubSection.ts +0 -14
- package/src/models/SubSectionWithChildren.ts +0 -16
- package/src/models/TagsView.ts +0 -10
- package/src/models/TargetSystemEnum.ts +0 -12
- package/src/models/TaskView.ts +0 -8
- package/src/models/TeamsConfig.ts +0 -12
- package/src/models/TeamsWebhook.ts +0 -22
- package/src/models/TemplateMentor.ts +0 -14
- package/src/models/TenantMentorTraces.ts +0 -11
- package/src/models/ThemeEnum.ts +0 -12
- package/src/models/TonesView.ts +0 -9
- package/src/models/ToolResponse.ts +0 -16
- package/src/models/TopicModel.ts +0 -8
- package/src/models/TopicRecord.ts +0 -9
- package/src/models/TopicStatistics.ts +0 -12
- package/src/models/TopicStatisticsResponse.ts +0 -11
- package/src/models/TopicSummaryView.ts +0 -9
- package/src/models/TrainChatSessionDocumentView.ts +0 -11
- package/src/models/TrainChatSessionDocumentViewRequest.ts +0 -11
- package/src/models/TrainDocumentViewRequest.ts +0 -47
- package/src/models/TrainDocumentViewResponse.ts +0 -20
- package/src/models/Training.ts +0 -46
- package/src/models/TrainingCreate.ts +0 -36
- package/src/models/TrainingStatusEnum.ts +0 -16
- package/src/models/TransportEnum.ts +0 -12
- package/src/models/TrendEntry.ts +0 -9
- package/src/models/TriggerRequest.ts +0 -10
- package/src/models/TriggerResponse.ts +0 -11
- package/src/models/TypeC42Enum.ts +0 -12
- package/src/models/Unit.ts +0 -16
- package/src/models/UnitWithChildren.ts +0 -18
- package/src/models/UseMainCreds.ts +0 -8
- package/src/models/UserAllChatMemoryView.ts +0 -12
- package/src/models/UserCatalogItemMemoryView.ts +0 -19
- package/src/models/UserChatByPeriod.ts +0 -9
- package/src/models/UserChatFeedback.ts +0 -19
- package/src/models/UserChatFeedbackCount.ts +0 -9
- package/src/models/UserChatMemoryStatusRequestView.ts +0 -11
- package/src/models/UserChatMemoryStatusView.ts +0 -11
- package/src/models/UserChatMemoryUpdateView.ts +0 -15
- package/src/models/UserCountRecord.ts +0 -9
- package/src/models/UserEdxMemory.ts +0 -20
- package/src/models/UserMemoryContextRequest.ts +0 -18
- package/src/models/UserMemoryContextResponse.ts +0 -17
- package/src/models/UserMetric.ts +0 -9
- package/src/models/UserMetricsResponse.ts +0 -12
- package/src/models/UserSentimentCountView.ts +0 -9
- package/src/models/UserTrendByPeriod.ts +0 -10
- package/src/models/VectorResult.ts +0 -13
- package/src/models/VideoCaption.ts +0 -8
- package/src/models/Voice.ts +0 -14
- package/src/models/VoiceProviderEnum.ts +0 -14
- package/src/models/WebResource.ts +0 -14
- package/src/models/WebResourceCard.ts +0 -12
- package/src/models/WebResourcesQuery.ts +0 -8
- package/src/models/WebexConfig.ts +0 -15
- package/src/models/WebexWebhook.ts +0 -9
- package/src/models/WhatAppWebHook.ts +0 -8
- package/src/models/WhatsappConfig.ts +0 -16
- package/src/models/WhatsappUserConfig.ts +0 -15
- package/src/services/AiAccountService.ts +0 -479
- package/src/services/AiAnalyticsService.ts +0 -5198
- package/src/services/AiBotService.ts +0 -1174
- package/src/services/AiFinetuningService.ts +0 -402
- package/src/services/AiIndexService.ts +0 -693
- package/src/services/AiMarketingService.ts +0 -87
- package/src/services/AiMediaService.ts +0 -273
- package/src/services/AiMentorService.ts +0 -7977
- package/src/services/AiPromptService.ts +0 -1771
|
@@ -1,4235 +0,0 @@
|
|
|
1
|
-
import type { AIGeneratedImage } from '../models/AIGeneratedImage';
|
|
2
|
-
import type { AIUserProfileMemoryRelation } from '../models/AIUserProfileMemoryRelation';
|
|
3
|
-
import type { AIUserProfileRequest } from '../models/AIUserProfileRequest';
|
|
4
|
-
import type { AssumedKnowledge } from '../models/AssumedKnowledge';
|
|
5
|
-
import type { AudioToTextRequest } from '../models/AudioToTextRequest';
|
|
6
|
-
import type { AudioToTextResponse } from '../models/AudioToTextResponse';
|
|
7
|
-
import type { CallAuthenticationRequest } from '../models/CallAuthenticationRequest';
|
|
8
|
-
import type { CallAuthenticationResponse } from '../models/CallAuthenticationResponse';
|
|
9
|
-
import type { ChatHistoryItem } from '../models/ChatHistoryItem';
|
|
10
|
-
import type { ChatHistorySessionId } from '../models/ChatHistorySessionId';
|
|
11
|
-
import type { ChatSessionRequest } from '../models/ChatSessionRequest';
|
|
12
|
-
import type { ChatSessionResponse } from '../models/ChatSessionResponse';
|
|
13
|
-
import type { CourseCreationTask } from '../models/CourseCreationTask';
|
|
14
|
-
import type { CourseCreationTaskFile } from '../models/CourseCreationTaskFile';
|
|
15
|
-
import type { CustomInstructionResponse } from '../models/CustomInstructionResponse';
|
|
16
|
-
import type { EdxCourse } from '../models/EdxCourse';
|
|
17
|
-
import type { ElevenlabsCustomVoice } from '../models/ElevenlabsCustomVoice';
|
|
18
|
-
import type { ElevenlabsCustomVoiceResponse } from '../models/ElevenlabsCustomVoiceResponse';
|
|
19
|
-
import type { EmailPromptDetail } from '../models/EmailPromptDetail';
|
|
20
|
-
import type { EmailPromptSummary } from '../models/EmailPromptSummary';
|
|
21
|
-
import type { FreeUsageCount } from '../models/FreeUsageCount';
|
|
22
|
-
import type { FullCourse } from '../models/FullCourse';
|
|
23
|
-
import type { JobRun } from '../models/JobRun';
|
|
24
|
-
import type { LinkCourseRequest } from '../models/LinkCourseRequest';
|
|
25
|
-
import type { LinkCourseResponse } from '../models/LinkCourseResponse';
|
|
26
|
-
import type { LLMModelForTenant } from '../models/LLMModelForTenant';
|
|
27
|
-
import type { LLMResponse } from '../models/LLMResponse';
|
|
28
|
-
import type { MCPServer } from '../models/MCPServer';
|
|
29
|
-
import type { MemoryComponentMemoryDetail } from '../models/MemoryComponentMemoryDetail';
|
|
30
|
-
import type { MemoryComponentResponse } from '../models/MemoryComponentResponse';
|
|
31
|
-
import type { MemoryProgress } from '../models/MemoryProgress';
|
|
32
|
-
import type { Mentor } from '../models/Mentor';
|
|
33
|
-
import type { MentorAudience } from '../models/MentorAudience';
|
|
34
|
-
import type { MentorCategory } from '../models/MentorCategory';
|
|
35
|
-
import type { MentorCategoryCreate } from '../models/MentorCategoryCreate';
|
|
36
|
-
import type { MentorCategoryGroup } from '../models/MentorCategoryGroup';
|
|
37
|
-
import type { MentorCategoryGroupCreate } from '../models/MentorCategoryGroupCreate';
|
|
38
|
-
import type { MentorCreate } from '../models/MentorCreate';
|
|
39
|
-
import type { MentorCustomVoice } from '../models/MentorCustomVoice';
|
|
40
|
-
import type { MentorCustomVoiceResponse } from '../models/MentorCustomVoiceResponse';
|
|
41
|
-
import type { MentorEval } from '../models/MentorEval';
|
|
42
|
-
import type { MentorEvalReport } from '../models/MentorEvalReport';
|
|
43
|
-
import type { MentorEvalRequest } from '../models/MentorEvalRequest';
|
|
44
|
-
import type { MentorFork } from '../models/MentorFork';
|
|
45
|
-
import type { MentorFromTemplateRequest } from '../models/MentorFromTemplateRequest';
|
|
46
|
-
import type { MentorFromTemplateWithSettingRequest } from '../models/MentorFromTemplateWithSettingRequest';
|
|
47
|
-
import type { MentorMemorySettingsRequest } from '../models/MentorMemorySettingsRequest';
|
|
48
|
-
import type { MentorMemorySettingsResponse } from '../models/MentorMemorySettingsResponse';
|
|
49
|
-
import type { MentorMetadata } from '../models/MentorMetadata';
|
|
50
|
-
import type { MentorScenario } from '../models/MentorScenario';
|
|
51
|
-
import type { MentorSettings } from '../models/MentorSettings';
|
|
52
|
-
import type { MentorSettingsPublic } from '../models/MentorSettingsPublic';
|
|
53
|
-
import type { MentorSettingsRequest } from '../models/MentorSettingsRequest';
|
|
54
|
-
import type { MentorWizard } from '../models/MentorWizard';
|
|
55
|
-
import type { MessageView } from '../models/MessageView';
|
|
56
|
-
import type { MessageViewRequest } from '../models/MessageViewRequest';
|
|
57
|
-
import type { MessageViewUpdatResponse } from '../models/MessageViewUpdatResponse';
|
|
58
|
-
import type { ModerationLog } from '../models/ModerationLog';
|
|
59
|
-
import type { PaginatedAIGeneratedImageList } from '../models/PaginatedAIGeneratedImageList';
|
|
60
|
-
import type { PaginatedCourseCreationTaskFileList } from '../models/PaginatedCourseCreationTaskFileList';
|
|
61
|
-
import type { PaginatedCourseCreationTaskList } from '../models/PaginatedCourseCreationTaskList';
|
|
62
|
-
import type { PaginatedEdxCourseList } from '../models/PaginatedEdxCourseList';
|
|
63
|
-
import type { PaginatedEmailPromptListList } from '../models/PaginatedEmailPromptListList';
|
|
64
|
-
import type { PaginatedJobRunList } from '../models/PaginatedJobRunList';
|
|
65
|
-
import type { PaginatedMCPServerList } from '../models/PaginatedMCPServerList';
|
|
66
|
-
import type { PaginatedMentorList } from '../models/PaginatedMentorList';
|
|
67
|
-
import type { PaginatedModerationLogList } from '../models/PaginatedModerationLogList';
|
|
68
|
-
import type { PaginatedPeriodicAgentList } from '../models/PaginatedPeriodicAgentList';
|
|
69
|
-
import type { PaginatedPeriodicAgentLogList } from '../models/PaginatedPeriodicAgentLogList';
|
|
70
|
-
import type { PaginatedPlayWrightScriptList } from '../models/PaginatedPlayWrightScriptList';
|
|
71
|
-
import type { PaginatedSectionList } from '../models/PaginatedSectionList';
|
|
72
|
-
import type { PaginatedSubSectionList } from '../models/PaginatedSubSectionList';
|
|
73
|
-
import type { PaginatedUnitList } from '../models/PaginatedUnitList';
|
|
74
|
-
import type { PaginatedUserEdxMemoryList } from '../models/PaginatedUserEdxMemoryList';
|
|
75
|
-
import type { PaginatedVoiceList } from '../models/PaginatedVoiceList';
|
|
76
|
-
import type { PatchedCourseCreationTaskFile } from '../models/PatchedCourseCreationTaskFile';
|
|
77
|
-
import type { PatchedMCPServer } from '../models/PatchedMCPServer';
|
|
78
|
-
import type { PatchedMentorCategoryGroupCreate } from '../models/PatchedMentorCategoryGroupCreate';
|
|
79
|
-
import type { PatchedMentorCreate } from '../models/PatchedMentorCreate';
|
|
80
|
-
import type { PatchedPeriodicAgentCreate } from '../models/PatchedPeriodicAgentCreate';
|
|
81
|
-
import type { PatchedPlayWrightScript } from '../models/PatchedPlayWrightScript';
|
|
82
|
-
import type { PatchedSection } from '../models/PatchedSection';
|
|
83
|
-
import type { PatchedSubSection } from '../models/PatchedSubSection';
|
|
84
|
-
import type { PatchedUnit } from '../models/PatchedUnit';
|
|
85
|
-
import type { PeriodicAgent } from '../models/PeriodicAgent';
|
|
86
|
-
import type { PeriodicAgentCreate } from '../models/PeriodicAgentCreate';
|
|
87
|
-
import type { PeriodicAgentLog } from '../models/PeriodicAgentLog';
|
|
88
|
-
import type { PinnedMessageCreate } from '../models/PinnedMessageCreate';
|
|
89
|
-
import type { PinnedMessageGet } from '../models/PinnedMessageGet';
|
|
90
|
-
import type { PinnedMessageRequest } from '../models/PinnedMessageRequest';
|
|
91
|
-
import type { PlayWrightScript } from '../models/PlayWrightScript';
|
|
92
|
-
import type { PredictiveAnalyticsRequest } from '../models/PredictiveAnalyticsRequest';
|
|
93
|
-
import type { PredictiveAnalyticsResponse } from '../models/PredictiveAnalyticsResponse';
|
|
94
|
-
import type { QuestionCardTag } from '../models/QuestionCardTag';
|
|
95
|
-
import type { QuestionRequest } from '../models/QuestionRequest';
|
|
96
|
-
import type { QuestionResponse } from '../models/QuestionResponse';
|
|
97
|
-
import type { RecentlyAccessedMentor } from '../models/RecentlyAccessedMentor';
|
|
98
|
-
import type { RecommendCourseBlock } from '../models/RecommendCourseBlock';
|
|
99
|
-
import type { RecommendCourseResponse } from '../models/RecommendCourseResponse';
|
|
100
|
-
import type { RelatedText } from '../models/RelatedText';
|
|
101
|
-
import type { RetrieveTask } from '../models/RetrieveTask';
|
|
102
|
-
import type { RunMentorEval } from '../models/RunMentorEval';
|
|
103
|
-
import type { Section } from '../models/Section';
|
|
104
|
-
import type { SeedMentorsView } from '../models/SeedMentorsView';
|
|
105
|
-
import type { SessionBrowserScreenshot } from '../models/SessionBrowserScreenshot';
|
|
106
|
-
import type { SessionDetail } from '../models/SessionDetail';
|
|
107
|
-
import type { SessionMemoryStorage } from '../models/SessionMemoryStorage';
|
|
108
|
-
import type { ShellLogs } from '../models/ShellLogs';
|
|
109
|
-
import type { SpacedRepetitionLearningPath } from '../models/SpacedRepetitionLearningPath';
|
|
110
|
-
import type { SpacedRepetitionQuestionStats } from '../models/SpacedRepetitionQuestionStats';
|
|
111
|
-
import type { StarMentor } from '../models/StarMentor';
|
|
112
|
-
import type { SubSection } from '../models/SubSection';
|
|
113
|
-
import type { TaskView } from '../models/TaskView';
|
|
114
|
-
import type { TemplateMentor } from '../models/TemplateMentor';
|
|
115
|
-
import type { ToolResponse } from '../models/ToolResponse';
|
|
116
|
-
import type { TriggerRequest } from '../models/TriggerRequest';
|
|
117
|
-
import type { TriggerResponse } from '../models/TriggerResponse';
|
|
118
|
-
import type { Unit } from '../models/Unit';
|
|
119
|
-
import type { UserChatFeedback } from '../models/UserChatFeedback';
|
|
120
|
-
import type { UserEdxMemory } from '../models/UserEdxMemory';
|
|
121
|
-
import type { VectorResult } from '../models/VectorResult';
|
|
122
|
-
import type { Voice } from '../models/Voice';
|
|
123
|
-
import type { WebResource } from '../models/WebResource';
|
|
124
|
-
import type { WebResourcesQuery } from '../models/WebResourcesQuery';
|
|
125
|
-
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
126
|
-
export declare class AiMentorService {
|
|
127
|
-
/**
|
|
128
|
-
* List all triggers for an organization.
|
|
129
|
-
*
|
|
130
|
-
* Args:
|
|
131
|
-
* request: The HTTP request.
|
|
132
|
-
* org: The organization/tenant identifier.
|
|
133
|
-
*
|
|
134
|
-
* Returns:
|
|
135
|
-
* Response: A list of trigger slugs for the organization.
|
|
136
|
-
*
|
|
137
|
-
* Raises:
|
|
138
|
-
* BadRequest: If the request is invalid.
|
|
139
|
-
* @param org
|
|
140
|
-
* @returns any List of trigger slugs
|
|
141
|
-
* @throws ApiError
|
|
142
|
-
*/
|
|
143
|
-
static aiMentorOrgsAllTriggersRetrieve(org: string): CancelablePromise<any>;
|
|
144
|
-
/**
|
|
145
|
-
* Retrieve a list of emails in a mentor's inbox.
|
|
146
|
-
*
|
|
147
|
-
* The list can be filtered using the 'search' query parameter to search
|
|
148
|
-
* for specific terms in the email content or subject.
|
|
149
|
-
*
|
|
150
|
-
* Args:
|
|
151
|
-
* mentor: The unique identifier of the mentor.
|
|
152
|
-
*
|
|
153
|
-
* Returns:
|
|
154
|
-
* Response: A paginated list of emails in the mentor's inbox.
|
|
155
|
-
*
|
|
156
|
-
* Raises:
|
|
157
|
-
* NotFound: If the specified mentor does not exist.
|
|
158
|
-
* @param mentor
|
|
159
|
-
* @param org
|
|
160
|
-
* @param page A page number within the paginated result set.
|
|
161
|
-
* @param pageSize Number of results to return per page.
|
|
162
|
-
* @param search Search term to filter emails by content or subject
|
|
163
|
-
* @returns PaginatedEmailPromptListList
|
|
164
|
-
* @throws ApiError
|
|
165
|
-
*/
|
|
166
|
-
static aiMentorOrgsMentorsEmailInboxList(mentor: string, org: string, page?: number, pageSize?: number, search?: string): CancelablePromise<PaginatedEmailPromptListList>;
|
|
167
|
-
/**
|
|
168
|
-
* Retrieve a summary of a mentor's email inbox.
|
|
169
|
-
*
|
|
170
|
-
* Args:
|
|
171
|
-
* request: The HTTP request.
|
|
172
|
-
* mentor: The unique identifier of the mentor.
|
|
173
|
-
*
|
|
174
|
-
* Returns:
|
|
175
|
-
* Response: A summary of the mentor's email inbox statistics.
|
|
176
|
-
*
|
|
177
|
-
* Raises:
|
|
178
|
-
* NotFound: If the specified mentor does not exist.
|
|
179
|
-
* @param mentor
|
|
180
|
-
* @param org
|
|
181
|
-
* @returns EmailPromptSummary
|
|
182
|
-
* @throws ApiError
|
|
183
|
-
*/
|
|
184
|
-
static aiMentorOrgsMentorsEmailInboxSummaryRetrieve(mentor: string, org: string): CancelablePromise<EmailPromptSummary>;
|
|
185
|
-
/**
|
|
186
|
-
* Retrieve details of a specific email in a mentor's inbox.
|
|
187
|
-
*
|
|
188
|
-
* Args:
|
|
189
|
-
* request: The HTTP request.
|
|
190
|
-
* email_prompt_id: The ID of the email to retrieve.
|
|
191
|
-
*
|
|
192
|
-
* Returns:
|
|
193
|
-
* Response: The detailed information about the email.
|
|
194
|
-
*
|
|
195
|
-
* Raises:
|
|
196
|
-
* NotFound: If the specified email does not exist.
|
|
197
|
-
* @param emailPromptId
|
|
198
|
-
* @param mentor
|
|
199
|
-
* @param org
|
|
200
|
-
* @returns EmailPromptDetail
|
|
201
|
-
* @throws ApiError
|
|
202
|
-
*/
|
|
203
|
-
static aiMentorOrgsMentorsEmailInboxRetrieve(emailPromptId: number, mentor: string, org: string): CancelablePromise<EmailPromptDetail>;
|
|
204
|
-
/**
|
|
205
|
-
* API endpoint to link mentor with a course and enable guided mode.
|
|
206
|
-
*
|
|
207
|
-
* Permissions:
|
|
208
|
-
* - Accessible to tenant admins.
|
|
209
|
-
* @param mentor
|
|
210
|
-
* @param org
|
|
211
|
-
* @returns LinkCourseResponse
|
|
212
|
-
* @throws ApiError
|
|
213
|
-
*/
|
|
214
|
-
static aiMentorOrgsMentorsLinkCourseRetrieve(mentor: string, org: string): CancelablePromise<LinkCourseResponse>;
|
|
215
|
-
/**
|
|
216
|
-
* API endpoint to link mentor with a course and enable guided mode.
|
|
217
|
-
*
|
|
218
|
-
* Permissions:
|
|
219
|
-
* - Accessible to tenant admins.
|
|
220
|
-
* @param mentor
|
|
221
|
-
* @param org
|
|
222
|
-
* @param requestBody
|
|
223
|
-
* @returns LinkCourseResponse
|
|
224
|
-
* @throws ApiError
|
|
225
|
-
*/
|
|
226
|
-
static aiMentorOrgsMentorsLinkCourseCreate(mentor: string, org: string, requestBody: LinkCourseRequest): CancelablePromise<LinkCourseResponse>;
|
|
227
|
-
/**
|
|
228
|
-
* Create or update metadata for a mentor.
|
|
229
|
-
*
|
|
230
|
-
* Args:
|
|
231
|
-
* request: The HTTP request containing the metadata.
|
|
232
|
-
* org: The organization/tenant identifier.
|
|
233
|
-
*
|
|
234
|
-
* Returns:
|
|
235
|
-
* Response: The created or updated mentor metadata.
|
|
236
|
-
*
|
|
237
|
-
* Raises:
|
|
238
|
-
* BadRequest: If the provided data is invalid.
|
|
239
|
-
* @param org
|
|
240
|
-
* @param requestBody
|
|
241
|
-
* @returns MentorMetadata
|
|
242
|
-
* @throws ApiError
|
|
243
|
-
*/
|
|
244
|
-
static aiMentorOrgsMetadataCreate(org: string, requestBody: MentorMetadata): CancelablePromise<MentorMetadata>;
|
|
245
|
-
/**
|
|
246
|
-
* Retrieve existing questions.
|
|
247
|
-
*
|
|
248
|
-
* Args:
|
|
249
|
-
* request: The HTTP request.
|
|
250
|
-
*
|
|
251
|
-
* Returns:
|
|
252
|
-
* Response: The existing questions.
|
|
253
|
-
* @param org
|
|
254
|
-
* @returns any No response body
|
|
255
|
-
* @throws ApiError
|
|
256
|
-
*/
|
|
257
|
-
static aiMentorOrgsQuizCustomizerRetrieve(org: string): CancelablePromise<any>;
|
|
258
|
-
/**
|
|
259
|
-
* Generate follow-up questions based on initial questions.
|
|
260
|
-
*
|
|
261
|
-
* Args:
|
|
262
|
-
* request: The HTTP request containing the initial questions.
|
|
263
|
-
*
|
|
264
|
-
* Returns:
|
|
265
|
-
* Response: The generated follow-up questions.
|
|
266
|
-
*
|
|
267
|
-
* Raises:
|
|
268
|
-
* BadRequest: If the provided data is invalid.
|
|
269
|
-
* @param org
|
|
270
|
-
* @param requestBody
|
|
271
|
-
* @returns QuestionResponse
|
|
272
|
-
* @throws ApiError
|
|
273
|
-
*/
|
|
274
|
-
static aiMentorOrgsQuizCustomizerCreate(org: string, requestBody: QuestionRequest): CancelablePromise<QuestionResponse>;
|
|
275
|
-
/**
|
|
276
|
-
* Retrieve or create a chat session with a mentor.
|
|
277
|
-
*
|
|
278
|
-
* Passing `null` as `tools` results in using all tools assigned to the mentor.
|
|
279
|
-
* To specify that no tools be used, pass an empty list.
|
|
280
|
-
*
|
|
281
|
-
* Args:
|
|
282
|
-
* request: HTTP request containing mentor details.
|
|
283
|
-
* org: Organization key identifier.
|
|
284
|
-
* user_id (optional): Username for authentication (if required by the mentor).
|
|
285
|
-
*
|
|
286
|
-
* Returns:
|
|
287
|
-
* Response: JSON object containing the session ID.
|
|
288
|
-
*
|
|
289
|
-
* Raises:
|
|
290
|
-
* Http404: If the mentor is not found.
|
|
291
|
-
* ValidationError: If the username is invalid.
|
|
292
|
-
* ValidationError: If one or more tool slugs are invalid.
|
|
293
|
-
* @param org
|
|
294
|
-
* @param requestBody
|
|
295
|
-
* @returns ChatSessionResponse
|
|
296
|
-
* @throws ApiError
|
|
297
|
-
*/
|
|
298
|
-
static aiMentorOrgsSessionsCreate(org: string, requestBody: ChatSessionRequest): CancelablePromise<ChatSessionResponse>;
|
|
299
|
-
/**
|
|
300
|
-
* Create or modify a trigger.
|
|
301
|
-
*
|
|
302
|
-
* Args:
|
|
303
|
-
* request: The HTTP request containing the trigger data.
|
|
304
|
-
* org: The organization/tenant identifier.
|
|
305
|
-
*
|
|
306
|
-
* Returns:
|
|
307
|
-
* Response: The created or updated trigger details.
|
|
308
|
-
*
|
|
309
|
-
* Raises:
|
|
310
|
-
* BadRequest: If the provided data is invalid or missing required parameters.
|
|
311
|
-
* @param org
|
|
312
|
-
* @param requestBody
|
|
313
|
-
* @returns TriggerResponse
|
|
314
|
-
* @throws ApiError
|
|
315
|
-
*/
|
|
316
|
-
static aiMentorOrgsTriggerCreate(org: string, requestBody: TriggerRequest): CancelablePromise<TriggerResponse>;
|
|
317
|
-
/**
|
|
318
|
-
* Retrieve available trigger templates.
|
|
319
|
-
*
|
|
320
|
-
* Args:
|
|
321
|
-
* request: The HTTP request.
|
|
322
|
-
* org: The organization/tenant identifier.
|
|
323
|
-
*
|
|
324
|
-
* Returns:
|
|
325
|
-
* Response: A dictionary of available trigger templates and their required parameters.
|
|
326
|
-
*
|
|
327
|
-
* Raises:
|
|
328
|
-
* BadRequest: If the request is invalid.
|
|
329
|
-
* @param org
|
|
330
|
-
* @returns any Dictionary of trigger templates and their required parameters
|
|
331
|
-
* @throws ApiError
|
|
332
|
-
*/
|
|
333
|
-
static aiMentorOrgsTriggerTemplatesRetrieve(org: string): CancelablePromise<any>;
|
|
334
|
-
/**
|
|
335
|
-
* Retrieve details of a specific trigger.
|
|
336
|
-
*
|
|
337
|
-
* Args:
|
|
338
|
-
* request: The HTTP request.
|
|
339
|
-
* org: The organization/tenant identifier.
|
|
340
|
-
* slug: The unique slug identifier of the trigger.
|
|
341
|
-
*
|
|
342
|
-
* Returns:
|
|
343
|
-
* Response: The details of the specified trigger.
|
|
344
|
-
*
|
|
345
|
-
* Raises:
|
|
346
|
-
* Http404: If the specified trigger does not exist.
|
|
347
|
-
* @param org
|
|
348
|
-
* @param slug
|
|
349
|
-
* @returns TriggerResponse
|
|
350
|
-
* @throws ApiError
|
|
351
|
-
*/
|
|
352
|
-
static aiMentorOrgsTriggerRetrieve(org: string, slug: string): CancelablePromise<TriggerResponse>;
|
|
353
|
-
/**
|
|
354
|
-
* Delete a specific trigger.
|
|
355
|
-
*
|
|
356
|
-
* Args:
|
|
357
|
-
* request: The HTTP request.
|
|
358
|
-
* org: The organization/tenant identifier.
|
|
359
|
-
* slug: The unique slug identifier of the trigger to delete.
|
|
360
|
-
*
|
|
361
|
-
* Returns:
|
|
362
|
-
* Response: A confirmation of the deletion status.
|
|
363
|
-
*
|
|
364
|
-
* Raises:
|
|
365
|
-
* BadRequest: If the specified trigger does not exist.
|
|
366
|
-
* @param org
|
|
367
|
-
* @param slug
|
|
368
|
-
* @returns any Trigger successfully deleted
|
|
369
|
-
* @throws ApiError
|
|
370
|
-
*/
|
|
371
|
-
static aiMentorOrgsTriggerDeletionCreate(org: string, slug: string): CancelablePromise<any>;
|
|
372
|
-
/**
|
|
373
|
-
* Retrieve a list of mentors.
|
|
374
|
-
*
|
|
375
|
-
* Returns:
|
|
376
|
-
* - List of mentors matching the filters.
|
|
377
|
-
* @param org
|
|
378
|
-
* @param userId
|
|
379
|
-
* @param departmentId Department to filter by
|
|
380
|
-
* @param filterBy Filter options include, date, name, default is date
|
|
381
|
-
* @param metadataKey Metadata key to be queried with
|
|
382
|
-
* @param metadataValue Metadata value to be filter for
|
|
383
|
-
* @param page A page number within the paginated result set.
|
|
384
|
-
* @param pageSize Number of results to return per page.
|
|
385
|
-
* @param returnSessionInformation Declares if session information should be included in the mentor data
|
|
386
|
-
* @param visibility visibility type to be queried with
|
|
387
|
-
* @returns PaginatedMentorList
|
|
388
|
-
* @throws ApiError
|
|
389
|
-
*/
|
|
390
|
-
static aiMentorOrgsUsersList(org: string, userId: string, departmentId?: number, filterBy?: string, metadataKey?: string, metadataValue?: string, page?: number, pageSize?: number, returnSessionInformation?: boolean, visibility?: string): CancelablePromise<PaginatedMentorList>;
|
|
391
|
-
/**
|
|
392
|
-
* Create a new mentor.
|
|
393
|
-
*
|
|
394
|
-
* Body Parameters:
|
|
395
|
-
* - name: Mentor name.
|
|
396
|
-
* - unique_id: Unique identifier.
|
|
397
|
-
* - platform_key: Associated platform.
|
|
398
|
-
* - metadata: Additional mentor attributes.
|
|
399
|
-
* @param org
|
|
400
|
-
* @param userId
|
|
401
|
-
* @param requestBody
|
|
402
|
-
* @param departmentId Department to filter by
|
|
403
|
-
* @param filterBy Filter options include, date, name, default is date
|
|
404
|
-
* @param metadataKey Metadata key to be queried with
|
|
405
|
-
* @param metadataValue Metadata value to be filter for
|
|
406
|
-
* @param returnSessionInformation Declares if session information should be included in the mentor data
|
|
407
|
-
* @param visibility visibility type to be queried with
|
|
408
|
-
* @returns Mentor
|
|
409
|
-
* @throws ApiError
|
|
410
|
-
*/
|
|
411
|
-
static aiMentorOrgsUsersCreate(org: string, userId: string, requestBody: MentorCreate, departmentId?: number, filterBy?: string, metadataKey?: string, metadataValue?: string, returnSessionInformation?: boolean, visibility?: string): CancelablePromise<Mentor>;
|
|
412
|
-
/**
|
|
413
|
-
* API ViewSet for managing mentors.
|
|
414
|
-
*
|
|
415
|
-
* Provides endpoints to retrieve, create, update, and delete mentor data.
|
|
416
|
-
*
|
|
417
|
-
* Permissions:
|
|
418
|
-
* - Accessible to both tenant admins and students.
|
|
419
|
-
* @param name
|
|
420
|
-
* @param org
|
|
421
|
-
* @param userId
|
|
422
|
-
* @param departmentId Department to filter by
|
|
423
|
-
* @param filterBy Filter options include, date, name, default is date
|
|
424
|
-
* @param metadataKey Metadata key to be queried with
|
|
425
|
-
* @param metadataValue Metadata value to be filter for
|
|
426
|
-
* @param returnSessionInformation Declares if session information should be included in the mentor data
|
|
427
|
-
* @param visibility visibility type to be queried with
|
|
428
|
-
* @returns Mentor
|
|
429
|
-
* @throws ApiError
|
|
430
|
-
*/
|
|
431
|
-
static aiMentorOrgsUsersRetrieve(name: string, org: string, userId: string, departmentId?: number, filterBy?: string, metadataKey?: string, metadataValue?: string, returnSessionInformation?: boolean, visibility?: string): CancelablePromise<Mentor>;
|
|
432
|
-
/**
|
|
433
|
-
* Update a mentor's details.
|
|
434
|
-
* @param name
|
|
435
|
-
* @param org
|
|
436
|
-
* @param userId
|
|
437
|
-
* @param requestBody
|
|
438
|
-
* @param departmentId Department to filter by
|
|
439
|
-
* @param filterBy Filter options include, date, name, default is date
|
|
440
|
-
* @param metadataKey Metadata key to be queried with
|
|
441
|
-
* @param metadataValue Metadata value to be filter for
|
|
442
|
-
* @param returnSessionInformation Declares if session information should be included in the mentor data
|
|
443
|
-
* @param visibility visibility type to be queried with
|
|
444
|
-
* @returns Mentor
|
|
445
|
-
* @throws ApiError
|
|
446
|
-
*/
|
|
447
|
-
static aiMentorOrgsUsersUpdate(name: string, org: string, userId: string, requestBody: MentorCreate, departmentId?: number, filterBy?: string, metadataKey?: string, metadataValue?: string, returnSessionInformation?: boolean, visibility?: string): CancelablePromise<Mentor>;
|
|
448
|
-
/**
|
|
449
|
-
* API ViewSet for managing mentors.
|
|
450
|
-
*
|
|
451
|
-
* Provides endpoints to retrieve, create, update, and delete mentor data.
|
|
452
|
-
*
|
|
453
|
-
* Permissions:
|
|
454
|
-
* - Accessible to both tenant admins and students.
|
|
455
|
-
* @param name
|
|
456
|
-
* @param org
|
|
457
|
-
* @param userId
|
|
458
|
-
* @param departmentId Department to filter by
|
|
459
|
-
* @param filterBy Filter options include, date, name, default is date
|
|
460
|
-
* @param metadataKey Metadata key to be queried with
|
|
461
|
-
* @param metadataValue Metadata value to be filter for
|
|
462
|
-
* @param returnSessionInformation Declares if session information should be included in the mentor data
|
|
463
|
-
* @param visibility visibility type to be queried with
|
|
464
|
-
* @param requestBody
|
|
465
|
-
* @returns MentorCreate
|
|
466
|
-
* @throws ApiError
|
|
467
|
-
*/
|
|
468
|
-
static aiMentorOrgsUsersPartialUpdate(name: string, org: string, userId: string, departmentId?: number, filterBy?: string, metadataKey?: string, metadataValue?: string, returnSessionInformation?: boolean, visibility?: string, requestBody?: PatchedMentorCreate): CancelablePromise<MentorCreate>;
|
|
469
|
-
/**
|
|
470
|
-
* Soft delete a mentor.
|
|
471
|
-
* @param name
|
|
472
|
-
* @param org
|
|
473
|
-
* @param userId
|
|
474
|
-
* @param departmentId Department to filter by
|
|
475
|
-
* @param filterBy Filter options include, date, name, default is date
|
|
476
|
-
* @param metadataKey Metadata key to be queried with
|
|
477
|
-
* @param metadataValue Metadata value to be filter for
|
|
478
|
-
* @param returnSessionInformation Declares if session information should be included in the mentor data
|
|
479
|
-
* @param visibility visibility type to be queried with
|
|
480
|
-
* @returns void
|
|
481
|
-
* @throws ApiError
|
|
482
|
-
*/
|
|
483
|
-
static aiMentorOrgsUsersDestroy(name: string, org: string, userId: string, departmentId?: number, filterBy?: string, metadataKey?: string, metadataValue?: string, returnSessionInformation?: boolean, visibility?: string): CancelablePromise<void>;
|
|
484
|
-
/**
|
|
485
|
-
* Endpoint to view and delete AI generated images for a user.
|
|
486
|
-
*
|
|
487
|
-
* AI Generated images are images generated during chat with AI. They are cached to allow retrieval and deletion.
|
|
488
|
-
*
|
|
489
|
-
* optional filtering parameters allowed are
|
|
490
|
-
* - username: The username of the user for which this image was stored.
|
|
491
|
-
* - provider: The provider used to generate the image. eg. openai, nvidia (nim), replicate.
|
|
492
|
-
* - model: the text to image model on the provider used to generate the image.
|
|
493
|
-
*
|
|
494
|
-
* This endpoint is accessible to both students and platform admins.
|
|
495
|
-
* @param org
|
|
496
|
-
* @param userId
|
|
497
|
-
* @param model
|
|
498
|
-
* @param ordering Which field to use when ordering the results.
|
|
499
|
-
* @param page A page number within the paginated result set.
|
|
500
|
-
* @param pageSize Number of results to return per page.
|
|
501
|
-
* @param provider
|
|
502
|
-
* @param search A search term.
|
|
503
|
-
* @param username
|
|
504
|
-
* @returns PaginatedAIGeneratedImageList
|
|
505
|
-
* @throws ApiError
|
|
506
|
-
*/
|
|
507
|
-
static aiMentorOrgsUsersAiGeneratedImagesList(org: string, userId: string, model?: string, ordering?: string, page?: number, pageSize?: number, provider?: string, search?: string, username?: string): CancelablePromise<PaginatedAIGeneratedImageList>;
|
|
508
|
-
/**
|
|
509
|
-
* Endpoint to view and delete AI generated images for a user.
|
|
510
|
-
*
|
|
511
|
-
* AI Generated images are images generated during chat with AI. They are cached to allow retrieval and deletion.
|
|
512
|
-
*
|
|
513
|
-
* optional filtering parameters allowed are
|
|
514
|
-
* - username: The username of the user for which this image was stored.
|
|
515
|
-
* - provider: The provider used to generate the image. eg. openai, nvidia (nim), replicate.
|
|
516
|
-
* - model: the text to image model on the provider used to generate the image.
|
|
517
|
-
*
|
|
518
|
-
* This endpoint is accessible to both students and platform admins.
|
|
519
|
-
* @param id A unique integer value identifying this ai generated image.
|
|
520
|
-
* @param org
|
|
521
|
-
* @param userId
|
|
522
|
-
* @returns AIGeneratedImage
|
|
523
|
-
* @throws ApiError
|
|
524
|
-
*/
|
|
525
|
-
static aiMentorOrgsUsersAiGeneratedImagesRetrieve(id: number, org: string, userId: string): CancelablePromise<AIGeneratedImage>;
|
|
526
|
-
/**
|
|
527
|
-
* Endpoint to view and delete AI generated images for a user.
|
|
528
|
-
*
|
|
529
|
-
* AI Generated images are images generated during chat with AI. They are cached to allow retrieval and deletion.
|
|
530
|
-
*
|
|
531
|
-
* optional filtering parameters allowed are
|
|
532
|
-
* - username: The username of the user for which this image was stored.
|
|
533
|
-
* - provider: The provider used to generate the image. eg. openai, nvidia (nim), replicate.
|
|
534
|
-
* - model: the text to image model on the provider used to generate the image.
|
|
535
|
-
*
|
|
536
|
-
* This endpoint is accessible to both students and platform admins.
|
|
537
|
-
* @param id A unique integer value identifying this ai generated image.
|
|
538
|
-
* @param org
|
|
539
|
-
* @param userId
|
|
540
|
-
* @returns void
|
|
541
|
-
* @throws ApiError
|
|
542
|
-
*/
|
|
543
|
-
static aiMentorOrgsUsersAiGeneratedImagesDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
|
|
544
|
-
/**
|
|
545
|
-
* Endpoint to get a list of AI user profile memory entries or to add an entry.
|
|
546
|
-
* @param org
|
|
547
|
-
* @param userId
|
|
548
|
-
* @returns AIUserProfileMemoryRelation
|
|
549
|
-
* @throws ApiError
|
|
550
|
-
*/
|
|
551
|
-
static aiMentorOrgsUsersAiUserProfileMemoryList(org: string, userId: string): CancelablePromise<Array<AIUserProfileMemoryRelation>>;
|
|
552
|
-
/**
|
|
553
|
-
* Endpoint to create an AI user profile memory entry.
|
|
554
|
-
*
|
|
555
|
-
* Sample request:
|
|
556
|
-
* ```
|
|
557
|
-
* {"favorite-animal": "my favorite animal is cat"}
|
|
558
|
-
* ```
|
|
559
|
-
* Sample Response (the same as request data):
|
|
560
|
-
* ```
|
|
561
|
-
* {"favorite-animal": "my favorite animal is cat"}
|
|
562
|
-
* ```
|
|
563
|
-
* @param org
|
|
564
|
-
* @param userId
|
|
565
|
-
* @param requestBody
|
|
566
|
-
* @returns AIUserProfileMemoryRelation
|
|
567
|
-
* @throws ApiError
|
|
568
|
-
*/
|
|
569
|
-
static aiMentorOrgsUsersAiUserProfileMemoryCreate(org: string, userId: string, requestBody: AIUserProfileRequest): CancelablePromise<AIUserProfileMemoryRelation>;
|
|
570
|
-
/**
|
|
571
|
-
* The endpoint to delete an AI user profile memory entry.
|
|
572
|
-
*
|
|
573
|
-
* No query parameters or JSON parameters are required.
|
|
574
|
-
*
|
|
575
|
-
* The response is always empty. Successful request will be responded with status 204, and failed request will be responded with status 404.
|
|
576
|
-
* @param org
|
|
577
|
-
* @param tag
|
|
578
|
-
* @param userId
|
|
579
|
-
* @returns void
|
|
580
|
-
* @throws ApiError
|
|
581
|
-
*/
|
|
582
|
-
static aiMentorOrgsUsersAiUserProfileMemoryDestroy(org: string, tag: string, userId: string): CancelablePromise<void>;
|
|
583
|
-
/**
|
|
584
|
-
* Retrieve assumed knowledge levels.
|
|
585
|
-
*
|
|
586
|
-
* Args:
|
|
587
|
-
* request: The HTTP request.
|
|
588
|
-
* org: The organization/tenant identifier.
|
|
589
|
-
* user_id: The ID of the user to retrieve assumed knowledge for.
|
|
590
|
-
*
|
|
591
|
-
* Returns:
|
|
592
|
-
* Response: The assumed knowledge levels for different categories.
|
|
593
|
-
*
|
|
594
|
-
* Raises:
|
|
595
|
-
* NotFound: If no assumed knowledge exists for the user.
|
|
596
|
-
* @param org
|
|
597
|
-
* @param userId
|
|
598
|
-
* @returns AssumedKnowledge
|
|
599
|
-
* @throws ApiError
|
|
600
|
-
*/
|
|
601
|
-
static aiMentorOrgsUsersAssumedKnowledgeRetrieve(org: string, userId: string): CancelablePromise<AssumedKnowledge>;
|
|
602
|
-
/**
|
|
603
|
-
* Update assumed knowledge levels.
|
|
604
|
-
*
|
|
605
|
-
* Args:
|
|
606
|
-
* request: The HTTP request containing the updated knowledge levels.
|
|
607
|
-
* org: The organization/tenant identifier.
|
|
608
|
-
* user_id: The ID of the user to update assumed knowledge for.
|
|
609
|
-
*
|
|
610
|
-
* Returns:
|
|
611
|
-
* Response: The updated assumed knowledge levels.
|
|
612
|
-
*
|
|
613
|
-
* Raises:
|
|
614
|
-
* BadRequest: If the provided data is invalid.
|
|
615
|
-
* @param org
|
|
616
|
-
* @param userId
|
|
617
|
-
* @param requestBody
|
|
618
|
-
* @returns AssumedKnowledge
|
|
619
|
-
* @throws ApiError
|
|
620
|
-
*/
|
|
621
|
-
static aiMentorOrgsUsersAssumedKnowledgeCreate(org: string, userId: string, requestBody: AssumedKnowledge): CancelablePromise<AssumedKnowledge>;
|
|
622
|
-
/**
|
|
623
|
-
* Convert an uploaded audio file to text.
|
|
624
|
-
*
|
|
625
|
-
* Args:
|
|
626
|
-
* request: The HTTP request containing the audio file.
|
|
627
|
-
* org: The organization/tenant identifier.
|
|
628
|
-
* user_id: The ID of the user uploading the audio.
|
|
629
|
-
*
|
|
630
|
-
* Returns:
|
|
631
|
-
* Response: The transcribed text from the audio file.
|
|
632
|
-
*
|
|
633
|
-
* Raises:
|
|
634
|
-
* BadRequest: If the audio file is invalid or cannot be processed.
|
|
635
|
-
* NotFound: If the API key for the tenant is not found.
|
|
636
|
-
* @param org
|
|
637
|
-
* @param userId
|
|
638
|
-
* @param formData
|
|
639
|
-
* @returns AudioToTextResponse
|
|
640
|
-
* @throws ApiError
|
|
641
|
-
*/
|
|
642
|
-
static aiMentorOrgsUsersAudioToTextCreate(org: string, userId: string, formData: AudioToTextRequest): CancelablePromise<AudioToTextResponse>;
|
|
643
|
-
/**
|
|
644
|
-
* This endpoint list available template mentors for a tenant
|
|
645
|
-
*
|
|
646
|
-
* Returns:
|
|
647
|
-
*
|
|
648
|
-
* 200 : List of Tool objects
|
|
649
|
-
* @param org
|
|
650
|
-
* @param userId
|
|
651
|
-
* @returns TemplateMentor
|
|
652
|
-
* @throws ApiError
|
|
653
|
-
*/
|
|
654
|
-
static aiMentorOrgsUsersAvailableTemplateMentorsRetrieve(org: string, userId: string): CancelablePromise<TemplateMentor>;
|
|
655
|
-
/**
|
|
656
|
-
* Retrieve a list of Mentor Category Groups.
|
|
657
|
-
* @param org
|
|
658
|
-
* @param userId
|
|
659
|
-
* @param audience
|
|
660
|
-
* @param audienceName
|
|
661
|
-
* @param ordering Which field to use when ordering the results.
|
|
662
|
-
* @param search A search term.
|
|
663
|
-
* @returns MentorCategoryGroup
|
|
664
|
-
* @throws ApiError
|
|
665
|
-
*/
|
|
666
|
-
static aiMentorOrgsUsersCategoryGroupsList(org: string, userId: string, audience?: number, audienceName?: string, ordering?: string, search?: string): CancelablePromise<Array<MentorCategoryGroup>>;
|
|
667
|
-
/**
|
|
668
|
-
* Create a new Mentor Category Group. Only accessible to Platform Admins.
|
|
669
|
-
* @param org
|
|
670
|
-
* @param userId
|
|
671
|
-
* @param requestBody
|
|
672
|
-
* @returns MentorCategoryGroup
|
|
673
|
-
* @throws ApiError
|
|
674
|
-
*/
|
|
675
|
-
static aiMentorOrgsUsersCategoryGroupsCreate(org: string, userId: string, requestBody: MentorCategoryGroupCreate): CancelablePromise<MentorCategoryGroup>;
|
|
676
|
-
/**
|
|
677
|
-
* Mentor Category Groups offer parent grouping for mentor category objects.
|
|
678
|
-
*
|
|
679
|
-
* The parameter `audience` is deprecated and is currently left behind for backward compatibility.
|
|
680
|
-
*
|
|
681
|
-
* Permissions:
|
|
682
|
-
* GET: Accessible to both Platform Admins and Students
|
|
683
|
-
* POST, DELETE, PATCH, PUT: Accessible to only Platform Admins
|
|
684
|
-
* @param id A unique integer value identifying this mentor category group.
|
|
685
|
-
* @param org
|
|
686
|
-
* @param userId
|
|
687
|
-
* @returns MentorCategoryGroup
|
|
688
|
-
* @throws ApiError
|
|
689
|
-
*/
|
|
690
|
-
static aiMentorOrgsUsersCategoryGroupsRetrieve(id: number, org: string, userId: string): CancelablePromise<MentorCategoryGroup>;
|
|
691
|
-
/**
|
|
692
|
-
* Mentor Category Groups offer parent grouping for mentor category objects.
|
|
693
|
-
*
|
|
694
|
-
* The parameter `audience` is deprecated and is currently left behind for backward compatibility.
|
|
695
|
-
*
|
|
696
|
-
* Permissions:
|
|
697
|
-
* GET: Accessible to both Platform Admins and Students
|
|
698
|
-
* POST, DELETE, PATCH, PUT: Accessible to only Platform Admins
|
|
699
|
-
* @param id A unique integer value identifying this mentor category group.
|
|
700
|
-
* @param org
|
|
701
|
-
* @param userId
|
|
702
|
-
* @param requestBody
|
|
703
|
-
* @returns MentorCategoryGroupCreate
|
|
704
|
-
* @throws ApiError
|
|
705
|
-
*/
|
|
706
|
-
static aiMentorOrgsUsersCategoryGroupsUpdate(id: number, org: string, userId: string, requestBody: MentorCategoryGroupCreate): CancelablePromise<MentorCategoryGroupCreate>;
|
|
707
|
-
/**
|
|
708
|
-
* Mentor Category Groups offer parent grouping for mentor category objects.
|
|
709
|
-
*
|
|
710
|
-
* The parameter `audience` is deprecated and is currently left behind for backward compatibility.
|
|
711
|
-
*
|
|
712
|
-
* Permissions:
|
|
713
|
-
* GET: Accessible to both Platform Admins and Students
|
|
714
|
-
* POST, DELETE, PATCH, PUT: Accessible to only Platform Admins
|
|
715
|
-
* @param id A unique integer value identifying this mentor category group.
|
|
716
|
-
* @param org
|
|
717
|
-
* @param userId
|
|
718
|
-
* @param requestBody
|
|
719
|
-
* @returns MentorCategoryGroupCreate
|
|
720
|
-
* @throws ApiError
|
|
721
|
-
*/
|
|
722
|
-
static aiMentorOrgsUsersCategoryGroupsPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedMentorCategoryGroupCreate): CancelablePromise<MentorCategoryGroupCreate>;
|
|
723
|
-
/**
|
|
724
|
-
* Mentor Category Groups offer parent grouping for mentor category objects.
|
|
725
|
-
*
|
|
726
|
-
* The parameter `audience` is deprecated and is currently left behind for backward compatibility.
|
|
727
|
-
*
|
|
728
|
-
* Permissions:
|
|
729
|
-
* GET: Accessible to both Platform Admins and Students
|
|
730
|
-
* POST, DELETE, PATCH, PUT: Accessible to only Platform Admins
|
|
731
|
-
* @param id A unique integer value identifying this mentor category group.
|
|
732
|
-
* @param org
|
|
733
|
-
* @param userId
|
|
734
|
-
* @returns void
|
|
735
|
-
* @throws ApiError
|
|
736
|
-
*/
|
|
737
|
-
static aiMentorOrgsUsersCategoryGroupsDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
|
|
738
|
-
/**
|
|
739
|
-
* Retrieve and clean up vector results from a specific session.
|
|
740
|
-
*
|
|
741
|
-
* This endpoint retrieves the documents last used by the mentor to answer
|
|
742
|
-
* the most recent query from the user in the specified session, and cleans
|
|
743
|
-
* them to remove any inappropriate content.
|
|
744
|
-
*
|
|
745
|
-
* Args:
|
|
746
|
-
* request: The HTTP request.
|
|
747
|
-
* org: The organization/tenant identifier.
|
|
748
|
-
* user_id: The ID of the user making the request.
|
|
749
|
-
* session_id: The ID of the session to retrieve vector results from.
|
|
750
|
-
*
|
|
751
|
-
* Returns:
|
|
752
|
-
* Response: The cleaned vector results.
|
|
753
|
-
*
|
|
754
|
-
* Raises:
|
|
755
|
-
* BadRequest: If the API key for the cleaning provider is not found.
|
|
756
|
-
* NotFound: If no vector results are found for the session.
|
|
757
|
-
* @param org
|
|
758
|
-
* @param sessionId
|
|
759
|
-
* @param userId
|
|
760
|
-
* @returns VectorResult
|
|
761
|
-
* @throws ApiError
|
|
762
|
-
*/
|
|
763
|
-
static aiMentorOrgsUsersCleanVectorResultsList(org: string, sessionId: string, userId: string): CancelablePromise<Array<VectorResult>>;
|
|
764
|
-
/**
|
|
765
|
-
* Clean up provided vector results.
|
|
766
|
-
*
|
|
767
|
-
* This endpoint allows users to submit specific vector results for cleaning,
|
|
768
|
-
* which is useful when there are particular documents that need to be processed.
|
|
769
|
-
*
|
|
770
|
-
* Args:
|
|
771
|
-
* request: The HTTP request containing the vector results to clean.
|
|
772
|
-
* org: The organization/tenant identifier.
|
|
773
|
-
* user_id: The ID of the user making the request.
|
|
774
|
-
*
|
|
775
|
-
* Returns:
|
|
776
|
-
* Response: The cleaned vector results.
|
|
777
|
-
*
|
|
778
|
-
* Raises:
|
|
779
|
-
* BadRequest: If the API key for the cleaning provider is not found or the provided data is invalid.
|
|
780
|
-
* @param org
|
|
781
|
-
* @param sessionId
|
|
782
|
-
* @param userId
|
|
783
|
-
* @param requestBody
|
|
784
|
-
* @returns VectorResult
|
|
785
|
-
* @throws ApiError
|
|
786
|
-
*/
|
|
787
|
-
static aiMentorOrgsUsersCleanVectorResultsCreate(org: string, sessionId: string, userId: string, requestBody: Array<VectorResult>): CancelablePromise<Array<VectorResult>>;
|
|
788
|
-
/**
|
|
789
|
-
* Delete User Chat History
|
|
790
|
-
* Endpoint to clear a user's chat history.
|
|
791
|
-
* @param org
|
|
792
|
-
* @param userId
|
|
793
|
-
* @returns void
|
|
794
|
-
* @throws ApiError
|
|
795
|
-
*/
|
|
796
|
-
static aiMentorOrgsUsersClearChathistoryDestroy(org: string, userId: string): CancelablePromise<void>;
|
|
797
|
-
/**
|
|
798
|
-
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
799
|
-
* @param org
|
|
800
|
-
* @param userId
|
|
801
|
-
* @param page A page number within the paginated result set.
|
|
802
|
-
* @param pageSize Number of results to return per page.
|
|
803
|
-
* @returns PaginatedCourseCreationTaskFileList
|
|
804
|
-
* @throws ApiError
|
|
805
|
-
*/
|
|
806
|
-
static aiMentorOrgsUsersCourseCreationTaskFilesList(org: string, userId: string, page?: number, pageSize?: number): CancelablePromise<PaginatedCourseCreationTaskFileList>;
|
|
807
|
-
/**
|
|
808
|
-
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
809
|
-
* @param org
|
|
810
|
-
* @param userId
|
|
811
|
-
* @param formData
|
|
812
|
-
* @returns CourseCreationTaskFile
|
|
813
|
-
* @throws ApiError
|
|
814
|
-
*/
|
|
815
|
-
static aiMentorOrgsUsersCourseCreationTaskFilesCreate(org: string, userId: string, formData: CourseCreationTaskFile): CancelablePromise<CourseCreationTaskFile>;
|
|
816
|
-
/**
|
|
817
|
-
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
818
|
-
* @param id A unique integer value identifying this course creation task file.
|
|
819
|
-
* @param org
|
|
820
|
-
* @param userId
|
|
821
|
-
* @returns CourseCreationTaskFile
|
|
822
|
-
* @throws ApiError
|
|
823
|
-
*/
|
|
824
|
-
static aiMentorOrgsUsersCourseCreationTaskFilesRetrieve(id: number, org: string, userId: string): CancelablePromise<CourseCreationTaskFile>;
|
|
825
|
-
/**
|
|
826
|
-
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
827
|
-
* @param id A unique integer value identifying this course creation task file.
|
|
828
|
-
* @param org
|
|
829
|
-
* @param userId
|
|
830
|
-
* @param formData
|
|
831
|
-
* @returns CourseCreationTaskFile
|
|
832
|
-
* @throws ApiError
|
|
833
|
-
*/
|
|
834
|
-
static aiMentorOrgsUsersCourseCreationTaskFilesUpdate(id: number, org: string, userId: string, formData: CourseCreationTaskFile): CancelablePromise<CourseCreationTaskFile>;
|
|
835
|
-
/**
|
|
836
|
-
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
837
|
-
* @param id A unique integer value identifying this course creation task file.
|
|
838
|
-
* @param org
|
|
839
|
-
* @param userId
|
|
840
|
-
* @param formData
|
|
841
|
-
* @returns CourseCreationTaskFile
|
|
842
|
-
* @throws ApiError
|
|
843
|
-
*/
|
|
844
|
-
static aiMentorOrgsUsersCourseCreationTaskFilesPartialUpdate(id: number, org: string, userId: string, formData?: PatchedCourseCreationTaskFile): CancelablePromise<CourseCreationTaskFile>;
|
|
845
|
-
/**
|
|
846
|
-
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
847
|
-
* @param id A unique integer value identifying this course creation task file.
|
|
848
|
-
* @param org
|
|
849
|
-
* @param userId
|
|
850
|
-
* @returns void
|
|
851
|
-
* @throws ApiError
|
|
852
|
-
*/
|
|
853
|
-
static aiMentorOrgsUsersCourseCreationTaskFilesDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
|
|
854
|
-
/**
|
|
855
|
-
* Create, retrieve and delete course creation tasks
|
|
856
|
-
*
|
|
857
|
-
* Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
|
|
858
|
-
*
|
|
859
|
-
* The course is created entirely by an ai model (as specified in your inputs).
|
|
860
|
-
*
|
|
861
|
-
* The llm decides on the content of the course based on the name, description, target audience and other parameters.
|
|
862
|
-
* Bigger and newer models tend to outperform smaller once.
|
|
863
|
-
*
|
|
864
|
-
* Clear and unambiguous parameters are more likely to produce better results.
|
|
865
|
-
* @param org
|
|
866
|
-
* @param userId
|
|
867
|
-
* @param page A page number within the paginated result set.
|
|
868
|
-
* @param pageSize Number of results to return per page.
|
|
869
|
-
* @returns PaginatedCourseCreationTaskList
|
|
870
|
-
* @throws ApiError
|
|
871
|
-
*/
|
|
872
|
-
static aiMentorOrgsUsersCourseCreationTasksList(org: string, userId: string, page?: number, pageSize?: number): CancelablePromise<PaginatedCourseCreationTaskList>;
|
|
873
|
-
/**
|
|
874
|
-
* Create, retrieve and delete course creation tasks
|
|
875
|
-
*
|
|
876
|
-
* Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
|
|
877
|
-
*
|
|
878
|
-
* The course is created entirely by an ai model (as specified in your inputs).
|
|
879
|
-
*
|
|
880
|
-
* The llm decides on the content of the course based on the name, description, target audience and other parameters.
|
|
881
|
-
* Bigger and newer models tend to outperform smaller once.
|
|
882
|
-
*
|
|
883
|
-
* Clear and unambiguous parameters are more likely to produce better results.
|
|
884
|
-
* @param org
|
|
885
|
-
* @param userId
|
|
886
|
-
* @param formData
|
|
887
|
-
* @returns CourseCreationTask
|
|
888
|
-
* @throws ApiError
|
|
889
|
-
*/
|
|
890
|
-
static aiMentorOrgsUsersCourseCreationTasksCreate(org: string, userId: string, formData: CourseCreationTask): CancelablePromise<CourseCreationTask>;
|
|
891
|
-
/**
|
|
892
|
-
* Create, retrieve and delete course creation tasks
|
|
893
|
-
*
|
|
894
|
-
* Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
|
|
895
|
-
*
|
|
896
|
-
* The course is created entirely by an ai model (as specified in your inputs).
|
|
897
|
-
*
|
|
898
|
-
* The llm decides on the content of the course based on the name, description, target audience and other parameters.
|
|
899
|
-
* Bigger and newer models tend to outperform smaller once.
|
|
900
|
-
*
|
|
901
|
-
* Clear and unambiguous parameters are more likely to produce better results.
|
|
902
|
-
* @param id A unique integer value identifying this course creation task.
|
|
903
|
-
* @param org
|
|
904
|
-
* @param userId
|
|
905
|
-
* @returns CourseCreationTask
|
|
906
|
-
* @throws ApiError
|
|
907
|
-
*/
|
|
908
|
-
static aiMentorOrgsUsersCourseCreationTasksRetrieve(id: number, org: string, userId: string): CancelablePromise<CourseCreationTask>;
|
|
909
|
-
/**
|
|
910
|
-
* Create, retrieve and delete course creation tasks
|
|
911
|
-
*
|
|
912
|
-
* Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
|
|
913
|
-
*
|
|
914
|
-
* The course is created entirely by an ai model (as specified in your inputs).
|
|
915
|
-
*
|
|
916
|
-
* The llm decides on the content of the course based on the name, description, target audience and other parameters.
|
|
917
|
-
* Bigger and newer models tend to outperform smaller once.
|
|
918
|
-
*
|
|
919
|
-
* Clear and unambiguous parameters are more likely to produce better results.
|
|
920
|
-
* @param id A unique integer value identifying this course creation task.
|
|
921
|
-
* @param org
|
|
922
|
-
* @param userId
|
|
923
|
-
* @returns void
|
|
924
|
-
* @throws ApiError
|
|
925
|
-
*/
|
|
926
|
-
static aiMentorOrgsUsersCourseCreationTasksDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
|
|
927
|
-
/**
|
|
928
|
-
* Cancel a course creation task run.
|
|
929
|
-
* ** Conditions Required **:
|
|
930
|
-
* The task must be running or pending.
|
|
931
|
-
* ** Response **:
|
|
932
|
-
* - 200: The course creation task is successfully cancelled.
|
|
933
|
-
* - 400: The course creation task is not in a running or pending state.
|
|
934
|
-
* @param id A unique integer value identifying this course creation task.
|
|
935
|
-
* @param org
|
|
936
|
-
* @param userId
|
|
937
|
-
* @returns CourseCreationTask
|
|
938
|
-
* @throws ApiError
|
|
939
|
-
*/
|
|
940
|
-
static aiMentorOrgsUsersCourseCreationTasksCancelRetrieve(id: number, org: string, userId: string): CancelablePromise<CourseCreationTask>;
|
|
941
|
-
/**
|
|
942
|
-
* This is intended for stepwise approach of course creation.
|
|
943
|
-
*
|
|
944
|
-
* Use this to intiate generating an outline of the course.
|
|
945
|
-
* @param id A unique integer value identifying this course creation task.
|
|
946
|
-
* @param org
|
|
947
|
-
* @param userId
|
|
948
|
-
* @returns FullCourse
|
|
949
|
-
* @throws ApiError
|
|
950
|
-
*/
|
|
951
|
-
static aiMentorOrgsUsersCourseCreationTasksCreateCourseOutlineRetrieve(id: number, org: string, userId: string): CancelablePromise<FullCourse>;
|
|
952
|
-
/**
|
|
953
|
-
* This is intended for stepwise approach of course creation.
|
|
954
|
-
*
|
|
955
|
-
* Use this to intiate generating an outline of the course.
|
|
956
|
-
* @param id A unique integer value identifying this course creation task.
|
|
957
|
-
* @param org
|
|
958
|
-
* @param userId
|
|
959
|
-
* @param formData
|
|
960
|
-
* @returns FullCourse
|
|
961
|
-
* @throws ApiError
|
|
962
|
-
*/
|
|
963
|
-
static aiMentorOrgsUsersCourseCreationTasksCreateCourseOutlineCreate(id: number, org: string, userId: string, formData: CourseCreationTask): CancelablePromise<FullCourse>;
|
|
964
|
-
/**
|
|
965
|
-
* Kick start the course creation task.
|
|
966
|
-
* This endpoint should be called once the files for a course creation task has
|
|
967
|
-
* been successfully uploaded.
|
|
968
|
-
*
|
|
969
|
-
* ** Conditions Required **:
|
|
970
|
-
* - The course creation task must be in a pending state or failed state.
|
|
971
|
-
*
|
|
972
|
-
* ** Response **:
|
|
973
|
-
* - 200: The course creation task is successfully started.
|
|
974
|
-
* - 400: The course creation task is not in a pending state.
|
|
975
|
-
* @param id A unique integer value identifying this course creation task.
|
|
976
|
-
* @param org
|
|
977
|
-
* @param userId
|
|
978
|
-
* @returns CourseCreationTask
|
|
979
|
-
* @throws ApiError
|
|
980
|
-
*/
|
|
981
|
-
static aiMentorOrgsUsersCourseCreationTasksStartRetrieve(id: number, org: string, userId: string): CancelablePromise<CourseCreationTask>;
|
|
982
|
-
/**
|
|
983
|
-
* API viewset for managing course units.
|
|
984
|
-
*
|
|
985
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
986
|
-
* units within course subsections, and generate content for them.
|
|
987
|
-
*
|
|
988
|
-
* Permissions:
|
|
989
|
-
* - Restricted to platform administrators only
|
|
990
|
-
* @param org
|
|
991
|
-
* @param userId
|
|
992
|
-
* @param course
|
|
993
|
-
* @param ordering Which field to use when ordering the results.
|
|
994
|
-
* @param page A page number within the paginated result set.
|
|
995
|
-
* @param pageSize Number of results to return per page.
|
|
996
|
-
* @param search A search term.
|
|
997
|
-
* @param section
|
|
998
|
-
* @param subsection
|
|
999
|
-
* @param task
|
|
1000
|
-
* @returns PaginatedUnitList
|
|
1001
|
-
* @throws ApiError
|
|
1002
|
-
*/
|
|
1003
|
-
static aiMentorOrgsUsersCourseCreationComponentList(org: string, userId: string, course?: number, ordering?: string, page?: number, pageSize?: number, search?: string, section?: number, subsection?: number, task?: number): CancelablePromise<PaginatedUnitList>;
|
|
1004
|
-
/**
|
|
1005
|
-
* API viewset for managing course units.
|
|
1006
|
-
*
|
|
1007
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1008
|
-
* units within course subsections, and generate content for them.
|
|
1009
|
-
*
|
|
1010
|
-
* Permissions:
|
|
1011
|
-
* - Restricted to platform administrators only
|
|
1012
|
-
* @param org
|
|
1013
|
-
* @param userId
|
|
1014
|
-
* @param requestBody
|
|
1015
|
-
* @returns Unit
|
|
1016
|
-
* @throws ApiError
|
|
1017
|
-
*/
|
|
1018
|
-
static aiMentorOrgsUsersCourseCreationComponentCreate(org: string, userId: string, requestBody: Unit): CancelablePromise<Unit>;
|
|
1019
|
-
/**
|
|
1020
|
-
* API viewset for managing course units.
|
|
1021
|
-
*
|
|
1022
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1023
|
-
* units within course subsections, and generate content for them.
|
|
1024
|
-
*
|
|
1025
|
-
* Permissions:
|
|
1026
|
-
* - Restricted to platform administrators only
|
|
1027
|
-
* @param id A unique integer value identifying this unit.
|
|
1028
|
-
* @param org
|
|
1029
|
-
* @param userId
|
|
1030
|
-
* @returns Unit
|
|
1031
|
-
* @throws ApiError
|
|
1032
|
-
*/
|
|
1033
|
-
static aiMentorOrgsUsersCourseCreationComponentRetrieve(id: number, org: string, userId: string): CancelablePromise<Unit>;
|
|
1034
|
-
/**
|
|
1035
|
-
* API viewset for managing course units.
|
|
1036
|
-
*
|
|
1037
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1038
|
-
* units within course subsections, and generate content for them.
|
|
1039
|
-
*
|
|
1040
|
-
* Permissions:
|
|
1041
|
-
* - Restricted to platform administrators only
|
|
1042
|
-
* @param id A unique integer value identifying this unit.
|
|
1043
|
-
* @param org
|
|
1044
|
-
* @param userId
|
|
1045
|
-
* @param requestBody
|
|
1046
|
-
* @returns Unit
|
|
1047
|
-
* @throws ApiError
|
|
1048
|
-
*/
|
|
1049
|
-
static aiMentorOrgsUsersCourseCreationComponentUpdate(id: number, org: string, userId: string, requestBody: Unit): CancelablePromise<Unit>;
|
|
1050
|
-
/**
|
|
1051
|
-
* API viewset for managing course units.
|
|
1052
|
-
*
|
|
1053
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1054
|
-
* units within course subsections, and generate content for them.
|
|
1055
|
-
*
|
|
1056
|
-
* Permissions:
|
|
1057
|
-
* - Restricted to platform administrators only
|
|
1058
|
-
* @param id A unique integer value identifying this unit.
|
|
1059
|
-
* @param org
|
|
1060
|
-
* @param userId
|
|
1061
|
-
* @param requestBody
|
|
1062
|
-
* @returns Unit
|
|
1063
|
-
* @throws ApiError
|
|
1064
|
-
*/
|
|
1065
|
-
static aiMentorOrgsUsersCourseCreationComponentPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedUnit): CancelablePromise<Unit>;
|
|
1066
|
-
/**
|
|
1067
|
-
* API viewset for managing course units.
|
|
1068
|
-
*
|
|
1069
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1070
|
-
* units within course subsections, and generate content for them.
|
|
1071
|
-
*
|
|
1072
|
-
* Permissions:
|
|
1073
|
-
* - Restricted to platform administrators only
|
|
1074
|
-
* @param id A unique integer value identifying this unit.
|
|
1075
|
-
* @param org
|
|
1076
|
-
* @param userId
|
|
1077
|
-
* @returns void
|
|
1078
|
-
* @throws ApiError
|
|
1079
|
-
*/
|
|
1080
|
-
static aiMentorOrgsUsersCourseCreationComponentDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
|
|
1081
|
-
/**
|
|
1082
|
-
* Generate draft content for a specific unit.
|
|
1083
|
-
*
|
|
1084
|
-
* This action starts a background task to create draft content
|
|
1085
|
-
* for the specified unit using AI.
|
|
1086
|
-
*
|
|
1087
|
-
* Args:
|
|
1088
|
-
* request: The HTTP request.
|
|
1089
|
-
* pk: The primary key of the unit to generate content for.
|
|
1090
|
-
*
|
|
1091
|
-
* Returns:
|
|
1092
|
-
* Response: A confirmation that the content generation task has been started.
|
|
1093
|
-
*
|
|
1094
|
-
* Raises:
|
|
1095
|
-
* NotFound: If the specified unit does not exist.
|
|
1096
|
-
* @param id A unique integer value identifying this unit.
|
|
1097
|
-
* @param org
|
|
1098
|
-
* @param userId
|
|
1099
|
-
* @returns any Content creation started successfully
|
|
1100
|
-
* @throws ApiError
|
|
1101
|
-
*/
|
|
1102
|
-
static aiMentorOrgsUsersCourseCreationComponentDraftContentRetrieve(id: number, org: string, userId: string): CancelablePromise<any>;
|
|
1103
|
-
/**
|
|
1104
|
-
* Generate draft content for a specific unit.
|
|
1105
|
-
*
|
|
1106
|
-
* This action starts a background task to create draft content
|
|
1107
|
-
* for the specified unit using AI.
|
|
1108
|
-
*
|
|
1109
|
-
* Args:
|
|
1110
|
-
* request: The HTTP request.
|
|
1111
|
-
* pk: The primary key of the unit to generate content for.
|
|
1112
|
-
*
|
|
1113
|
-
* Returns:
|
|
1114
|
-
* Response: A confirmation that the content generation task has been started.
|
|
1115
|
-
*
|
|
1116
|
-
* Raises:
|
|
1117
|
-
* NotFound: If the specified unit does not exist.
|
|
1118
|
-
* @param id A unique integer value identifying this unit.
|
|
1119
|
-
* @param org
|
|
1120
|
-
* @param userId
|
|
1121
|
-
* @param requestBody
|
|
1122
|
-
* @returns any Content creation started successfully
|
|
1123
|
-
* @throws ApiError
|
|
1124
|
-
*/
|
|
1125
|
-
static aiMentorOrgsUsersCourseCreationComponentDraftContentCreate(id: number, org: string, userId: string, requestBody: Unit): CancelablePromise<any>;
|
|
1126
|
-
/**
|
|
1127
|
-
* API viewset for managing EdX courses.
|
|
1128
|
-
*
|
|
1129
|
-
* This viewset allows platform administrators to retrieve, delete, and
|
|
1130
|
-
* perform various operations on EdX courses that were created through
|
|
1131
|
-
* course creation tasks.
|
|
1132
|
-
*
|
|
1133
|
-
* Permissions:
|
|
1134
|
-
* - Restricted to platform administrators only
|
|
1135
|
-
* @param org
|
|
1136
|
-
* @param userId
|
|
1137
|
-
* @param ordering Which field to use when ordering the results.
|
|
1138
|
-
* @param page A page number within the paginated result set.
|
|
1139
|
-
* @param pageSize Number of results to return per page.
|
|
1140
|
-
* @param search A search term.
|
|
1141
|
-
* @param task
|
|
1142
|
-
* @returns PaginatedEdxCourseList
|
|
1143
|
-
* @throws ApiError
|
|
1144
|
-
*/
|
|
1145
|
-
static aiMentorOrgsUsersCourseCreationCourseList(org: string, userId: string, ordering?: string, page?: number, pageSize?: number, search?: string, task?: number): CancelablePromise<PaginatedEdxCourseList>;
|
|
1146
|
-
/**
|
|
1147
|
-
* API viewset for managing EdX courses.
|
|
1148
|
-
*
|
|
1149
|
-
* This viewset allows platform administrators to retrieve, delete, and
|
|
1150
|
-
* perform various operations on EdX courses that were created through
|
|
1151
|
-
* course creation tasks.
|
|
1152
|
-
*
|
|
1153
|
-
* Permissions:
|
|
1154
|
-
* - Restricted to platform administrators only
|
|
1155
|
-
* @param id A unique integer value identifying this edx course.
|
|
1156
|
-
* @param org
|
|
1157
|
-
* @param userId
|
|
1158
|
-
* @returns EdxCourse
|
|
1159
|
-
* @throws ApiError
|
|
1160
|
-
*/
|
|
1161
|
-
static aiMentorOrgsUsersCourseCreationCourseRetrieve(id: number, org: string, userId: string): CancelablePromise<EdxCourse>;
|
|
1162
|
-
/**
|
|
1163
|
-
* API viewset for managing EdX courses.
|
|
1164
|
-
*
|
|
1165
|
-
* This viewset allows platform administrators to retrieve, delete, and
|
|
1166
|
-
* perform various operations on EdX courses that were created through
|
|
1167
|
-
* course creation tasks.
|
|
1168
|
-
*
|
|
1169
|
-
* Permissions:
|
|
1170
|
-
* - Restricted to platform administrators only
|
|
1171
|
-
* @param id A unique integer value identifying this edx course.
|
|
1172
|
-
* @param org
|
|
1173
|
-
* @param userId
|
|
1174
|
-
* @returns void
|
|
1175
|
-
* @throws ApiError
|
|
1176
|
-
*/
|
|
1177
|
-
static aiMentorOrgsUsersCourseCreationCourseDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
|
|
1178
|
-
/**
|
|
1179
|
-
* Generate draft content for all units in a course.
|
|
1180
|
-
*
|
|
1181
|
-
* This action starts a background task to create draft content
|
|
1182
|
-
* for all units in the course using AI.
|
|
1183
|
-
*
|
|
1184
|
-
* Args:
|
|
1185
|
-
* request: The HTTP request.
|
|
1186
|
-
* pk: The primary key of the course to generate content for.
|
|
1187
|
-
*
|
|
1188
|
-
* Returns:
|
|
1189
|
-
* Response: A confirmation that the content generation task has been started.
|
|
1190
|
-
*
|
|
1191
|
-
* Raises:
|
|
1192
|
-
* NotFound: If the specified course does not exist.
|
|
1193
|
-
* @param id A unique integer value identifying this edx course.
|
|
1194
|
-
* @param org
|
|
1195
|
-
* @param userId
|
|
1196
|
-
* @returns any Content creation started successfully
|
|
1197
|
-
* @throws ApiError
|
|
1198
|
-
*/
|
|
1199
|
-
static aiMentorOrgsUsersCourseCreationCourseDraftContentForAllUnitsRetrieve(id: number, org: string, userId: string): CancelablePromise<any>;
|
|
1200
|
-
/**
|
|
1201
|
-
* Retrieve the full structure of a course.
|
|
1202
|
-
*
|
|
1203
|
-
* This action returns the complete hierarchical structure of the course,
|
|
1204
|
-
* including all sections, subsections, units, and components.
|
|
1205
|
-
*
|
|
1206
|
-
* Args:
|
|
1207
|
-
* request: The HTTP request.
|
|
1208
|
-
* pk: The primary key of the course to retrieve.
|
|
1209
|
-
*
|
|
1210
|
-
* Returns:
|
|
1211
|
-
* Response: The full structure of the course.
|
|
1212
|
-
*
|
|
1213
|
-
* Raises:
|
|
1214
|
-
* NotFound: If the specified course does not exist.
|
|
1215
|
-
* @param id A unique integer value identifying this edx course.
|
|
1216
|
-
* @param org
|
|
1217
|
-
* @param userId
|
|
1218
|
-
* @returns FullCourse
|
|
1219
|
-
* @throws ApiError
|
|
1220
|
-
*/
|
|
1221
|
-
static aiMentorOrgsUsersCourseCreationCourseFullStructureRetrieve(id: number, org: string, userId: string): CancelablePromise<FullCourse>;
|
|
1222
|
-
/**
|
|
1223
|
-
* Load existing course structure from OpenEdX.
|
|
1224
|
-
*
|
|
1225
|
-
* This action starts a background task to pull the course structure
|
|
1226
|
-
* from the EdX platform into the database.
|
|
1227
|
-
*
|
|
1228
|
-
* Args:
|
|
1229
|
-
* request: The HTTP request.
|
|
1230
|
-
* pk: The primary key of the course to load.
|
|
1231
|
-
*
|
|
1232
|
-
* Returns:
|
|
1233
|
-
* Response: A confirmation that the load task has been started.
|
|
1234
|
-
*
|
|
1235
|
-
* Raises:
|
|
1236
|
-
* NotFound: If the specified course does not exist.
|
|
1237
|
-
* @param id A unique integer value identifying this edx course.
|
|
1238
|
-
* @param org
|
|
1239
|
-
* @param userId
|
|
1240
|
-
* @returns any Course load started successfully
|
|
1241
|
-
* @throws ApiError
|
|
1242
|
-
*/
|
|
1243
|
-
static aiMentorOrgsUsersCourseCreationCourseLoadFromEdxRetrieve(id: number, org: string, userId: string): CancelablePromise<any>;
|
|
1244
|
-
/**
|
|
1245
|
-
* Synchronize the course structure to EdX.
|
|
1246
|
-
*
|
|
1247
|
-
* This action starts a background task to push the course structure
|
|
1248
|
-
* from the database to the EdX platform.
|
|
1249
|
-
*
|
|
1250
|
-
* Args:
|
|
1251
|
-
* request: The HTTP request.
|
|
1252
|
-
* pk: The primary key of the course to synchronize.
|
|
1253
|
-
*
|
|
1254
|
-
* Returns:
|
|
1255
|
-
* Response: A confirmation that the sync task has been started.
|
|
1256
|
-
*
|
|
1257
|
-
* Raises:
|
|
1258
|
-
* NotFound: If the specified course does not exist.
|
|
1259
|
-
* @param id A unique integer value identifying this edx course.
|
|
1260
|
-
* @param org
|
|
1261
|
-
* @param userId
|
|
1262
|
-
* @returns any Course sync started successfully
|
|
1263
|
-
* @throws ApiError
|
|
1264
|
-
*/
|
|
1265
|
-
static aiMentorOrgsUsersCourseCreationCourseSyncToEdxRetrieve(id: number, org: string, userId: string): CancelablePromise<any>;
|
|
1266
|
-
/**
|
|
1267
|
-
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
1268
|
-
* @param org
|
|
1269
|
-
* @param userId
|
|
1270
|
-
* @param page A page number within the paginated result set.
|
|
1271
|
-
* @param pageSize Number of results to return per page.
|
|
1272
|
-
* @returns PaginatedCourseCreationTaskFileList
|
|
1273
|
-
* @throws ApiError
|
|
1274
|
-
*/
|
|
1275
|
-
static aiMentorOrgsUsersCourseCreationFilesList(org: string, userId: string, page?: number, pageSize?: number): CancelablePromise<PaginatedCourseCreationTaskFileList>;
|
|
1276
|
-
/**
|
|
1277
|
-
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
1278
|
-
* @param org
|
|
1279
|
-
* @param userId
|
|
1280
|
-
* @param formData
|
|
1281
|
-
* @returns CourseCreationTaskFile
|
|
1282
|
-
* @throws ApiError
|
|
1283
|
-
*/
|
|
1284
|
-
static aiMentorOrgsUsersCourseCreationFilesCreate(org: string, userId: string, formData: CourseCreationTaskFile): CancelablePromise<CourseCreationTaskFile>;
|
|
1285
|
-
/**
|
|
1286
|
-
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
1287
|
-
* @param id A unique integer value identifying this course creation task file.
|
|
1288
|
-
* @param org
|
|
1289
|
-
* @param userId
|
|
1290
|
-
* @returns CourseCreationTaskFile
|
|
1291
|
-
* @throws ApiError
|
|
1292
|
-
*/
|
|
1293
|
-
static aiMentorOrgsUsersCourseCreationFilesRetrieve(id: number, org: string, userId: string): CancelablePromise<CourseCreationTaskFile>;
|
|
1294
|
-
/**
|
|
1295
|
-
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
1296
|
-
* @param id A unique integer value identifying this course creation task file.
|
|
1297
|
-
* @param org
|
|
1298
|
-
* @param userId
|
|
1299
|
-
* @param formData
|
|
1300
|
-
* @returns CourseCreationTaskFile
|
|
1301
|
-
* @throws ApiError
|
|
1302
|
-
*/
|
|
1303
|
-
static aiMentorOrgsUsersCourseCreationFilesUpdate(id: number, org: string, userId: string, formData: CourseCreationTaskFile): CancelablePromise<CourseCreationTaskFile>;
|
|
1304
|
-
/**
|
|
1305
|
-
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
1306
|
-
* @param id A unique integer value identifying this course creation task file.
|
|
1307
|
-
* @param org
|
|
1308
|
-
* @param userId
|
|
1309
|
-
* @param formData
|
|
1310
|
-
* @returns CourseCreationTaskFile
|
|
1311
|
-
* @throws ApiError
|
|
1312
|
-
*/
|
|
1313
|
-
static aiMentorOrgsUsersCourseCreationFilesPartialUpdate(id: number, org: string, userId: string, formData?: PatchedCourseCreationTaskFile): CancelablePromise<CourseCreationTaskFile>;
|
|
1314
|
-
/**
|
|
1315
|
-
* Endpoint to fetch update and delete files associated with course creation tasks.
|
|
1316
|
-
* @param id A unique integer value identifying this course creation task file.
|
|
1317
|
-
* @param org
|
|
1318
|
-
* @param userId
|
|
1319
|
-
* @returns void
|
|
1320
|
-
* @throws ApiError
|
|
1321
|
-
*/
|
|
1322
|
-
static aiMentorOrgsUsersCourseCreationFilesDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
|
|
1323
|
-
/**
|
|
1324
|
-
* API viewset for managing course sections.
|
|
1325
|
-
*
|
|
1326
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1327
|
-
* sections within EdX courses.
|
|
1328
|
-
*
|
|
1329
|
-
* Permissions:
|
|
1330
|
-
* - Restricted to platform administrators only
|
|
1331
|
-
* @param org
|
|
1332
|
-
* @param userId
|
|
1333
|
-
* @param course
|
|
1334
|
-
* @param ordering Which field to use when ordering the results.
|
|
1335
|
-
* @param page A page number within the paginated result set.
|
|
1336
|
-
* @param pageSize Number of results to return per page.
|
|
1337
|
-
* @param search A search term.
|
|
1338
|
-
* @param task
|
|
1339
|
-
* @returns PaginatedSectionList
|
|
1340
|
-
* @throws ApiError
|
|
1341
|
-
*/
|
|
1342
|
-
static aiMentorOrgsUsersCourseCreationSectionList(org: string, userId: string, course?: number, ordering?: string, page?: number, pageSize?: number, search?: string, task?: number): CancelablePromise<PaginatedSectionList>;
|
|
1343
|
-
/**
|
|
1344
|
-
* API viewset for managing course sections.
|
|
1345
|
-
*
|
|
1346
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1347
|
-
* sections within EdX courses.
|
|
1348
|
-
*
|
|
1349
|
-
* Permissions:
|
|
1350
|
-
* - Restricted to platform administrators only
|
|
1351
|
-
* @param org
|
|
1352
|
-
* @param userId
|
|
1353
|
-
* @param requestBody
|
|
1354
|
-
* @returns Section
|
|
1355
|
-
* @throws ApiError
|
|
1356
|
-
*/
|
|
1357
|
-
static aiMentorOrgsUsersCourseCreationSectionCreate(org: string, userId: string, requestBody: Section): CancelablePromise<Section>;
|
|
1358
|
-
/**
|
|
1359
|
-
* API viewset for managing course sections.
|
|
1360
|
-
*
|
|
1361
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1362
|
-
* sections within EdX courses.
|
|
1363
|
-
*
|
|
1364
|
-
* Permissions:
|
|
1365
|
-
* - Restricted to platform administrators only
|
|
1366
|
-
* @param id A unique integer value identifying this section.
|
|
1367
|
-
* @param org
|
|
1368
|
-
* @param userId
|
|
1369
|
-
* @returns Section
|
|
1370
|
-
* @throws ApiError
|
|
1371
|
-
*/
|
|
1372
|
-
static aiMentorOrgsUsersCourseCreationSectionRetrieve(id: number, org: string, userId: string): CancelablePromise<Section>;
|
|
1373
|
-
/**
|
|
1374
|
-
* API viewset for managing course sections.
|
|
1375
|
-
*
|
|
1376
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1377
|
-
* sections within EdX courses.
|
|
1378
|
-
*
|
|
1379
|
-
* Permissions:
|
|
1380
|
-
* - Restricted to platform administrators only
|
|
1381
|
-
* @param id A unique integer value identifying this section.
|
|
1382
|
-
* @param org
|
|
1383
|
-
* @param userId
|
|
1384
|
-
* @param requestBody
|
|
1385
|
-
* @returns Section
|
|
1386
|
-
* @throws ApiError
|
|
1387
|
-
*/
|
|
1388
|
-
static aiMentorOrgsUsersCourseCreationSectionUpdate(id: number, org: string, userId: string, requestBody: Section): CancelablePromise<Section>;
|
|
1389
|
-
/**
|
|
1390
|
-
* API viewset for managing course sections.
|
|
1391
|
-
*
|
|
1392
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1393
|
-
* sections within EdX courses.
|
|
1394
|
-
*
|
|
1395
|
-
* Permissions:
|
|
1396
|
-
* - Restricted to platform administrators only
|
|
1397
|
-
* @param id A unique integer value identifying this section.
|
|
1398
|
-
* @param org
|
|
1399
|
-
* @param userId
|
|
1400
|
-
* @param requestBody
|
|
1401
|
-
* @returns Section
|
|
1402
|
-
* @throws ApiError
|
|
1403
|
-
*/
|
|
1404
|
-
static aiMentorOrgsUsersCourseCreationSectionPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedSection): CancelablePromise<Section>;
|
|
1405
|
-
/**
|
|
1406
|
-
* API viewset for managing course sections.
|
|
1407
|
-
*
|
|
1408
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1409
|
-
* sections within EdX courses.
|
|
1410
|
-
*
|
|
1411
|
-
* Permissions:
|
|
1412
|
-
* - Restricted to platform administrators only
|
|
1413
|
-
* @param id A unique integer value identifying this section.
|
|
1414
|
-
* @param org
|
|
1415
|
-
* @param userId
|
|
1416
|
-
* @returns void
|
|
1417
|
-
* @throws ApiError
|
|
1418
|
-
*/
|
|
1419
|
-
static aiMentorOrgsUsersCourseCreationSectionDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
|
|
1420
|
-
/**
|
|
1421
|
-
* API viewset for managing course subsections.
|
|
1422
|
-
*
|
|
1423
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1424
|
-
* subsections within course sections.
|
|
1425
|
-
*
|
|
1426
|
-
* Permissions:
|
|
1427
|
-
* - Restricted to platform administrators only
|
|
1428
|
-
* @param org
|
|
1429
|
-
* @param userId
|
|
1430
|
-
* @param course
|
|
1431
|
-
* @param ordering Which field to use when ordering the results.
|
|
1432
|
-
* @param page A page number within the paginated result set.
|
|
1433
|
-
* @param pageSize Number of results to return per page.
|
|
1434
|
-
* @param search A search term.
|
|
1435
|
-
* @param section
|
|
1436
|
-
* @param task
|
|
1437
|
-
* @returns PaginatedSubSectionList
|
|
1438
|
-
* @throws ApiError
|
|
1439
|
-
*/
|
|
1440
|
-
static aiMentorOrgsUsersCourseCreationSubsectionList(org: string, userId: string, course?: number, ordering?: string, page?: number, pageSize?: number, search?: string, section?: number, task?: number): CancelablePromise<PaginatedSubSectionList>;
|
|
1441
|
-
/**
|
|
1442
|
-
* API viewset for managing course subsections.
|
|
1443
|
-
*
|
|
1444
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1445
|
-
* subsections within course sections.
|
|
1446
|
-
*
|
|
1447
|
-
* Permissions:
|
|
1448
|
-
* - Restricted to platform administrators only
|
|
1449
|
-
* @param org
|
|
1450
|
-
* @param userId
|
|
1451
|
-
* @param requestBody
|
|
1452
|
-
* @returns SubSection
|
|
1453
|
-
* @throws ApiError
|
|
1454
|
-
*/
|
|
1455
|
-
static aiMentorOrgsUsersCourseCreationSubsectionCreate(org: string, userId: string, requestBody: SubSection): CancelablePromise<SubSection>;
|
|
1456
|
-
/**
|
|
1457
|
-
* API viewset for managing course subsections.
|
|
1458
|
-
*
|
|
1459
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1460
|
-
* subsections within course sections.
|
|
1461
|
-
*
|
|
1462
|
-
* Permissions:
|
|
1463
|
-
* - Restricted to platform administrators only
|
|
1464
|
-
* @param id A unique integer value identifying this sub section.
|
|
1465
|
-
* @param org
|
|
1466
|
-
* @param userId
|
|
1467
|
-
* @returns SubSection
|
|
1468
|
-
* @throws ApiError
|
|
1469
|
-
*/
|
|
1470
|
-
static aiMentorOrgsUsersCourseCreationSubsectionRetrieve(id: number, org: string, userId: string): CancelablePromise<SubSection>;
|
|
1471
|
-
/**
|
|
1472
|
-
* API viewset for managing course subsections.
|
|
1473
|
-
*
|
|
1474
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1475
|
-
* subsections within course sections.
|
|
1476
|
-
*
|
|
1477
|
-
* Permissions:
|
|
1478
|
-
* - Restricted to platform administrators only
|
|
1479
|
-
* @param id A unique integer value identifying this sub section.
|
|
1480
|
-
* @param org
|
|
1481
|
-
* @param userId
|
|
1482
|
-
* @param requestBody
|
|
1483
|
-
* @returns SubSection
|
|
1484
|
-
* @throws ApiError
|
|
1485
|
-
*/
|
|
1486
|
-
static aiMentorOrgsUsersCourseCreationSubsectionUpdate(id: number, org: string, userId: string, requestBody: SubSection): CancelablePromise<SubSection>;
|
|
1487
|
-
/**
|
|
1488
|
-
* API viewset for managing course subsections.
|
|
1489
|
-
*
|
|
1490
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1491
|
-
* subsections within course sections.
|
|
1492
|
-
*
|
|
1493
|
-
* Permissions:
|
|
1494
|
-
* - Restricted to platform administrators only
|
|
1495
|
-
* @param id A unique integer value identifying this sub section.
|
|
1496
|
-
* @param org
|
|
1497
|
-
* @param userId
|
|
1498
|
-
* @param requestBody
|
|
1499
|
-
* @returns SubSection
|
|
1500
|
-
* @throws ApiError
|
|
1501
|
-
*/
|
|
1502
|
-
static aiMentorOrgsUsersCourseCreationSubsectionPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedSubSection): CancelablePromise<SubSection>;
|
|
1503
|
-
/**
|
|
1504
|
-
* API viewset for managing course subsections.
|
|
1505
|
-
*
|
|
1506
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1507
|
-
* subsections within course sections.
|
|
1508
|
-
*
|
|
1509
|
-
* Permissions:
|
|
1510
|
-
* - Restricted to platform administrators only
|
|
1511
|
-
* @param id A unique integer value identifying this sub section.
|
|
1512
|
-
* @param org
|
|
1513
|
-
* @param userId
|
|
1514
|
-
* @returns void
|
|
1515
|
-
* @throws ApiError
|
|
1516
|
-
*/
|
|
1517
|
-
static aiMentorOrgsUsersCourseCreationSubsectionDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
|
|
1518
|
-
/**
|
|
1519
|
-
* Create, retrieve and delete course creation tasks
|
|
1520
|
-
*
|
|
1521
|
-
* Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
|
|
1522
|
-
*
|
|
1523
|
-
* The course is created entirely by an ai model (as specified in your inputs).
|
|
1524
|
-
*
|
|
1525
|
-
* The llm decides on the content of the course based on the name, description, target audience and other parameters.
|
|
1526
|
-
* Bigger and newer models tend to outperform smaller once.
|
|
1527
|
-
*
|
|
1528
|
-
* Clear and unambiguous parameters are more likely to produce better results.
|
|
1529
|
-
* @param org
|
|
1530
|
-
* @param userId
|
|
1531
|
-
* @param page A page number within the paginated result set.
|
|
1532
|
-
* @param pageSize Number of results to return per page.
|
|
1533
|
-
* @returns PaginatedCourseCreationTaskList
|
|
1534
|
-
* @throws ApiError
|
|
1535
|
-
*/
|
|
1536
|
-
static aiMentorOrgsUsersCourseCreationTasksList2(org: string, userId: string, page?: number, pageSize?: number): CancelablePromise<PaginatedCourseCreationTaskList>;
|
|
1537
|
-
/**
|
|
1538
|
-
* Create, retrieve and delete course creation tasks
|
|
1539
|
-
*
|
|
1540
|
-
* Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
|
|
1541
|
-
*
|
|
1542
|
-
* The course is created entirely by an ai model (as specified in your inputs).
|
|
1543
|
-
*
|
|
1544
|
-
* The llm decides on the content of the course based on the name, description, target audience and other parameters.
|
|
1545
|
-
* Bigger and newer models tend to outperform smaller once.
|
|
1546
|
-
*
|
|
1547
|
-
* Clear and unambiguous parameters are more likely to produce better results.
|
|
1548
|
-
* @param org
|
|
1549
|
-
* @param userId
|
|
1550
|
-
* @param formData
|
|
1551
|
-
* @returns CourseCreationTask
|
|
1552
|
-
* @throws ApiError
|
|
1553
|
-
*/
|
|
1554
|
-
static aiMentorOrgsUsersCourseCreationTasksCreate2(org: string, userId: string, formData: CourseCreationTask): CancelablePromise<CourseCreationTask>;
|
|
1555
|
-
/**
|
|
1556
|
-
* Create, retrieve and delete course creation tasks
|
|
1557
|
-
*
|
|
1558
|
-
* Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
|
|
1559
|
-
*
|
|
1560
|
-
* The course is created entirely by an ai model (as specified in your inputs).
|
|
1561
|
-
*
|
|
1562
|
-
* The llm decides on the content of the course based on the name, description, target audience and other parameters.
|
|
1563
|
-
* Bigger and newer models tend to outperform smaller once.
|
|
1564
|
-
*
|
|
1565
|
-
* Clear and unambiguous parameters are more likely to produce better results.
|
|
1566
|
-
* @param id A unique integer value identifying this course creation task.
|
|
1567
|
-
* @param org
|
|
1568
|
-
* @param userId
|
|
1569
|
-
* @returns CourseCreationTask
|
|
1570
|
-
* @throws ApiError
|
|
1571
|
-
*/
|
|
1572
|
-
static aiMentorOrgsUsersCourseCreationTasksRetrieve2(id: number, org: string, userId: string): CancelablePromise<CourseCreationTask>;
|
|
1573
|
-
/**
|
|
1574
|
-
* Create, retrieve and delete course creation tasks
|
|
1575
|
-
*
|
|
1576
|
-
* Course creation tasks allow you to schedule the creation of a course on OpenEdx deployment connected to this data manager.
|
|
1577
|
-
*
|
|
1578
|
-
* The course is created entirely by an ai model (as specified in your inputs).
|
|
1579
|
-
*
|
|
1580
|
-
* The llm decides on the content of the course based on the name, description, target audience and other parameters.
|
|
1581
|
-
* Bigger and newer models tend to outperform smaller once.
|
|
1582
|
-
*
|
|
1583
|
-
* Clear and unambiguous parameters are more likely to produce better results.
|
|
1584
|
-
* @param id A unique integer value identifying this course creation task.
|
|
1585
|
-
* @param org
|
|
1586
|
-
* @param userId
|
|
1587
|
-
* @returns void
|
|
1588
|
-
* @throws ApiError
|
|
1589
|
-
*/
|
|
1590
|
-
static aiMentorOrgsUsersCourseCreationTasksDestroy2(id: number, org: string, userId: string): CancelablePromise<void>;
|
|
1591
|
-
/**
|
|
1592
|
-
* Cancel a course creation task run.
|
|
1593
|
-
* ** Conditions Required **:
|
|
1594
|
-
* The task must be running or pending.
|
|
1595
|
-
* ** Response **:
|
|
1596
|
-
* - 200: The course creation task is successfully cancelled.
|
|
1597
|
-
* - 400: The course creation task is not in a running or pending state.
|
|
1598
|
-
* @param id A unique integer value identifying this course creation task.
|
|
1599
|
-
* @param org
|
|
1600
|
-
* @param userId
|
|
1601
|
-
* @returns CourseCreationTask
|
|
1602
|
-
* @throws ApiError
|
|
1603
|
-
*/
|
|
1604
|
-
static aiMentorOrgsUsersCourseCreationTasksCancelRetrieve2(id: number, org: string, userId: string): CancelablePromise<CourseCreationTask>;
|
|
1605
|
-
/**
|
|
1606
|
-
* This is intended for stepwise approach of course creation.
|
|
1607
|
-
*
|
|
1608
|
-
* Use this to intiate generating an outline of the course.
|
|
1609
|
-
* @param id A unique integer value identifying this course creation task.
|
|
1610
|
-
* @param org
|
|
1611
|
-
* @param userId
|
|
1612
|
-
* @returns FullCourse
|
|
1613
|
-
* @throws ApiError
|
|
1614
|
-
*/
|
|
1615
|
-
static aiMentorOrgsUsersCourseCreationTasksCreateCourseOutlineRetrieve2(id: number, org: string, userId: string): CancelablePromise<FullCourse>;
|
|
1616
|
-
/**
|
|
1617
|
-
* This is intended for stepwise approach of course creation.
|
|
1618
|
-
*
|
|
1619
|
-
* Use this to intiate generating an outline of the course.
|
|
1620
|
-
* @param id A unique integer value identifying this course creation task.
|
|
1621
|
-
* @param org
|
|
1622
|
-
* @param userId
|
|
1623
|
-
* @param formData
|
|
1624
|
-
* @returns FullCourse
|
|
1625
|
-
* @throws ApiError
|
|
1626
|
-
*/
|
|
1627
|
-
static aiMentorOrgsUsersCourseCreationTasksCreateCourseOutlineCreate2(id: number, org: string, userId: string, formData: CourseCreationTask): CancelablePromise<FullCourse>;
|
|
1628
|
-
/**
|
|
1629
|
-
* Kick start the course creation task.
|
|
1630
|
-
* This endpoint should be called once the files for a course creation task has
|
|
1631
|
-
* been successfully uploaded.
|
|
1632
|
-
*
|
|
1633
|
-
* ** Conditions Required **:
|
|
1634
|
-
* - The course creation task must be in a pending state or failed state.
|
|
1635
|
-
*
|
|
1636
|
-
* ** Response **:
|
|
1637
|
-
* - 200: The course creation task is successfully started.
|
|
1638
|
-
* - 400: The course creation task is not in a pending state.
|
|
1639
|
-
* @param id A unique integer value identifying this course creation task.
|
|
1640
|
-
* @param org
|
|
1641
|
-
* @param userId
|
|
1642
|
-
* @returns CourseCreationTask
|
|
1643
|
-
* @throws ApiError
|
|
1644
|
-
*/
|
|
1645
|
-
static aiMentorOrgsUsersCourseCreationTasksStartRetrieve2(id: number, org: string, userId: string): CancelablePromise<CourseCreationTask>;
|
|
1646
|
-
/**
|
|
1647
|
-
* API viewset for managing course units.
|
|
1648
|
-
*
|
|
1649
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1650
|
-
* units within course subsections, and generate content for them.
|
|
1651
|
-
*
|
|
1652
|
-
* Permissions:
|
|
1653
|
-
* - Restricted to platform administrators only
|
|
1654
|
-
* @param org
|
|
1655
|
-
* @param userId
|
|
1656
|
-
* @param course
|
|
1657
|
-
* @param ordering Which field to use when ordering the results.
|
|
1658
|
-
* @param page A page number within the paginated result set.
|
|
1659
|
-
* @param pageSize Number of results to return per page.
|
|
1660
|
-
* @param search A search term.
|
|
1661
|
-
* @param section
|
|
1662
|
-
* @param subsection
|
|
1663
|
-
* @param task
|
|
1664
|
-
* @returns PaginatedUnitList
|
|
1665
|
-
* @throws ApiError
|
|
1666
|
-
*/
|
|
1667
|
-
static aiMentorOrgsUsersCourseCreationUnitList(org: string, userId: string, course?: number, ordering?: string, page?: number, pageSize?: number, search?: string, section?: number, subsection?: number, task?: number): CancelablePromise<PaginatedUnitList>;
|
|
1668
|
-
/**
|
|
1669
|
-
* API viewset for managing course units.
|
|
1670
|
-
*
|
|
1671
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1672
|
-
* units within course subsections, and generate content for them.
|
|
1673
|
-
*
|
|
1674
|
-
* Permissions:
|
|
1675
|
-
* - Restricted to platform administrators only
|
|
1676
|
-
* @param org
|
|
1677
|
-
* @param userId
|
|
1678
|
-
* @param requestBody
|
|
1679
|
-
* @returns Unit
|
|
1680
|
-
* @throws ApiError
|
|
1681
|
-
*/
|
|
1682
|
-
static aiMentorOrgsUsersCourseCreationUnitCreate(org: string, userId: string, requestBody: Unit): CancelablePromise<Unit>;
|
|
1683
|
-
/**
|
|
1684
|
-
* API viewset for managing course units.
|
|
1685
|
-
*
|
|
1686
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1687
|
-
* units within course subsections, and generate content for them.
|
|
1688
|
-
*
|
|
1689
|
-
* Permissions:
|
|
1690
|
-
* - Restricted to platform administrators only
|
|
1691
|
-
* @param id A unique integer value identifying this unit.
|
|
1692
|
-
* @param org
|
|
1693
|
-
* @param userId
|
|
1694
|
-
* @returns Unit
|
|
1695
|
-
* @throws ApiError
|
|
1696
|
-
*/
|
|
1697
|
-
static aiMentorOrgsUsersCourseCreationUnitRetrieve(id: number, org: string, userId: string): CancelablePromise<Unit>;
|
|
1698
|
-
/**
|
|
1699
|
-
* API viewset for managing course units.
|
|
1700
|
-
*
|
|
1701
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1702
|
-
* units within course subsections, and generate content for them.
|
|
1703
|
-
*
|
|
1704
|
-
* Permissions:
|
|
1705
|
-
* - Restricted to platform administrators only
|
|
1706
|
-
* @param id A unique integer value identifying this unit.
|
|
1707
|
-
* @param org
|
|
1708
|
-
* @param userId
|
|
1709
|
-
* @param requestBody
|
|
1710
|
-
* @returns Unit
|
|
1711
|
-
* @throws ApiError
|
|
1712
|
-
*/
|
|
1713
|
-
static aiMentorOrgsUsersCourseCreationUnitUpdate(id: number, org: string, userId: string, requestBody: Unit): CancelablePromise<Unit>;
|
|
1714
|
-
/**
|
|
1715
|
-
* API viewset for managing course units.
|
|
1716
|
-
*
|
|
1717
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1718
|
-
* units within course subsections, and generate content for them.
|
|
1719
|
-
*
|
|
1720
|
-
* Permissions:
|
|
1721
|
-
* - Restricted to platform administrators only
|
|
1722
|
-
* @param id A unique integer value identifying this unit.
|
|
1723
|
-
* @param org
|
|
1724
|
-
* @param userId
|
|
1725
|
-
* @param requestBody
|
|
1726
|
-
* @returns Unit
|
|
1727
|
-
* @throws ApiError
|
|
1728
|
-
*/
|
|
1729
|
-
static aiMentorOrgsUsersCourseCreationUnitPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedUnit): CancelablePromise<Unit>;
|
|
1730
|
-
/**
|
|
1731
|
-
* API viewset for managing course units.
|
|
1732
|
-
*
|
|
1733
|
-
* This viewset allows platform administrators to retrieve and manage
|
|
1734
|
-
* units within course subsections, and generate content for them.
|
|
1735
|
-
*
|
|
1736
|
-
* Permissions:
|
|
1737
|
-
* - Restricted to platform administrators only
|
|
1738
|
-
* @param id A unique integer value identifying this unit.
|
|
1739
|
-
* @param org
|
|
1740
|
-
* @param userId
|
|
1741
|
-
* @returns void
|
|
1742
|
-
* @throws ApiError
|
|
1743
|
-
*/
|
|
1744
|
-
static aiMentorOrgsUsersCourseCreationUnitDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
|
|
1745
|
-
/**
|
|
1746
|
-
* Generate draft content for a specific unit.
|
|
1747
|
-
*
|
|
1748
|
-
* This action starts a background task to create draft content
|
|
1749
|
-
* for the specified unit using AI.
|
|
1750
|
-
*
|
|
1751
|
-
* Args:
|
|
1752
|
-
* request: The HTTP request.
|
|
1753
|
-
* pk: The primary key of the unit to generate content for.
|
|
1754
|
-
*
|
|
1755
|
-
* Returns:
|
|
1756
|
-
* Response: A confirmation that the content generation task has been started.
|
|
1757
|
-
*
|
|
1758
|
-
* Raises:
|
|
1759
|
-
* NotFound: If the specified unit does not exist.
|
|
1760
|
-
* @param id A unique integer value identifying this unit.
|
|
1761
|
-
* @param org
|
|
1762
|
-
* @param userId
|
|
1763
|
-
* @returns any Content creation started successfully
|
|
1764
|
-
* @throws ApiError
|
|
1765
|
-
*/
|
|
1766
|
-
static aiMentorOrgsUsersCourseCreationUnitDraftContentRetrieve(id: number, org: string, userId: string): CancelablePromise<any>;
|
|
1767
|
-
/**
|
|
1768
|
-
* Generate draft content for a specific unit.
|
|
1769
|
-
*
|
|
1770
|
-
* This action starts a background task to create draft content
|
|
1771
|
-
* for the specified unit using AI.
|
|
1772
|
-
*
|
|
1773
|
-
* Args:
|
|
1774
|
-
* request: The HTTP request.
|
|
1775
|
-
* pk: The primary key of the unit to generate content for.
|
|
1776
|
-
*
|
|
1777
|
-
* Returns:
|
|
1778
|
-
* Response: A confirmation that the content generation task has been started.
|
|
1779
|
-
*
|
|
1780
|
-
* Raises:
|
|
1781
|
-
* NotFound: If the specified unit does not exist.
|
|
1782
|
-
* @param id A unique integer value identifying this unit.
|
|
1783
|
-
* @param org
|
|
1784
|
-
* @param userId
|
|
1785
|
-
* @param requestBody
|
|
1786
|
-
* @returns any Content creation started successfully
|
|
1787
|
-
* @throws ApiError
|
|
1788
|
-
*/
|
|
1789
|
-
static aiMentorOrgsUsersCourseCreationUnitDraftContentCreate(id: number, org: string, userId: string, requestBody: Unit): CancelablePromise<any>;
|
|
1790
|
-
/**
|
|
1791
|
-
* Create a new mentor using the wizard interface.
|
|
1792
|
-
*
|
|
1793
|
-
* Args:
|
|
1794
|
-
* request: The HTTP request containing the mentor data.
|
|
1795
|
-
* org: The organization/tenant identifier.
|
|
1796
|
-
* user_id: The ID of the user creating the mentor.
|
|
1797
|
-
*
|
|
1798
|
-
* Returns:
|
|
1799
|
-
* Response: The created mentor.
|
|
1800
|
-
*
|
|
1801
|
-
* Raises:
|
|
1802
|
-
* BadRequest: If the provided data is invalid.
|
|
1803
|
-
* @param org
|
|
1804
|
-
* @param userId
|
|
1805
|
-
* @param requestBody
|
|
1806
|
-
* @returns Mentor
|
|
1807
|
-
* @throws ApiError
|
|
1808
|
-
*/
|
|
1809
|
-
static aiMentorOrgsUsersCreateMentorWizardCreate(org: string, userId: string, requestBody: MentorWizard): CancelablePromise<Mentor>;
|
|
1810
|
-
/**
|
|
1811
|
-
* Retrieve custom instructions for a specific user.
|
|
1812
|
-
*
|
|
1813
|
-
* Args:
|
|
1814
|
-
* request: The HTTP request.
|
|
1815
|
-
* org: The organization/tenant identifier.
|
|
1816
|
-
* user_id: The ID of the user to retrieve custom instructions for.
|
|
1817
|
-
*
|
|
1818
|
-
* Returns:
|
|
1819
|
-
* Response: The custom instructions for the user.
|
|
1820
|
-
*
|
|
1821
|
-
* Raises:
|
|
1822
|
-
* NotFound: If no custom instructions exist for the user.
|
|
1823
|
-
* @param org
|
|
1824
|
-
* @param userId
|
|
1825
|
-
* @returns CustomInstructionResponse
|
|
1826
|
-
* @throws ApiError
|
|
1827
|
-
*/
|
|
1828
|
-
static aiMentorOrgsUsersCustomInstructionRetrieve(org: string, userId: string): CancelablePromise<CustomInstructionResponse>;
|
|
1829
|
-
/**
|
|
1830
|
-
* Create a new custom instruction for a user.
|
|
1831
|
-
*
|
|
1832
|
-
* Args:
|
|
1833
|
-
* request: The HTTP request containing the custom instruction data.
|
|
1834
|
-
* org: The organization/tenant identifier.
|
|
1835
|
-
* user_id: The ID of the user to create custom instructions for.
|
|
1836
|
-
*
|
|
1837
|
-
* Returns:
|
|
1838
|
-
* Response: The created custom instruction.
|
|
1839
|
-
*
|
|
1840
|
-
* Raises:
|
|
1841
|
-
* BadRequest: If the provided data is invalid.
|
|
1842
|
-
* @param org
|
|
1843
|
-
* @param userId
|
|
1844
|
-
* @param requestBody
|
|
1845
|
-
* @returns CustomInstructionResponse
|
|
1846
|
-
* @throws ApiError
|
|
1847
|
-
*/
|
|
1848
|
-
static aiMentorOrgsUsersCustomInstructionCreate(org: string, userId: string, requestBody?: CustomInstructionResponse): CancelablePromise<CustomInstructionResponse>;
|
|
1849
|
-
/**
|
|
1850
|
-
* Update an existing custom instruction for a user.
|
|
1851
|
-
*
|
|
1852
|
-
* Args:
|
|
1853
|
-
* request: The HTTP request containing the updated custom instruction data.
|
|
1854
|
-
* org: The organization/tenant identifier.
|
|
1855
|
-
* user_id: The ID of the user to update custom instructions for.
|
|
1856
|
-
*
|
|
1857
|
-
* Returns:
|
|
1858
|
-
* Response: The updated custom instruction.
|
|
1859
|
-
*
|
|
1860
|
-
* Raises:
|
|
1861
|
-
* BadRequest: If the provided data is invalid.
|
|
1862
|
-
* NotFound: If no custom instruction exists for the user.
|
|
1863
|
-
* @param org
|
|
1864
|
-
* @param userId
|
|
1865
|
-
* @param requestBody
|
|
1866
|
-
* @returns CustomInstructionResponse
|
|
1867
|
-
* @throws ApiError
|
|
1868
|
-
*/
|
|
1869
|
-
static aiMentorOrgsUsersCustomInstructionUpdate(org: string, userId: string, requestBody?: CustomInstructionResponse): CancelablePromise<CustomInstructionResponse>;
|
|
1870
|
-
/**
|
|
1871
|
-
* Retrieves the chat history for a user if the export task is ready.
|
|
1872
|
-
*
|
|
1873
|
-
* This Endpoint to download user chathistory.
|
|
1874
|
-
*
|
|
1875
|
-
* Accessible to tenant admins and students.
|
|
1876
|
-
*
|
|
1877
|
-
* Returns:
|
|
1878
|
-
*
|
|
1879
|
-
* 200: When task is not ready.
|
|
1880
|
-
*
|
|
1881
|
-
* 200: chat history object
|
|
1882
|
-
*
|
|
1883
|
-
* 400: When data is not valid.
|
|
1884
|
-
* @param org
|
|
1885
|
-
* @param taskId
|
|
1886
|
-
* @param userId
|
|
1887
|
-
* @param toCsv Choose download in csv or not
|
|
1888
|
-
* @returns ChatHistoryItem
|
|
1889
|
-
* @throws ApiError
|
|
1890
|
-
*/
|
|
1891
|
-
static aiMentorOrgsUsersDownloadsTasksRetrieve(org: string, taskId: string, userId: string, toCsv?: boolean): CancelablePromise<ChatHistoryItem>;
|
|
1892
|
-
/**
|
|
1893
|
-
* Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with.
|
|
1894
|
-
* This information is passed to the corresponding mentor so the mentor has context information
|
|
1895
|
-
* about the course and unit that the user last interracted with.
|
|
1896
|
-
*
|
|
1897
|
-
* There can be only one UserEdxMemory instance per student and course_id.
|
|
1898
|
-
*
|
|
1899
|
-
* Url Args:
|
|
1900
|
-
* org (str): The organization's platform key.
|
|
1901
|
-
* user_id (str): The username identifier of the individual.
|
|
1902
|
-
*
|
|
1903
|
-
* Returns:
|
|
1904
|
-
*
|
|
1905
|
-
* 200: A paginated list of UserEdxMemory objects
|
|
1906
|
-
*
|
|
1907
|
-
* Examples:
|
|
1908
|
-
*
|
|
1909
|
-
* - List all memories
|
|
1910
|
-
* GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/
|
|
1911
|
-
*
|
|
1912
|
-
* Request: None
|
|
1913
|
-
* Response: {
|
|
1914
|
-
* "count": 0,
|
|
1915
|
-
* "next": null,
|
|
1916
|
-
* "previous": null,
|
|
1917
|
-
* "results": [{
|
|
1918
|
-
* "student": 1,
|
|
1919
|
-
* "course_id": "course-v1:main+CARBON+2024_Fall",
|
|
1920
|
-
* "data": {},
|
|
1921
|
-
* "date_created": "2024-06-25T15:30:26.257140",
|
|
1922
|
-
* "last_modified": "2024-06-25T15:30:26.257140"
|
|
1923
|
-
* }]
|
|
1924
|
-
* }
|
|
1925
|
-
* - Get a single UserEdxMemory object
|
|
1926
|
-
* GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/
|
|
1927
|
-
*
|
|
1928
|
-
* Request: None
|
|
1929
|
-
* Response: {
|
|
1930
|
-
* "student": 1,
|
|
1931
|
-
* "course_id": "course-v1:main+CARBON+2024_Fall",
|
|
1932
|
-
* "data": {},
|
|
1933
|
-
* "date_created": "2024-06-25T15:30:26.257140",
|
|
1934
|
-
* "last_modified": "2024-06-25T15:30:26.257140"
|
|
1935
|
-
* }
|
|
1936
|
-
* @param org
|
|
1937
|
-
* @param userId
|
|
1938
|
-
* @param courseId
|
|
1939
|
-
* @param ordering Which field to use when ordering the results.
|
|
1940
|
-
* @param page A page number within the paginated result set.
|
|
1941
|
-
* @param pageSize Number of results to return per page.
|
|
1942
|
-
* @param student edX user ID
|
|
1943
|
-
* @param username
|
|
1944
|
-
* @returns PaginatedUserEdxMemoryList
|
|
1945
|
-
* @throws ApiError
|
|
1946
|
-
*/
|
|
1947
|
-
static aiMentorOrgsUsersEdxMemoryList(org: string, userId: string, courseId?: string, ordering?: string, page?: number, pageSize?: number, student?: number, username?: string): CancelablePromise<PaginatedUserEdxMemoryList>;
|
|
1948
|
-
/**
|
|
1949
|
-
* Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with.
|
|
1950
|
-
* This information is passed to the corresponding mentor so the mentor has context information
|
|
1951
|
-
* about the course and unit that the user last interracted with.
|
|
1952
|
-
*
|
|
1953
|
-
* There can be only one UserEdxMemory instance per student and course_id.
|
|
1954
|
-
*
|
|
1955
|
-
* Url Args:
|
|
1956
|
-
* org (str): The organization's platform key.
|
|
1957
|
-
* user_id (str): The username identifier of the individual.
|
|
1958
|
-
*
|
|
1959
|
-
* Returns:
|
|
1960
|
-
*
|
|
1961
|
-
* 200: A paginated list of UserEdxMemory objects
|
|
1962
|
-
*
|
|
1963
|
-
* Examples:
|
|
1964
|
-
*
|
|
1965
|
-
* - List all memories
|
|
1966
|
-
* GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/
|
|
1967
|
-
*
|
|
1968
|
-
* Request: None
|
|
1969
|
-
* Response: {
|
|
1970
|
-
* "count": 0,
|
|
1971
|
-
* "next": null,
|
|
1972
|
-
* "previous": null,
|
|
1973
|
-
* "results": [{
|
|
1974
|
-
* "student": 1,
|
|
1975
|
-
* "course_id": "course-v1:main+CARBON+2024_Fall",
|
|
1976
|
-
* "data": {},
|
|
1977
|
-
* "date_created": "2024-06-25T15:30:26.257140",
|
|
1978
|
-
* "last_modified": "2024-06-25T15:30:26.257140"
|
|
1979
|
-
* }]
|
|
1980
|
-
* }
|
|
1981
|
-
* - Get a single UserEdxMemory object
|
|
1982
|
-
* GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/
|
|
1983
|
-
*
|
|
1984
|
-
* Request: None
|
|
1985
|
-
* Response: {
|
|
1986
|
-
* "student": 1,
|
|
1987
|
-
* "course_id": "course-v1:main+CARBON+2024_Fall",
|
|
1988
|
-
* "data": {},
|
|
1989
|
-
* "date_created": "2024-06-25T15:30:26.257140",
|
|
1990
|
-
* "last_modified": "2024-06-25T15:30:26.257140"
|
|
1991
|
-
* }
|
|
1992
|
-
* @param id A unique integer value identifying this user edx memory.
|
|
1993
|
-
* @param org
|
|
1994
|
-
* @param userId
|
|
1995
|
-
* @returns UserEdxMemory
|
|
1996
|
-
* @throws ApiError
|
|
1997
|
-
*/
|
|
1998
|
-
static aiMentorOrgsUsersEdxMemoryRetrieve(id: number, org: string, userId: string): CancelablePromise<UserEdxMemory>;
|
|
1999
|
-
/**
|
|
2000
|
-
* Endpoints to fetch and delete Edx stored Memory information stored for a user and a corresponding edx course they have interracted with.
|
|
2001
|
-
* This information is passed to the corresponding mentor so the mentor has context information
|
|
2002
|
-
* about the course and unit that the user last interracted with.
|
|
2003
|
-
*
|
|
2004
|
-
* There can be only one UserEdxMemory instance per student and course_id.
|
|
2005
|
-
*
|
|
2006
|
-
* Url Args:
|
|
2007
|
-
* org (str): The organization's platform key.
|
|
2008
|
-
* user_id (str): The username identifier of the individual.
|
|
2009
|
-
*
|
|
2010
|
-
* Returns:
|
|
2011
|
-
*
|
|
2012
|
-
* 200: A paginated list of UserEdxMemory objects
|
|
2013
|
-
*
|
|
2014
|
-
* Examples:
|
|
2015
|
-
*
|
|
2016
|
-
* - List all memories
|
|
2017
|
-
* GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/
|
|
2018
|
-
*
|
|
2019
|
-
* Request: None
|
|
2020
|
-
* Response: {
|
|
2021
|
-
* "count": 0,
|
|
2022
|
-
* "next": null,
|
|
2023
|
-
* "previous": null,
|
|
2024
|
-
* "results": [{
|
|
2025
|
-
* "student": 1,
|
|
2026
|
-
* "course_id": "course-v1:main+CARBON+2024_Fall",
|
|
2027
|
-
* "data": {},
|
|
2028
|
-
* "date_created": "2024-06-25T15:30:26.257140",
|
|
2029
|
-
* "last_modified": "2024-06-25T15:30:26.257140"
|
|
2030
|
-
* }]
|
|
2031
|
-
* }
|
|
2032
|
-
* - Get a single UserEdxMemory object
|
|
2033
|
-
* GET: /api/ai-mentor/orgs/main/users/johndoe/edx-memory/1/
|
|
2034
|
-
*
|
|
2035
|
-
* Request: None
|
|
2036
|
-
* Response: {
|
|
2037
|
-
* "student": 1,
|
|
2038
|
-
* "course_id": "course-v1:main+CARBON+2024_Fall",
|
|
2039
|
-
* "data": {},
|
|
2040
|
-
* "date_created": "2024-06-25T15:30:26.257140",
|
|
2041
|
-
* "last_modified": "2024-06-25T15:30:26.257140"
|
|
2042
|
-
* }
|
|
2043
|
-
* @param id A unique integer value identifying this user edx memory.
|
|
2044
|
-
* @param org
|
|
2045
|
-
* @param userId
|
|
2046
|
-
* @returns void
|
|
2047
|
-
* @throws ApiError
|
|
2048
|
-
*/
|
|
2049
|
-
static aiMentorOrgsUsersEdxMemoryDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
|
|
2050
|
-
/**
|
|
2051
|
-
* Retrieve a list of Elevenlabs voices available to a user.
|
|
2052
|
-
*
|
|
2053
|
-
* This endpoint returns both custom voices created by the user
|
|
2054
|
-
* and premade voices available to all users.
|
|
2055
|
-
*
|
|
2056
|
-
* Args:
|
|
2057
|
-
* request: The HTTP request.
|
|
2058
|
-
* org: The organization/tenant identifier.
|
|
2059
|
-
* user_id: The ID of the user to retrieve voices for.
|
|
2060
|
-
*
|
|
2061
|
-
* Returns:
|
|
2062
|
-
* Response: A list of available Elevenlabs voices.
|
|
2063
|
-
*
|
|
2064
|
-
* Raises:
|
|
2065
|
-
* NotFound: If the specified user does not exist.
|
|
2066
|
-
* @param org
|
|
2067
|
-
* @param userId
|
|
2068
|
-
* @returns ElevenlabsCustomVoiceResponse
|
|
2069
|
-
* @throws ApiError
|
|
2070
|
-
*/
|
|
2071
|
-
static aiMentorOrgsUsersElevenlabsVoiceList(org: string, userId: string): CancelablePromise<Array<ElevenlabsCustomVoiceResponse>>;
|
|
2072
|
-
/**
|
|
2073
|
-
* Create a new custom Elevenlabs voice.
|
|
2074
|
-
*
|
|
2075
|
-
* This endpoint allows users to upload audio files to create a custom voice
|
|
2076
|
-
* that can be used with the Elevenlabs text-to-speech service.
|
|
2077
|
-
*
|
|
2078
|
-
* Note: The audio files' total length should be longer than 1 minute and
|
|
2079
|
-
* the total size should be smaller than 11 MiB.
|
|
2080
|
-
*
|
|
2081
|
-
* Args:
|
|
2082
|
-
* request: The HTTP request containing the voice name and audio files.
|
|
2083
|
-
* org: The organization/tenant identifier.
|
|
2084
|
-
* user_id: The ID of the user creating the voice.
|
|
2085
|
-
*
|
|
2086
|
-
* Returns:
|
|
2087
|
-
* Response: The created voice configuration.
|
|
2088
|
-
*
|
|
2089
|
-
* Raises:
|
|
2090
|
-
* BadRequest: If the provided data is invalid, credentials are not found, or there's an API error.
|
|
2091
|
-
* @param org
|
|
2092
|
-
* @param userId
|
|
2093
|
-
* @param formData
|
|
2094
|
-
* @returns ElevenlabsCustomVoiceResponse
|
|
2095
|
-
* @throws ApiError
|
|
2096
|
-
*/
|
|
2097
|
-
static aiMentorOrgsUsersElevenlabsVoiceCreate(org: string, userId: string, formData: ElevenlabsCustomVoice): CancelablePromise<ElevenlabsCustomVoiceResponse>;
|
|
2098
|
-
/**
|
|
2099
|
-
* Delete an existing Elevenlabs voice configuration.
|
|
2100
|
-
*
|
|
2101
|
-
* This endpoint removes a custom voice configuration both from the local database
|
|
2102
|
-
* and from the Elevenlabs remote API if applicable.
|
|
2103
|
-
*
|
|
2104
|
-
* Args:
|
|
2105
|
-
* request: The HTTP request.
|
|
2106
|
-
* org: The organization/tenant identifier.
|
|
2107
|
-
* user_id: The ID of the user who owns the voice.
|
|
2108
|
-
* voice_name: The name of the voice to delete.
|
|
2109
|
-
*
|
|
2110
|
-
* Returns:
|
|
2111
|
-
* Response: A confirmation of the deletion.
|
|
2112
|
-
*
|
|
2113
|
-
* Raises:
|
|
2114
|
-
* BadRequest: If the Elevenlabs credentials are not found or there's an API error.
|
|
2115
|
-
* @param org
|
|
2116
|
-
* @param userId
|
|
2117
|
-
* @param voiceName
|
|
2118
|
-
* @returns any Voice successfully deleted
|
|
2119
|
-
* @throws ApiError
|
|
2120
|
-
*/
|
|
2121
|
-
static aiMentorOrgsUsersElevenlabsVoiceDestroy(org: string, userId: string, voiceName: string): CancelablePromise<any>;
|
|
2122
|
-
/**
|
|
2123
|
-
* Initiates a background task to export the user's chat history.
|
|
2124
|
-
*
|
|
2125
|
-
* Returns:
|
|
2126
|
-
*
|
|
2127
|
-
* 200: task id.
|
|
2128
|
-
* @param org
|
|
2129
|
-
* @param userId
|
|
2130
|
-
* @returns TaskView
|
|
2131
|
-
* @throws ApiError
|
|
2132
|
-
*/
|
|
2133
|
-
static aiMentorOrgsUsersExportChathistoryCreate(org: string, userId: string): CancelablePromise<TaskView>;
|
|
2134
|
-
/**
|
|
2135
|
-
* Retrieve the count of free usage credits available to a user.
|
|
2136
|
-
*
|
|
2137
|
-
* Args:
|
|
2138
|
-
* request: The HTTP request.
|
|
2139
|
-
* org: The organization/tenant identifier.
|
|
2140
|
-
* user_id: The ID of the user to check free usage for.
|
|
2141
|
-
*
|
|
2142
|
-
* Returns:
|
|
2143
|
-
* Response: The count of free usage credits available.
|
|
2144
|
-
*
|
|
2145
|
-
* Raises:
|
|
2146
|
-
* NotFound: If the specified user does not exist.
|
|
2147
|
-
* @param org
|
|
2148
|
-
* @param userId
|
|
2149
|
-
* @returns FreeUsageCount
|
|
2150
|
-
* @throws ApiError
|
|
2151
|
-
*/
|
|
2152
|
-
static aiMentorOrgsUsersFreeUsageCountRetrieve(org: string, userId: string): CancelablePromise<FreeUsageCount>;
|
|
2153
|
-
/**
|
|
2154
|
-
* List all MCP servers.
|
|
2155
|
-
*
|
|
2156
|
-
* Returns a paginated list of MCP servers that can be filtered by platform
|
|
2157
|
-
* and searched by name or URL.
|
|
2158
|
-
* @param org
|
|
2159
|
-
* @param userId
|
|
2160
|
-
* @param page A page number within the paginated result set.
|
|
2161
|
-
* @param pageSize Number of results to return per page.
|
|
2162
|
-
* @param platform
|
|
2163
|
-
* @param search A search term.
|
|
2164
|
-
* @returns PaginatedMCPServerList
|
|
2165
|
-
* @throws ApiError
|
|
2166
|
-
*/
|
|
2167
|
-
static aiMentorOrgsUsersMcpServersList(org: string, userId: string, page?: number, pageSize?: number, platform?: number, search?: string): CancelablePromise<PaginatedMCPServerList>;
|
|
2168
|
-
/**
|
|
2169
|
-
* ViewSet for MCP Servers.
|
|
2170
|
-
*
|
|
2171
|
-
* Allows platform admins to list, create, retrieve, update, and delete MCP servers.
|
|
2172
|
-
*
|
|
2173
|
-
* Permissions:
|
|
2174
|
-
* - Accessible to tenant admins.
|
|
2175
|
-
* @param org
|
|
2176
|
-
* @param userId
|
|
2177
|
-
* @param requestBody
|
|
2178
|
-
* @returns MCPServer
|
|
2179
|
-
* @throws ApiError
|
|
2180
|
-
*/
|
|
2181
|
-
static aiMentorOrgsUsersMcpServersCreate(org: string, userId: string, requestBody: MCPServer): CancelablePromise<MCPServer>;
|
|
2182
|
-
/**
|
|
2183
|
-
* ViewSet for MCP Servers.
|
|
2184
|
-
*
|
|
2185
|
-
* Allows platform admins to list, create, retrieve, update, and delete MCP servers.
|
|
2186
|
-
*
|
|
2187
|
-
* Permissions:
|
|
2188
|
-
* - Accessible to tenant admins.
|
|
2189
|
-
* @param id A unique integer value identifying this mcp server.
|
|
2190
|
-
* @param org
|
|
2191
|
-
* @param userId
|
|
2192
|
-
* @returns MCPServer
|
|
2193
|
-
* @throws ApiError
|
|
2194
|
-
*/
|
|
2195
|
-
static aiMentorOrgsUsersMcpServersRetrieve(id: number, org: string, userId: string): CancelablePromise<MCPServer>;
|
|
2196
|
-
/**
|
|
2197
|
-
* ViewSet for MCP Servers.
|
|
2198
|
-
*
|
|
2199
|
-
* Allows platform admins to list, create, retrieve, update, and delete MCP servers.
|
|
2200
|
-
*
|
|
2201
|
-
* Permissions:
|
|
2202
|
-
* - Accessible to tenant admins.
|
|
2203
|
-
* @param id A unique integer value identifying this mcp server.
|
|
2204
|
-
* @param org
|
|
2205
|
-
* @param userId
|
|
2206
|
-
* @param requestBody
|
|
2207
|
-
* @returns MCPServer
|
|
2208
|
-
* @throws ApiError
|
|
2209
|
-
*/
|
|
2210
|
-
static aiMentorOrgsUsersMcpServersUpdate(id: number, org: string, userId: string, requestBody: MCPServer): CancelablePromise<MCPServer>;
|
|
2211
|
-
/**
|
|
2212
|
-
* ViewSet for MCP Servers.
|
|
2213
|
-
*
|
|
2214
|
-
* Allows platform admins to list, create, retrieve, update, and delete MCP servers.
|
|
2215
|
-
*
|
|
2216
|
-
* Permissions:
|
|
2217
|
-
* - Accessible to tenant admins.
|
|
2218
|
-
* @param id A unique integer value identifying this mcp server.
|
|
2219
|
-
* @param org
|
|
2220
|
-
* @param userId
|
|
2221
|
-
* @param requestBody
|
|
2222
|
-
* @returns MCPServer
|
|
2223
|
-
* @throws ApiError
|
|
2224
|
-
*/
|
|
2225
|
-
static aiMentorOrgsUsersMcpServersPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedMCPServer): CancelablePromise<MCPServer>;
|
|
2226
|
-
/**
|
|
2227
|
-
* ViewSet for MCP Servers.
|
|
2228
|
-
*
|
|
2229
|
-
* Allows platform admins to list, create, retrieve, update, and delete MCP servers.
|
|
2230
|
-
*
|
|
2231
|
-
* Permissions:
|
|
2232
|
-
* - Accessible to tenant admins.
|
|
2233
|
-
* @param id A unique integer value identifying this mcp server.
|
|
2234
|
-
* @param org
|
|
2235
|
-
* @param userId
|
|
2236
|
-
* @returns void
|
|
2237
|
-
* @throws ApiError
|
|
2238
|
-
*/
|
|
2239
|
-
static aiMentorOrgsUsersMcpServersDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
|
|
2240
|
-
/**
|
|
2241
|
-
* Retrieve details of a specific user chat feedback entry.
|
|
2242
|
-
*
|
|
2243
|
-
* Args:
|
|
2244
|
-
* request: The HTTP request.
|
|
2245
|
-
* org: The organization/tenant identifier.
|
|
2246
|
-
* feedback_id: The ID of the feedback entry to retrieve.
|
|
2247
|
-
*
|
|
2248
|
-
* Returns:
|
|
2249
|
-
* Response: The feedback entry details.
|
|
2250
|
-
*
|
|
2251
|
-
* Raises:
|
|
2252
|
-
* NotFound: If the specified feedback entry does not exist.
|
|
2253
|
-
* @param feedbackId
|
|
2254
|
-
* @param org
|
|
2255
|
-
* @param userId
|
|
2256
|
-
* @returns UserChatFeedback
|
|
2257
|
-
* @throws ApiError
|
|
2258
|
-
*/
|
|
2259
|
-
static aiMentorOrgsUsersMentorFeedbackRetrieve(feedbackId: number, org: string, userId: string): CancelablePromise<UserChatFeedback>;
|
|
2260
|
-
/**
|
|
2261
|
-
* Update an existing user chat feedback entry.
|
|
2262
|
-
*
|
|
2263
|
-
* Args:
|
|
2264
|
-
* request: The HTTP request containing the updated feedback data.
|
|
2265
|
-
* org: The organization/tenant identifier.
|
|
2266
|
-
* feedback_id: The ID of the feedback entry to update.
|
|
2267
|
-
*
|
|
2268
|
-
* Returns:
|
|
2269
|
-
* Response: The updated feedback entry.
|
|
2270
|
-
*
|
|
2271
|
-
* Raises:
|
|
2272
|
-
* NotFound: If the specified feedback entry does not exist.
|
|
2273
|
-
* BadRequest: If the provided data is invalid or the mentor does not exist.
|
|
2274
|
-
* @param feedbackId
|
|
2275
|
-
* @param org
|
|
2276
|
-
* @param userId
|
|
2277
|
-
* @param requestBody
|
|
2278
|
-
* @returns UserChatFeedback
|
|
2279
|
-
* @throws ApiError
|
|
2280
|
-
*/
|
|
2281
|
-
static aiMentorOrgsUsersMentorFeedbackUpdate(feedbackId: number, org: string, userId: string, requestBody: UserChatFeedback): CancelablePromise<UserChatFeedback>;
|
|
2282
|
-
/**
|
|
2283
|
-
* Create a new user chat feedback entry.
|
|
2284
|
-
*
|
|
2285
|
-
* Args:
|
|
2286
|
-
* request: The HTTP request containing the feedback data.
|
|
2287
|
-
* org: The organization/tenant identifier.
|
|
2288
|
-
*
|
|
2289
|
-
* Returns:
|
|
2290
|
-
* Response: The created feedback entry.
|
|
2291
|
-
*
|
|
2292
|
-
* Raises:
|
|
2293
|
-
* BadRequest: If the provided data is invalid or the mentor does not exist.
|
|
2294
|
-
* @param org
|
|
2295
|
-
* @param userId
|
|
2296
|
-
* @param requestBody
|
|
2297
|
-
* @returns UserChatFeedback
|
|
2298
|
-
* @throws ApiError
|
|
2299
|
-
*/
|
|
2300
|
-
static aiMentorOrgsUsersMentorFeedbackCreateCreate(org: string, userId: string, requestBody: UserChatFeedback): CancelablePromise<UserChatFeedback>;
|
|
2301
|
-
/**
|
|
2302
|
-
* View to create a mentor from a template
|
|
2303
|
-
*
|
|
2304
|
-
* Accessible to only tenant admins.
|
|
2305
|
-
* @param org
|
|
2306
|
-
* @param userId
|
|
2307
|
-
* @param requestBody
|
|
2308
|
-
* @returns Mentor
|
|
2309
|
-
* @throws ApiError
|
|
2310
|
-
*/
|
|
2311
|
-
static aiMentorOrgsUsersMentorFromTemplateCreate(org: string, userId: string, requestBody: MentorFromTemplateRequest): CancelablePromise<Mentor>;
|
|
2312
|
-
/**
|
|
2313
|
-
* Retrieve available LLMs for a user.
|
|
2314
|
-
* @param org
|
|
2315
|
-
* @param userId
|
|
2316
|
-
* @returns LLMResponse
|
|
2317
|
-
* @throws ApiError
|
|
2318
|
-
*/
|
|
2319
|
-
static aiMentorOrgsUsersMentorLlmsList(org: string, userId: string): CancelablePromise<Array<LLMResponse>>;
|
|
2320
|
-
/**
|
|
2321
|
-
* Retrieve the list of available mentor tools.
|
|
2322
|
-
* @param org
|
|
2323
|
-
* @param userId
|
|
2324
|
-
* @returns ToolResponse
|
|
2325
|
-
* @throws ApiError
|
|
2326
|
-
*/
|
|
2327
|
-
static aiMentorOrgsUsersMentorToolsList(org: string, userId: string): CancelablePromise<Array<ToolResponse>>;
|
|
2328
|
-
/**
|
|
2329
|
-
* View to create a mentor from a template with settings.
|
|
2330
|
-
*
|
|
2331
|
-
* Accessible to tenant admins only.
|
|
2332
|
-
* @param org
|
|
2333
|
-
* @param userId
|
|
2334
|
-
* @param formData
|
|
2335
|
-
* @returns Mentor
|
|
2336
|
-
* @throws ApiError
|
|
2337
|
-
*/
|
|
2338
|
-
static aiMentorOrgsUsersMentorWithSettingsCreate(org: string, userId: string, formData: MentorFromTemplateWithSettingRequest): CancelablePromise<Mentor>;
|
|
2339
|
-
/**
|
|
2340
|
-
* Retrieve the list of mentor audiences.
|
|
2341
|
-
*
|
|
2342
|
-
* Returns:
|
|
2343
|
-
* - 200: List of mentor audiences.
|
|
2344
|
-
* @param org
|
|
2345
|
-
* @param userId
|
|
2346
|
-
* @returns MentorAudience
|
|
2347
|
-
* @throws ApiError
|
|
2348
|
-
*/
|
|
2349
|
-
static aiMentorOrgsUsersMentorAudienceList(org: string, userId: string): CancelablePromise<Array<MentorAudience>>;
|
|
2350
|
-
/**
|
|
2351
|
-
* Create a new mentor audience.
|
|
2352
|
-
*
|
|
2353
|
-
* Accessible to tenant admins only.
|
|
2354
|
-
*
|
|
2355
|
-
* Returns:
|
|
2356
|
-
* - 201: Created mentor audience.
|
|
2357
|
-
* - 401: Unauthorized.
|
|
2358
|
-
* @param org
|
|
2359
|
-
* @param userId
|
|
2360
|
-
* @param requestBody
|
|
2361
|
-
* @returns MentorAudience
|
|
2362
|
-
* @throws ApiError
|
|
2363
|
-
*/
|
|
2364
|
-
static aiMentorOrgsUsersMentorAudienceCreate(org: string, userId: string, requestBody: MentorAudience): CancelablePromise<MentorAudience>;
|
|
2365
|
-
/**
|
|
2366
|
-
* Delete a mentor audience.
|
|
2367
|
-
*
|
|
2368
|
-
* Accessible to tenant admins only.
|
|
2369
|
-
*
|
|
2370
|
-
* Returns:
|
|
2371
|
-
* - 204: No content.
|
|
2372
|
-
* - 400: Bad request if audience name is missing.
|
|
2373
|
-
* - 404: Not found if audience does not exist.
|
|
2374
|
-
* - 401: Unauthorized.
|
|
2375
|
-
* @param org
|
|
2376
|
-
* @param userId
|
|
2377
|
-
* @returns void
|
|
2378
|
-
* @throws ApiError
|
|
2379
|
-
*/
|
|
2380
|
-
static aiMentorOrgsUsersMentorAudienceDestroy(org: string, userId: string): CancelablePromise<void>;
|
|
2381
|
-
/**
|
|
2382
|
-
* Retrieve a list of mentor categories.
|
|
2383
|
-
*
|
|
2384
|
-
* Returns:
|
|
2385
|
-
* 200: A list of mentor categories.
|
|
2386
|
-
* @param org
|
|
2387
|
-
* @param userId
|
|
2388
|
-
* @returns MentorCategory
|
|
2389
|
-
* @throws ApiError
|
|
2390
|
-
*/
|
|
2391
|
-
static aiMentorOrgsUsersMentorCategoriesList(org: string, userId: string): CancelablePromise<Array<MentorCategory>>;
|
|
2392
|
-
/**
|
|
2393
|
-
* Create a new mentor category.
|
|
2394
|
-
*
|
|
2395
|
-
* Accessible only to tenant admins.
|
|
2396
|
-
*
|
|
2397
|
-
* Returns:
|
|
2398
|
-
* 200: Details of the created mentor category.
|
|
2399
|
-
* @param org
|
|
2400
|
-
* @param userId
|
|
2401
|
-
* @param requestBody
|
|
2402
|
-
* @returns MentorCategory
|
|
2403
|
-
* @throws ApiError
|
|
2404
|
-
*/
|
|
2405
|
-
static aiMentorOrgsUsersMentorCategoriesCreate(org: string, userId: string, requestBody: MentorCategoryCreate): CancelablePromise<MentorCategory>;
|
|
2406
|
-
/**
|
|
2407
|
-
* Delete a mentor category.
|
|
2408
|
-
*
|
|
2409
|
-
* Accessible only to tenant admins.
|
|
2410
|
-
*
|
|
2411
|
-
* Returns:
|
|
2412
|
-
* 204: "No content" when Delete succeeded.
|
|
2413
|
-
* 400: Bad request data received
|
|
2414
|
-
* @param org
|
|
2415
|
-
* @param userId
|
|
2416
|
-
* @returns void
|
|
2417
|
-
* @throws ApiError
|
|
2418
|
-
*/
|
|
2419
|
-
static aiMentorOrgsUsersMentorCategoriesDestroy(org: string, userId: string): CancelablePromise<void>;
|
|
2420
|
-
/**
|
|
2421
|
-
* Seed initial mentors in a tenant.
|
|
2422
|
-
*
|
|
2423
|
-
* Args:
|
|
2424
|
-
* request: The HTTP request.
|
|
2425
|
-
* org: The organization/tenant identifier.
|
|
2426
|
-
* user_id: The ID of the user initiating the seeding.
|
|
2427
|
-
*
|
|
2428
|
-
* Returns:
|
|
2429
|
-
* Response: A success message with details about the seeded mentors.
|
|
2430
|
-
*
|
|
2431
|
-
* Raises:
|
|
2432
|
-
* BadRequest: If the seeding process fails.
|
|
2433
|
-
* @param org
|
|
2434
|
-
* @param userId
|
|
2435
|
-
* @returns SeedMentorsView
|
|
2436
|
-
* @throws ApiError
|
|
2437
|
-
*/
|
|
2438
|
-
static aiMentorOrgsUsersMentorSeedRetrieve(org: string, userId: string): CancelablePromise<SeedMentorsView>;
|
|
2439
|
-
/**
|
|
2440
|
-
* Retrieve details of a specific mentor by slug or name.
|
|
2441
|
-
* @param mentor
|
|
2442
|
-
* @param org
|
|
2443
|
-
* @param userId
|
|
2444
|
-
* @returns Mentor
|
|
2445
|
-
* @throws ApiError
|
|
2446
|
-
*/
|
|
2447
|
-
static aiMentorOrgsUsersMentorsRetrieve(mentor: string, org: string, userId: string): CancelablePromise<Mentor>;
|
|
2448
|
-
/**
|
|
2449
|
-
* Retrieve tools available for a particular mentor.
|
|
2450
|
-
* @param mentor
|
|
2451
|
-
* @param org
|
|
2452
|
-
* @param userId
|
|
2453
|
-
* @returns ToolResponse
|
|
2454
|
-
* @throws ApiError
|
|
2455
|
-
*/
|
|
2456
|
-
static aiMentorOrgsUsersMentorsAvailableToolsList(mentor: string, org: string, userId: string): CancelablePromise<Array<ToolResponse>>;
|
|
2457
|
-
/**
|
|
2458
|
-
* Generate IBL Call Pro authentication parameters for audio calls.
|
|
2459
|
-
*
|
|
2460
|
-
* This endpoint creates the necessary authentication tokens and parameters
|
|
2461
|
-
* for connecting to a IBL Call Pro room for audio communication with a mentor.
|
|
2462
|
-
*
|
|
2463
|
-
* Args:
|
|
2464
|
-
* request: The HTTP request object containing the required parameters.
|
|
2465
|
-
* org: The organization/tenant identifier.
|
|
2466
|
-
* user_id: The ID of the user requesting authentication.
|
|
2467
|
-
*
|
|
2468
|
-
* Returns:
|
|
2469
|
-
* Response: IBL Call Pro authentication parameters including URL, room name,
|
|
2470
|
-
* participant name, and authentication token.
|
|
2471
|
-
*
|
|
2472
|
-
* Raises:
|
|
2473
|
-
* ValidationError: If the request parameters are invalid.
|
|
2474
|
-
* BadRequest: If the IBL Call Pro credentials are not properly configured.
|
|
2475
|
-
* @param mentor
|
|
2476
|
-
* @param org
|
|
2477
|
-
* @param userId
|
|
2478
|
-
* @param requestBody
|
|
2479
|
-
* @returns CallAuthenticationResponse
|
|
2480
|
-
* @throws ApiError
|
|
2481
|
-
*/
|
|
2482
|
-
static aiMentorOrgsUsersMentorsCreateCallCredentialsCreate(mentor: string, org: string, userId: string, requestBody: CallAuthenticationRequest): CancelablePromise<CallAuthenticationResponse>;
|
|
2483
|
-
/**
|
|
2484
|
-
* Retrieve memory components for a specific mentor.
|
|
2485
|
-
*
|
|
2486
|
-
* Args:
|
|
2487
|
-
* request: The HTTP request.
|
|
2488
|
-
* org: The organization/tenant identifier.
|
|
2489
|
-
* user_id: The ID of the user making the request.
|
|
2490
|
-
* mentor: The identifier of the mentor to retrieve memory for.
|
|
2491
|
-
*
|
|
2492
|
-
* Returns:
|
|
2493
|
-
* Response: The memory components for the mentor.
|
|
2494
|
-
*
|
|
2495
|
-
* Raises:
|
|
2496
|
-
* NotFound: If the specified mentor or memory does not exist.
|
|
2497
|
-
* @param mentor
|
|
2498
|
-
* @param org
|
|
2499
|
-
* @param userId
|
|
2500
|
-
* @returns MemoryComponentResponse
|
|
2501
|
-
* @throws ApiError
|
|
2502
|
-
*/
|
|
2503
|
-
static aiMentorOrgsUsersMentorsCurrentMemoryRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MemoryComponentResponse>;
|
|
2504
|
-
/**
|
|
2505
|
-
* Update memory components for a specific mentor.
|
|
2506
|
-
*
|
|
2507
|
-
* Args:
|
|
2508
|
-
* request: The HTTP request containing the updated memory data.
|
|
2509
|
-
* org: The organization/tenant identifier.
|
|
2510
|
-
* user_id: The ID of the user making the request.
|
|
2511
|
-
* mentor: The identifier of the mentor to update memory for.
|
|
2512
|
-
*
|
|
2513
|
-
* Returns:
|
|
2514
|
-
* Response: The updated memory components for the mentor.
|
|
2515
|
-
*
|
|
2516
|
-
* Raises:
|
|
2517
|
-
* BadRequest: If the provided data is invalid.
|
|
2518
|
-
* NotFound: If the specified mentor does not exist.
|
|
2519
|
-
* @param mentor
|
|
2520
|
-
* @param org
|
|
2521
|
-
* @param userId
|
|
2522
|
-
* @param requestBody
|
|
2523
|
-
* @returns QuestionResponse
|
|
2524
|
-
* @throws ApiError
|
|
2525
|
-
*/
|
|
2526
|
-
static aiMentorOrgsUsersMentorsCurrentMemoryUpdate(mentor: string, org: string, userId: string, requestBody: QuestionRequest): CancelablePromise<QuestionResponse>;
|
|
2527
|
-
/**
|
|
2528
|
-
* Retrieve the current custom voice settings for a mentor.
|
|
2529
|
-
*
|
|
2530
|
-
* Args:
|
|
2531
|
-
* request: The HTTP request.
|
|
2532
|
-
* org: The organization/tenant identifier.
|
|
2533
|
-
* user_id: The ID of the user who owns the mentor link.
|
|
2534
|
-
* mentor: The unique identifier of the mentor.
|
|
2535
|
-
*
|
|
2536
|
-
* Returns:
|
|
2537
|
-
* Response: The current custom voice settings.
|
|
2538
|
-
*
|
|
2539
|
-
* Raises:
|
|
2540
|
-
* NotFound: If the specified mentor or student does not exist.
|
|
2541
|
-
* @param mentor
|
|
2542
|
-
* @param org
|
|
2543
|
-
* @param userId
|
|
2544
|
-
* @returns MentorCustomVoiceResponse
|
|
2545
|
-
* @throws ApiError
|
|
2546
|
-
*/
|
|
2547
|
-
static aiMentorOrgsUsersMentorsCustomVoiceRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MentorCustomVoiceResponse>;
|
|
2548
|
-
/**
|
|
2549
|
-
* Set a custom voice for a mentor.
|
|
2550
|
-
*
|
|
2551
|
-
* This endpoint allows setting a custom voice for a specific mentor,
|
|
2552
|
-
* either using the default voice provider or Elevenlabs.
|
|
2553
|
-
*
|
|
2554
|
-
* Args:
|
|
2555
|
-
* request: The HTTP request containing the voice provider and name.
|
|
2556
|
-
* org: The organization/tenant identifier.
|
|
2557
|
-
* user_id: The ID of the user who owns the mentor link.
|
|
2558
|
-
* mentor: The unique identifier of the mentor.
|
|
2559
|
-
*
|
|
2560
|
-
* Returns:
|
|
2561
|
-
* Response: The updated custom voice settings.
|
|
2562
|
-
*
|
|
2563
|
-
* Raises:
|
|
2564
|
-
* BadRequest: If the provided data is invalid or the voice does not exist.
|
|
2565
|
-
* NotFound: If the mentor or student does not exist.
|
|
2566
|
-
* @param mentor
|
|
2567
|
-
* @param org
|
|
2568
|
-
* @param userId
|
|
2569
|
-
* @param requestBody
|
|
2570
|
-
* @returns MentorCustomVoiceResponse
|
|
2571
|
-
* @throws ApiError
|
|
2572
|
-
*/
|
|
2573
|
-
static aiMentorOrgsUsersMentorsCustomVoiceCreate(mentor: string, org: string, userId: string, requestBody: MentorCustomVoice): CancelablePromise<MentorCustomVoiceResponse>;
|
|
2574
|
-
/**
|
|
2575
|
-
* Generate audio from text using a mentor's custom voice.
|
|
2576
|
-
*
|
|
2577
|
-
* This endpoint converts the provided text to speech using the
|
|
2578
|
-
* custom voice configured for the specified mentor.
|
|
2579
|
-
*
|
|
2580
|
-
* Args:
|
|
2581
|
-
* request: The HTTP request containing the text to convert.
|
|
2582
|
-
* org: The organization/tenant identifier.
|
|
2583
|
-
* user_id: The ID of the user who owns the mentor link.
|
|
2584
|
-
* mentor: The unique identifier of the mentor.
|
|
2585
|
-
*
|
|
2586
|
-
* Returns:
|
|
2587
|
-
* Response: An MP3 audio file of the synthesized speech.
|
|
2588
|
-
*
|
|
2589
|
-
* Raises:
|
|
2590
|
-
* BadRequest: If the text is empty, credentials are not found, or custom voice is not set.
|
|
2591
|
-
* NotFound: If the mentor or student does not exist.
|
|
2592
|
-
* @param mentor
|
|
2593
|
-
* @param org
|
|
2594
|
-
* @param userId
|
|
2595
|
-
* @param formData
|
|
2596
|
-
* @returns any MP3 audio file
|
|
2597
|
-
* @throws ApiError
|
|
2598
|
-
*/
|
|
2599
|
-
static aiMentorOrgsUsersMentorsCustomVoiceTtsCreate(mentor: string, org: string, userId: string, formData?: Record<string, any>): CancelablePromise<any>;
|
|
2600
|
-
/**
|
|
2601
|
-
* Update scenarios for a specific mentor.
|
|
2602
|
-
*
|
|
2603
|
-
* Args:
|
|
2604
|
-
* request: The HTTP request containing the updated scenarios.
|
|
2605
|
-
* org: The organization/tenant identifier.
|
|
2606
|
-
* user_id: The ID of the user making the request.
|
|
2607
|
-
* mentor: The identifier of the mentor to update scenarios for.
|
|
2608
|
-
*
|
|
2609
|
-
* Returns:
|
|
2610
|
-
* Response: The updated scenarios for the mentor.
|
|
2611
|
-
*
|
|
2612
|
-
* Raises:
|
|
2613
|
-
* BadRequest: If the provided data is invalid.
|
|
2614
|
-
* NotFound: If the specified mentor does not exist.
|
|
2615
|
-
* @param mentor
|
|
2616
|
-
* @param org
|
|
2617
|
-
* @param userId
|
|
2618
|
-
* @param requestBody
|
|
2619
|
-
* @returns MentorScenario
|
|
2620
|
-
* @throws ApiError
|
|
2621
|
-
*/
|
|
2622
|
-
static aiMentorOrgsUsersMentorsEditScenariosUpdate(mentor: string, org: string, userId: string, requestBody: MentorScenario): CancelablePromise<MentorScenario>;
|
|
2623
|
-
/**
|
|
2624
|
-
* Fork (clone) an existing mentor.
|
|
2625
|
-
*
|
|
2626
|
-
* Args:
|
|
2627
|
-
* request: The HTTP request containing the fork parameters.
|
|
2628
|
-
* org: The organization/tenant identifier.
|
|
2629
|
-
* mentor: The identifier of the mentor to fork.
|
|
2630
|
-
* user_id: The ID of the user initiating the fork.
|
|
2631
|
-
*
|
|
2632
|
-
* Returns:
|
|
2633
|
-
* Response: The newly created forked mentor.
|
|
2634
|
-
*
|
|
2635
|
-
* Raises:
|
|
2636
|
-
* BadRequest: If the provided data is invalid or the fork operation fails.
|
|
2637
|
-
* NotFound: If the specified mentor does not exist.
|
|
2638
|
-
* @param mentor
|
|
2639
|
-
* @param org
|
|
2640
|
-
* @param userId
|
|
2641
|
-
* @param requestBody
|
|
2642
|
-
* @returns Mentor
|
|
2643
|
-
* @throws ApiError
|
|
2644
|
-
*/
|
|
2645
|
-
static aiMentorOrgsUsersMentorsForkCreate(mentor: string, org: string, userId: string, requestBody: MentorFork): CancelablePromise<Mentor>;
|
|
2646
|
-
/**
|
|
2647
|
-
* Retrieve memory history entries for a specific mentor and user.
|
|
2648
|
-
*
|
|
2649
|
-
* Args:
|
|
2650
|
-
* request: The HTTP request.
|
|
2651
|
-
* org: The organization/tenant identifier.
|
|
2652
|
-
* user_id: The ID of the user to retrieve memory history for.
|
|
2653
|
-
* mentor: The identifier of the mentor to retrieve memory history for.
|
|
2654
|
-
*
|
|
2655
|
-
* Returns:
|
|
2656
|
-
* Response: The memory history entries for the mentor and user.
|
|
2657
|
-
*
|
|
2658
|
-
* Raises:
|
|
2659
|
-
* NotFound: If the specified mentor or memory history does not exist.
|
|
2660
|
-
* @param mentor
|
|
2661
|
-
* @param org
|
|
2662
|
-
* @param userId
|
|
2663
|
-
* @returns MemoryComponentMemoryDetail
|
|
2664
|
-
* @throws ApiError
|
|
2665
|
-
*/
|
|
2666
|
-
static aiMentorOrgsUsersMentorsHistoricalMemoryRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MemoryComponentMemoryDetail>;
|
|
2667
|
-
/**
|
|
2668
|
-
* Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
|
|
2669
|
-
* @param mentor
|
|
2670
|
-
* @param org
|
|
2671
|
-
* @param userId
|
|
2672
|
-
* @returns MemoryProgress
|
|
2673
|
-
* @throws ApiError
|
|
2674
|
-
*/
|
|
2675
|
-
static aiMentorOrgsUsersMentorsMemoryProgressRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MemoryProgress>;
|
|
2676
|
-
/**
|
|
2677
|
-
* Retrieve memory settings for a specific mentor.
|
|
2678
|
-
*
|
|
2679
|
-
* Args:
|
|
2680
|
-
* request: The HTTP request.
|
|
2681
|
-
* org: The organization/tenant identifier.
|
|
2682
|
-
* user_id: The ID of the user making the request.
|
|
2683
|
-
* mentor: The identifier of the mentor to retrieve settings for.
|
|
2684
|
-
*
|
|
2685
|
-
* Returns:
|
|
2686
|
-
* Response: The memory settings for the mentor.
|
|
2687
|
-
*
|
|
2688
|
-
* Raises:
|
|
2689
|
-
* NotFound: If the specified mentor or settings do not exist.
|
|
2690
|
-
* @param mentor
|
|
2691
|
-
* @param org
|
|
2692
|
-
* @param userId
|
|
2693
|
-
* @returns MentorMemorySettingsResponse
|
|
2694
|
-
* @throws ApiError
|
|
2695
|
-
*/
|
|
2696
|
-
static aiMentorOrgsUsersMentorsMemorySettingsRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MentorMemorySettingsResponse>;
|
|
2697
|
-
/**
|
|
2698
|
-
* Endpoint for mentor memory item settings.
|
|
2699
|
-
*
|
|
2700
|
-
* Accessible to platform admins and superusers.
|
|
2701
|
-
*
|
|
2702
|
-
* Returns:
|
|
2703
|
-
*
|
|
2704
|
-
* 200: Change mentor memory component item.
|
|
2705
|
-
*
|
|
2706
|
-
* 400: When request is not valid.
|
|
2707
|
-
* @param mentor
|
|
2708
|
-
* @param org
|
|
2709
|
-
* @param userId
|
|
2710
|
-
* @param requestBody
|
|
2711
|
-
* @returns MentorMemorySettingsResponse
|
|
2712
|
-
* @throws ApiError
|
|
2713
|
-
*/
|
|
2714
|
-
static aiMentorOrgsUsersMentorsMemorySettingsCreate(mentor: string, org: string, userId: string, requestBody?: MentorMemorySettingsRequest): CancelablePromise<MentorMemorySettingsResponse>;
|
|
2715
|
-
/**
|
|
2716
|
-
* Retrieve evaluation criteria for a specific mentor.
|
|
2717
|
-
*
|
|
2718
|
-
* Args:
|
|
2719
|
-
* request: The HTTP request.
|
|
2720
|
-
* org: The organization/tenant identifier.
|
|
2721
|
-
* user_id: The ID of the user making the request.
|
|
2722
|
-
* mentor: The identifier of the mentor to retrieve evaluations for.
|
|
2723
|
-
*
|
|
2724
|
-
* Returns:
|
|
2725
|
-
* Response: The evaluation criteria for the mentor.
|
|
2726
|
-
*
|
|
2727
|
-
* Raises:
|
|
2728
|
-
* NotFound: If the specified mentor or evaluations do not exist.
|
|
2729
|
-
* @param mentor
|
|
2730
|
-
* @param org
|
|
2731
|
-
* @param userId
|
|
2732
|
-
* @returns MentorEval
|
|
2733
|
-
* @throws ApiError
|
|
2734
|
-
*/
|
|
2735
|
-
static aiMentorOrgsUsersMentorsMentorEvalRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MentorEval>;
|
|
2736
|
-
/**
|
|
2737
|
-
* Create or update evaluation criteria for a specific mentor.
|
|
2738
|
-
*
|
|
2739
|
-
* Args:
|
|
2740
|
-
* request: The HTTP request containing the evaluation data.
|
|
2741
|
-
* org: The organization/tenant identifier.
|
|
2742
|
-
* user_id: The ID of the user making the request.
|
|
2743
|
-
* mentor: The identifier of the mentor to create/update evaluations for.
|
|
2744
|
-
*
|
|
2745
|
-
* Returns:
|
|
2746
|
-
* Response: The created or updated evaluation criteria.
|
|
2747
|
-
*
|
|
2748
|
-
* Raises:
|
|
2749
|
-
* BadRequest: If the provided data is invalid or the mentor does not exist.
|
|
2750
|
-
* @param mentor
|
|
2751
|
-
* @param org
|
|
2752
|
-
* @param userId
|
|
2753
|
-
* @param requestBody
|
|
2754
|
-
* @returns MentorEval
|
|
2755
|
-
* @throws ApiError
|
|
2756
|
-
*/
|
|
2757
|
-
static aiMentorOrgsUsersMentorsMentorEvalCreate(mentor: string, org: string, userId: string, requestBody?: MentorEvalRequest): CancelablePromise<MentorEval>;
|
|
2758
|
-
/**
|
|
2759
|
-
* Run an evaluation for a specific mentor.
|
|
2760
|
-
*
|
|
2761
|
-
* Args:
|
|
2762
|
-
* request: The HTTP request containing the evaluation ID.
|
|
2763
|
-
* org: The organization/tenant identifier.
|
|
2764
|
-
* user_id: The ID of the user making the request.
|
|
2765
|
-
* mentor: The identifier of the mentor to evaluate.
|
|
2766
|
-
*
|
|
2767
|
-
* Returns:
|
|
2768
|
-
* Response: The ID of the generated evaluation report.
|
|
2769
|
-
*
|
|
2770
|
-
* Raises:
|
|
2771
|
-
* BadRequest: If the evaluation ID is invalid or the mentor does not match.
|
|
2772
|
-
* @param mentor
|
|
2773
|
-
* @param org
|
|
2774
|
-
* @param userId
|
|
2775
|
-
* @param requestBody
|
|
2776
|
-
* @returns any Evaluation execution started successfully
|
|
2777
|
-
* @throws ApiError
|
|
2778
|
-
*/
|
|
2779
|
-
static aiMentorOrgsUsersMentorsMentorEvalExecutionCreate(mentor: string, org: string, userId: string, requestBody: RunMentorEval): CancelablePromise<any>;
|
|
2780
|
-
/**
|
|
2781
|
-
* Retrieve public mentor settings.
|
|
2782
|
-
*
|
|
2783
|
-
* Args:
|
|
2784
|
-
* request: HTTP request instance.
|
|
2785
|
-
* user_id: The ID of the user requesting settings.
|
|
2786
|
-
* mentor: The mentor identifier (name, slug, or unique_id).
|
|
2787
|
-
* org: The organization key.
|
|
2788
|
-
*
|
|
2789
|
-
* Returns:
|
|
2790
|
-
* Response containing the mentor settings or an error message.
|
|
2791
|
-
* @param mentor
|
|
2792
|
-
* @param org
|
|
2793
|
-
* @param userId
|
|
2794
|
-
* @returns MentorSettingsPublic
|
|
2795
|
-
* @throws ApiError
|
|
2796
|
-
*/
|
|
2797
|
-
static aiMentorOrgsUsersMentorsPublicSettingsRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MentorSettingsPublic>;
|
|
2798
|
-
/**
|
|
2799
|
-
* Retrieve a specific evaluation report.
|
|
2800
|
-
*
|
|
2801
|
-
* Args:
|
|
2802
|
-
* request: The HTTP request.
|
|
2803
|
-
* org: The organization/tenant identifier.
|
|
2804
|
-
* user_id: The ID of the user making the request.
|
|
2805
|
-
* mentor: The identifier of the mentor that was evaluated.
|
|
2806
|
-
* report_id: The ID of the evaluation report to retrieve.
|
|
2807
|
-
*
|
|
2808
|
-
* Returns:
|
|
2809
|
-
* Response: The detailed evaluation report.
|
|
2810
|
-
*
|
|
2811
|
-
* Raises:
|
|
2812
|
-
* BadRequest: If the report does not exist, does not match the mentor, or is still being generated.
|
|
2813
|
-
* @param mentor
|
|
2814
|
-
* @param org
|
|
2815
|
-
* @param reportId
|
|
2816
|
-
* @param userId
|
|
2817
|
-
* @returns MentorEvalReport
|
|
2818
|
-
* @throws ApiError
|
|
2819
|
-
*/
|
|
2820
|
-
static aiMentorOrgsUsersMentorsReportsMentorEvalReportRetrieve(mentor: string, org: string, reportId: number, userId: string): CancelablePromise<MentorEvalReport>;
|
|
2821
|
-
/**
|
|
2822
|
-
* Retrieve available scenarios for a specific mentor.
|
|
2823
|
-
*
|
|
2824
|
-
* Args:
|
|
2825
|
-
* request: The HTTP request.
|
|
2826
|
-
* org: The organization/tenant identifier.
|
|
2827
|
-
* user_id: The ID of the user making the request.
|
|
2828
|
-
* mentor: The identifier of the mentor to retrieve scenarios for.
|
|
2829
|
-
*
|
|
2830
|
-
* Returns:
|
|
2831
|
-
* Response: The available scenarios for the mentor.
|
|
2832
|
-
*
|
|
2833
|
-
* Raises:
|
|
2834
|
-
* NotFound: If the specified mentor or scenarios do not exist.
|
|
2835
|
-
* @param mentor
|
|
2836
|
-
* @param org
|
|
2837
|
-
* @param userId
|
|
2838
|
-
* @returns MentorScenario
|
|
2839
|
-
* @throws ApiError
|
|
2840
|
-
*/
|
|
2841
|
-
static aiMentorOrgsUsersMentorsScenariosRetrieve(mentor: string, org: string, userId: string): CancelablePromise<MentorScenario>;
|
|
2842
|
-
/**
|
|
2843
|
-
* Retrieve Mentor Settings
|
|
2844
|
-
* Fetch the settings of a mentor within an organization. Only accessible to tenant admins.
|
|
2845
|
-
* @param mentor
|
|
2846
|
-
* @param org
|
|
2847
|
-
* @param userId
|
|
2848
|
-
* @param departmentId Department to authorize users by
|
|
2849
|
-
* @returns MentorSettingsPublic
|
|
2850
|
-
* @throws ApiError
|
|
2851
|
-
*/
|
|
2852
|
-
static aiMentorOrgsUsersMentorsSettingsRetrieve(mentor: string, org: string, userId: string, departmentId?: number): CancelablePromise<MentorSettingsPublic>;
|
|
2853
|
-
/**
|
|
2854
|
-
* Update Mentor Settings
|
|
2855
|
-
* Update various mentor settings including system prompts, tool permissions, and UI configurations.
|
|
2856
|
-
* @param mentor
|
|
2857
|
-
* @param org
|
|
2858
|
-
* @param userId
|
|
2859
|
-
* @param departmentId Department to authorize users by
|
|
2860
|
-
* @param formData
|
|
2861
|
-
* @returns MentorSettings
|
|
2862
|
-
* @throws ApiError
|
|
2863
|
-
*/
|
|
2864
|
-
static aiMentorOrgsUsersMentorsSettingsUpdate(mentor: string, org: string, userId: string, departmentId?: number, formData?: MentorSettingsRequest): CancelablePromise<MentorSettings>;
|
|
2865
|
-
/**
|
|
2866
|
-
* Retrieve spaced repetition question statistics.
|
|
2867
|
-
*
|
|
2868
|
-
* Args:
|
|
2869
|
-
* request: The HTTP request.
|
|
2870
|
-
* org: The organization/tenant identifier.
|
|
2871
|
-
* user_id: The ID of the user to retrieve statistics for.
|
|
2872
|
-
* mentor: The unique identifier of the mentor.
|
|
2873
|
-
*
|
|
2874
|
-
* Returns:
|
|
2875
|
-
* Response: Statistics about the user's performance on spaced repetition questions.
|
|
2876
|
-
*
|
|
2877
|
-
* Raises:
|
|
2878
|
-
* NotFound: If the mentor or student does not exist.
|
|
2879
|
-
* @param mentor
|
|
2880
|
-
* @param org
|
|
2881
|
-
* @param userId
|
|
2882
|
-
* @returns SpacedRepetitionQuestionStats
|
|
2883
|
-
* @throws ApiError
|
|
2884
|
-
*/
|
|
2885
|
-
static aiMentorOrgsUsersMentorsSpacedRepetitionQuestionStatsRetrieve(mentor: string, org: string, userId: string): CancelablePromise<SpacedRepetitionQuestionStats>;
|
|
2886
|
-
/**
|
|
2887
|
-
* Retrieve a list of learning paths associated with a specific mentor and student.
|
|
2888
|
-
*
|
|
2889
|
-
* This endpoint uses the memory component to establish the learning context for a student
|
|
2890
|
-
* under the guidance of a mentor. It verifies that the provided organization identifier matches
|
|
2891
|
-
* the mentor's platform key, and then retrieves learning path tags associated with the student's
|
|
2892
|
-
* question cards. Each tag is annotated with the total number of question cards and the count of
|
|
2893
|
-
* cards with successful repetitions (i.e., correct answers). The learning paths are ordered by the
|
|
2894
|
-
* number of correct answers and limited to the top five entries.
|
|
2895
|
-
*
|
|
2896
|
-
* Args:
|
|
2897
|
-
* request: The HTTP request containing the necessary context.
|
|
2898
|
-
* org (str): The organization identifier/platform key.
|
|
2899
|
-
* user_id (str): The username of the student.
|
|
2900
|
-
* mentor (str): The unique identifier of the mentor.
|
|
2901
|
-
* *args: Additional positional arguments.
|
|
2902
|
-
* **kwargs: Additional keyword arguments.
|
|
2903
|
-
*
|
|
2904
|
-
* Returns:
|
|
2905
|
-
* Resp200onse: memory component detail infomrmation
|
|
2906
|
-
*
|
|
2907
|
-
* Raises:
|
|
2908
|
-
* NotFound: If the memory component for the specified mentor and student cannot be found,
|
|
2909
|
-
* or if the organization identifier does not match the mentor's platform key.
|
|
2910
|
-
* @param mentor
|
|
2911
|
-
* @param org
|
|
2912
|
-
* @param userId
|
|
2913
|
-
* @returns QuestionCardTag
|
|
2914
|
-
* @throws ApiError
|
|
2915
|
-
*/
|
|
2916
|
-
static aiMentorOrgsUsersMentorsSpacedRepetitionRecommendedPathsList(mentor: string, org: string, userId: string): CancelablePromise<Array<QuestionCardTag>>;
|
|
2917
|
-
/**
|
|
2918
|
-
* Set a specific learning path for spaced repetition.
|
|
2919
|
-
*
|
|
2920
|
-
* Args:
|
|
2921
|
-
* request: The HTTP request containing the learning path.
|
|
2922
|
-
* org: The organization/tenant identifier.
|
|
2923
|
-
* user_id: The ID of the user to set the learning path for.
|
|
2924
|
-
* mentor: The unique identifier of the mentor.
|
|
2925
|
-
*
|
|
2926
|
-
* Returns:
|
|
2927
|
-
* Response: The set learning path.
|
|
2928
|
-
*
|
|
2929
|
-
* Raises:
|
|
2930
|
-
* BadRequest: If the provided data is invalid.
|
|
2931
|
-
* NotFound: If the learning path, mentor, or student does not exist.
|
|
2932
|
-
* @param mentor
|
|
2933
|
-
* @param org
|
|
2934
|
-
* @param userId
|
|
2935
|
-
* @param requestBody
|
|
2936
|
-
* @returns SpacedRepetitionLearningPath
|
|
2937
|
-
* @throws ApiError
|
|
2938
|
-
*/
|
|
2939
|
-
static aiMentorOrgsUsersMentorsSpacedRepetitionRecommendedPathsUpdate(mentor: string, org: string, userId: string, requestBody: SpacedRepetitionLearningPath): CancelablePromise<SpacedRepetitionLearningPath>;
|
|
2940
|
-
/**
|
|
2941
|
-
* Endpoint for getting the star status of a mentor.
|
|
2942
|
-
*
|
|
2943
|
-
* Accessible to students and admins.
|
|
2944
|
-
*
|
|
2945
|
-
*
|
|
2946
|
-
* Returns:
|
|
2947
|
-
*
|
|
2948
|
-
* 200: Star status.
|
|
2949
|
-
*
|
|
2950
|
-
* 400: When request is not valid.
|
|
2951
|
-
* @param mentor
|
|
2952
|
-
* @param org
|
|
2953
|
-
* @param userId
|
|
2954
|
-
* @returns StarMentor
|
|
2955
|
-
* @throws ApiError
|
|
2956
|
-
*/
|
|
2957
|
-
static aiMentorOrgsUsersMentorsStarRetrieve(mentor: string, org: string, userId: string): CancelablePromise<StarMentor>;
|
|
2958
|
-
/**
|
|
2959
|
-
* Endpoint for starring a mentor.
|
|
2960
|
-
*
|
|
2961
|
-
* Accessible to students and admins.
|
|
2962
|
-
*
|
|
2963
|
-
*
|
|
2964
|
-
* Returns:
|
|
2965
|
-
*
|
|
2966
|
-
* 200: Star status.
|
|
2967
|
-
*
|
|
2968
|
-
* 400: When request is not valid.
|
|
2969
|
-
* @param mentor
|
|
2970
|
-
* @param org
|
|
2971
|
-
* @param userId
|
|
2972
|
-
* @returns StarMentor
|
|
2973
|
-
* @throws ApiError
|
|
2974
|
-
*/
|
|
2975
|
-
static aiMentorOrgsUsersMentorsStarCreate(mentor: string, org: string, userId: string): CancelablePromise<StarMentor>;
|
|
2976
|
-
/**
|
|
2977
|
-
* Remove a mentor from a user's starred list.
|
|
2978
|
-
*
|
|
2979
|
-
* Args:
|
|
2980
|
-
* request: The HTTP request.
|
|
2981
|
-
* org: The organization/tenant identifier.
|
|
2982
|
-
* user_id: The ID of the user unstarring the mentor.
|
|
2983
|
-
* mentor: The identifier of the mentor to unstar.
|
|
2984
|
-
*
|
|
2985
|
-
* Returns:
|
|
2986
|
-
* Response: The updated star status of the mentor.
|
|
2987
|
-
*
|
|
2988
|
-
* Raises:
|
|
2989
|
-
* NotFound: If the specified mentor or student does not exist.
|
|
2990
|
-
* BadRequest: If the request is invalid.
|
|
2991
|
-
* @param mentor
|
|
2992
|
-
* @param org
|
|
2993
|
-
* @param userId
|
|
2994
|
-
* @returns StarMentor
|
|
2995
|
-
* @throws ApiError
|
|
2996
|
-
*/
|
|
2997
|
-
static aiMentorOrgsUsersMentorsUnstarCreate(mentor: string, org: string, userId: string): CancelablePromise<StarMentor>;
|
|
2998
|
-
/**
|
|
2999
|
-
* Retrieve metadata for a mentor.
|
|
3000
|
-
*
|
|
3001
|
-
* Args:
|
|
3002
|
-
* request: The HTTP request.
|
|
3003
|
-
* org: The organization/tenant identifier.
|
|
3004
|
-
* user_id: The ID of the user making the request.
|
|
3005
|
-
*
|
|
3006
|
-
* Returns:
|
|
3007
|
-
* Response: The mentor metadata.
|
|
3008
|
-
*
|
|
3009
|
-
* Raises:
|
|
3010
|
-
* NotFound: If no metadata exists for the specified mentor.
|
|
3011
|
-
* @param org
|
|
3012
|
-
* @param userId
|
|
3013
|
-
* @returns MentorMetadata
|
|
3014
|
-
* @throws ApiError
|
|
3015
|
-
*/
|
|
3016
|
-
static aiMentorOrgsUsersMetadataRetrieve(org: string, userId: string): CancelablePromise<MentorMetadata>;
|
|
3017
|
-
/**
|
|
3018
|
-
* Endpoint to view and delete Moderation Logs for a tenant.
|
|
3019
|
-
*
|
|
3020
|
-
* These can be filtered by username, platform_key and mentor id
|
|
3021
|
-
*
|
|
3022
|
-
*
|
|
3023
|
-
* A search query can be conducted to search through the prompts and reason for the moderation catch event.
|
|
3024
|
-
* @param org
|
|
3025
|
-
* @param userId
|
|
3026
|
-
* @param mentor
|
|
3027
|
-
* @param ordering Which field to use when ordering the results.
|
|
3028
|
-
* @param page A page number within the paginated result set.
|
|
3029
|
-
* @param pageSize Number of results to return per page.
|
|
3030
|
-
* @param platformKey
|
|
3031
|
-
* @param search A search term.
|
|
3032
|
-
* @param targetSystem * `Safety System` - Safety System
|
|
3033
|
-
* * `Moderation System` - Moderation System
|
|
3034
|
-
* @param username
|
|
3035
|
-
* @returns PaginatedModerationLogList
|
|
3036
|
-
* @throws ApiError
|
|
3037
|
-
*/
|
|
3038
|
-
static aiMentorOrgsUsersModerationLogsList(org: string, userId: string, mentor?: number, ordering?: string, page?: number, pageSize?: number, platformKey?: string, search?: string, targetSystem?: 'Moderation System' | 'Safety System', username?: string): CancelablePromise<PaginatedModerationLogList>;
|
|
3039
|
-
/**
|
|
3040
|
-
* Endpoint to view and delete Moderation Logs for a tenant.
|
|
3041
|
-
*
|
|
3042
|
-
* These can be filtered by username, platform_key and mentor id
|
|
3043
|
-
*
|
|
3044
|
-
*
|
|
3045
|
-
* A search query can be conducted to search through the prompts and reason for the moderation catch event.
|
|
3046
|
-
* @param id A unique integer value identifying this moderation log.
|
|
3047
|
-
* @param org
|
|
3048
|
-
* @param userId
|
|
3049
|
-
* @returns ModerationLog
|
|
3050
|
-
* @throws ApiError
|
|
3051
|
-
*/
|
|
3052
|
-
static aiMentorOrgsUsersModerationLogsRetrieve(id: number, org: string, userId: string): CancelablePromise<ModerationLog>;
|
|
3053
|
-
/**
|
|
3054
|
-
* Endpoint to view and delete Moderation Logs for a tenant.
|
|
3055
|
-
*
|
|
3056
|
-
* These can be filtered by username, platform_key and mentor id
|
|
3057
|
-
*
|
|
3058
|
-
*
|
|
3059
|
-
* A search query can be conducted to search through the prompts and reason for the moderation catch event.
|
|
3060
|
-
* @param id A unique integer value identifying this moderation log.
|
|
3061
|
-
* @param org
|
|
3062
|
-
* @param userId
|
|
3063
|
-
* @returns void
|
|
3064
|
-
* @throws ApiError
|
|
3065
|
-
*/
|
|
3066
|
-
static aiMentorOrgsUsersModerationLogsDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
|
|
3067
|
-
/**
|
|
3068
|
-
* Endpoint to view logs for periodic agent runs.
|
|
3069
|
-
*
|
|
3070
|
-
* These logs contain the full mentor output for each run for debugging.
|
|
3071
|
-
* Logs are ordered from newest to oldest. However this can be changed.
|
|
3072
|
-
*
|
|
3073
|
-
* You can also filter logs for a PeriodicAgent by passing the `periodic_agent` query parameter in the URL.
|
|
3074
|
-
* @param org
|
|
3075
|
-
* @param userId
|
|
3076
|
-
* @param ordering Which field to use when ordering the results.
|
|
3077
|
-
* @param page A page number within the paginated result set.
|
|
3078
|
-
* @param pageSize Number of results to return per page.
|
|
3079
|
-
* @param parentMentorId
|
|
3080
|
-
* @param parentSessionId
|
|
3081
|
-
* @param periodicAgent
|
|
3082
|
-
* @param search A search term.
|
|
3083
|
-
* @param status * `success` - Success
|
|
3084
|
-
* * `error` - Error
|
|
3085
|
-
* * `running` - Running
|
|
3086
|
-
* @param username
|
|
3087
|
-
* @returns PaginatedPeriodicAgentLogList
|
|
3088
|
-
* @throws ApiError
|
|
3089
|
-
*/
|
|
3090
|
-
static aiMentorOrgsUsersPeriodicAgentLogsList(org: string, userId: string, ordering?: string, page?: number, pageSize?: number, parentMentorId?: string, parentSessionId?: string, periodicAgent?: number, search?: string, status?: 'error' | 'running' | 'success', username?: string): CancelablePromise<PaginatedPeriodicAgentLogList>;
|
|
3091
|
-
/**
|
|
3092
|
-
* Endpoint to view logs for periodic agent runs.
|
|
3093
|
-
*
|
|
3094
|
-
* These logs contain the full mentor output for each run for debugging.
|
|
3095
|
-
* Logs are ordered from newest to oldest. However this can be changed.
|
|
3096
|
-
*
|
|
3097
|
-
* You can also filter logs for a PeriodicAgent by passing the `periodic_agent` query parameter in the URL.
|
|
3098
|
-
* @param id A unique integer value identifying this periodic agent log.
|
|
3099
|
-
* @param org
|
|
3100
|
-
* @param userId
|
|
3101
|
-
* @returns PeriodicAgentLog
|
|
3102
|
-
* @throws ApiError
|
|
3103
|
-
*/
|
|
3104
|
-
static aiMentorOrgsUsersPeriodicAgentLogsRetrieve(id: number, org: string, userId: string): CancelablePromise<PeriodicAgentLog>;
|
|
3105
|
-
/**
|
|
3106
|
-
* Endpoint to create and view, update and delete periodic agents.
|
|
3107
|
-
*
|
|
3108
|
-
* Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any)
|
|
3109
|
-
* as well as a cron schedule to trigger the periodic agent.
|
|
3110
|
-
*
|
|
3111
|
-
* Access to these are restricted to platform admins and tenant administrators
|
|
3112
|
-
*
|
|
3113
|
-
* Session information for running the periodic agent will be generated with the credentials of the
|
|
3114
|
-
* user (platform administrator) who created the agent.
|
|
3115
|
-
*
|
|
3116
|
-
* A Periodic Agent is allowed to have a `callback_url` and `callback_secret`.
|
|
3117
|
-
* When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp
|
|
3118
|
-
* of the run will be made to the callback_url provided.
|
|
3119
|
-
* Here is the payload structure:
|
|
3120
|
-
* ```
|
|
3121
|
-
* {
|
|
3122
|
-
* "timestamp": "timestamp when the run completed",
|
|
3123
|
-
* "status": "status of the periodic agent",
|
|
3124
|
-
* "prompt": "input prompt to agent,
|
|
3125
|
-
* "agent_output": "...final response of agent",
|
|
3126
|
-
* "log": "... full agent run log",
|
|
3127
|
-
* "log_id": periodic agent log id.,
|
|
3128
|
-
* }
|
|
3129
|
-
* ```
|
|
3130
|
-
* The payload is encrypted using the `callback_secret` provided.
|
|
3131
|
-
*
|
|
3132
|
-
* You can validate the payload using the X-Hub-Signature-256 signature header for request data.
|
|
3133
|
-
* This is a Sha256 encoded HMAC hex digest of the payload body.
|
|
3134
|
-
*
|
|
3135
|
-
* ```python
|
|
3136
|
-
* import hmac
|
|
3137
|
-
* import haslib
|
|
3138
|
-
*
|
|
3139
|
-
* def validate_payload(request: HttpRequest, callback_secret: str):
|
|
3140
|
-
* # Get the X-Hub-Signature-256 header from the request
|
|
3141
|
-
* received_signature = request.META.get("HTTP_X_HUB_SIGNATURE_256", "")
|
|
3142
|
-
*
|
|
3143
|
-
* if not received_signature.startswith("sha256="):
|
|
3144
|
-
* # Invalid signature format
|
|
3145
|
-
* return False
|
|
3146
|
-
*
|
|
3147
|
-
* received_signature = received_signature[len("sha256=") :]
|
|
3148
|
-
*
|
|
3149
|
-
* try:
|
|
3150
|
-
* # Get the raw request body
|
|
3151
|
-
* payload = request.body
|
|
3152
|
-
*
|
|
3153
|
-
* # Compute the expected signature using the app_secret
|
|
3154
|
-
* expected_signature = hmac.new(
|
|
3155
|
-
* callback_secret.encode(), payload, hashlib.sha256
|
|
3156
|
-
* ).hexdigest()
|
|
3157
|
-
*
|
|
3158
|
-
* if hmac.compare_digest(received_signature, expected_signature):
|
|
3159
|
-
* # Signatures match, the payload is genuine
|
|
3160
|
-
* return True
|
|
3161
|
-
* else:
|
|
3162
|
-
* # Signatures don't match
|
|
3163
|
-
* return False
|
|
3164
|
-
* except Exception as e:
|
|
3165
|
-
* # Handle any errors that may occur during validation
|
|
3166
|
-
* return False
|
|
3167
|
-
*
|
|
3168
|
-
* ```
|
|
3169
|
-
* @param org
|
|
3170
|
-
* @param userId
|
|
3171
|
-
* @param enabled
|
|
3172
|
-
* @param ordering Which field to use when ordering the results.
|
|
3173
|
-
* @param page A page number within the paginated result set.
|
|
3174
|
-
* @param pageSize Number of results to return per page.
|
|
3175
|
-
* @param parentMentorId
|
|
3176
|
-
* @param parentSessionId
|
|
3177
|
-
* @param previousAgent
|
|
3178
|
-
* @param previousAgentStatus The status that the previous agent must be in before this agent gets scheduled.
|
|
3179
|
-
*
|
|
3180
|
-
* * `success` - Success
|
|
3181
|
-
* * `error` - Error
|
|
3182
|
-
* * `running` - Running
|
|
3183
|
-
* * `pending` - Pending
|
|
3184
|
-
* @param search A search term.
|
|
3185
|
-
* @param status * `success` - Success
|
|
3186
|
-
* * `error` - Error
|
|
3187
|
-
* * `running` - Running
|
|
3188
|
-
* * `pending` - Pending
|
|
3189
|
-
* @param title
|
|
3190
|
-
* @param username
|
|
3191
|
-
* @returns PaginatedPeriodicAgentList
|
|
3192
|
-
* @throws ApiError
|
|
3193
|
-
*/
|
|
3194
|
-
static aiMentorOrgsUsersPeriodicAgentsList(org: string, userId: string, enabled?: boolean, ordering?: string, page?: number, pageSize?: number, parentMentorId?: number, parentSessionId?: string, previousAgent?: number, previousAgentStatus?: 'error' | 'pending' | 'running' | 'success', search?: string, status?: 'error' | 'pending' | 'running' | 'success', title?: string, username?: string): CancelablePromise<PaginatedPeriodicAgentList>;
|
|
3195
|
-
/**
|
|
3196
|
-
* Endpoint to create and view, update and delete periodic agents.
|
|
3197
|
-
*
|
|
3198
|
-
* Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any)
|
|
3199
|
-
* as well as a cron schedule to trigger the periodic agent.
|
|
3200
|
-
*
|
|
3201
|
-
* Access to these are restricted to platform admins and tenant administrators
|
|
3202
|
-
*
|
|
3203
|
-
* Session information for running the periodic agent will be generated with the credentials of the
|
|
3204
|
-
* user (platform administrator) who created the agent.
|
|
3205
|
-
*
|
|
3206
|
-
* A Periodic Agent is allowed to have a `callback_url` and `callback_secret`.
|
|
3207
|
-
* When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp
|
|
3208
|
-
* of the run will be made to the callback_url provided.
|
|
3209
|
-
* Here is the payload structure:
|
|
3210
|
-
* ```
|
|
3211
|
-
* {
|
|
3212
|
-
* "timestamp": "timestamp when the run completed",
|
|
3213
|
-
* "status": "status of the periodic agent",
|
|
3214
|
-
* "prompt": "input prompt to agent,
|
|
3215
|
-
* "agent_output": "...final response of agent",
|
|
3216
|
-
* "log": "... full agent run log",
|
|
3217
|
-
* "log_id": periodic agent log id.,
|
|
3218
|
-
* }
|
|
3219
|
-
* ```
|
|
3220
|
-
* The payload is encrypted using the `callback_secret` provided.
|
|
3221
|
-
*
|
|
3222
|
-
* You can validate the payload using the X-Hub-Signature-256 signature header for request data.
|
|
3223
|
-
* This is a Sha256 encoded HMAC hex digest of the payload body.
|
|
3224
|
-
*
|
|
3225
|
-
* ```python
|
|
3226
|
-
* import hmac
|
|
3227
|
-
* import haslib
|
|
3228
|
-
*
|
|
3229
|
-
* def validate_payload(request: HttpRequest, callback_secret: str):
|
|
3230
|
-
* # Get the X-Hub-Signature-256 header from the request
|
|
3231
|
-
* received_signature = request.META.get("HTTP_X_HUB_SIGNATURE_256", "")
|
|
3232
|
-
*
|
|
3233
|
-
* if not received_signature.startswith("sha256="):
|
|
3234
|
-
* # Invalid signature format
|
|
3235
|
-
* return False
|
|
3236
|
-
*
|
|
3237
|
-
* received_signature = received_signature[len("sha256=") :]
|
|
3238
|
-
*
|
|
3239
|
-
* try:
|
|
3240
|
-
* # Get the raw request body
|
|
3241
|
-
* payload = request.body
|
|
3242
|
-
*
|
|
3243
|
-
* # Compute the expected signature using the app_secret
|
|
3244
|
-
* expected_signature = hmac.new(
|
|
3245
|
-
* callback_secret.encode(), payload, hashlib.sha256
|
|
3246
|
-
* ).hexdigest()
|
|
3247
|
-
*
|
|
3248
|
-
* if hmac.compare_digest(received_signature, expected_signature):
|
|
3249
|
-
* # Signatures match, the payload is genuine
|
|
3250
|
-
* return True
|
|
3251
|
-
* else:
|
|
3252
|
-
* # Signatures don't match
|
|
3253
|
-
* return False
|
|
3254
|
-
* except Exception as e:
|
|
3255
|
-
* # Handle any errors that may occur during validation
|
|
3256
|
-
* return False
|
|
3257
|
-
*
|
|
3258
|
-
* ```
|
|
3259
|
-
* @param org
|
|
3260
|
-
* @param userId
|
|
3261
|
-
* @param requestBody
|
|
3262
|
-
* @returns PeriodicAgentCreate
|
|
3263
|
-
* @throws ApiError
|
|
3264
|
-
*/
|
|
3265
|
-
static aiMentorOrgsUsersPeriodicAgentsCreate(org: string, userId: string, requestBody: PeriodicAgentCreate): CancelablePromise<PeriodicAgentCreate>;
|
|
3266
|
-
/**
|
|
3267
|
-
* Endpoint to create and view, update and delete periodic agents.
|
|
3268
|
-
*
|
|
3269
|
-
* Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any)
|
|
3270
|
-
* as well as a cron schedule to trigger the periodic agent.
|
|
3271
|
-
*
|
|
3272
|
-
* Access to these are restricted to platform admins and tenant administrators
|
|
3273
|
-
*
|
|
3274
|
-
* Session information for running the periodic agent will be generated with the credentials of the
|
|
3275
|
-
* user (platform administrator) who created the agent.
|
|
3276
|
-
*
|
|
3277
|
-
* A Periodic Agent is allowed to have a `callback_url` and `callback_secret`.
|
|
3278
|
-
* When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp
|
|
3279
|
-
* of the run will be made to the callback_url provided.
|
|
3280
|
-
* Here is the payload structure:
|
|
3281
|
-
* ```
|
|
3282
|
-
* {
|
|
3283
|
-
* "timestamp": "timestamp when the run completed",
|
|
3284
|
-
* "status": "status of the periodic agent",
|
|
3285
|
-
* "prompt": "input prompt to agent,
|
|
3286
|
-
* "agent_output": "...final response of agent",
|
|
3287
|
-
* "log": "... full agent run log",
|
|
3288
|
-
* "log_id": periodic agent log id.,
|
|
3289
|
-
* }
|
|
3290
|
-
* ```
|
|
3291
|
-
* The payload is encrypted using the `callback_secret` provided.
|
|
3292
|
-
*
|
|
3293
|
-
* You can validate the payload using the X-Hub-Signature-256 signature header for request data.
|
|
3294
|
-
* This is a Sha256 encoded HMAC hex digest of the payload body.
|
|
3295
|
-
*
|
|
3296
|
-
* ```python
|
|
3297
|
-
* import hmac
|
|
3298
|
-
* import haslib
|
|
3299
|
-
*
|
|
3300
|
-
* def validate_payload(request: HttpRequest, callback_secret: str):
|
|
3301
|
-
* # Get the X-Hub-Signature-256 header from the request
|
|
3302
|
-
* received_signature = request.META.get("HTTP_X_HUB_SIGNATURE_256", "")
|
|
3303
|
-
*
|
|
3304
|
-
* if not received_signature.startswith("sha256="):
|
|
3305
|
-
* # Invalid signature format
|
|
3306
|
-
* return False
|
|
3307
|
-
*
|
|
3308
|
-
* received_signature = received_signature[len("sha256=") :]
|
|
3309
|
-
*
|
|
3310
|
-
* try:
|
|
3311
|
-
* # Get the raw request body
|
|
3312
|
-
* payload = request.body
|
|
3313
|
-
*
|
|
3314
|
-
* # Compute the expected signature using the app_secret
|
|
3315
|
-
* expected_signature = hmac.new(
|
|
3316
|
-
* callback_secret.encode(), payload, hashlib.sha256
|
|
3317
|
-
* ).hexdigest()
|
|
3318
|
-
*
|
|
3319
|
-
* if hmac.compare_digest(received_signature, expected_signature):
|
|
3320
|
-
* # Signatures match, the payload is genuine
|
|
3321
|
-
* return True
|
|
3322
|
-
* else:
|
|
3323
|
-
* # Signatures don't match
|
|
3324
|
-
* return False
|
|
3325
|
-
* except Exception as e:
|
|
3326
|
-
* # Handle any errors that may occur during validation
|
|
3327
|
-
* return False
|
|
3328
|
-
*
|
|
3329
|
-
* ```
|
|
3330
|
-
* @param id A unique integer value identifying this periodic agent.
|
|
3331
|
-
* @param org
|
|
3332
|
-
* @param userId
|
|
3333
|
-
* @returns PeriodicAgent
|
|
3334
|
-
* @throws ApiError
|
|
3335
|
-
*/
|
|
3336
|
-
static aiMentorOrgsUsersPeriodicAgentsRetrieve(id: number, org: string, userId: string): CancelablePromise<PeriodicAgent>;
|
|
3337
|
-
/**
|
|
3338
|
-
* Endpoint to create and view, update and delete periodic agents.
|
|
3339
|
-
*
|
|
3340
|
-
* Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any)
|
|
3341
|
-
* as well as a cron schedule to trigger the periodic agent.
|
|
3342
|
-
*
|
|
3343
|
-
* Access to these are restricted to platform admins and tenant administrators
|
|
3344
|
-
*
|
|
3345
|
-
* Session information for running the periodic agent will be generated with the credentials of the
|
|
3346
|
-
* user (platform administrator) who created the agent.
|
|
3347
|
-
*
|
|
3348
|
-
* A Periodic Agent is allowed to have a `callback_url` and `callback_secret`.
|
|
3349
|
-
* When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp
|
|
3350
|
-
* of the run will be made to the callback_url provided.
|
|
3351
|
-
* Here is the payload structure:
|
|
3352
|
-
* ```
|
|
3353
|
-
* {
|
|
3354
|
-
* "timestamp": "timestamp when the run completed",
|
|
3355
|
-
* "status": "status of the periodic agent",
|
|
3356
|
-
* "prompt": "input prompt to agent,
|
|
3357
|
-
* "agent_output": "...final response of agent",
|
|
3358
|
-
* "log": "... full agent run log",
|
|
3359
|
-
* "log_id": periodic agent log id.,
|
|
3360
|
-
* }
|
|
3361
|
-
* ```
|
|
3362
|
-
* The payload is encrypted using the `callback_secret` provided.
|
|
3363
|
-
*
|
|
3364
|
-
* You can validate the payload using the X-Hub-Signature-256 signature header for request data.
|
|
3365
|
-
* This is a Sha256 encoded HMAC hex digest of the payload body.
|
|
3366
|
-
*
|
|
3367
|
-
* ```python
|
|
3368
|
-
* import hmac
|
|
3369
|
-
* import haslib
|
|
3370
|
-
*
|
|
3371
|
-
* def validate_payload(request: HttpRequest, callback_secret: str):
|
|
3372
|
-
* # Get the X-Hub-Signature-256 header from the request
|
|
3373
|
-
* received_signature = request.META.get("HTTP_X_HUB_SIGNATURE_256", "")
|
|
3374
|
-
*
|
|
3375
|
-
* if not received_signature.startswith("sha256="):
|
|
3376
|
-
* # Invalid signature format
|
|
3377
|
-
* return False
|
|
3378
|
-
*
|
|
3379
|
-
* received_signature = received_signature[len("sha256=") :]
|
|
3380
|
-
*
|
|
3381
|
-
* try:
|
|
3382
|
-
* # Get the raw request body
|
|
3383
|
-
* payload = request.body
|
|
3384
|
-
*
|
|
3385
|
-
* # Compute the expected signature using the app_secret
|
|
3386
|
-
* expected_signature = hmac.new(
|
|
3387
|
-
* callback_secret.encode(), payload, hashlib.sha256
|
|
3388
|
-
* ).hexdigest()
|
|
3389
|
-
*
|
|
3390
|
-
* if hmac.compare_digest(received_signature, expected_signature):
|
|
3391
|
-
* # Signatures match, the payload is genuine
|
|
3392
|
-
* return True
|
|
3393
|
-
* else:
|
|
3394
|
-
* # Signatures don't match
|
|
3395
|
-
* return False
|
|
3396
|
-
* except Exception as e:
|
|
3397
|
-
* # Handle any errors that may occur during validation
|
|
3398
|
-
* return False
|
|
3399
|
-
*
|
|
3400
|
-
* ```
|
|
3401
|
-
* @param id A unique integer value identifying this periodic agent.
|
|
3402
|
-
* @param org
|
|
3403
|
-
* @param userId
|
|
3404
|
-
* @param requestBody
|
|
3405
|
-
* @returns PeriodicAgentCreate
|
|
3406
|
-
* @throws ApiError
|
|
3407
|
-
*/
|
|
3408
|
-
static aiMentorOrgsUsersPeriodicAgentsUpdate(id: number, org: string, userId: string, requestBody: PeriodicAgentCreate): CancelablePromise<PeriodicAgentCreate>;
|
|
3409
|
-
/**
|
|
3410
|
-
* Endpoint to create and view, update and delete periodic agents.
|
|
3411
|
-
*
|
|
3412
|
-
* Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any)
|
|
3413
|
-
* as well as a cron schedule to trigger the periodic agent.
|
|
3414
|
-
*
|
|
3415
|
-
* Access to these are restricted to platform admins and tenant administrators
|
|
3416
|
-
*
|
|
3417
|
-
* Session information for running the periodic agent will be generated with the credentials of the
|
|
3418
|
-
* user (platform administrator) who created the agent.
|
|
3419
|
-
*
|
|
3420
|
-
* A Periodic Agent is allowed to have a `callback_url` and `callback_secret`.
|
|
3421
|
-
* When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp
|
|
3422
|
-
* of the run will be made to the callback_url provided.
|
|
3423
|
-
* Here is the payload structure:
|
|
3424
|
-
* ```
|
|
3425
|
-
* {
|
|
3426
|
-
* "timestamp": "timestamp when the run completed",
|
|
3427
|
-
* "status": "status of the periodic agent",
|
|
3428
|
-
* "prompt": "input prompt to agent,
|
|
3429
|
-
* "agent_output": "...final response of agent",
|
|
3430
|
-
* "log": "... full agent run log",
|
|
3431
|
-
* "log_id": periodic agent log id.,
|
|
3432
|
-
* }
|
|
3433
|
-
* ```
|
|
3434
|
-
* The payload is encrypted using the `callback_secret` provided.
|
|
3435
|
-
*
|
|
3436
|
-
* You can validate the payload using the X-Hub-Signature-256 signature header for request data.
|
|
3437
|
-
* This is a Sha256 encoded HMAC hex digest of the payload body.
|
|
3438
|
-
*
|
|
3439
|
-
* ```python
|
|
3440
|
-
* import hmac
|
|
3441
|
-
* import haslib
|
|
3442
|
-
*
|
|
3443
|
-
* def validate_payload(request: HttpRequest, callback_secret: str):
|
|
3444
|
-
* # Get the X-Hub-Signature-256 header from the request
|
|
3445
|
-
* received_signature = request.META.get("HTTP_X_HUB_SIGNATURE_256", "")
|
|
3446
|
-
*
|
|
3447
|
-
* if not received_signature.startswith("sha256="):
|
|
3448
|
-
* # Invalid signature format
|
|
3449
|
-
* return False
|
|
3450
|
-
*
|
|
3451
|
-
* received_signature = received_signature[len("sha256=") :]
|
|
3452
|
-
*
|
|
3453
|
-
* try:
|
|
3454
|
-
* # Get the raw request body
|
|
3455
|
-
* payload = request.body
|
|
3456
|
-
*
|
|
3457
|
-
* # Compute the expected signature using the app_secret
|
|
3458
|
-
* expected_signature = hmac.new(
|
|
3459
|
-
* callback_secret.encode(), payload, hashlib.sha256
|
|
3460
|
-
* ).hexdigest()
|
|
3461
|
-
*
|
|
3462
|
-
* if hmac.compare_digest(received_signature, expected_signature):
|
|
3463
|
-
* # Signatures match, the payload is genuine
|
|
3464
|
-
* return True
|
|
3465
|
-
* else:
|
|
3466
|
-
* # Signatures don't match
|
|
3467
|
-
* return False
|
|
3468
|
-
* except Exception as e:
|
|
3469
|
-
* # Handle any errors that may occur during validation
|
|
3470
|
-
* return False
|
|
3471
|
-
*
|
|
3472
|
-
* ```
|
|
3473
|
-
* @param id A unique integer value identifying this periodic agent.
|
|
3474
|
-
* @param org
|
|
3475
|
-
* @param userId
|
|
3476
|
-
* @param requestBody
|
|
3477
|
-
* @returns PeriodicAgentCreate
|
|
3478
|
-
* @throws ApiError
|
|
3479
|
-
*/
|
|
3480
|
-
static aiMentorOrgsUsersPeriodicAgentsPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedPeriodicAgentCreate): CancelablePromise<PeriodicAgentCreate>;
|
|
3481
|
-
/**
|
|
3482
|
-
* Endpoint to create and view, update and delete periodic agents.
|
|
3483
|
-
*
|
|
3484
|
-
* Periodic agents are schedulers issued for mentors. These are configured with input prompt (if any)
|
|
3485
|
-
* as well as a cron schedule to trigger the periodic agent.
|
|
3486
|
-
*
|
|
3487
|
-
* Access to these are restricted to platform admins and tenant administrators
|
|
3488
|
-
*
|
|
3489
|
-
* Session information for running the periodic agent will be generated with the credentials of the
|
|
3490
|
-
* user (platform administrator) who created the agent.
|
|
3491
|
-
*
|
|
3492
|
-
* A Periodic Agent is allowed to have a `callback_url` and `callback_secret`.
|
|
3493
|
-
* When a `callback_url` is set for a Periodic Agent, a post request with data entries containing the log and timestamp
|
|
3494
|
-
* of the run will be made to the callback_url provided.
|
|
3495
|
-
* Here is the payload structure:
|
|
3496
|
-
* ```
|
|
3497
|
-
* {
|
|
3498
|
-
* "timestamp": "timestamp when the run completed",
|
|
3499
|
-
* "status": "status of the periodic agent",
|
|
3500
|
-
* "prompt": "input prompt to agent,
|
|
3501
|
-
* "agent_output": "...final response of agent",
|
|
3502
|
-
* "log": "... full agent run log",
|
|
3503
|
-
* "log_id": periodic agent log id.,
|
|
3504
|
-
* }
|
|
3505
|
-
* ```
|
|
3506
|
-
* The payload is encrypted using the `callback_secret` provided.
|
|
3507
|
-
*
|
|
3508
|
-
* You can validate the payload using the X-Hub-Signature-256 signature header for request data.
|
|
3509
|
-
* This is a Sha256 encoded HMAC hex digest of the payload body.
|
|
3510
|
-
*
|
|
3511
|
-
* ```python
|
|
3512
|
-
* import hmac
|
|
3513
|
-
* import haslib
|
|
3514
|
-
*
|
|
3515
|
-
* def validate_payload(request: HttpRequest, callback_secret: str):
|
|
3516
|
-
* # Get the X-Hub-Signature-256 header from the request
|
|
3517
|
-
* received_signature = request.META.get("HTTP_X_HUB_SIGNATURE_256", "")
|
|
3518
|
-
*
|
|
3519
|
-
* if not received_signature.startswith("sha256="):
|
|
3520
|
-
* # Invalid signature format
|
|
3521
|
-
* return False
|
|
3522
|
-
*
|
|
3523
|
-
* received_signature = received_signature[len("sha256=") :]
|
|
3524
|
-
*
|
|
3525
|
-
* try:
|
|
3526
|
-
* # Get the raw request body
|
|
3527
|
-
* payload = request.body
|
|
3528
|
-
*
|
|
3529
|
-
* # Compute the expected signature using the app_secret
|
|
3530
|
-
* expected_signature = hmac.new(
|
|
3531
|
-
* callback_secret.encode(), payload, hashlib.sha256
|
|
3532
|
-
* ).hexdigest()
|
|
3533
|
-
*
|
|
3534
|
-
* if hmac.compare_digest(received_signature, expected_signature):
|
|
3535
|
-
* # Signatures match, the payload is genuine
|
|
3536
|
-
* return True
|
|
3537
|
-
* else:
|
|
3538
|
-
* # Signatures don't match
|
|
3539
|
-
* return False
|
|
3540
|
-
* except Exception as e:
|
|
3541
|
-
* # Handle any errors that may occur during validation
|
|
3542
|
-
* return False
|
|
3543
|
-
*
|
|
3544
|
-
* ```
|
|
3545
|
-
* @param id A unique integer value identifying this periodic agent.
|
|
3546
|
-
* @param org
|
|
3547
|
-
* @param userId
|
|
3548
|
-
* @returns void
|
|
3549
|
-
* @throws ApiError
|
|
3550
|
-
*/
|
|
3551
|
-
static aiMentorOrgsUsersPeriodicAgentsDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
|
|
3552
|
-
/**
|
|
3553
|
-
* Retrieve pinned messages for a user.
|
|
3554
|
-
*
|
|
3555
|
-
* Args:
|
|
3556
|
-
* request: The HTTP request.
|
|
3557
|
-
* org: Organization key identifier.
|
|
3558
|
-
* user_id: The username of the student.
|
|
3559
|
-
*
|
|
3560
|
-
* Returns:
|
|
3561
|
-
* Response: Paginated list of pinned messages.
|
|
3562
|
-
*
|
|
3563
|
-
* Raises:
|
|
3564
|
-
* NotFound: If the student or session does not exist.
|
|
3565
|
-
* @param org
|
|
3566
|
-
* @param sessionId Session id of the message to pin
|
|
3567
|
-
* @param userId
|
|
3568
|
-
* @returns PinnedMessageGet
|
|
3569
|
-
* @throws ApiError
|
|
3570
|
-
*/
|
|
3571
|
-
static aiMentorOrgsUsersPinMessageList(org: string, sessionId: string, userId: string): CancelablePromise<Array<PinnedMessageGet>>;
|
|
3572
|
-
/**
|
|
3573
|
-
* Create a pinned message for a user session.
|
|
3574
|
-
*
|
|
3575
|
-
* Args:
|
|
3576
|
-
* request: The HTTP request containing session details.
|
|
3577
|
-
* org: Organization key identifier.
|
|
3578
|
-
* user_id: The username of the student.
|
|
3579
|
-
*
|
|
3580
|
-
* Returns:
|
|
3581
|
-
* Response: Status 201 on success.
|
|
3582
|
-
*
|
|
3583
|
-
* Raises:
|
|
3584
|
-
* NotFound: If the student does not exist.
|
|
3585
|
-
* ValidationError: If request data is invalid.
|
|
3586
|
-
* @param org
|
|
3587
|
-
* @param userId
|
|
3588
|
-
* @param requestBody
|
|
3589
|
-
* @returns PinnedMessageCreate
|
|
3590
|
-
* @throws ApiError
|
|
3591
|
-
*/
|
|
3592
|
-
static aiMentorOrgsUsersPinMessageCreate(org: string, userId: string, requestBody: PinnedMessageRequest): CancelablePromise<PinnedMessageCreate>;
|
|
3593
|
-
/**
|
|
3594
|
-
* Delete a pinned message for a user.
|
|
3595
|
-
*
|
|
3596
|
-
* Args:
|
|
3597
|
-
* request: The HTTP request containing session details.
|
|
3598
|
-
* org: Organization key identifier.
|
|
3599
|
-
* user_id: The username of the student.
|
|
3600
|
-
*
|
|
3601
|
-
* Returns:
|
|
3602
|
-
* Response: Status 204 on success.
|
|
3603
|
-
*
|
|
3604
|
-
* Raises:
|
|
3605
|
-
* NotFound: If the student or pinned message does not exist.
|
|
3606
|
-
* ValidationError: If request data is invalid.
|
|
3607
|
-
* @param org
|
|
3608
|
-
* @param userId
|
|
3609
|
-
* @returns void
|
|
3610
|
-
* @throws ApiError
|
|
3611
|
-
*/
|
|
3612
|
-
static aiMentorOrgsUsersPinMessageDestroy(org: string, userId: string): CancelablePromise<void>;
|
|
3613
|
-
/**
|
|
3614
|
-
* Endpoints for viewing jobs and their status
|
|
3615
|
-
* A job run refers to a task with steps that an agent is going to undertake.
|
|
3616
|
-
* You can filter job runs by their status.
|
|
3617
|
-
* Note that for a single user and a specified session, at most only one JobRun instance
|
|
3618
|
-
* is active at any point in time.
|
|
3619
|
-
* @param org
|
|
3620
|
-
* @param userId
|
|
3621
|
-
* @param active
|
|
3622
|
-
* @param ordering Which field to use when ordering the results.
|
|
3623
|
-
* @param page A page number within the paginated result set.
|
|
3624
|
-
* @param pageSize Number of results to return per page.
|
|
3625
|
-
* @param search A search term.
|
|
3626
|
-
* @param session
|
|
3627
|
-
* @returns PaginatedJobRunList
|
|
3628
|
-
* @throws ApiError
|
|
3629
|
-
*/
|
|
3630
|
-
static aiMentorOrgsUsersPlannedJobsList(org: string, userId: string, active?: boolean, ordering?: string, page?: number, pageSize?: number, search?: string, session?: string): CancelablePromise<PaginatedJobRunList>;
|
|
3631
|
-
/**
|
|
3632
|
-
* Endpoints for viewing jobs and their status
|
|
3633
|
-
* A job run refers to a task with steps that an agent is going to undertake.
|
|
3634
|
-
* You can filter job runs by their status.
|
|
3635
|
-
* Note that for a single user and a specified session, at most only one JobRun instance
|
|
3636
|
-
* is active at any point in time.
|
|
3637
|
-
* @param id A unique integer value identifying this job run.
|
|
3638
|
-
* @param org
|
|
3639
|
-
* @param userId
|
|
3640
|
-
* @returns JobRun
|
|
3641
|
-
* @throws ApiError
|
|
3642
|
-
*/
|
|
3643
|
-
static aiMentorOrgsUsersPlannedJobsRetrieve(id: number, org: string, userId: string): CancelablePromise<JobRun>;
|
|
3644
|
-
/**
|
|
3645
|
-
* Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
|
|
3646
|
-
* @param org
|
|
3647
|
-
* @param userId
|
|
3648
|
-
* @param isPublic
|
|
3649
|
-
* @param ordering Which field to use when ordering the results.
|
|
3650
|
-
* @param page A page number within the paginated result set.
|
|
3651
|
-
* @param pageSize Number of results to return per page.
|
|
3652
|
-
* @param search A search term.
|
|
3653
|
-
* @param student edX user ID
|
|
3654
|
-
* @returns PaginatedPlayWrightScriptList
|
|
3655
|
-
* @throws ApiError
|
|
3656
|
-
*/
|
|
3657
|
-
static aiMentorOrgsUsersPlaywrightScriptsList(org: string, userId: string, isPublic?: boolean, ordering?: string, page?: number, pageSize?: number, search?: string, student?: number): CancelablePromise<PaginatedPlayWrightScriptList>;
|
|
3658
|
-
/**
|
|
3659
|
-
* Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
|
|
3660
|
-
* @param org
|
|
3661
|
-
* @param userId
|
|
3662
|
-
* @param requestBody
|
|
3663
|
-
* @returns PlayWrightScript
|
|
3664
|
-
* @throws ApiError
|
|
3665
|
-
*/
|
|
3666
|
-
static aiMentorOrgsUsersPlaywrightScriptsCreate(org: string, userId: string, requestBody: PlayWrightScript): CancelablePromise<PlayWrightScript>;
|
|
3667
|
-
/**
|
|
3668
|
-
* Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
|
|
3669
|
-
* @param id A unique integer value identifying this play wright script.
|
|
3670
|
-
* @param org
|
|
3671
|
-
* @param userId
|
|
3672
|
-
* @returns PlayWrightScript
|
|
3673
|
-
* @throws ApiError
|
|
3674
|
-
*/
|
|
3675
|
-
static aiMentorOrgsUsersPlaywrightScriptsRetrieve(id: number, org: string, userId: string): CancelablePromise<PlayWrightScript>;
|
|
3676
|
-
/**
|
|
3677
|
-
* Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
|
|
3678
|
-
* @param id A unique integer value identifying this play wright script.
|
|
3679
|
-
* @param org
|
|
3680
|
-
* @param userId
|
|
3681
|
-
* @param requestBody
|
|
3682
|
-
* @returns PlayWrightScript
|
|
3683
|
-
* @throws ApiError
|
|
3684
|
-
*/
|
|
3685
|
-
static aiMentorOrgsUsersPlaywrightScriptsUpdate(id: number, org: string, userId: string, requestBody: PlayWrightScript): CancelablePromise<PlayWrightScript>;
|
|
3686
|
-
/**
|
|
3687
|
-
* Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
|
|
3688
|
-
* @param id A unique integer value identifying this play wright script.
|
|
3689
|
-
* @param org
|
|
3690
|
-
* @param userId
|
|
3691
|
-
* @param requestBody
|
|
3692
|
-
* @returns PlayWrightScript
|
|
3693
|
-
* @throws ApiError
|
|
3694
|
-
*/
|
|
3695
|
-
static aiMentorOrgsUsersPlaywrightScriptsPartialUpdate(id: number, org: string, userId: string, requestBody?: PatchedPlayWrightScript): CancelablePromise<PlayWrightScript>;
|
|
3696
|
-
/**
|
|
3697
|
-
* Endpoints for viewing playwright scripts and updating playwright scripts for a tenant and user.
|
|
3698
|
-
* @param id A unique integer value identifying this play wright script.
|
|
3699
|
-
* @param org
|
|
3700
|
-
* @param userId
|
|
3701
|
-
* @returns void
|
|
3702
|
-
* @throws ApiError
|
|
3703
|
-
*/
|
|
3704
|
-
static aiMentorOrgsUsersPlaywrightScriptsDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
|
|
3705
|
-
/**
|
|
3706
|
-
* Retrieve predictive analytics based on historical data variables.
|
|
3707
|
-
*
|
|
3708
|
-
* Args:
|
|
3709
|
-
* request: HTTP request containing predictive analytics input.
|
|
3710
|
-
* org: Organization key identifier.
|
|
3711
|
-
*
|
|
3712
|
-
* Returns:
|
|
3713
|
-
* - 200: Object containing predicted data.
|
|
3714
|
-
* - 400: When AI response cannot be loaded into JSON.
|
|
3715
|
-
* - 404: When OpenAI key for the tenant is not set.
|
|
3716
|
-
* - 429: When OpenAI request exceeds the rate limit.
|
|
3717
|
-
*
|
|
3718
|
-
* Example:
|
|
3719
|
-
* **POST** `/api/ai-prompt/orgs/main/users/johndoe/predictive-analytics/`
|
|
3720
|
-
* @param org
|
|
3721
|
-
* @param userId
|
|
3722
|
-
* @param requestBody
|
|
3723
|
-
* @returns PredictiveAnalyticsResponse
|
|
3724
|
-
* @throws ApiError
|
|
3725
|
-
*/
|
|
3726
|
-
static aiMentorOrgsUsersPredictiveAnalyticsCreate(org: string, userId: string, requestBody: PredictiveAnalyticsRequest): CancelablePromise<PredictiveAnalyticsResponse>;
|
|
3727
|
-
/**
|
|
3728
|
-
* Retrieves recent chat messages based on provided query parameters.
|
|
3729
|
-
*
|
|
3730
|
-
* Returns:
|
|
3731
|
-
* 200: Paginated List of chat messages.
|
|
3732
|
-
* 400: Invalid query parameters.
|
|
3733
|
-
* @param org
|
|
3734
|
-
* @param userId
|
|
3735
|
-
* @returns any No response body
|
|
3736
|
-
* @throws ApiError
|
|
3737
|
-
*/
|
|
3738
|
-
static aiMentorOrgsUsersRecentMessagesRetrieve(org: string, userId: string): CancelablePromise<any>;
|
|
3739
|
-
/**
|
|
3740
|
-
* Endpoint for listing most recently accessed mentors.
|
|
3741
|
-
*
|
|
3742
|
-
* Accessible to students and admins.
|
|
3743
|
-
*
|
|
3744
|
-
*
|
|
3745
|
-
* Returns:
|
|
3746
|
-
*
|
|
3747
|
-
* 200: List of most recently accessed mentors.
|
|
3748
|
-
*
|
|
3749
|
-
* 400: When request is not valid.
|
|
3750
|
-
* @param org
|
|
3751
|
-
* @param userId
|
|
3752
|
-
* @returns RecentlyAccessedMentor
|
|
3753
|
-
* @throws ApiError
|
|
3754
|
-
*/
|
|
3755
|
-
static aiMentorOrgsUsersRecentlyAccessedMentorsList(org: string, userId: string): CancelablePromise<Array<RecentlyAccessedMentor>>;
|
|
3756
|
-
/**
|
|
3757
|
-
* Retrieve recommended courses for a specific user.
|
|
3758
|
-
*
|
|
3759
|
-
* Args:
|
|
3760
|
-
* request: The HTTP request containing query parameters.
|
|
3761
|
-
* org: The organization/tenant identifier.
|
|
3762
|
-
* user_id: The ID of the user to get recommendations for.
|
|
3763
|
-
*
|
|
3764
|
-
* Returns:
|
|
3765
|
-
* Response: A list of recommended courses.
|
|
3766
|
-
*
|
|
3767
|
-
* Raises:
|
|
3768
|
-
* BadRequest: If the query parameters are invalid.
|
|
3769
|
-
* NotFound: If the OpenAI API key for the tenant is not found.
|
|
3770
|
-
* TooManyRequests: If rate limits are exceeded.
|
|
3771
|
-
* ServerError: If there's an error processing the AI response.
|
|
3772
|
-
* @param org
|
|
3773
|
-
* @param userId
|
|
3774
|
-
* @param includeLearnerSkills Include available learner skills for search
|
|
3775
|
-
* @param includeMainCourses Include courses from the main tenant
|
|
3776
|
-
* @param rankByDifficulty Rank by course difficulty
|
|
3777
|
-
* @param returnCourseData Return course data
|
|
3778
|
-
* @param returnNumber Number of courses to return
|
|
3779
|
-
* @param searchTerms Terms to be searched
|
|
3780
|
-
* @returns RecommendCourseResponse
|
|
3781
|
-
* @throws ApiError
|
|
3782
|
-
*/
|
|
3783
|
-
static aiMentorOrgsUsersRecommendCoursesRetrieve(org: string, userId: string, includeLearnerSkills?: boolean, includeMainCourses?: boolean, rankByDifficulty?: boolean, returnCourseData?: boolean, returnNumber?: number, searchTerms?: string): CancelablePromise<RecommendCourseResponse>;
|
|
3784
|
-
/**
|
|
3785
|
-
* Retrieve recommended course blocks for a specific user.
|
|
3786
|
-
*
|
|
3787
|
-
* Args:
|
|
3788
|
-
* request: The HTTP request containing query parameters.
|
|
3789
|
-
* org: The organization/tenant identifier.
|
|
3790
|
-
* user_id: The ID of the user to get recommendations for.
|
|
3791
|
-
*
|
|
3792
|
-
* Returns:
|
|
3793
|
-
* Response: A list of recommended course blocks.
|
|
3794
|
-
*
|
|
3795
|
-
* Raises:
|
|
3796
|
-
* BadRequest: If the query parameters are invalid.
|
|
3797
|
-
* @param org
|
|
3798
|
-
* @param userId
|
|
3799
|
-
* @param includeLearnerSkills Include available learner skills for search
|
|
3800
|
-
* @param includeMainCourses Include courses from the main tenant
|
|
3801
|
-
* @param rankByDifficulty Rank by course difficulty
|
|
3802
|
-
* @param returnCourseData Return course data
|
|
3803
|
-
* @param returnNumber Number of courses to return
|
|
3804
|
-
* @param searchTerms Terms to be searched
|
|
3805
|
-
* @returns RecommendCourseBlock
|
|
3806
|
-
* @throws ApiError
|
|
3807
|
-
*/
|
|
3808
|
-
static aiMentorOrgsUsersRecommendCoursesBlockRetrieve(org: string, userId: string, includeLearnerSkills?: boolean, includeMainCourses?: boolean, rankByDifficulty?: boolean, returnCourseData?: boolean, returnNumber?: number, searchTerms?: string): CancelablePromise<RecommendCourseBlock>;
|
|
3809
|
-
/**
|
|
3810
|
-
* Search for web resources based on a query.
|
|
3811
|
-
*
|
|
3812
|
-
* Args:
|
|
3813
|
-
* request: The HTTP request containing the search query.
|
|
3814
|
-
* org: The organization/tenant identifier.
|
|
3815
|
-
* user_id: The ID of the user making the request.
|
|
3816
|
-
*
|
|
3817
|
-
* Returns:
|
|
3818
|
-
* Response: A list of web resources matching the query.
|
|
3819
|
-
*
|
|
3820
|
-
* Raises:
|
|
3821
|
-
* ValidationError: If the search fails or returns no results.
|
|
3822
|
-
* @param org
|
|
3823
|
-
* @param userId
|
|
3824
|
-
* @param requestBody
|
|
3825
|
-
* @returns WebResource
|
|
3826
|
-
* @throws ApiError
|
|
3827
|
-
*/
|
|
3828
|
-
static aiMentorOrgsUsersResourcesWebCreate(org: string, userId: string, requestBody: WebResourcesQuery): CancelablePromise<Array<WebResource>>;
|
|
3829
|
-
/**
|
|
3830
|
-
* Endpoint to view and delete Safety System Logs for a tenant.
|
|
3831
|
-
*
|
|
3832
|
-
* These can be filtered by username, platform_key and mentor id
|
|
3833
|
-
*
|
|
3834
|
-
*
|
|
3835
|
-
* A search query can be conducted to search through the prompts and reason for the moderation catch event.
|
|
3836
|
-
* @param org
|
|
3837
|
-
* @param userId
|
|
3838
|
-
* @param mentor
|
|
3839
|
-
* @param ordering Which field to use when ordering the results.
|
|
3840
|
-
* @param page A page number within the paginated result set.
|
|
3841
|
-
* @param pageSize Number of results to return per page.
|
|
3842
|
-
* @param platformKey
|
|
3843
|
-
* @param search A search term.
|
|
3844
|
-
* @param targetSystem * `Safety System` - Safety System
|
|
3845
|
-
* * `Moderation System` - Moderation System
|
|
3846
|
-
* @param username
|
|
3847
|
-
* @returns PaginatedModerationLogList
|
|
3848
|
-
* @throws ApiError
|
|
3849
|
-
*/
|
|
3850
|
-
static aiMentorOrgsUsersSafetyLogsList(org: string, userId: string, mentor?: number, ordering?: string, page?: number, pageSize?: number, platformKey?: string, search?: string, targetSystem?: 'Moderation System' | 'Safety System', username?: string): CancelablePromise<PaginatedModerationLogList>;
|
|
3851
|
-
/**
|
|
3852
|
-
* Endpoint to view and delete Safety System Logs for a tenant.
|
|
3853
|
-
*
|
|
3854
|
-
* These can be filtered by username, platform_key and mentor id
|
|
3855
|
-
*
|
|
3856
|
-
*
|
|
3857
|
-
* A search query can be conducted to search through the prompts and reason for the moderation catch event.
|
|
3858
|
-
* @param id A unique integer value identifying this moderation log.
|
|
3859
|
-
* @param org
|
|
3860
|
-
* @param userId
|
|
3861
|
-
* @returns ModerationLog
|
|
3862
|
-
* @throws ApiError
|
|
3863
|
-
*/
|
|
3864
|
-
static aiMentorOrgsUsersSafetyLogsRetrieve(id: number, org: string, userId: string): CancelablePromise<ModerationLog>;
|
|
3865
|
-
/**
|
|
3866
|
-
* Endpoint to view and delete Safety System Logs for a tenant.
|
|
3867
|
-
*
|
|
3868
|
-
* These can be filtered by username, platform_key and mentor id
|
|
3869
|
-
*
|
|
3870
|
-
*
|
|
3871
|
-
* A search query can be conducted to search through the prompts and reason for the moderation catch event.
|
|
3872
|
-
* @param id A unique integer value identifying this moderation log.
|
|
3873
|
-
* @param org
|
|
3874
|
-
* @param userId
|
|
3875
|
-
* @returns void
|
|
3876
|
-
* @throws ApiError
|
|
3877
|
-
*/
|
|
3878
|
-
static aiMentorOrgsUsersSafetyLogsDestroy(id: number, org: string, userId: string): CancelablePromise<void>;
|
|
3879
|
-
/**
|
|
3880
|
-
* Retrieve session details including message counts and timestamps.
|
|
3881
|
-
*
|
|
3882
|
-
* Query Parameters:
|
|
3883
|
-
* page (optional, int): Page number for pagination.
|
|
3884
|
-
*
|
|
3885
|
-
* Returns:
|
|
3886
|
-
* - 200: Paginated list of session details.
|
|
3887
|
-
* - 404: Session not found.
|
|
3888
|
-
* @param mentor
|
|
3889
|
-
* @param org
|
|
3890
|
-
* @param userId
|
|
3891
|
-
* @param page Page number for pagination
|
|
3892
|
-
* @returns SessionDetail
|
|
3893
|
-
* @throws ApiError
|
|
3894
|
-
*/
|
|
3895
|
-
static aiMentorOrgsUsersSessionDetailMentorsList(mentor: string, org: string, userId: string, page?: number): CancelablePromise<Array<SessionDetail>>;
|
|
3896
|
-
/**
|
|
3897
|
-
* Retrieve user sessions filtered by start date and end date.
|
|
3898
|
-
*
|
|
3899
|
-
* Query Parameters:
|
|
3900
|
-
* start_date (optional, ISO format): Start date for filtering sessions.
|
|
3901
|
-
* end_date (optional, ISO format): End date for filtering sessions.
|
|
3902
|
-
*
|
|
3903
|
-
* Returns:
|
|
3904
|
-
* - 200: List of session IDs with insertion timestamps.
|
|
3905
|
-
* - 400: Invalid request parameters.
|
|
3906
|
-
* @param org
|
|
3907
|
-
* @param userId
|
|
3908
|
-
* @param endDate
|
|
3909
|
-
* @param startDate
|
|
3910
|
-
* @returns ChatHistorySessionId
|
|
3911
|
-
* @throws ApiError
|
|
3912
|
-
*/
|
|
3913
|
-
static aiMentorOrgsUsersSessionidList(org: string, userId: string, endDate?: string, startDate?: string): CancelablePromise<Array<ChatHistorySessionId>>;
|
|
3914
|
-
/**
|
|
3915
|
-
* Retrieve or create a chat session with a mentor.
|
|
3916
|
-
*
|
|
3917
|
-
* Passing `null` as `tools` results in using all tools assigned to the mentor.
|
|
3918
|
-
* To specify that no tools be used, pass an empty list.
|
|
3919
|
-
*
|
|
3920
|
-
* Args:
|
|
3921
|
-
* request: HTTP request containing mentor details.
|
|
3922
|
-
* org: Organization key identifier.
|
|
3923
|
-
* user_id (optional): Username for authentication (if required by the mentor).
|
|
3924
|
-
*
|
|
3925
|
-
* Returns:
|
|
3926
|
-
* Response: JSON object containing the session ID.
|
|
3927
|
-
*
|
|
3928
|
-
* Raises:
|
|
3929
|
-
* Http404: If the mentor is not found.
|
|
3930
|
-
* ValidationError: If the username is invalid.
|
|
3931
|
-
* ValidationError: If one or more tool slugs are invalid.
|
|
3932
|
-
* @param org
|
|
3933
|
-
* @param userId
|
|
3934
|
-
* @param requestBody
|
|
3935
|
-
* @returns ChatSessionResponse
|
|
3936
|
-
* @throws ApiError
|
|
3937
|
-
*/
|
|
3938
|
-
static aiMentorOrgsUsersSessionsCreate(org: string, userId: string, requestBody: ChatSessionRequest): CancelablePromise<ChatSessionResponse>;
|
|
3939
|
-
/**
|
|
3940
|
-
* Retrieve Chat Messages
|
|
3941
|
-
* Fetches chat messages for a specific session.
|
|
3942
|
-
* @param org
|
|
3943
|
-
* @param sessionId
|
|
3944
|
-
* @param userId
|
|
3945
|
-
* @param share
|
|
3946
|
-
* @returns MessageView
|
|
3947
|
-
* @throws ApiError
|
|
3948
|
-
*/
|
|
3949
|
-
static aiMentorOrgsUsersSessionsRetrieve(org: string, sessionId: string, userId: string, share?: boolean): CancelablePromise<MessageView>;
|
|
3950
|
-
/**
|
|
3951
|
-
* Update the title of a chat session and its tools
|
|
3952
|
-
* @param org
|
|
3953
|
-
* @param sessionId
|
|
3954
|
-
* @param userId
|
|
3955
|
-
* @param requestBody
|
|
3956
|
-
* @returns MessageViewUpdatResponse
|
|
3957
|
-
* @throws ApiError
|
|
3958
|
-
*/
|
|
3959
|
-
static aiMentorOrgsUsersSessionsUpdate(org: string, sessionId: string, userId: string, requestBody?: MessageViewRequest): CancelablePromise<MessageViewUpdatResponse>;
|
|
3960
|
-
/**
|
|
3961
|
-
* Deletes all messages in a chat session.
|
|
3962
|
-
* @param org
|
|
3963
|
-
* @param sessionId
|
|
3964
|
-
* @param userId
|
|
3965
|
-
* @returns void
|
|
3966
|
-
* @throws ApiError
|
|
3967
|
-
*/
|
|
3968
|
-
static aiMentorOrgsUsersSessionsDestroy(org: string, sessionId: string, userId: string): CancelablePromise<void>;
|
|
3969
|
-
/**
|
|
3970
|
-
* Endpoint to fetch the logs of a session.
|
|
3971
|
-
* Logs are cached for up to 1 hour of their creation: accessing the logs after an hour will result in an empty data.
|
|
3972
|
-
*
|
|
3973
|
-
* This is intentional and made to avoid cases where logs bloat our in-memory db.
|
|
3974
|
-
*
|
|
3975
|
-
* Accessible to tenant admins and students.
|
|
3976
|
-
*
|
|
3977
|
-
* Url Args:
|
|
3978
|
-
* org (str): The organization's platform key.
|
|
3979
|
-
* user_id (str): The username identifier of the individual.
|
|
3980
|
-
* session_id (str): The session id.
|
|
3981
|
-
*
|
|
3982
|
-
* Returns:
|
|
3983
|
-
*
|
|
3984
|
-
* 200: a SessionBrowserScreenshot object
|
|
3985
|
-
* @param org
|
|
3986
|
-
* @param sessionId
|
|
3987
|
-
* @param userId
|
|
3988
|
-
* @returns SessionBrowserScreenshot
|
|
3989
|
-
* @throws ApiError
|
|
3990
|
-
*/
|
|
3991
|
-
static aiMentorOrgsUsersSessionsBrowserScreenshotRetrieve(org: string, sessionId: string, userId: string): CancelablePromise<SessionBrowserScreenshot>;
|
|
3992
|
-
/**
|
|
3993
|
-
* Retrieves the chat history for a session as a plain text file.
|
|
3994
|
-
*
|
|
3995
|
-
* Returns:
|
|
3996
|
-
* 200: txt file containing coversation
|
|
3997
|
-
* @param org
|
|
3998
|
-
* @param sessionId
|
|
3999
|
-
* @param userId
|
|
4000
|
-
* @returns any No response body
|
|
4001
|
-
* @throws ApiError
|
|
4002
|
-
*/
|
|
4003
|
-
static aiMentorOrgsUsersSessionsDownloadSessionRetrieve(org: string, sessionId: string, userId: string): CancelablePromise<any>;
|
|
4004
|
-
/**
|
|
4005
|
-
* Retrieve memory data for a specific session.
|
|
4006
|
-
*
|
|
4007
|
-
* This endpoint returns the memory components (knowledge gaps, lessons learned,
|
|
4008
|
-
* help requests) that were generated during the specified chat session.
|
|
4009
|
-
*
|
|
4010
|
-
* Args:
|
|
4011
|
-
* org: The organization/tenant identifier.
|
|
4012
|
-
* user_id: The ID of the user who owns the session.
|
|
4013
|
-
* session_id: The ID of the session to retrieve memory for.
|
|
4014
|
-
*
|
|
4015
|
-
* Returns:
|
|
4016
|
-
* Response: The memory data associated with the session.
|
|
4017
|
-
*
|
|
4018
|
-
* Raises:
|
|
4019
|
-
* NotFound: If the session does not exist or does not belong to the user.
|
|
4020
|
-
* @param org
|
|
4021
|
-
* @param sessionId
|
|
4022
|
-
* @param userId
|
|
4023
|
-
* @returns SessionMemoryStorage
|
|
4024
|
-
* @throws ApiError
|
|
4025
|
-
*/
|
|
4026
|
-
static aiMentorOrgsUsersSessionsMemoryRetrieve(org: string, sessionId: string, userId: string): CancelablePromise<SessionMemoryStorage>;
|
|
4027
|
-
/**
|
|
4028
|
-
* Retrieve shell logs for a specific session.
|
|
4029
|
-
*
|
|
4030
|
-
* Args:
|
|
4031
|
-
* request: The HTTP request.
|
|
4032
|
-
* org: The organization/tenant identifier.
|
|
4033
|
-
* user_id: The ID of the user who owns the session.
|
|
4034
|
-
* session_id: The ID of the session to retrieve logs for.
|
|
4035
|
-
*
|
|
4036
|
-
* Returns:
|
|
4037
|
-
* Response: The shell logs for the specified session.
|
|
4038
|
-
*
|
|
4039
|
-
* Raises:
|
|
4040
|
-
* NotFound: If the specified session does not exist.
|
|
4041
|
-
* @param org
|
|
4042
|
-
* @param sessionId
|
|
4043
|
-
* @param userId
|
|
4044
|
-
* @returns ShellLogs
|
|
4045
|
-
* @throws ApiError
|
|
4046
|
-
*/
|
|
4047
|
-
static aiMentorOrgsUsersSessionsShellLogsRetrieve(org: string, sessionId: string, userId: string): CancelablePromise<ShellLogs>;
|
|
4048
|
-
/**
|
|
4049
|
-
* Retrieve a list of related questions based on a chat session.
|
|
4050
|
-
* @param org
|
|
4051
|
-
* @param sessionId
|
|
4052
|
-
* @param userId
|
|
4053
|
-
* @param numQuestions
|
|
4054
|
-
* @returns RelatedText
|
|
4055
|
-
* @throws ApiError
|
|
4056
|
-
*/
|
|
4057
|
-
static aiMentorOrgsUsersSessionsSuggestionList(org: string, sessionId: string, userId: string, numQuestions?: number): CancelablePromise<Array<RelatedText>>;
|
|
4058
|
-
/**
|
|
4059
|
-
* Retrieves the chat history for a given session if the export task is ready.
|
|
4060
|
-
*
|
|
4061
|
-
* Returns:
|
|
4062
|
-
*
|
|
4063
|
-
* 200: When task is not ready.
|
|
4064
|
-
*
|
|
4065
|
-
* 200: chat history object
|
|
4066
|
-
*
|
|
4067
|
-
* 400: When data is not valid.
|
|
4068
|
-
* @param org
|
|
4069
|
-
* @param sessionId
|
|
4070
|
-
* @param taskId
|
|
4071
|
-
* @param userId
|
|
4072
|
-
* @param toCsv Choose download in csv or not
|
|
4073
|
-
* @returns ChatHistoryItem
|
|
4074
|
-
* @throws ApiError
|
|
4075
|
-
*/
|
|
4076
|
-
static aiMentorOrgsUsersSessionsTasksRetrieve(org: string, sessionId: string, taskId: string, userId: string, toCsv?: boolean): CancelablePromise<ChatHistoryItem>;
|
|
4077
|
-
/**
|
|
4078
|
-
* Retrieve all LLM models assigned to a specific tenant.
|
|
4079
|
-
*
|
|
4080
|
-
* Args:
|
|
4081
|
-
* request: The HTTP request.
|
|
4082
|
-
* org: The unique identifier of the tenant.
|
|
4083
|
-
*
|
|
4084
|
-
* Returns:
|
|
4085
|
-
* Response: A list of LLM models assigned to the tenant.
|
|
4086
|
-
*
|
|
4087
|
-
* Raises:
|
|
4088
|
-
* NotFound: If the specified tenant does not have any associated models.
|
|
4089
|
-
* ValidationError: If an unexpected error occurs.
|
|
4090
|
-
* @param org
|
|
4091
|
-
* @param userId
|
|
4092
|
-
* @returns LLMModelForTenant
|
|
4093
|
-
* @throws ApiError
|
|
4094
|
-
*/
|
|
4095
|
-
static aiMentorOrgsUsersSettingsTenantLlmList(org: string, userId: string): CancelablePromise<Array<LLMModelForTenant>>;
|
|
4096
|
-
/**
|
|
4097
|
-
* Create or update an LLM model for a tenant.
|
|
4098
|
-
*
|
|
4099
|
-
* Accessible only to tenant administrators.
|
|
4100
|
-
*
|
|
4101
|
-
* Args:
|
|
4102
|
-
* request: The HTTP request containing LLM model details.
|
|
4103
|
-
* org: The unique identifier of the tenant.
|
|
4104
|
-
*
|
|
4105
|
-
* Returns:
|
|
4106
|
-
* Response: Details of the newly created or updated LLM model.
|
|
4107
|
-
*
|
|
4108
|
-
* Raises:
|
|
4109
|
-
* ValidationError: If request data is invalid.
|
|
4110
|
-
* NotFound: If the tenant does not exist.
|
|
4111
|
-
* @param org
|
|
4112
|
-
* @param userId
|
|
4113
|
-
* @param requestBody
|
|
4114
|
-
* @returns LLMModelForTenant
|
|
4115
|
-
* @throws ApiError
|
|
4116
|
-
*/
|
|
4117
|
-
static aiMentorOrgsUsersSettingsTenantLlmCreate(org: string, userId: string, requestBody: LLMModelForTenant): CancelablePromise<LLMModelForTenant>;
|
|
4118
|
-
/**
|
|
4119
|
-
* Retrieve a list of mentors starred by a specific user.
|
|
4120
|
-
*
|
|
4121
|
-
* Args:
|
|
4122
|
-
* request: The HTTP request.
|
|
4123
|
-
* org: The organization/tenant identifier.
|
|
4124
|
-
* user_id: The ID of the user to retrieve starred mentors for.
|
|
4125
|
-
*
|
|
4126
|
-
* Returns:
|
|
4127
|
-
* Response: A list of the user's starred mentors, sorted by most recently accessed.
|
|
4128
|
-
*
|
|
4129
|
-
* Raises:
|
|
4130
|
-
* NotFound: If the specified student does not exist.
|
|
4131
|
-
* BadRequest: If the request is invalid.
|
|
4132
|
-
* @param org
|
|
4133
|
-
* @param userId
|
|
4134
|
-
* @returns StarMentor
|
|
4135
|
-
* @throws ApiError
|
|
4136
|
-
*/
|
|
4137
|
-
static aiMentorOrgsUsersStarredMentorsList(org: string, userId: string): CancelablePromise<Array<StarMentor>>;
|
|
4138
|
-
/**
|
|
4139
|
-
* Retrieves the status of a task using its task ID.
|
|
4140
|
-
*
|
|
4141
|
-
* Accessible to both tenant admins and students.
|
|
4142
|
-
*
|
|
4143
|
-
* Returns:
|
|
4144
|
-
*
|
|
4145
|
-
* 200: task id
|
|
4146
|
-
* @param org
|
|
4147
|
-
* @param taskId
|
|
4148
|
-
* @param userId
|
|
4149
|
-
* @returns RetrieveTask
|
|
4150
|
-
* @throws ApiError
|
|
4151
|
-
*/
|
|
4152
|
-
static aiMentorOrgsUsersTasksRetrieve(org: string, taskId: string, userId: string): CancelablePromise<RetrieveTask>;
|
|
4153
|
-
/**
|
|
4154
|
-
* Export chat history for a session.
|
|
4155
|
-
*
|
|
4156
|
-
* Returns:
|
|
4157
|
-
* 200: Task ID for the export operation.
|
|
4158
|
-
* @param org
|
|
4159
|
-
* @param sessionId
|
|
4160
|
-
* @param userId
|
|
4161
|
-
* @param requestBody
|
|
4162
|
-
* @returns TaskView
|
|
4163
|
-
* @throws ApiError
|
|
4164
|
-
*/
|
|
4165
|
-
static aiMentorOrgsUsersTasksSessionsCreate(org: string, sessionId: string, userId: string, requestBody: TaskView): CancelablePromise<TaskView>;
|
|
4166
|
-
/**
|
|
4167
|
-
* Retrieve a list of available voice options.
|
|
4168
|
-
*
|
|
4169
|
-
* Args:
|
|
4170
|
-
* request: The HTTP request.
|
|
4171
|
-
*
|
|
4172
|
-
* Returns:
|
|
4173
|
-
* Response: A list of available voice options.
|
|
4174
|
-
*
|
|
4175
|
-
* Raises:
|
|
4176
|
-
* NotFound: If no voice options are available.
|
|
4177
|
-
* @param org
|
|
4178
|
-
* @param userId
|
|
4179
|
-
* @param ordering Which field to use when ordering the results.
|
|
4180
|
-
* @param page A page number within the paginated result set.
|
|
4181
|
-
* @param pageSize Number of results to return per page.
|
|
4182
|
-
* @param provider * `openai` - Openai
|
|
4183
|
-
* * `google` - Google
|
|
4184
|
-
* * `elevenlabs` - Elevenlabs
|
|
4185
|
-
* @param search A search term.
|
|
4186
|
-
* @returns PaginatedVoiceList
|
|
4187
|
-
* @throws ApiError
|
|
4188
|
-
*/
|
|
4189
|
-
static aiMentorOrgsUsersVoicesList(org: string, userId: string, ordering?: string, page?: number, pageSize?: number, provider?: 'elevenlabs' | 'google' | 'openai', search?: string): CancelablePromise<PaginatedVoiceList>;
|
|
4190
|
-
/**
|
|
4191
|
-
* Retrieve details of a specific voice option.
|
|
4192
|
-
*
|
|
4193
|
-
* Args:
|
|
4194
|
-
* request: The HTTP request.
|
|
4195
|
-
* pk: The primary key of the voice option to retrieve.
|
|
4196
|
-
*
|
|
4197
|
-
* Returns:
|
|
4198
|
-
* Response: The details of the specified voice option.
|
|
4199
|
-
*
|
|
4200
|
-
* Raises:
|
|
4201
|
-
* NotFound: If the specified voice option does not exist.
|
|
4202
|
-
* @param id A unique integer value identifying this voice.
|
|
4203
|
-
* @param org
|
|
4204
|
-
* @param userId
|
|
4205
|
-
* @returns Voice
|
|
4206
|
-
* @throws ApiError
|
|
4207
|
-
*/
|
|
4208
|
-
static aiMentorOrgsUsersVoicesRetrieve(id: number, org: string, userId: string): CancelablePromise<Voice>;
|
|
4209
|
-
/**
|
|
4210
|
-
* @param org
|
|
4211
|
-
* @param slug
|
|
4212
|
-
* @returns any No response body
|
|
4213
|
-
* @throws ApiError
|
|
4214
|
-
*/
|
|
4215
|
-
static aiMentorOrgsWebhooksAzureTriggerCreate(org: string, slug: string): CancelablePromise<any>;
|
|
4216
|
-
/**
|
|
4217
|
-
* Handle incoming POST requests from GitHub webhook for pull requests.
|
|
4218
|
-
*
|
|
4219
|
-
* Args:
|
|
4220
|
-
* request: The HTTP request object containing the webhook payload.
|
|
4221
|
-
* org: the organizaion name.
|
|
4222
|
-
*
|
|
4223
|
-
* Returns:
|
|
4224
|
-
* Response: A response indicating the result of processing the webhook event.
|
|
4225
|
-
* @param org
|
|
4226
|
-
* @returns any No response body
|
|
4227
|
-
* @throws ApiError
|
|
4228
|
-
*/
|
|
4229
|
-
static aiMentorOrgsWebhooksGithubPullrequestCreate(org: string): CancelablePromise<any>;
|
|
4230
|
-
/**
|
|
4231
|
-
* @returns any No response body
|
|
4232
|
-
* @throws ApiError
|
|
4233
|
-
*/
|
|
4234
|
-
static aiMentorWebhooksAzureEmailchatCreate(): CancelablePromise<any>;
|
|
4235
|
-
}
|