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

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

@@ -1,208 +0,0 @@
-import type { GreetingMethodEnum } from './GreetingMethodEnum';
-import type { PrivacyActionC61Enum } from './PrivacyActionC61Enum';
-import type { StarterPromptsB04Enum } from './StarterPromptsB04Enum';
-import type { VoiceProviderD5aEnum } from './VoiceProviderD5aEnum';
-export type PatchedMentorCreate = {
-    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;
-    /**
-     * TTS provider used when synthesizing chat messages from this mentor. Selects between openai_voice and google_voice.
-     *
-     * * `browser` - Browser
-     * * `openai` - OpenAI
-     * * `google` - Google
-     */
-    voice_provider?: VoiceProviderD5aEnum;
-    /**
-     * 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;
-    /**
-     * Show catalogue on mentor.
-     */
-    show_catalogue?: boolean;
-    /**
-     * Show reasoning on mentor.
-     */
-    show_reasoning?: 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;
-    /**
-     * 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;
-    /**
-     * Enable PII detection and filtering before messages reach the LLM
-     */
-    enable_privacy_router?: 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?: PrivacyActionC61Enum;
-    /**
-     * 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;
-    /**
-     * Also filter PII from LLM responses (output rail)
-     */
-    enable_privacy_output_filter?: 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/PatchedMentorFromTemplate.d.ts

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

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

@@ -1,24 +0,0 @@
-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 PatchedMentorGraderConfig = {
-    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/PatchedMentorSettings.d.ts

@@ -1,126 +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 { Segment } from './Segment';
-import type { Subject } from './Subject';
-import type { ThemeEnum } from './ThemeEnum';
-export type PatchedMentorSettings = {
-    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 voice_instructions?: 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 show_catalogue?: boolean;
-    readonly show_reasoning?: 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 enable_privacy_router?: 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 segment?: Segment | null;
-    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 enable_voice_call?: boolean;
-    readonly system_prompt?: string;
-    readonly llm_temperature?: number;
-    readonly safety_system_prompt?: string;
-    readonly safety_response?: string;
-    readonly privacy_action?: string;
-    readonly privacy_entities?: Array<any>;
-    readonly privacy_response?: string;
-    readonly enable_privacy_output_filter?: boolean;
-    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 strip_page_content_html?: boolean;
-    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 voice_provider?: 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;
-    enable_claw?: boolean;
-};

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

@@ -1,12 +0,0 @@
-export type PatchedMentorSkillAssignment = {
-    readonly id?: number;
-    readonly mentor?: string;
-    readonly mentor_name?: string;
-    readonly mentor_slug?: string;
-    skill?: string;
-    readonly skill_name?: string;
-    readonly skill_slug?: string;
-    enabled?: boolean;
-    readonly created_at?: string;
-    readonly updated_at?: string;
-};

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

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

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

@@ -1,41 +0,0 @@
-import type { PeriodicTask } from './PeriodicTask';
-import type { PreviousAgentStatusEnum } from './PreviousAgentStatusEnum';
-export type PatchedPeriodicAgentCreate = {
-    readonly id?: number;
-    mentor?: string;
-    title?: string;
-    readonly username?: string;
-    description?: string;
-    /**
-     * Prompt for the periodic agent if any.
-     */
-    prompt?: string;
-    task?: PeriodicTask;
-    readonly created_at?: string;
-    readonly modified_at?: string;
-    readonly enabled?: boolean;
-    readonly one_off?: boolean;
-    readonly platform_key?: string;
-    pathway?: string;
-    callback_url?: string;
-    callback_secret?: string;
-    parent_session_id?: string;
-    parent_mentor_id?: number | null;
-    /**
-     * Agent that needs to run before the current agent runs.
-     */
-    previous_agent?: number | null;
-    /**
-     * The status that the previous agent must be in before this agent gets scheduled.
-     *
-     * * `success` - Success
-     * * `error` - Error
-     * * `running` - Running
-     * * `pending` - Pending
-     */
-    previous_agent_status?: PreviousAgentStatusEnum;
-    /**
-     * This will be fed into the run of this agent as part of its input prompt.
-     */
-    readonly previous_agent_output?: string;
-};

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

@@ -1,12 +0,0 @@
-export type PatchedPlayWrightScript = {
-    readonly id?: number;
-    readonly platform?: number | null;
-    /**
-     * edX user ID
-     */
-    readonly student?: number | null;
-    title?: string;
-    description?: string;
-    script?: string;
-    readonly is_public?: boolean;
-};

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

@@ -1,51 +0,0 @@
-import type { ProjectMentor } from './ProjectMentor';
-/**
- * Unified serializer for Project model.
- *
- * Write-only fields:
- * - mentors_to_add: List of mentor unique IDs to add to the project
- * - mentors_to_remove: List of mentor unique IDs to remove from the project
- *
- * These fields are mutually exclusive and only used during create/update operations.
- * For create: only mentors_to_add is used
- * For update: either can be used, but not both at once
- */
-export type PatchedProject = {
-    readonly id?: number;
-    /**
-     * Name of the project
-     */
-    name?: string;
-    /**
-     * Description of the project
-     */
-    description?: string;
-    /**
-     * Whether this project is shared with others or personal
-     */
-    shared?: boolean;
-    /**
-     * User who created this project
-     */
-    readonly owner?: number;
-    readonly owner_username?: string;
-    /**
-     * Platform this project belongs to
-     */
-    readonly platform?: number | null;
-    readonly platform_key?: string;
-    readonly platform_name?: string;
-    readonly mentor_count?: number;
-    readonly is_personal?: boolean;
-    readonly created_at?: string;
-    readonly updated_at?: string;
-    readonly mentors?: Array<ProjectMentor>;
-    /**
-     * List of mentor unique IDs to add to the project
-     */
-    mentors_to_add?: Array<string>;
-    /**
-     * List of mentor unique IDs to remove from the project
-     */
-    mentors_to_remove?: Array<string>;
-};

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

@@ -1,22 +0,0 @@
-import type { BlankEnum } from './BlankEnum';
-import type { NullEnum } from './NullEnum';
-import type { PromptVisibilityEnum } from './PromptVisibilityEnum';
-export type PatchedPrompt = {
-    readonly id?: number;
-    mentor?: string;
-    tone?: string | null;
-    style?: string;
-    language?: string;
-    tags?: Array<number>;
-    is_system?: boolean;
-    metadata?: any;
-    category?: string;
-    prompt?: string;
-    title?: string | null;
-    description?: string | null;
-    prompt_visibility?: (PromptVisibilityEnum | BlankEnum | NullEnum) | null;
-    readonly created_at?: string;
-    readonly updated_at?: string;
-    created_by?: string | null;
-    platform?: number;
-};

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

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

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

@@ -1,8 +0,0 @@
-export type PatchedSlackConfig = {
-    readonly id?: number;
-    bot?: number;
-    client_id?: string;
-    client_secret?: string;
-    app_token?: string;
-    verification_token?: string;
-};

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

@@ -1,17 +0,0 @@
-export type PatchedSlackUserConfig = {
-    readonly id?: number;
-    /**
-     * edX user ID
-     */
-    readonly user?: number;
-    /**
-     * Team Domain in the stated slack workspace. This is also the workspace name.
-     */
-    slack_team_domain?: string;
-    /**
-     * Username in the stated slack workspace
-     */
-    slack_username?: string;
-    readonly date_created?: string;
-    readonly last_modified?: string;
-};

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

@@ -1,7 +0,0 @@
-export type PatchedTeamsConfig = {
-    readonly id?: number;
-    readonly bot?: number;
-    client_id?: string;
-    client_secret?: string;
-    verification_token?: string;
-};

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

@@ -1,11 +0,0 @@
-/**
- * Serializer for the tenant-wide chat-privacy config payload.
- *
- * Shared by GET and PATCH on /orgs/{org}/chat-privacy-config/.
- */
-export type PatchedTenantChatPrivacyConfig = {
-    /**
-     * Whether the tenant allows end users to control their chat history privacy (anonymize or disable). When False, user and session preferences are ignored and history is always logged.
-     */
-    allow_user_chat_privacy_control?: boolean;
-};

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

@@ -1,10 +0,0 @@
-export type PatchedTicketMessage = {
-    readonly id?: number;
-    ticket?: number;
-    /**
-     * edX user ID
-     */
-    sender?: number | null;
-    message?: string;
-    readonly timestamp?: string;
-};

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

@@ -1,10 +0,0 @@
-export type PatchedWebexConfig = {
-    readonly id?: number;
-    readonly bot?: number;
-    /**
-     * Bot id from webex
-     */
-    webex_bot_id?: string;
-    bot_access_token?: string;
-    bot_username?: string;
-};

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

@@ -1,11 +0,0 @@
-export type PatchedWhatsappConfig = {
-    readonly id?: number;
-    readonly bot?: number;
-    phone_number_id?: string;
-    application_secret?: string;
-    webhook_verification_token?: string;
-    /**
-     * Access token to the bot. This can also be a temporary access token.
-     */
-    access_token?: string;
-};

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

@@ -1,10 +0,0 @@
-export type PatchedWhatsappUserConfig = {
-    readonly id?: number;
-    /**
-     * edX user ID
-     */
-    readonly user?: number;
-    phone_number?: string;
-    readonly date_created?: string;
-    readonly last_modified?: string;
-};

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

@@ -1,58 +0,0 @@
-/**
- * Serializer for Workflow CRUD operations.
- *
- * Provides basic ReactFlow JSON validation (Phase 1) to ensure definitions
- * are renderable, while allowing draft workflows that may not be executable.
- *
- * Comprehensive execution validation (Phase 2) is available via the
- * validate action endpoint.
- *
- * Fields:
- * - All model fields are exposed
- * - Platform and creator are set automatically from URL context
- * - Read-only fields: id, unique_id, created_at, updated_at
- * - Chat settings (chat_name, chat_greeting, etc.) update the entry_mentor
- */
-export type PatchedWorkflow = {
-    readonly id?: number;
-    readonly unique_id?: string;
-    name?: string;
-    description?: string;
-    /**
-     * Workflow definition in ReactFlow format
-     */
-    definition?: any;
-    is_active?: boolean;
-    is_template?: boolean;
-    /**
-     * Parent workflow if this is a template variant
-     */
-    parent_workflow?: number | null;
-    readonly platform?: number;
-    readonly platform_key?: string;
-    readonly platform_name?: string;
-    /**
-     * edX user ID
-     */
-    readonly created_by?: number;
-    readonly created_by_username?: string;
-    readonly created_at?: string;
-    readonly updated_at?: string;
-    /**
-     * Get the number of nodes in the workflow definition.
-     */
-    readonly node_count?: number;
-    /**
-     * Get the number of edges in the workflow definition.
-     */
-    readonly edge_count?: number;
-    readonly entry_mentor_id?: string;
-    /**
-     * Display name for chat (updates entry_mentor.name)
-     */
-    chat_name?: string;
-    /**
-     * Proactive greeting message for chat (updates entry_mentor.proactive_response)
-     */
-    chat_proactive_response?: string;
-};