@iblai/iblai-api 3.36.1-core → 3.37.0-ai

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

@@ -0,0 +1,5 @@
+export type LinkCourseResponse = {
+    mentor_unique_id: string;
+    course_id?: string | null;
+    is_linked: boolean;
+};

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

@@ -0,0 +1,21 @@
+import type { TransportEnum } from './TransportEnum';
+/**
+ * Serializer for the MCPServer model.
+ */
+export type MCPServer = {
+    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/MemoryComponentData.d.ts

@@ -0,0 +1,5 @@
+import type { KindEnum } from './KindEnum';
+export type MemoryComponentData = {
+    kind?: KindEnum;
+    content: string;
+};

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

@@ -0,0 +1,4 @@
+import type { MemoryComponentData } from './MemoryComponentData';
+export type MemoryComponentMemory = {
+    readonly data: Array<MemoryComponentData>;
+};

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

@@ -0,0 +1,8 @@
+import type { MemoryComponentData } from './MemoryComponentData';
+export type MemoryComponentMemoryDetail = {
+    data: Array<MemoryComponentData>;
+    readonly catalog_item: string;
+    readonly mentor_unique_id: string;
+    readonly student: string;
+    readonly inserted_at: string;
+};

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

@@ -0,0 +1,5 @@
+export type MemoryComponentResponse = {
+    readonly knowledge_gaps: Array<string>;
+    readonly lessons_learned: Array<string>;
+    readonly help_requests: Array<string>;
+};

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

@@ -0,0 +1,8 @@
+export type MemoryProgress = {
+    readonly memory_type: string;
+    readonly all_units: number | null;
+    readonly all_unit_names: Array<string> | null;
+    readonly current_unit: number | null;
+    readonly current_unit_name: string | null;
+    readonly item_name: string | null;
+};

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

@@ -0,0 +1,6 @@
+export type MemoryStatusRequestView = {
+    /**
+     * Enable or disable memory use
+     */
+    enabled: boolean;
+};

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

@@ -0,0 +1,6 @@
+export type MemoryStatusView = {
+    readonly id: number;
+    username: string;
+    platform_key: string;
+    enabled?: boolean;
+};

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

@@ -0,0 +1,80 @@
+import type { GreetingMethodEnum } from './GreetingMethodEnum';
+import type { MCPServer } from './MCPServer';
+import type { MentorCategory } from './MentorCategory';
+export type Mentor = {
+    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;
+    /**
+     * Instructions to determine how prompt suggestions are generated.
+     */
+    guided_prompt_instructions?: string;
+    google_voice?: number | null;
+    openai_voice?: number | null;
+    categories: Array<MentorCategory>;
+    /**
+     * 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;
+    enable_safety_system?: boolean;
+    /**
+     * Response to start a conversation with a user.
+     */
+    proactive_response?: string;
+    /**
+     * 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;
+    mcp_servers: Array<MCPServer>;
+    /**
+     * 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;
+};

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

@@ -0,0 +1,5 @@
+export type MentorAudience = {
+    readonly id: number;
+    name: string;
+    description?: string | null;
+};

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

@@ -0,0 +1,9 @@
+import type { MentorAudience } from './MentorAudience';
+export type MentorCategory = {
+    readonly id: number;
+    name: string;
+    description?: string | null;
+    category_group?: number | null;
+    audience: MentorAudience;
+    audiences: Array<MentorAudience>;
+};

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

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

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

@@ -0,0 +1,11 @@
+import type { MentorAudience } from './MentorAudience';
+import type { MentorCategory } from './MentorCategory';
+export type MentorCategoryGroup = {
+    readonly id: number;
+    name: string;
+    description: string;
+    audience: MentorAudience;
+    readonly date_created: string;
+    categories: Array<MentorCategory>;
+    audiences: Array<MentorAudience>;
+};

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

@@ -0,0 +1,11 @@
+export type MentorCategoryGroupCreate = {
+    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/MentorCreate.d.ts

@@ -0,0 +1,78 @@
+import type { GreetingMethodEnum } from './GreetingMethodEnum';
+export type MentorCreate = {
+    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;
+    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;
+};

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

@@ -0,0 +1,4 @@
+export type MentorCustomVoice = {
+    voice_provider: string;
+    voice_name?: string | null;
+};

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

@@ -0,0 +1,4 @@
+export type MentorCustomVoiceResponse = {
+    readonly voice_provider: string;
+    readonly voice_name: string;
+};

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

@@ -0,0 +1,7 @@
+import type { MentorSession } from './MentorSession';
+export type MentorData = {
+    mentor_unique_id: string;
+    mentor_name: string;
+    total_cost: number;
+    mentor_sessions: Array<MentorSession>;
+};

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

@@ -0,0 +1,6 @@
+export type MentorDetailAnalytics = {
+    total_mentors: number;
+    active_mentors: number;
+    total_questions_answered: number;
+    total_ratings: number;
+};

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

@@ -0,0 +1,11 @@
+import type { MentorEvalQuestion } from './MentorEvalQuestion';
+export type MentorEval = {
+    readonly id: number;
+    readonly mentor: string;
+    readonly questions: Array<MentorEvalQuestion>;
+    eval_id?: string;
+    name?: string | null;
+    passing_score?: number;
+    evaluation_prompt?: string;
+    question_set?: number | null;
+};

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

@@ -0,0 +1,5 @@
+export type MentorEvalQuestion = {
+    readonly id: number;
+    content: string;
+    sample_answer?: string | null;
+};

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

@@ -0,0 +1,4 @@
+export type MentorEvalQuestionRequest = {
+    content: string;
+    sample_answer?: string | null;
+};

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

@@ -0,0 +1,10 @@
+import type { ConversationRating } from './ConversationRating';
+export type MentorEvalReport = {
+    readonly id: number;
+    readonly mentor_eval: string;
+    readonly mentor: string;
+    readonly conversation_ratings: Array<ConversationRating>;
+    readonly overall_score: number;
+    readonly is_passed: boolean;
+    readonly generated_at: string;
+};

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

@@ -0,0 +1,8 @@
+import type { MentorEvalQuestionRequest } from './MentorEvalQuestionRequest';
+export type MentorEvalRequest = {
+    id?: number | null;
+    name?: string | null;
+    passing_score?: number | null;
+    questions?: Array<MentorEvalQuestionRequest> | null;
+    evaluation_prompt?: string | null;
+};

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

@@ -0,0 +1,5 @@
+export type MentorFork = {
+    new_mentor_name: string;
+    destination_platform_key: string;
+    clone_documents?: boolean;
+};

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

@@ -0,0 +1,4 @@
+export type MentorFromTemplateRequest = {
+    template_name: string;
+    new_mentor_name: string;
+};

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

@@ -0,0 +1,43 @@
+import type { GreetingMethodEnum } from './GreetingMethodEnum';
+export type MentorFromTemplateWithSettingRequest = {
+    template_name: string;
+    display_name?: string;
+    description?: string;
+    profile_image?: string;
+    initial_message?: string;
+    suggested_message?: string;
+    new_mentor_name: string;
+    theme?: string;
+    user_message_color?: string;
+    mentor_bubble_color?: string;
+    align_mentor_bubble?: string;
+    system_prompt?: string;
+    llm_provider?: string;
+    llm_name?: string;
+    mentor_visibility?: string;
+    enable_image_generation?: boolean;
+    enable_web_browsing?: boolean;
+    enable_code_interpreter?: boolean;
+    metadata?: any;
+    custom_css?: string;
+    uploaded_profile_image?: string;
+    proactive_response?: string;
+    greeting_method?: GreetingMethodEnum;
+    categories?: Array<number>;
+    tool_slugs?: Array<string>;
+    llm_temperature?: number;
+    seo_tags?: any;
+    marketing_conversations?: any;
+    proactive_prompt?: string;
+    moderation_system_prompt?: string;
+    moderation_response?: string;
+    enable_moderation?: boolean;
+    enable_openai_assistant?: boolean;
+    enable_total_grounding?: boolean;
+    google_voice?: number;
+    openai_voice?: number;
+    enable_suggested_prompts?: boolean | null;
+    enable_guided_prompts?: boolean | null;
+    mcp_servers?: Array<number> | null;
+    guided_prompt_instructions?: string | null;
+};

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

@@ -0,0 +1,6 @@
+export type MentorMemorySettingsRequest = {
+    item_type?: string | null;
+    item_identifier?: string | null;
+    learner_advance_correct_rate?: number | null;
+    learner_advance_question_count?: number | null;
+};

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

@@ -0,0 +1,6 @@
+export type MentorMemorySettingsResponse = {
+    readonly item_type: string | null;
+    readonly item_identifier: string | null;
+    learner_advance_correct_rate?: number | null;
+    learner_advance_question_count?: number | null;
+};

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

@@ -0,0 +1,5 @@
+export type MentorMetadata = {
+    metadata: any;
+    mentor?: string;
+    mentor_id?: number;
+};

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

@@ -0,0 +1,6 @@
+import type { MentorScenarioPrompt } from './MentorScenarioPrompt';
+export type MentorScenario = {
+    display?: string | null;
+    name: string;
+    prompts: Array<MentorScenarioPrompt>;
+};

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

@@ -0,0 +1,5 @@
+export type MentorScenarioPrompt = {
+    summary: string;
+    content: string;
+    icon?: string;
+};

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

@@ -0,0 +1,4 @@
+export type MentorSession = {
+    session_id: string;
+    cost: number;
+};

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

@@ -0,0 +1,52 @@
+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 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>;
+};

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

@@ -0,0 +1,43 @@
+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;
+};

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

@@ -0,0 +1,53 @@
+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;
+    metadata?: any;
+    custom_css?: string | null;
+    mentor_visibility?: string;
+    enable_image_generation?: boolean;
+    enable_web_browsing?: boolean;
+    enable_code_interpreter?: boolean;
+    allow_anonymous?: 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>;
+};