@iblai/iblai-api 4.5.2-ai-plus → 4.5.3-ai

package/src/services/AiAccountService.ts

@@ -5,8 +5,10 @@
 import type { ConnectedService } from '../models/ConnectedService';
 import type { CredentialRequest } from '../models/CredentialRequest';
 import type { IntegrationCredential } from '../models/IntegrationCredential';
+import type { IntegrationCredentialSchema } from '../models/IntegrationCredentialSchema';
 import type { LLMCredentialRequest } from '../models/LLMCredentialRequest';
 import type { LLMCredentialResponse } from '../models/LLMCredentialResponse';
+import type { LLMCredentialSchema } from '../models/LLMCredentialSchema';
 import type { OAuthStartResponse } from '../models/OAuthStartResponse';
 import type { PatchedCredentialRequest } from '../models/PatchedCredentialRequest';
 import type { PatchedLLMCredentialRequest } from '../models/PatchedLLMCredentialRequest';
@@ -163,7 +165,7 @@ export class AiAccountService {
      * Delete an existing LLM credential for an organization.
      *
      * Args:
-     * request: The HTTP request containing updated credential information
+     * request: The HTTP request containing credential information (must include 'name')
      * org: Organization key identifier
      *
      * Returns:
@@ -188,6 +190,46 @@ export class AiAccountService {
             },
         });
     }
+    /**
+     * Retrieve LLM credentials schemas.
+     *
+     * Query Parameters:
+     * name (optional): Filter results by LLM service name
+     *
+     * Args:
+     * request: The HTTP request
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: List of integration credentials schema available.
+     *
+     * Raises:
+     * NotFound: When  no credentials match the filters
+     * ValidationError: When query parameters are invalid
+     * @returns LLMCredentialSchema
+     * @throws ApiError
+     */
+    public static aiAccountOrgsCredentialSchemaRetrieve({
+        org,
+        name,
+    }: {
+        org: string,
+        /**
+         * Filter credentials by provider name (e.g., 'openai', 'google')
+         */
+        name?: string,
+    }): CancelablePromise<LLMCredentialSchema> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-account/orgs/{org}/credential/schema/',
+            path: {
+                'org': org,
+            },
+            query: {
+                'name': name,
+            },
+        });
+    }
     /**
      * Retrieve integration credentials for an organization.
      *
@@ -298,7 +340,7 @@ export class AiAccountService {
      * Delete an existing integration credential for an organization.
      *
      * Args:
-     * request: The HTTP request containing credential information (must include 'id')
+     * request: The HTTP request containing credential information (must include 'name')
      * org: Organization key identifier
      *
      * Returns:
@@ -323,6 +365,46 @@ export class AiAccountService {
             },
         });
     }
+    /**
+     * Retrieve integration credentials schema for.
+     *
+     * Query Parameters:
+     * name (optional): Filter results by integration service name
+     *
+     * Args:
+     * request: The HTTP request
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: List of integration credentials schema available.
+     *
+     * Raises:
+     * NotFound: When  no credentials match the filters
+     * ValidationError: When query parameters are invalid
+     * @returns IntegrationCredentialSchema
+     * @throws ApiError
+     */
+    public static aiAccountOrgsIntegrationCredentialSchemaRetrieve({
+        org,
+        name,
+    }: {
+        org: string,
+        /**
+         * Filter credentials by provider name (e.g., 'openai', 'google')
+         */
+        name?: string,
+    }): CancelablePromise<IntegrationCredentialSchema> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-account/orgs/{org}/integration-credential/schema/',
+            path: {
+                'org': org,
+            },
+            query: {
+                'name': name,
+            },
+        });
+    }
     /**
      * Enable or disable the use of main LLM credentials for an organization.
      *

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

@@ -1,15 +0,0 @@
-import type { Provider05cEnum } from './Provider05cEnum';
-export type Bot = {
-    readonly id: number;
-    readonly platform: number;
-    readonly tenant: string;
-    name: string;
-    provider: Provider05cEnum;
-    readonly is_configured: boolean;
-    slack_config: number;
-    readonly discord_config: number;
-    readonly webex_config: number;
-    readonly whatsapp_config: number;
-    readonly teams_config: number;
-    readonly webhook_url: string;
-};

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

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

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

@@ -1,12 +0,0 @@
-import type { Provider05cEnum } from './Provider05cEnum';
-export type BotCreate = {
-    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/DataSet.d.ts

@@ -1,21 +0,0 @@
-import type { DataSetStatusEnum } from './DataSetStatusEnum';
-export type DataSet = {
-    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/DataSetCreate.d.ts

@@ -1,12 +0,0 @@
-export type DataSetCreate = {
-    readonly id: string;
-    name: string;
-    source_url?: string;
-    source_file?: string;
-    num_data_points?: number;
-    train_split?: number;
-    /**
-     * (if any) Special instructions for generating the dataset. This could be requirements on tone, language, style, etc.
-     */
-    prompt?: string;
-};

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

@@ -1,12 +0,0 @@
-/**
- * * `pending` - Pending
- * * `processing` - Processing
- * * `completed` - Completed
- * * `failed` - Failed
- */
-export declare enum DataSetStatusEnum {
-    PENDING = "pending",
-    PROCESSING = "processing",
-    COMPLETED = "completed",
-    FAILED = "failed"
-}

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

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

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

@@ -1,10 +0,0 @@
-export type DiscordUserConfig = {
-    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/DiscordWebhook.d.ts

@@ -1,6 +0,0 @@
-export type DiscordWebhook = {
-    application_id: string;
-    type: string;
-    token: string;
-    id: string;
-};

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,31 +0,0 @@
-import type { Provider63aEnum } from './Provider63aEnum';
-export type PatchedTrainingCreate = {
-    readonly id?: string;
-    project_name?: string;
-    dataset?: string;
-    base_model_name?: string;
-    provider?: Provider63aEnum;
-    text_column?: string;
-    learning_rate?: number;
-    batch_size?: number;
-    num_epochs?: number;
-    block_size?: number;
-    warmup_ratio?: number;
-    lora_r?: number;
-    lora_alpha?: number;
-    lora_dropout?: number;
-    weight_decay?: number;
-    gradient_accumulation?: number;
-    use_peft?: boolean;
-    use_fp16?: boolean;
-    use_int4?: boolean;
-    push_to_hub?: boolean;
-    repo_id?: string;
-    preprocess_dataset?: boolean;
-    prompt_column?: string;
-    prompt_prefix?: string;
-    prompt_suffix?: string;
-    response_prefix?: string;
-    readonly date_created?: string;
-    readonly last_modified?: string;
-};

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

@@ -1,10 +0,0 @@
-export type PatchedWebexConfig = {
-    readonly id?: number;
-    readonly bot?: number;
-    /**
-     * Bot id from webex
-     */
-    webex_bot_id?: string;
-    bot_access_token?: string;
-    bot_username?: string;
-};

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

@@ -1,11 +0,0 @@
-export type PatchedWhatsappConfig = {
-    readonly id?: number;
-    readonly bot?: number;
-    phone_number_id?: string;
-    application_secret?: string;
-    webhook_verification_token?: string;
-    /**
-     * Access token to the bot. This can also be a temporary access token.
-     */
-    access_token?: string;
-};

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

@@ -1,10 +0,0 @@
-export type PatchedWhatsappUserConfig = {
-    readonly id?: number;
-    /**
-     * edX user ID
-     */
-    readonly user?: number;
-    phone_number?: string;
-    readonly date_created?: string;
-    readonly last_modified?: string;
-};

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

@@ -1,14 +0,0 @@
-/**
- * * `webex` - Webex
- * * `slack` - Slack
- * * `whatsapp` - Whatsapp
- * * `discord` - Discord
- * * `teams` - Teams
- */
-export declare enum Provider05cEnum {
-    WEBEX = "webex",
-    SLACK = "slack",
-    WHATSAPP = "whatsapp",
-    DISCORD = "discord",
-    TEAMS = "teams"
-}

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

@@ -1,6 +0,0 @@
-/**
- * * `openai` - Openai
- */
-export declare enum Provider63aEnum {
-    OPENAI = "openai"
-}

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

@@ -1,8 +0,0 @@
-export type SlackConfig = {
-    readonly id: number;
-    bot: number;
-    client_id: string;
-    client_secret: string;
-    app_token: string;
-    verification_token: string;
-};

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

@@ -1,17 +0,0 @@
-export type SlackUserConfig = {
-    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;
-};

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

@@ -1,6 +0,0 @@
-export type SlackWebhook = {
-    type: string;
-    event: Record<string, any>;
-    command: string;
-    response_url: string;
-};

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

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

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

@@ -1,17 +0,0 @@
-export type TeamsWebhook = {
-    id?: string | null;
-    type?: string | null;
-    channelData?: Record<string, any> | null;
-    entities?: Array<any> | null;
-    text?: string | null;
-    locale?: string | null;
-    textFormat?: string | null;
-    recipient?: Record<string, any> | null;
-    conversation?: Record<string, any> | null;
-    from_?: Record<string, any> | null;
-    channelId?: string | null;
-    serviceUrl?: string | null;
-    localTimezone?: string | null;
-    localTimestamp?: string | null;
-    timestamp?: string | null;
-};

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

@@ -1,41 +0,0 @@
-import type { DataSet } from './DataSet';
-import type { Provider63aEnum } from './Provider63aEnum';
-import type { TrainingStatusEnum } from './TrainingStatusEnum';
-export type Training = {
-    id?: string;
-    dataset: DataSet;
-    project_name: string;
-    metadata?: any;
-    status?: TrainingStatusEnum;
-    retry_attempts?: number;
-    fine_tuned_model?: string;
-    provider?: Provider63aEnum;
-    base_model_name: string;
-    text_column?: string;
-    learning_rate?: number;
-    batch_size?: number;
-    num_epochs?: number;
-    block_size?: number;
-    warmup_ratio?: number;
-    lora_r?: number;
-    lora_alpha?: number;
-    lora_dropout?: number;
-    weight_decay?: number;
-    gradient_accumulation?: number;
-    use_peft?: boolean;
-    use_fp16?: boolean;
-    use_int4?: boolean;
-    push_to_hub?: boolean;
-    repo_id?: string;
-    preprocess_dataset?: boolean;
-    prompt_column?: string;
-    response_column?: string;
-    prompt_prefix?: string;
-    prompt_suffix?: string;
-    response_prefix?: string;
-    response_suffix?: string;
-    error_log?: string;
-    readonly date_created: string;
-    readonly last_modified: string;
-    platform: number;
-};

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

@@ -1,31 +0,0 @@
-import type { Provider63aEnum } from './Provider63aEnum';
-export type TrainingCreate = {
-    readonly id: string;
-    project_name: string;
-    dataset: string;
-    base_model_name: string;
-    provider?: Provider63aEnum;
-    text_column?: string;
-    learning_rate?: number;
-    batch_size?: number;
-    num_epochs?: number;
-    block_size?: number;
-    warmup_ratio?: number;
-    lora_r?: number;
-    lora_alpha?: number;
-    lora_dropout?: number;
-    weight_decay?: number;
-    gradient_accumulation?: number;
-    use_peft?: boolean;
-    use_fp16?: boolean;
-    use_int4?: boolean;
-    push_to_hub?: boolean;
-    repo_id?: string;
-    preprocess_dataset?: boolean;
-    prompt_column?: string;
-    prompt_prefix?: string;
-    prompt_suffix?: string;
-    response_prefix?: string;
-    readonly date_created: string;
-    readonly last_modified: string;
-};

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

@@ -1,10 +0,0 @@
-export type WebexConfig = {
-    readonly id: number;
-    readonly bot: number;
-    /**
-     * Bot id from webex
-     */
-    webex_bot_id: string;
-    bot_access_token: string;
-    bot_username: string;
-};

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

@@ -1,4 +0,0 @@
-export type WebexWebhook = {
-    data: Record<string, any>;
-    resource: string;
-};

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

@@ -1,3 +0,0 @@
-export type WhatAppWebHook = {
-    entry: Array<Record<string, any>>;
-};

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

@@ -1,11 +0,0 @@
-export type WhatsappConfig = {
-    readonly id: number;
-    readonly bot: number;
-    phone_number_id: string;
-    application_secret: string;
-    webhook_verification_token: string;
-    /**
-     * Access token to the bot. This can also be a temporary access token.
-     */
-    access_token: string;
-};

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

@@ -1,10 +0,0 @@
-export type WhatsappUserConfig = {
-    readonly id: number;
-    /**
-     * edX user ID
-     */
-    readonly user: number;
-    phone_number: string;
-    readonly date_created: string;
-    readonly last_modified: string;
-};