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

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

@@ -1,13 +0,0 @@
-export type AIGeneratedImage = {
-    readonly id: number;
-    /**
-     * edX user ID
-     */
-    user?: number | null;
-    image: string;
-    platform?: number | null;
-    prompt?: string;
-    model?: string;
-    provider?: string;
-    readonly date_created: string;
-};

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

@@ -1,4 +0,0 @@
-export type AIUserProfileMemoryRelation = {
-    readonly tag: string;
-    detail?: string | null;
-};

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

@@ -1,4 +0,0 @@
-export type AIUserProfileRequest = {
-    tag: string;
-    detail: string;
-};

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

@@ -1,8 +0,0 @@
-/**
- * * `public` - Public
- * * `private` - Private
- */
-export declare enum AccessEnum {
-    PUBLIC = "public",
-    PRIVATE = "private"
-}

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

@@ -1,5 +0,0 @@
-export type AccessTimesHeatmap = {
-    day_of_week: number;
-    hour: number;
-    value: number;
-};

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

@@ -1,13 +0,0 @@
-/**
- * Request serializer for accessible mentors by email endpoint.
- */
-export type AccessibleMentorsByEmailRequest = {
-    /**
-     * The user email to check mentor access for
-     */
-    email?: string;
-    /**
-     * If true, return all mentors in the platform (ignoring email if present). If false (default), return only mentors owned by the user's email.
-     */
-    all_mentors?: boolean;
-};

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

@@ -1,13 +0,0 @@
-/**
- * Response serializer for accessible mentors by email.
- */
-export type AccessibleMentorsByEmailResponse = {
-    /**
-     * List of mentor unique IDs
-     */
-    readonly mentors: Array<string>;
-    /**
-     * The user ID that mentors belong to when all_mentors is False
-     */
-    readonly user_id: number | null;
-};

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

@@ -1,10 +0,0 @@
-/**
- * Action/trace name cost breakdown.
- */
-export type ActionBreakdown = {
-    action: string;
-    cost: string;
-    sessions: number;
-    trace_count: number;
-    unique_users?: number;
-};

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

@@ -1,12 +0,0 @@
-/**
- * Serializer for adding a mentor to a disclaimer.
- *
- * This serializer validates the mentor_id input and provides proper schema documentation
- * for the add_mentor action.
- */
-export type AddMentorToDisclaimer = {
-    /**
-     * The unique_id of the mentor to add to the disclaimer.
-     */
-    mentor_id: string;
-};

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

@@ -1,17 +0,0 @@
-import type { ExternalServiceInfo } from './ExternalServiceInfo';
-/**
- * For admins - returns .masked_value (all fields, sensitive ones masked).
- * Admins see that credentials are configured without seeing actual secrets.
- *
- * Inherits from StudentIntegrationCredentialSerializer, only overrides get_value.
- */
-export type AdminIntegrationCredential = {
-    readonly id: number;
-    name: string;
-    readonly value: string;
-    /**
-     * The platform key
-     */
-    readonly platform: string;
-    readonly service_info: ExternalServiceInfo;
-};

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

@@ -1,35 +0,0 @@
-import type { SkillTypeEnum } from './SkillTypeEnum';
-export type AgentSkill = {
-    readonly id: number;
-    readonly unique_id: string;
-    name: string;
-    slug: string;
-    description?: string;
-    version?: string;
-    skill_type?: SkillTypeEnum;
-    /**
-     * Grouping for the catalog UI: web, code, browser, data, etc.
-     */
-    category?: string;
-    /**
-     * Provenance for seeded/imported skills (e.g. iblai-claw-agents/higher-education/skills/canvas).
-     */
-    source?: string;
-    /**
-     * Featured skills on the 'main' platform are visible to all tenants.
-     */
-    is_featured?: boolean;
-    mentor?: string | null;
-    /**
-     * SKILL.md body — the agent runbook for this skill.
-     */
-    instruction?: string;
-    /**
-     * SKILL.md frontmatter (requires, primaryEnv, emoji, etc.).
-     */
-    metadata?: any;
-    enabled?: boolean;
-    readonly platform_key: string;
-    readonly created_at: string;
-    readonly updated_at: string;
-};

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

@@ -1,17 +0,0 @@
-import type { FileTypeEnum } from './FileTypeEnum';
-export type AgentSkillResource = {
-    readonly id: number;
-    skill: number;
-    file_type: FileTypeEnum;
-    filename: string;
-    /**
-     * Text content for script/reference resources.
-     */
-    content?: string;
-    /**
-     * Binary file for asset resources.
-     */
-    file?: string | null;
-    readonly created_at: string;
-    readonly updated_at: string;
-};

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

@@ -1,8 +0,0 @@
-/**
- * * `left` - Left
- * * `right` - Right
- */
-export declare enum AlignMentorBubbleEnum {
-    LEFT = "left",
-    RIGHT = "right"
-}

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

@@ -1,7 +0,0 @@
-import type { MetricChange } from './MetricChange';
-export type AnalyticsOverview = {
-    conversation_volume: MetricChange;
-    users: MetricChange;
-    topics: MetricChange;
-    user_rating: MetricChange;
-};

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

@@ -1,11 +0,0 @@
-/**
- * Serializer for an individual answer choice for a question.
- *
- * Attributes:
- * text (str): The text of the answer.
- * is_correct (Optional[bool]): Boolean indicating if this answer is correct.
- */
-export type Answer = {
-    text: string;
-    is_correct?: boolean;
-};

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

@@ -1,72 +0,0 @@
-/**
- * Serializer for Artifact model.
- *
- * Artifacts are structured content like essays, documents, code files, etc.
- * that are generated by AI agents during a chat session and are best
- * displayed separately from the normal chat flow.
- *
- * Fields:
- * - id: Unique identifier for the artifact
- * - title: Title or identifier for the artifact
- * - content: The markdown-styled content of the artifact
- * - file_extension: The extension of the file (e.g., 'py', 'md', 'html', 'json', 'csv')
- * - chat_message: Reference to the chat message that contains this artifact
- * - llm_name: Name of the LLM that generated the artifact
- * - llm_provider: Provider of the LLM (e.g., 'openai', 'google', 'anthropic')
- * - date_created: Timestamp when the artifact was created
- * - date_updated: Timestamp when the artifact was last updated
- * - metadata: Additional metadata for the artifact
- * - username: Username of the student who owns the artifact (read-only)
- * - session_id: UUID of the session that generated the artifact (read-only)
- *
- * Read-only fields:
- * - id, date_created, date_updated, username, session_id
- */
-export type Artifact = {
-    readonly id: number;
-    /**
-     * Title or identifier for the artifact
-     */
-    title: string;
-    /**
-     * Text content of the artifact; empty for binary artifacts
-     */
-    readonly content: string;
-    /**
-     * Base64-encoded bytes of a binary artifact (pdf, xlsx, ...); null for text artifacts. The client chooses the rendering from `file_extension`/`mime_type`.
-     */
-    readonly binary_content: string;
-    /**
-     * True when the artifact carries `binary_content` instead of `content`
-     */
-    readonly is_binary: boolean;
-    /**
-     * MIME type of a binary artifact, e.g. application/pdf.
-     */
-    readonly mime_type: string;
-    /**
-     * The extension of the file for the artifact. eg. `py`, `md`, `html`, `json`, `csv`, etc
-     */
-    readonly file_extension: string;
-    readonly llm_name: string;
-    readonly llm_provider: string;
-    readonly date_created: string;
-    readonly date_updated: string;
-    /**
-     * Additional metadata for the artifact
-     */
-    metadata?: any;
-    /**
-     * Username of the student who owns this artifact
-     */
-    readonly username: string;
-    readonly session_id: string | null;
-    /**
-     * Version number of the current version
-     */
-    readonly current_version_number: number;
-    /**
-     * Total number of versions for this artifact
-     */
-    readonly version_count: number;
-};

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

@@ -1,50 +0,0 @@
-/**
- * Lightweight serializer for listing artifacts.
- *
- * This serializer is optimized for list views, excluding the potentially
- * large content field and including useful computed fields.
- *
- * Fields:
- * - id: Unique identifier for the artifact
- * - title: Title or identifier for the artifact
- * - file_extension: The extension of the file
- * - llm_name: Name of the LLM that generated the artifact
- * - llm_provider: Provider of the LLM
- * - date_created: Timestamp when the artifact was created
- * - date_updated: Timestamp when the artifact was last updated
- * - username: Username of the student who owns the artifact
- * - session_id: UUID of the session that generated the artifact
- * - content_length: Length of the content in characters
- */
-export type ArtifactList = {
-    readonly id: number;
-    /**
-     * Title or identifier for the artifact
-     */
-    readonly title: string;
-    /**
-     * The extension of the file for the artifact. eg. `py`, `md`, `html`, `json`, `csv`, etc
-     */
-    readonly file_extension: string;
-    /**
-     * True when the artifact carries `binary_content` instead of `content`
-     */
-    readonly is_binary: boolean;
-    /**
-     * MIME type of a binary artifact, e.g. application/pdf.
-     */
-    readonly mime_type: string;
-    readonly llm_name: string;
-    readonly llm_provider: string;
-    readonly date_created: string;
-    readonly date_updated: string;
-    /**
-     * Username of the student who owns this artifact
-     */
-    readonly username: string;
-    readonly session_id: string | null;
-    /**
-     * Length of the artifact content in characters (bytes for binary artifacts)
-     */
-    readonly content_length: number;
-};

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

@@ -1,59 +0,0 @@
-import type { InterfaceEnum } from './InterfaceEnum';
-import type { VersionNestedArtifact } from './VersionNestedArtifact';
-/**
- * Serializer for ArtifactVersion model.
- *
- * Represents a single version of an artifact with its content and metadata.
- */
-export type ArtifactVersion = {
-    readonly id: number;
-    artifact: VersionNestedArtifact;
-    /**
-     * Get the title of the artifact version.
-     */
-    readonly title: string;
-    /**
-     * The markdown-styled content of this artifact version
-     */
-    content: string;
-    /**
-     * Base64-encoded bytes when the artifact is binary and this is the current version; null otherwise (binary artifacts keep one stored payload — fetch the artifact for the bytes).
-     */
-    readonly binary_content: string;
-    /**
-     * UUID of the session that generated this artifact version
-     */
-    readonly session_id: string;
-    /**
-     * Length of the version content in characters
-     */
-    readonly content_length: number;
-    /**
-     * Whether this version is the current/active version
-     */
-    readonly is_current: boolean;
-    readonly chat_message: number | null;
-    /**
-     * Sequential version number for display purposes
-     */
-    readonly version_number: number;
-    /**
-     * When this version was created
-     */
-    readonly date_created: string;
-    /**
-     * Identifier for who created this version (e.g., 'llm', 'user:username')
-     */
-    created_by?: string;
-    /**
-     * Optional summary of what changed in this version
-     */
-    change_summary?: string;
-    /**
-     * How this version was created
-     *
-     * * `chat` - Chat
-     * * `api` - Api
-     */
-    readonly interface: InterfaceEnum;
-};

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

@@ -1,4 +0,0 @@
-import type { AssumedKnowledgeLevel } from './AssumedKnowledgeLevel';
-export type AssumedKnowledge = {
-    levels: Array<AssumedKnowledgeLevel>;
-};

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

@@ -1,4 +0,0 @@
-export type AssumedKnowledgeLevel = {
-    category: string;
-    level: string;
-};

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

@@ -1,15 +0,0 @@
-export type AudioToTextRequest = {
-    file: string;
-    /**
-     * Optional mentor identifier — slug, name or unique_id. When given, that mentor's pinned transcription language and instructions are applied. Must belong to the org in the path.
-     */
-    mentor?: string;
-    /**
-     * Optional ISO-639-1 code. Overrides the mentor's pin and the platform default; omit to auto-detect.
-     */
-    language?: string;
-    /**
-     * Optional context or vocabulary hints. Overrides the mentor's transcription instructions.
-     */
-    prompt?: string;
-};

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

@@ -1,3 +0,0 @@
-export type AudioToTextResponse = {
-    text: string;
-};

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

@@ -1,12 +0,0 @@
-/**
- * * `bearer_token` - Bearer token
- * * `header` - Header
- * * `query_param` - Query param
- * * `none` - None
- */
-export declare enum AuthModeEnum {
-    BEARER_TOKEN = "bearer_token",
-    HEADER = "header",
-    QUERY_PARAM = "query_param",
-    NONE = "none"
-}

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

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

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

@@ -1,10 +0,0 @@
-/**
- * * `none` - None
- * * `token` - Token
- * * `oauth2` - Oauth2
- */
-export declare enum AuthTypeEnum {
-    NONE = "none",
-    TOKEN = "token",
-    OAUTH2 = "oauth2"
-}

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

@@ -1,37 +0,0 @@
-import type { ComparisonInfo } from './ComparisonInfo';
-import type { FinanceFilters } from './FinanceFilters';
-import type { OvertimeData } from './OvertimeData';
-import type { PeriodInfo } from './PeriodInfo';
-/**
- * Base response for all finance metrics.
- */
-export type BaseFinanceResponse = {
-    /**
-     * The metric type that was requested
-     */
-    metric: string;
-    /**
-     * Applied filters for this query
-     */
-    filters: FinanceFilters;
-    /**
-     * Primary metric value (cost in USD)
-     */
-    value: string;
-    /**
-     * Percentage change vs comparison period (null if no comparison)
-     */
-    percentage_change: number | null;
-    /**
-     * Time series data for overtime visualization
-     */
-    overtime: Array<OvertimeData>;
-    /**
-     * Information about the analysis period
-     */
-    period_info: PeriodInfo;
-    /**
-     * Information about comparison period (empty if no comparison)
-     */
-    comparison_info: ComparisonInfo;
-};

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

@@ -1,8 +0,0 @@
-/**
- * Billing period information.
- */
-export type BillingPeriod = {
-    start_date: string;
-    end_date: string;
-    days: number;
-};

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

@@ -1,15 +0,0 @@
-import type { Provider05cEnum } from './Provider05cEnum';
-export type Bot = {
-    readonly id: number;
-    readonly platform: number;
-    readonly tenant: string;
-    name: string;
-    provider: Provider05cEnum;
-    readonly is_configured: boolean;
-    slack_config: number;
-    readonly discord_config: number;
-    readonly webex_config: number;
-    readonly whatsapp_config: number;
-    readonly teams_config: number;
-    readonly webhook_url: string;
-};

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

@@ -1,6 +0,0 @@
-export type BotCommand = {
-    readonly id: number;
-    command: string;
-    mentor: number;
-    bot: number;
-};

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

@@ -1,12 +0,0 @@
-import type { Provider05cEnum } from './Provider05cEnum';
-export type BotCreate = {
-    readonly id: number;
-    name: string;
-    provider: Provider05cEnum;
-    readonly is_configured: boolean;
-    readonly webhook_url: string;
-    readonly discord_config: number;
-    readonly webex_config: number;
-    readonly whatsapp_config: number;
-    readonly teams_config: number;
-};

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

@@ -1,11 +0,0 @@
-import type { ActionBreakdown } from './ActionBreakdown';
-import type { MentorBreakdown } from './MentorBreakdown';
-import type { ProviderBreakdown } from './ProviderBreakdown';
-/**
- * Detailed breakdown of costs.
- */
-export type Breakdown = {
-    by_provider?: Array<ProviderBreakdown>;
-    by_mentor?: Array<MentorBreakdown>;
-    by_action?: Array<ActionBreakdown>;
-};

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

@@ -1,17 +0,0 @@
-/**
- * Serializer for IBL Call Pro authentication request.
- */
-export type CallAuthenticationRequest = {
-    /**
-     * The ID of the session for the call
-     */
-    session_id: string;
-    /**
-     * The pathway identifier for the call context
-     */
-    pathway: string;
-    /**
-     * Whether to enable video during the call. Required for screensharing and video calls to work.
-     */
-    enable_video?: boolean;
-};

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

@@ -1,21 +0,0 @@
-/**
- * Serializer for IBL Call Pro authentication parameters.
- */
-export type CallAuthenticationResponse = {
-    /**
-     * The WebSocket URL for the IBL Call Pro server
-     */
-    ws_url: string;
-    /**
-     * The name of the IBL Call Pro room
-     */
-    room_name: string;
-    /**
-     * The name of the participant joining the room
-     */
-    participant_name: string;
-    /**
-     * The JWT token for authenticating the participant
-     */
-    participant_token: string;
-};

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

@@ -1,38 +0,0 @@
-import type { CallConfigurationModeEnum } from './CallConfigurationModeEnum';
-import type { LlmProviderEnum } from './LlmProviderEnum';
-import type { SttProviderEnum } from './SttProviderEnum';
-import type { TtsProviderEnum } from './TtsProviderEnum';
-import type { Voice } from './Voice';
-export type CallConfiguration = {
-    readonly id: number;
-    mentor: string;
-    mode?: CallConfigurationModeEnum;
-    tts_provider?: TtsProviderEnum;
-    stt_provider?: SttProviderEnum;
-    llm_provider?: LlmProviderEnum;
-    /**
-     * Language code for TTS, STT, and LLM (e.g., 'en', 'en-US', 'es', 'fr'). Defaults to 'en' (English).
-     */
-    language?: string;
-    /**
-     * Whether to use function calls in the agent or force RAG calls before LLM generation
-     */
-    use_function_calling_for_rag?: boolean;
-    google_voice?: Voice;
-    openai_voice?: Voice;
-    openai_voice_id?: number | null;
-    google_voice_id?: number | null;
-    /**
-     * Whether to enable video for the call. (applicable only for realtime mode)
-     */
-    enable_video?: boolean;
-    /**
-     * System prompt to use for screensharing guidance. Defaults to VIDEO_GUIDANCE_PROMPT from constants.
-     */
-    screensharing_system_prompt?: string;
-    /**
-     * Proactive prompt used during screensharing calls to guide the conversation.
-     */
-    screensharing_proactive_prompt?: string;
-    readonly platform_key: string;
-};

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

@@ -1,8 +0,0 @@
-/**
- * * `realtime` - Realtime
- * * `inference` - Inference
- */
-export declare enum CallConfigurationModeEnum {
-    REALTIME = "realtime",
-    INFERENCE = "inference"
-}

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

@@ -1,27 +0,0 @@
-/**
- * Validate the subset of the OpenAI chat completions body we support.
- *
- * Unknown fields are ignored (forward-compatible with newer OpenAI clients).
- * Sampling parameters are forwarded to the provider as-is; if a provider does
- * not support one, the resulting provider error is surfaced to the caller.
- */
-export type ChatCompletionRequest = {
-    model: string;
-    messages: Array<any>;
-    stream?: boolean;
-    stream_options?: any;
-    temperature?: number;
-    top_p?: number;
-    max_tokens?: number;
-    max_completion_tokens?: number;
-    'n'?: number;
-    presence_penalty?: number;
-    frequency_penalty?: number;
-    seed?: number;
-    stop?: any;
-    user?: string;
-    tools?: any;
-    tool_choice?: any;
-    parallel_tool_calls?: boolean;
-    response_format?: any;
-};