@iblai/iblai-api 3.34.5-ai

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

@@ -0,0 +1,344 @@
+import type { CheckDocumentTrainingStatus } from '../models/CheckDocumentTrainingStatus';
+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.
+     * @param documentId
+     * @param org
+     * @param userId
+     * @returns RetrieverDocumentEmbedding
+     * @throws ApiError
+     */
+    static aiIndexOrgsUsersDocumentsRetrieve(documentId: string, org: string, userId: 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.
+     * @param documentId
+     * @param org
+     * @param userId
+     * @param requestBody
+     * @returns RetrieverDocumentEmbedding
+     * @throws ApiError
+     */
+    static aiIndexOrgsUsersDocumentsUpdate(documentId: string, org: string, userId: string, requestBody: 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.
+     * @param documentId
+     * @param org
+     * @param userId
+     * @returns void
+     * @throws ApiError
+     */
+    static aiIndexOrgsUsersDocumentsDestroy(documentId: string, org: string, userId: string): CancelablePromise<void>;
+    /**
+     * 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 requestBody
+     * @returns TrainDocumentViewResponse
+     * @throws ApiError
+     */
+    static aiIndexOrgsUsersDocumentsGraphTrainCreate(org: string, userId: string, requestBody: TrainDocumentViewRequest): CancelablePromise<TrainDocumentViewResponse>;
+    /**
+     * 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
+     */
+    static aiIndexOrgsUsersDocumentsPathwaysList(org: string, pathway: string, userId: string): CancelablePromise<Array<RetrieverDocumentEmbedding>>;
+    /**
+     * 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
+     */
+    static aiIndexOrgsUsersDocumentsSearchCreate(org: string, userId: 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.
+     * @param org
+     * @param userId
+     * @param requestBody
+     * @returns RetrieverRequestSearchDocument
+     * @throws ApiError
+     */
+    static aiIndexOrgsUsersDocumentsSourcesCreate(org: string, userId: 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".
+     * @param org
+     * @param taskId
+     * @param userId
+     * @returns CheckDocumentTrainingStatus
+     * @throws ApiError
+     */
+    static aiIndexOrgsUsersDocumentsTasksRetrieve(org: string, taskId: string, userId: 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.
+     * @param org
+     * @param userId
+     * @param requestBody
+     * @returns TrainDocumentViewResponse
+     * @throws ApiError
+     */
+    static aiIndexOrgsUsersDocumentsTrainCreate(org: string, userId: string, requestBody: 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.
+     * @param org
+     * @param userId
+     * @param requestBody
+     * @returns RetreiverTrainViewResponse
+     * @throws ApiError
+     */
+    static aiIndexOrgsUsersDocumentsTrainRetrieverCreate(org: string, userId: string, requestBody: RetreiverTrainViewRequest): CancelablePromise<RetreiverTrainViewResponse>;
+    /**
+     * Process and train a document for use in a specific chat session.
+     *
+     * This endpoint allows uploading a document during a chat session,
+     * which will be processed and made available for the AI to reference
+     * when responding to queries in that session.
+     *
+     * Args:
+     * request: The HTTP request containing the file to process.
+     * org: Organization key identifier.
+     * session_id: The ID of the chat session to associate the document with.
+     *
+     * Returns:
+     * Response: A confirmation that the file was processed successfully.
+     *
+     * Raises:
+     * BadRequest: If the file is invalid, unsupported, or cannot be processed.
+     * RequestEntityTooLarge: If the file exceeds the maximum allowed size.
+     * @param org
+     * @param sessionId
+     * @param userId
+     * @param requestBody
+     * @returns TrainChatSessionDocumentView
+     * @throws ApiError
+     */
+    static aiIndexOrgsUsersDocumentsTrainSessionsCreate(org: string, sessionId: string, userId: string, requestBody: 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.
+     * @param org
+     * @param resourceId
+     * @param userId
+     * @returns ResourceScrappedData
+     * @throws ApiError
+     */
+    static aiIndexOrgsUsersResourceDataScrappedRetrieve(org: string, resourceId: string, userId: 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.
+     * @param org
+     * @param userId
+     * @param isArchive
+     * @param isLike
+     * @param isVideo
+     * @param searchKey
+     * @returns ResourceScrappedData
+     * @throws ApiError
+     */
+    static aiIndexOrgsUsersResourceDataScrappedList(org: string, userId: 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.
+     * @param requestBody
+     * @returns ScanWebhookResponse
+     * @throws ApiError
+     */
+    static aiIndexWebhookScanCreate(requestBody: ScanWebhookRequest): CancelablePromise<ScanWebhookResponse>;
+}

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

@@ -0,0 +1,34 @@
+import type { HeygenMarketingVideoDetail } from '../models/HeygenMarketingVideoDetail';
+import type { HeygenMarketingVideoList } from '../models/HeygenMarketingVideoList';
+import type { PaginatedHeygenMarketingVideoListList } from '../models/PaginatedHeygenMarketingVideoListList';
+import type { CancelablePromise } from '../core/CancelablePromise';
+export declare class AiMarketingService {
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
+     * @param org
+     * @param userId
+     * @param page A page number within the paginated result set.
+     * @param pageSize Number of results to return per page.
+     * @returns PaginatedHeygenMarketingVideoListList
+     * @throws ApiError
+     */
+    static aiMarketingOrgsUsersHeygenVideosList(org: string, userId: string, page?: number, pageSize?: number): CancelablePromise<PaginatedHeygenMarketingVideoListList>;
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
+     * @param org
+     * @param userId
+     * @param requestBody
+     * @returns HeygenMarketingVideoList
+     * @throws ApiError
+     */
+    static aiMarketingOrgsUsersHeygenVideosCreate(org: string, userId: string, requestBody?: HeygenMarketingVideoList): CancelablePromise<HeygenMarketingVideoList>;
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
+     * @param name
+     * @param org
+     * @param userId
+     * @returns HeygenMarketingVideoDetail
+     * @throws ApiError
+     */
+    static aiMarketingOrgsUsersHeygenVideosRetrieve(name: string, org: string, userId: string): CancelablePromise<HeygenMarketingVideoDetail>;
+}