@iblai/iblai-api 4.131.1-ai → 4.131.2-core

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

@@ -1,232 +0,0 @@
-import type { DataSet } from '../models/DataSet';
-import type { DataSetCreate } from '../models/DataSetCreate';
-import type { PaginatedDataSetList } from '../models/PaginatedDataSetList';
-import type { PaginatedTrainingList } from '../models/PaginatedTrainingList';
-import type { PatchedDataSet } from '../models/PatchedDataSet';
-import type { PatchedTrainingCreate } from '../models/PatchedTrainingCreate';
-import type { Training } from '../models/Training';
-import type { TrainingCreate } from '../models/TrainingCreate';
-import type { CancelablePromise } from '../core/CancelablePromise';
-export declare class AiFinetuningService {
-    /**
-     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @returns PaginatedDataSetList
-     * @throws ApiError
-     */
-    static aiFinetuningV1OrgUserDatasetsList({ org, username, dateCreated, numDataPoints, ordering, page, pageSize, retryAttempts, search, status, }: {
-        org: string;
-        username: string;
-        dateCreated?: string;
-        numDataPoints?: number;
-        /**
-         * Which field to use when ordering the results.
-         */
-        ordering?: string;
-        /**
-         * A page number within the paginated result set.
-         */
-        page?: number;
-        /**
-         * Number of results to return per page.
-         */
-        pageSize?: number;
-        retryAttempts?: number;
-        /**
-         * A search term.
-         */
-        search?: string;
-        /**
-         * * `pending` - Pending
-         * * `processing` - Processing
-         * * `completed` - Completed
-         * * `failed` - Failed
-         */
-        status?: 'completed' | 'failed' | 'pending' | 'processing';
-    }): CancelablePromise<PaginatedDataSetList>;
-    /**
-     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @returns DataSetCreate
-     * @throws ApiError
-     */
-    static aiFinetuningV1OrgUserDatasetsCreate({ org, username, requestBody, }: {
-        org: string;
-        username: string;
-        requestBody: DataSetCreate;
-    }): CancelablePromise<DataSetCreate>;
-    /**
-     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @returns DataSet
-     * @throws ApiError
-     */
-    static aiFinetuningV1OrgUserDatasetsRetrieve({ id, org, username, }: {
-        /**
-         * A UUID string identifying this data set.
-         */
-        id: string;
-        org: string;
-        username: string;
-    }): CancelablePromise<DataSet>;
-    /**
-     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @returns DataSet
-     * @throws ApiError
-     */
-    static aiFinetuningV1OrgUserDatasetsUpdate({ id, org, username, requestBody, }: {
-        /**
-         * A UUID string identifying this data set.
-         */
-        id: string;
-        org: string;
-        username: string;
-        requestBody: DataSet;
-    }): CancelablePromise<DataSet>;
-    /**
-     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @returns DataSet
-     * @throws ApiError
-     */
-    static aiFinetuningV1OrgUserDatasetsPartialUpdate({ id, org, username, requestBody, }: {
-        /**
-         * A UUID string identifying this data set.
-         */
-        id: string;
-        org: string;
-        username: string;
-        requestBody?: PatchedDataSet;
-    }): CancelablePromise<DataSet>;
-    /**
-     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @returns void
-     * @throws ApiError
-     */
-    static aiFinetuningV1OrgUserDatasetsDestroy({ id, org, username, }: {
-        /**
-         * A UUID string identifying this data set.
-         */
-        id: string;
-        org: string;
-        username: string;
-    }): CancelablePromise<void>;
-    /**
-     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @returns PaginatedTrainingList
-     * @throws ApiError
-     */
-    static aiFinetuningV1OrgUserTrainingsList({ org, username, baseModelName, dataset, dateCreated, fineTunedModel, lastModified, ordering, page, pageSize, preprocessDataset, provider, search, status, }: {
-        org: string;
-        username: string;
-        baseModelName?: string;
-        dataset?: string;
-        dateCreated?: string;
-        fineTunedModel?: string;
-        lastModified?: string;
-        /**
-         * Which field to use when ordering the results.
-         */
-        ordering?: string;
-        /**
-         * A page number within the paginated result set.
-         */
-        page?: number;
-        /**
-         * Number of results to return per page.
-         */
-        pageSize?: number;
-        preprocessDataset?: boolean;
-        /**
-         * * `openai` - Openai
-         */
-        provider?: 'openai';
-        /**
-         * A search term.
-         */
-        search?: string;
-        /**
-         * * `pending` - Pending
-         * * `processing` - Processing
-         * * `completed` - Completed
-         * * `cancelled` - Cancelled
-         * * `failed` - Failed
-         */
-        status?: 'cancelled' | 'completed' | 'failed' | 'pending' | 'processing';
-    }): CancelablePromise<PaginatedTrainingList>;
-    /**
-     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @returns TrainingCreate
-     * @throws ApiError
-     */
-    static aiFinetuningV1OrgUserTrainingsCreate({ org, username, requestBody, }: {
-        org: string;
-        username: string;
-        requestBody: TrainingCreate;
-    }): CancelablePromise<TrainingCreate>;
-    /**
-     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @returns Training
-     * @throws ApiError
-     */
-    static aiFinetuningV1OrgUserTrainingsRetrieve({ id, org, username, }: {
-        /**
-         * A UUID string identifying this training.
-         */
-        id: string;
-        org: string;
-        username: string;
-    }): CancelablePromise<Training>;
-    /**
-     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @returns TrainingCreate
-     * @throws ApiError
-     */
-    static aiFinetuningV1OrgUserTrainingsUpdate({ id, org, username, requestBody, }: {
-        /**
-         * A UUID string identifying this training.
-         */
-        id: string;
-        org: string;
-        username: string;
-        requestBody: TrainingCreate;
-    }): CancelablePromise<TrainingCreate>;
-    /**
-     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @returns TrainingCreate
-     * @throws ApiError
-     */
-    static aiFinetuningV1OrgUserTrainingsPartialUpdate({ id, org, username, requestBody, }: {
-        /**
-         * A UUID string identifying this training.
-         */
-        id: string;
-        org: string;
-        username: string;
-        requestBody?: PatchedTrainingCreate;
-    }): CancelablePromise<TrainingCreate>;
-    /**
-     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @returns void
-     * @throws ApiError
-     */
-    static aiFinetuningV1OrgUserTrainingsDestroy({ id, org, username, }: {
-        /**
-         * A UUID string identifying this training.
-         */
-        id: string;
-        org: string;
-        username: string;
-    }): CancelablePromise<void>;
-    /**
-     * Retrieves a paginated list of completed fine-tuned models, excluding those without a fine-tuned model.
-     * Filtering and pagination is allowed.
-     *
-     * NB: This is only a helper endpoint. The same functionality can be achieved with the appropriate filters using the
-     * training list endpoint.
-     * Returns:
-     * Response: A paginated response containing the serialized fine-tuned models.
-     * @returns Training
-     * @throws ApiError
-     */
-    static aiFinetuningV1OrgUserTrainingsFinetunedModelsRetrieve({ org, username, }: {
-        org: string;
-        username: string;
-    }): CancelablePromise<Training>;
-}

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

@@ -1,355 +0,0 @@
-import type { CheckDocumentTrainingStatus } from '../models/CheckDocumentTrainingStatus';
-import type { DocumentFromPoolRequest } from '../models/DocumentFromPoolRequest';
-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 { 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 document from the document pool
-     *
-     * Sample request:
-     * ```json
-     * {"document_id": 3, "to_pathway": "7c43ec09-3d37-489c-a461-8d73df1d91c7"}
-     * ```
-     * @returns TrainDocumentViewResponse
-     * @throws ApiError
-     */
-    static aiIndexOrgsUsersDocumentsDocumentFromPoolCreate({ org, userId, requestBody, }: {
-        org: string;
-        requestBody: DocumentFromPoolRequest;
-    }): 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>;
-    /**
-     * 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>;
-}

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

@@ -1,38 +0,0 @@
-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
-     * @returns PaginatedHeygenMarketingVideoListList
-     * @throws ApiError
-     */
-    static aiMarketingOrgsUsersHeygenVideosList({ org, userId, page, pageSize, }: {
-        org: string; /**
-         * A page number within the paginated result set.
-         */
-        page?: number; /**
-         * Number of results to return per page.
-         */
-        pageSize?: number;
-    }): CancelablePromise<PaginatedHeygenMarketingVideoListList>;
-    /**
-     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @returns HeygenMarketingVideoList
-     * @throws ApiError
-     */
-    static aiMarketingOrgsUsersHeygenVideosCreate({ org, userId, requestBody, }: {
-        org: string;
-        requestBody?: HeygenMarketingVideoList;
-    }): CancelablePromise<HeygenMarketingVideoList>;
-    /**
-     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
-     * @returns HeygenMarketingVideoDetail
-     * @throws ApiError
-     */
-    static aiMarketingOrgsUsersHeygenVideosRetrieve({ name, org, userId, }: {
-        name: string;
-        org: string;
-    }): CancelablePromise<HeygenMarketingVideoDetail>;
-}