@iblai/iblai-api 4.5.1-ai → 4.5.1-core

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

@@ -1,280 +0,0 @@
-import type { ConnectedService } from '../models/ConnectedService';
-import type { CredentialRequest } from '../models/CredentialRequest';
-import type { IntegrationCredential } from '../models/IntegrationCredential';
-import type { LLMCredentialRequest } from '../models/LLMCredentialRequest';
-import type { LLMCredentialResponse } from '../models/LLMCredentialResponse';
-import type { OAuthStartResponse } from '../models/OAuthStartResponse';
-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 {
-    /**
-     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
-     * @returns ConnectedService Callback for the OAuth flow
-     * @throws ApiError
-     */
-    static aiAccountConnectedServicesCallbackRetrieve(): CancelablePromise<ConnectedService>;
-    /**
-     * Mixin that includes the StudentTokenAuthentication and IsAdminUserOrStudent
-     * @returns OAuthStartResponse Starts the OAuth flow for the given provider and service
-     * @throws ApiError
-     */
-    static aiAccountConnectedServicesOrgsUsersRetrieve({ org, provider, service, userId, }: {
-        org: string;
-        provider: string;
-        service: string;
-    }): CancelablePromise<OAuthStartResponse>;
-    /**
-     * 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
-     * @returns LLMCredentialResponse
-     * @throws ApiError
-     */
-    static aiAccountOrgsCredentialRetrieve({ org, name, }: {
-        org: string;
-        /**
-         * Filter credentials by provider name (e.g., 'openai', 'google')
-         */
-        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
-     * @returns LLMCredentialResponse
-     * @throws ApiError
-     */
-    static aiAccountOrgsCredentialCreate({ org, requestBody, }: {
-        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
-     * @returns LLMCredentialResponse
-     * @throws ApiError
-     */
-    static aiAccountOrgsCredentialPartialUpdate({ org, requestBody, }: {
-        org: string;
-        requestBody?: PatchedLLMCredentialRequest;
-    }): CancelablePromise<LLMCredentialResponse>;
-    /**
-     * Delete an existing LLM credential for an organization.
-     *
-     * Args:
-     * request: The HTTP request containing updated credential information
-     * org: Organization key identifier
-     *
-     * Returns:
-     * Response: 204
-     *
-     * Raises:
-     * NotFound: When organization or credential is not found
-     * ValidationError: When request data is invalid
-     * @returns void
-     * @throws ApiError
-     */
-    static aiAccountOrgsCredentialDestroy({ org, }: {
-        org: string;
-    }): CancelablePromise<void>;
-    /**
-     * 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
-     * @returns IntegrationCredential
-     * @throws ApiError
-     */
-    static aiAccountOrgsIntegrationCredentialRetrieve({ org, name, }: {
-        org: string;
-        /**
-         * Filter credentials by provider name (e.g., 'openai', 'google')
-         */
-        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
-     * @returns IntegrationCredential
-     * @throws ApiError
-     */
-    static aiAccountOrgsIntegrationCredentialCreate({ org, requestBody, }: {
-        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
-     * @returns IntegrationCredential
-     * @throws ApiError
-     */
-    static aiAccountOrgsIntegrationCredentialPartialUpdate({ org, requestBody, }: {
-        org: string;
-        requestBody?: PatchedCredentialRequest;
-    }): CancelablePromise<IntegrationCredential>;
-    /**
-     * Delete an existing integration credential for an organization.
-     *
-     * Args:
-     * request: The HTTP request containing credential information (must include 'id')
-     * org: Organization key identifier
-     *
-     * Returns:
-     * Response: 204
-     *
-     * Raises:
-     * NotFound: When organization or credential is not found
-     * ValidationError: When request data is invalid
-     * @returns void
-     * @throws ApiError
-     */
-    static aiAccountOrgsIntegrationCredentialDestroy({ org, }: {
-        org: string;
-    }): CancelablePromise<void>;
-    /**
-     * 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
-     * @returns any
-     * @throws ApiError
-     */
-    static aiAccountOrgsUseDefaultLlmKeyCreate({ org, requestBody, }: {
-        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
-     * @returns any No response body
-     * @throws ApiError
-     */
-    static aiAccountOrgsUseFreeTrialCreate({ org, }: {
-        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
-     * @returns any No response body
-     * @throws ApiError
-     */
-    static aiAccountOrgsUsersDefaultLlmKeyUsageRetrieve({ org, userId, }: {
-        org: 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
-     * @returns any
-     * @throws ApiError
-     */
-    static aiAccountOrgsUsersFreeTrialRetrieve({ org, userId, }: {
-        org: string;
-        userId: string;
-    }): CancelablePromise<{
-        is_in_free_trial?: boolean;
-    }>;
-}

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

@@ -1,408 +0,0 @@
-import type { CheckDocumentTrainingStatus } from '../models/CheckDocumentTrainingStatus';
-import type { DocumentSettingsResponse } from '../models/DocumentSettingsResponse';
-import type { PaginatedRetrieverDocumentEmbeddingList } from '../models/PaginatedRetrieverDocumentEmbeddingList';
-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';
-export declare 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.
-     * @returns RetrieverDocumentEmbedding
-     * @throws ApiError
-     */
-    static aiIndexOrgsUsersDocumentsRetrieve({ documentId, org, userId, }: {
-        documentId: string;
-        org: string;
-    }): CancelablePromise<RetrieverDocumentEmbedding>;
-    /**
-     * 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.
-     * @returns RetrieverDocumentEmbedding
-     * @throws ApiError
-     */
-    static aiIndexOrgsUsersDocumentsUpdate({ documentId, org, userId, formData, }: {
-        documentId: string;
-        org: string;
-        formData: RetrieverDocumentEmbeddingRequest;
-    }): CancelablePromise<RetrieverDocumentEmbedding>;
-    /**
-     * 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.
-     * @returns void
-     * @throws ApiError
-     */
-    static aiIndexOrgsUsersDocumentsDestroy({ documentId, org, userId, }: {
-        documentId: string;
-        org: string;
-    }): CancelablePromise<void>;
-    /**
-     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @returns DocumentSettingsResponse
-     * @throws ApiError
-     */
-    static aiIndexOrgsUsersDocumentsSettingsRetrieve({ documentId, org, userId, }: {
-        documentId: string;
-        org: string;
-    }): CancelablePromise<DocumentSettingsResponse>;
-    /**
-     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @returns DocumentSettingsResponse
-     * @throws ApiError
-     */
-    static aiIndexOrgsUsersDocumentsSettingsCreate({ documentId, org, userId, requestBody, }: {
-        documentId: string;
-        org: string;
-        requestBody?: DocumentSettingsResponse;
-    }): CancelablePromise<DocumentSettingsResponse>;
-    /**
-     * 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.
-     * @returns TrainDocumentViewResponse
-     * @throws ApiError
-     */
-    static aiIndexOrgsUsersDocumentsGraphTrainCreate({ org, userId, formData, }: {
-        org: string;
-        formData: TrainDocumentViewRequest;
-    }): CancelablePromise<TrainDocumentViewResponse>;
-    /**
-     * Description:
-     * Retrieves a list of document embeddings for a specific pathway with optional search and pagination.
-     *
-     * Methods:
-     * - GET: Retrieves document embeddings that match the specified search criteria and are paginated according to offset and limit.
-     *
-     * Parameters:
-     * - search (str): Search query to filter document names or URLs.
-     * - offset (int): Offset number for pagination.
-     * - limit (int): Limit number for pagination.
-     *
-     * Returns:
-     * - GET: A paginated list of document embeddings with their details.
-     * {
-         * "count": 10,
-         * "next": "http://api.example.com/retriever_documents/?offset=10&limit=2",
-         * "previous": "http://api.example.com/retriever_documents/?offset=0&limit=2",
-         * "results": [
-             * {
-                 * "document_name": "Document2",
-                 * "platform_key": "example_platform",
-                 * "pathway": "example_pathway"
-                 * }
-                 * ]
-                 * }
-                 *
-                 * Error Responses:
-                 * - 400 Bad Request: Invalid query parameters.
-                 * - 404 Not Found: No document embeddings found for the specified criteria.
-                 * @returns PaginatedRetrieverDocumentEmbeddingList
-                 * @throws ApiError
-                 */
-    static aiIndexOrgsUsersDocumentsPathwaysList({ org, pathway, userId, limit, offset, search, }: {
-        org: string;
-        pathway: string; /**
-         * limit number
-         */
-        limit?: number; /**
-         * Offset number
-         */
-        offset?: number; /**
-         * Search query
-         */
-        search?: string;
-    }): CancelablePromise<PaginatedRetrieverDocumentEmbeddingList>;
-    /**
-     * 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.
-     * @returns RetrieverResponseSearch
-     * @throws ApiError
-     */
-    static aiIndexOrgsUsersDocumentsSearchCreate({ org, userId, requestBody, }: {
-        org: string;
-        requestBody: RetrieverRequestSearch;
-    }): CancelablePromise<RetrieverResponseSearch>;
-    /**
-     * 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.
-     * @returns RetrieverRequestSearchDocument
-     * @throws ApiError
-     */
-    static aiIndexOrgsUsersDocumentsSourcesCreate({ org, userId, requestBody, }: {
-        org: string;
-        requestBody: RetrieverRequestSearch;
-    }): CancelablePromise<Array<RetrieverRequestSearchDocument>>;
-    /**
-     * 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".
-     * @returns CheckDocumentTrainingStatus
-     * @throws ApiError
-     */
-    static aiIndexOrgsUsersDocumentsTasksRetrieve({ org, taskId, userId, }: {
-        org: string;
-        taskId: string;
-    }): CancelablePromise<CheckDocumentTrainingStatus>;
-    /**
-     * 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.
-     * @returns TrainDocumentViewResponse
-     * @throws ApiError
-     */
-    static aiIndexOrgsUsersDocumentsTrainCreate({ org, userId, formData, }: {
-        org: string;
-        formData: TrainDocumentViewRequest;
-    }): CancelablePromise<TrainDocumentViewResponse>;
-    /**
-     * 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.
-     * @returns RetreiverTrainViewResponse
-     * @throws ApiError
-     */
-    static aiIndexOrgsUsersDocumentsTrainRetrieverCreate({ org, userId, formData, }: {
-        org: string;
-        formData: RetreiverTrainViewRequest;
-    }): CancelablePromise<RetreiverTrainViewResponse>;
-    /**
-     * 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.
-         * @returns TrainChatSessionDocumentView
-         * @throws ApiError
-         */
-    static aiIndexOrgsUsersDocumentsTrainSessionsCreate({ org, sessionId, userId, formData, }: {
-        org: string;
-        sessionId: string;
-        formData: TrainChatSessionDocumentViewRequest;
-    }): CancelablePromise<TrainChatSessionDocumentView>;
-    /**
-     * 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
-     */
-    static aiIndexOrgsUsersResourceDataScrappedRetrieve({ org, resourceId, userId, }: {
-        org: string;
-        resourceId: string;
-    }): CancelablePromise<ResourceScrappedData>;
-    /**
-     * 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
-     */
-    static aiIndexOrgsUsersResourceDataScrappedList({ org, userId, isArchive, isLike, isVideo, searchKey, }: {
-        org: string;
-        isArchive?: boolean | null;
-        isLike?: boolean | null;
-        isVideo?: boolean | null;
-        searchKey?: string;
-    }): CancelablePromise<Array<ResourceScrappedData>>;
-    /**
-     * 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
-     */
-    static aiIndexWebhookScanCreate({ requestBody, }: {
-        requestBody: ScanWebhookRequest;
-    }): CancelablePromise<ScanWebhookResponse>;
-}