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

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

@@ -1,5 +0,0 @@
-export type LinkCourseResponse = {
-    mentor_unique_id: string;
-    course_id?: string | null;
-    is_linked: boolean;
-};

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

@@ -1,12 +0,0 @@
-/**
- * * `openai` - Openai
- * * `google` - Google
- * * `azure_openai` - Azure Openai
- * * `iblai` - ibl.ai
- */
-export declare enum LlmProviderEnum {
-    OPENAI = "openai",
-    GOOGLE = "google",
-    AZURE_OPENAI = "azure_openai",
-    IBLAI = "iblai"
-}

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

@@ -1,8 +0,0 @@
-/**
- * Response envelope for the LLM usage analytics endpoint.
- */
-export type LlmUsageAnalyticsResponse = {
-    resource: string;
-    data?: any;
-    meta?: any;
-};

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

@@ -1,67 +0,0 @@
-import type { AuthScopeEnum } from './AuthScopeEnum';
-import type { AuthTypeEnum } from './AuthTypeEnum';
-import type { MCPServerTransportEnum } from './MCPServerTransportEnum';
-import type { OAuthService } from './OAuthService';
-/**
- * Serializer for the MCPServer model.
- */
-export type MCPServer = {
-    readonly id: number;
-    readonly platform: number;
-    mentor?: string | null;
-    /**
-     * edX username
-     */
-    owner?: string | null;
-    readonly owner_email: string | null;
-    readonly owner_full_name: string | null;
-    name: string;
-    /**
-     * A description of the MCP server.
-     */
-    description?: string;
-    /**
-     * The url of the MCP server.
-     */
-    url: string;
-    image?: string | null;
-    transport?: MCPServerTransportEnum;
-    /**
-     * Authorization credentials to authenticate to the MCP server. If provided, these take priority over any headers configured on the server. Token here must be the full authorization value. For example: `<scheme> <credentials>`
-     */
-    credentials?: string;
-    /**
-     * Headers to send to the MCP server. Useful for authentication,
-     */
-    extra_headers?: any;
-    readonly platform_key: string;
-    /**
-     * Featured mcp servers will be accessible to all other tenants.
-     */
-    is_featured?: boolean;
-    /**
-     * The type of authentication to use for the MCP server.
-     *
-     * * `none` - None
-     * * `token` - Token
-     * * `oauth2` - Oauth2
-     */
-    auth_type?: AuthTypeEnum;
-    /**
-     * Determines the required authentication granularity. 'platform' uses shared platform credentials, 'mentor' requires mentor-level credentials, and 'user' requires each user to authenticate individually.
-     *
-     * * `platform` - Platform
-     * * `mentor` - Mentor
-     * * `user` - User
-     */
-    auth_scope?: AuthScopeEnum;
-    oauth_service?: number | null;
-    readonly oauth_service_data: OAuthService;
-    readonly mcp_server_connections: string;
-    /**
-     * Whether the MCP server is enabled or not.
-     */
-    is_enabled?: boolean;
-    readonly created_at: string;
-    readonly updated_at: string;
-};

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

@@ -1,49 +0,0 @@
-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;
-    readonly user_email: string | null;
-    readonly user_full_name: 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/dist/types/models/MCPServerConnectionScopeEnum.d.ts

@@ -1,10 +0,0 @@
-/**
- * * `user` - User
- * * `mentor` - Mentor
- * * `platform` - Platform
- */
-export declare enum MCPServerConnectionScopeEnum {
-    USER = "user",
-    MENTOR = "mentor",
-    PLATFORM = "platform"
-}

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

@@ -1,5 +0,0 @@
-export type MCPServerOauthFind = {
-    url: string;
-    callback_url?: string;
-    name?: string;
-};

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

@@ -1,10 +0,0 @@
-/**
- * * `sse` - Sse
- * * `websocket` - Websocket
- * * `streamable_http` - Streamable Http
- */
-export declare enum MCPServerTransportEnum {
-    SSE = "sse",
-    WEBSOCKET = "websocket",
-    STREAMABLE_HTTP = "streamable_http"
-}

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

@@ -1,25 +0,0 @@
-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/dist/types/models/MaskedLLMCredential.d.ts

@@ -1,10 +0,0 @@
-import type { ExternalServiceInfo } from './ExternalServiceInfo';
-export type MaskedLLMCredential = {
-    name: string;
-    value?: any;
-    /**
-     * The platform key
-     */
-    platform: string;
-    readonly service_info: ExternalServiceInfo;
-};

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

@@ -1,17 +0,0 @@
-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/dist/types/models/McpServerConfigTransportEnum.d.ts

@@ -1,8 +0,0 @@
-/**
- * * `sse` - sse
- * * `streamable-http` - streamable-http
- */
-export declare enum McpServerConfigTransportEnum {
-    SSE = "sse",
-    STREAMABLE_HTTP = "streamable-http"
-}

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

@@ -1,8 +0,0 @@
-import type { McpServerConfig } from './McpServerConfig';
-/**
- * Body for ``POST mcp-servers/``.
- */
-export type McpServerCreate = {
-    name: string;
-    config: McpServerConfig;
-};

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

@@ -1,8 +0,0 @@
-import type { McpServerConfig } from './McpServerConfig';
-/**
- * One entry in the MCP servers listing.
- */
-export type McpServerEntry = {
-    name: string;
-    config: McpServerConfig;
-};

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

@@ -1,4 +0,0 @@
-import type { McpServerEntry } from './McpServerEntry';
-export type McpServerListResponse = {
-    servers: Array<McpServerEntry>;
-};

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

@@ -1,5 +0,0 @@
-import type { MemoryComponentDataKindEnum } from './MemoryComponentDataKindEnum';
-export type MemoryComponentData = {
-    kind?: MemoryComponentDataKindEnum;
-    content: string;
-};

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

@@ -1,10 +0,0 @@
-/**
- * * `KnowledgeGap` - KnowledgeGap
- * * `LessonsLearned` - LessonsLearned
- * * `HelpRequest` - HelpRequest
- */
-export declare enum MemoryComponentDataKindEnum {
-    KNOWLEDGE_GAP = "KnowledgeGap",
-    LESSONS_LEARNED = "LessonsLearned",
-    HELP_REQUEST = "HelpRequest"
-}

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

@@ -1,4 +0,0 @@
-import type { MemoryComponentData } from './MemoryComponentData';
-export type MemoryComponentMemory = {
-    readonly data: Array<MemoryComponentData>;
-};

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

@@ -1,10 +0,0 @@
-import type { MemoryComponentData } from './MemoryComponentData';
-export type MemoryComponentMemoryDetail = {
-    data: Array<MemoryComponentData>;
-    readonly catalog_item: string;
-    readonly mentor_unique_id: string;
-    readonly student: string;
-    readonly student_email: string | null;
-    readonly student_full_name: string | null;
-    readonly inserted_at: string;
-};

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

@@ -1,5 +0,0 @@
-export type MemoryComponentResponse = {
-    readonly knowledge_gaps: Array<string>;
-    readonly lessons_learned: Array<string>;
-    readonly help_requests: Array<string>;
-};

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

@@ -1,8 +0,0 @@
-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/dist/types/models/MemoryStatusRequestView.d.ts

@@ -1,6 +0,0 @@
-export type MemoryStatusRequestView = {
-    /**
-     * Enable or disable memory use
-     */
-    enabled: boolean;
-};

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

@@ -1,34 +0,0 @@
-/**
- * Adds read-only ``user_email``/``user_full_name`` from a username column.
- *
- * For models that store the username but hold no FK to the user, so there is
- * nothing to traverse. Resolution costs **one query per payload**: DRF reuses
- * a single child serializer for a whole page, so the first field access reads
- * every username being serialized and looks them all up at once. A view that
- * already knows the identities can put a ``user_identity_map`` in serializer
- * context to skip the query entirely.
- *
- * ``SerializerMetaclass`` is what collects ``_declared_fields``; it also keeps
- * this out of the MRO games that subclassing ``Serializer`` into a
- * ``ModelSerializer`` would introduce.
- *
- * **Privacy invariant — resolve only from the row's own stored username.**
- * Chat privacy's ``ANONYMIZED`` mode removes identity by writing the row with
- * no username (``ibl_ai_langchain_ext/langchain/memories.py``:
- * ``None if privacy_mode == ChatPrivacyMode.ANONYMIZED else self.username``),
- * so an anonymised row reaches this mixin with nothing to look up and renders
- * nulls. That is the whole of the protection: nothing here may back-fill the
- * identity from elsewhere (``session.student``, the request user, …), or an
- * anonymised row would be re-identified in the response. Privacy mode redacts
- * conversation *text*, not identity, on the other rows this mixin serves —
- * a moderation log or run tracker keeps its username by design — so those
- * resolving an identity is intended, not a leak.
- */
-export type MemoryStatusView = {
-    readonly id: number;
-    username: string;
-    readonly user_email: string | null;
-    readonly user_full_name: string | null;
-    platform_key: string;
-    enabled?: boolean;
-};

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

@@ -1,269 +0,0 @@
-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;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * ISO-639-1 code pinned when transcribing this mentor's voice input (e.g. 'es'). Leave empty to let the provider auto-detect, which is the right choice unless learners always speak one language — a pinned language the audio is not in corrupts the whole transcript.
-     */
-    transcription_language?: string;
-    /**
-     * Context or vocabulary hints passed to transcription models that accept a prompt — proper nouns, jargon and acronyms the model would otherwise mishear. Ignored by providers that take no prompt.
-     */
-    transcription_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;
-    /**
-     * 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;
-    /**
-     * 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/dist/types/models/MentorAudience.d.ts

@@ -1,5 +0,0 @@
-export type MentorAudience = {
-    readonly id: number;
-    name: string;
-    description?: string | null;
-};