@mlhub/models-ts-sdk 0.1.1 → 0.2.0

package/.openapi-generator/FILES

@@ -18,9 +18,11 @@ src/models/ArtifactIngestionStatus.ts
 src/models/ArtifactPublication.ts
 src/models/ArtifactPublicationStatus.ts
 src/models/ArtifactType.ts
-src/models/AssociateModelMetadata.ts
+src/models/AssociateModelMetadataBody.ts
 src/models/AssociateModelMetadataResponse.ts
 src/models/BadRequestResponse.ts
+src/models/Canonical.ts
+src/models/CreateModelMetadataBody.ts
 src/models/CreateModelMetadataResponse.ts
 src/models/DiscoverModelsByPlatformResponse.ts
 src/models/DiscoverModelsResponse.ts
@@ -42,6 +44,7 @@ src/models/ListModelsByPlatformResponse.ts
 src/models/ListModelsResponse.ts
 src/models/ListPlatformsResponse.ts
 src/models/ListTasksResponse.ts
+src/models/Locator.ts
 src/models/ModelArtifact.ts
 src/models/ModelIO.ts
 src/models/ModelMetadata.ts

package/README.md

@@ -1,4 +1,4 @@
-## @mlhub/models-ts-sdk@0.1.1
+## @mlhub/models-ts-sdk@0.2.0
 
 This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @mlhub/models-ts-sdk@0.1.1 --save
+npm install @mlhub/models-ts-sdk@0.2.0 --save
 ```
 
 _unPublished (not recommended):_

package/dist/apis/ArtifactsApi.d.ts

@@ -10,10 +10,10 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { AssociateModelMetadata, AssociateModelMetadataResponse, GetModelArtifactResponse, ListModelArtifactResponse } from '../models';
+import { AssociateModelMetadataBody, AssociateModelMetadataResponse, GetModelArtifactResponse, ListModelArtifactResponse } from '../models';
 export interface AssociateModelMetadataWithArtifactRequest {
     artifactId: string;
-    associateModelMetadata: AssociateModelMetadata;
+    associateModelMetadataBody: AssociateModelMetadataBody;
 }
 export interface GetModelArtifactRequest {
     artifactId: string;

package/dist/apis/ArtifactsApi.js

@@ -87,8 +87,8 @@ var ArtifactsApi = /** @class */ (function (_super) {
                         if (requestParameters.artifactId === null || requestParameters.artifactId === undefined) {
                             throw new runtime.RequiredError('artifactId', 'Required parameter requestParameters.artifactId was null or undefined when calling associateModelMetadataWithArtifact.');
                         }
-                        if (requestParameters.associateModelMetadata === null || requestParameters.associateModelMetadata === undefined) {
-                            throw new runtime.RequiredError('associateModelMetadata', 'Required parameter requestParameters.associateModelMetadata was null or undefined when calling associateModelMetadataWithArtifact.');
+                        if (requestParameters.associateModelMetadataBody === null || requestParameters.associateModelMetadataBody === undefined) {
+                            throw new runtime.RequiredError('associateModelMetadataBody', 'Required parameter requestParameters.associateModelMetadataBody was null or undefined when calling associateModelMetadataWithArtifact.');
                         }
                         queryParameters = {};
                         headerParameters = {};
@@ -98,7 +98,7 @@ var ArtifactsApi = /** @class */ (function (_super) {
                                 method: 'POST',
                                 headers: headerParameters,
                                 query: queryParameters,
-                                body: (0, models_1.AssociateModelMetadataToJSON)(requestParameters.associateModelMetadata),
+                                body: (0, models_1.AssociateModelMetadataBodyToJSON)(requestParameters.associateModelMetadataBody),
                             }, initOverrides)];
                     case 1:
                         response = _a.sent();

package/dist/apis/ModelsApi.d.ts

@@ -10,9 +10,9 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { CreateModelMetadataResponse, DiscoverModelsResponse, DiscoveryCriteria, GetModelResponse, IngestArtifactRequest, IngestModelArtifactResponse, ListModelsResponse, ModelMetadata } from '../models';
+import { CreateModelMetadataBody, CreateModelMetadataResponse, DiscoverModelsResponse, DiscoveryCriteria, GetModelResponse, IngestArtifactRequest, IngestModelArtifactResponse, ListModelsResponse } from '../models';
 export interface CreateModelMetadataRequest {
-    modelMetadata: ModelMetadata;
+    createModelMetadataBody: CreateModelMetadataBody;
 }
 export interface DiscoverModelsRequest {
     discoveryCriteria: DiscoveryCriteria;
@@ -29,9 +29,6 @@ export interface IngestCanonicalModelRequest {
     name: string;
     ingestArtifactRequest: IngestArtifactRequest;
 }
-export interface ListModelsRequest {
-    modelMetadata: ModelMetadata;
-}
 export interface ListModelsByAuthorRequest {
     author: string;
 }
@@ -74,11 +71,11 @@ export declare class ModelsApi extends runtime.BaseAPI {
     /**
      * List all models
      */
-    listModelsRaw(requestParameters: ListModelsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ListModelsResponse>>;
+    listModelsRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<ListModelsResponse>>;
     /**
      * List all models
      */
-    listModels(requestParameters: ListModelsRequest, initOverrides?: RequestInit): Promise<ListModelsResponse>;
+    listModels(initOverrides?: RequestInit): Promise<ListModelsResponse>;
     /**
      * List models by author
      */

package/dist/apis/ModelsApi.js

@@ -84,8 +84,8 @@ var ModelsApi = /** @class */ (function (_super) {
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        if (requestParameters.modelMetadata === null || requestParameters.modelMetadata === undefined) {
-                            throw new runtime.RequiredError('modelMetadata', 'Required parameter requestParameters.modelMetadata was null or undefined when calling createModelMetadata.');
+                        if (requestParameters.createModelMetadataBody === null || requestParameters.createModelMetadataBody === undefined) {
+                            throw new runtime.RequiredError('createModelMetadataBody', 'Required parameter requestParameters.createModelMetadataBody was null or undefined when calling createModelMetadata.');
                         }
                         queryParameters = {};
                         headerParameters = {};
@@ -95,7 +95,7 @@ var ModelsApi = /** @class */ (function (_super) {
                                 method: 'POST',
                                 headers: headerParameters,
                                 query: queryParameters,
-                                body: (0, models_1.ModelMetadataToJSON)(requestParameters.modelMetadata),
+                                body: (0, models_1.CreateModelMetadataBodyToJSON)(requestParameters.createModelMetadataBody),
                             }, initOverrides)];
                     case 1:
                         response = _a.sent();
@@ -278,24 +278,19 @@ var ModelsApi = /** @class */ (function (_super) {
     /**
      * List all models
      */
-    ModelsApi.prototype.listModelsRaw = function (requestParameters, initOverrides) {
+    ModelsApi.prototype.listModelsRaw = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
             var queryParameters, headerParameters, response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
-                        if (requestParameters.modelMetadata === null || requestParameters.modelMetadata === undefined) {
-                            throw new runtime.RequiredError('modelMetadata', 'Required parameter requestParameters.modelMetadata was null or undefined when calling listModels.');
-                        }
                         queryParameters = {};
                         headerParameters = {};
-                        headerParameters['Content-Type'] = 'application/json';
                         return [4 /*yield*/, this.request({
                                 path: "/models-api/models",
                                 method: 'GET',
                                 headers: headerParameters,
                                 query: queryParameters,
-                                body: (0, models_1.ModelMetadataToJSON)(requestParameters.modelMetadata),
                             }, initOverrides)];
                     case 1:
                         response = _a.sent();
@@ -307,12 +302,12 @@ var ModelsApi = /** @class */ (function (_super) {
     /**
      * List all models
      */
-    ModelsApi.prototype.listModels = function (requestParameters, initOverrides) {
+    ModelsApi.prototype.listModels = function (initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
             var response;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, this.listModelsRaw(requestParameters, initOverrides)];
+                    case 0: return [4 /*yield*/, this.listModelsRaw(initOverrides)];
                     case 1:
                         response = _a.sent();
                         return [4 /*yield*/, response.value()];

package/dist/models/AssociateModelMetadataBody.d.ts

@@ -0,0 +1,33 @@
+/**
+ * MLHub Models API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface AssociateModelMetadataBody
+ */
+export interface AssociateModelMetadataBody {
+    /**
+     *
+     * @type {string}
+     * @memberof AssociateModelMetadataBody
+     */
+    author: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AssociateModelMetadataBody
+     */
+    name: string;
+}
+export declare function AssociateModelMetadataBodyFromJSON(json: any): AssociateModelMetadataBody;
+export declare function AssociateModelMetadataBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): AssociateModelMetadataBody;
+export declare function AssociateModelMetadataBodyToJSON(value?: AssociateModelMetadataBody | null): any;

package/dist/models/{AssociateModelMetadata.js → AssociateModelMetadataBody.js}

@@ -13,13 +13,13 @@
  * Do not edit the class manually.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AssociateModelMetadataFromJSON = AssociateModelMetadataFromJSON;
-exports.AssociateModelMetadataFromJSONTyped = AssociateModelMetadataFromJSONTyped;
-exports.AssociateModelMetadataToJSON = AssociateModelMetadataToJSON;
-function AssociateModelMetadataFromJSON(json) {
-    return AssociateModelMetadataFromJSONTyped(json, false);
+exports.AssociateModelMetadataBodyFromJSON = AssociateModelMetadataBodyFromJSON;
+exports.AssociateModelMetadataBodyFromJSONTyped = AssociateModelMetadataBodyFromJSONTyped;
+exports.AssociateModelMetadataBodyToJSON = AssociateModelMetadataBodyToJSON;
+function AssociateModelMetadataBodyFromJSON(json) {
+    return AssociateModelMetadataBodyFromJSONTyped(json, false);
 }
-function AssociateModelMetadataFromJSONTyped(json, ignoreDiscriminator) {
+function AssociateModelMetadataBodyFromJSONTyped(json, ignoreDiscriminator) {
     if ((json === undefined) || (json === null)) {
         return json;
     }
@@ -28,7 +28,7 @@ function AssociateModelMetadataFromJSONTyped(json, ignoreDiscriminator) {
         'name': json['name'],
     };
 }
-function AssociateModelMetadataToJSON(value) {
+function AssociateModelMetadataBodyToJSON(value) {
     if (value === undefined) {
         return undefined;
     }

package/dist/models/Canonical.d.ts

@@ -0,0 +1,76 @@
+/**
+ * MLHub Models API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Locator, Platform } from './';
+/**
+ *
+ * @export
+ * @interface Canonical
+ */
+export interface Canonical {
+    /**
+     *
+     * @type {string}
+     * @memberof Canonical
+     */
+    author?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof Canonical
+     */
+    downloads?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Canonical
+     */
+    gated?: boolean | null;
+    /**
+     *
+     * @type {number}
+     * @memberof Canonical
+     */
+    likes?: number | null;
+    /**
+     *
+     * @type {Locator}
+     * @memberof Canonical
+     */
+    locator: Locator;
+    /**
+     *
+     * @type {string}
+     * @memberof Canonical
+     */
+    model_id: string;
+    /**
+     *
+     * @type {Platform}
+     * @memberof Canonical
+     */
+    platform: Platform;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Canonical
+     */
+    _private?: boolean | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Canonical
+     */
+    sha?: string | null;
+}
+export declare function CanonicalFromJSON(json: any): Canonical;
+export declare function CanonicalFromJSONTyped(json: any, ignoreDiscriminator: boolean): Canonical;
+export declare function CanonicalToJSON(value?: Canonical | null): any;

package/dist/models/Canonical.js

@@ -0,0 +1,58 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * MLHub Models API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CanonicalFromJSON = CanonicalFromJSON;
+exports.CanonicalFromJSONTyped = CanonicalFromJSONTyped;
+exports.CanonicalToJSON = CanonicalToJSON;
+var runtime_1 = require("../runtime");
+var _1 = require("./");
+function CanonicalFromJSON(json) {
+    return CanonicalFromJSONTyped(json, false);
+}
+function CanonicalFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'author': !(0, runtime_1.exists)(json, 'author') ? undefined : json['author'],
+        'downloads': !(0, runtime_1.exists)(json, 'downloads') ? undefined : json['downloads'],
+        'gated': !(0, runtime_1.exists)(json, 'gated') ? undefined : json['gated'],
+        'likes': !(0, runtime_1.exists)(json, 'likes') ? undefined : json['likes'],
+        'locator': (0, _1.LocatorFromJSON)(json['locator']),
+        'model_id': json['model_id'],
+        'platform': (0, _1.PlatformFromJSON)(json['platform']),
+        '_private': !(0, runtime_1.exists)(json, 'private') ? undefined : json['private'],
+        'sha': !(0, runtime_1.exists)(json, 'sha') ? undefined : json['sha'],
+    };
+}
+function CanonicalToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'author': value.author,
+        'downloads': value.downloads,
+        'gated': value.gated,
+        'likes': value.likes,
+        'locator': (0, _1.LocatorToJSON)(value.locator),
+        'model_id': value.model_id,
+        'platform': (0, _1.PlatformToJSON)(value.platform),
+        'private': value._private,
+        'sha': value.sha,
+    };
+}

package/dist/models/CreateModelMetadataBody.d.ts

@@ -0,0 +1,245 @@
+/**
+ * MLHub Models API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { HardwareRequirements, ModelIO, Task } from './';
+/**
+ *
+ * @export
+ * @interface CreateModelMetadataBody
+ */
+export interface CreateModelMetadataBody {
+    /**
+     *
+     * @type {any}
+     * @memberof CreateModelMetadataBody
+     */
+    annotations?: any | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateModelMetadataBody
+     */
+    author?: string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CreateModelMetadataBody
+     */
+    bias_evaluation_score?: number | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CreateModelMetadataBody
+     */
+    edge_optimized?: boolean | null;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof CreateModelMetadataBody
+     */
+    finetuning_datasets?: Array<string> | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateModelMetadataBody
+     */
+    image?: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CreateModelMetadataBody
+     */
+    inference_distributed?: boolean | null;
+    /**
+     *
+     * @type {HardwareRequirements}
+     * @memberof CreateModelMetadataBody
+     */
+    inference_hardware?: HardwareRequirements;
+    /**
+     *
+     * @type {number}
+     * @memberof CreateModelMetadataBody
+     */
+    inference_max_compute_utilization_percentage?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CreateModelMetadataBody
+     */
+    inference_max_energy_consumption_watts?: number | null;
+    /**
+     * Inference performance fields
+     * @type {number}
+     * @memberof CreateModelMetadataBody
+     */
+    inference_max_latency_ms?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CreateModelMetadataBody
+     */
+    inference_max_memory_usage_mb?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof CreateModelMetadataBody
+     */
+    inference_min_throughput?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateModelMetadataBody
+     */
+    inference_precision?: string | null;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof CreateModelMetadataBody
+     */
+    inference_software_dependencies?: Array<string> | null;
+    /**
+     * Arbitrary labels
+     * @type {Array<string>}
+     * @memberof CreateModelMetadataBody
+     */
+    keywords?: Array<string> | null;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof CreateModelMetadataBody
+     */
+    libraries?: Array<string> | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateModelMetadataBody
+     */
+    license?: string | null;
+    /**
+     *
+     * @type {Array<ModelIO>}
+     * @memberof CreateModelMetadataBody
+     */
+    model_inputs?: Array<ModelIO> | null;
+    /**
+     *
+     * @type {Array<ModelIO>}
+     * @memberof CreateModelMetadataBody
+     */
+    model_outputs?: Array<ModelIO> | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateModelMetadataBody
+     */
+    model_type?: string | null;
+    /**
+     * Architecture fields
+     * @type {boolean}
+     * @memberof CreateModelMetadataBody
+     */
+    multi_modal?: boolean | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateModelMetadataBody
+     */
+    name?: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CreateModelMetadataBody
+     */
+    pretrained?: boolean | null;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof CreateModelMetadataBody
+     */
+    pretraining_datasets?: Array<string> | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CreateModelMetadataBody
+     */
+    pruned?: boolean | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CreateModelMetadataBody
+     */
+    quantization_aware?: boolean | null;
+    /**
+     * Regulatory and Compliance Fields
+     * A vector or strings that represent regulatory standards. Ex HIPPA
+     * @type {Array<string>}
+     * @memberof CreateModelMetadataBody
+     */
+    regulatory?: Array<string> | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CreateModelMetadataBody
+     */
+    slimmed?: boolean | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CreateModelMetadataBody
+     */
+    supports_quantization?: boolean | null;
+    /**
+     * Inference Fields
+     * @type {Array<Task>}
+     * @memberof CreateModelMetadataBody
+     */
+    task_types?: Array<Task> | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateModelMetadataBody
+     */
+    tenant_id?: string | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CreateModelMetadataBody
+     */
+    training_distributed?: boolean | null;
+    /**
+     *
+     * @type {HardwareRequirements}
+     * @memberof CreateModelMetadataBody
+     */
+    training_hardware?: HardwareRequirements;
+    /**
+     * Training performance fields
+     * @type {number}
+     * @memberof CreateModelMetadataBody
+     */
+    training_max_energy_consumption_watts?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof CreateModelMetadataBody
+     */
+    training_precision?: string | null;
+    /**
+     * Training-related Fields
+     * @type {number}
+     * @memberof CreateModelMetadataBody
+     */
+    training_time?: number | null;
+}
+export declare function CreateModelMetadataBodyFromJSON(json: any): CreateModelMetadataBody;
+export declare function CreateModelMetadataBodyFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateModelMetadataBody;
+export declare function CreateModelMetadataBodyToJSON(value?: CreateModelMetadataBody | null): any;