@iblai/iblai-api 3.45.3-core → 3.45.4-ai

package/dist/types/models/MentorSettings.d.ts

@@ -0,0 +1,56 @@
+import type { AlignMentorBubbleEnum } from './AlignMentorBubbleEnum';
+import type { BlankEnum } from './BlankEnum';
+import type { MCPServer } from './MCPServer';
+import type { MentorVisibilityEnum } from './MentorVisibilityEnum';
+import type { NullEnum } from './NullEnum';
+import type { ThemeEnum } from './ThemeEnum';
+export type MentorSettings = {
+    readonly id: number;
+    display_name?: string | null;
+    profile_image?: string | null;
+    initial_message?: string | null;
+    suggested_message?: string | null;
+    theme?: ThemeEnum;
+    user_message_color?: string;
+    mentor_bubble_color?: string;
+    align_mentor_bubble?: AlignMentorBubbleEnum;
+    readonly mentor: string;
+    readonly mentor_slug: string;
+    readonly mentor_unique_id: string;
+    readonly metadata: any;
+    mentor_visibility?: (MentorVisibilityEnum | BlankEnum | NullEnum) | null;
+    enable_image_generation?: boolean | null;
+    enable_web_browsing?: boolean | null;
+    enable_code_interpreter?: boolean | null;
+    custom_css?: string | null;
+    readonly allow_anonymous: boolean;
+    readonly mentor_description: string;
+    readonly suggested_prompts: any;
+    readonly proactive_response: string;
+    readonly greeting_method: string;
+    readonly mentor_tools: any;
+    readonly can_use_tools: boolean;
+    readonly llm_name: string;
+    readonly proactive_prompt: string;
+    readonly enable_memory_component: boolean;
+    readonly enable_email_chat: boolean;
+    readonly enable_spaced_repetition: boolean;
+    readonly enable_instruction_mode: boolean;
+    readonly enable_socratic_mode: boolean;
+    readonly is_guided_mentor: boolean;
+    readonly enable_guided_prompts: boolean;
+    readonly enable_moderation: boolean;
+    readonly enable_safety_system: boolean;
+    readonly forkable: boolean;
+    readonly forkable_with_training_data: boolean;
+    readonly system_prompt: string;
+    readonly llm_provider: string;
+    readonly llm_temperature: number;
+    readonly safety_system_prompt: string;
+    readonly safety_response: string;
+    readonly moderation_system_prompt: string;
+    readonly moderation_response: string;
+    readonly mcp_servers: Array<MCPServer>;
+    readonly department: string;
+    readonly disable_chathistory: string;
+};

package/dist/types/models/MentorSettingsPublic.d.ts

@@ -0,0 +1,45 @@
+import type { AlignMentorBubbleEnum } from './AlignMentorBubbleEnum';
+import type { BlankEnum } from './BlankEnum';
+import type { MentorVisibilityEnum } from './MentorVisibilityEnum';
+import type { NullEnum } from './NullEnum';
+import type { ThemeEnum } from './ThemeEnum';
+export type MentorSettingsPublic = {
+    readonly id: number;
+    display_name?: string | null;
+    profile_image?: string | null;
+    initial_message?: string | null;
+    suggested_message?: string | null;
+    theme?: ThemeEnum;
+    user_message_color?: string;
+    mentor_bubble_color?: string;
+    align_mentor_bubble?: AlignMentorBubbleEnum;
+    readonly mentor: string;
+    readonly mentor_slug: string;
+    readonly mentor_unique_id: string;
+    readonly metadata: any;
+    mentor_visibility?: (MentorVisibilityEnum | BlankEnum | NullEnum) | null;
+    enable_image_generation?: boolean | null;
+    enable_web_browsing?: boolean | null;
+    enable_code_interpreter?: boolean | null;
+    custom_css?: string | null;
+    readonly allow_anonymous: boolean;
+    readonly mentor_description: string;
+    readonly suggested_prompts: any;
+    readonly proactive_response: string;
+    readonly greeting_method: string;
+    readonly mentor_tools: any;
+    readonly can_use_tools: boolean;
+    readonly llm_name: string;
+    readonly proactive_prompt: string;
+    readonly enable_memory_component: boolean;
+    readonly enable_email_chat: boolean;
+    readonly enable_spaced_repetition: boolean;
+    readonly enable_instruction_mode: boolean;
+    readonly enable_socratic_mode: boolean;
+    readonly is_guided_mentor: boolean;
+    readonly enable_guided_prompts: boolean;
+    readonly enable_moderation: boolean;
+    readonly enable_safety_system: boolean;
+    readonly forkable: boolean;
+    readonly forkable_with_training_data: boolean;
+};

package/dist/types/models/MentorSettingsRequest.d.ts

@@ -0,0 +1,60 @@
+import type { GreetingMethodEnum } from './GreetingMethodEnum';
+export type MentorSettingsRequest = {
+    mentor_name?: string;
+    template_name?: string;
+    display_name?: string;
+    profile_image?: string;
+    initial_message?: string | null;
+    suggested_message?: string | null;
+    theme?: string;
+    user_message_color?: string;
+    mentor_bubble_color?: string;
+    align_mentor_bubble?: string;
+    system_prompt?: string;
+    llm_provider?: string;
+    llm_name?: string;
+    featured?: boolean;
+    disable_chathistory?: boolean;
+    metadata?: any;
+    custom_css?: string | null;
+    /**
+     * Department to authorize users by
+     */
+    department_id?: number | null;
+    mentor_visibility?: string;
+    enable_image_generation?: boolean;
+    enable_web_browsing?: boolean;
+    enable_code_interpreter?: boolean;
+    allow_anonymous?: boolean;
+    forkable?: boolean;
+    forkable_with_training_data?: boolean;
+    mentor_description?: string;
+    uploaded_profile_image?: string;
+    proactive_response?: string;
+    greeting_method?: GreetingMethodEnum;
+    can_use_tools?: boolean;
+    tool_slugs?: Array<string>;
+    llm_temperature?: number;
+    proactive_prompt?: string;
+    moderation_system_prompt?: string;
+    moderation_response?: string;
+    enable_moderation?: boolean;
+    enable_openai_assistant?: boolean;
+    enable_total_grounding?: boolean;
+    enable_suggested_prompts?: boolean | null;
+    enable_guided_prompts?: boolean | null;
+    mcp_servers?: Array<number> | null;
+    google_voice?: number;
+    openai_voice?: number;
+    guided_prompt_instructions?: string | null;
+    safety_system_prompt?: string;
+    safety_response?: string;
+    enable_safety_system?: boolean;
+    enable_memory_component?: boolean;
+    enable_spaced_repetition?: boolean;
+    enable_instruction_mode?: boolean;
+    enable_socratic_mode?: boolean;
+    is_guided_mentor?: boolean;
+    enable_email_chat?: boolean;
+    categories?: Array<number>;
+};

package/dist/types/models/MentorVisibilityEnum.d.ts

@@ -0,0 +1,10 @@
+/**
+ * * `viewable_by_tenant_admins` - Viewable By Tenant Admins
+ * * `viewable_by_tenant_students` - Viewable By Tenant Students
+ * * `viewable_by_anyone` - Viewable By Anyone
+ */
+export declare enum MentorVisibilityEnum {
+    VIEWABLE_BY_TENANT_ADMINS = "viewable_by_tenant_admins",
+    VIEWABLE_BY_TENANT_STUDENTS = "viewable_by_tenant_students",
+    VIEWABLE_BY_ANYONE = "viewable_by_anyone"
+}

package/dist/types/models/MentorWizard.d.ts

@@ -0,0 +1,4 @@
+export type MentorWizard = {
+    name: string;
+    description: string;
+};

package/dist/types/models/MessageStatistics.d.ts

@@ -0,0 +1,5 @@
+export type MessageStatistics = {
+    time: string;
+    avg_messages: number;
+    total_sessions: number;
+};

package/dist/types/models/MessageView.d.ts

@@ -0,0 +1,10 @@
+export type MessageView = {
+    count: number;
+    title: string;
+    proactive_prompt: string;
+    mentor_unique_id: string;
+    platform_key: string;
+    previous: string;
+    next: string;
+    results: Array<any>;
+};

package/dist/types/models/MessageViewRequest.d.ts

@@ -0,0 +1,7 @@
+export type MessageViewRequest = {
+    title?: string;
+    /**
+     * List of tools slugs to use
+     */
+    tools?: Array<string>;
+};

package/dist/types/models/MessageViewUpdatResponse.d.ts

@@ -0,0 +1,3 @@
+export type MessageViewUpdatResponse = {
+    detail: string;
+};

package/dist/types/models/Metadata.d.ts

@@ -0,0 +1,5 @@
+export type Metadata = {
+    metadata: any;
+    prompt?: string;
+    prompt_id?: number;
+};

package/dist/types/models/MetricChange.d.ts

@@ -0,0 +1,4 @@
+export type MetricChange = {
+    total: number;
+    change: number;
+};

package/dist/types/models/ModelCost.d.ts

@@ -0,0 +1,4 @@
+export type ModelCost = {
+    model: string;
+    total_cost: number;
+};

package/dist/types/models/ModerationLog.d.ts

@@ -0,0 +1,11 @@
+import type { TargetSystemEnum } from './TargetSystemEnum';
+export type ModerationLog = {
+    readonly id: number;
+    username?: string;
+    platform_key: string;
+    mentor: number;
+    prompt: string;
+    reason: string;
+    target_system?: TargetSystemEnum;
+    readonly date_created: string;
+};

package/dist/types/models/NoChatMessagesFound.d.ts

@@ -0,0 +1,3 @@
+export type NoChatMessagesFound = {
+    error?: string;
+};

package/dist/types/models/NotificationSource.d.ts

@@ -1,8 +1,8 @@
-import type { TypeEnum } from './TypeEnum';
+import type { NotificationSourceTypeEnum } from './NotificationSourceTypeEnum';
 /**
  * Request serializer for source validation
  */
 export type NotificationSource = {
-    type: TypeEnum;
+    type: NotificationSourceTypeEnum;
     data: any;
 };

package/dist/types/models/{TypeEnum.d.ts → NotificationSourceTypeEnum.d.ts}

@@ -7,7 +7,7 @@
  * * `pathway` - pathway
  * * `program` - program
  */
-export declare enum TypeEnum {
+export declare enum NotificationSourceTypeEnum {
     EMAIL = "email",
     USERNAME = "username",
     PLATFORM = "platform",

package/dist/types/models/NullEnum.d.ts

@@ -0,0 +1 @@
+export type NullEnum = {};

package/dist/types/models/PageContent.d.ts

@@ -0,0 +1,6 @@
+export type PageContent = {
+    /**
+     * The page content
+     */
+    page_content: string;
+};

package/dist/types/models/PaginatedAIGeneratedImageList.d.ts

@@ -0,0 +1,7 @@
+import type { AIGeneratedImage } from './AIGeneratedImage';
+export type PaginatedAIGeneratedImageList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<AIGeneratedImage>;
+};

package/dist/types/models/PaginatedConversationsList.d.ts

@@ -0,0 +1,7 @@
+import type { Conversations } from './Conversations';
+export type PaginatedConversationsList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<Conversations>;
+};

package/dist/types/models/PaginatedCourseCreationTaskFileList.d.ts

@@ -0,0 +1,7 @@
+import type { CourseCreationTaskFile } from './CourseCreationTaskFile';
+export type PaginatedCourseCreationTaskFileList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<CourseCreationTaskFile>;
+};

package/dist/types/models/PaginatedCourseCreationTaskList.d.ts

@@ -0,0 +1,7 @@
+import type { CourseCreationTask } from './CourseCreationTask';
+export type PaginatedCourseCreationTaskList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<CourseCreationTask>;
+};

package/dist/types/models/PaginatedEdxCourseList.d.ts

@@ -0,0 +1,7 @@
+import type { EdxCourse } from './EdxCourse';
+export type PaginatedEdxCourseList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<EdxCourse>;
+};

package/dist/types/models/PaginatedEmailPromptListList.d.ts

@@ -0,0 +1,7 @@
+import type { EmailPromptList } from './EmailPromptList';
+export type PaginatedEmailPromptListList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<EmailPromptList>;
+};

package/dist/types/models/PaginatedHeygenMarketingVideoListList.d.ts

@@ -0,0 +1,7 @@
+import type { HeygenMarketingVideoList } from './HeygenMarketingVideoList';
+export type PaginatedHeygenMarketingVideoListList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<HeygenMarketingVideoList>;
+};

package/dist/types/models/PaginatedHeygenTemplateResponseSingleList.d.ts

@@ -0,0 +1,7 @@
+import type { HeygenTemplateResponseSingle } from './HeygenTemplateResponseSingle';
+export type PaginatedHeygenTemplateResponseSingleList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<HeygenTemplateResponseSingle>;
+};

package/dist/types/models/PaginatedJobRunList.d.ts

@@ -0,0 +1,7 @@
+import type { JobRun } from './JobRun';
+export type PaginatedJobRunList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<JobRun>;
+};

package/dist/types/models/PaginatedMCPServerList.d.ts

@@ -0,0 +1,7 @@
+import type { MCPServer } from './MCPServer';
+export type PaginatedMCPServerList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<MCPServer>;
+};

package/dist/types/models/PaginatedMentorList.d.ts

@@ -0,0 +1,7 @@
+import type { Mentor } from './Mentor';
+export type PaginatedMentorList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<Mentor>;
+};

package/dist/types/models/PaginatedModerationLogList.d.ts

@@ -0,0 +1,7 @@
+import type { ModerationLog } from './ModerationLog';
+export type PaginatedModerationLogList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<ModerationLog>;
+};

package/dist/types/models/PaginatedPeriodicAgentList.d.ts

@@ -0,0 +1,7 @@
+import type { PeriodicAgent } from './PeriodicAgent';
+export type PaginatedPeriodicAgentList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<PeriodicAgent>;
+};

package/dist/types/models/PaginatedPeriodicAgentLogList.d.ts

@@ -0,0 +1,7 @@
+import type { PeriodicAgentLog } from './PeriodicAgentLog';
+export type PaginatedPeriodicAgentLogList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<PeriodicAgentLog>;
+};

package/dist/types/models/PaginatedPlayWrightScriptList.d.ts

@@ -0,0 +1,7 @@
+import type { PlayWrightScript } from './PlayWrightScript';
+export type PaginatedPlayWrightScriptList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<PlayWrightScript>;
+};

package/dist/types/models/PaginatedSectionList.d.ts

@@ -0,0 +1,7 @@
+import type { Section } from './Section';
+export type PaginatedSectionList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<Section>;
+};

package/dist/types/models/PaginatedSubSectionList.d.ts

@@ -0,0 +1,7 @@
+import type { SubSection } from './SubSection';
+export type PaginatedSubSectionList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<SubSection>;
+};

package/dist/types/models/PaginatedTopicStatisticsResponse.d.ts

@@ -0,0 +1,7 @@
+import type { TopicStatistics } from './TopicStatistics';
+export type PaginatedTopicStatisticsResponse = {
+    count: number;
+    next: string | null;
+    previous: string | null;
+    results: Array<TopicStatistics>;
+};

package/dist/types/models/PaginatedUnitList.d.ts

@@ -0,0 +1,7 @@
+import type { Unit } from './Unit';
+export type PaginatedUnitList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<Unit>;
+};

package/dist/types/models/PaginatedUserEdxMemoryList.d.ts

@@ -0,0 +1,7 @@
+import type { UserEdxMemory } from './UserEdxMemory';
+export type PaginatedUserEdxMemoryList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<UserEdxMemory>;
+};

package/dist/types/models/PaginatedVoiceList.d.ts

@@ -0,0 +1,7 @@
+import type { Voice } from './Voice';
+export type PaginatedVoiceList = {
+    count: number;
+    next?: string | null;
+    previous?: string | null;
+    results: Array<Voice>;
+};

package/dist/types/models/PatchedConversations.d.ts

@@ -0,0 +1,28 @@
+import type { TopicModel } from './TopicModel';
+export type PatchedConversations = {
+    readonly id?: string;
+    readonly messages?: string;
+    topics?: Array<TopicModel>;
+    readonly sentiment?: string;
+    mentor?: string;
+    readonly student?: string;
+    readonly email?: string;
+    model?: string;
+    readonly rating?: number;
+    platform?: string;
+    /**
+     * Email claim from LTI1.3 JWT if an LTI user and available
+     */
+    readonly lti_email?: string;
+    /**
+     * Username claim from LTI1.3 JWT if an LTI user and available
+     */
+    readonly lti_username?: string;
+    readonly inserted_at?: string;
+    has_document?: boolean;
+    memory_tracked?: boolean;
+    llm_name?: string | null;
+    llm_provider?: string | null;
+    metadata?: any;
+    tools?: Array<number>;
+};

package/dist/types/models/PatchedCourseCreationTaskFile.d.ts

@@ -0,0 +1,7 @@
+export type PatchedCourseCreationTaskFile = {
+    readonly id?: number;
+    course_creation_task?: number;
+    file?: string;
+    readonly date_created?: string;
+    readonly last_modified?: string;
+};

package/dist/types/models/PatchedCredentialRequest.d.ts

@@ -0,0 +1,14 @@
+export type PatchedCredentialRequest = {
+    /**
+     * Name of the credential provider (e.g., 'openai', 'google-drive')
+     */
+    name?: string;
+    /**
+     * Credential data for the provider (API keys, service account details, etc.)
+     */
+    value?: any;
+    /**
+     * Organization key identifier for the tenant
+     */
+    platform?: string;
+};

package/dist/types/models/PatchedLLMCredentialRequest.d.ts

@@ -0,0 +1,14 @@
+export type PatchedLLMCredentialRequest = {
+    /**
+     * Name of the credential provider
+     */
+    name?: string;
+    /**
+     * Value of the credential provider
+     */
+    value?: any;
+    /**
+     * Key of the tenant
+     */
+    platform?: string;
+};

package/dist/types/models/PatchedMCPServer.d.ts

@@ -0,0 +1,21 @@
+import type { TransportEnum } from './TransportEnum';
+/**
+ * Serializer for the MCPServer model.
+ */
+export type PatchedMCPServer = {
+    readonly id?: number;
+    readonly platform?: number;
+    name?: string;
+    /**
+     * The url of the MCP server.
+     */
+    url?: string;
+    transport?: TransportEnum;
+    /**
+     * Headers to send to the MCP server. Useful for authentication,
+     */
+    headers?: any;
+    readonly platform_key?: string;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+};

package/dist/types/models/PatchedMentorCategoryGroupCreate.d.ts

@@ -0,0 +1,11 @@
+export type PatchedMentorCategoryGroupCreate = {
+    readonly id?: number;
+    name?: string;
+    description?: string;
+    /**
+     * Deprecated: This is only left for backward compatibility. Please use the audiences field instead.
+     */
+    audience?: number | null;
+    audiences?: Array<number>;
+    readonly date_created?: string;
+};

package/dist/types/models/PatchedMentorCreate.d.ts

@@ -0,0 +1,79 @@
+import type { GreetingMethodEnum } from './GreetingMethodEnum';
+export type PatchedMentorCreate = {
+    name?: string;
+    unique_id?: string;
+    /**
+     * The langflow json for the mentor
+     */
+    flow?: any;
+    slug?: string;
+    platform?: string;
+    allow_anonymous?: boolean;
+    metadata?: any;
+    enable_moderation?: boolean;
+    /**
+     * (Deprecated) Set template mentor to openai-agent instead.
+     */
+    enable_openai_assistant?: boolean;
+    /**
+     * Whether to force mentor to only use information within the provided documents.
+     */
+    enable_total_grounding?: boolean;
+    /**
+     * Whether to show suggested prompts for the mentor or not. Note: Suggested prompts are created by tenant admins.
+     */
+    enable_suggested_prompts?: boolean;
+    /**
+     * Whether to show suggested prompts for the mentor or not. Note: Guided prompts are created with an llm based on chat history.
+     */
+    enable_guided_prompts?: boolean;
+    google_voice?: number | null;
+    openai_voice?: number | null;
+    /**
+     * Instructions to determine how prompt suggestions are generated.
+     */
+    guided_prompt_instructions?: string;
+    categories?: Array<number>;
+    /**
+     * Prompt template used to start a conversation with the user when greeting_type is proactive_prompt. This will be sent to the LLM so it can respond naturally
+     */
+    proactive_prompt?: string;
+    /**
+     * The prompt for the moderation system. This prompt must clearly distinguish between 'Approapriate' and 'Not Appropriate' queries.
+     */
+    moderation_system_prompt?: string;
+    /**
+     * Desired feedback to return to the user when their prompt is deemed inappropriate.
+     */
+    moderation_response?: string;
+    /**
+     * Prompt to check whether the models response is appropriate or not.
+     */
+    safety_system_prompt?: string;
+    /**
+     * Feedback given to the user when a model generates an inappropriate response
+     */
+    safety_response?: string;
+    disable_chathistory?: boolean;
+    enable_safety_system?: boolean;
+    /**
+     * Response to start a conversation with a user.
+     */
+    proactive_response?: string;
+    mcp_servers?: Array<number>;
+    /**
+     * How the mentor should greet the user. proactive_prompt: Allow the LLM to respond to proactive_prompt msg. proactive_response: use proactive_response template without performing an LLM call.
+     *
+     * * `proactive_prompt` - Proactive Prompt
+     * * `proactive_response` - Proactive Response
+     */
+    greeting_method?: GreetingMethodEnum;
+    /**
+     * edX user ID
+     */
+    last_accessed_by?: number | null;
+    recently_accessed_at?: string | null;
+    created_by?: string | null;
+    readonly created_at?: string | null;
+    readonly updated_at?: string | null;
+};