@iblai/iblai-api 4.6.2-dev1-ai → 4.6.2-dev1-ai-plus

package/src/services/AiFinetuningService.ts

@@ -0,0 +1,472 @@
+/* generated using openapi-typescript-codegen -- do not edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+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';
+import { OpenAPI } from '../core/OpenAPI';
+import { request as __request } from '../core/request';
+export class AiFinetuningService {
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
+     * @returns PaginatedDataSetList
+     * @throws ApiError
+     */
+    public 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> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/',
+            path: {
+                'org': org,
+                'username': username,
+            },
+            query: {
+                'date_created': dateCreated,
+                'num_data_points': numDataPoints,
+                'ordering': ordering,
+                'page': page,
+                'page_size': pageSize,
+                'retry_attempts': retryAttempts,
+                'search': search,
+                'status': status,
+            },
+        });
+    }
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
+     * @returns DataSetCreate
+     * @throws ApiError
+     */
+    public static aiFinetuningV1OrgUserDatasetsCreate({
+        org,
+        username,
+        requestBody,
+    }: {
+        org: string,
+        username: string,
+        requestBody: DataSetCreate,
+    }): CancelablePromise<DataSetCreate> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/',
+            path: {
+                'org': org,
+                'username': username,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
+     * @returns DataSet
+     * @throws ApiError
+     */
+    public static aiFinetuningV1OrgUserDatasetsRetrieve({
+        id,
+        org,
+        username,
+    }: {
+        /**
+         * A UUID string identifying this data set.
+         */
+        id: string,
+        org: string,
+        username: string,
+    }): CancelablePromise<DataSet> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
+            path: {
+                'id': id,
+                'org': org,
+                'username': username,
+            },
+        });
+    }
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
+     * @returns DataSet
+     * @throws ApiError
+     */
+    public static aiFinetuningV1OrgUserDatasetsUpdate({
+        id,
+        org,
+        username,
+        requestBody,
+    }: {
+        /**
+         * A UUID string identifying this data set.
+         */
+        id: string,
+        org: string,
+        username: string,
+        requestBody: DataSet,
+    }): CancelablePromise<DataSet> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
+            path: {
+                'id': id,
+                'org': org,
+                'username': username,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
+     * @returns DataSet
+     * @throws ApiError
+     */
+    public static aiFinetuningV1OrgUserDatasetsPartialUpdate({
+        id,
+        org,
+        username,
+        requestBody,
+    }: {
+        /**
+         * A UUID string identifying this data set.
+         */
+        id: string,
+        org: string,
+        username: string,
+        requestBody?: PatchedDataSet,
+    }): CancelablePromise<DataSet> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
+            path: {
+                'id': id,
+                'org': org,
+                'username': username,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
+     * @returns void
+     * @throws ApiError
+     */
+    public static aiFinetuningV1OrgUserDatasetsDestroy({
+        id,
+        org,
+        username,
+    }: {
+        /**
+         * A UUID string identifying this data set.
+         */
+        id: string,
+        org: string,
+        username: string,
+    }): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/api/ai-finetuning/v1/org/{org}/user/{username}/datasets/{id}/',
+            path: {
+                'id': id,
+                'org': org,
+                'username': username,
+            },
+        });
+    }
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
+     * @returns PaginatedTrainingList
+     * @throws ApiError
+     */
+    public 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> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/',
+            path: {
+                'org': org,
+                'username': username,
+            },
+            query: {
+                'base_model_name': baseModelName,
+                'dataset': dataset,
+                'date_created': dateCreated,
+                'fine_tuned_model': fineTunedModel,
+                'last_modified': lastModified,
+                'ordering': ordering,
+                'page': page,
+                'page_size': pageSize,
+                'preprocess_dataset': preprocessDataset,
+                'provider': provider,
+                'search': search,
+                'status': status,
+            },
+        });
+    }
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
+     * @returns TrainingCreate
+     * @throws ApiError
+     */
+    public static aiFinetuningV1OrgUserTrainingsCreate({
+        org,
+        username,
+        requestBody,
+    }: {
+        org: string,
+        username: string,
+        requestBody: TrainingCreate,
+    }): CancelablePromise<TrainingCreate> {
+        return __request(OpenAPI, {
+            method: 'POST',
+            url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/',
+            path: {
+                'org': org,
+                'username': username,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
+     * @returns Training
+     * @throws ApiError
+     */
+    public static aiFinetuningV1OrgUserTrainingsRetrieve({
+        id,
+        org,
+        username,
+    }: {
+        /**
+         * A UUID string identifying this training.
+         */
+        id: string,
+        org: string,
+        username: string,
+    }): CancelablePromise<Training> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
+            path: {
+                'id': id,
+                'org': org,
+                'username': username,
+            },
+        });
+    }
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
+     * @returns TrainingCreate
+     * @throws ApiError
+     */
+    public static aiFinetuningV1OrgUserTrainingsUpdate({
+        id,
+        org,
+        username,
+        requestBody,
+    }: {
+        /**
+         * A UUID string identifying this training.
+         */
+        id: string,
+        org: string,
+        username: string,
+        requestBody: TrainingCreate,
+    }): CancelablePromise<TrainingCreate> {
+        return __request(OpenAPI, {
+            method: 'PUT',
+            url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
+            path: {
+                'id': id,
+                'org': org,
+                'username': username,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
+     * @returns TrainingCreate
+     * @throws ApiError
+     */
+    public static aiFinetuningV1OrgUserTrainingsPartialUpdate({
+        id,
+        org,
+        username,
+        requestBody,
+    }: {
+        /**
+         * A UUID string identifying this training.
+         */
+        id: string,
+        org: string,
+        username: string,
+        requestBody?: PatchedTrainingCreate,
+    }): CancelablePromise<TrainingCreate> {
+        return __request(OpenAPI, {
+            method: 'PATCH',
+            url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
+            path: {
+                'id': id,
+                'org': org,
+                'username': username,
+            },
+            body: requestBody,
+            mediaType: 'application/json',
+        });
+    }
+    /**
+     * Mixin that includes the StudentTokenAuthentication and IsPlatformAdmin
+     * @returns void
+     * @throws ApiError
+     */
+    public static aiFinetuningV1OrgUserTrainingsDestroy({
+        id,
+        org,
+        username,
+    }: {
+        /**
+         * A UUID string identifying this training.
+         */
+        id: string,
+        org: string,
+        username: string,
+    }): CancelablePromise<void> {
+        return __request(OpenAPI, {
+            method: 'DELETE',
+            url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/{id}/',
+            path: {
+                'id': id,
+                'org': org,
+                'username': username,
+            },
+        });
+    }
+    /**
+     * 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
+     */
+    public static aiFinetuningV1OrgUserTrainingsFinetunedModelsRetrieve({
+        org,
+        username,
+    }: {
+        org: string,
+        username: string,
+    }): CancelablePromise<Training> {
+        return __request(OpenAPI, {
+            method: 'GET',
+            url: '/api/ai-finetuning/v1/org/{org}/user/{username}/trainings/finetuned-models/',
+            path: {
+                'org': org,
+                'username': username,
+            },
+        });
+    }
+}