@iblai/iblai-api 3.47.2-core → 3.48.0-ai

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

@@ -0,0 +1,79 @@
+import type { GreetingMethodEnum } from './GreetingMethodEnum';
+export type PatchedMentorCreate = {
+    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;
+    /**
+     * (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;
+    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;
+    disable_chathistory?: boolean;
+    enable_safety_system?: boolean;
+    /**
+     * Response to start a conversation with a user.
+     */
+    proactive_response?: string;
+    mcp_servers?: Array<number>;
+    /**
+     * 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/PatchedPeriodicAgentCreate.d.ts

@@ -0,0 +1,41 @@
+import type { PeriodicTask } from './PeriodicTask';
+import type { PreviousAgentStatusEnum } from './PreviousAgentStatusEnum';
+export type PatchedPeriodicAgentCreate = {
+    readonly id?: number;
+    mentor?: number;
+    title?: string;
+    readonly username?: string;
+    description?: string;
+    /**
+     * Prompt for the periodic agent if any.
+     */
+    prompt?: string;
+    task?: PeriodicTask;
+    readonly created_at?: string;
+    readonly modified_at?: string;
+    readonly enabled?: boolean;
+    readonly one_off?: boolean;
+    readonly platform_key?: string;
+    pathway?: string;
+    callback_url?: string;
+    callback_secret?: string;
+    parent_session_id?: string;
+    parent_mentor_id?: number | null;
+    /**
+     * Agent that needs to run before the current agent runs.
+     */
+    previous_agent?: number | null;
+    /**
+     * The status that the previous agent must be in before this agent gets scheduled.
+     *
+     * * `success` - Success
+     * * `error` - Error
+     * * `running` - Running
+     * * `pending` - Pending
+     */
+    previous_agent_status?: PreviousAgentStatusEnum;
+    /**
+     * This will be fed into the run of this agent as part of its input prompt.
+     */
+    readonly previous_agent_output?: string;
+};

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

@@ -0,0 +1,12 @@
+export type PatchedPlayWrightScript = {
+    readonly id?: number;
+    readonly platform?: number | null;
+    /**
+     * edX user ID
+     */
+    readonly student?: number | null;
+    title?: string;
+    description?: string;
+    script?: string;
+    readonly is_public?: boolean;
+};

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

@@ -0,0 +1,22 @@
+import type { BlankEnum } from './BlankEnum';
+import type { NullEnum } from './NullEnum';
+import type { PromptVisibilityEnum } from './PromptVisibilityEnum';
+export type PatchedPrompt = {
+    readonly id?: number;
+    mentor?: string;
+    tone?: string | null;
+    style?: string;
+    language?: string;
+    tags?: Array<number>;
+    is_system?: boolean;
+    metadata?: any;
+    category?: string;
+    prompt?: string;
+    title?: string | null;
+    description?: string | null;
+    prompt_visibility?: (PromptVisibilityEnum | BlankEnum | NullEnum) | null;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+    created_by?: string | null;
+    platform?: number;
+};

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

@@ -0,0 +1,34 @@
+import type { RbacPlatform } from './RbacPlatform';
+import type { RbacUser } from './RbacUser';
+/**
+ * Serializer for RBAC groups.
+ */
+export type PatchedRbacGroup = {
+    readonly id?: number;
+    /**
+     * The unique identifier for the group
+     */
+    unique_id?: string;
+    readonly platform?: RbacPlatform;
+    /**
+     * The platform key
+     */
+    platform_key?: string;
+    /**
+     * Optional name of the group
+     */
+    name?: string;
+    /**
+     * Optional group description
+     */
+    description?: string;
+    readonly users?: Array<RbacUser>;
+    /**
+     * List of user IDs to add to this group
+     */
+    users_to_add?: Array<number>;
+    /**
+     * List of user IDs to remove from this group
+     */
+    users_to_remove?: Array<number>;
+};

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

@@ -0,0 +1,13 @@
+import type { RbacGroup } from './RbacGroup';
+import type { RbacRole } from './RbacRole';
+/**
+ * Serializer for RBAC group roles.
+ */
+export type PatchedRbacGroupRole = {
+    readonly id?: number;
+    readonly group?: RbacGroup;
+    readonly role?: RbacRole;
+    group_id?: number;
+    role_id?: number;
+    platform_key?: string;
+};

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

@@ -0,0 +1,28 @@
+import type { RbacPlatform } from './RbacPlatform';
+import type { RbacRole } from './RbacRole';
+/**
+ * Serializer for policies.
+ */
+export type PatchedRbacPolicy = {
+    readonly id?: number;
+    /**
+     * Role information (read-only)
+     */
+    readonly role?: RbacRole;
+    /**
+     * Platform information (read-only)
+     */
+    readonly platform?: RbacPlatform;
+    /**
+     * List of resource paths this policy grants access to (e.g., ['/platforms/1/mentors', '/platforms/1/mentors/settings'])
+     */
+    resources?: Array<string>;
+    /**
+     * ID of the role this policy applies to
+     */
+    role_id?: number;
+    /**
+     * Platform key where this policy applies
+     */
+    platform_key?: string;
+};

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

@@ -0,0 +1,20 @@
+import type { RbacPlatform } from './RbacPlatform';
+/**
+ * Serializer for roles.
+ */
+export type PatchedRbacRole = {
+    readonly id?: number;
+    name?: string;
+    /**
+     * Platform information (read-only)
+     */
+    readonly platform?: RbacPlatform;
+    /**
+     * Platform key where this role belongs
+     */
+    platform_key?: string;
+    /**
+     * List of actions/permissions this role can perform (e.g., ['Ibl.Mentor/Settings/read', 'Ibl.Mentor/Settings/write'])
+     */
+    actions?: Array<string>;
+};

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

@@ -0,0 +1,28 @@
+import type { RbacRole } from './RbacRole';
+import type { RbacUser } from './RbacUser';
+/**
+ * Serializer for user roles.
+ */
+export type PatchedRbacUserRole = {
+    readonly id?: number;
+    /**
+     * User information (read-only)
+     */
+    readonly user?: RbacUser;
+    /**
+     * Role information (read-only)
+     */
+    readonly role?: RbacRole;
+    /**
+     * ID of the role to assign. Role must belong to the specified platform.
+     */
+    role_id?: number;
+    /**
+     * Platform key. Must match the role's platform and the user must be a member of this platform.
+     */
+    platform_key?: string;
+    /**
+     * ID of the user to assign the role to. User must belong to the specified platform.
+     */
+    user_id?: number;
+};

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

@@ -0,0 +1,9 @@
+import type { Status6eeEnum } from './Status6eeEnum';
+export type PatchedSection = {
+    readonly id?: number;
+    course?: number;
+    display_name?: string;
+    readonly status?: Status6eeEnum;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+};

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

@@ -0,0 +1,9 @@
+import type { Status6eeEnum } from './Status6eeEnum';
+export type PatchedSubSection = {
+    readonly id?: number;
+    section?: number;
+    display_name?: string;
+    readonly status?: Status6eeEnum;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+};

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

@@ -0,0 +1,11 @@
+import type { Status6eeEnum } from './Status6eeEnum';
+import type { TypeC42Enum } from './TypeC42Enum';
+export type PatchedUnit = {
+    readonly id?: number;
+    subsection?: number;
+    display_name?: string;
+    readonly status?: Status6eeEnum;
+    type?: TypeC42Enum;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+};

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

@@ -0,0 +1,42 @@
+import type { Mentor } from './Mentor';
+import type { PeriodicTask } from './PeriodicTask';
+import type { PreviousAgentStatusEnum } from './PreviousAgentStatusEnum';
+export type PeriodicAgent = {
+    readonly id: number;
+    mentor: Mentor;
+    title: string;
+    readonly username: string;
+    description?: string;
+    /**
+     * Prompt for the periodic agent if any.
+     */
+    prompt?: string;
+    task: PeriodicTask;
+    readonly created_at: string;
+    readonly modified_at: string;
+    readonly enabled: boolean;
+    readonly one_off: boolean;
+    readonly platform_key: string;
+    pathway?: string;
+    callback_url?: string;
+    callback_secret?: string;
+    parent_session_id?: string;
+    parent_mentor_id?: number | null;
+    /**
+     * Agent that needs to run before the current agent runs.
+     */
+    previous_agent?: number | null;
+    /**
+     * The status that the previous agent must be in before this agent gets scheduled.
+     *
+     * * `success` - Success
+     * * `error` - Error
+     * * `running` - Running
+     * * `pending` - Pending
+     */
+    previous_agent_status?: PreviousAgentStatusEnum;
+    /**
+     * This will be fed into the run of this agent as part of its input prompt.
+     */
+    readonly previous_agent_output: string;
+};

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

@@ -0,0 +1,41 @@
+import type { PeriodicTask } from './PeriodicTask';
+import type { PreviousAgentStatusEnum } from './PreviousAgentStatusEnum';
+export type PeriodicAgentCreate = {
+    readonly id: number;
+    mentor: number;
+    title: string;
+    readonly username: string;
+    description?: string;
+    /**
+     * Prompt for the periodic agent if any.
+     */
+    prompt?: string;
+    task: PeriodicTask;
+    readonly created_at: string;
+    readonly modified_at: string;
+    readonly enabled: boolean;
+    readonly one_off: boolean;
+    readonly platform_key: string;
+    pathway?: string;
+    callback_url?: string;
+    callback_secret?: string;
+    parent_session_id?: string;
+    parent_mentor_id?: number | null;
+    /**
+     * Agent that needs to run before the current agent runs.
+     */
+    previous_agent?: number | null;
+    /**
+     * The status that the previous agent must be in before this agent gets scheduled.
+     *
+     * * `success` - Success
+     * * `error` - Error
+     * * `running` - Running
+     * * `pending` - Pending
+     */
+    previous_agent_status?: PreviousAgentStatusEnum;
+    /**
+     * This will be fed into the run of this agent as part of its input prompt.
+     */
+    readonly previous_agent_output: string;
+};

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

@@ -0,0 +1,11 @@
+import type { PeriodicAgentLogStatusEnum } from './PeriodicAgentLogStatusEnum';
+export type PeriodicAgentLog = {
+    readonly id: number;
+    content?: string;
+    status?: PeriodicAgentLogStatusEnum;
+    start_time?: string;
+    end_time?: string | null;
+    readonly created_at: string;
+    readonly modified_at: string;
+    periodic_agent: number;
+};

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

@@ -0,0 +1,10 @@
+/**
+ * * `success` - Success
+ * * `error` - Error
+ * * `running` - Running
+ */
+export declare enum PeriodicAgentLogStatusEnum {
+    SUCCESS = "success",
+    ERROR = "error",
+    RUNNING = "running"
+}

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

@@ -0,0 +1,21 @@
+import type { CrontabSchedule } from './CrontabSchedule';
+export type PeriodicTask = {
+    readonly id: number;
+    /**
+     * Short Description For This Task
+     */
+    readonly name: string;
+    crontab: CrontabSchedule;
+    /**
+     * If True, the schedule will only run the task a single time
+     */
+    one_off?: boolean;
+    /**
+     * Datetime when the schedule should begin triggering the task to run
+     */
+    start_time?: string | null;
+    /**
+     * Set to False to disable the schedule
+     */
+    enabled?: boolean;
+};

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

@@ -0,0 +1,5 @@
+import type { PieChartSegment } from './PieChartSegment';
+export type PieChartData = {
+    new_users: PieChartSegment;
+    returning_users: PieChartSegment;
+};

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

@@ -0,0 +1,4 @@
+export type PieChartSegment = {
+    count: number;
+    percentage: number;
+};

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

@@ -0,0 +1,9 @@
+export type PinnedMessageCreate = {
+    readonly id: number;
+    /**
+     * The platform key
+     */
+    platform: string;
+    username: string;
+    session_id: string | null;
+};

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

@@ -0,0 +1,7 @@
+import type { ChatHistory } from './ChatHistory';
+import type { Mentor } from './Mentor';
+export type PinnedMessageGet = {
+    session_id: string;
+    mentor: Mentor;
+    messages: Array<ChatHistory>;
+};

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

@@ -0,0 +1,6 @@
+export type PinnedMessageRequest = {
+    /**
+     * Session id of the message to pin
+     */
+    session_id: string;
+};

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

@@ -0,0 +1,12 @@
+export type PlayWrightScript = {
+    readonly id: number;
+    readonly platform: number | null;
+    /**
+     * edX user ID
+     */
+    readonly student: number | null;
+    title: string;
+    description?: string;
+    script: string;
+    readonly is_public: boolean;
+};

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

@@ -0,0 +1,4 @@
+import type { ReuestDataVariableList } from './ReuestDataVariableList';
+export type PredictiveAnalyticsRequest = {
+    prompt: ReuestDataVariableList;
+};

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

@@ -0,0 +1,4 @@
+import type { ResponseDataVariable } from './ResponseDataVariable';
+export type PredictiveAnalyticsResponse = {
+    predictions: Array<ResponseDataVariable>;
+};

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

@@ -0,0 +1,12 @@
+/**
+ * * `success` - Success
+ * * `error` - Error
+ * * `running` - Running
+ * * `pending` - Pending
+ */
+export declare enum PreviousAgentStatusEnum {
+    SUCCESS = "success",
+    ERROR = "error",
+    RUNNING = "running",
+    PENDING = "pending"
+}

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

@@ -0,0 +1,22 @@
+import type { BlankEnum } from './BlankEnum';
+import type { NullEnum } from './NullEnum';
+import type { PromptVisibilityEnum } from './PromptVisibilityEnum';
+export type Prompt = {
+    readonly id: number;
+    mentor?: string;
+    tone?: string | null;
+    style?: string;
+    language?: string;
+    tags?: Array<number>;
+    is_system?: boolean;
+    metadata?: any;
+    category?: string;
+    prompt: string;
+    title?: string | null;
+    description?: string | null;
+    prompt_visibility?: (PromptVisibilityEnum | BlankEnum | NullEnum) | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+    created_by?: string | null;
+    platform: number;
+};

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

@@ -0,0 +1,7 @@
+export type PromptCategory = {
+    readonly id: number;
+    name: string;
+    description?: string | null;
+    readonly created_at: string | null;
+    readonly updated_at: string | null;
+};

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

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

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

@@ -0,0 +1,35 @@
+import type { Prompt } from './Prompt';
+import type { PromptFacet } from './PromptFacet';
+/**
+ * Response serializer for PromptSearchView
+ */
+export type PromptSearchResponse = {
+    /**
+     * List of prompts matching the search criteria
+     */
+    results: Array<Prompt>;
+    /**
+     * Total number of prompts 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
+     */
+    num_pages: number;
+    /**
+     * Facet information for filtering
+     */
+    facets?: Record<string, PromptFacet>;
+};

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

@@ -0,0 +1,10 @@
+/**
+ * * `viewable_by_tenant_admins` - Viewable By Tenant Admins
+ * * `viewable_by_tenant_students` - Viewable By Tenant Students
+ * * `viewable_by_anyone` - Viewable By Anyone
+ */
+export declare enum PromptVisibilityEnum {
+    VIEWABLE_BY_TENANT_ADMINS = "viewable_by_tenant_admins",
+    VIEWABLE_BY_TENANT_STUDENTS = "viewable_by_tenant_students",
+    VIEWABLE_BY_ANYONE = "viewable_by_anyone"
+}

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

@@ -0,0 +1,10 @@
+/**
+ * * `openai` - Openai
+ * * `google` - Google
+ * * `elevenlabs` - Elevenlabs
+ */
+export declare enum ProviderEnum {
+    OPENAI = "openai",
+    GOOGLE = "google",
+    ELEVENLABS = "elevenlabs"
+}

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

@@ -0,0 +1,8 @@
+export type QuestionCardTag = {
+    readonly id: number;
+    name: string;
+    difficulty: number;
+    readonly total_cards: number;
+    readonly correct_answers: number;
+    readonly correct_rate: number;
+};

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

@@ -0,0 +1,15 @@
+import type { InputQuestion } from './InputQuestion';
+/**
+ * Serializer for incoming request data that includes initial questions and the username.
+ *
+ * Attributes:
+ * username (str): Username of the requesting student or user.
+ * initial_questions (list[InputQuestionSerializer]): List of initial questions provided by the LMS.
+ * question_count (int): Number of questions the mentor (llm) should generate
+ */
+export type QuestionRequest = {
+    username: string;
+    initial_questions: Array<InputQuestion>;
+    question_count?: number;
+    subject: string;
+};