@iblai/iblai-api 3.35.2-core → 3.35.3-ai-plus

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

@@ -0,0 +1,7 @@
+export type MessageViewRequest = {
+    title?: string;
+    /**
+     * List of tools slugs to use
+     */
+    tools?: Array<string>;
+};

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

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

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

@@ -0,0 +1,5 @@
+export type Metadata = {
+    metadata: any;
+    prompt?: string;
+    prompt_id?: number;
+};

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

@@ -0,0 +1,4 @@
+export type MetricChange = {
+    total: number;
+    change: number;
+};

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

@@ -0,0 +1,4 @@
+export type ModelCost = {
+    model: string;
+    total_cost: number;
+};

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

@@ -0,0 +1,11 @@
+import type { TargetSystemEnum } from './TargetSystemEnum';
+export type ModerationLog = {
+    readonly id: number;
+    username?: string;
+    platform_key: string;
+    mentor: number;
+    prompt: string;
+    reason: string;
+    target_system?: TargetSystemEnum;
+    readonly date_created: string;
+};

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

@@ -0,0 +1,3 @@
+export type NoChatMessagesFound = {
+    error?: string;
+};

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

@@ -1,11 +1,11 @@
 import type { BlankEnum } from './BlankEnum';
-import type { StatusEnum } from './StatusEnum';
+import type { NotificationStatusEnum } from './NotificationStatusEnum';
 export type Notification = {
     readonly id: string;
     username: string;
     readonly title: string;
     readonly body: string;
-    status?: (StatusEnum | BlankEnum);
+    status?: (NotificationStatusEnum | BlankEnum);
     readonly channel: string | null;
     context?: any;
     readonly short_message: string;

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

@@ -1,8 +1,8 @@
-import type { TypeEnum } from './TypeEnum';
+import type { NotificationSourceTypeEnum } from './NotificationSourceTypeEnum';
 /**
  * Request serializer for source validation
  */
 export type NotificationSource = {
-    type: TypeEnum;
+    type: NotificationSourceTypeEnum;
     data: any;
 };

package/dist/types/models/{TypeEnum.d.ts → NotificationSourceTypeEnum.d.ts}

@@ -7,7 +7,7 @@
  * * `pathway` - pathway
  * * `program` - program
  */
-export declare enum TypeEnum {
+export declare enum NotificationSourceTypeEnum {
     EMAIL = "email",
     USERNAME = "username",
     PLATFORM = "platform",

package/dist/types/models/{StatusEnum.d.ts → NotificationStatusEnum.d.ts}

@@ -3,7 +3,7 @@
  * * `UNREAD` - Unread
  * * `CANCELLED` - Cancelled
  */
-export declare enum StatusEnum {
+export declare enum NotificationStatusEnum {
     READ = "READ",
     UNREAD = "UNREAD",
     CANCELLED = "CANCELLED"

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

@@ -0,0 +1 @@
+export type NullEnum = {};

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

@@ -0,0 +1,6 @@
+export type PageContent = {
+    /**
+     * The page content
+     */
+    page_content: string;
+};

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,12 @@
+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/PatchedConversations.d.ts

@@ -0,0 +1,28 @@
+import type { TopicModel } from './TopicModel';
+export type PatchedConversations = {
+    readonly id?: string;
+    readonly messages?: string;
+    topics?: Array<TopicModel>;
+    readonly sentiment?: string;
+    mentor?: string;
+    readonly student?: string;
+    readonly email?: string;
+    model?: string;
+    readonly rating?: number;
+    platform?: string;
+    /**
+     * Email claim from LTI1.3 JWT if an LTI user and available
+     */
+    readonly lti_email?: string;
+    /**
+     * Username claim from LTI1.3 JWT if an LTI user and available
+     */
+    readonly lti_username?: string;
+    readonly inserted_at?: string;
+    has_document?: boolean;
+    memory_tracked?: boolean;
+    llm_name?: string | null;
+    llm_provider?: string | null;
+    metadata?: any;
+    tools?: Array<number>;
+};

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

@@ -0,0 +1,7 @@
+export type PatchedCourseCreationTaskFile = {
+    readonly id?: number;
+    course_creation_task?: number;
+    file?: string;
+    readonly date_created?: string;
+    readonly last_modified?: string;
+};

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

@@ -0,0 +1,14 @@
+export type PatchedCredentialRequest = {
+    /**
+     * Name of the credential provider (e.g., 'openai', 'google-drive')
+     */
+    name?: string;
+    /**
+     * Credential data for the provider (API keys, service account details, etc.)
+     */
+    value?: any;
+    /**
+     * Organization key identifier for the tenant
+     */
+    platform?: string;
+};

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

@@ -0,0 +1,21 @@
+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

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

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

@@ -0,0 +1,10 @@
+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/PatchedLLMCredentialRequest.d.ts

@@ -0,0 +1,14 @@
+export type PatchedLLMCredentialRequest = {
+    /**
+     * Name of the credential provider
+     */
+    name?: string;
+    /**
+     * Value of the credential provider
+     */
+    value?: any;
+    /**
+     * Key of the tenant
+     */
+    platform?: string;
+};

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

@@ -0,0 +1,11 @@
+export type PatchedMentorCategoryGroupCreate = {
+    readonly id?: number;
+    name?: string;
+    description?: string;
+    /**
+     * Deprecated: This is only left for backward compatibility. Please use the audiences field instead.
+     */
+    audience?: number | null;
+    audiences?: Array<number>;
+    readonly date_created?: string;
+};

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

@@ -0,0 +1,74 @@
+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;
+    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;
+    enable_safety_system?: boolean;
+    /**
+     * Response to start a conversation with a user.
+     */
+    proactive_response?: string;
+    /**
+     * 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/dist/types/models/PatchedNotification.d.ts

@@ -1,11 +1,11 @@
 import type { BlankEnum } from './BlankEnum';
-import type { StatusEnum } from './StatusEnum';
+import type { NotificationStatusEnum } from './NotificationStatusEnum';
 export type PatchedNotification = {
     readonly id?: string;
     username?: string;
     readonly title?: string;
     readonly body?: string;
-    status?: (StatusEnum | BlankEnum);
+    status?: (NotificationStatusEnum | BlankEnum);
     readonly channel?: string | null;
     context?: any;
     readonly short_message?: string;

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

@@ -0,0 +1,41 @@
+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/dist/types/models/PatchedPlayWrightScript.d.ts

@@ -0,0 +1,12 @@
+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/dist/types/models/PatchedPrompt.d.ts

@@ -0,0 +1,22 @@
+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/dist/types/models/PatchedSection.d.ts

@@ -0,0 +1,9 @@
+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/dist/types/models/PatchedSlackConfig.d.ts

@@ -0,0 +1,8 @@
+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

@@ -0,0 +1,17 @@
+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;
+};