@iblai/iblai-api 3.35.2-core → 3.35.3-ai

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,10 @@
+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>;
+};

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/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/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/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 seperated 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/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;
+};

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

@@ -0,0 +1,13 @@
+export type EmailPromptDetail = {
+    readonly id: number;
+    readonly inserted_at: string;
+    sender_email: string;
+    sender_name?: string | null;
+    subject?: string | null;
+    content: string;
+    mentor_name?: string | null;
+    mentor_email: string;
+    is_processed?: boolean;
+    mentor_response?: string | null;
+    send_status?: string | null;
+};

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

@@ -0,0 +1,11 @@
+export type EmailPromptList = {
+    readonly id: number;
+    sender_email: string;
+    sender_name?: string | null;
+    subject?: string | null;
+    readonly content_summary: string | null;
+    mentor_name?: string | null;
+    mentor_email: string;
+    is_processed?: boolean;
+    readonly inserted_at: string;
+};

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

@@ -0,0 +1,5 @@
+export type EmailPromptSummary = {
+    readonly total_emails: number;
+    readonly replied_emails: number;
+    readonly pending_emails: number;
+};

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

@@ -0,0 +1,3 @@
+export type FreeUsageCount = {
+    count: number;
+};

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

@@ -0,0 +1,13 @@
+import type { SectionWithChildren } from './SectionWithChildren';
+export type FullCourse = {
+    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;
+    sections: Array<SectionWithChildren>;
+};

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

@@ -0,0 +1,8 @@
+/**
+ * * `proactive_prompt` - Proactive Prompt
+ * * `proactive_response` - Proactive Response
+ */
+export declare enum GreetingMethodEnum {
+    PROACTIVE_PROMPT = "proactive_prompt",
+    PROACTIVE_RESPONSE = "proactive_response"
+}

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

@@ -0,0 +1,3 @@
+export type GuidedPromptsResponse = {
+    ai_prompts: Array<string>;
+};

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

@@ -0,0 +1,8 @@
+export type HeygenMarketingVideoDetail = {
+    name?: string;
+    data?: any;
+    script?: string | null;
+    readonly pk: number;
+    readonly video_file: string | null;
+    readonly generation_status: string;
+};

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

@@ -0,0 +1,6 @@
+export type HeygenMarketingVideoList = {
+    name?: string;
+    data?: any;
+    readonly pk: number;
+    readonly generation_status: string;
+};

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

@@ -0,0 +1,3 @@
+export type IBLAIPlatformMeta = {
+    metadata?: any;
+};

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

@@ -0,0 +1,6 @@
+export type IBLAIPlatformMetaRequest = {
+    /**
+     * Platform metadata including LLM configurations and active services
+     */
+    data: any;
+};

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

@@ -0,0 +1,10 @@
+export type IBLAIPlatformMetaUpdateRequest = {
+    /**
+     * The LLM provider to set as active (e.g., 'openai', 'google')
+     */
+    active_llm?: string;
+    /**
+     * List of LLM providers to add to available providers
+     */
+    llms?: Array<string>;
+};

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

@@ -0,0 +1,6 @@
+import type { IntialQuestionAnswer } from './IntialQuestionAnswer';
+export type InputQuestion = {
+    text: string;
+    difficulty_level?: number;
+    possible_answers: Array<IntialQuestionAnswer>;
+};

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

@@ -0,0 +1,8 @@
+export type IntegrationCredential = {
+    name: string;
+    value?: any;
+    /**
+     * The platform key
+     */
+    platform: string;
+};

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

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

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

@@ -0,0 +1,11 @@
+import type { Step } from './Step';
+export type JobRun = {
+    readonly id: number;
+    title: string;
+    description?: string;
+    session: string;
+    active?: boolean;
+    readonly created_at: string;
+    readonly updated_at: string;
+    steps: Array<Step>;
+};

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

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

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

@@ -0,0 +1,14 @@
+export type LLMCredentialRequest = {
+    /**
+     * Name of the credential provider
+     */
+    name: string;
+    /**
+     * Value of the credential provider
+     */
+    value: any;
+    /**
+     * Key of the tenant
+     */
+    platform: string;
+};

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

@@ -0,0 +1,8 @@
+export type LLMCredentialResponse = {
+    name: string;
+    value?: any;
+    /**
+     * The platform key
+     */
+    platform: string;
+};

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

@@ -0,0 +1,6 @@
+export type LLMModelForTenant = {
+    readonly id: number;
+    llm_provider: string;
+    llm_name: string;
+    tenant?: number | null;
+};

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

@@ -0,0 +1,15 @@
+import type { Answer } from './Answer';
+/**
+ * Serializer for individual question data, including possible answers.
+ *
+ * Attributes:
+ * question_id (str): Unique identifier for the question.
+ * text (str): The text of the question.
+ * difficulty_level (Optional[int]): An optional difficulty level for the question.
+ * options (list[AnswerSerializer]): List of possible answers for the question.
+ */
+export type LLMQuestion = {
+    text: string;
+    difficulty_level?: number;
+    options: Array<Answer>;
+};

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

@@ -0,0 +1,14 @@
+export type LLMResponse = {
+    readonly id: number;
+    name: string;
+    description?: string | null;
+    metadata?: any;
+    resource_ids?: any;
+    tags?: any;
+    overview?: string | null;
+    use_cases?: string | null;
+    documentation?: string | null;
+    sdk_samples?: string | null;
+    chat_models?: any;
+    logo?: string | null;
+};

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

@@ -0,0 +1,5 @@
+export type LLMTracesListResponse = {
+    id: string;
+    name: string;
+    date: string;
+};

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

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

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

@@ -0,0 +1,3 @@
+export type LinkCourseRequest = {
+    course_id: string;
+};

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,6 @@
+export type MemoryStatusView = {
+    readonly id: number;
+    username: string;
+    platform_key: string;
+    enabled?: boolean;
+};