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

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

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

@@ -0,0 +1,30 @@
+import type { AccessEnum } from './AccessEnum';
+export type RetrieverDocumentEmbeddingRequest = {
+    /**
+     * The name of the document
+     */
+    document_name?: string;
+    /**
+     * The type of the document
+     */
+    document_type?: string;
+    /**
+     * The pathway to retrain the document in
+     */
+    pathway: string;
+    /**
+     * The url of the document
+     */
+    url?: string;
+    /**
+     * The type of the document
+     */
+    train?: boolean;
+    /**
+     * The access of the document.
+     *
+     * * `public` - Public
+     * * `private` - Private
+     */
+    access?: AccessEnum;
+};

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

@@ -0,0 +1,10 @@
+export type RetrieverRequestSearch = {
+    /**
+     * The query for similarity search
+     */
+    query: string;
+    /**
+     * The pathway of the docs
+     */
+    pathway: string;
+};

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

@@ -0,0 +1,10 @@
+export type RetrieverRequestSearchDocument = {
+    /**
+     * The source url of the docuemnt
+     */
+    source: string;
+    /**
+     * The percentge confidence level of the document retrieved
+     */
+    confidence_level: number;
+};

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

@@ -0,0 +1,7 @@
+import type { PageContent } from './PageContent';
+export type RetrieverResponseSearch = {
+    /**
+     * Docs from similarity search
+     */
+    results: Array<PageContent>;
+};

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

@@ -0,0 +1,4 @@
+import type { RequestDataVariable } from './RequestDataVariable';
+export type ReuestDataVariableList = {
+    data_variables: Array<RequestDataVariable>;
+};

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

@@ -0,0 +1,3 @@
+export type RunMentorEval = {
+    id: number;
+};

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

@@ -0,0 +1,6 @@
+export type ScanWebhookRequest = {
+    file_id: string;
+    filename: string;
+    status: string;
+    message: string;
+};

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

@@ -0,0 +1,3 @@
+export type ScanWebhookResponse = {
+    message: string;
+};

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

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

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

@@ -0,0 +1,11 @@
+import type { Status6eeEnum } from './Status6eeEnum';
+import type { SubSectionWithChildren } from './SubSectionWithChildren';
+export type SectionWithChildren = {
+    readonly id: number;
+    course: number;
+    display_name: string;
+    readonly status: Status6eeEnum;
+    subsections: Array<SubSectionWithChildren>;
+    readonly created_at: string;
+    readonly updated_at: string;
+};

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

@@ -0,0 +1,3 @@
+export type SeedMentorsView = {
+    detail: string;
+};

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

@@ -0,0 +1,4 @@
+export type SentimentSummary = {
+    sentiment_distribution: Record<string, any>;
+    total_sentiments: number;
+};

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

@@ -0,0 +1,8 @@
+export type SessionBrowserScreenshot = {
+    type: string;
+    session_id: string;
+    format: string;
+    ext: string;
+    url: string;
+    time: string;
+};

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

@@ -0,0 +1,6 @@
+export type SessionDetail = {
+    count: number;
+    previous: string;
+    next: string;
+    results: Array<string>;
+};

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

@@ -0,0 +1,6 @@
+import type { MemoryComponentMemory } from './MemoryComponentMemory';
+export type SessionMemoryStorage = {
+    readonly memory: MemoryComponentMemory;
+    readonly updated_at: string;
+    readonly session_id: string;
+};

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

@@ -0,0 +1,3 @@
+export type ShellLogs = {
+    logs: string;
+};

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

@@ -0,0 +1,3 @@
+export type SpacedRepetitionLearningPath = {
+    learning_path: string;
+};

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

@@ -0,0 +1,5 @@
+export type SpacedRepetitionQuestionStats = {
+    readonly total_questions: number;
+    readonly success_rate: number;
+    readonly reviewed_questions: number;
+};

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

@@ -0,0 +1,7 @@
+export type StarMentor = {
+    is_starred?: boolean;
+    readonly updated_at: string;
+    readonly mentor: string;
+    readonly student: string;
+    readonly recently_accessed_at: string | null;
+};

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

@@ -0,0 +1,12 @@
+/**
+ * * `published` - Published
+ * * `draft` - Unsynced
+ * * `error` - Error
+ * * `syncing` - Syncing
+ */
+export declare enum Status6eeEnum {
+    PUBLISHED = "published",
+    DRAFT = "draft",
+    ERROR = "error",
+    SYNCING = "syncing"
+}

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

@@ -0,0 +1,9 @@
+import type { StepStatusEnum } from './StepStatusEnum';
+export type Step = {
+    readonly id: number;
+    title: string;
+    description?: string;
+    status?: StepStatusEnum;
+    position: number;
+    job: number;
+};

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

@@ -0,0 +1,10 @@
+/**
+ * * `completed` - Completed
+ * * `failed` - Failed
+ * * `pending` - Pending
+ */
+export declare enum StepStatusEnum {
+    COMPLETED = "completed",
+    FAILED = "failed",
+    PENDING = "pending"
+}

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

@@ -0,0 +1,4 @@
+export type StudentChatMessage = {
+    username: string;
+    chat_message_count: number;
+};

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

@@ -0,0 +1,4 @@
+export type StylesView = {
+    readonly id: number;
+    description: string;
+};

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

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

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

@@ -0,0 +1,11 @@
+import type { Status6eeEnum } from './Status6eeEnum';
+import type { UnitWithChildren } from './UnitWithChildren';
+export type SubSectionWithChildren = {
+    readonly id: number;
+    section: number;
+    display_name: string;
+    readonly status: Status6eeEnum;
+    units: Array<UnitWithChildren>;
+    readonly created_at: string;
+    readonly updated_at: string;
+};

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

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

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

@@ -0,0 +1,8 @@
+/**
+ * * `Safety System` - Safety System
+ * * `Moderation System` - Moderation System
+ */
+export declare enum TargetSystemEnum {
+    SAFETY_SYSTEM = "Safety System",
+    MODERATION_SYSTEM = "Moderation System"
+}

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

@@ -0,0 +1,3 @@
+export type TaskView = {
+    task_id: string;
+};

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

@@ -0,0 +1,9 @@
+export type TemplateMentor = {
+    readonly id: number;
+    name: string;
+    slug?: string;
+    unique_id?: string;
+    description?: string | null;
+    system_prompt?: string | null;
+    platform_key: string | null;
+};

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

@@ -0,0 +1,6 @@
+import type { MentorData } from './MentorData';
+export type TenantMentorTraces = {
+    tenant: string;
+    tenant_total_cost: number;
+    mentor_data: Array<MentorData>;
+};

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

@@ -0,0 +1,8 @@
+/**
+ * * `dark` - Dark
+ * * `light` - Light
+ */
+export declare enum ThemeEnum {
+    DARK = "dark",
+    LIGHT = "light"
+}

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

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