@iblai/iblai-api 3.38.8-core → 3.38.9-ai-plus

package/src/models/PatchedMentorCreate.ts

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

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

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

@@ -0,0 +1,27 @@
+/* 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 { 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/src/models/PatchedSection.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 PatchedSection = {
+    readonly id?: number;
+    course?: number;
+    display_name?: string;
+    readonly status?: Status6eeEnum;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+};
+

package/src/models/PatchedSlackConfig.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PatchedSlackConfig = {
+    readonly id?: number;
+    bot?: number;
+    client_id?: string;
+    client_secret?: string;
+    app_token?: string;
+    verification_token?: string;
+};
+

package/src/models/PatchedSlackUserConfig.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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/src/models/PatchedSubSection.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 PatchedSubSection = {
+    readonly id?: number;
+    section?: number;
+    display_name?: string;
+    readonly status?: Status6eeEnum;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+};
+

package/src/models/PatchedTeamsConfig.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PatchedTeamsConfig = {
+    readonly id?: number;
+    readonly bot?: number;
+    client_id?: string;
+    client_secret?: string;
+    verification_token?: string;
+};
+

package/src/models/PatchedTrainingCreate.ts

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

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

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

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PatchedWhatsappUserConfig = {
+    readonly id?: number;
+    /**
+     * edX user ID
+     */
+    readonly user?: number;
+    phone_number?: string;
+    readonly date_created?: string;
+    readonly last_modified?: string;
+};
+

package/src/models/Pathway.ts

@@ -0,0 +1,33 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type Pathway = {
+    readonly id: number;
+    /**
+     * A unique pathway ID.
+     */
+    pathway_id: string;
+    pathway_uuid?: string;
+    readonly path: string;
+    /**
+     * The verbose name of the pathway.
+     */
+    name?: string;
+    /**
+     * Pathway visibility
+     */
+    visible?: boolean;
+    /**
+     * An additional unique slug field. (Optional)
+     */
+    slug?: string | null;
+    user_id?: number;
+    username?: string;
+    platform_key?: string;
+    /**
+     * Metadata
+     */
+    data?: any;
+};
+

package/src/models/PathwayCreateUpdateRequest.ts

@@ -0,0 +1,50 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for pathway creation/update request body.
+ */
+export type PathwayCreateUpdateRequest = {
+    /**
+     * Pathway ID
+     */
+    pathway_id?: string;
+    /**
+     * Pathway UUID
+     */
+    pathway_uuid?: string;
+    /**
+     * User ID of the pathway owner
+     */
+    user_id: number;
+    /**
+     * Username of the pathway owner
+     */
+    username?: string;
+    /**
+     * Pathway name
+     */
+    name: string;
+    /**
+     * Pathway slug
+     */
+    slug?: string;
+    /**
+     * Whether the pathway is visible
+     */
+    visible?: boolean;
+    /**
+     * Platform key
+     */
+    platform_key?: string;
+    /**
+     * List of items in the pathway with item_id and optional position
+     */
+    path: Array<Record<string, any>>;
+    /**
+     * Additional pathway data
+     */
+    data?: any;
+};
+

package/src/models/PathwayDeleteResponse.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for pathway deletion response.
+ */
+export type PathwayDeleteResponse = {
+    /**
+     * Number of pathways deleted
+     */
+    count: number;
+    /**
+     * Types of objects deleted
+     */
+    type: Record<string, any>;
+};
+

package/src/models/PathwayEnrollment.ts

@@ -0,0 +1,27 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PathwayEnrollment = {
+    user_id?: number;
+    username?: string;
+    pathway_id?: string;
+    pathway_uuid?: string;
+    platform_key?: string;
+    org?: string;
+    name?: string;
+    slug?: string;
+    /**
+     * Date when enrollment began/activated
+     */
+    created?: string | null;
+    /**
+     * Date when enrollment ended/deactivated
+     */
+    readonly ended: string | null;
+    /**
+     * Whether the enrollment is active
+     */
+    active?: boolean;
+};
+

package/src/models/PathwayEnrollmentPlus.ts

@@ -0,0 +1,31 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Includes metadata+
+ */
+export type PathwayEnrollmentPlus = {
+    user_id?: number;
+    username?: string;
+    pathway_id?: string;
+    pathway_uuid?: string;
+    platform_key?: string;
+    org?: string;
+    name?: string;
+    slug?: string;
+    /**
+     * Date when enrollment began/activated
+     */
+    created?: string | null;
+    /**
+     * Date when enrollment ended/deactivated
+     */
+    readonly ended: string | null;
+    /**
+     * Whether the enrollment is active
+     */
+    active?: boolean;
+    metadata?: any;
+};
+

package/src/models/PathwayEnrollmentRequest.ts

@@ -0,0 +1,54 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for pathway enrollment request parameters.
+ */
+export type PathwayEnrollmentRequest = {
+    /**
+     * User ID for enrollment
+     */
+    user_id?: string;
+    /**
+     * Username for enrollment
+     */
+    username?: string;
+    /**
+     * Pathway ID for enrollment
+     */
+    pathway_id?: string;
+    /**
+     * Pathway UUID for enrollment
+     */
+    pathway_uuid?: string;
+    /**
+     * Pathway key for enrollment
+     */
+    pathway_key?: string;
+    /**
+     * Pathway slug for enrollment
+     */
+    slug?: string;
+    /**
+     * Organization for the pathway
+     */
+    org?: string;
+    /**
+     * Platform key for the pathway
+     */
+    platform_key?: string;
+    /**
+     * Include enrollments from default platform
+     */
+    include_default_platform?: boolean;
+    /**
+     * Include metadata in the response
+     */
+    include_metadata?: boolean;
+    /**
+     * Whether the enrollment should be active
+     */
+    active?: boolean;
+};
+

package/src/models/PathwaySelfEnrollmentRequest.ts

@@ -0,0 +1,42 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Serializer for pathway self-enrollment request parameters.
+ */
+export type PathwaySelfEnrollmentRequest = {
+    /**
+     * User ID for self-enrollment
+     */
+    user_id?: string;
+    /**
+     * Username for self-enrollment
+     */
+    username?: string;
+    /**
+     * Pathway ID for self-enrollment
+     */
+    pathway_id?: string;
+    /**
+     * Pathway key for self-enrollment
+     */
+    pathway_key?: string;
+    /**
+     * Pathway slug for self-enrollment
+     */
+    slug?: string;
+    /**
+     * Organization for the pathway
+     */
+    org?: string;
+    /**
+     * Platform key for the pathway
+     */
+    platform_key?: string;
+    /**
+     * Whether the enrollment should be active
+     */
+    active?: boolean;
+};
+

package/src/models/PeriodicAgent.ts

@@ -0,0 +1,47 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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;
+};
+