@iblai/iblai-api 4.202.2-ai → 4.202.2-core

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

@@ -1,161 +0,0 @@
-import type { GreetingMethodEnum } from './GreetingMethodEnum';
-import type { StarterPromptsB04Enum } from './StarterPromptsB04Enum';
-export type MentorCreate = {
-    name: string;
-    unique_id?: string;
-    /**
-     * The langflow json for the mentor
-     */
-    flow?: any;
-    slug?: string;
-    platform?: string;
-    allow_anonymous?: boolean;
-    /**
-     * Allow this mentor to be used offline with local LLMs
-     */
-    enable_offline_mode?: boolean;
-    metadata?: any;
-    enable_moderation?: boolean;
-    enable_multi_query_rag?: boolean;
-    /**
-     * Enable prompt caching for Anthropic models to reduce latency and cost. This disabled RAG and other dynamic parts of system prompt such as memory, current datetime, etc. Use with caution
-     */
-    enable_prompt_caching?: boolean;
-    enable_post_processing_system?: 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;
-    save_flagged_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>;
-    types?: Array<number>;
-    subjects?: 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;
-    /**
-     * Prompt to be used to guide the user through their studies when study mode tool is enabled.
-     */
-    study_mode_prompt?: string;
-    /**
-     * Disclaimer to be shown to the user when the mentor is used.
-     */
-    disclaimer?: string;
-    enable_disclaimer?: boolean;
-    /**
-     * Show attachments on mentor.
-     */
-    show_attachment?: boolean;
-    /**
-     * Show voice call button on mentor.
-     */
-    show_voice_call?: boolean;
-    /**
-     * Show voice recording button on mentor.
-     */
-    show_voice_record?: boolean;
-    /**
-     * Show RAG images in mentor response.
-     */
-    show_rag_images?: boolean;
-    /**
-     * Type of starter prompts to show: guided_prompt or suggested_prompt.
-     *
-     * * `guided_prompt` - Guided Prompt
-     * * `suggested_prompt` - Suggested Prompt
-     */
-    starter_prompts?: StarterPromptsB04Enum;
-    /**
-     * Allow embedded mentor to read content on the embedded web page.
-     */
-    embed_is_context_aware?: boolean;
-    /**
-     * Open mentor embed iframe by default.
-     */
-    embed_open_by_default?: boolean;
-    /**
-     * Show attachments on embedded mentor.
-     */
-    embed_show_attachment?: boolean;
-    /**
-     * Show voice call button on embedded mentor.
-     */
-    embed_show_voice_call?: boolean;
-    /**
-     * Show voice recording button on embedded mentor.
-     */
-    embed_show_voice_record?: boolean;
-    /**
-     * Show explore mentors option.
-     */
-    show_explore_mentors?: boolean;
-    /**
-     * Stores embedded icon selection data for the mentor widget.
-     */
-    embed_icon_selection_data?: any;
-    /**
-     * Placeholder to be shown in the input text area when the mentor is used.
-     */
-    placeholder_prompt?: string;
-    /**
-     * The prompt for the moderation system. This prompt must clearly distinguish between 'Approapriate' and 'Not Appropriate' queries.
-     */
-    moderation_system_prompt?: string;
-    /**
-     * Prompt to be used to alter or modify final llm response into any desired form.
-     */
-    post_processing_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/dist/types/models/MentorCustomVoice.d.ts

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

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

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

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

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

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

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

@@ -1,11 +0,0 @@
-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

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

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

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

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

@@ -1,10 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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/MentorFacet.d.ts

@@ -1,17 +0,0 @@
-/**
- * Serializer for mentor facets
- */
-export type MentorFacet = {
-    /**
-     * Total number of mentors in this facet
-     */
-    total: number;
-    /**
-     * Terms and their counts in this facet
-     */
-    terms: Record<string, any>;
-    /**
-     * Count of mentors not in any term
-     */
-    other: number;
-};

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

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

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

@@ -1,72 +0,0 @@
-import type { GreetingMethodEnum } from './GreetingMethodEnum';
-import type { StarterPrompts8c6Enum } from './StarterPrompts8c6Enum';
-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;
-    custom_javascript?: string;
-    uploaded_profile_image?: string;
-    embed_custom_image?: string;
-    proactive_response?: string;
-    greeting_method?: GreetingMethodEnum;
-    forkable?: boolean;
-    forkable_with_training_data?: boolean;
-    categories?: Array<number>;
-    types?: Array<number>;
-    subjects?: Array<number>;
-    tool_slugs?: Array<string>;
-    llm_temperature?: number;
-    seo_tags?: any;
-    marketing_conversations?: any;
-    proactive_prompt?: string;
-    study_mode_prompt?: string;
-    disclaimer?: string;
-    enable_disclaimer?: boolean;
-    show_attachment?: boolean;
-    show_voice_call?: boolean;
-    show_voice_record?: boolean;
-    show_rag_images?: boolean;
-    starter_prompts?: StarterPrompts8c6Enum;
-    embed_is_context_aware?: boolean;
-    embed_open_by_default?: boolean;
-    embed_show_attachment?: boolean;
-    embed_show_voice_call?: boolean;
-    embed_show_voice_record?: boolean;
-    show_explore_mentors?: boolean;
-    embed_icon_selection_data?: any;
-    placeholder_prompt?: string;
-    moderation_system_prompt?: string;
-    post_processing_prompt?: string;
-    moderation_response?: string;
-    enable_moderation?: boolean;
-    enable_multi_query_rag?: boolean;
-    enable_prompt_caching?: boolean;
-    enable_post_processing_system?: 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;
-    save_flagged_prompts?: boolean | null;
-    mcp_servers?: Array<number> | null;
-    guided_prompt_instructions?: string | null;
-    is_featured?: boolean;
-};

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

@@ -1,6 +0,0 @@
-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

@@ -1,6 +0,0 @@
-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

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

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

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

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

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

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

@@ -1,35 +0,0 @@
-import type { Mentor } from './Mentor';
-import type { MentorFacet } from './MentorFacet';
-/**
- * Response serializer for MentorSearchView
- */
-export type MentorSearchResponse = {
-    /**
-     * List of mentors matching the search criteria
-     */
-    results: Array<Mentor>;
-    /**
-     * Total number of mentors matching the search criteria
-     */
-    count: number;
-    /**
-     * URL for the next page of results
-     */
-    next: string | null;
-    /**
-     * URL for the previous page of results
-     */
-    previous: string | null;
-    /**
-     * Current page number
-     */
-    current_page: number;
-    /**
-     * Total number of pages
-     */
-    total_pages: number;
-    /**
-     * Facet information for filtering
-     */
-    facets?: Record<string, MentorFacet>;
-};

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

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

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

@@ -1,112 +0,0 @@
-import type { AlignMentorBubbleEnum } from './AlignMentorBubbleEnum';
-import type { BlankEnum } from './BlankEnum';
-import type { CallConfiguration } from './CallConfiguration';
-import type { MCPServer } from './MCPServer';
-import type { MentorCategory } from './MentorCategory';
-import type { MentorType } from './MentorType';
-import type { MentorVisibilityEnum } from './MentorVisibilityEnum';
-import type { NullEnum } from './NullEnum';
-import type { Subject } from './Subject';
-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 mentor_id: number;
-    readonly metadata: any;
-    mentor_visibility?: (MentorVisibilityEnum | BlankEnum | NullEnum) | null;
-    enable_image_generation?: boolean | null;
-    enable_web_browsing?: boolean | null;
-    enable_code_interpreter?: boolean | null;
-    readonly enable_memory_component: boolean;
-    custom_css?: string | null;
-    custom_javascript?: string | null;
-    readonly enable_custom_javascript: boolean;
-    readonly allow_anonymous: boolean;
-    readonly enable_offline_mode: 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 study_mode_prompt: string;
-    readonly disclaimer: string;
-    readonly enable_disclaimer: boolean;
-    readonly show_attachment: boolean;
-    readonly show_voice_call: boolean;
-    readonly show_voice_record: boolean;
-    readonly show_rag_images: boolean;
-    readonly starter_prompts: string;
-    readonly embed_is_context_aware: boolean;
-    readonly embed_open_by_default: boolean;
-    readonly embed_show_attachment: boolean;
-    readonly embed_show_voice_call: boolean;
-    readonly embed_show_voice_record: boolean;
-    readonly show_explore_mentors: boolean;
-    readonly embed_icon_selection_data: any;
-    embed_custom_image?: string | null;
-    readonly placeholder_prompt: string;
-    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 is_featured: boolean;
-    readonly enable_guided_prompts: boolean;
-    readonly save_flagged_prompts: boolean;
-    readonly enable_moderation: boolean;
-    readonly enable_multi_query_rag: boolean;
-    readonly enable_prompt_caching: boolean;
-    readonly enable_post_processing_system: boolean;
-    readonly enable_safety_system: boolean;
-    readonly forkable: boolean;
-    readonly forkable_with_training_data: boolean;
-    readonly mentor_name: string;
-    readonly categories: Array<MentorCategory>;
-    readonly types: Array<MentorType>;
-    readonly subjects: Array<Subject>;
-    readonly recently_accessed_at: string;
-    readonly created_by: string;
-    readonly created_at: string;
-    readonly updated_at: string;
-    readonly platform_key: string;
-    readonly llm_config: any;
-    readonly llm_provider: string;
-    readonly system_prompt: string;
-    readonly llm_temperature: number;
-    readonly safety_system_prompt: string;
-    readonly safety_response: string;
-    readonly moderation_system_prompt: string;
-    readonly post_processing_prompt: string;
-    readonly moderation_response: string;
-    readonly mcp_servers: Array<MCPServer>;
-    readonly department: string;
-    readonly disable_chathistory: string;
-    readonly call_configuration: CallConfiguration;
-    readonly guided_prompt_instructions: string;
-    readonly seo_tags: any;
-    readonly marketing_conversations: any;
-    readonly template_mentor: any;
-    readonly google_voice: string;
-    readonly openai_voice: string;
-    readonly enable_openai_assistant: boolean;
-    readonly enable_total_grounding: boolean;
-    readonly enable_suggested_prompts: boolean;
-    readonly is_deleted: boolean;
-    /**
-     * Enables LTI access for this mentor. When True, LTI users can be granted access via RBAC policies.
-     */
-    is_lti_accessible?: boolean | null;
-};

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

@@ -1,85 +0,0 @@
-import type { AlignMentorBubbleEnum } from './AlignMentorBubbleEnum';
-import type { BlankEnum } from './BlankEnum';
-import type { MentorCategory } from './MentorCategory';
-import type { MentorType } from './MentorType';
-import type { MentorVisibilityEnum } from './MentorVisibilityEnum';
-import type { NullEnum } from './NullEnum';
-import type { Subject } from './Subject';
-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 mentor_id: number;
-    readonly metadata: any;
-    mentor_visibility?: (MentorVisibilityEnum | BlankEnum | NullEnum) | null;
-    enable_image_generation?: boolean | null;
-    enable_web_browsing?: boolean | null;
-    enable_code_interpreter?: boolean | null;
-    readonly enable_memory_component: boolean;
-    custom_css?: string | null;
-    custom_javascript?: string | null;
-    readonly enable_custom_javascript: boolean;
-    readonly allow_anonymous: boolean;
-    readonly enable_offline_mode: 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 study_mode_prompt: string;
-    readonly disclaimer: string;
-    readonly enable_disclaimer: boolean;
-    readonly show_attachment: boolean;
-    readonly show_voice_call: boolean;
-    readonly show_voice_record: boolean;
-    readonly show_rag_images: boolean;
-    readonly starter_prompts: string;
-    readonly embed_is_context_aware: boolean;
-    readonly embed_open_by_default: boolean;
-    readonly embed_show_attachment: boolean;
-    readonly embed_show_voice_call: boolean;
-    readonly embed_show_voice_record: boolean;
-    readonly show_explore_mentors: boolean;
-    readonly embed_icon_selection_data: any;
-    embed_custom_image?: string | null;
-    readonly placeholder_prompt: string;
-    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 is_featured: boolean;
-    readonly enable_guided_prompts: boolean;
-    readonly save_flagged_prompts: boolean;
-    readonly enable_moderation: boolean;
-    readonly enable_multi_query_rag: boolean;
-    readonly enable_prompt_caching: boolean;
-    readonly enable_post_processing_system: boolean;
-    readonly enable_safety_system: boolean;
-    readonly forkable: boolean;
-    readonly forkable_with_training_data: boolean;
-    readonly mentor_name: string;
-    readonly categories: Array<MentorCategory>;
-    readonly types: Array<MentorType>;
-    readonly subjects: Array<Subject>;
-    readonly recently_accessed_at: string;
-    readonly created_by: string;
-    readonly created_at: string;
-    readonly updated_at: string;
-    readonly platform_key: string;
-    readonly llm_config: any;
-    readonly llm_provider: string;
-};