@iblai/iblai-api 3.48.2-core → 3.48.3-ai

package/src/models/UserCountRecord.ts

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

package/src/models/UserEdxMemory.ts

@@ -0,0 +1,20 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type UserEdxMemory = {
+    readonly id: number;
+    readonly username: string;
+    /**
+     * edX user ID
+     */
+    student: number;
+    course_id: string;
+    /**
+     * The course data to be stored. This includes the current page and the blocks that have been visited.
+     */
+    data?: any;
+    readonly date_created: string;
+    readonly last_modified: string;
+};
+

package/src/models/UserMemoryContextRequest.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type UserMemoryContextRequest = {
+    /**
+     * Extra custom data to be added to the memory
+     */
+    extra_data?: string;
+    use_reported_skills?: boolean;
+    use_desired_skills?: boolean;
+    use_credentials?: boolean;
+    use_enrolled_courses?: boolean;
+    use_time_spent?: boolean;
+    use_completed_courses?: boolean;
+    use_completed_programs?: boolean;
+};
+

package/src/models/UserMemoryContextResponse.ts

@@ -0,0 +1,17 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type UserMemoryContextResponse = {
+    username: string;
+    platform_key: string;
+    extra_data?: string | null;
+    use_reported_skills?: boolean;
+    use_desired_skills?: boolean;
+    use_credentials?: boolean;
+    use_enrolled_courses?: boolean;
+    use_time_spent?: boolean;
+    use_completed_courses?: boolean;
+    use_completed_programs?: boolean;
+};
+

package/src/models/UserMetric.ts

@@ -0,0 +1,9 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type UserMetric = {
+    total: number;
+    change_percentage: number;
+};
+

package/src/models/UserMetricsResponse.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { UserMetric } from './UserMetric';
+export type UserMetricsResponse = {
+    registered_users: UserMetric;
+    new_users: UserMetric;
+    unique_users: UserMetric;
+    veteran_users: UserMetric;
+};
+

package/src/models/UserSentimentCountView.ts

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

package/src/models/UserTrendByPeriod.ts

@@ -0,0 +1,10 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type UserTrendByPeriod = {
+    periods: Array<string>;
+    new_users: Array<number>;
+    veteran_users: Array<number>;
+};
+

package/src/models/VectorResult.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type VectorResult = {
+    type?: string;
+    title?: string;
+    snippet: string;
+    source?: string;
+    score?: number;
+    confidence_level?: number;
+};
+

package/src/models/VideoCaption.ts

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

package/src/models/Voice.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { ProviderEnum } from './ProviderEnum';
+export type Voice = {
+    readonly id: number;
+    name: string;
+    provider: ProviderEnum;
+    language?: string;
+    description?: string;
+    readonly audio_url: string;
+};
+

package/src/models/WebResource.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { WebResourceCard } from './WebResourceCard';
+export type WebResource = {
+    content: string;
+    title: string;
+    imageUrl?: string | null;
+    source?: string;
+    metadata?: any;
+    card?: WebResourceCard;
+};
+

package/src/models/WebResourceCard.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+export type WebResourceCard = {
+    title: string;
+    description: string;
+    imageUrl: string;
+    domain: string;
+    site_name: string;
+};
+

package/src/models/WebResourcesQuery.ts

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

package/src/services/AiAccountService.ts

@@ -0,0 +1,479 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { APITokenCost } from '../models/APITokenCost';
+import type { CredentialRequest } from '../models/CredentialRequest';
+import type { IBLAIPlatformMeta } from '../models/IBLAIPlatformMeta';
+import type { IBLAIPlatformMetaRequest } from '../models/IBLAIPlatformMetaRequest';
+import type { IBLAIPlatformMetaUpdateRequest } from '../models/IBLAIPlatformMetaUpdateRequest';
+import type { IntegrationCredential } from '../models/IntegrationCredential';
+import type { LLMCredentialRequest } from '../models/LLMCredentialRequest';
+import type { LLMCredentialResponse } from '../models/LLMCredentialResponse';
+import type { PatchedCredentialRequest } from '../models/PatchedCredentialRequest';
+import type { PatchedLLMCredentialRequest } from '../models/PatchedLLMCredentialRequest';
+import type { UseMainCreds } from '../models/UseMainCreds';
+import type { CancelablePromise } from '../core/CancelablePromise';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class AiAccountService {
+    /**
+     * Retrieve LLM credentials for an organization.
+     *
+     * Query Parameters:
+     * name (optional): Filter results by LLM provider name
+     *
+     * Args:
+     * request: The HTTP request
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: List of LLM credentials for the organization
+     *
+     * Raises:
+     * NotFound: When organization is not found or when no credentials match the filters
+     * ValidationError: When query parameters are invalid
+     * @param org
+     * @param name Filter credentials by provider name (e.g., 'openai', 'google')
+     * @returns LLMCredentialResponse
+     * @throws ApiError
+     */
+    public static aiAccountOrgsCredentialRetrieve(
+        org: string,
+        name?: string,
+    ): CancelablePromise<LLMCredentialResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-account/orgs/{org}/credential/',
+            path: {
+                'org': org,
+            },
+            query: {
+                'name': name,
+            },
+        });
+    }
+    /**
+     * Create a new LLM credential for an organization.
+     *
+     * Args:
+     * request: The HTTP request containing credential information
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: Created LLM credential
+     *
+     * Raises:
+     * NotFound: When organization is not found
+     * ValidationError: When request data is invalid
+     * @param org
+     * @param requestBody
+     * @returns LLMCredentialResponse
+     * @throws ApiError
+     */
+    public static aiAccountOrgsCredentialCreate(
+        org: string,
+        requestBody: LLMCredentialRequest,
+    ): CancelablePromise<LLMCredentialResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/ai-account/orgs/{org}/credential/',
+            path: {
+                'org': org,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Update an existing LLM credential for an organization.
+     *
+     * Args:
+     * request: The HTTP request containing updated credential information
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: Updated LLM credential
+     *
+     * Raises:
+     * NotFound: When organization or credential is not found
+     * ValidationError: When request data is invalid
+     * @param org
+     * @param requestBody
+     * @returns LLMCredentialResponse
+     * @throws ApiError
+     */
+    public static aiAccountOrgsCredentialPartialUpdate(
+        org: string,
+        requestBody?: PatchedLLMCredentialRequest,
+    ): CancelablePromise<LLMCredentialResponse> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/api/ai-account/orgs/{org}/credential/',
+            path: {
+                'org': org,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Retrieve integration credentials for an organization.
+     *
+     * 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 for the organization
+     *
+     * Raises:
+     * NotFound: When organization is not found or when no credentials match the filters
+     * ValidationError: When query parameters are invalid
+     * @param org
+     * @param name Filter credentials by provider name (e.g., 'openai', 'google')
+     * @returns IntegrationCredential
+     * @throws ApiError
+     */
+    public static aiAccountOrgsIntegrationCredentialRetrieve(
+        org: string,
+        name?: string,
+    ): CancelablePromise<IntegrationCredential> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-account/orgs/{org}/integration-credential/',
+            path: {
+                'org': org,
+            },
+            query: {
+                'name': name,
+            },
+        });
+    }
+    /**
+     * Create a new integration credential for an organization.
+     *
+     * Args:
+     * request: The HTTP request containing credential information
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: Created integration credential
+     *
+     * Raises:
+     * NotFound: When organization is not found
+     * ValidationError: When request data is invalid
+     * @param org
+     * @param requestBody
+     * @returns IntegrationCredential
+     * @throws ApiError
+     */
+    public static aiAccountOrgsIntegrationCredentialCreate(
+        org: string,
+        requestBody: CredentialRequest,
+    ): CancelablePromise<IntegrationCredential> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/ai-account/orgs/{org}/integration-credential/',
+            path: {
+                'org': org,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Update an existing integration credential for an organization.
+     *
+     * Args:
+     * request: The HTTP request containing updated credential information
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: Updated integration credential
+     *
+     * Raises:
+     * NotFound: When organization or credential is not found
+     * ValidationError: When request data is invalid
+     * @param org
+     * @param requestBody
+     * @returns IntegrationCredential
+     * @throws ApiError
+     */
+    public static aiAccountOrgsIntegrationCredentialPartialUpdate(
+        org: string,
+        requestBody?: PatchedCredentialRequest,
+    ): CancelablePromise<IntegrationCredential> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/api/ai-account/orgs/{org}/integration-credential/',
+            path: {
+                'org': org,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Retrieve platform metadata for a specific organization.
+     *
+     * Args:
+     * request: The HTTP request
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: Platform metadata including service configurations and active services
+     *
+     * Raises:
+     * NotFound: When platform metadata is not found
+     * @param org
+     * @returns IBLAIPlatformMeta
+     * @throws ApiError
+     */
+    public static aiAccountOrgsPlatformMetadataList(
+        org: string,
+    ): CancelablePromise<Array<IBLAIPlatformMeta>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-account/orgs/{org}/platform-metadata/',
+            path: {
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Create or update platform metadata for a specific organization.
+     *
+     * Args:
+     * request: The HTTP request containing metadata information
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: Created/updated platform metadata
+     *
+     * Raises:
+     * NotFound: When platform is not found
+     * ValidationError: When request data is invalid
+     * @param org
+     * @param requestBody
+     * @returns IBLAIPlatformMeta
+     * @throws ApiError
+     */
+    public static aiAccountOrgsPlatformMetadataCreate(
+        org: string,
+        requestBody: IBLAIPlatformMetaRequest,
+    ): CancelablePromise<IBLAIPlatformMeta> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/ai-account/orgs/{org}/platform-metadata/',
+            path: {
+                'org': org,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Update specific fields of platform metadata for an organization.
+     *
+     * This endpoint allows updating the active LLM provider and available LLMs.
+     *
+     * Args:
+     * request: The HTTP request containing update information
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: Updated platform metadata
+     *
+     * Raises:
+     * NotFound: When platform metadata is not found
+     * ValidationError: When request data is invalid
+     * @param org
+     * @param requestBody
+     * @returns IBLAIPlatformMeta
+     * @throws ApiError
+     */
+    public static aiAccountOrgsPlatformMetadataUpdate(
+        org: string,
+        requestBody?: IBLAIPlatformMetaUpdateRequest,
+    ): CancelablePromise<Array<IBLAIPlatformMeta>> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/api/ai-account/orgs/{org}/platform-metadata/',
+            path: {
+                'org': org,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Retrieve weekly token usage statistics for an organization.
+     *
+     * Query Parameters:
+     * username (optional): Filter results by specific username
+     * session_id (optional): Filter results by specific session ID
+     *
+     * Args:
+     * request: The HTTP request
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: List of weekly token usage records with prompt and completion tokens
+     *
+     * Raises:
+     * NotFound: When organization is not found or when no sessions match the filters
+     * ValidationError: When query parameters are invalid
+     * @param org
+     * @param sessionId Filter token usage by specific chat session ID
+     * @param username Filter token usage by specific username
+     * @returns APITokenCost
+     * @throws ApiError
+     */
+    public static aiAccountOrgsTokensList(
+        org: string,
+        sessionId?: string,
+        username?: string,
+    ): CancelablePromise<Array<APITokenCost>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-account/orgs/{org}/tokens/',
+            path: {
+                'org': org,
+            },
+            query: {
+                'session_id': sessionId,
+                'username': username,
+            },
+        });
+    }
+    /**
+     * Enable or disable the use of main LLM credentials for an organization.
+     *
+     * Request Body:
+     * enable (boolean): Set to true to enable main credentials
+     * disable (boolean): Set to true to disable main credentials
+     *
+     * Args:
+     * request: The HTTP request
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: Confirmation message
+     *
+     * Raises:
+     * ValidationError: When neither enable nor disable is specified
+     * @param org
+     * @param requestBody
+     * @returns any
+     * @throws ApiError
+     */
+    public static aiAccountOrgsUseDefaultLlmKeyCreate(
+        org: string,
+        requestBody: UseMainCreds,
+    ): CancelablePromise<{
+        message?: string;
+    }> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/ai-account/orgs/{org}/use-default-llm-key/',
+            path: {
+                'org': org,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Enable, disable, or update free trial settings for an organization.
+     *
+     * Request Body:
+     * enable (boolean): Set to true to enable free trial
+     * disable (boolean): Set to true to disable free trial
+     * metadata (object, optional): Additional metadata for the free trial
+     *
+     * Args:
+     * request: The HTTP request
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: Confirmation message
+     * @param org
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static aiAccountOrgsUseFreeTrialCreate(
+        org: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/ai-account/orgs/{org}/use-free-trial/',
+            path: {
+                'org': org,
+            },
+        });
+    }
+    /**
+     * Retrieve the status of main LLM credential usage for an organization.
+     *
+     * Args:
+     * request: The HTTP request
+     * org: Organization key identifier
+     * user_id: User identifier
+     *
+     * Returns:
+     * Response: Status of main LLM credential usage
+     * @param org
+     * @param userId
+     * @returns any No response body
+     * @throws ApiError
+     */
+    public static aiAccountOrgsUsersDefaultLlmKeyUsageRetrieve(
+        org: string,
+        userId: string,
+    ): CancelablePromise<any> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-account/orgs/{org}/users/{user_id}/default-llm-key-usage',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+        });
+    }
+    /**
+     * Retrieve the free trial status for an organization.
+     *
+     * Args:
+     * request: The HTTP request
+     * org: Organization key identifier
+     *
+     * Returns:
+     * Response: Free trial status (boolean)
+     *
+     * Raises:
+     * NotFound: When organization is not found
+     * @param org
+     * @param userId
+     * @returns any
+     * @throws ApiError
+     */
+    public static aiAccountOrgsUsersFreeTrialRetrieve(
+        org: string,
+        userId: string,
+    ): CancelablePromise<{
+        is_in_free_trial?: boolean;
+    }> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-account/orgs/{org}/users/{user_id}/free-trial',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+        });
+    }
+}