@gpuai/sdk 0.1.0

package/docs/EnvironmentsApi.md

@@ -0,0 +1,69 @@
+# EnvironmentsApi
+
+All URIs are relative to *https://api.gpu.ai/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getEnvironments**](EnvironmentsApi.md#getenvironments) | **GET** /environments | List launch environments (no auth required) |
+
+
+
+## getEnvironments
+
+> Environments getEnvironments()
+
+List launch environments (no auth required)
+
+The server-controlled launch environment catalog — the certified framework roster, the selectable version(s) per framework (the version picker), the \"What\'s included\" software lists, and the raw-VM OS catalog. These are exactly the values accepted by the `environment` field of POST /v1/instances.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  EnvironmentsApi,
+} from '@gpuai/sdk';
+import type { GetEnvironmentsRequest } from '@gpuai/sdk';
+
+async function example() {
+  console.log("🚀 Testing @gpuai/sdk SDK...");
+  const api = new EnvironmentsApi();
+
+  try {
+    const data = await api.getEnvironments();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Environments**](Environments.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`, `application/problem+json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | OK |  -  |
+| **0** | Error response (RFC 7807) |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/FileObject.md

@@ -0,0 +1,45 @@
+
+# FileObject
+
+An uploaded file object. The storage location is an internal detail and is intentionally absent from this schema (privacy-by-omission, D6).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`object` | string
+`bytes` | number
+`createdAt` | number
+`filename` | string
+`purpose` | string
+
+## Example
+
+```typescript
+import type { FileObject } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "object": null,
+  "bytes": null,
+  "createdAt": null,
+  "filename": null,
+  "purpose": null,
+} satisfies FileObject
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FileObject
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FineTuningApi.md

@@ -0,0 +1,468 @@
+# FineTuningApi
+
+All URIs are relative to *https://api.gpu.ai/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**cancelFineTuningJob**](FineTuningApi.md#cancelfinetuningjob) | **POST** /fine_tuning/jobs/{id}/cancel | Cancel a fine-tuning job (OpenAI-compatible) |
+| [**createFile**](FineTuningApi.md#createfile) | **POST** /files | Upload a fine-tuning dataset file (OpenAI-compatible) |
+| [**createFineTuningJob**](FineTuningApi.md#createfinetuningjoboperation) | **POST** /fine_tuning/jobs | Create a managed fine-tuning job (OpenAI-compatible) |
+| [**getFineTuningJob**](FineTuningApi.md#getfinetuningjob) | **GET** /fine_tuning/jobs/{id} | Retrieve a fine-tuning job (OpenAI-compatible) |
+| [**listFineTuningJobEvents**](FineTuningApi.md#listfinetuningjobevents) | **GET** /fine_tuning/jobs/{id}/events | List fine-tuning job events (OpenAI-compatible) |
+| [**listFineTuningJobs**](FineTuningApi.md#listfinetuningjobs) | **GET** /fine_tuning/jobs | List fine-tuning jobs (OpenAI-compatible) |
+
+
+
+## cancelFineTuningJob
+
+> FineTuningJob cancelFineTuningJob(id)
+
+Cancel a fine-tuning job (OpenAI-compatible)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FineTuningApi,
+} from '@gpuai/sdk';
+import type { CancelFineTuningJobRequest } from '@gpuai/sdk';
+
+async function example() {
+  console.log("🚀 Testing @gpuai/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new FineTuningApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+  } satisfies CancelFineTuningJobRequest;
+
+  try {
+    const data = await api.cancelFineTuningJob(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**FineTuningJob**](FineTuningJob.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | The cancelled fine-tuning job. |  -  |
+| **401** | Missing or invalid API key (OpenAI error envelope). |  -  |
+| **403** | API key lacks the required scope (OpenAI error envelope). |  -  |
+| **404** | Model or resource not found (OpenAI error envelope). |  -  |
+| **429** | Rate limit exceeded (OpenAI error envelope). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## createFile
+
+> FileObject createFile(purpose, file)
+
+Upload a fine-tuning dataset file (OpenAI-compatible)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FineTuningApi,
+} from '@gpuai/sdk';
+import type { CreateFileRequest } from '@gpuai/sdk';
+
+async function example() {
+  console.log("🚀 Testing @gpuai/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new FineTuningApi(config);
+
+  const body = {
+    // string
+    purpose: purpose_example,
+    // Blob | A JSONL chat-format training dataset.
+    file: BINARY_DATA_HERE,
+  } satisfies CreateFileRequest;
+
+  try {
+    const data = await api.createFile(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **purpose** | `fine-tune` |  | [Defaults to `undefined`] [Enum: fine-tune] |
+| **file** | `Blob` | A JSONL chat-format training dataset. | [Defaults to `undefined`] |
+
+### Return type
+
+[**FileObject**](FileObject.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | The uploaded file object. |  -  |
+| **400** | Invalid request (OpenAI error envelope). |  -  |
+| **401** | Missing or invalid API key (OpenAI error envelope). |  -  |
+| **403** | API key lacks the required scope (OpenAI error envelope). |  -  |
+| **429** | Rate limit exceeded (OpenAI error envelope). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+| **500** | Internal server error (OpenAI error envelope). |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## createFineTuningJob
+
+> FineTuningJob createFineTuningJob(createFineTuningJobRequest)
+
+Create a managed fine-tuning job (OpenAI-compatible)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FineTuningApi,
+} from '@gpuai/sdk';
+import type { CreateFineTuningJobOperationRequest } from '@gpuai/sdk';
+
+async function example() {
+  console.log("🚀 Testing @gpuai/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new FineTuningApi(config);
+
+  const body = {
+    // CreateFineTuningJobRequest
+    createFineTuningJobRequest: ...,
+  } satisfies CreateFineTuningJobOperationRequest;
+
+  try {
+    const data = await api.createFineTuningJob(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createFineTuningJobRequest** | [CreateFineTuningJobRequest](CreateFineTuningJobRequest.md) |  | |
+
+### Return type
+
+[**FineTuningJob**](FineTuningJob.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | The created fine-tuning job. |  -  |
+| **400** | Invalid request (OpenAI error envelope). |  -  |
+| **401** | Missing or invalid API key (OpenAI error envelope). |  -  |
+| **402** | Insufficient balance (OpenAI error envelope, SERV-06). |  -  |
+| **403** | API key lacks the required scope (OpenAI error envelope). |  -  |
+| **404** | Model or resource not found (OpenAI error envelope). |  -  |
+| **422** | Request validation failed (OpenAI error envelope). |  -  |
+| **429** | Rate limit exceeded (OpenAI error envelope). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+| **500** | Internal server error (OpenAI error envelope). |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getFineTuningJob
+
+> FineTuningJob getFineTuningJob(id)
+
+Retrieve a fine-tuning job (OpenAI-compatible)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FineTuningApi,
+} from '@gpuai/sdk';
+import type { GetFineTuningJobRequest } from '@gpuai/sdk';
+
+async function example() {
+  console.log("🚀 Testing @gpuai/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new FineTuningApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+  } satisfies GetFineTuningJobRequest;
+
+  try {
+    const data = await api.getFineTuningJob(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**FineTuningJob**](FineTuningJob.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | The fine-tuning job. |  -  |
+| **401** | Missing or invalid API key (OpenAI error envelope). |  -  |
+| **403** | API key lacks the required scope (OpenAI error envelope). |  -  |
+| **404** | Model or resource not found (OpenAI error envelope). |  -  |
+| **429** | Rate limit exceeded (OpenAI error envelope). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listFineTuningJobEvents
+
+> FineTuningJobEventList listFineTuningJobEvents(id, after, limit)
+
+List fine-tuning job events (OpenAI-compatible)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FineTuningApi,
+} from '@gpuai/sdk';
+import type { ListFineTuningJobEventsRequest } from '@gpuai/sdk';
+
+async function example() {
+  console.log("🚀 Testing @gpuai/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new FineTuningApi(config);
+
+  const body = {
+    // string
+    id: id_example,
+    // string (optional)
+    after: after_example,
+    // number (optional)
+    limit: 56,
+  } satisfies ListFineTuningJobEventsRequest;
+
+  try {
+    const data = await api.listFineTuningJobEvents(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+| **after** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**FineTuningJobEventList**](FineTuningJobEventList.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | A page of fine-tuning job events. |  -  |
+| **401** | Missing or invalid API key (OpenAI error envelope). |  -  |
+| **403** | API key lacks the required scope (OpenAI error envelope). |  -  |
+| **404** | Model or resource not found (OpenAI error envelope). |  -  |
+| **429** | Rate limit exceeded (OpenAI error envelope). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listFineTuningJobs
+
+> FineTuningJobList listFineTuningJobs(after, limit)
+
+List fine-tuning jobs (OpenAI-compatible)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  FineTuningApi,
+} from '@gpuai/sdk';
+import type { ListFineTuningJobsRequest } from '@gpuai/sdk';
+
+async function example() {
+  console.log("🚀 Testing @gpuai/sdk SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new FineTuningApi(config);
+
+  const body = {
+    // string (optional)
+    after: after_example,
+    // number (optional)
+    limit: 56,
+  } satisfies ListFineTuningJobsRequest;
+
+  try {
+    const data = await api.listFineTuningJobs(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **after** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **limit** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**FineTuningJobList**](FineTuningJobList.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | A page of fine-tuning jobs. |  -  |
+| **401** | Missing or invalid API key (OpenAI error envelope). |  -  |
+| **403** | API key lacks the required scope (OpenAI error envelope). |  -  |
+| **429** | Rate limit exceeded (OpenAI error envelope). Retry-After header indicates seconds to wait. |  * Retry-After - Seconds the client should wait before retrying. <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/FineTuningJob.md

@@ -0,0 +1,61 @@
+
+# FineTuningJob
+
+The fine-tuning job object. `status` is the COLLAPSED public enum (the rich internal states are hidden). `result_files` are freshly-presigned, short-lived download URLs regenerated per read. No backing-provider identity is present (D6).
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`object` | string
+`model` | string
+`createdAt` | number
+`finishedAt` | number
+`fineTunedModel` | string
+`status` | string
+`trainingFile` | string
+`resultFiles` | Array<string>
+`error` | [FineTuningJobError](FineTuningJobError.md)
+`method` | [FineTuningJobMethod](FineTuningJobMethod.md)
+`seed` | number
+`suffix` | string
+`metadata` | { [key: string]: any; }
+
+## Example
+
+```typescript
+import type { FineTuningJob } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "object": null,
+  "model": null,
+  "createdAt": null,
+  "finishedAt": null,
+  "fineTunedModel": null,
+  "status": null,
+  "trainingFile": null,
+  "resultFiles": null,
+  "error": null,
+  "method": null,
+  "seed": null,
+  "suffix": null,
+  "metadata": null,
+} satisfies FineTuningJob
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FineTuningJob
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/FineTuningJobError.md

@@ -0,0 +1,38 @@
+
+# FineTuningJobError
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`code` | string
+`message` | string
+`param` | string
+
+## Example
+
+```typescript
+import type { FineTuningJobError } from '@gpuai/sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "code": null,
+  "message": null,
+  "param": null,
+} satisfies FineTuningJobError
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as FineTuningJobError
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+