@iblai/iblai-api 4.7.2-core → 4.7.3-ai

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

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

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

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

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

@@ -0,0 +1,7 @@
+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

@@ -0,0 +1,11 @@
+/**
+ * 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/AssumedKnowledge.d.ts

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

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

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

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

@@ -0,0 +1,3 @@
+export type AudioToTextRequest = {
+    file: string;
+};

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

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

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

@@ -0,0 +1,4 @@
+export type AutoMemoryPrompt = {
+    auto_memory_prompt?: string;
+    reset?: boolean;
+};

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

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

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

@@ -0,0 +1,21 @@
+/**
+ * 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

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

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

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

@@ -0,0 +1,8 @@
+export type ChatHistory = {
+    readonly id: number;
+    message?: any;
+    readonly inserted_at: string;
+    title?: string | null;
+    readonly feedback: any;
+    document_sources?: any;
+};

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

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

@@ -0,0 +1,5 @@
+export type ChatHistoryFilterUser = {
+    username: string;
+    email: string;
+    readonly lti_email: string;
+};

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

@@ -0,0 +1,5 @@
+export type ChatHistoryItem = {
+    type: string;
+    content: string;
+    timestamp: string;
+};

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

@@ -0,0 +1,3 @@
+export type ChatHistorySessionId = {
+    id: string;
+};

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

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

@@ -0,0 +1,5 @@
+import type { ToolResponse } from './ToolResponse';
+export type ChatSessionResponse = {
+    session_id: string;
+    tools: Array<ToolResponse>;
+};

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

@@ -0,0 +1,10 @@
+export type CheckDocumentTrainingStatus = {
+    /**
+     * Status of the training
+     */
+    status: string;
+    /**
+     * Message of the training
+     */
+    message: string;
+};

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

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

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

@@ -0,0 +1,9 @@
+import type { ComponentBlockTypeEnum } from './ComponentBlockTypeEnum';
+export type ComponentBlock = {
+    readonly id: number;
+    unit: number;
+    type?: ComponentBlockTypeEnum;
+    display_name: string;
+    readonly created_at: string;
+    readonly updated_at: string;
+};

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

@@ -0,0 +1,8 @@
+/**
+ * * `html` - Html
+ * * `multiple_choice` - Multiple Choice
+ */
+export declare enum ComponentBlockTypeEnum {
+    HTML = "html",
+    MULTIPLE_CHOICE = "multiple_choice"
+}

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

@@ -0,0 +1,9 @@
+import type { ConnectedServiceProviderEnum } from './ConnectedServiceProviderEnum';
+import type { ServiceEnum } from './ServiceEnum';
+export type ConnectedService = {
+    readonly id: number;
+    provider: ConnectedServiceProviderEnum;
+    service: ServiceEnum;
+    expires_at?: string | null;
+    scope: string;
+};

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

@@ -0,0 +1,6 @@
+/**
+ * * `google` - Google
+ */
+export declare enum ConnectedServiceProviderEnum {
+    GOOGLE = "google"
+}

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

@@ -0,0 +1,11 @@
+import type { TopicModel } from './TopicModel';
+export type ConversationMessage = {
+    readonly first_message: string;
+    topics: Array<TopicModel>;
+    id: string;
+    user_id: string;
+    readonly message_count: number;
+    model: string;
+    inserted_at: string;
+    readonly user_sentiment: string;
+};

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

@@ -0,0 +1,6 @@
+export type ConversationRating = {
+    readonly id: number;
+    full_conversation_text: string;
+    rating_text?: string | null;
+    score?: number | null;
+};

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

@@ -0,0 +1,5 @@
+export type ConversationSummary = {
+    total_conversations: number;
+    total_human_messages: number;
+    total_ai_messages: number;
+};

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

@@ -0,0 +1,4 @@
+export type ConversationVolume = {
+    date: string;
+    conversation_count: number;
+};

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

@@ -0,0 +1,28 @@
+import type { TopicModel } from './TopicModel';
+export type Conversations = {
+    readonly id: string;
+    readonly messages: string;
+    topics: Array<TopicModel>;
+    readonly sentiment: string;
+    mentor: string;
+    readonly student: string;
+    readonly email: string;
+    model: string;
+    readonly rating: number;
+    platform: string;
+    /**
+     * Email claim from LTI1.3 JWT if an LTI user and available
+     */
+    readonly lti_email: string;
+    /**
+     * Username claim from LTI1.3 JWT if an LTI user and available
+     */
+    readonly lti_username: string;
+    readonly inserted_at: string;
+    has_document?: boolean;
+    memory_tracked?: boolean;
+    llm_name?: string | null;
+    llm_provider?: string | null;
+    metadata?: any;
+    tools?: Array<number>;
+};

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

@@ -0,0 +1,3 @@
+export type Cost = {
+    total_cost: number;
+};

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

@@ -0,0 +1,6 @@
+import type { ModelCost } from './ModelCost';
+export type CostPerTenant = {
+    platform_key: string;
+    total_cost: number;
+    model_costs: Array<ModelCost>;
+};

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

@@ -0,0 +1,31 @@
+import type { CourseCreationTaskFile } from './CourseCreationTaskFile';
+import type { CourseCreationTaskStatusEnum } from './CourseCreationTaskStatusEnum';
+export type CourseCreationTask = {
+    readonly id: number;
+    readonly user_id: string;
+    /**
+     * edX user ID
+     */
+    readonly student: number;
+    name: string;
+    /**
+     * Description of the course to create and its requirements
+     */
+    description: string;
+    /**
+     * The intended audience for the course. eg. Grade 11 students.
+     */
+    target_audience: string;
+    readonly platform: number;
+    readonly platform_key: string;
+    readonly status: CourseCreationTaskStatusEnum;
+    publish_course?: boolean;
+    readonly course_data: any;
+    provider?: string;
+    model?: string;
+    desired_number_of_sections?: number;
+    readonly logs: string;
+    readonly files: Array<CourseCreationTaskFile>;
+    readonly date_created: string;
+    readonly last_modified: string;
+};

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

@@ -0,0 +1,7 @@
+export type CourseCreationTaskFile = {
+    readonly id: number;
+    course_creation_task: number;
+    file: string;
+    readonly date_created: string;
+    readonly last_modified: string;
+};

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

@@ -0,0 +1,16 @@
+/**
+ * * `Pending` - Pending
+ * * `Scheduled` - Scheduled
+ * * `Success` - Success
+ * * `Failed` - Failed
+ * * `Cancelled` - Cancelled
+ * * `In Progress` - In Progress
+ */
+export declare enum CourseCreationTaskStatusEnum {
+    PENDING = "Pending",
+    SCHEDULED = "Scheduled",
+    SUCCESS = "Success",
+    FAILED = "Failed",
+    CANCELLED = "Cancelled",
+    IN_PROGRESS = "In Progress"
+}

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

@@ -0,0 +1,8 @@
+/**
+ * * `glob` - Glob
+ * * `regex` - Regex
+ */
+export declare enum CrawlerPatternTypeEnum {
+    GLOB = "glob",
+    REGEX = "regex"
+}

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

@@ -0,0 +1,14 @@
+export type CredentialRequest = {
+    /**
+     * Name of the credential provider (e.g., 'openai', 'google-drive')
+     */
+    name: string;
+    /**
+     * Credential data for the provider (API keys, service account details, etc.)
+     */
+    value: any;
+    /**
+     * Organization key identifier for the tenant
+     */
+    platform: string;
+};

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

@@ -0,0 +1,22 @@
+export type CrontabSchedule = {
+    /**
+     * Cron Minutes to Run. Use "*" for "all". (Example: "0,30")
+     */
+    minute?: string;
+    /**
+     * Cron Hours to Run. Use "*" for "all". (Example: "8,20")
+     */
+    hour?: string;
+    /**
+     * Cron Days Of The Week to Run. Use "*" for "all", Sunday is 0 or 7, Monday is 1. (Example: "0,5")
+     */
+    day_of_week?: string;
+    /**
+     * Cron Days Of The Month to Run. Use "*" for "all". (Example: "1,15")
+     */
+    day_of_month?: string;
+    /**
+     * Cron Months (1-12) Of The Year to Run. Use "*" for "all". (Example: "1,12")
+     */
+    month_of_year?: string;
+};

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

@@ -0,0 +1,13 @@
+export type CustomInstructionResponse = {
+    readonly id: number;
+    about_user?: string | null;
+    mentor_tone?: string | null;
+    /**
+     * Position or work. eg: Engineer, student etc.
+     */
+    profession?: string;
+    /**
+     * Comma separated list of expected traits for mentor.
+     */
+    desired_mentor_traits?: string;
+};

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

@@ -0,0 +1,4 @@
+export type DateRange = {
+    start_date: string;
+    end_date: string;
+};

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

@@ -0,0 +1,41 @@
+/**
+ * Serializer for document objects
+ */
+export type Document = {
+    /**
+     * Document ID
+     */
+    id: number;
+    /**
+     * Name of the document
+     */
+    document_name: string;
+    /**
+     * Type of document (e.g., 'pdf', 'text')
+     */
+    document_type: string;
+    /**
+     * Access level of the document
+     */
+    access: string;
+    /**
+     * Training status of the document
+     */
+    training_status: string;
+    /**
+     * Date when the document was created
+     */
+    date_created: string;
+    /**
+     * Date when the document was last modified
+     */
+    last_modified: string;
+    /**
+     * URL to access the document
+     */
+    url: string;
+    /**
+     * Additional metadata for the document
+     */
+    metadata: any;
+};

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

@@ -0,0 +1,17 @@
+/**
+ * Serializer for document facets
+ */
+export type DocumentFacet = {
+    /**
+     * Total number of documents in this facet
+     */
+    total: number;
+    /**
+     * Terms and their counts in this facet
+     */
+    terms: Record<string, any>;
+    /**
+     * Count of documents not in any term
+     */
+    other: number;
+};

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

@@ -0,0 +1,35 @@
+import type { Document } from './Document';
+import type { DocumentFacet } from './DocumentFacet';
+/**
+ * Response serializer for DocumentSearchView
+ */
+export type DocumentSearchResponse = {
+    /**
+     * List of documents matching the search criteria
+     */
+    results: Array<Document>;
+    /**
+     * Total number of documents matching the search criteria
+     */
+    count: number;
+    /**
+     * URL for the next page of results
+     */
+    next: string | null;
+    /**
+     * URL for the previous page of results
+     */
+    previous: string | null;
+    /**
+     * Current page number
+     */
+    current_page: number;
+    /**
+     * Total number of pages
+     */
+    total_pages: number;
+    /**
+     * Facet information for filtering
+     */
+    facets: Record<string, DocumentFacet>;
+};

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

@@ -0,0 +1,3 @@
+export type DocumentSettingsResponse = {
+    retrain_interval_days?: number | null;
+};

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

@@ -0,0 +1,11 @@
+export type EdxCourse = {
+    readonly id: number;
+    name: string;
+    run: string;
+    number: string;
+    description?: string;
+    xblock_id: string;
+    task?: number | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+};

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

@@ -0,0 +1,4 @@
+export type ElevenlabsCustomVoice = {
+    name: string;
+    files: Array<string>;
+};

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

@@ -0,0 +1,8 @@
+export type ElevenlabsCustomVoiceResponse = {
+    name: string;
+    readonly owner_student: string | null;
+    language?: string;
+    is_premade?: boolean;
+    description?: string;
+    readonly sample_audio_url: string | null;
+};