@iblai/iblai-api 4.4.0-ai-plus → 4.4.1-ai

package/src/models/{WebexWebhook.ts → UserMemoryEntryRequest.ts}

@@ -2,8 +2,9 @@
 /* istanbul ignore file */
 /* tslint:disable */
 /* eslint-disable */
-export type WebexWebhook = {
-    data: Record<string, any>;
-    resource: string;
+export type UserMemoryEntryRequest = {
+    key: string;
+    value: string;
+    expires_at?: string | null;
 };
 

package/src/models/UserMemoryRequest.ts

@@ -0,0 +1,17 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { UserMemoryEntryRequest } from './UserMemoryEntryRequest';
+export type UserMemoryRequest = {
+    mode?: string;
+    name?: string | null;
+    platform?: string | null;
+    mentor_unique_id?: string | null;
+    session_id?: string | null;
+    catalog_item_type?: string | null;
+    catalog_item_id?: string | null;
+    entries: Array<UserMemoryEntryRequest>;
+    category?: string | null;
+};
+

package/src/services/AiMentorService.ts

@@ -132,6 +132,7 @@ import type { Unit } from '../models/Unit';
 import type { UserChatFeedback } from '../models/UserChatFeedback';
 import type { UserEdxMemory } from '../models/UserEdxMemory';
 import type { UserMemory } from '../models/UserMemory';
+import type { UserMemoryRequest } from '../models/UserMemoryRequest';
 import type { VectorResult } from '../models/VectorResult';
 import type { Voice } from '../models/Voice';
 import type { WebResource } from '../models/WebResource';
@@ -140,6 +141,17 @@ import type { CancelablePromise } from '../core/CancelablePromise';
 import { OpenAPI } from '../core/OpenAPI';
 import { request as __request } from '../core/request';
 export class AiMentorService {
+    /**
+     * Proxy endpoint to check for langfuse health status
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static aiMentorLangfuseHealthRetrieve(): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-mentor/langfuse/health',
+        });
+    }
     /**
      * List all triggers for an organization.
      *
@@ -5141,18 +5153,47 @@ export class AiMentorService {
                                             });
                                         }
                                         /**
-                                         * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
+                                         * Retrieve a list of memories based on filter conditions.
+                                         *
+                                         * Returns:
+                                         * Response: A paginated list of memories.
+                                         *
+                                         * Raises:
+                                         * NotFound: If the query is invalid.
                                          * @returns PaginatedUserMemoryList
                                          * @throws ApiError
                                          */
                                         public static aiMentorOrgsUsersMemoriesList({
                                             org,
                                             userId,
+                                            category,
+                                            endDate,
+                                            mentor,
+                                            mode,
                                             page,
                                             pageSize,
+                                            platform,
+                                            session,
+                                            startDate,
                                         }: {
                                             org: string,
                                             userId: string,
+                                            /**
+                                             * a string of category to filter memories
+                                             */
+                                            category?: string,
+                                            /**
+                                             * ISO date for end date (optional)
+                                             */
+                                            endDate?: string,
+                                            /**
+                                             * the mentor unique id which the memory is linked to
+                                             */
+                                            mentor?: string,
+                                            /**
+                                             * mode which the memory applies to. can be `guided`, `regular` or `all`
+                                             */
+                                            mode?: string,
                                             /**
                                              * A page number within the paginated result set.
                                              */
@@ -5161,6 +5202,18 @@ export class AiMentorService {
                                              * Number of results to return per page.
                                              */
                                             pageSize?: number,
+                                            /**
+                                             * the platform which the memory is linked to
+                                             */
+                                            platform?: string,
+                                            /**
+                                             * the session id which the memory is linked to
+                                             */
+                                            session?: string,
+                                            /**
+                                             * ISO date for start date (optional)
+                                             */
+                                            startDate?: string,
                                         }): CancelablePromise<PaginatedUserMemoryList> {
                                             return __request(OpenAPI, {
                                                 method: 'GET',
@@ -5170,25 +5223,43 @@ export class AiMentorService {
                                                     'user_id': userId,
                                                 },
                                                 query: {
+                                                    'category': category,
+                                                    'end_date': endDate,
+                                                    'mentor': mentor,
+                                                    'mode': mode,
                                                     'page': page,
                                                     'page_size': pageSize,
+                                                    'platform': platform,
+                                                    'session': session,
+                                                    'start_date': startDate,
                                                 },
                                             });
                                         }
                                         /**
-                                         * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
-                                         * @returns UserMemory
+                                         * Create memory
+                                         * Create memory using the request data
+                                         * @returns PaginatedUserMemoryList
                                          * @throws ApiError
                                          */
                                         public static aiMentorOrgsUsersMemoriesCreate({
                                             org,
                                             userId,
                                             requestBody,
+                                            page,
+                                            pageSize,
                                         }: {
                                             org: string,
                                             userId: string,
-                                            requestBody: UserMemory,
-                                        }): CancelablePromise<UserMemory> {
+                                            requestBody: UserMemoryRequest,
+                                            /**
+                                             * A page number within the paginated result set.
+                                             */
+                                            page?: number,
+                                            /**
+                                             * Number of results to return per page.
+                                             */
+                                            pageSize?: number,
+                                        }): CancelablePromise<PaginatedUserMemoryList> {
                                             return __request(OpenAPI, {
                                                 method: 'POST',
                                                 url: '/api/ai-mentor/orgs/{org}/users/{user_id}/memories/',
@@ -5196,6 +5267,10 @@ export class AiMentorService {
                                                     'org': org,
                                                     'user_id': userId,
                                                 },
+                                                query: {
+                                                    'page': page,
+                                                    'page_size': pageSize,
+                                                },
                                                 body: requestBody,
                                                 mediaType: 'application/json',
                                             });
@@ -5226,35 +5301,7 @@ export class AiMentorService {
                                         }
                                         /**
                                          * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
-                                         * @returns UserMemory
-                                         * @throws ApiError
-                                         */
-                                        public static aiMentorOrgsUsersMemoryCreate({
-                                            memoryUniqueId,
-                                            org,
-                                            userId,
-                                            requestBody,
-                                        }: {
-                                            memoryUniqueId: string,
-                                            org: string,
-                                            userId: string,
-                                            requestBody: UserMemory,
-                                        }): CancelablePromise<UserMemory> {
-                                            return __request(OpenAPI, {
-                                                method: 'POST',
-                                                url: '/api/ai-mentor/orgs/{org}/users/{user_id}/memory/{memory_unique_id}/',
-                                                path: {
-                                                    'memory_unique_id': memoryUniqueId,
-                                                    'org': org,
-                                                    'user_id': userId,
-                                                },
-                                                body: requestBody,
-                                                mediaType: 'application/json',
-                                            });
-                                        }
-                                        /**
-                                         * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
-                                         * @returns void
+                                         * @returns any Memory deleted successfully.
                                          * @throws ApiError
                                          */
                                         public static aiMentorOrgsUsersMemoryDestroy({
@@ -5265,7 +5312,7 @@ export class AiMentorService {
                                             memoryUniqueId: string,
                                             org: string,
                                             userId: string,
-                                        }): CancelablePromise<void> {
+                                        }): CancelablePromise<any> {
                                             return __request(OpenAPI, {
                                                 method: 'DELETE',
                                                 url: '/api/ai-mentor/orgs/{org}/users/{user_id}/memory/{memory_unique_id}/',
@@ -5274,6 +5321,9 @@ export class AiMentorService {
                                                     'org': org,
                                                     'user_id': userId,
                                                 },
+                                                errors: {
+                                                    404: `Memory not found.`,
+                                                },
                                             });
                                         }
                                         /**

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

@@ -1,15 +0,0 @@
-import type { Provider05cEnum } from './Provider05cEnum';
-export type Bot = {
-    readonly id: number;
-    readonly platform: number;
-    readonly tenant: string;
-    name: string;
-    provider: Provider05cEnum;
-    readonly is_configured: boolean;
-    slack_config: number;
-    readonly discord_config: number;
-    readonly webex_config: number;
-    readonly whatsapp_config: number;
-    readonly teams_config: number;
-    readonly webhook_url: string;
-};

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

@@ -1,6 +0,0 @@
-export type BotCommand = {
-    readonly id: number;
-    command: string;
-    mentor: number;
-    bot: number;
-};

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

@@ -1,12 +0,0 @@
-import type { Provider05cEnum } from './Provider05cEnum';
-export type BotCreate = {
-    readonly id: number;
-    name: string;
-    provider: Provider05cEnum;
-    readonly is_configured: boolean;
-    readonly webhook_url: string;
-    readonly discord_config: number;
-    readonly webex_config: number;
-    readonly whatsapp_config: number;
-    readonly teams_config: number;
-};

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

@@ -1,21 +0,0 @@
-import type { DataSetStatusEnum } from './DataSetStatusEnum';
-export type DataSet = {
-    readonly id: string;
-    readonly platform: Record<string, (string | number)> | null;
-    name: string;
-    /**
-     * (if any) Special instructions for generating the dataset. This could be requirements on tone, language, style, etc.
-     */
-    prompt?: string;
-    source_url?: string;
-    source_file?: string;
-    status?: DataSetStatusEnum;
-    num_data_points?: number;
-    train_split?: number;
-    train_file?: string;
-    test_file?: string;
-    retry_attempts?: number;
-    error_log?: string;
-    readonly date_created: string;
-    readonly last_modified: string;
-};

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

@@ -1,12 +0,0 @@
-export type DataSetCreate = {
-    readonly id: string;
-    name: string;
-    source_url?: string;
-    source_file?: string;
-    num_data_points?: number;
-    train_split?: number;
-    /**
-     * (if any) Special instructions for generating the dataset. This could be requirements on tone, language, style, etc.
-     */
-    prompt?: string;
-};

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

@@ -1,12 +0,0 @@
-/**
- * * `pending` - Pending
- * * `processing` - Processing
- * * `completed` - Completed
- * * `failed` - Failed
- */
-export declare enum DataSetStatusEnum {
-    PENDING = "pending",
-    PROCESSING = "processing",
-    COMPLETED = "completed",
-    FAILED = "failed"
-}

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

@@ -1,7 +0,0 @@
-export type DiscordConfig = {
-    readonly id: number;
-    readonly bot: number;
-    client_id: string;
-    token: string;
-    client_secret: string;
-};

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

@@ -1,10 +0,0 @@
-export type DiscordUserConfig = {
-    readonly id: number;
-    /**
-     * edX user ID
-     */
-    readonly user: number;
-    discord_user_id: string;
-    readonly date_created: string;
-    readonly last_modified: string;
-};

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

@@ -1,6 +0,0 @@
-export type DiscordWebhook = {
-    application_id: string;
-    type: string;
-    token: string;
-    id: string;
-};

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

@@ -1,7 +0,0 @@
-import type { DataSet } from './DataSet';
-export type PaginatedDataSetList = {
-    count: number;
-    next?: string | null;
-    previous?: string | null;
-    results: Array<DataSet>;
-};

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

@@ -1,7 +0,0 @@
-import type { Training } from './Training';
-export type PaginatedTrainingList = {
-    count: number;
-    next?: string | null;
-    previous?: string | null;
-    results: Array<Training>;
-};

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

@@ -1,6 +0,0 @@
-export type PatchedBotCommand = {
-    readonly id?: number;
-    command?: string;
-    mentor?: number;
-    bot?: number;
-};

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

@@ -1,12 +0,0 @@
-import type { Provider05cEnum } from './Provider05cEnum';
-export type PatchedBotCreate = {
-    readonly id?: number;
-    name?: string;
-    provider?: Provider05cEnum;
-    readonly is_configured?: boolean;
-    readonly webhook_url?: string;
-    readonly discord_config?: number;
-    readonly webex_config?: number;
-    readonly whatsapp_config?: number;
-    readonly teams_config?: number;
-};

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

@@ -1,21 +0,0 @@
-import type { DataSetStatusEnum } from './DataSetStatusEnum';
-export type PatchedDataSet = {
-    readonly id?: string;
-    readonly platform?: Record<string, (string | number)> | null;
-    name?: string;
-    /**
-     * (if any) Special instructions for generating the dataset. This could be requirements on tone, language, style, etc.
-     */
-    prompt?: string;
-    source_url?: string;
-    source_file?: string;
-    status?: DataSetStatusEnum;
-    num_data_points?: number;
-    train_split?: number;
-    train_file?: string;
-    test_file?: string;
-    retry_attempts?: number;
-    error_log?: string;
-    readonly date_created?: string;
-    readonly last_modified?: string;
-};

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

@@ -1,7 +0,0 @@
-export type PatchedDiscordConfig = {
-    readonly id?: number;
-    readonly bot?: number;
-    client_id?: string;
-    token?: string;
-    client_secret?: string;
-};

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

@@ -1,10 +0,0 @@
-export type PatchedDiscordUserConfig = {
-    readonly id?: number;
-    /**
-     * edX user ID
-     */
-    readonly user?: number;
-    discord_user_id?: string;
-    readonly date_created?: string;
-    readonly last_modified?: string;
-};

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

@@ -1,8 +0,0 @@
-export type PatchedSlackConfig = {
-    readonly id?: number;
-    bot?: number;
-    client_id?: string;
-    client_secret?: string;
-    app_token?: string;
-    verification_token?: string;
-};

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

@@ -1,17 +0,0 @@
-export type PatchedSlackUserConfig = {
-    readonly id?: number;
-    /**
-     * edX user ID
-     */
-    readonly user?: number;
-    /**
-     * Team Domain in the stated slack workspace. This is also the workspace name.
-     */
-    slack_team_domain?: string;
-    /**
-     * Username in the stated slack workspace
-     */
-    slack_username?: string;
-    readonly date_created?: string;
-    readonly last_modified?: string;
-};

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

@@ -1,7 +0,0 @@
-export type PatchedTeamsConfig = {
-    readonly id?: number;
-    readonly bot?: number;
-    client_id?: string;
-    client_secret?: string;
-    verification_token?: string;
-};

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

@@ -1,31 +0,0 @@
-import type { Provider63aEnum } from './Provider63aEnum';
-export type PatchedTrainingCreate = {
-    readonly id?: string;
-    project_name?: string;
-    dataset?: string;
-    base_model_name?: string;
-    provider?: Provider63aEnum;
-    text_column?: string;
-    learning_rate?: number;
-    batch_size?: number;
-    num_epochs?: number;
-    block_size?: number;
-    warmup_ratio?: number;
-    lora_r?: number;
-    lora_alpha?: number;
-    lora_dropout?: number;
-    weight_decay?: number;
-    gradient_accumulation?: number;
-    use_peft?: boolean;
-    use_fp16?: boolean;
-    use_int4?: boolean;
-    push_to_hub?: boolean;
-    repo_id?: string;
-    preprocess_dataset?: boolean;
-    prompt_column?: string;
-    prompt_prefix?: string;
-    prompt_suffix?: string;
-    response_prefix?: string;
-    readonly date_created?: string;
-    readonly last_modified?: string;
-};

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

@@ -1,10 +0,0 @@
-export type PatchedWebexConfig = {
-    readonly id?: number;
-    readonly bot?: number;
-    /**
-     * Bot id from webex
-     */
-    webex_bot_id?: string;
-    bot_access_token?: string;
-    bot_username?: string;
-};

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

@@ -1,11 +0,0 @@
-export type PatchedWhatsappConfig = {
-    readonly id?: number;
-    readonly bot?: number;
-    phone_number_id?: string;
-    application_secret?: string;
-    webhook_verification_token?: string;
-    /**
-     * Access token to the bot. This can also be a temporary access token.
-     */
-    access_token?: string;
-};

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

@@ -1,10 +0,0 @@
-export type PatchedWhatsappUserConfig = {
-    readonly id?: number;
-    /**
-     * edX user ID
-     */
-    readonly user?: number;
-    phone_number?: string;
-    readonly date_created?: string;
-    readonly last_modified?: string;
-};

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

@@ -1,14 +0,0 @@
-/**
- * * `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

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

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

@@ -1,8 +0,0 @@
-export type SlackConfig = {
-    readonly id: number;
-    bot: number;
-    client_id: string;
-    client_secret: string;
-    app_token: string;
-    verification_token: string;
-};

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

@@ -1,17 +0,0 @@
-export type SlackUserConfig = {
-    readonly id: number;
-    /**
-     * edX user ID
-     */
-    readonly user: number;
-    /**
-     * Team Domain in the stated slack workspace. This is also the workspace name.
-     */
-    slack_team_domain: string;
-    /**
-     * Username in the stated slack workspace
-     */
-    slack_username: string;
-    readonly date_created: string;
-    readonly last_modified: string;
-};

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

@@ -1,6 +0,0 @@
-export type SlackWebhook = {
-    type: string;
-    event: Record<string, any>;
-    command: string;
-    response_url: string;
-};

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

@@ -1,7 +0,0 @@
-export type TeamsConfig = {
-    readonly id: number;
-    readonly bot: number;
-    client_id: string;
-    client_secret: string;
-    verification_token?: string;
-};

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

@@ -1,17 +0,0 @@
-export type TeamsWebhook = {
-    id?: string | null;
-    type?: string | null;
-    channelData?: Record<string, any> | null;
-    entities?: Array<any> | null;
-    text?: string | null;
-    locale?: string | null;
-    textFormat?: string | null;
-    recipient?: Record<string, any> | null;
-    conversation?: Record<string, any> | null;
-    from_?: Record<string, any> | null;
-    channelId?: string | null;
-    serviceUrl?: string | null;
-    localTimezone?: string | null;
-    localTimestamp?: string | null;
-    timestamp?: string | null;
-};