@iblai/iblai-api 4.413.0-core → 4.414.0-ai

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

@@ -0,0 +1,47 @@
+/**
+ * Serializer for a single audit log entry.
+ *
+ * Transforms DMAuditLogEntry model instances into API response format.
+ */
+export type MentorAuditLogEntry = {
+    /**
+     * Audit log entry ID
+     */
+    id: number;
+    /**
+     * When the action occurred
+     */
+    timestamp: string;
+    /**
+     * Username of the user who performed the action
+     */
+    actor_username: string | null;
+    /**
+     * Email of the user who performed the action
+     */
+    actor_email: string | null;
+    /**
+     * Display name of the user who performed the action
+     */
+    actor_full_name: string | null;
+    /**
+     * Action type: create, update, or delete
+     */
+    action: string;
+    /**
+     * Type of resource modified (e.g., mentor, mentorsettings)
+     */
+    resource_type: string;
+    /**
+     * ID of the modified resource
+     */
+    resource_id: string;
+    /**
+     * Human-readable representation of the resource
+     */
+    resource_repr: string;
+    /**
+     * Dictionary of field changes with old and new values
+     */
+    changes: Record<string, any>;
+};

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

@@ -0,0 +1,9 @@
+/**
+ * Agent cost breakdown.
+ */
+export type MentorBreakdown = {
+    mentor: string;
+    cost: string;
+    sessions: number;
+    mentor_name?: string;
+};

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,267 @@
+import type { GreetingMethodEnum } from './GreetingMethodEnum';
+import type { PhiActionEnum } from './PhiActionEnum';
+import type { PrivacyActionEnum } from './PrivacyActionEnum';
+import type { StarterPromptsB04Enum } from './StarterPromptsB04Enum';
+import type { VoiceProviderEefEnum } from './VoiceProviderEefEnum';
+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;
+    /**
+     * Voice used when voice_provider is 'iblai'. Leave empty to use the tenant's configured default voice.
+     */
+    iblai_voice?: number | null;
+    /**
+     * TTS provider used when synthesizing chat messages from this mentor. Selects which of the *_voice fields applies. `iblai` synthesizes through our own gateway with the model configured on the tenant's ibl.ai routing profile, and uses iblai_voice — except when that model is an OpenAI one, which takes openai_voice.
+     *
+     * * `browser` - Browser
+     * * `openai` - OpenAI
+     * * `google` - Google
+     * * `iblai` - ibl.ai
+     */
+    voice_provider?: VoiceProviderEefEnum;
+    /**
+     * 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;
+    /**
+     * Lowercase file extensions (no dot) allowed for in-chat uploads, e.g. ['pdf','docx','png']. Empty/null = allow all supported types.
+     */
+    allowed_file_upload_extensions?: any;
+    /**
+     * 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;
+    /**
+     * Show catalogue on mentor.
+     */
+    show_catalogue?: boolean;
+    /**
+     * Show reasoning on mentor.
+     */
+    show_reasoning?: boolean;
+    /**
+     * Show the user's most recent conversation by default when the mentor is opened, so a new chat continues the last one instead of starting fresh. Off by default. Nullable for rolling deploys; NULL is treated as off at read time.
+     */
+    show_last_conversation?: boolean | null;
+    /**
+     * Whether a chat-time `document_filter` payload is honored for this mentor. Off by default: user-submitted document filters are ignored unless an admin turns this on. Nullable for rolling deploys; NULL is treated as off at read time.
+     */
+    enable_document_filter?: boolean | null;
+    /**
+     * Turn off end-user chat-privacy controls for this mentor. When on, the client hides the privacy-mode button and the API rejects any attempt to make a conversation private on this mentor — disabling a session's chat history or starting a private session returns 403. Off by default: users keep the privacy controls the tenant allows. Nullable for rolling deploys; NULL is treated as off at read time.
+     */
+    disable_privacy_mode?: boolean | null;
+    /**
+     * Let a student pick a different LLM for their current session from the chat UI, without changing this mentor's own `llm_name`/`llm_provider`. When on, an in-chat `llm_provider`/`llm_name` is validated against the tenant's credentials, stored on the session, and used for that session's turns (newest choice wins and persists until changed). Off by default: the mentor's LLM is always used. Nullable for rolling deploys; NULL is treated as off at read time.
+     */
+    enable_in_chat_llm_change?: boolean | null;
+    /**
+     * 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 display canvas on embedded mentor.
+     */
+    embed_show_canvas?: 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;
+    /**
+     * Per-mentor toggle for stripping HTML markup from `payload.page_content` before it is envelope-wrapped and cached for the LLM. Defaults to False (raw HTML reaches the prompt). Set to True to strip markup, e.g. when pages embed inline JSON/CSS in script/style tags that bloats the context window. Nullable so the add-column migration is a no-op for existing rows during a rolling multi-server deploy; a NULL value is treated as False at read time.
+     */
+    strip_page_content_html?: boolean | null;
+    enable_safety_system?: boolean;
+    /**
+     * Master switch: enable input filtering before messages reach the LLM. Which categories run is controlled by filter_pii / filter_phi.
+     */
+    enable_privacy_router?: boolean;
+    /**
+     * When the privacy router is enabled, apply PII detection/filtering (uses privacy_action / privacy_entities).
+     */
+    filter_pii?: boolean;
+    /**
+     * Action to take when PII is detected: redact replaces with labels, mask partially hides, block rejects the message, allow passes the message through unchanged while still logging the detection
+     *
+     * * `redact` - Redact
+     * * `mask` - Mask
+     * * `block` - Block
+     * * `allow` - Allow
+     */
+    privacy_action?: PrivacyActionEnum;
+    /**
+     * List of PII entity types to detect. Empty list uses defaults (PERSON, EMAIL, PHONE, SSN, etc.)
+     */
+    privacy_entities?: any;
+    /**
+     * Response shown to user when a message is blocked due to PII detection
+     */
+    privacy_response?: string;
+    /**
+     * Master switch: also filter LLM responses (output rail). Which categories run is controlled by filter_pii / filter_phi.
+     */
+    enable_privacy_output_filter?: boolean;
+    /**
+     * When the privacy router is enabled, apply PHI detection/filtering (uses phi_action / phi_entities).
+     */
+    filter_phi?: boolean;
+    /**
+     * Action to take when PHI is detected: redact replaces with labels, mask partially hides, block rejects the message, allow passes the message through unchanged while still logging the detection
+     *
+     * * `redact` - Redact
+     * * `mask` - Mask
+     * * `block` - Block
+     * * `allow` - Allow
+     */
+    phi_action?: PhiActionEnum;
+    /**
+     * List of PHI entity types to detect. Empty list detects all supported clinical and identifier entities.
+     */
+    phi_entities?: any;
+    /**
+     * Response shown to user when a message is blocked due to PHI detection
+     */
+    phi_response?: string;
+    /**
+     * 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;
+    /**
+     * Per-mentor toggle for the sandboxed quickjs code-interpreter middleware on the graph agent. Off by default: the middleware runs an in-process JS REPL that adds latency and system-resource overhead, so it is only enabled for mentors that specifically need computational tool use. Even when True, the middleware is only attached if the mentor's chosen LLM supports function calling; it is never attached for the fake graph mentors used in tests/healthchecks. Nullable so the add-column migration is a no-op for existing rows during a rolling multi-server deploy; a NULL value is treated as False at read time.
+     */
+    enable_computational_runtime?: boolean | 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/MentorFacet.d.ts

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

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

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

@@ -0,0 +1,89 @@
+import type { GreetingMethodEnum } from './GreetingMethodEnum';
+import type { MentorFromTemplateWithSettingRequestVoiceProviderEnum } from './MentorFromTemplateWithSettingRequestVoiceProviderEnum';
+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;
+    /**
+     * Lowercase file extensions (no dot) allowed for in-chat uploads. Empty list = allow all supported types.
+     */
+    allowed_file_upload_extensions?: Array<string> | null;
+    show_voice_call?: boolean;
+    show_voice_record?: boolean;
+    show_rag_images?: boolean;
+    show_catalogue?: boolean;
+    show_reasoning?: boolean;
+    show_last_conversation?: boolean;
+    enable_document_filter?: boolean;
+    disable_privacy_mode?: boolean;
+    enable_in_chat_llm_change?: 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;
+    embed_show_canvas?: 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;
+    iblai_voice?: number;
+    voice_provider?: MentorFromTemplateWithSettingRequestVoiceProviderEnum;
+    voice_instructions?: string;
+    transcription_language?: string;
+    transcription_instructions?: string;
+    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/MentorFromTemplateWithSettingRequestVoiceProviderEnum.d.ts

@@ -0,0 +1,10 @@
+/**
+ * * `openai` - openai
+ * * `google` - google
+ * * `iblai` - iblai
+ */
+export declare enum MentorFromTemplateWithSettingRequestVoiceProviderEnum {
+    OPENAI = "openai",
+    GOOGLE = "google",
+    IBLAI = "iblai"
+}

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

@@ -0,0 +1,24 @@
+import type { FeedbackModeEnum } from './FeedbackModeEnum';
+import type { GradingModeEnum } from './GradingModeEnum';
+/**
+ * Config-only surface. Criteria are managed through the criteria
+ * endpoints — keeping the two responsibilities separate.
+ */
+export type MentorGraderConfig = {
+    readonly id: number;
+    readonly mentor: string;
+    /**
+     * Selects which grading tool the mentor exposes to the LLM. Only one tool is exposed per mode so the agent can't choose between them.
+     *
+     * * `submission` - Submission
+     * * `conversation` - Conversation
+     */
+    grading_mode?: GradingModeEnum;
+    /**
+     * Describe the problem that's being graded and any special instructions outside of the rubric. The grading LLM is already instructed to give a score of 0-1 for each rubric criterion which is multiplied by the criterion's points to give earned points; overall score is total earned points / total possible points.
+     */
+    grader_instructions: string;
+    feedback_mode: FeedbackModeEnum;
+    readonly created_at: string;
+    readonly updated_at: string;
+};

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/MentorSearchResponse.d.ts

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