@iblai/iblai-api 3.45.9-core → 3.45.10-ai-plus

package/src/services/AiIndexService.ts

@@ -0,0 +1,665 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { CheckDocumentTrainingStatus } from '../models/CheckDocumentTrainingStatus';
+import type { DocumentSettingsResponse } from '../models/DocumentSettingsResponse';
+import type { ResourceScrappedData } from '../models/ResourceScrappedData';
+import type { RetreiverTrainViewRequest } from '../models/RetreiverTrainViewRequest';
+import type { RetreiverTrainViewResponse } from '../models/RetreiverTrainViewResponse';
+import type { RetrieverDocumentEmbedding } from '../models/RetrieverDocumentEmbedding';
+import type { RetrieverDocumentEmbeddingRequest } from '../models/RetrieverDocumentEmbeddingRequest';
+import type { RetrieverRequestSearch } from '../models/RetrieverRequestSearch';
+import type { RetrieverRequestSearchDocument } from '../models/RetrieverRequestSearchDocument';
+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';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class AiIndexService {
+    /**
+     * Retrieve details of a specific document embedding.
+     *
+     * This endpoint returns detailed information about a specific
+     * document embedding identified by its ID.
+     *
+     * Args:
+     * request: The HTTP request.
+     * org: Organization key identifier.
+     * document_id: The ID of the document embedding to retrieve.
+     *
+     * Returns:
+     * Response: Detailed information about the document embedding.
+     *
+     * Raises:
+     * NotFound: If the specified document embedding does not exist.
+     * @param documentId
+     * @param org
+     * @param userId
+     * @returns RetrieverDocumentEmbedding
+     * @throws ApiError
+     */
+    public static aiIndexOrgsUsersDocumentsRetrieve(
+        documentId: string,
+        org: string,
+        userId: string,
+    ): CancelablePromise<RetrieverDocumentEmbedding> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
+            path: {
+                'document_id': documentId,
+                'org': org,
+                'user_id': userId,
+            },
+            errors: {
+                404: `Document not found`,
+            },
+        });
+    }
+    /**
+     * Update a specific document embedding.
+     *
+     * This endpoint allows updating various properties of a document embedding,
+     * including its name, type, pathway, and training status.
+     *
+     * Args:
+     * request: The HTTP request containing the updated document data.
+     * org: Organization key identifier.
+     * document_id: The ID of the document embedding to update.
+     *
+     * Returns:
+     * Response: The updated document embedding information.
+     *
+     * Raises:
+     * BadRequest: If the provided data is invalid.
+     * NotFound: If the specified document embedding does not exist.
+     * @param documentId
+     * @param org
+     * @param userId
+     * @param formData
+     * @returns RetrieverDocumentEmbedding
+     * @throws ApiError
+     */
+    public static aiIndexOrgsUsersDocumentsUpdate(
+        documentId: string,
+        org: string,
+        userId: string,
+        formData: RetrieverDocumentEmbeddingRequest,
+    ): CancelablePromise<RetrieverDocumentEmbedding> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
+            path: {
+                'document_id': documentId,
+                'org': org,
+                'user_id': userId,
+            },
+            formData: formData,
+            mediaType: 'multipart/form-data',
+            errors: {
+                400: `Invalid request data`,
+                404: `Document not found`,
+            },
+        });
+    }
+    /**
+     * Delete a specific document embedding.
+     *
+     * This endpoint removes a document embedding from the system,
+     * including untraining it from any associated pathways.
+     *
+     * Args:
+     * request: The HTTP request.
+     * org: Organization key identifier.
+     * document_id: The ID of the document embedding to delete.
+     *
+     * Returns:
+     * Response: An empty response with a 204 status code if successful.
+     *
+     * Raises:
+     * NotFound: If the specified document embedding does not exist.
+     * @param documentId
+     * @param org
+     * @param userId
+     * @returns void
+     * @throws ApiError
+     */
+    public static aiIndexOrgsUsersDocumentsDestroy(
+        documentId: string,
+        org: string,
+        userId: string,
+    ): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/',
+            path: {
+                'document_id': documentId,
+                'org': org,
+                'user_id': userId,
+            },
+            errors: {
+                404: `Document not found`,
+            },
+        });
+    }
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
+     * @param documentId
+     * @param org
+     * @param userId
+     * @returns DocumentSettingsResponse
+     * @throws ApiError
+     */
+    public static aiIndexOrgsUsersDocumentsSettingsRetrieve(
+        documentId: string,
+        org: string,
+        userId: string,
+    ): CancelablePromise<DocumentSettingsResponse> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/',
+            path: {
+                'document_id': documentId,
+                'org': org,
+                'user_id': userId,
+            },
+        });
+    }
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
+     * @param documentId
+     * @param org
+     * @param userId
+     * @param requestBody
+     * @returns DocumentSettingsResponse
+     * @throws ApiError
+     */
+    public static aiIndexOrgsUsersDocumentsSettingsCreate(
+        documentId: string,
+        org: string,
+        userId: string,
+        requestBody?: DocumentSettingsResponse,
+    ): CancelablePromise<DocumentSettingsResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/{document_id}/settings/',
+            path: {
+                'document_id': documentId,
+                'org': org,
+                'user_id': userId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Train a graph-based document through a worker process.
+     *
+     * This endpoint queues graph-based documents for training through a
+     * specialized worker process that handles knowledge graph processing.
+     *
+     * Args:
+     * request: The HTTP request containing the document information.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: A confirmation that the document was queued for training,
+     * including a task ID for tracking the progress.
+     *
+     * Raises:
+     * ValidationError: If the request data is invalid.
+     * BadRequest: If there was an error processing the document.
+     * @param org
+     * @param userId
+     * @param formData
+     * @returns TrainDocumentViewResponse
+     * @throws ApiError
+     */
+    public static aiIndexOrgsUsersDocumentsGraphTrainCreate(
+        org: string,
+        userId: string,
+        formData: TrainDocumentViewRequest,
+    ): CancelablePromise<TrainDocumentViewResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/graph-train/',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+            formData: formData,
+            mediaType: 'multipart/form-data',
+            errors: {
+                400: `Invalid request data or document processing error`,
+            },
+        });
+    }
+    /**
+     * Retrieve a list of document embeddings for a specific pathway.
+     *
+     * This endpoint returns a paginated list of all document embeddings
+     * that have been created for the specified pathway within the organization.
+     *
+     * Args:
+     * request: The HTTP request.
+     * org: Organization key identifier.
+     * pathway: The pathway to retrieve document embeddings for.
+     *
+     * Returns:
+     * Response: A paginated list of document embeddings for the pathway.
+     * @param org
+     * @param pathway
+     * @param userId
+     * @returns RetrieverDocumentEmbedding
+     * @throws ApiError
+     */
+    public static aiIndexOrgsUsersDocumentsPathwaysList(
+        org: string,
+        pathway: string,
+        userId: string,
+    ): CancelablePromise<Array<RetrieverDocumentEmbedding>> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/pathways/{pathway}/',
+            path: {
+                'org': org,
+                'pathway': pathway,
+                'user_id': userId,
+            },
+        });
+    }
+    /**
+     * Retrieve resource documents similar to the given query.
+     *
+     * This endpoint performs a semantic search to find documents that are
+     * relevant to the provided query within the specified pathway.
+     *
+     * Args:
+     * request: The HTTP request containing the search query.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: A list of documents relevant to the search query.
+     *
+     * Raises:
+     * ValidationError: If the request data is invalid.
+     * @param org
+     * @param userId
+     * @param requestBody
+     * @returns RetrieverResponseSearch
+     * @throws ApiError
+     */
+    public static aiIndexOrgsUsersDocumentsSearchCreate(
+        org: string,
+        userId: string,
+        requestBody: RetrieverRequestSearch,
+    ): CancelablePromise<RetrieverResponseSearch> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/search/',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Invalid request data`,
+            },
+        });
+    }
+    /**
+     * Retrieve document sources related to a given query.
+     *
+     * This endpoint performs a semantic search to find document sources
+     * that are relevant to the provided query within the specified pathway,
+     * and returns them along with confidence levels.
+     *
+     * Args:
+     * request: The HTTP request containing the search query.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: A list of document sources with confidence levels.
+     *
+     * Raises:
+     * ValidationError: If the request data is invalid.
+     * @param org
+     * @param userId
+     * @param requestBody
+     * @returns RetrieverRequestSearchDocument
+     * @throws ApiError
+     */
+    public static aiIndexOrgsUsersDocumentsSourcesCreate(
+        org: string,
+        userId: string,
+        requestBody: RetrieverRequestSearch,
+    ): CancelablePromise<Array<RetrieverRequestSearchDocument>> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/sources/',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+            errors: {
+                400: `Invalid request data`,
+            },
+        });
+    }
+    /**
+     * Check the status of a document training task.
+     *
+     * This endpoint retrieves the current status of an asynchronous
+     * document training task that was previously initiated.
+     *
+     * Args:
+     * request: The HTTP request.
+     * org: Organization key identifier.
+     * task_id: The ID of the training task to check.
+     *
+     * Returns:
+     * Response: The current status of the document training task,
+     * which can be "pending", "completed", or "failed".
+     * @param org
+     * @param taskId
+     * @param userId
+     * @returns CheckDocumentTrainingStatus
+     * @throws ApiError
+     */
+    public static aiIndexOrgsUsersDocumentsTasksRetrieve(
+        org: string,
+        taskId: string,
+        userId: string,
+    ): CancelablePromise<CheckDocumentTrainingStatus> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/tasks/{task_id}/',
+            path: {
+                'org': org,
+                'task_id': taskId,
+                'user_id': userId,
+            },
+        });
+    }
+    /**
+     * Train a document through a worker process.
+     *
+     * This endpoint queues larger documents for training through a worker
+     * process, which is more suitable for handling documents that would
+     * take too long to process directly.
+     *
+     * Args:
+     * request: The HTTP request containing the document information.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: A confirmation that the document was queued for training,
+     * including a task ID for tracking the progress.
+     *
+     * Raises:
+     * ValidationError: If the request data is invalid.
+     * BadRequest: If there was an error processing the document.
+     * @param org
+     * @param userId
+     * @param formData
+     * @returns TrainDocumentViewResponse
+     * @throws ApiError
+     */
+    public static aiIndexOrgsUsersDocumentsTrainCreate(
+        org: string,
+        userId: string,
+        formData: TrainDocumentViewRequest,
+    ): CancelablePromise<TrainDocumentViewResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/train/',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+            formData: formData,
+            mediaType: 'multipart/form-data',
+            errors: {
+                400: `Invalid request data`,
+            },
+        });
+    }
+    /**
+     * Train a document directly without using a worker.
+     *
+     * This endpoint is designed for training smaller documents directly
+     * without queuing them through a worker process. For larger documents,
+     * use the TrainDocumentView endpoint instead.
+     *
+     * Args:
+     * request: The HTTP request containing the document information.
+     * org: Organization key identifier.
+     *
+     * Returns:
+     * Response: A confirmation that the document was trained successfully.
+     *
+     * Raises:
+     * ValidationError: If the request data is invalid.
+     * BadRequest: If the document training failed.
+     * @param org
+     * @param userId
+     * @param formData
+     * @returns RetreiverTrainViewResponse
+     * @throws ApiError
+     */
+    public static aiIndexOrgsUsersDocumentsTrainRetrieverCreate(
+        org: string,
+        userId: string,
+        formData: RetreiverTrainViewRequest,
+    ): CancelablePromise<RetreiverTrainViewResponse> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/ai-index/orgs/{org}/users/{user_id}/documents/train/retriever/',
+            path: {
+                'org': org,
+                'user_id': userId,
+            },
+            formData: formData,
+            mediaType: 'multipart/form-data',
+            errors: {
+                400: `Invalid request data or training failed`,
+            },
+        });
+    }
+    /**
+     * 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.
+     *
+     * Methods:
+     * - POST: Submits a document or media file for training within a specified chat session.
+     *
+     * 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:
+     * - 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.
+         * @param org
+         * @param sessionId
+         * @param userId
+         * @param formData
+         * @returns TrainChatSessionDocumentView
+         * @throws ApiError
+         */
+        public static aiIndexOrgsUsersDocumentsTrainSessionsCreate(
+            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.
+         * @param org
+         * @param resourceId
+         * @param userId
+         * @returns ResourceScrappedData
+         * @throws ApiError
+         */
+        public static aiIndexOrgsUsersResourceDataScrappedRetrieve(
+            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.
+         * @param org
+         * @param userId
+         * @param isArchive
+         * @param isLike
+         * @param isVideo
+         * @param searchKey
+         * @returns ResourceScrappedData
+         * @throws ApiError
+         */
+        public static aiIndexOrgsUsersResourceDataScrappedList(
+            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.
+         * @param requestBody
+         * @returns ScanWebhookResponse
+         * @throws ApiError
+         */
+        public static aiIndexWebhookScanCreate(
+            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`,
+                },
+            });
+        }
+    }