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

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

@@ -0,0 +1,15 @@
+import type { GooglePayAccountResponseStatusEnum } from './GooglePayAccountResponseStatusEnum';
+export type GooglePayAccountResponse = {
+    account_id: string;
+    /**
+     * The bundle id of the app
+     */
+    bundle_id?: string;
+    status?: GooglePayAccountResponseStatusEnum;
+    readonly created_on: string;
+    readonly last_updated: string;
+    /**
+     * edX user ID
+     */
+    user?: number | null;
+};

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

@@ -0,0 +1,8 @@
+/**
+ * * `ACCOUNT_ACTIVE` - Account Active
+ * * `ACCOUNT_PENDING` - Account Pending
+ */
+export declare enum GooglePayAccountResponseStatusEnum {
+    ACCOUNT_ACTIVE = "ACCOUNT_ACTIVE",
+    ACCOUNT_PENDING = "ACCOUNT_PENDING"
+}

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

@@ -0,0 +1,6 @@
+export type GooglePayVerifyToken = {
+    google_pay_receipt: string;
+    bundle_id?: string;
+    key?: string;
+    name?: string;
+};

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

@@ -0,0 +1,18 @@
+/**
+ * * `course` - Course
+ * * `unit` - Unit
+ * * `resource` - Resource
+ * * `course_unit` - Course and Unit
+ * * `course_resource` - Course and Resource
+ * * `unit_resource` - Unit and Resource
+ * * `all` - Course, Unit, and Resource
+ */
+export declare enum ItemTypeEnum {
+    COURSE = "course",
+    UNIT = "unit",
+    RESOURCE = "resource",
+    COURSE_UNIT = "course_unit",
+    COURSE_RESOURCE = "course_resource",
+    UNIT_RESOURCE = "unit_resource",
+    ALL = "all"
+}

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

@@ -0,0 +1,9 @@
+export type LauncherViewPostRequest = {
+    user_id: number;
+    key: string;
+    name?: string;
+    org?: string;
+    lms_url?: string;
+    cms_url?: string;
+    portal_url?: string;
+};

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

@@ -0,0 +1,13 @@
+/**
+ * Manager auth token serializer
+ */
+export type ManagerAuthToken = {
+    /**
+     * Token key
+     */
+    readonly token: string;
+    /**
+     * Token expiration
+     */
+    expires: string;
+};

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

@@ -0,0 +1,71 @@
+import type { ItemTypeEnum } from './ItemTypeEnum';
+import type { MediaTypeEnum } from './MediaTypeEnum';
+export type MediaResource = {
+    readonly id: number;
+    /**
+     * Title of the media resource
+     */
+    title: string;
+    /**
+     * Description of the media resource
+     */
+    description?: string | null;
+    /**
+     * Type of media
+     *
+     * * `video` - Video
+     * * `image` - Image
+     * * `document` - Document
+     * * `audio` - Audio
+     * * `other` - Other
+     */
+    media_type: MediaTypeEnum;
+    /**
+     * Type of item this media is associated with
+     *
+     * * `course` - Course
+     * * `unit` - Unit
+     * * `resource` - Resource
+     * * `course_unit` - Course and Unit
+     * * `course_resource` - Course and Resource
+     * * `unit_resource` - Unit and Resource
+     * * `all` - Course, Unit, and Resource
+     */
+    readonly item_type: ItemTypeEnum;
+    /**
+     * ID of the associated course
+     */
+    course_id?: string | null;
+    /**
+     * ID of the associated unit
+     */
+    unit_id?: string | null;
+    /**
+     * ID of the associated item (resource)
+     */
+    item_id?: string | null;
+    /**
+     * The platform this media resource belongs to
+     */
+    readonly platform: number;
+    /**
+     * External URL for the media resource
+     */
+    file_url?: string | null;
+    /**
+     * Uploaded media file
+     */
+    file?: string | null;
+    /**
+     * User who created this media resource
+     */
+    readonly created_by: number | null;
+    /**
+     * When this record was created
+     */
+    readonly created_at: string;
+    /**
+     * When this record was last updated
+     */
+    readonly updated_at: string;
+};

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

@@ -0,0 +1,14 @@
+/**
+ * * `video` - Video
+ * * `image` - Image
+ * * `document` - Document
+ * * `audio` - Audio
+ * * `other` - Other
+ */
+export declare enum MediaTypeEnum {
+    VIDEO = "video",
+    IMAGE = "image",
+    DOCUMENT = "document",
+    AUDIO = "audio",
+    OTHER = "other"
+}

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,75 @@
+import type { GreetingMethodEnum } from './GreetingMethodEnum';
+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_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;
+    /**
+     * 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;
+    /**
+     * 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;
+};

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

@@ -0,0 +1,74 @@
+import type { GreetingMethodEnum } from './GreetingMethodEnum';
+export type MentorCreate = {
+    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_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;
+    google_voice?: number | null;
+    openai_voice?: number | null;
+    /**
+     * Instructions to determine how prompt suggestions are generated.
+     */
+    guided_prompt_instructions?: string;
+    categories?: Array<number>;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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/MentorCustomVoice.d.ts

@@ -0,0 +1,4 @@
+export type MentorCustomVoice = {
+    voice_provider: string;
+    voice_name?: string | null;
+};

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

@@ -0,0 +1,4 @@
+export type MentorCustomVoiceResponse = {
+    readonly voice_provider: string;
+    readonly voice_name: string;
+};

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

@@ -0,0 +1,7 @@
+import type { MentorSession } from './MentorSession';
+export type MentorData = {
+    mentor_unique_id: string;
+    mentor_name: string;
+    total_cost: number;
+    mentor_sessions: Array<MentorSession>;
+};

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

@@ -0,0 +1,6 @@
+export type MentorDetailAnalytics = {
+    total_mentors: number;
+    active_mentors: number;
+    total_questions_answered: number;
+    total_ratings: number;
+};