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

package/src/models/QuestionRequest.ts

@@ -0,0 +1,20 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/QuestionResponse.ts

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/RatingEnum.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `1` - Up Vote
+ * * `-1` - Down Vote
+ */
+export enum RatingEnum {
+    '_1' = 1,
+    '_-1' = -1,
+}

package/src/models/RatingRecord.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type RatingRecord = {
+    time: string;
+    total_ratings: number;
+};
+

package/src/models/RbacGroup.ts

@@ -0,0 +1,39 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/RbacGroupRole.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/RbacPlatform.ts

@@ -0,0 +1,19 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for platforms.
+ */
+export type RbacPlatform = {
+    readonly id: number;
+    /**
+     * The platform key
+     */
+    key: string;
+    /**
+     * The name of the platform
+     */
+    name?: string | null;
+};
+

package/src/models/RbacPolicy.ts

@@ -0,0 +1,33 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/RbacRole.ts

@@ -0,0 +1,25 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/RbacUser.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for users.
+ */
+export type RbacUser = {
+    /**
+     * edX user ID
+     */
+    readonly id: number;
+    /**
+     * edX username
+     */
+    username?: string | null;
+};
+

package/src/models/RbacUserRole.ts

@@ -0,0 +1,33 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/RecentlyAccessedMentor.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/RecommendCourseBlock.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type RecommendCourseBlock = {
+    blocks: Array<any>;
+};
+

package/src/models/RecommendCourseResponse.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type RecommendCourseResponse = {
+    courses: Array<any>;
+};
+

package/src/models/RecommendedCoursesResponse.ts

@@ -0,0 +1,38 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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/src/models/RelatedText.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type RelatedText = {
+    question: string;
+};
+

package/src/models/RequestDataVariable.ts

@@ -0,0 +1,19 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/ResourceScrappedData.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/ResourceScrappedDataStatusEnum.ts

@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * * `scrapped` - Scraped
+ * * `failed` - Failed
+ * * `pending` - Pending
+ * * `unscrapped` - Unscraped
+ */
+export enum ResourceScrappedDataStatusEnum {
+    SCRAPPED = 'scrapped',
+    FAILED = 'failed',
+    PENDING = 'pending',
+    UNSCRAPPED = 'unscrapped',
+}

package/src/models/ResponseDataVariable.ts

@@ -0,0 +1,19 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type ResponseDataVariable = {
+    /**
+     * Variable Name
+     */
+    variable_name: string;
+    /**
+     * Predicted data
+     */
+    predicted_data: any;
+    /**
+     * Explanation of prediction
+     */
+    narrative: string;
+};
+

package/src/models/RetreiverTrainViewRequest.ts

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type RetreiverTrainViewRequest = {
+    /**
+     * Pathway for document to be trained in
+     */
+    pathway: string;
+    /**
+     * Url of the document to be trained
+     */
+    url: string;
+};
+

package/src/models/RetreiverTrainViewResponse.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type RetreiverTrainViewResponse = {
+    /**
+     * Status of the training
+     */
+    detail: string;
+};
+

package/src/models/RetrieveTask.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type RetrieveTask = {
+    task: string;
+};
+

package/src/models/RetrieverDocumentEmbedding.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/RetrieverDocumentEmbeddingRequest.ts

@@ -0,0 +1,35 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/RetrieverRequestSearch.ts

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type RetrieverRequestSearch = {
+    /**
+     * The query for similarity search
+     */
+    query: string;
+    /**
+     * The pathway of the docs
+     */
+    pathway: string;
+};
+

package/src/models/RetrieverRequestSearchDocument.ts

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type RetrieverRequestSearchDocument = {
+    /**
+     * The source url of the docuemnt
+     */
+    source: string;
+    /**
+     * The percentge confidence level of the document retrieved
+     */
+    confidence_level: number;
+};
+

package/src/models/RetrieverResponseSearch.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { PageContent } from './PageContent';
+export type RetrieverResponseSearch = {
+    /**
+     * Docs from similarity search
+     */
+    results: Array<PageContent>;
+};
+

package/src/models/ReuestDataVariableList.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { RequestDataVariable } from './RequestDataVariable';
+export type ReuestDataVariableList = {
+    data_variables: Array<RequestDataVariable>;
+};
+

package/src/models/RunMentorEval.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type RunMentorEval = {
+    id: number;
+};
+

package/src/models/ScanWebhookRequest.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type ScanWebhookRequest = {
+    file_id: string;
+    filename: string;
+    status: string;
+    message: string;
+};
+

package/src/models/ScanWebhookResponse.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type ScanWebhookResponse = {
+    message: string;
+};
+

package/src/models/Section.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/SectionWithChildren.ts

@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/SeedMentorsView.ts

@@ -0,0 +1,8 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type SeedMentorsView = {
+    detail: string;
+};
+

package/src/models/SentimentSummary.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type SentimentSummary = {
+    sentiment_distribution: Record<string, any>;
+    total_sentiments: number;
+};
+

package/src/models/SessionBrowserScreenshot.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type SessionBrowserScreenshot = {
+    type: string;
+    session_id: string;
+    format: string;
+    ext: string;
+    url: string;
+    time: string;
+};
+