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

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

@@ -0,0 +1,14 @@
+/**
+ * * `webex` - Webex
+ * * `slack` - Slack
+ * * `whatsapp` - Whatsapp
+ * * `discord` - Discord
+ * * `teams` - Teams
+ */
+export declare enum Provider05cEnum {
+    WEBEX = "webex",
+    SLACK = "slack",
+    WHATSAPP = "whatsapp",
+    DISCORD = "discord",
+    TEAMS = "teams"
+}

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

@@ -0,0 +1,6 @@
+/**
+ * * `openai` - Openai
+ */
+export declare enum Provider63aEnum {
+    OPENAI = "openai"
+}

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

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

@@ -0,0 +1,10 @@
+import type { LLMQuestion } from './LLMQuestion';
+/**
+ * Serializer for the response data that returns additional questions.
+ *
+ * Attributes:
+ * follow_up_questions (list[LLMQuestionSerializer]): List of generated follow-up questions.
+ */
+export type QuestionResponse = {
+    questions: Array<LLMQuestion>;
+};

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

@@ -0,0 +1,8 @@
+/**
+ * * `1` - Up Vote
+ * * `-1` - Down Vote
+ */
+export declare enum RatingEnum {
+    '_1' = 1,
+    '_-1' = -1
+}

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

@@ -0,0 +1,4 @@
+export type RatingRecord = {
+    time: string;
+    total_ratings: number;
+};

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

@@ -0,0 +1,34 @@
+import type { RbacPlatform } from './RbacPlatform';
+import type { RbacUser } from './RbacUser';
+/**
+ * Serializer for RBAC groups.
+ */
+export type RbacGroup = {
+    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/RbacGroupRole.d.ts

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

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

@@ -0,0 +1,14 @@
+/**
+ * Serializer for platforms.
+ */
+export type RbacPlatform = {
+    readonly id: number;
+    /**
+     * The platform key
+     */
+    key: string;
+    /**
+     * The name of the platform
+     */
+    name?: string | null;
+};

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

@@ -0,0 +1,28 @@
+import type { RbacPlatform } from './RbacPlatform';
+import type { RbacRole } from './RbacRole';
+/**
+ * Serializer for policies.
+ */
+export type RbacPolicy = {
+    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/RbacRole.d.ts

@@ -0,0 +1,20 @@
+import type { RbacPlatform } from './RbacPlatform';
+/**
+ * Serializer for roles.
+ */
+export type RbacRole = {
+    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/RbacUser.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Serializer for users.
+ */
+export type RbacUser = {
+    /**
+     * edX user ID
+     */
+    readonly id: number;
+    /**
+     * edX username
+     */
+    username?: string | null;
+};

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

@@ -0,0 +1,28 @@
+import type { RbacRole } from './RbacRole';
+import type { RbacUser } from './RbacUser';
+/**
+ * Serializer for user roles.
+ */
+export type RbacUserRole = {
+    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/RecentlyAccessedMentor.d.ts

@@ -0,0 +1,8 @@
+export type RecentlyAccessedMentor = {
+    readonly slug: string | null;
+    readonly name: string | null;
+    readonly description: string | null;
+    readonly recently_accessed_at: string | null;
+    readonly platform_key: string | null;
+    readonly last_accessed_by: string | null;
+};

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

@@ -0,0 +1,3 @@
+export type RecommendCourseBlock = {
+    blocks: Array<any>;
+};

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

@@ -0,0 +1,3 @@
+export type RecommendCourseResponse = {
+    courses: Array<any>;
+};

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

@@ -0,0 +1,33 @@
+/**
+ * Response serializer for RecommendedCoursesView
+ */
+export type RecommendedCoursesResponse = {
+    /**
+     * List of content items matching the search criteria
+     */
+    results: Array<Record<string, any>>;
+    /**
+     * Total number of items 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, any>;
+};

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

@@ -0,0 +1,3 @@
+export type RelatedText = {
+    question: string;
+};

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

@@ -0,0 +1,14 @@
+export type RequestDataVariable = {
+    /**
+     * Variable Name
+     */
+    variable_name: string;
+    /**
+     * Data set to be used for prediction
+     */
+    data_set: any;
+    /**
+     * Number of Data Points
+     */
+    number_of_data_points: number;
+};

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

@@ -0,0 +1,13 @@
+import type { BlankEnum } from './BlankEnum';
+import type { NullEnum } from './NullEnum';
+import type { ResourceScrappedDataStatusEnum } from './ResourceScrappedDataStatusEnum';
+export type ResourceScrappedData = {
+    readonly id: number;
+    status?: (ResourceScrappedDataStatusEnum | BlankEnum | NullEnum) | null;
+    readonly date_created: string | null;
+    readonly last_modified: string | null;
+    resource: number;
+    content?: string | null;
+    content_type?: string | null;
+    extra_data?: any;
+};

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

@@ -0,0 +1,12 @@
+/**
+ * * `scrapped` - Scraped
+ * * `failed` - Failed
+ * * `pending` - Pending
+ * * `unscrapped` - Unscraped
+ */
+export declare enum ResourceScrappedDataStatusEnum {
+    SCRAPPED = "scrapped",
+    FAILED = "failed",
+    PENDING = "pending",
+    UNSCRAPPED = "unscrapped"
+}

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

@@ -0,0 +1,14 @@
+export type ResponseDataVariable = {
+    /**
+     * Variable Name
+     */
+    variable_name: string;
+    /**
+     * Predicted data
+     */
+    predicted_data: any;
+    /**
+     * Explanation of prediction
+     */
+    narrative: string;
+};

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

@@ -0,0 +1,10 @@
+export type RetreiverTrainViewRequest = {
+    /**
+     * Pathway for document to be trained in
+     */
+    pathway: string;
+    /**
+     * Url of the document to be trained
+     */
+    url: string;
+};

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

@@ -0,0 +1,6 @@
+export type RetreiverTrainViewResponse = {
+    /**
+     * Status of the training
+     */
+    detail: string;
+};

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

@@ -0,0 +1,3 @@
+export type RetrieveTask = {
+    task: string;
+};

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

@@ -0,0 +1,17 @@
+import type { AccessEnum } from './AccessEnum';
+import type { BlankEnum } from './BlankEnum';
+import type { NullEnum } from './NullEnum';
+import type { TrainingStatusEnum } from './TrainingStatusEnum';
+export type RetrieverDocumentEmbedding = {
+    readonly id: number;
+    metadata?: any;
+    document_name?: string | null;
+    document_type?: string | null;
+    training_status?: (TrainingStatusEnum | BlankEnum | NullEnum) | null;
+    pathway: string;
+    url?: string | null;
+    tokens?: number | null;
+    platform_key: string;
+    is_trained?: boolean;
+    access?: (AccessEnum | BlankEnum | NullEnum) | null;
+};