@iblai/iblai-api 4.185.2-ai → 4.185.2-core

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

@@ -1,15 +0,0 @@
-import type { Answer } from './Answer';
-/**
- * Serializer for individual question data, including possible answers.
- *
- * Attributes:
- * question_id (str): Unique identifier for the question.
- * text (str): The text of the question.
- * difficulty_level (Optional[int]): An optional difficulty level for the question.
- * options (list[AnswerSerializer]): List of possible answers for the question.
- */
-export type LLMQuestion = {
-    text: string;
-    difficulty_level?: number;
-    options: Array<Answer>;
-};

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

@@ -1,18 +0,0 @@
-export type LLMResponse = {
-    readonly id: number;
-    name: string;
-    description?: string | null;
-    metadata?: any;
-    resource_ids?: any;
-    tags?: any;
-    overview?: string | null;
-    use_cases?: string | null;
-    documentation?: string | null;
-    sdk_samples?: string | null;
-    chat_models?: any;
-    /**
-     * List of disabled models. If empty, all models are enabled.
-     */
-    disabled_models?: any;
-    logo?: string | null;
-};

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

@@ -1,5 +0,0 @@
-export type LLMTracesListResponse = {
-    id: string;
-    name: string;
-    date: string;
-};

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

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

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

@@ -1,3 +0,0 @@
-export type LinkCourseRequest = {
-    course_id: string;
-};

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

@@ -1,5 +0,0 @@
-export type LinkCourseResponse = {
-    mentor_unique_id: string;
-    course_id?: string | null;
-    is_linked: boolean;
-};

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

@@ -1,10 +0,0 @@
-/**
- * * `openai` - Openai
- * * `google` - Google
- * * `azure_openai` - Azure Openai
- */
-export declare enum LlmProviderEnum {
-    OPENAI = "openai",
-    GOOGLE = "google",
-    AZURE_OPENAI = "azure_openai"
-}

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

@@ -1,65 +0,0 @@
-import type { AuthScopeEnum } from './AuthScopeEnum';
-import type { AuthTypeEnum } from './AuthTypeEnum';
-import type { OAuthService } from './OAuthService';
-import type { TransportEnum } from './TransportEnum';
-/**
- * Serializer for the MCPServer model.
- */
-export type MCPServer = {
-    readonly id: number;
-    readonly platform: number;
-    mentor?: string | null;
-    /**
-     * edX username
-     */
-    owner?: string | null;
-    name: string;
-    /**
-     * A description of the MCP server.
-     */
-    description?: string;
-    /**
-     * The url of the MCP server.
-     */
-    url: string;
-    image?: string | null;
-    transport?: TransportEnum;
-    /**
-     * Authorization credentials to authenticate to the MCP server. If provided, these take priority over any headers configured on the server. Token here must be the full authorization value. For example: `<scheme> <credentials>`
-     */
-    credentials?: string;
-    /**
-     * Headers to send to the MCP server. Useful for authentication,
-     */
-    extra_headers?: any;
-    readonly platform_key: string;
-    /**
-     * Featured mcp servers will be accessible to all other tenants.
-     */
-    is_featured?: boolean;
-    /**
-     * The type of authentication to use for the MCP server.
-     *
-     * * `none` - None
-     * * `token` - Token
-     * * `oauth2` - Oauth2
-     */
-    auth_type?: AuthTypeEnum;
-    /**
-     * Determines the required authentication granularity. 'platform' uses shared platform credentials, 'mentor' requires mentor-level credentials, and 'user' requires each user to authenticate individually.
-     *
-     * * `platform` - Platform
-     * * `mentor` - Mentor
-     * * `user` - User
-     */
-    auth_scope?: AuthScopeEnum;
-    oauth_service?: number | null;
-    readonly oauth_service_data: OAuthService;
-    readonly mcp_server_connections: string;
-    /**
-     * Whether the MCP server is enabled or not.
-     */
-    is_enabled?: boolean;
-    readonly created_at: string;
-    readonly updated_at: string;
-};

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

@@ -1,47 +0,0 @@
-import type { AuthTypeEnum } from './AuthTypeEnum';
-import type { MCPServerConnectionScopeEnum } from './MCPServerConnectionScopeEnum';
-/**
- * Serializer for managing `MCPServerConnection` records via the API.
- *
- * The serializer enforces the business rules for combining scope, platform,
- * and authentication configuration while exposing a masked view of any stored
- * credentials.
- */
-export type MCPServerConnection = {
-    readonly id: number;
-    server: number;
-    readonly server_name: string;
-    /**
-     * Whether this connection is scoped to a user or shared across a platform.
-     *
-     * * `user` - User
-     * * `mentor` - Mentor
-     * * `platform` - Platform
-     */
-    scope?: MCPServerConnectionScopeEnum;
-    auth_type?: AuthTypeEnum;
-    platform?: number | null;
-    readonly platform_key: string | null;
-    /**
-     * edX username
-     */
-    user?: string | null;
-    mentor?: string | null;
-    connected_service?: number | null;
-    readonly connected_service_summary: Record<string, any> | null;
-    /**
-     * Static credential/token value for token-based authentication.
-     */
-    credentials?: string;
-    /**
-     * Authorization scheme to prefix tokens with (e.g. 'Bearer').
-     */
-    authorization_scheme?: string;
-    /**
-     * Additional headers to include when connecting to the MCP server.
-     */
-    extra_headers?: any;
-    is_active?: boolean;
-    readonly created_at: string;
-    readonly updated_at: string;
-};

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

@@ -1,10 +0,0 @@
-/**
- * * `user` - User
- * * `mentor` - Mentor
- * * `platform` - Platform
- */
-export declare enum MCPServerConnectionScopeEnum {
-    USER = "user",
-    MENTOR = "mentor",
-    PLATFORM = "platform"
-}

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

@@ -1,5 +0,0 @@
-export type MCPServerOauthFind = {
-    url: string;
-    callback_url?: string;
-    name?: string;
-};

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

@@ -1,10 +0,0 @@
-import type { ExternalServiceInfo } from './ExternalServiceInfo';
-export type MaskedIntegrationCredential = {
-    name: string;
-    value?: any;
-    /**
-     * The platform key
-     */
-    platform: string;
-    readonly service_info: ExternalServiceInfo;
-};

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

@@ -1,10 +0,0 @@
-import type { ExternalServiceInfo } from './ExternalServiceInfo';
-export type MaskedLLMCredential = {
-    name: string;
-    value?: any;
-    /**
-     * The platform key
-     */
-    platform: string;
-    readonly service_info: ExternalServiceInfo;
-};

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

@@ -1,5 +0,0 @@
-import type { KindEnum } from './KindEnum';
-export type MemoryComponentData = {
-    kind?: KindEnum;
-    content: string;
-};

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

@@ -1,4 +0,0 @@
-import type { MemoryComponentData } from './MemoryComponentData';
-export type MemoryComponentMemory = {
-    readonly data: Array<MemoryComponentData>;
-};

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

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

@@ -1,5 +0,0 @@
-export type MemoryComponentResponse = {
-    readonly knowledge_gaps: Array<string>;
-    readonly lessons_learned: Array<string>;
-    readonly help_requests: Array<string>;
-};

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

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

@@ -1,6 +0,0 @@
-export type MemoryStatusRequestView = {
-    /**
-     * Enable or disable memory use
-     */
-    enabled: boolean;
-};

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

@@ -1,6 +0,0 @@
-export type MemoryStatusView = {
-    readonly id: number;
-    username: string;
-    platform_key: string;
-    enabled?: boolean;
-};

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

@@ -1,167 +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 { StarterPromptsB04Enum } from './StarterPromptsB04Enum';
-import type { Subject } from './Subject';
-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_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;
-    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;
-    /**
-     * 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/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,157 +0,0 @@
-import type { GreetingMethodEnum } from './GreetingMethodEnum';
-import type { StarterPromptsB04Enum } from './StarterPromptsB04Enum';
-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_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;
-    /**
-     * 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;
-    /**
-     * 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;
-};