@iblai/iblai-api 4.424.0-ai → 4.424.1-core

package/src/models/PatchedWorkflow.ts

@@ -1,65 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-/**
- * 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_by_email?: string | null;
-    readonly created_by_full_name?: string | null;
-    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;
-};
-

package/src/models/PeriodInfo.ts

@@ -1,26 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Information about the analysis period.
- */
-export type PeriodInfo = {
-    /**
-     * Start date of analysis period
-     */
-    start_date?: string;
-    /**
-     * End date of analysis period
-     */
-    end_date?: string;
-    /**
-     * Number of days in period
-     */
-    period_days?: number;
-    /**
-     * Type of date range (custom, default, all_time, etc.)
-     */
-    range_type?: string;
-};
-

package/src/models/PeriodicAgent.ts

@@ -1,75 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { Mentor } from './Mentor';
-import type { PeriodicTask } from './PeriodicTask';
-import type { PreviousAgentStatusEnum } from './PreviousAgentStatusEnum';
-/**
- * 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 PeriodicAgent = {
-    readonly id: number;
-    mentor: Mentor;
-    title: string;
-    readonly username: string;
-    readonly user_email: string | null;
-    readonly user_full_name: string | null;
-    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/src/models/PeriodicAgentCreate.ts

@@ -1,74 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { PeriodicTask } from './PeriodicTask';
-import type { PreviousAgentStatusEnum } from './PreviousAgentStatusEnum';
-/**
- * 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 PeriodicAgentCreate = {
-    readonly id: number;
-    mentor: string;
-    title: string;
-    readonly username: string;
-    readonly user_email: string | null;
-    readonly user_full_name: string | null;
-    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/src/models/PeriodicAgentLog.ts

@@ -1,16 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { PeriodicAgentLogStatusEnum } from './PeriodicAgentLogStatusEnum';
-export type PeriodicAgentLog = {
-    readonly id: number;
-    content?: string;
-    status?: PeriodicAgentLogStatusEnum;
-    start_time?: string;
-    end_time?: string | null;
-    readonly created_at: string;
-    readonly modified_at: string;
-    periodic_agent: number;
-};
-

package/src/models/PeriodicAgentLogStatusEnum.ts

@@ -1,14 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-/**
- * * `success` - Success
- * * `error` - Error
- * * `running` - Running
- */
-export enum PeriodicAgentLogStatusEnum {
-    SUCCESS = 'success',
-    ERROR = 'error',
-    RUNNING = 'running',
-}

package/src/models/PeriodicAgentStatistics.ts

@@ -1,12 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type PeriodicAgentStatistics = {
-    total_tasks: number;
-    succeeded_tasks: number;
-    failed_tasks: number;
-    running_tasks: number;
-    pending_tasks: number;
-};
-

package/src/models/PeriodicTask.ts

@@ -1,26 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { CrontabSchedule } from './CrontabSchedule';
-export type PeriodicTask = {
-    readonly id: number;
-    /**
-     * Short Description For This Task
-     */
-    readonly name: string;
-    crontab: CrontabSchedule;
-    /**
-     * If True, the schedule will only run the task a single time
-     */
-    one_off?: boolean;
-    /**
-     * Datetime when the schedule should begin triggering the task to run
-     */
-    start_time?: string | null;
-    /**
-     * Set to False to disable the schedule
-     */
-    enabled?: boolean;
-};
-

package/src/models/PhiActionEnum.ts

@@ -1,16 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-/**
- * * `redact` - Redact
- * * `mask` - Mask
- * * `block` - Block
- * * `allow` - Allow
- */
-export enum PhiActionEnum {
-    REDACT = 'redact',
-    MASK = 'mask',
-    BLOCK = 'block',
-    ALLOW = 'allow',
-}

package/src/models/PieChartData.ts

@@ -1,10 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { PieChartSegment } from './PieChartSegment';
-export type PieChartData = {
-    new_users: PieChartSegment;
-    returning_users: PieChartSegment;
-};
-

package/src/models/PieChartSegment.ts

@@ -1,9 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type PieChartSegment = {
-    count: number;
-    percentage: number;
-};
-

package/src/models/PinnedMessageCreate.ts

@@ -1,14 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type PinnedMessageCreate = {
-    readonly id: number;
-    /**
-     * The platform key
-     */
-    platform: string;
-    username: string;
-    session_id: string | null;
-};
-

package/src/models/PinnedMessageRequest.ts

@@ -1,11 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type PinnedMessageRequest = {
-    /**
-     * Session id of the message to pin
-     */
-    session_id: string;
-};
-

package/src/models/PlatformPrompt.ts

@@ -1,39 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { RecommendationTypeEnum } from './RecommendationTypeEnum';
-/**
- * Serializer for platform recommendation prompt management.
- *
- * Used by instructors/admins to configure tenant-specific prompts for different SPAs.
- * A platform can have multiple prompts (one per SPA/frontend).
- *
- * Note: spa_url will be automatically normalized (protocol stripped, lowercase) during validation.
- */
-export type PlatformPrompt = {
-    /**
-     * Platform key this prompt belongs to
-     */
-    platform_key?: string;
-    /**
-     * The custom recommendation strategy prompt
-     */
-    prompt_text?: string;
-    /**
-     * Prompt category. Use 'catalog' for courses/programs/resources/pathways; use 'mentors' for mentor prompts.
-     *
-     * * `mentors` - Mentor Recommendations
-     * * `catalog` - Catalog Recommendations
-     */
-    recommendation_type?: RecommendationTypeEnum;
-    /**
-     * Frontend/SPA identifier (e.g., 'catalog.example.com', 'mentor-ai.ibl.com', 'https://mentor-ai.ibl.com'). Protocol and case will be normalized automatically. Leave blank for platform-wide prompts.
-     */
-    spa_url?: string | null;
-    /**
-     * Whether this prompt is currently active
-     */
-    active?: boolean;
-};
-

package/src/models/PlatformPromptResponse.ts

@@ -1,21 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Response serializer for platform prompt retrieval.
- */
-export type PlatformPromptResponse = {
-    platform_key: string;
-    prompt_text: string;
-    recommendation_type: string;
-    spa_url?: string | null;
-    active: boolean;
-    created_at: string;
-    updated_at: string;
-    /**
-     * Username of who created this prompt
-     */
-    created_by?: string | null;
-};
-

package/src/models/PredictiveAnalyticsRequest.ts

@@ -1,9 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { ReuestDataVariableList } from './ReuestDataVariableList';
-export type PredictiveAnalyticsRequest = {
-    prompt: ReuestDataVariableList;
-};
-

package/src/models/PredictiveAnalyticsResponse.ts

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

package/src/models/PreviousAgentStatusEnum.ts

@@ -1,16 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-/**
- * * `success` - Success
- * * `error` - Error
- * * `running` - Running
- * * `pending` - Pending
- */
-export enum PreviousAgentStatusEnum {
-    SUCCESS = 'success',
-    ERROR = 'error',
-    RUNNING = 'running',
-    PENDING = 'pending',
-}

package/src/models/PrivacyActionEnum.ts

@@ -1,16 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-/**
- * * `redact` - Redact
- * * `mask` - Mask
- * * `block` - Block
- * * `allow` - Allow
- */
-export enum PrivacyActionEnum {
-    REDACT = 'redact',
-    MASK = 'mask',
-    BLOCK = 'block',
-    ALLOW = 'allow',
-}

package/src/models/PrivacyFlag.ts

@@ -1,40 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { ActionTakenEnum } from './ActionTakenEnum';
-import type { BlankEnum } from './BlankEnum';
-import type { PrivacyFlagSourceEnum } from './PrivacyFlagSourceEnum';
-import type { RailEnum } from './RailEnum';
-/**
- * A single PII/PHI detection surfaced for tenant-admin auditing.
- *
- * Read-only. Identity (``username``/``email``/``user_full_name``) is resolved
- * through the ``user`` FK — free of extra queries as long as the view
- * ``select_related``s ``user``. A flag whose user has since been deleted (FK
- * nulled) reports null identity rather than raising. Only entity *types* are
- * exposed in ``detected_entities`` — never the raw detected values.
- */
-export type PrivacyFlag = {
-    readonly id: number;
-    /**
-     * edX user ID
-     */
-    user?: number | null;
-    readonly username: string | null;
-    readonly email: string | null;
-    readonly user_full_name: string | null;
-    platform_key: string;
-    mentor?: number | null;
-    session_id?: string;
-    rail: RailEnum;
-    action_taken?: (ActionTakenEnum | BlankEnum);
-    source: PrivacyFlagSourceEnum;
-    detected_entities?: any;
-    file_name?: string;
-    file_content_type?: string;
-    file_size?: number | null;
-    file_reference?: string;
-    readonly date_created: string;
-};
-

package/src/models/PrivacyFlagSourceEnum.ts

@@ -1,20 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-/**
- * * `text_prompt` - Text prompt
- * * `file_text` - File (text)
- * * `file_image` - File (image)
- * * `file_pdf` - File (PDF)
- * * `llm_response` - LLM response
- * * `memory_retrieval` - Memory retrieval
- */
-export enum PrivacyFlagSourceEnum {
-    TEXT_PROMPT = 'text_prompt',
-    FILE_TEXT = 'file_text',
-    FILE_IMAGE = 'file_image',
-    FILE_PDF = 'file_pdf',
-    LLM_RESPONSE = 'llm_response',
-    MEMORY_RETRIEVAL = 'memory_retrieval',
-}

package/src/models/Project.ts

@@ -1,58 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-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 Project = {
-    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;
-    readonly owner_email: string | null;
-    readonly owner_full_name: string | null;
-    /**
-     * 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/src/models/ProjectMentor.ts

@@ -1,16 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Serializer for mentors within a project.
- */
-export type ProjectMentor = {
-    readonly id: number;
-    name: string;
-    description?: string | null;
-    readonly unique_id: string;
-    readonly slug: string;
-    readonly created_at: string | null;
-};
-

package/src/models/Prompt.ts

@@ -1,27 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { BlankEnum } from './BlankEnum';
-import type { NullEnum } from './NullEnum';
-import type { PromptVisibilityEnum } from './PromptVisibilityEnum';
-export type Prompt = {
-    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;
-};
-