@iblai/iblai-api 4.331.0-core → 4.332.0-ai

package/src/models/PatchedCredentialRequest.ts

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

@@ -0,0 +1,29 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { CronDelivery } from './CronDelivery';
+import type { CronPayload } from './CronPayload';
+import type { CronSchedule } from './CronSchedule';
+import type { WakeModeEnum } from './WakeModeEnum';
+/**
+ * Body for ``PATCH cron-jobs/<job_id>/`` — sent verbatim to
+ * ``cron.update`` as the ``patch`` parameter.  Every field is optional.
+ *
+ * Field names are camelCase here to match the wire schema (``CronJobPatch``)
+ * since the patch dict is forwarded directly without translation.
+ */
+export type PatchedCronJobPatch = {
+    name?: string;
+    description?: string;
+    enabled?: boolean;
+    deleteAfterRun?: boolean;
+    agentId?: string;
+    sessionKey?: string;
+    sessionTarget?: string;
+    wakeMode?: WakeModeEnum;
+    schedule?: CronSchedule;
+    payload?: CronPayload;
+    delivery?: CronDelivery;
+};
+

package/src/models/PatchedDisclaimer.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { DisclaimerScopeEnum } from './DisclaimerScopeEnum';
+export type PatchedDisclaimer = {
+    readonly id?: number;
+    scope?: DisclaimerScopeEnum;
+    /**
+     * Platform to which the disclaimer applies.
+     */
+    readonly platform?: number;
+    content?: string;
+    title?: string;
+    active?: boolean;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+    readonly has_agreed?: boolean;
+    readonly platform_key?: string;
+    mentors?: Array<string>;
+};
+

package/src/models/PatchedDiscordConfig.ts

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

package/src/models/PatchedDiscordUserConfig.ts

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

@@ -0,0 +1,38 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ScopeC1dEnum } from './ScopeC1dEnum';
+/**
+ * Serializer for updating FallbackLLM configuration.
+ */
+export type PatchedFallbackLLMUpdate = {
+    /**
+     * Whether this fallback applies to a specific model or entire provider
+     *
+     * * `model` - Model Specific
+     * * `provider` - Provider Wide
+     */
+    scope?: ScopeC1dEnum;
+    /**
+     * The provider whose models this fallback applies to
+     */
+    source_provider?: number;
+    /**
+     * Specific model this fallback applies to (only for model scope)
+     */
+    source_model?: number | null;
+    /**
+     * The provider to use as fallback
+     */
+    fallback_provider?: number;
+    /**
+     * The model to use as fallback
+     */
+    fallback_model?: number;
+    /**
+     * Whether this fallback configuration is active
+     */
+    is_enabled?: boolean;
+};
+

package/src/models/PatchedGoogleAgentDetail.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PatchedGoogleAgentDetail = {
+    readonly id?: number;
+    readonly sub_agents?: string;
+    readonly platform?: string;
+    unique_id?: string;
+    model?: string;
+    name?: string;
+    description?: string;
+    instruction?: string;
+    output_key?: string | null;
+    readonly inserted_at?: string;
+    readonly updated_at?: string;
+    /**
+     * edX user ID
+     */
+    created_by?: number | null;
+};
+

package/src/models/PatchedGradeResultOverride.ts

@@ -0,0 +1,20 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Human override request.
+ *
+ * Scores are stored normalized but rubrics are authored in raw points, so
+ * the wire format is points and normalization happens here. A grade with no
+ * usable rubric snapshot has no denominator, so it cannot be overridden at
+ * all rather than silently falling back to a different scale.
+ */
+export type PatchedGradeResultOverride = {
+    /**
+     * Points awarded, between 0 and the rubric's total_points. Null clears the override and restores the AI score.
+     */
+    override_points?: number | null;
+    override_feedback?: string;
+};
+

package/src/models/PatchedGraderCriterion.ts

@@ -0,0 +1,20 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PatchedGraderCriterion = {
+    readonly id?: number;
+    /**
+     * Name for the criteria (accuracy, clarity, etc.)
+     */
+    name?: string;
+    /**
+     * The requirements to evaluate this criterion against.
+     */
+    criteria?: string;
+    /**
+     * Raw point value for this criterion (e.g. 6 for a 6-point criterion). Normalized against the sum of all criteria points at grading time.
+     */
+    points?: number;
+};
+

package/src/models/PatchedHumanSupportTicket.ts

@@ -0,0 +1,28 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { HumanSupportTicketStatusEnum } from './HumanSupportTicketStatusEnum';
+/**
+ * serializer interface intended for students/ non-admin users.
+ * This limits students to only update the subject and description of a ticket.
+ */
+export type PatchedHumanSupportTicket = {
+    readonly id?: number;
+    readonly username?: string;
+    readonly email?: string;
+    readonly full_name?: string;
+    /**
+     * edX user ID
+     */
+    readonly user?: number;
+    readonly session?: string;
+    subject?: string;
+    description?: string;
+    status?: HumanSupportTicketStatusEnum;
+    readonly mentor_id?: string;
+    readonly created_at?: string;
+    readonly updated_at?: string;
+    readonly resolved_at?: string | null;
+};
+

package/src/models/PatchedLLMCredentialRequest.ts

@@ -0,0 +1,19 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type PatchedLLMCredentialRequest = {
+    /**
+     * Name of the credential provider
+     */
+    name?: string;
+    /**
+     * Value of the credential provider
+     */
+    value?: any;
+    /**
+     * Key of the tenant
+     */
+    platform?: string;
+};
+

package/src/models/PatchedMCPServer.ts

@@ -0,0 +1,70 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { AuthScopeEnum } from './AuthScopeEnum';
+import type { AuthTypeEnum } from './AuthTypeEnum';
+import type { MCPServerTransportEnum } from './MCPServerTransportEnum';
+import type { OAuthService } from './OAuthService';
+/**
+ * Serializer for the MCPServer model.
+ */
+export type PatchedMCPServer = {
+    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?: MCPServerTransportEnum;
+    /**
+     * 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/src/models/PatchedMCPServerConnection.ts

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

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { McpServerConfig } from './McpServerConfig';
+/**
+ * Body for ``PATCH mcp-servers/<name>/``.
+ */
+export type PatchedMcpServerUpdate = {
+    config?: McpServerConfig;
+    replace?: boolean;
+};
+

package/src/models/PatchedMentorCategoryGroupCreate.ts

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

@@ -0,0 +1,248 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { GreetingMethodEnum } from './GreetingMethodEnum';
+import type { PhiActionEnum } from './PhiActionEnum';
+import type { PrivacyActionEnum } from './PrivacyActionEnum';
+import type { StarterPromptsB04Enum } from './StarterPromptsB04Enum';
+import type { VoiceProviderEefEnum } from './VoiceProviderEefEnum';
+export type PatchedMentorCreate = {
+    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. `iblai` reaches OpenAI's TTS models through our own gateway and uses openai_voice, unless it is configured with a non-OpenAI model.
+     *
+     * * `browser` - Browser
+     * * `openai` - OpenAI
+     * * `google` - Google
+     * * `iblai` - ibl.ai
+     */
+    voice_provider?: VoiceProviderEefEnum;
+    /**
+     * 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;
+    /**
+     * Show catalogue on mentor.
+     */
+    show_catalogue?: boolean;
+    /**
+     * Show reasoning on mentor.
+     */
+    show_reasoning?: 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 display canvas on embedded mentor.
+     */
+    embed_show_canvas?: 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;
+    /**
+     * Per-mentor toggle for stripping HTML markup from `payload.page_content` before it is envelope-wrapped and cached for the LLM. Defaults to False (raw HTML reaches the prompt). Set to True to strip markup, e.g. when pages embed inline JSON/CSS in script/style tags that bloats the context window. Nullable so the add-column migration is a no-op for existing rows during a rolling multi-server deploy; a NULL value is treated as False at read time.
+     */
+    strip_page_content_html?: boolean | null;
+    enable_safety_system?: boolean;
+    /**
+     * Master switch: enable input filtering before messages reach the LLM. Which categories run is controlled by filter_pii / filter_phi.
+     */
+    enable_privacy_router?: boolean;
+    /**
+     * When the privacy router is enabled, apply PII detection/filtering (uses privacy_action / privacy_entities).
+     */
+    filter_pii?: boolean;
+    /**
+     * Action to take when PII is detected: redact replaces with labels, mask partially hides, block rejects the message, allow passes the message through unchanged while still logging the detection
+     *
+     * * `redact` - Redact
+     * * `mask` - Mask
+     * * `block` - Block
+     * * `allow` - Allow
+     */
+    privacy_action?: PrivacyActionEnum;
+    /**
+     * 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;
+    /**
+     * Master switch: also filter LLM responses (output rail). Which categories run is controlled by filter_pii / filter_phi.
+     */
+    enable_privacy_output_filter?: boolean;
+    /**
+     * When the privacy router is enabled, apply PHI detection/filtering (uses phi_action / phi_entities).
+     */
+    filter_phi?: boolean;
+    /**
+     * Action to take when PHI is detected: redact replaces with labels, mask partially hides, block rejects the message, allow passes the message through unchanged while still logging the detection
+     *
+     * * `redact` - Redact
+     * * `mask` - Mask
+     * * `block` - Block
+     * * `allow` - Allow
+     */
+    phi_action?: PhiActionEnum;
+    /**
+     * List of PHI entity types to detect. Empty list detects all supported clinical and identifier entities.
+     */
+    phi_entities?: any;
+    /**
+     * Response shown to user when a message is blocked due to PHI detection
+     */
+    phi_response?: string;
+    /**
+     * 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;
+    /**
+     * Per-mentor toggle for the sandboxed quickjs code-interpreter middleware on the graph agent. Off by default: the middleware runs an in-process JS REPL that adds latency and system-resource overhead, so it is only enabled for mentors that specifically need computational tool use. Even when True, the middleware is only attached if the mentor's chosen LLM supports function calling; it is never attached for the fake graph mentors used in tests/healthchecks. Nullable so the add-column migration is a no-op for existing rows during a rolling multi-server deploy; a NULL value is treated as False at read time.
+     */
+    enable_computational_runtime?: boolean | null;
+};
+

package/src/models/PatchedMentorFromTemplate.ts

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