@gpuai/sdk 0.5.0 → 0.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/README.md +7 -2
  3. package/dist/apis/InferenceApi.d.ts +60 -0
  4. package/dist/apis/InferenceApi.js +126 -1
  5. package/dist/esm/apis/InferenceApi.d.ts +60 -0
  6. package/dist/esm/apis/InferenceApi.js +125 -0
  7. package/dist/esm/models/DataRetention.d.ts +51 -0
  8. package/dist/esm/models/DataRetention.js +57 -0
  9. package/dist/esm/models/Model.d.ts +6 -0
  10. package/dist/esm/models/Model.js +2 -0
  11. package/dist/esm/models/OfferingAlternative.d.ts +68 -0
  12. package/dist/esm/models/OfferingAlternative.js +67 -0
  13. package/dist/esm/models/OperationError.d.ts +20 -1
  14. package/dist/esm/models/OperationError.js +7 -0
  15. package/dist/esm/models/Problem.d.ts +1 -0
  16. package/dist/esm/models/Problem.js +1 -0
  17. package/dist/esm/models/UpdateDataRetentionRequest.d.ts +32 -0
  18. package/dist/esm/models/UpdateDataRetentionRequest.js +43 -0
  19. package/dist/esm/models/index.d.ts +3 -0
  20. package/dist/esm/models/index.js +3 -0
  21. package/dist/esm/runtime.js +1 -1
  22. package/dist/models/DataRetention.d.ts +51 -0
  23. package/dist/models/DataRetention.js +65 -0
  24. package/dist/models/Model.d.ts +6 -0
  25. package/dist/models/Model.js +2 -0
  26. package/dist/models/OfferingAlternative.d.ts +68 -0
  27. package/dist/models/OfferingAlternative.js +74 -0
  28. package/dist/models/OperationError.d.ts +20 -1
  29. package/dist/models/OperationError.js +7 -0
  30. package/dist/models/Problem.d.ts +1 -0
  31. package/dist/models/Problem.js +1 -0
  32. package/dist/models/UpdateDataRetentionRequest.d.ts +32 -0
  33. package/dist/models/UpdateDataRetentionRequest.js +50 -0
  34. package/dist/models/index.d.ts +3 -0
  35. package/dist/models/index.js +3 -0
  36. package/dist/runtime.js +1 -1
  37. package/docs/DataRetention.md +38 -0
  38. package/docs/FineTuningApi.md +2 -2
  39. package/docs/InferenceApi.md +163 -12
  40. package/docs/Model.md +2 -0
  41. package/docs/OfferingAlternative.md +47 -0
  42. package/docs/OperationError.md +6 -0
  43. package/docs/UpdateDataRetentionRequest.md +34 -0
  44. package/package.json +1 -1
  45. package/src/apis/InferenceApi.ts +162 -0
  46. package/src/models/DataRetention.ts +95 -0
  47. package/src/models/Model.ts +8 -0
  48. package/src/models/OfferingAlternative.ts +120 -0
  49. package/src/models/OperationError.ts +33 -1
  50. package/src/models/Problem.ts +1 -0
  51. package/src/models/UpdateDataRetentionRequest.ts +66 -0
  52. package/src/models/index.ts +3 -0
  53. package/src/runtime.ts +1 -1
@@ -0,0 +1,68 @@
1
+ /**
2
+ * GPU.ai Public Developer API
3
+ * Programmatic API for GPU.ai. Authenticate with API keys minted from the dashboard. See https://gpu.ai/docs for details.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@gpu.ai
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * A live catalog row a launch whose pinned offering was gone could take instead. Same fields and meaning as the matching GET /pricing row.
14
+ * @export
15
+ * @interface OfferingAlternative
16
+ */
17
+ export interface OfferingAlternative {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof OfferingAlternative
22
+ */
23
+ offeringId: string;
24
+ /**
25
+ *
26
+ * @type {string}
27
+ * @memberof OfferingAlternative
28
+ */
29
+ gpuType: string;
30
+ /**
31
+ *
32
+ * @type {number}
33
+ * @memberof OfferingAlternative
34
+ */
35
+ gpuCount: number;
36
+ /**
37
+ *
38
+ * @type {string}
39
+ * @memberof OfferingAlternative
40
+ */
41
+ region: string;
42
+ /**
43
+ *
44
+ * @type {string}
45
+ * @memberof OfferingAlternative
46
+ */
47
+ tier: string;
48
+ /**
49
+ *
50
+ * @type {number}
51
+ * @memberof OfferingAlternative
52
+ */
53
+ pricePerHour: number;
54
+ /**
55
+ *
56
+ * @type {number}
57
+ * @memberof OfferingAlternative
58
+ */
59
+ available: number;
60
+ }
61
+ /**
62
+ * Check if a given object implements the OfferingAlternative interface.
63
+ */
64
+ export declare function instanceOfOfferingAlternative(value: object): value is OfferingAlternative;
65
+ export declare function OfferingAlternativeFromJSON(json: any): OfferingAlternative;
66
+ export declare function OfferingAlternativeFromJSONTyped(json: any, ignoreDiscriminator: boolean): OfferingAlternative;
67
+ export declare function OfferingAlternativeToJSON(json: any): OfferingAlternative;
68
+ export declare function OfferingAlternativeToJSONTyped(value?: OfferingAlternative | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,74 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * GPU.ai Public Developer API
6
+ * Programmatic API for GPU.ai. Authenticate with API keys minted from the dashboard. See https://gpu.ai/docs for details.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: support@gpu.ai
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfOfferingAlternative = instanceOfOfferingAlternative;
17
+ exports.OfferingAlternativeFromJSON = OfferingAlternativeFromJSON;
18
+ exports.OfferingAlternativeFromJSONTyped = OfferingAlternativeFromJSONTyped;
19
+ exports.OfferingAlternativeToJSON = OfferingAlternativeToJSON;
20
+ exports.OfferingAlternativeToJSONTyped = OfferingAlternativeToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the OfferingAlternative interface.
23
+ */
24
+ function instanceOfOfferingAlternative(value) {
25
+ if ((!('offeringId' in value) && !('offering_id' in value)) || (value['offeringId'] === undefined && value['offering_id'] === undefined))
26
+ return false;
27
+ if ((!('gpuType' in value) && !('gpu_type' in value)) || (value['gpuType'] === undefined && value['gpu_type'] === undefined))
28
+ return false;
29
+ if ((!('gpuCount' in value) && !('gpu_count' in value)) || (value['gpuCount'] === undefined && value['gpu_count'] === undefined))
30
+ return false;
31
+ if (!('region' in value) || value['region'] === undefined)
32
+ return false;
33
+ if (!('tier' in value) || value['tier'] === undefined)
34
+ return false;
35
+ if ((!('pricePerHour' in value) && !('price_per_hour' in value)) || (value['pricePerHour'] === undefined && value['price_per_hour'] === undefined))
36
+ return false;
37
+ if (!('available' in value) || value['available'] === undefined)
38
+ return false;
39
+ return true;
40
+ }
41
+ function OfferingAlternativeFromJSON(json) {
42
+ return OfferingAlternativeFromJSONTyped(json, false);
43
+ }
44
+ function OfferingAlternativeFromJSONTyped(json, ignoreDiscriminator) {
45
+ if (json == null) {
46
+ return json;
47
+ }
48
+ return {
49
+ 'offeringId': json['offering_id'],
50
+ 'gpuType': json['gpu_type'],
51
+ 'gpuCount': json['gpu_count'],
52
+ 'region': json['region'],
53
+ 'tier': json['tier'],
54
+ 'pricePerHour': json['price_per_hour'],
55
+ 'available': json['available'],
56
+ };
57
+ }
58
+ function OfferingAlternativeToJSON(json) {
59
+ return OfferingAlternativeToJSONTyped(json, false);
60
+ }
61
+ function OfferingAlternativeToJSONTyped(value, ignoreDiscriminator = false) {
62
+ if (value == null) {
63
+ return value;
64
+ }
65
+ return {
66
+ 'offering_id': value['offeringId'],
67
+ 'gpu_type': value['gpuType'],
68
+ 'gpu_count': value['gpuCount'],
69
+ 'region': value['region'],
70
+ 'tier': value['tier'],
71
+ 'price_per_hour': value['pricePerHour'],
72
+ 'available': value['available'],
73
+ };
74
+ }
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { OfferingAlternative } from './OfferingAlternative';
12
13
  /**
13
14
  *
14
15
  * @export
@@ -16,7 +17,7 @@
16
17
  */
17
18
  export interface OperationError {
18
19
  /**
19
- *
20
+ * Stable machine-readable failure code (see Problem.code), for example operation_failed (retryable after a backoff), price_changed or offering_unavailable (not retryable as sent).
20
21
  * @type {string}
21
22
  * @memberof OperationError
22
23
  */
@@ -27,6 +28,24 @@ export interface OperationError {
27
28
  * @memberof OperationError
28
29
  */
29
30
  detail?: string;
31
+ /**
32
+ * Present only when code is offering_unavailable: up to three live catalog rows of the same GPU type, count and tier, cheapest first. Pass one's offering_id as the new pin.
33
+ * @type {Array<OfferingAlternative>}
34
+ * @memberof OperationError
35
+ */
36
+ alternatives?: Array<OfferingAlternative>;
37
+ /**
38
+ * Present only when code is price_changed: the live hourly price the launch found.
39
+ * @type {number}
40
+ * @memberof OperationError
41
+ */
42
+ currentPricePerHour?: number;
43
+ /**
44
+ * Present only when code is price_changed: the hourly price the launch was approved at (max_price_per_hour, or the viewed price). Relaunch with max_price_per_hour of at least current_price_per_hour to accept the new price.
45
+ * @type {number}
46
+ * @memberof OperationError
47
+ */
48
+ maxPricePerHour?: number;
30
49
  }
31
50
  /**
32
51
  * Check if a given object implements the OperationError interface.
@@ -18,6 +18,7 @@ exports.OperationErrorFromJSON = OperationErrorFromJSON;
18
18
  exports.OperationErrorFromJSONTyped = OperationErrorFromJSONTyped;
19
19
  exports.OperationErrorToJSON = OperationErrorToJSON;
20
20
  exports.OperationErrorToJSONTyped = OperationErrorToJSONTyped;
21
+ const OfferingAlternative_1 = require("./OfferingAlternative");
21
22
  /**
22
23
  * Check if a given object implements the OperationError interface.
23
24
  */
@@ -34,6 +35,9 @@ function OperationErrorFromJSONTyped(json, ignoreDiscriminator) {
34
35
  return {
35
36
  'code': json['code'] == null ? undefined : json['code'],
36
37
  'detail': json['detail'] == null ? undefined : json['detail'],
38
+ 'alternatives': json['alternatives'] == null ? undefined : (json['alternatives'].map(OfferingAlternative_1.OfferingAlternativeFromJSON)),
39
+ 'currentPricePerHour': json['current_price_per_hour'] == null ? undefined : json['current_price_per_hour'],
40
+ 'maxPricePerHour': json['max_price_per_hour'] == null ? undefined : json['max_price_per_hour'],
37
41
  };
38
42
  }
39
43
  function OperationErrorToJSON(json) {
@@ -46,5 +50,8 @@ function OperationErrorToJSONTyped(value, ignoreDiscriminator = false) {
46
50
  return {
47
51
  'code': value['code'],
48
52
  'detail': value['detail'],
53
+ 'alternatives': value['alternatives'] == null ? undefined : (value['alternatives'].map(OfferingAlternative_1.OfferingAlternativeToJSON)),
54
+ 'current_price_per_hour': value['currentPricePerHour'],
55
+ 'max_price_per_hour': value['maxPricePerHour'],
49
56
  };
50
57
  }
@@ -69,6 +69,7 @@ export declare const ProblemCodeEnum: {
69
69
  readonly ModelTooLarge: "model_too_large";
70
70
  readonly GpuVramTooSmall: "gpu_vram_too_small";
71
71
  readonly PriceChanged: "price_changed";
72
+ readonly OfferingUnavailable: "offering_unavailable";
72
73
  readonly DedicatedIpLimit: "dedicated_ip_limit";
73
74
  readonly DedicatedIpUnavailable: "dedicated_ip_unavailable";
74
75
  readonly InsufficientBalance: "insufficient_balance";
@@ -36,6 +36,7 @@ exports.ProblemCodeEnum = {
36
36
  ModelTooLarge: 'model_too_large',
37
37
  GpuVramTooSmall: 'gpu_vram_too_small',
38
38
  PriceChanged: 'price_changed',
39
+ OfferingUnavailable: 'offering_unavailable',
39
40
  DedicatedIpLimit: 'dedicated_ip_limit',
40
41
  DedicatedIpUnavailable: 'dedicated_ip_unavailable',
41
42
  InsufficientBalance: 'insufficient_balance',
@@ -0,0 +1,32 @@
1
+ /**
2
+ * GPU.ai Public Developer API
3
+ * Programmatic API for GPU.ai. Authenticate with API keys minted from the dashboard. See https://gpu.ai/docs for details.
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@gpu.ai
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface UpdateDataRetentionRequest
16
+ */
17
+ export interface UpdateDataRetentionRequest {
18
+ /**
19
+ *
20
+ * @type {boolean}
21
+ * @memberof UpdateDataRetentionRequest
22
+ */
23
+ zeroDataRetention: boolean;
24
+ }
25
+ /**
26
+ * Check if a given object implements the UpdateDataRetentionRequest interface.
27
+ */
28
+ export declare function instanceOfUpdateDataRetentionRequest(value: object): value is UpdateDataRetentionRequest;
29
+ export declare function UpdateDataRetentionRequestFromJSON(json: any): UpdateDataRetentionRequest;
30
+ export declare function UpdateDataRetentionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateDataRetentionRequest;
31
+ export declare function UpdateDataRetentionRequestToJSON(json: any): UpdateDataRetentionRequest;
32
+ export declare function UpdateDataRetentionRequestToJSONTyped(value?: UpdateDataRetentionRequest | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,50 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * GPU.ai Public Developer API
6
+ * Programmatic API for GPU.ai. Authenticate with API keys minted from the dashboard. See https://gpu.ai/docs for details.
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ * Contact: support@gpu.ai
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfUpdateDataRetentionRequest = instanceOfUpdateDataRetentionRequest;
17
+ exports.UpdateDataRetentionRequestFromJSON = UpdateDataRetentionRequestFromJSON;
18
+ exports.UpdateDataRetentionRequestFromJSONTyped = UpdateDataRetentionRequestFromJSONTyped;
19
+ exports.UpdateDataRetentionRequestToJSON = UpdateDataRetentionRequestToJSON;
20
+ exports.UpdateDataRetentionRequestToJSONTyped = UpdateDataRetentionRequestToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the UpdateDataRetentionRequest interface.
23
+ */
24
+ function instanceOfUpdateDataRetentionRequest(value) {
25
+ if ((!('zeroDataRetention' in value) && !('zero_data_retention' in value)) || (value['zeroDataRetention'] === undefined && value['zero_data_retention'] === undefined))
26
+ return false;
27
+ return true;
28
+ }
29
+ function UpdateDataRetentionRequestFromJSON(json) {
30
+ return UpdateDataRetentionRequestFromJSONTyped(json, false);
31
+ }
32
+ function UpdateDataRetentionRequestFromJSONTyped(json, ignoreDiscriminator) {
33
+ if (json == null) {
34
+ return json;
35
+ }
36
+ return {
37
+ 'zeroDataRetention': json['zero_data_retention'],
38
+ };
39
+ }
40
+ function UpdateDataRetentionRequestToJSON(json) {
41
+ return UpdateDataRetentionRequestToJSONTyped(json, false);
42
+ }
43
+ function UpdateDataRetentionRequestToJSONTyped(value, ignoreDiscriminator = false) {
44
+ if (value == null) {
45
+ return value;
46
+ }
47
+ return {
48
+ 'zero_data_retention': value['zeroDataRetention'],
49
+ };
50
+ }
@@ -35,6 +35,7 @@ export * from './CreateRegistryCredentialRequest';
35
35
  export * from './CreateSshKeyRequest';
36
36
  export * from './CreateWebhookEndpointRequest';
37
37
  export * from './CryptoDeposit';
38
+ export * from './DataRetention';
38
39
  export * from './DedicatedIPRequest';
39
40
  export * from './Embedding';
40
41
  export * from './EmbeddingsRequest';
@@ -88,6 +89,7 @@ export * from './ModelList';
88
89
  export * from './ModelParametersInner';
89
90
  export * from './ModelPricing';
90
91
  export * from './ModelRate';
92
+ export * from './OfferingAlternative';
91
93
  export * from './OpenAIErrorEnvelope';
92
94
  export * from './OpenAIErrorEnvelopeError';
93
95
  export * from './Operation';
@@ -109,6 +111,7 @@ export * from './TemplateEnvInner';
109
111
  export * from './TemplateList';
110
112
  export * from './TemplatePortsInner';
111
113
  export * from './UpdateBillingDetailsRequest';
114
+ export * from './UpdateDataRetentionRequest';
112
115
  export * from './UpdateInstanceRequest';
113
116
  export * from './UpdateSpendingLimitRequest';
114
117
  export * from './Usage';
@@ -53,6 +53,7 @@ __exportStar(require("./CreateRegistryCredentialRequest"), exports);
53
53
  __exportStar(require("./CreateSshKeyRequest"), exports);
54
54
  __exportStar(require("./CreateWebhookEndpointRequest"), exports);
55
55
  __exportStar(require("./CryptoDeposit"), exports);
56
+ __exportStar(require("./DataRetention"), exports);
56
57
  __exportStar(require("./DedicatedIPRequest"), exports);
57
58
  __exportStar(require("./Embedding"), exports);
58
59
  __exportStar(require("./EmbeddingsRequest"), exports);
@@ -106,6 +107,7 @@ __exportStar(require("./ModelList"), exports);
106
107
  __exportStar(require("./ModelParametersInner"), exports);
107
108
  __exportStar(require("./ModelPricing"), exports);
108
109
  __exportStar(require("./ModelRate"), exports);
110
+ __exportStar(require("./OfferingAlternative"), exports);
109
111
  __exportStar(require("./OpenAIErrorEnvelope"), exports);
110
112
  __exportStar(require("./OpenAIErrorEnvelopeError"), exports);
111
113
  __exportStar(require("./Operation"), exports);
@@ -127,6 +129,7 @@ __exportStar(require("./TemplateEnvInner"), exports);
127
129
  __exportStar(require("./TemplateList"), exports);
128
130
  __exportStar(require("./TemplatePortsInner"), exports);
129
131
  __exportStar(require("./UpdateBillingDetailsRequest"), exports);
132
+ __exportStar(require("./UpdateDataRetentionRequest"), exports);
130
133
  __exportStar(require("./UpdateInstanceRequest"), exports);
131
134
  __exportStar(require("./UpdateSpendingLimitRequest"), exports);
132
135
  __exportStar(require("./Usage"), exports);
package/dist/runtime.js CHANGED
@@ -69,7 +69,7 @@ class Configuration {
69
69
  return undefined;
70
70
  }
71
71
  get headers() {
72
- return Object.assign({ 'User-Agent': 'gpuai-sdk-ts/0.5.0' }, this.configuration.headers);
72
+ return Object.assign({ 'User-Agent': 'gpuai-sdk-ts/0.5.2' }, this.configuration.headers);
73
73
  }
74
74
  get credentials() {
75
75
  return this.configuration.credentials;
@@ -0,0 +1,38 @@
1
+
2
+ # DataRetention
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `object` | string
10
+ `zeroDataRetention` | boolean
11
+ `updatedAt` | Date
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { DataRetention } from '@gpuai/sdk'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "object": null,
21
+ "zeroDataRetention": null,
22
+ "updatedAt": null,
23
+ } satisfies DataRetention
24
+
25
+ console.log(example)
26
+
27
+ // Convert the instance to a JSON string
28
+ const exampleJSON: string = JSON.stringify(example)
29
+ console.log(exampleJSON)
30
+
31
+ // Parse the JSON string back to an object
32
+ const exampleParsed = JSON.parse(exampleJSON) as DataRetention
33
+ console.log(exampleParsed)
34
+ ```
35
+
36
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
37
+
38
+
@@ -155,7 +155,7 @@ example().catch(console.error);
155
155
  | Status code | Description | Response headers |
156
156
  |-------------|-------------|------------------|
157
157
  | **200** | The uploaded file object. | - |
158
- | **400** | Invalid request (OpenAI error envelope). | - |
158
+ | **400** | Invalid request (OpenAI error envelope). On inference routes this includes &#x60;zero_data_retention_unavailable&#x60; when zero data retention is required and the model has no zero-data-retention host. | - |
159
159
  | **401** | Missing or invalid API key (OpenAI error envelope). | - |
160
160
  | **403** | API key lacks the required scope (OpenAI error envelope). | - |
161
161
  | **429** | Rate limit exceeded (OpenAI error envelope). Retry-After header indicates seconds to wait. | * Retry-After - Seconds the client should wait before retrying. <br> |
@@ -229,7 +229,7 @@ example().catch(console.error);
229
229
  | Status code | Description | Response headers |
230
230
  |-------------|-------------|------------------|
231
231
  | **200** | The created fine-tuning job. | - |
232
- | **400** | Invalid request (OpenAI error envelope). | - |
232
+ | **400** | Invalid request (OpenAI error envelope). On inference routes this includes &#x60;zero_data_retention_unavailable&#x60; when zero data retention is required and the model has no zero-data-retention host. | - |
233
233
  | **401** | Missing or invalid API key (OpenAI error envelope). | - |
234
234
  | **402** | Insufficient balance (OpenAI error envelope, SERV-06). | - |
235
235
  | **403** | API key lacks the required scope (OpenAI error envelope). | - |