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

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/FinanceDetailsResponse.d.ts

@@ -0,0 +1,13 @@
+import type { MetricInfo } from './MetricInfo';
+/**
+ * Serializer for /financial/details responses.
+ */
+export type FinanceDetailsResponse = {
+    page: number;
+    limit: number;
+    total_pages: number;
+    total_records: number;
+    rows: Array<Record<string, any>>;
+    total_cost?: number;
+    metrics?: Array<MetricInfo>;
+};

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

@@ -0,0 +1,15 @@
+/**
+ * Applied filters for the response.
+ */
+export type FinanceFilters = {
+    start_date?: string;
+    end_date?: string;
+    granularity: string;
+    comparison_days?: number;
+    platform_key?: string;
+    mentor_unique_id?: string;
+    username?: string;
+    provider?: string;
+    llm_model?: string;
+    all_time?: boolean;
+};

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/GuidedPrompt.d.ts

@@ -0,0 +1,4 @@
+export type GuidedPrompt = {
+    prompt: string;
+    icon: string;
+};

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

@@ -0,0 +1,5 @@
+import type { GuidedPrompt } from './GuidedPrompt';
+export type GuidedPromptsResponse = {
+    ai_prompts: Array<string>;
+    results: Array<GuidedPrompt>;
+};

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/HeygenTemplateRequest.d.ts

@@ -0,0 +1,5 @@
+export type HeygenTemplateRequest = {
+    template_id: string;
+    preview_image_url?: string | null;
+    name: string;
+};

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

@@ -0,0 +1,6 @@
+export type HeygenTemplateResponseSingle = {
+    readonly template_id: string | null;
+    readonly preview_image_url: string | null;
+    name: string;
+    provider: string;
+};

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

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

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

@@ -0,0 +1,5 @@
+export type HeygenVideoRequest = {
+    script: string;
+    name: string;
+    template_id?: string | null;
+};

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

@@ -0,0 +1,21 @@
+import type { HumanSupportTicketStatusEnum } from './HumanSupportTicketStatusEnum';
+/**
+ * serializer interface intended for students/ non-admin users.
+ * This limits students to only update the subject and description of a ticket.
+ */
+export type HumanSupportTicket = {
+    readonly id: number;
+    readonly username: string;
+    /**
+     * edX user ID
+     */
+    readonly user: number;
+    readonly session: string;
+    subject: string;
+    description: string;
+    status?: HumanSupportTicketStatusEnum;
+    readonly mentor_id: string;
+    readonly created_at: string;
+    readonly updated_at: string;
+    readonly resolved_at: string | null;
+};

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

@@ -0,0 +1,10 @@
+/**
+ * * `open` - Open
+ * * `in_progress` - In Progress
+ * * `closed` - Closed
+ */
+export declare enum HumanSupportTicketStatusEnum {
+    OPEN = "open",
+    IN_PROGRESS = "in_progress",
+    CLOSED = "closed"
+}

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/IntegrationCredentialSchema.d.ts

@@ -0,0 +1,4 @@
+export type IntegrationCredentialSchema = {
+    name: string;
+    schema?: any;
+};

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/LLMCredentialSchema.d.ts

@@ -0,0 +1,4 @@
+export type LLMCredentialSchema = {
+    name: string;
+    schema?: any;
+};

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/LlmProviderEnum.d.ts

@@ -0,0 +1,8 @@
+/**
+ * * `openai` - Openai
+ * * `google` - Google
+ */
+export declare enum LlmProviderEnum {
+    OPENAI = "openai",
+    GOOGLE = "google"
+}

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

@@ -0,0 +1,21 @@
+import type { TransportEnum } from './TransportEnum';
+/**
+ * Serializer for the MCPServer model.
+ */
+export type MCPServer = {
+    readonly id: number;
+    readonly platform: number;
+    name: string;
+    /**
+     * The url of the MCP server.
+     */
+    url: string;
+    transport?: TransportEnum;
+    /**
+     * Headers to send to the MCP server. Useful for authentication,
+     */
+    headers?: any;
+    readonly platform_key: string;
+    readonly created_at: string;
+    readonly updated_at: string;
+};

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

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

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

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

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

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

@@ -0,0 +1,87 @@
+import type { CallConfiguration } from './CallConfiguration';
+import type { GreetingMethodEnum } from './GreetingMethodEnum';
+import type { MCPServer } from './MCPServer';
+import type { MentorCategory } from './MentorCategory';
+export type Mentor = {
+    name: string;
+    unique_id?: string;
+    /**
+     * The langflow json for the mentor
+     */
+    flow: any;
+    slug?: string;
+    platform?: string;
+    allow_anonymous?: boolean;
+    metadata?: any;
+    enable_moderation?: boolean;
+    enable_post_processing_system?: boolean;
+    /**
+     * (Deprecated) Set template mentor to openai-agent instead.
+     */
+    enable_openai_assistant?: boolean;
+    /**
+     * Whether to force mentor to only use information within the provided documents.
+     */
+    enable_total_grounding?: boolean;
+    /**
+     * Whether to show suggested prompts for the mentor or not. Note: Suggested prompts are created by tenant admins.
+     */
+    enable_suggested_prompts?: boolean;
+    /**
+     * Whether to show suggested prompts for the mentor or not. Note: Guided prompts are created with an llm based on chat history.
+     */
+    enable_guided_prompts?: boolean;
+    /**
+     * Instructions to determine how prompt suggestions are generated.
+     */
+    guided_prompt_instructions?: string;
+    google_voice?: number | null;
+    openai_voice?: number | null;
+    categories: Array<MentorCategory>;
+    /**
+     * Prompt template used to start a conversation with the user when greeting_type is proactive_prompt. This will be sent to the LLM so it can respond naturally
+     */
+    proactive_prompt?: string;
+    /**
+     * The prompt for the moderation system. This prompt must clearly distinguish between 'Approapriate' and 'Not Appropriate' queries.
+     */
+    moderation_system_prompt?: string;
+    /**
+     * Prompt to be used to alter or modify final llm response into any desired form.
+     */
+    post_processing_prompt?: string;
+    /**
+     * Desired feedback to return to the user when their prompt is deemed inappropriate.
+     */
+    moderation_response?: string;
+    /**
+     * Prompt to check whether the models response is appropriate or not.
+     */
+    safety_system_prompt?: string;
+    /**
+     * Feedback given to the user when a model generates an inappropriate response
+     */
+    safety_response?: string;
+    enable_safety_system?: boolean;
+    /**
+     * Response to start a conversation with a user.
+     */
+    proactive_response?: string;
+    /**
+     * How the mentor should greet the user. proactive_prompt: Allow the LLM to respond to proactive_prompt msg. proactive_response: use proactive_response template without performing an LLM call.
+     *
+     * * `proactive_prompt` - Proactive Prompt
+     * * `proactive_response` - Proactive Response
+     */
+    greeting_method?: GreetingMethodEnum;
+    call_configuration?: CallConfiguration;
+    mcp_servers: Array<MCPServer>;
+    /**
+     * edX user ID
+     */
+    last_accessed_by?: number | null;
+    recently_accessed_at?: string | null;
+    created_by?: string | null;
+    readonly created_at: string | null;
+    readonly updated_at: string | null;
+};

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

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

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

@@ -0,0 +1,9 @@
+import type { MentorAudience } from './MentorAudience';
+export type MentorCategory = {
+    readonly id: number;
+    name: string;
+    description?: string | null;
+    category_group?: number | null;
+    audience: MentorAudience;
+    audiences: Array<MentorAudience>;
+};

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

@@ -0,0 +1,11 @@
+export type MentorCategoryCreate = {
+    readonly id: number;
+    name: string;
+    category_group?: number | null;
+    description?: string | null;
+    /**
+     * Deprecated: This is only left for backward compatibility. Please use the audiences field instead.
+     */
+    audience?: number | null;
+    audiences?: Array<number>;
+};

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

@@ -0,0 +1,11 @@
+import type { MentorAudience } from './MentorAudience';
+import type { MentorCategory } from './MentorCategory';
+export type MentorCategoryGroup = {
+    readonly id: number;
+    name: string;
+    description: string;
+    audience: MentorAudience;
+    readonly date_created: string;
+    categories: Array<MentorCategory>;
+    audiences: Array<MentorAudience>;
+};

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

@@ -0,0 +1,11 @@
+export type MentorCategoryGroupCreate = {
+    readonly id: number;
+    name: string;
+    description: string;
+    /**
+     * Deprecated: This is only left for backward compatibility. Please use the audiences field instead.
+     */
+    audience?: number | null;
+    audiences?: Array<number>;
+    readonly date_created: string;
+};