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

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

@@ -0,0 +1,8 @@
+/**
+ * * `tutorial` - Tutorial
+ * * `assessment` - Assessment
+ */
+export declare enum TypeC42Enum {
+    TUTORIAL = "tutorial",
+    ASSESSMENT = "assessment"
+}

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

@@ -0,0 +1,11 @@
+import type { Status6eeEnum } from './Status6eeEnum';
+import type { TypeC42Enum } from './TypeC42Enum';
+export type Unit = {
+    readonly id: number;
+    subsection: number;
+    display_name: string;
+    readonly status: Status6eeEnum;
+    type?: TypeC42Enum;
+    readonly created_at: string;
+    readonly updated_at: string;
+};

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

@@ -0,0 +1,13 @@
+import type { ComponentBlock } from './ComponentBlock';
+import type { Status6eeEnum } from './Status6eeEnum';
+import type { TypeC42Enum } from './TypeC42Enum';
+export type UnitWithChildren = {
+    readonly id: number;
+    subsection: number;
+    display_name: string;
+    readonly status: Status6eeEnum;
+    type?: TypeC42Enum;
+    readonly created_at: string;
+    readonly updated_at: string;
+    components: Array<ComponentBlock>;
+};

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

@@ -0,0 +1,3 @@
+export type UseMainCreds = {
+    message: string;
+};

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

@@ -0,0 +1,7 @@
+export type UserAllChatMemoryView = {
+    readonly id: number;
+    username: string;
+    platform_key: string;
+    content?: string | null;
+    session_id?: string | null;
+};

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

@@ -0,0 +1,14 @@
+export type UserCatalogItemMemoryView = {
+    readonly id: number;
+    /**
+     * edX username
+     */
+    student: string | null;
+    /**
+     * The platform key
+     */
+    platform: string;
+    catalog_item?: string;
+    lessons?: any;
+    next_steps?: any;
+};

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

@@ -0,0 +1,4 @@
+export type UserChatByPeriod = {
+    period: string;
+    user_count: number;
+};

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

@@ -0,0 +1,14 @@
+import type { NullEnum } from './NullEnum';
+import type { RatingEnum } from './RatingEnum';
+export type UserChatFeedback = {
+    readonly id: number;
+    username: string;
+    session: string;
+    user_text: string;
+    ai_response: string;
+    reason: string;
+    additional_feedback: string;
+    rating?: (RatingEnum | NullEnum) | null;
+    inserted_at?: string;
+    mentor: number;
+};

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

@@ -0,0 +1,4 @@
+export type UserChatFeedbackCount = {
+    period: string;
+    feedback_count: number;
+};

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

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

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

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

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

@@ -0,0 +1,10 @@
+export type UserChatMemoryUpdateView = {
+    /**
+     * Id of the schedled task
+     */
+    task_id: string;
+    /**
+     * Message about the scheduled task
+     */
+    message: string;
+};

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

@@ -0,0 +1,4 @@
+export type UserCountRecord = {
+    date: string;
+    user_count: number;
+};

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

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

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

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

@@ -0,0 +1,4 @@
+export type UserMetric = {
+    total: number;
+    change_percentage: number;
+};

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

@@ -0,0 +1,7 @@
+import type { UserMetric } from './UserMetric';
+export type UserMetricsResponse = {
+    registered_users: UserMetric;
+    new_users: UserMetric;
+    unique_users: UserMetric;
+    veteran_users: UserMetric;
+};

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

@@ -0,0 +1,4 @@
+export type UserSentimentCountView = {
+    date: string;
+    sentiment_count: number;
+};

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

@@ -0,0 +1,5 @@
+export type UserTrendByPeriod = {
+    periods: Array<string>;
+    new_users: Array<number>;
+    veteran_users: Array<number>;
+};

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

@@ -0,0 +1,8 @@
+export type VectorResult = {
+    type?: string;
+    title?: string;
+    snippet: string;
+    source?: string;
+    score?: number;
+    confidence_level?: number;
+};

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

@@ -0,0 +1,3 @@
+export type VideoCaption = {
+    file: string;
+};

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

@@ -0,0 +1,9 @@
+import type { ProviderEnum } from './ProviderEnum';
+export type Voice = {
+    readonly id: number;
+    name: string;
+    provider: ProviderEnum;
+    language?: string;
+    description?: string;
+    readonly audio_url: string;
+};

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

@@ -0,0 +1,9 @@
+import type { WebResourceCard } from './WebResourceCard';
+export type WebResource = {
+    content: string;
+    title: string;
+    imageUrl?: string | null;
+    source?: string;
+    metadata?: any;
+    card?: WebResourceCard;
+};

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

@@ -0,0 +1,7 @@
+export type WebResourceCard = {
+    title: string;
+    description: string;
+    imageUrl: string;
+    domain: string;
+    site_name: string;
+};

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

@@ -0,0 +1,3 @@
+export type WebResourcesQuery = {
+    query: string;
+};

package/dist/types/services/AiAccountService.d.ts

@@ -0,0 +1,294 @@
+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';
+export declare 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
+     */
+    static aiAccountOrgsCredentialRetrieve(org: string, name?: string): CancelablePromise<LLMCredentialResponse>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsCredentialCreate(org: string, requestBody: LLMCredentialRequest): CancelablePromise<LLMCredentialResponse>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsCredentialPartialUpdate(org: string, requestBody?: PatchedLLMCredentialRequest): CancelablePromise<LLMCredentialResponse>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsIntegrationCredentialRetrieve(org: string, name?: string): CancelablePromise<IntegrationCredential>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsIntegrationCredentialCreate(org: string, requestBody: CredentialRequest): CancelablePromise<IntegrationCredential>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsIntegrationCredentialPartialUpdate(org: string, requestBody?: PatchedCredentialRequest): CancelablePromise<IntegrationCredential>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsPlatformMetadataList(org: string): CancelablePromise<Array<IBLAIPlatformMeta>>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsPlatformMetadataCreate(org: string, requestBody: IBLAIPlatformMetaRequest): CancelablePromise<IBLAIPlatformMeta>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsPlatformMetadataUpdate(org: string, requestBody?: IBLAIPlatformMetaUpdateRequest): CancelablePromise<Array<IBLAIPlatformMeta>>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsTokensList(org: string, sessionId?: string, username?: string): CancelablePromise<Array<APITokenCost>>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsUseDefaultLlmKeyCreate(org: string, requestBody: UseMainCreds): CancelablePromise<{
+        message?: string;
+    }>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsUseFreeTrialCreate(org: string): CancelablePromise<any>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsUsersDefaultLlmKeyUsageRetrieve(org: string, userId: string): CancelablePromise<any>;
+    /**
+     * 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
+     */
+    static aiAccountOrgsUsersFreeTrialRetrieve(org: string, userId: string): CancelablePromise<{
+        is_in_free_trial?: boolean;
+    }>;
+}