@iblai/iblai-api 3.38.2-ai-plus → 3.38.3-core

package/src/models/Mentor.ts

@@ -1,85 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-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/src/models/MentorAudience.ts

@@ -1,10 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type MentorAudience = {
-    readonly id: number;
-    name: string;
-    description?: string | null;
-};
-

package/src/models/MentorCategory.ts

@@ -1,14 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-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/src/models/MentorCategoryCreate.ts

@@ -1,16 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-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/src/models/MentorCategoryGroup.ts

@@ -1,16 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-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/src/models/MentorCategoryGroupCreate.ts

@@ -1,16 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-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/src/models/MentorCreate.ts

@@ -1,84 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-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;
-    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;
-};
-

package/src/models/MentorCustomVoice.ts

@@ -1,9 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type MentorCustomVoice = {
-    voice_provider: string;
-    voice_name?: string | null;
-};
-

package/src/models/MentorCustomVoiceResponse.ts

@@ -1,9 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type MentorCustomVoiceResponse = {
-    readonly voice_provider: string;
-    readonly voice_name: string;
-};
-

package/src/models/MentorData.ts

@@ -1,12 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { MentorSession } from './MentorSession';
-export type MentorData = {
-    mentor_unique_id: string;
-    mentor_name: string;
-    total_cost: number;
-    mentor_sessions: Array<MentorSession>;
-};
-

package/src/models/MentorDetailAnalytics.ts

@@ -1,11 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type MentorDetailAnalytics = {
-    total_mentors: number;
-    active_mentors: number;
-    total_questions_answered: number;
-    total_ratings: number;
-};
-

package/src/models/MentorEval.ts

@@ -1,16 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-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/src/models/MentorEvalQuestion.ts

@@ -1,10 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type MentorEvalQuestion = {
-    readonly id: number;
-    content: string;
-    sample_answer?: string | null;
-};
-

package/src/models/MentorEvalQuestionRequest.ts

@@ -1,9 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type MentorEvalQuestionRequest = {
-    content: string;
-    sample_answer?: string | null;
-};
-

package/src/models/MentorEvalReport.ts

@@ -1,15 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-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/src/models/MentorEvalRequest.ts

@@ -1,13 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-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/src/models/MentorFork.ts

@@ -1,10 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type MentorFork = {
-    new_mentor_name: string;
-    destination_platform_key: string;
-    clone_documents?: boolean;
-};
-

package/src/models/MentorFromTemplateRequest.ts

@@ -1,9 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type MentorFromTemplateRequest = {
-    template_name: string;
-    new_mentor_name: string;
-};
-

package/src/models/MentorFromTemplateWithSettingRequest.ts

@@ -1,48 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-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/src/models/MentorMemorySettingsRequest.ts

@@ -1,11 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type MentorMemorySettingsRequest = {
-    item_type?: string | null;
-    item_identifier?: string | null;
-    learner_advance_correct_rate?: number | null;
-    learner_advance_question_count?: number | null;
-};
-

package/src/models/MentorMemorySettingsResponse.ts

@@ -1,11 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-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/src/models/MentorMetadata.ts

@@ -1,10 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type MentorMetadata = {
-    metadata: any;
-    mentor?: string;
-    mentor_id?: number;
-};
-

package/src/models/MentorScenario.ts

@@ -1,11 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { MentorScenarioPrompt } from './MentorScenarioPrompt';
-export type MentorScenario = {
-    display?: string | null;
-    name: string;
-    prompts: Array<MentorScenarioPrompt>;
-};
-

package/src/models/MentorScenarioPrompt.ts

@@ -1,10 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type MentorScenarioPrompt = {
-    summary: string;
-    content: string;
-    icon?: string;
-};
-

package/src/models/MentorSession.ts

@@ -1,9 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type MentorSession = {
-    session_id: string;
-    cost: number;
-};
-

package/src/models/MentorSettings.ts

@@ -1,59 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-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>;
-    readonly department: string;
-    readonly disable_chathistory: string;
-};
-

package/src/models/MentorSettingsPublic.ts

@@ -1,48 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-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;
-};
-