@iblai/iblai-api 4.331.0-core → 4.332.0-ai

package/src/models/MCPServerConnection.ts

@@ -0,0 +1,52 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { AuthTypeEnum } from './AuthTypeEnum';
+import type { MCPServerConnectionScopeEnum } from './MCPServerConnectionScopeEnum';
+/**
+ * Serializer for managing `MCPServerConnection` records via the API.
+ *
+ * The serializer enforces the business rules for combining scope, platform,
+ * and authentication configuration while exposing a masked view of any stored
+ * credentials.
+ */
+export type MCPServerConnection = {
+    readonly id: number;
+    server: number;
+    readonly server_name: string;
+    /**
+     * Whether this connection is scoped to a user or shared across a platform.
+     *
+     * * `user` - User
+     * * `mentor` - Mentor
+     * * `platform` - Platform
+     */
+    scope?: MCPServerConnectionScopeEnum;
+    auth_type?: AuthTypeEnum;
+    platform?: number | null;
+    readonly platform_key: string | null;
+    /**
+     * edX username
+     */
+    user?: string | null;
+    mentor?: string | null;
+    connected_service?: number | null;
+    readonly connected_service_summary: Record<string, any> | null;
+    /**
+     * Static credential/token value for token-based authentication.
+     */
+    credentials?: string;
+    /**
+     * Authorization scheme to prefix tokens with (e.g. 'Bearer').
+     */
+    authorization_scheme?: string;
+    /**
+     * Additional headers to include when connecting to the MCP server.
+     */
+    extra_headers?: any;
+    is_active?: boolean;
+    readonly created_at: string;
+    readonly updated_at: string;
+};
+

package/src/models/MCPServerConnectionScopeEnum.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `user` - User
+ * * `mentor` - Mentor
+ * * `platform` - Platform
+ */
+export enum MCPServerConnectionScopeEnum {
+    USER = 'user',
+    MENTOR = 'mentor',
+    PLATFORM = 'platform',
+}

package/src/models/MCPServerOauthFind.ts

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

package/src/models/MCPServerTransportEnum.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `sse` - Sse
+ * * `websocket` - Websocket
+ * * `streamable_http` - Streamable Http
+ */
+export enum MCPServerTransportEnum {
+    SSE = 'sse',
+    WEBSOCKET = 'websocket',
+    STREAMABLE_HTTP = 'streamable_http',
+}

package/src/models/MaskedIntegrationCredential.ts

@@ -0,0 +1,30 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ExternalServiceInfo } from './ExternalServiceInfo';
+/**
+ * Used for POST / PATCH responses on the integration-credential endpoint.
+ *
+ * ``to_representation`` substitutes ``IntegrationCredential.masked_value``
+ * for the raw ``value`` field, so sensitive fields (as flagged by the
+ * linked v2 ``IntegrationCredentialSchema``) come out masked
+ * (e.g. ``"sk-****"``). Admin-only — GET responses go through
+ * ``AdminIntegrationCredentialSerializer`` or
+ * ``StudentIntegrationCredentialSerializer`` instead, depending on caller
+ * role.
+ */
+export type MaskedIntegrationCredential = {
+    name: string;
+    /**
+     * Returns non-sensitive fields only.
+     * Safe to return to students.
+     */
+    readonly value: Record<string, any>;
+    /**
+     * The platform key
+     */
+    platform: string;
+    readonly service_info: ExternalServiceInfo;
+};
+

package/src/models/MaskedLLMCredential.ts

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ExternalServiceInfo } from './ExternalServiceInfo';
+export type MaskedLLMCredential = {
+    name: string;
+    value?: any;
+    /**
+     * The platform key
+     */
+    platform: string;
+    readonly service_info: ExternalServiceInfo;
+};
+

package/src/models/McpServerConfig.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { McpServerConfigTransportEnum } from './McpServerConfigTransportEnum';
+/**
+ * ``McpServerSchema`` from ``src/config/zod-schema.ts``.
+ *
+ * All fields are optional (``catchall(unknown)`` on the upstream side) so
+ * callers can submit subsets.  Extra fields are allowed.
+ */
+export type McpServerConfig = {
+    command?: string;
+    args?: Array<string>;
+    env?: Record<string, any>;
+    cwd?: string;
+    workingDirectory?: string;
+    url?: string;
+    transport?: McpServerConfigTransportEnum;
+    headers?: Record<string, any>;
+};
+

package/src/models/McpServerConfigTransportEnum.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `sse` - sse
+ * * `streamable-http` - streamable-http
+ */
+export enum McpServerConfigTransportEnum {
+    SSE = 'sse',
+    STREAMABLE_HTTP = 'streamable-http',
+}

package/src/models/McpServerCreate.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { McpServerConfig } from './McpServerConfig';
+/**
+ * Body for ``POST mcp-servers/``.
+ */
+export type McpServerCreate = {
+    name: string;
+    config: McpServerConfig;
+};
+

package/src/models/McpServerEntry.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { McpServerConfig } from './McpServerConfig';
+/**
+ * One entry in the MCP servers listing.
+ */
+export type McpServerEntry = {
+    name: string;
+    config: McpServerConfig;
+};
+

package/src/models/McpServerListResponse.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { McpServerEntry } from './McpServerEntry';
+export type McpServerListResponse = {
+    servers: Array<McpServerEntry>;
+};
+

package/src/models/MemoryComponentData.ts

@@ -0,0 +1,10 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { MemoryComponentDataKindEnum } from './MemoryComponentDataKindEnum';
+export type MemoryComponentData = {
+    kind?: MemoryComponentDataKindEnum;
+    content: string;
+};
+

package/src/models/MemoryComponentDataKindEnum.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `KnowledgeGap` - KnowledgeGap
+ * * `LessonsLearned` - LessonsLearned
+ * * `HelpRequest` - HelpRequest
+ */
+export enum MemoryComponentDataKindEnum {
+    KNOWLEDGE_GAP = 'KnowledgeGap',
+    LESSONS_LEARNED = 'LessonsLearned',
+    HELP_REQUEST = 'HelpRequest',
+}

package/src/models/MemoryComponentMemory.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { MemoryComponentData } from './MemoryComponentData';
+export type MemoryComponentMemory = {
+    readonly data: Array<MemoryComponentData>;
+};
+

package/src/models/MemoryComponentMemoryDetail.ts

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

@@ -0,0 +1,10 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type MemoryComponentResponse = {
+    readonly knowledge_gaps: Array<string>;
+    readonly lessons_learned: Array<string>;
+    readonly help_requests: Array<string>;
+};
+

package/src/models/MemoryProgress.ts

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

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type MemoryStatusRequestView = {
+    /**
+     * Enable or disable memory use
+     */
+    enabled: boolean;
+};
+

package/src/models/MemoryStatusView.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type MemoryStatusView = {
+    readonly id: number;
+    username: string;
+    platform_key: string;
+    enabled?: boolean;
+};
+

package/src/models/Mentor.ts

@@ -0,0 +1,258 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { CallConfiguration } from './CallConfiguration';
+import type { GreetingMethodEnum } from './GreetingMethodEnum';
+import type { MCPServer } from './MCPServer';
+import type { MentorCategory } from './MentorCategory';
+import type { MentorType } from './MentorType';
+import type { PhiActionEnum } from './PhiActionEnum';
+import type { PrivacyActionEnum } from './PrivacyActionEnum';
+import type { StarterPromptsB04Enum } from './StarterPromptsB04Enum';
+import type { Subject } from './Subject';
+import type { VoiceProviderEefEnum } from './VoiceProviderEefEnum';
+export type Mentor = {
+    readonly id: number;
+    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;
+    /**
+     * Instructions to determine how prompt suggestions are generated.
+     */
+    guided_prompt_instructions?: string;
+    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. `iblai` reaches OpenAI's TTS models through our own gateway and uses openai_voice, unless it is configured with a non-OpenAI model.
+     *
+     * * `browser` - Browser
+     * * `openai` - OpenAI
+     * * `google` - Google
+     * * `iblai` - ibl.ai
+     */
+    voice_provider?: VoiceProviderEefEnum;
+    /**
+     * Free-form instructions describing the desired voice and reading style (tone, pace, emotion, accent) for TTS synthesis. Passed to providers that support style prompts: OpenAI as the speech ``instructions`` and Google as the synthesis ``prompt``. Ignored by providers/voices that don't support styling.
+     */
+    voice_instructions?: string;
+    categories: Array<MentorCategory>;
+    types: Array<MentorType>;
+    /**
+     * Whether the mentor is featured or not.
+     */
+    is_featured?: boolean;
+    subjects: Array<Subject>;
+    /**
+     * 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 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;
+    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;
+    /**
+     * 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;
+    call_configuration?: CallConfiguration;
+    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;
+    /**
+     * 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/src/models/MentorAudience.ts

@@ -0,0 +1,10 @@
+/* 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/MentorAuditLogEntry.ts

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

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Mentor cost breakdown.
+ */
+export type MentorBreakdown = {
+    mentor: string;
+    cost: string;
+    sessions: number;
+    mentor_name?: string;
+};
+

package/src/models/MentorCategory.ts

@@ -0,0 +1,14 @@
+/* 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>;
+};
+