@iblai/iblai-api 3.34.5-ai

package/src/models/LinkCourseRequest.ts

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

package/src/models/LinkCourseResponse.ts

@@ -0,0 +1,10 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type LinkCourseResponse = {
+    mentor_unique_id: string;
+    course_id?: string | null;
+    is_linked: boolean;
+};
+

package/src/models/LtiKey.ts

@@ -0,0 +1,24 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type LtiKey = {
+    readonly id: number;
+    /**
+     * Name of the RSA Key
+     */
+    name: string;
+    /**
+     * Public Key in PEM format
+     */
+    readonly public_key: string;
+    /**
+     * Public key in JWK format
+     */
+    readonly public_jwk: any;
+    /**
+     * Platform Key
+     */
+    platform_key: string;
+};
+

package/src/models/LtiLaunchGate.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type LtiLaunchGate = {
+    allowed_keys?: Array<string>;
+    allowed_courses?: Array<string>;
+    /**
+     * If True, a target_link_uri will work with any content within this org
+     */
+    allow_all_within_org?: boolean;
+};
+

package/src/models/LtiTool.ts

@@ -0,0 +1,51 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { LtiLaunchGate } from './LtiLaunchGate';
+export type LtiTool = {
+    readonly id: number;
+    /**
+     * The title of the tool
+     */
+    title: string;
+    /**
+     * This value will look someting like https://example.com. Value provided by Lti 1.3 Platform.
+     */
+    issuer: string;
+    /**
+     * The client id provided by Lti 1.3 Platform
+     */
+    client_id: string;
+    /**
+     * The Platforms OIDC Login endpoint. Value provided by LTI 1.3 Platform.
+     */
+    auth_login_url: string;
+    /**
+     * The Platforms OIDC Token endpoint. Value provided by LTI 1.3 Platform.
+     */
+    auth_token_url: string;
+    /**
+     * The platforms Oauth2 Audience (aud). Usually can be skipped.
+     */
+    auth_audience?: string | null;
+    /**
+     * The platforms JWKS endpoint. Value provided by LTI 1.3 Platform.
+     */
+    key_set_url?: string | null;
+    /**
+     * In case Platform's JWKS endpoint is not available, you can provide the JWKS here. Value provided by LTI 1.3 Platform.
+     */
+    key_set?: any;
+    /**
+     * Reference to Lti Tool
+     */
+    tool_key: number;
+    /**
+     * List of deployment ids. Example: ["1", "deployment-2"]. Value(s) provided by LTI 1.3 Platform.
+     */
+    deployment_ids: Array<string>;
+    platform_key: string;
+    launch_gate: LtiLaunchGate;
+};
+

package/src/models/MemoryComponentData.ts

@@ -0,0 +1,10 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { KindEnum } from './KindEnum';
+export type MemoryComponentData = {
+    kind?: KindEnum;
+    content: string;
+};
+

package/src/models/MemoryComponentMemory.ts

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

package/src/models/MemoryComponentMemoryDetail.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { MemoryComponentData } from './MemoryComponentData';
+export type MemoryComponentMemoryDetail = {
+    data: Array<MemoryComponentData>;
+    readonly catalog_item: string;
+    readonly mentor_unique_id: string;
+    readonly student: string;
+    readonly inserted_at: string;
+};
+

package/src/models/MemoryComponentResponse.ts

@@ -0,0 +1,10 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type MemoryComponentResponse = {
+    readonly knowledge_gaps: Array<string>;
+    readonly lessons_learned: Array<string>;
+    readonly help_requests: Array<string>;
+};
+

package/src/models/MemoryProgress.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type MemoryProgress = {
+    readonly memory_type: string;
+    readonly all_units: number | null;
+    readonly all_unit_names: Array<string> | null;
+    readonly current_unit: number | null;
+    readonly current_unit_name: string | null;
+    readonly item_name: string | null;
+};
+

package/src/models/MemoryStatusRequestView.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type MemoryStatusRequestView = {
+    /**
+     * Enable or disable memory use
+     */
+    enabled: boolean;
+};
+

package/src/models/MemoryStatusView.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type MemoryStatusView = {
+    readonly id: number;
+    username: string;
+    platform_key: string;
+    enabled?: boolean;
+};
+

package/src/models/Mentor.ts

@@ -0,0 +1,80 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { GreetingMethodEnum } from './GreetingMethodEnum';
+import type { MentorCategory } from './MentorCategory';
+export type Mentor = {
+    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;
+    /**
+     * Instructions to determine how prompt suggestions are generated.
+     */
+    guided_prompt_instructions?: string;
+    google_voice?: number | null;
+    openai_voice?: number | null;
+    categories: Array<MentorCategory>;
+    /**
+     * 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/src/models/MentorAudience.ts

@@ -0,0 +1,10 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type MentorAudience = {
+    readonly id: number;
+    name: string;
+    description?: string | null;
+};
+

package/src/models/MentorCategory.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { MentorAudience } from './MentorAudience';
+export type MentorCategory = {
+    readonly id: number;
+    name: string;
+    description?: string | null;
+    category_group?: number | null;
+    audience: MentorAudience;
+    audiences: Array<MentorAudience>;
+};
+

package/src/models/MentorCategoryCreate.ts

@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type MentorCategoryCreate = {
+    readonly id: number;
+    name: string;
+    category_group?: number | null;
+    description?: string | null;
+    /**
+     * Deprecated: This is only left for backward compatibility. Please use the audiences field instead.
+     */
+    audience?: number | null;
+    audiences?: Array<number>;
+};
+

package/src/models/MentorCategoryGroup.ts

@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { MentorAudience } from './MentorAudience';
+import type { MentorCategory } from './MentorCategory';
+export type MentorCategoryGroup = {
+    readonly id: number;
+    name: string;
+    description: string;
+    audience: MentorAudience;
+    readonly date_created: string;
+    categories: Array<MentorCategory>;
+    audiences: Array<MentorAudience>;
+};
+

package/src/models/MentorCategoryGroupCreate.ts

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

@@ -0,0 +1,79 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { GreetingMethodEnum } from './GreetingMethodEnum';
+export type MentorCreate = {
+    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/src/models/MentorCustomVoice.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type MentorCustomVoice = {
+    voice_provider: string;
+    voice_name?: string | null;
+};
+

package/src/models/MentorCustomVoiceResponse.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type MentorCustomVoiceResponse = {
+    readonly voice_provider: string;
+    readonly voice_name: string;
+};
+

package/src/models/MentorData.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { MentorSession } from './MentorSession';
+export type MentorData = {
+    mentor_unique_id: string;
+    mentor_name: string;
+    total_cost: number;
+    mentor_sessions: Array<MentorSession>;
+};
+

package/src/models/MentorDetailAnalytics.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type MentorDetailAnalytics = {
+    total_mentors: number;
+    active_mentors: number;
+    total_questions_answered: number;
+    total_ratings: number;
+};
+

package/src/models/MentorEval.ts

@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { MentorEvalQuestion } from './MentorEvalQuestion';
+export type MentorEval = {
+    readonly id: number;
+    readonly mentor: string;
+    readonly questions: Array<MentorEvalQuestion>;
+    eval_id?: string;
+    name?: string | null;
+    passing_score?: number;
+    evaluation_prompt?: string;
+    question_set?: number | null;
+};
+

package/src/models/MentorEvalQuestion.ts

@@ -0,0 +1,10 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type MentorEvalQuestion = {
+    readonly id: number;
+    content: string;
+    sample_answer?: string | null;
+};
+

package/src/models/MentorEvalQuestionRequest.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type MentorEvalQuestionRequest = {
+    content: string;
+    sample_answer?: string | null;
+};
+

package/src/models/MentorEvalReport.ts

@@ -0,0 +1,15 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ConversationRating } from './ConversationRating';
+export type MentorEvalReport = {
+    readonly id: number;
+    readonly mentor_eval: string;
+    readonly mentor: string;
+    readonly conversation_ratings: Array<ConversationRating>;
+    readonly overall_score: number;
+    readonly is_passed: boolean;
+    readonly generated_at: string;
+};
+

package/src/models/MentorEvalRequest.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { MentorEvalQuestionRequest } from './MentorEvalQuestionRequest';
+export type MentorEvalRequest = {
+    id?: number | null;
+    name?: string | null;
+    passing_score?: number | null;
+    questions?: Array<MentorEvalQuestionRequest> | null;
+    evaluation_prompt?: string | null;
+};
+

package/src/models/MentorFork.ts

@@ -0,0 +1,10 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type MentorFork = {
+    new_mentor_name: string;
+    destination_platform_key: string;
+    clone_documents?: boolean;
+};
+

package/src/models/MentorFromTemplateRequest.ts

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

package/src/models/MentorFromTemplateWithSettingRequest.ts

@@ -0,0 +1,47 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { GreetingMethodEnum } from './GreetingMethodEnum';
+export type MentorFromTemplateWithSettingRequest = {
+    template_name: string;
+    display_name?: string;
+    description?: string;
+    profile_image?: string;
+    initial_message?: string;
+    suggested_message?: string;
+    new_mentor_name: string;
+    theme?: string;
+    user_message_color?: string;
+    mentor_bubble_color?: string;
+    align_mentor_bubble?: string;
+    system_prompt?: string;
+    llm_provider?: string;
+    llm_name?: string;
+    mentor_visibility?: string;
+    enable_image_generation?: boolean;
+    enable_web_browsing?: boolean;
+    enable_code_interpreter?: boolean;
+    metadata?: any;
+    custom_css?: string;
+    uploaded_profile_image?: string;
+    proactive_response?: string;
+    greeting_method?: GreetingMethodEnum;
+    categories?: Array<number>;
+    tool_slugs?: Array<string>;
+    llm_temperature?: number;
+    seo_tags?: any;
+    marketing_conversations?: any;
+    proactive_prompt?: string;
+    moderation_system_prompt?: string;
+    moderation_response?: string;
+    enable_moderation?: boolean;
+    enable_openai_assistant?: boolean;
+    enable_total_grounding?: boolean;
+    google_voice?: number;
+    openai_voice?: number;
+    enable_suggested_prompts?: boolean | null;
+    enable_guided_prompts?: boolean | null;
+    guided_prompt_instructions?: string | null;
+};
+

package/src/models/MentorMemorySettingsRequest.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type MentorMemorySettingsRequest = {
+    item_type?: string | null;
+    item_identifier?: string | null;
+    learner_advance_correct_rate?: number | null;
+    learner_advance_question_count?: number | null;
+};
+

package/src/models/MentorMemorySettingsResponse.ts

@@ -0,0 +1,11 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type MentorMemorySettingsResponse = {
+    readonly item_type: string | null;
+    readonly item_identifier: string | null;
+    learner_advance_correct_rate?: number | null;
+    learner_advance_question_count?: number | null;
+};
+

package/src/models/MentorMetadata.ts

@@ -0,0 +1,10 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type MentorMetadata = {
+    metadata: any;
+    mentor?: string;
+    mentor_id?: number;
+};
+