@iblai/iblai-api 4.261.1-ai → 4.262.0-core

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

@@ -1,205 +0,0 @@
-import type { CallConfiguration } from './CallConfiguration';
-import type { GreetingMethodEnum } from './GreetingMethodEnum';
-import type { MCPServer } from './MCPServer';
-import type { MentorCategory } from './MentorCategory';
-import type { MentorType } from './MentorType';
-import type { PrivacyAction011Enum } from './PrivacyAction011Enum';
-import type { StarterPromptsB04Enum } from './StarterPromptsB04Enum';
-import type { Subject } from './Subject';
-import type { VoiceProviderD5aEnum } from './VoiceProviderD5aEnum';
-export type Mentor = {
-    readonly id: number;
-    name: string;
-    unique_id?: string;
-    /**
-     * The langflow json for the mentor
-     */
-    flow?: any;
-    slug?: string;
-    platform?: string;
-    allow_anonymous?: boolean;
-    /**
-     * Allow this mentor to be used offline with local LLMs
-     */
-    enable_offline_mode?: boolean;
-    metadata?: any;
-    enable_moderation?: boolean;
-    enable_multi_query_rag?: boolean;
-    /**
-     * Enable prompt caching for Anthropic models to reduce latency and cost. This disabled RAG and other dynamic parts of system prompt such as memory, current datetime, etc. Use with caution
-     */
-    enable_prompt_caching?: boolean;
-    enable_post_processing_system?: 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;
-    save_flagged_prompts?: boolean;
-    /**
-     * Instructions to determine how prompt suggestions are generated.
-     */
-    guided_prompt_instructions?: string;
-    google_voice?: number | null;
-    openai_voice?: number | null;
-    /**
-     * TTS provider used when synthesizing chat messages from this mentor. Selects between openai_voice and google_voice.
-     *
-     * * `browser` - Browser
-     * * `openai` - OpenAI
-     * * `google` - Google
-     */
-    voice_provider?: VoiceProviderD5aEnum;
-    categories: Array<MentorCategory>;
-    types: Array<MentorType>;
-    /**
-     * Whether the mentor is featured or not.
-     */
-    is_featured?: boolean;
-    subjects: Array<Subject>;
-    /**
-     * 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;
-    /**
-     * Prompt to be used to guide the user through their studies when study mode tool is enabled.
-     */
-    study_mode_prompt?: string;
-    /**
-     * Disclaimer to be shown to the user when the mentor is used.
-     */
-    disclaimer?: string;
-    enable_disclaimer?: boolean;
-    /**
-     * Show attachments on mentor.
-     */
-    show_attachment?: boolean;
-    /**
-     * Show voice call button on mentor.
-     */
-    show_voice_call?: boolean;
-    /**
-     * Show voice recording button on mentor.
-     */
-    show_voice_record?: boolean;
-    /**
-     * Show RAG images in mentor response.
-     */
-    show_rag_images?: boolean;
-    /**
-     * Type of starter prompts to show: guided_prompt or suggested_prompt.
-     *
-     * * `guided_prompt` - Guided Prompt
-     * * `suggested_prompt` - Suggested Prompt
-     */
-    starter_prompts?: StarterPromptsB04Enum;
-    /**
-     * Allow embedded mentor to read content on the embedded web page.
-     */
-    embed_is_context_aware?: boolean;
-    /**
-     * Open mentor embed iframe by default.
-     */
-    embed_open_by_default?: boolean;
-    /**
-     * Show attachments on embedded mentor.
-     */
-    embed_show_attachment?: boolean;
-    /**
-     * Show voice call button on embedded mentor.
-     */
-    embed_show_voice_call?: boolean;
-    /**
-     * Show voice recording button on embedded mentor.
-     */
-    embed_show_voice_record?: boolean;
-    /**
-     * Show explore mentors option.
-     */
-    show_explore_mentors?: boolean;
-    /**
-     * Stores embedded icon selection data for the mentor widget.
-     */
-    embed_icon_selection_data?: any;
-    /**
-     * Placeholder to be shown in the input text area when the mentor is used.
-     */
-    placeholder_prompt?: string;
-    /**
-     * The prompt for the moderation system. This prompt must clearly distinguish between 'Approapriate' and 'Not Appropriate' queries.
-     */
-    moderation_system_prompt?: string;
-    /**
-     * Prompt to be used to alter or modify final llm response into any desired form.
-     */
-    post_processing_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;
-    /**
-     * Enable PII detection and filtering before messages reach the LLM
-     */
-    enable_privacy_router?: boolean;
-    /**
-     * Action to take when PII is detected: redact replaces with labels, mask partially hides, block rejects the message
-     *
-     * * `redact` - Redact
-     * * `mask` - Mask
-     * * `block` - Block
-     */
-    privacy_action?: PrivacyAction011Enum;
-    /**
-     * List of PII entity types to detect. Empty list uses defaults (PERSON, EMAIL, PHONE, SSN, etc.)
-     */
-    privacy_entities?: any;
-    /**
-     * Response shown to user when a message is blocked due to PII detection
-     */
-    privacy_response?: string;
-    /**
-     * Also filter PII from LLM responses (output rail)
-     */
-    enable_privacy_output_filter?: 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;
-    call_configuration?: CallConfiguration;
-    mcp_servers: Array<MCPServer>;
-    /**
-     * 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/MentorAudience.d.ts

@@ -1,5 +0,0 @@
-export type MentorAudience = {
-    readonly id: number;
-    name: string;
-    description?: string | null;
-};

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

@@ -1,43 +0,0 @@
-/**
- * Serializer for a single audit log entry.
- *
- * Transforms DMAuditLogEntry model instances into API response format.
- */
-export type MentorAuditLogEntry = {
-    /**
-     * Audit log entry ID
-     */
-    id: number;
-    /**
-     * When the action occurred
-     */
-    timestamp: string;
-    /**
-     * Username of the user who performed the action
-     */
-    actor_username: string | null;
-    /**
-     * Email of the user who performed the action
-     */
-    actor_email: string | null;
-    /**
-     * Action type: create, update, or delete
-     */
-    action: string;
-    /**
-     * Type of resource modified (e.g., mentor, mentorsettings)
-     */
-    resource_type: string;
-    /**
-     * ID of the modified resource
-     */
-    resource_id: string;
-    /**
-     * Human-readable representation of the resource
-     */
-    resource_repr: string;
-    /**
-     * Dictionary of field changes with old and new values
-     */
-    changes: Record<string, any>;
-};

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

@@ -1,9 +0,0 @@
-/**
- * Mentor cost breakdown.
- */
-export type MentorBreakdown = {
-    mentor: string;
-    cost: string;
-    sessions: number;
-    mentor_name?: string;
-};

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

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

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

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

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

@@ -1,195 +0,0 @@
-import type { GreetingMethodEnum } from './GreetingMethodEnum';
-import type { PrivacyAction011Enum } from './PrivacyAction011Enum';
-import type { StarterPromptsB04Enum } from './StarterPromptsB04Enum';
-import type { VoiceProviderD5aEnum } from './VoiceProviderD5aEnum';
-export type MentorCreate = {
-    name: string;
-    unique_id?: string;
-    /**
-     * The langflow json for the mentor
-     */
-    flow?: any;
-    slug?: string;
-    platform?: string;
-    allow_anonymous?: boolean;
-    /**
-     * Allow this mentor to be used offline with local LLMs
-     */
-    enable_offline_mode?: boolean;
-    metadata?: any;
-    enable_moderation?: boolean;
-    enable_multi_query_rag?: boolean;
-    /**
-     * Enable prompt caching for Anthropic models to reduce latency and cost. This disabled RAG and other dynamic parts of system prompt such as memory, current datetime, etc. Use with caution
-     */
-    enable_prompt_caching?: boolean;
-    enable_post_processing_system?: 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;
-    save_flagged_prompts?: boolean;
-    google_voice?: number | null;
-    openai_voice?: number | null;
-    /**
-     * TTS provider used when synthesizing chat messages from this mentor. Selects between openai_voice and google_voice.
-     *
-     * * `browser` - Browser
-     * * `openai` - OpenAI
-     * * `google` - Google
-     */
-    voice_provider?: VoiceProviderD5aEnum;
-    /**
-     * Instructions to determine how prompt suggestions are generated.
-     */
-    guided_prompt_instructions?: string;
-    categories?: Array<number>;
-    types?: Array<number>;
-    subjects?: 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;
-    /**
-     * Prompt to be used to guide the user through their studies when study mode tool is enabled.
-     */
-    study_mode_prompt?: string;
-    /**
-     * Disclaimer to be shown to the user when the mentor is used.
-     */
-    disclaimer?: string;
-    enable_disclaimer?: boolean;
-    /**
-     * Show attachments on mentor.
-     */
-    show_attachment?: boolean;
-    /**
-     * Show voice call button on mentor.
-     */
-    show_voice_call?: boolean;
-    /**
-     * Show voice recording button on mentor.
-     */
-    show_voice_record?: boolean;
-    /**
-     * Show RAG images in mentor response.
-     */
-    show_rag_images?: boolean;
-    /**
-     * Type of starter prompts to show: guided_prompt or suggested_prompt.
-     *
-     * * `guided_prompt` - Guided Prompt
-     * * `suggested_prompt` - Suggested Prompt
-     */
-    starter_prompts?: StarterPromptsB04Enum;
-    /**
-     * Allow embedded mentor to read content on the embedded web page.
-     */
-    embed_is_context_aware?: boolean;
-    /**
-     * Open mentor embed iframe by default.
-     */
-    embed_open_by_default?: boolean;
-    /**
-     * Show attachments on embedded mentor.
-     */
-    embed_show_attachment?: boolean;
-    /**
-     * Show voice call button on embedded mentor.
-     */
-    embed_show_voice_call?: boolean;
-    /**
-     * Show voice recording button on embedded mentor.
-     */
-    embed_show_voice_record?: boolean;
-    /**
-     * Show explore mentors option.
-     */
-    show_explore_mentors?: boolean;
-    /**
-     * Stores embedded icon selection data for the mentor widget.
-     */
-    embed_icon_selection_data?: any;
-    /**
-     * Placeholder to be shown in the input text area when the mentor is used.
-     */
-    placeholder_prompt?: string;
-    /**
-     * The prompt for the moderation system. This prompt must clearly distinguish between 'Approapriate' and 'Not Appropriate' queries.
-     */
-    moderation_system_prompt?: string;
-    /**
-     * Prompt to be used to alter or modify final llm response into any desired form.
-     */
-    post_processing_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;
-    /**
-     * Enable PII detection and filtering before messages reach the LLM
-     */
-    enable_privacy_router?: boolean;
-    /**
-     * Action to take when PII is detected: redact replaces with labels, mask partially hides, block rejects the message
-     *
-     * * `redact` - Redact
-     * * `mask` - Mask
-     * * `block` - Block
-     */
-    privacy_action?: PrivacyAction011Enum;
-    /**
-     * List of PII entity types to detect. Empty list uses defaults (PERSON, EMAIL, PHONE, SSN, etc.)
-     */
-    privacy_entities?: any;
-    /**
-     * Response shown to user when a message is blocked due to PII detection
-     */
-    privacy_response?: string;
-    /**
-     * Also filter PII from LLM responses (output rail)
-     */
-    enable_privacy_output_filter?: 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/dist/types/models/MentorCustomVoice.d.ts

@@ -1,4 +0,0 @@
-export type MentorCustomVoice = {
-    voice_provider: string;
-    voice_name?: string | null;
-};

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

@@ -1,4 +0,0 @@
-export type MentorCustomVoiceResponse = {
-    readonly voice_provider: string;
-    readonly voice_name: string;
-};

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

@@ -1,7 +0,0 @@
-import type { MentorSession } from './MentorSession';
-export type MentorData = {
-    mentor_unique_id: string;
-    mentor_name: string;
-    total_cost: number;
-    mentor_sessions: Array<MentorSession>;
-};

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

@@ -1,6 +0,0 @@
-export type MentorDetailAnalytics = {
-    total_mentors: number;
-    active_mentors: number;
-    total_questions_answered: number;
-    total_ratings: number;
-};

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

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

@@ -1,5 +0,0 @@
-export type MentorEvalQuestion = {
-    readonly id: number;
-    content: string;
-    sample_answer?: string | null;
-};

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

@@ -1,4 +0,0 @@
-export type MentorEvalQuestionRequest = {
-    content: string;
-    sample_answer?: string | null;
-};

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

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

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

@@ -1,17 +0,0 @@
-/**
- * Serializer for mentor facets
- */
-export type MentorFacet = {
-    /**
-     * Total number of mentors in this facet
-     */
-    total: number;
-    /**
-     * Terms and their counts in this facet
-     */
-    terms: Record<string, any>;
-    /**
-     * Count of mentors not in any term
-     */
-    other: number;
-};

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

@@ -1,5 +0,0 @@
-export type MentorFork = {
-    new_mentor_name: string;
-    destination_platform_key: string;
-    clone_documents?: boolean;
-};

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

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