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