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

package/dist/types/services/AnalyticsService.d.ts

@@ -1,233 +0,0 @@
-import type { BaseFinanceResponse } from '../models/BaseFinanceResponse';
-import type { FinanceDetailsResponse } from '../models/FinanceDetailsResponse';
-import type { CancelablePromise } from '../core/CancelablePromise';
-export declare class AnalyticsService {
-    /**
-     * Financial Analytics API - Get comprehensive cost metrics with comparison analysis.
-     *
-     * This endpoint provides period-based cost analysis (not cumulative) with support for:
-     * - Multiple time granularities and metrics
-     * - Cross-dimensional filtering
-     * - Percentage change vs comparison periods
-     * - Forward-filled time series
-     *
-     * **Examples:**
-     *
-     * **Basic Weekly Costs:**
-     * ```
-     * GET /api/v2/analytics/financial/?metric=weekly_costs&comparison_days=10
-     * ```
-     *
-     * **Platform & Mentor Filtered:**
-     * ```
-     * # Get total costs for a specific platform and mentor
-     * GET /api/v2/analytics/financial/?metric=total_costs&platform_key=web-app&mentor_unique_id=mentor-123&comparison_days=14
-     * ```
-     *
-     * **Monthly Costs by Provider:**
-     * ```
-     * GET /api/v2/analytics/financial/?metric=monthly_costs&provider=openai&granularity=month&comparison_days=30
-     * ```
-     *
-     * **Daily Costs for Specific User:**
-     * ```
-     * GET /api/v2/analytics/financial/?metric=total_costs&username=user-456&granularity=day&start_date=2025-01-15&end_date=2025-01-21&comparison_days=7
-     * ```
-     *
-     *
-     * **Response Structure:**
-     * ```json
-     * {
-         * "metric": "weekly_costs",
-         * "value": 12.47,
-         * "percentage_change": 8.5,
-         * "overtime": [
-             * {"date": "2025-01-06", "value": 2.89},
-             * {"date": "2025-01-13", "value": 3.12}
-             * ],
-             * "period_info": {
-                 * "start_date": "2025-01-01",
-                 * "end_date": "2025-01-31",
-                 * "period_days": 31
-                 * },
-                 * "comparison_info": {
-                     * "previous_period_value": 11.50,
-                     * ...
-                     * }
-                     * }
-                     * ```
-                     * @returns BaseFinanceResponse Successful financial metrics response with period-based cost data
-                     * @throws ApiError
-                     */
-    static analyticsFinancialRetrieve({ metric, allTime, comparisonDays, endDate, fillMethod, granularity, llmModel, mentorUniqueId, platformKey, provider, showOvertime, startDate, username, }: {
-        /**
-         * Type of financial metric to retrieve
-         *
-         * * `total_costs` - Total costs for selected timeframe
-         * * `weekly_costs` - Costs for current/selected week
-         * * `monthly_costs` - Costs for current/selected month
-         */
-        metric: 'total_costs' | 'weekly_costs' | 'monthly_costs';
-        /**
-         * calculate from platform inception (ignores date filters)
-         */
-        allTime?: boolean;
-        /**
-         * Number of days for comparison period to calculate percentage change (e.g., 10 for 10-day comparison)
-         */
-        comparisonDays?: number;
-        /**
-         * End date for analysis (YYYY-MM-DD). Defaults to today.
-         */
-        endDate?: string;
-        /**
-         * Method for filling missing time periods in overtime data
-         *
-         * * `zero` - Fill missing periods with zero
-         * * `previous` - Fill missing periods with previous value
-         */
-        fillMethod?: 'zero' | 'previous';
-        /**
-         * Time granularity for overtime series data
-         *
-         * * `day` - Daily data points
-         * * `week` - Weekly data points
-         * * `month` - Monthly data points
-         */
-        granularity?: 'day' | 'week' | 'month';
-        /**
-         * Filter by specific LLM model (e.g., gpt-4o, claude-3-5-sonnet)
-         */
-        llmModel?: string;
-        /**
-         * Filter by specific mentor ID
-         */
-        mentorUniqueId?: string;
-        /**
-         * Filter by specific platform key
-         */
-        platformKey?: string;
-        /**
-         * Filter by AI provider
-         *
-         * * `openai` - OpenAI
-         * * `anthropic` - Anthropic
-         * * `azure` - Azure
-         * * `google` - Google
-         * * `meta` - Meta
-         * * `other` - Other
-         */
-        provider?: 'openai' | 'anthropic' | 'azure' | 'google' | 'meta' | 'other';
-        /**
-         * Whether to include overtime series data in response
-         */
-        showOvertime?: boolean;
-        /**
-         * Start date for analysis (YYYY-MM-DD). Defaults to 30 days ago.
-         */
-        startDate?: string;
-        /**
-         * Filter by specific username - returns costs for this user only
-         */
-        username?: string;
-    }): CancelablePromise<BaseFinanceResponse>;
-    /**
-     * Financial Details Analytics API – paginated cost tables with flexible grouping.
-     *
-     * This endpoint returns tabular cost metrics aggregated by the dimension
-     * specified via the `group_by` query parameter.  One or more KPI columns
-     * can be requested through the comma-separated `metrics` list while
-     * typical filters (date range, provider, platform_key, user, etc.) narrow the
-     * dataset.  Results are paginated with `page` / `limit`.
-     *
-     * **Required query parameters**
-     * - group_by – provider | llm_model | username | user_id | date | session_id
-     * - metrics – csv list of KPI names, e.g. total_cost, sessions, cost_per_session
-     *
-     * **Shared optional filters**
-     * - start_date, end_date   – ISO yyyy-mm-dd (ignored when all_time=true)
-     * - platform_key           – tenant isolation
-     * - mentor_unique_id       – filter to one mentor
-     * - username / user_id     – filter to a learner
-     * - provider / llm_model   – filter to LLM provider / model
-     * - all_time               – true → lifetime totals
-     * - page (default 1), limit (default 50)
-     *
-     * **Examples**
-     * --------
-     * 1. Cost by provider for the last week
-     * ```
-     * GET /api/v2/analytics/financial/details?
-     * group_by=provider&
-     * metrics=total_cost&
-     * start_date=2025-01-01&
-     * end_date=2025-01-07&
-     * page=1&limit=10
-     * ```
-     *
-     * 2. Lifetime cost per user with extra KPIs
-     * ```
-     * GET /api/v2/analytics/financial/details?
-     * group_by=username&
-     * metrics=total_cost,sessions,cost_per_session&
-     * all_time=true&page=1&limit=50
-     * ```
-     * 3. Cost by LLM model with tenant filter
-     * ```
-     * GET /api/v2/analytics/financial/details?
-     * group_by=llm_model&
-     * metrics=total_cost&
-     * platform_key=web-app&
-     * start_date=2025-01-01&end_date=2025-01-31
-     * ```
-     * Response structure
-     * -------------------
-     * ```
-     * {
-         * "page": 1,
-         * "limit": 10,
-         * "total_pages": 1,
-         * "total_records": 3,
-         * "rows": [
-             * {"provider": "openai", "total_cost": 2.5},
-             * {"provider": "anthropic", "total_cost": 1.0},
-             * {"provider": "azure",    "total_cost": 0.5}
-             * ],
-             * "metrics": [
-                 * {
-                     * "name": "total_cost",
-                     * "unit": "$",
-                     * "description": "Cost for this entity in period"
-                     * }
-                     * ],
-                     * "total_cost": 4.0   // optional grand-total when available
-                     * }
-                     * ``
-                     * @returns FinanceDetailsResponse
-                     * @throws ApiError
-                     */
-    static analyticsFinancialDetailsRetrieve({ groupBy, allTime, endDate, limit, llmModel, mentorUniqueId, metrics, page, platformKey, provider, startDate, username, }: {
-        /**
-         * Dimension to group by
-         *
-         * * `provider` - Group by provider
-         * * `llm_model` - Group by LLM model
-         * * `username` - Group by username
-         */
-        groupBy: 'provider' | 'llm_model' | 'username';
-        allTime?: boolean;
-        endDate?: string;
-        limit?: number;
-        llmModel?: string;
-        mentorUniqueId?: string;
-        /**
-         * Comma-separated list of metrics (e.g. total_cost,sessions, last_active)
-         */
-        metrics?: string;
-        page?: number;
-        platformKey?: string;
-        provider?: string;
-        startDate?: string;
-        username?: string;
-    }): CancelablePromise<FinanceDetailsResponse>;
-}

package/src/models/AIGeneratedImage.ts

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

@@ -1,9 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type AIUserProfileMemoryRelation = {
-    readonly tag: string;
-    detail?: string | null;
-};
-

package/src/models/AIUserProfileRequest.ts

@@ -1,9 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type AIUserProfileRequest = {
-    tag: string;
-    detail: string;
-};
-

package/src/models/AccessEnum.ts

@@ -1,12 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-/**
- * * `public` - Public
- * * `private` - Private
- */
-export enum AccessEnum {
-    PUBLIC = 'public',
-    PRIVATE = 'private',
-}

package/src/models/AlignMentorBubbleEnum.ts

@@ -1,12 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-/**
- * * `left` - Left
- * * `right` - Right
- */
-export enum AlignMentorBubbleEnum {
-    LEFT = 'left',
-    RIGHT = 'right',
-}

package/src/models/AnalyticsOverview.ts

@@ -1,12 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { MetricChange } from './MetricChange';
-export type AnalyticsOverview = {
-    conversation_volume: MetricChange;
-    users: MetricChange;
-    topics: MetricChange;
-    user_rating: MetricChange;
-};
-

package/src/models/Answer.ts

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

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

package/src/models/AssumedKnowledgeLevel.ts

@@ -1,9 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type AssumedKnowledgeLevel = {
-    category: string;
-    level: string;
-};
-

package/src/models/AudioToTextRequest.ts

@@ -1,8 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type AudioToTextRequest = {
-    file: string;
-};
-

package/src/models/AudioToTextResponse.ts

@@ -1,8 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type AudioToTextResponse = {
-    text: string;
-};
-

package/src/models/AutoMemoryPrompt.ts

@@ -1,9 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type AutoMemoryPrompt = {
-    auto_memory_prompt?: string;
-    reset?: boolean;
-};
-

package/src/models/BaseFinanceResponse.ts

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

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

package/src/models/CallAuthenticationResponse.ts

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

@@ -1,31 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-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: number;
-    mode?: CallConfigurationModeEnum;
-    tts_provider?: TtsProviderEnum;
-    stt_provider?: SttProviderEnum;
-    llm_provider?: LlmProviderEnum;
-    /**
-     * 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;
-    readonly platform_key: string;
-};
-

package/src/models/CallConfigurationModeEnum.ts

@@ -1,12 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-/**
- * * `realtime` - Realtime
- * * `inference` - Inference
- */
-export enum CallConfigurationModeEnum {
-    REALTIME = 'realtime',
-    INFERENCE = 'inference',
-}

package/src/models/ChatHistory.ts

@@ -1,13 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type ChatHistory = {
-    readonly id: number;
-    message?: any;
-    readonly inserted_at: string;
-    title?: string | null;
-    readonly feedback: any;
-    document_sources?: any;
-};
-

package/src/models/ChatHistoryFilterData.ts

@@ -1,14 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { ChatHistoryFilterUser } from './ChatHistoryFilterUser';
-import type { DateRange } from './DateRange';
-import type { TopicModel } from './TopicModel';
-export type ChatHistoryFilterData = {
-    topics: Array<TopicModel>;
-    date_ranges?: Array<DateRange>;
-    sentiment?: Array<string>;
-    users: Array<ChatHistoryFilterUser>;
-};
-

package/src/models/ChatHistoryFilterUser.ts

@@ -1,10 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type ChatHistoryFilterUser = {
-    username: string;
-    email: string;
-    readonly lti_email: string;
-};
-

package/src/models/ChatHistoryItem.ts

@@ -1,10 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type ChatHistoryItem = {
-    type: string;
-    content: string;
-    timestamp: string;
-};
-

package/src/models/ChatHistorySessionId.ts

@@ -1,8 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type ChatHistorySessionId = {
-    id: string;
-};
-

package/src/models/ChatSessionRequest.ts

@@ -1,19 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type ChatSessionRequest = {
-    /**
-     * Name of mentor
-     */
-    mentor: string;
-    /**
-     * List of tools slugs to use. Passing `null` will use all tools assigned to the mentor. For no tools, pass an empty list.
-     */
-    tools?: Array<string>;
-    /**
-     * Optional token for a mentor's shareable link
-     */
-    shareable_link_token?: string;
-};
-

package/src/models/ChatSessionResponse.ts

@@ -1,10 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-import type { ToolResponse } from './ToolResponse';
-export type ChatSessionResponse = {
-    session_id: string;
-    tools: Array<ToolResponse>;
-};
-

package/src/models/CheckDocumentTrainingStatus.ts

@@ -1,15 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-export type CheckDocumentTrainingStatus = {
-    /**
-     * Status of the training
-     */
-    status: string;
-    /**
-     * Message of the training
-     */
-    message: string;
-};
-

package/src/models/ComparisonInfo.ts

@@ -1,34 +0,0 @@
-/* generated using openapi-typescript-codegen -- do not edit */
-/* istanbul ignore file */
-/* tslint:disable */
-/* eslint-disable */
-/**
- * Comparison period information.
- */
-export type ComparisonInfo = {
-    /**
-     * Number of days in comparison period
-     */
-    previous_period_count?: number;
-    /**
-     * Cost value for comparison period
-     */
-    previous_period_value?: number;
-    /**
-     * Start date of comparison period
-     */
-    comparison_start?: string;
-    /**
-     * End date of comparison period
-     */
-    comparison_end?: string;
-    /**
-     * Number of comparison days
-     */
-    comparison_days?: number;
-    /**
-     * Cost value for current period
-     */
-    recent_period_value?: number;
-};
-