@iblai/iblai-api 4.125.0-test-ai → 4.125.1-ai

package/src/services/AiIndexService.ts

@@ -16,6 +16,8 @@ import type { RetrieverRequestSearchDocument } from '../models/RetrieverRequestS
 import type { RetrieverResponseSearch } from '../models/RetrieverResponseSearch';
 import type { ScanWebhookRequest } from '../models/ScanWebhookRequest';
 import type { ScanWebhookResponse } from '../models/ScanWebhookResponse';
+import type { TrainChatSessionDocumentView } from '../models/TrainChatSessionDocumentView';
+import type { TrainChatSessionDocumentViewRequest } from '../models/TrainChatSessionDocumentViewRequest';
 import type { TrainDocumentViewRequest } from '../models/TrainDocumentViewRequest';
 import type { TrainDocumentViewResponse } from '../models/TrainDocumentViewResponse';
 import type { CancelablePromise } from '../core/CancelablePromise';
@@ -515,130 +517,194 @@ export class AiIndexService {
                     });
                 }
                 /**
-                 * Retrieve detailed information about a specific scraped resource.
+                 * Description:
+                 * Submit a document file  in a chat session. Checks file type, size, and ensures the session exists, then processes the file.
+                 * Process  document for use in a specific chat session.
+                 * which will be processed and made available for the AI to reference
+                 * when responding to queries in that session.
                  *
-                 * This endpoint returns the complete scraped data for a specific resource
-                 * identified by its ID.
+                 * Methods:
+                 * - POST: Submits a document or media file for training within a specified chat session.
                  *
-                 * Args:
-                 * request: The HTTP request.
-                 * org: Organization key identifier.
-                 * user_id: The username of the user associated with the resource.
-                 * resource_id: The ID of the resource to retrieve.
+                 * Parameters:
+                 * - org (str):
+                 * - session_id (str): UUID of the chat session for which the document is being submitted.
+                 * - *args, **kwargs: Additional arguments.
+                 * - file (file): Multipart file input.
                  *
                  * Returns:
-                 * Response: The complete scraped data for the specified resource.
-                 *
-                 * Raises:
-                 * NotFound: If the specified resource data does not exist.
-                 * @returns ResourceScrappedData
-                 * @throws ApiError
-                 */
-                public static aiIndexOrgsUsersResourceDataScrappedRetrieve({
-                    org,
-                    resourceId,
-                    userId,
-                }: {
-                    org: string,
-                    resourceId: string,
-                    userId: string,
-                }): CancelablePromise<ResourceScrappedData> {
-                    return __request(OpenAPI, {
-                        method: 'GET',
-                        url: '/api/ai-index/orgs/{org}/users/{user_id}/resource/{resource_id}/data/scrapped/',
-                        path: {
-                            'org': org,
-                            'resource_id': resourceId,
-                            'user_id': userId,
-                        },
-                        errors: {
-                            404: `Resource data not found`,
-                        },
-                    });
-                }
-                /**
-                 * Retrieve and filter scraped data from resources.
-                 *
-                 * This endpoint returns a list of scraped data from resources associated
-                 * with the specified user, with optional filtering based on query parameters.
-                 *
-                 * Args:
-                 * request: The HTTP request containing filter query parameters.
-                 * org: Organization key identifier.
-                 * user_id: The username of the user whose resources to retrieve.
-                 *
-                 * Returns:
-                 * Response: A list of scraped resource data matching the filter criteria.
-                 *
-                 * Raises:
-                 * BadRequest: If the username is invalid or query parameters are incorrect.
-                 * @returns ResourceScrappedData
-                 * @throws ApiError
-                 */
-                public static aiIndexOrgsUsersResourceDataScrappedList({
-                    org,
-                    userId,
-                    isArchive,
-                    isLike,
-                    isVideo,
-                    searchKey,
-                }: {
-                    org: string,
-                    userId: string,
-                    isArchive?: boolean | null,
-                    isLike?: boolean | null,
-                    isVideo?: boolean | null,
-                    searchKey?: string,
-                }): CancelablePromise<Array<ResourceScrappedData>> {
-                    return __request(OpenAPI, {
-                        method: 'GET',
-                        url: '/api/ai-index/orgs/{org}/users/{user_id}/resource/data/scrapped/',
-                        path: {
-                            'org': org,
-                            'user_id': userId,
-                        },
-                        query: {
-                            'is_archive': isArchive,
-                            'is_like': isLike,
-                            'is_video': isVideo,
-                            'search_key': searchKey,
-                        },
-                        errors: {
-                            400: `Invalid username or query parameters`,
-                        },
-                    });
-                }
-                /**
-                 * Receive and process file scan status from external security scanning services.
-                 *
-                 * This webhook endpoint receives scan results for files that have been submitted
-                 * for security scanning. It processes the results asynchronously and determines
-                 * if the files are safe for further processing.
-                 *
-                 * Args:
-                 * request: The HTTP request containing scan result data.
-                 *
-                 * Returns:
-                 * Response: A confirmation that the scan result was received and is being processed.
-                 *
-                 * Raises:
-                 * BadRequest: If the provided scan result data is invalid.
-                 * @returns ScanWebhookResponse
-                 * @throws ApiError
-                 */
-                public static aiIndexWebhookScanCreate({
-                    requestBody,
-                }: {
-                    requestBody: ScanWebhookRequest,
-                }): CancelablePromise<ScanWebhookResponse> {
-                    return __request(OpenAPI, {
-                        method: 'POST',
-                        url: '/api/ai-index/webhook/scan/',
-                        body: requestBody,
-                        mediaType: 'application/json',
-                        errors: {
-                            400: `Invalid request data`,
-                        },
-                    });
+                 * - POST: Returns a JSON message with the result of the upload process. Response code 200 on success.
+                 * {
+                     * "message": "File processed."
+                     * }
+                     *
+                     * Error Responses:
+                     * - 400 Bad Request:
+                     * - "File field is required" if the 'file' parameter is missing.
+                     * - "invalid file object" if the file object is not valid.
+                     * - Specific error message if an exception occurs while saving to Redis.
+                     * - 404 Not Found:
+                     * - "Session not found" if the provided session_id does not match any existing session.
+                     * - 413 Request Entity Too Large:
+                     * - "file is too large" including specific limits for document and media files if the file exceeds size limits.
+                     *
+                     * Access Control:
+                     * Requires authentication with a Bearer token in the Authorization header. The user associated with the session must exist and be authorized for the request.
+                     * @returns TrainChatSessionDocumentView
+                     * @throws ApiError
+                     */
+                    public static aiIndexOrgsUsersDocumentsTrainSessionsCreate({
+                        org,
+                        sessionId,
+                        userId,
+                        formData,
+                    }: {
+                        org: string,
+                        sessionId: string,
+                        userId: string,
+                        formData: TrainChatSessionDocumentViewRequest,
+                    }): CancelablePromise<TrainChatSessionDocumentView> {
+                        return __request(OpenAPI, {
+                            method: 'POST',
+                            url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/train/sessions/{session_id}/',
+                            path: {
+                                'org': org,
+                                'session_id': sessionId,
+                                'user_id': userId,
+                            },
+                            formData: formData,
+                            mediaType: 'multipart/form-data',
+                            errors: {
+                                400: `Invalid file or processing error`,
+                                413: `File too large`,
+                            },
+                        });
+                    }
+                    /**
+                     * Retrieve detailed information about a specific scraped resource.
+                     *
+                     * This endpoint returns the complete scraped data for a specific resource
+                     * identified by its ID.
+                     *
+                     * Args:
+                     * request: The HTTP request.
+                     * org: Organization key identifier.
+                     * user_id: The username of the user associated with the resource.
+                     * resource_id: The ID of the resource to retrieve.
+                     *
+                     * Returns:
+                     * Response: The complete scraped data for the specified resource.
+                     *
+                     * Raises:
+                     * NotFound: If the specified resource data does not exist.
+                     * @returns ResourceScrappedData
+                     * @throws ApiError
+                     */
+                    public static aiIndexOrgsUsersResourceDataScrappedRetrieve({
+                        org,
+                        resourceId,
+                        userId,
+                    }: {
+                        org: string,
+                        resourceId: string,
+                        userId: string,
+                    }): CancelablePromise<ResourceScrappedData> {
+                        return __request(OpenAPI, {
+                            method: 'GET',
+                            url: '/api/ai-index/orgs/{org}/users/{user_id}/resource/{resource_id}/data/scrapped/',
+                            path: {
+                                'org': org,
+                                'resource_id': resourceId,
+                                'user_id': userId,
+                            },
+                            errors: {
+                                404: `Resource data not found`,
+                            },
+                        });
+                    }
+                    /**
+                     * Retrieve and filter scraped data from resources.
+                     *
+                     * This endpoint returns a list of scraped data from resources associated
+                     * with the specified user, with optional filtering based on query parameters.
+                     *
+                     * Args:
+                     * request: The HTTP request containing filter query parameters.
+                     * org: Organization key identifier.
+                     * user_id: The username of the user whose resources to retrieve.
+                     *
+                     * Returns:
+                     * Response: A list of scraped resource data matching the filter criteria.
+                     *
+                     * Raises:
+                     * BadRequest: If the username is invalid or query parameters are incorrect.
+                     * @returns ResourceScrappedData
+                     * @throws ApiError
+                     */
+                    public static aiIndexOrgsUsersResourceDataScrappedList({
+                        org,
+                        userId,
+                        isArchive,
+                        isLike,
+                        isVideo,
+                        searchKey,
+                    }: {
+                        org: string,
+                        userId: string,
+                        isArchive?: boolean | null,
+                        isLike?: boolean | null,
+                        isVideo?: boolean | null,
+                        searchKey?: string,
+                    }): CancelablePromise<Array<ResourceScrappedData>> {
+                        return __request(OpenAPI, {
+                            method: 'GET',
+                            url: '/api/ai-index/orgs/{org}/users/{user_id}/resource/data/scrapped/',
+                            path: {
+                                'org': org,
+                                'user_id': userId,
+                            },
+                            query: {
+                                'is_archive': isArchive,
+                                'is_like': isLike,
+                                'is_video': isVideo,
+                                'search_key': searchKey,
+                            },
+                            errors: {
+                                400: `Invalid username or query parameters`,
+                            },
+                        });
+                    }
+                    /**
+                     * Receive and process file scan status from external security scanning services.
+                     *
+                     * This webhook endpoint receives scan results for files that have been submitted
+                     * for security scanning. It processes the results asynchronously and determines
+                     * if the files are safe for further processing.
+                     *
+                     * Args:
+                     * request: The HTTP request containing scan result data.
+                     *
+                     * Returns:
+                     * Response: A confirmation that the scan result was received and is being processed.
+                     *
+                     * Raises:
+                     * BadRequest: If the provided scan result data is invalid.
+                     * @returns ScanWebhookResponse
+                     * @throws ApiError
+                     */
+                    public static aiIndexWebhookScanCreate({
+                        requestBody,
+                    }: {
+                        requestBody: ScanWebhookRequest,
+                    }): CancelablePromise<ScanWebhookResponse> {
+                        return __request(OpenAPI, {
+                            method: 'POST',
+                            url: '/api/ai-index/webhook/scan/',
+                            body: requestBody,
+                            mediaType: 'application/json',
+                            errors: {
+                                400: `Invalid request data`,
+                            },
+                        });
+                    }
                 }
-            }