@mlhub/models-ts-sdk 0.0.0

package/src/apis/MetadataApi.ts

@@ -0,0 +1,82 @@
+/* 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.
+ */
+
+
+import * as runtime from '../runtime';
+import {
+    BadRequestResponse,
+    BadRequestResponseFromJSON,
+    BadRequestResponseToJSON,
+    CreateModelMetadataResponse,
+    CreateModelMetadataResponseFromJSON,
+    CreateModelMetadataResponseToJSON,
+    ModelMetadata,
+    ModelMetadataFromJSON,
+    ModelMetadataToJSON,
+    NotFoundResponse,
+    NotFoundResponseFromJSON,
+    NotFoundResponseToJSON,
+    ServerErrorResponse,
+    ServerErrorResponseFromJSON,
+    ServerErrorResponseToJSON,
+} from '../models';
+
+export interface CreateModelMetadataRequest {
+    artifactId: string;
+    modelMetadata: ModelMetadata;
+}
+
+/**
+ * 
+ */
+export class MetadataApi extends runtime.BaseAPI {
+
+    /**
+     * Create metadata for a model artifact
+     */
+    async createModelMetadataRaw(requestParameters: CreateModelMetadataRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<CreateModelMetadataResponse>> {
+        if (requestParameters.artifactId === null || requestParameters.artifactId === undefined) {
+            throw new runtime.RequiredError('artifactId','Required parameter requestParameters.artifactId was null or undefined when calling createModelMetadata.');
+        }
+
+        if (requestParameters.modelMetadata === null || requestParameters.modelMetadata === undefined) {
+            throw new runtime.RequiredError('modelMetadata','Required parameter requestParameters.modelMetadata was null or undefined when calling createModelMetadata.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await this.request({
+            path: `/models-api/artifacts/{artifact_id}/metadata`.replace(`{${"artifact_id"}}`, encodeURIComponent(String(requestParameters.artifactId))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ModelMetadataToJSON(requestParameters.modelMetadata),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateModelMetadataResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Create metadata for a model artifact
+     */
+    async createModelMetadata(requestParameters: CreateModelMetadataRequest, initOverrides?: RequestInit): Promise<CreateModelMetadataResponse> {
+        const response = await this.createModelMetadataRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/PlatformsApi.ts

@@ -0,0 +1,246 @@
+/* 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.
+ */
+
+
+import * as runtime from '../runtime';
+import {
+    BadRequestResponse,
+    BadRequestResponseFromJSON,
+    BadRequestResponseToJSON,
+    DiscoverModelsByPlatformResponse,
+    DiscoverModelsByPlatformResponseFromJSON,
+    DiscoverModelsByPlatformResponseToJSON,
+    DiscoveryCriteria,
+    DiscoveryCriteriaFromJSON,
+    DiscoveryCriteriaToJSON,
+    GetModelByPlatformResponse,
+    GetModelByPlatformResponseFromJSON,
+    GetModelByPlatformResponseToJSON,
+    IngestArtifactRequest,
+    IngestArtifactRequestFromJSON,
+    IngestArtifactRequestToJSON,
+    IngestModelArtifactResponse,
+    IngestModelArtifactResponseFromJSON,
+    IngestModelArtifactResponseToJSON,
+    ListModelsByPlatformResponse,
+    ListModelsByPlatformResponseFromJSON,
+    ListModelsByPlatformResponseToJSON,
+    ListPlatformsResponse,
+    ListPlatformsResponseFromJSON,
+    ListPlatformsResponseToJSON,
+    NotFoundResponse,
+    NotFoundResponseFromJSON,
+    NotFoundResponseToJSON,
+    Platform,
+    PlatformFromJSON,
+    PlatformToJSON,
+    ServerErrorResponse,
+    ServerErrorResponseFromJSON,
+    ServerErrorResponseToJSON,
+} from '../models';
+
+export interface DiscoverModelsByPlatformRequest {
+    platform: Platform;
+    discoveryCriteria: DiscoveryCriteria;
+}
+
+export interface GetModelByPlatformRequest {
+    platform: Platform;
+    modelId: string;
+}
+
+export interface IngestExternalModelRequest {
+    platform: Platform;
+    modelId: string;
+    ingestArtifactRequest: IngestArtifactRequest;
+}
+
+export interface ListModelsByPlatformRequest {
+    platform: Platform;
+}
+
+/**
+ * 
+ */
+export class PlatformsApi extends runtime.BaseAPI {
+
+    /**
+     * Discover models from external platforms
+     */
+    async discoverModelsByPlatformRaw(requestParameters: DiscoverModelsByPlatformRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<DiscoverModelsByPlatformResponse>> {
+        if (requestParameters.platform === null || requestParameters.platform === undefined) {
+            throw new runtime.RequiredError('platform','Required parameter requestParameters.platform was null or undefined when calling discoverModelsByPlatform.');
+        }
+
+        if (requestParameters.discoveryCriteria === null || requestParameters.discoveryCriteria === undefined) {
+            throw new runtime.RequiredError('discoveryCriteria','Required parameter requestParameters.discoveryCriteria was null or undefined when calling discoverModelsByPlatform.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await this.request({
+            path: `/models-api/platforms/{platform}/models`.replace(`{${"platform"}}`, encodeURIComponent(String(requestParameters.platform))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: DiscoveryCriteriaToJSON(requestParameters.discoveryCriteria),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DiscoverModelsByPlatformResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Discover models from external platforms
+     */
+    async discoverModelsByPlatform(requestParameters: DiscoverModelsByPlatformRequest, initOverrides?: RequestInit): Promise<DiscoverModelsByPlatformResponse> {
+        const response = await this.discoverModelsByPlatformRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Fetch a model from an external platform by id
+     */
+    async getModelByPlatformRaw(requestParameters: GetModelByPlatformRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetModelByPlatformResponse>> {
+        if (requestParameters.platform === null || requestParameters.platform === undefined) {
+            throw new runtime.RequiredError('platform','Required parameter requestParameters.platform was null or undefined when calling getModelByPlatform.');
+        }
+
+        if (requestParameters.modelId === null || requestParameters.modelId === undefined) {
+            throw new runtime.RequiredError('modelId','Required parameter requestParameters.modelId was null or undefined when calling getModelByPlatform.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/models-api/platforms/{platform}/models/{model_id}`.replace(`{${"platform"}}`, encodeURIComponent(String(requestParameters.platform))).replace(`{${"model_id"}}`, String(requestParameters.modelId)),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetModelByPlatformResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Fetch a model from an external platform by id
+     */
+    async getModelByPlatform(requestParameters: GetModelByPlatformRequest, initOverrides?: RequestInit): Promise<GetModelByPlatformResponse> {
+        const response = await this.getModelByPlatformRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Ingest a model from an external platform
+     */
+    async ingestExternalModelRaw(requestParameters: IngestExternalModelRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<IngestModelArtifactResponse>> {
+        if (requestParameters.platform === null || requestParameters.platform === undefined) {
+            throw new runtime.RequiredError('platform','Required parameter requestParameters.platform was null or undefined when calling ingestExternalModel.');
+        }
+
+        if (requestParameters.modelId === null || requestParameters.modelId === undefined) {
+            throw new runtime.RequiredError('modelId','Required parameter requestParameters.modelId was null or undefined when calling ingestExternalModel.');
+        }
+
+        if (requestParameters.ingestArtifactRequest === null || requestParameters.ingestArtifactRequest === undefined) {
+            throw new runtime.RequiredError('ingestArtifactRequest','Required parameter requestParameters.ingestArtifactRequest was null or undefined when calling ingestExternalModel.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await this.request({
+            path: `/models-api/platforms/{platform}/models/{model_id}`.replace(`{${"platform"}}`, encodeURIComponent(String(requestParameters.platform))).replace(`{${"model_id"}}`, encodeURIComponent(String(requestParameters.modelId))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: IngestArtifactRequestToJSON(requestParameters.ingestArtifactRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => IngestModelArtifactResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Ingest a model from an external platform
+     */
+    async ingestExternalModel(requestParameters: IngestExternalModelRequest, initOverrides?: RequestInit): Promise<IngestModelArtifactResponse> {
+        const response = await this.ingestExternalModelRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List models from an external platform
+     */
+    async listModelsByPlatformRaw(requestParameters: ListModelsByPlatformRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ListModelsByPlatformResponse>> {
+        if (requestParameters.platform === null || requestParameters.platform === undefined) {
+            throw new runtime.RequiredError('platform','Required parameter requestParameters.platform was null or undefined when calling listModelsByPlatform.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/models-api/platforms/{platform}/models`.replace(`{${"platform"}}`, encodeURIComponent(String(requestParameters.platform))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListModelsByPlatformResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List models from an external platform
+     */
+    async listModelsByPlatform(requestParameters: ListModelsByPlatformRequest, initOverrides?: RequestInit): Promise<ListModelsByPlatformResponse> {
+        const response = await this.listModelsByPlatformRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List all external platforms integrated with this deployment of MLHub
+     */
+    async listPlatformsRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<ListPlatformsResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/models-api/platforms`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListPlatformsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List all external platforms integrated with this deployment of MLHub
+     */
+    async listPlatforms(initOverrides?: RequestInit): Promise<ListPlatformsResponse> {
+        const response = await this.listPlatformsRaw(initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/PublicationsApi.ts

@@ -0,0 +1,185 @@
+/* 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.
+ */
+
+
+import * as runtime from '../runtime';
+import {
+    BadRequestResponse,
+    BadRequestResponseFromJSON,
+    BadRequestResponseToJSON,
+    GetModelPublicationResponse,
+    GetModelPublicationResponseFromJSON,
+    GetModelPublicationResponseToJSON,
+    ListModelPublicationsForArtifactResponse,
+    ListModelPublicationsForArtifactResponseFromJSON,
+    ListModelPublicationsForArtifactResponseToJSON,
+    ListModelPublicationsResponse,
+    ListModelPublicationsResponseFromJSON,
+    ListModelPublicationsResponseToJSON,
+    NotFoundResponse,
+    NotFoundResponseFromJSON,
+    NotFoundResponseToJSON,
+    PublishArtifactRequest,
+    PublishArtifactRequestFromJSON,
+    PublishArtifactRequestToJSON,
+    PublishModelArtifactResponse,
+    PublishModelArtifactResponseFromJSON,
+    PublishModelArtifactResponseToJSON,
+    ServerErrorResponse,
+    ServerErrorResponseFromJSON,
+    ServerErrorResponseToJSON,
+} from '../models';
+
+export interface GetModelPublicationRequest {
+    publicationId: string;
+}
+
+export interface ListPublicationsForArtifactRequest {
+    artifactId: string;
+}
+
+export interface PublishModelArtifactRequest {
+    artifactId: string;
+    publishArtifactRequest: PublishArtifactRequest;
+}
+
+/**
+ * 
+ */
+export class PublicationsApi extends runtime.BaseAPI {
+
+    /**
+     * Fetch a publication by id
+     */
+    async getModelPublicationRaw(requestParameters: GetModelPublicationRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<GetModelPublicationResponse>> {
+        if (requestParameters.publicationId === null || requestParameters.publicationId === undefined) {
+            throw new runtime.RequiredError('publicationId','Required parameter requestParameters.publicationId was null or undefined when calling getModelPublication.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/models-api/publications/{publication_id}`.replace(`{${"publication_id"}}`, encodeURIComponent(String(requestParameters.publicationId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetModelPublicationResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Fetch a publication by id
+     */
+    async getModelPublication(requestParameters: GetModelPublicationRequest, initOverrides?: RequestInit): Promise<GetModelPublicationResponse> {
+        const response = await this.getModelPublicationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List all model publications
+     */
+    async listModelPublicationsRaw(initOverrides?: RequestInit): Promise<runtime.ApiResponse<ListModelPublicationsResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/models-api/publications`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListModelPublicationsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List all model publications
+     */
+    async listModelPublications(initOverrides?: RequestInit): Promise<ListModelPublicationsResponse> {
+        const response = await this.listModelPublicationsRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List all publications for an artifact
+     */
+    async listPublicationsForArtifactRaw(requestParameters: ListPublicationsForArtifactRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ListModelPublicationsForArtifactResponse>> {
+        if (requestParameters.artifactId === null || requestParameters.artifactId === undefined) {
+            throw new runtime.RequiredError('artifactId','Required parameter requestParameters.artifactId was null or undefined when calling listPublicationsForArtifact.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const response = await this.request({
+            path: `/models-api/artifacts/{artifact_id}/publications`.replace(`{${"artifact_id"}}`, encodeURIComponent(String(requestParameters.artifactId))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListModelPublicationsForArtifactResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List all publications for an artifact
+     */
+    async listPublicationsForArtifact(requestParameters: ListPublicationsForArtifactRequest, initOverrides?: RequestInit): Promise<ListModelPublicationsForArtifactResponse> {
+        const response = await this.listPublicationsForArtifactRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Publish a model artifact to an external platform
+     */
+    async publishModelArtifactRaw(requestParameters: PublishModelArtifactRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<PublishModelArtifactResponse>> {
+        if (requestParameters.artifactId === null || requestParameters.artifactId === undefined) {
+            throw new runtime.RequiredError('artifactId','Required parameter requestParameters.artifactId was null or undefined when calling publishModelArtifact.');
+        }
+
+        if (requestParameters.publishArtifactRequest === null || requestParameters.publishArtifactRequest === undefined) {
+            throw new runtime.RequiredError('publishArtifactRequest','Required parameter requestParameters.publishArtifactRequest was null or undefined when calling publishModelArtifact.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await this.request({
+            path: `/models-api/artifacts/{artifact_id}/publications`.replace(`{${"artifact_id"}}`, encodeURIComponent(String(requestParameters.artifactId))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: PublishArtifactRequestToJSON(requestParameters.publishArtifactRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PublishModelArtifactResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Publish a model artifact to an external platform
+     */
+    async publishModelArtifact(requestParameters: PublishModelArtifactRequest, initOverrides?: RequestInit): Promise<PublishModelArtifactResponse> {
+        const response = await this.publishModelArtifactRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -0,0 +1,7 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './ArtifactsApi';
+export * from './IngestionsApi';
+export * from './MetadataApi';
+export * from './PlatformsApi';
+export * from './PublicationsApi';

package/src/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './apis';
+export * from './models';

package/src/models/Accelerator.ts

@@ -0,0 +1,87 @@
+/* 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    SystemRequirement,
+    SystemRequirementFromJSON,
+    SystemRequirementFromJSONTyped,
+    SystemRequirementToJSON,
+} from './';
+
+/**
+ * 
+ * @export
+ * @interface Accelerator
+ */
+export interface Accelerator {
+    /**
+     * 
+     * @type {string}
+     * @memberof Accelerator
+     */
+    accelerator_type: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof Accelerator
+     */
+    cores?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof Accelerator
+     */
+    memory_gb?: number | null;
+    /**
+     * Firmware and software
+     * @type {Array<SystemRequirement>}
+     * @memberof Accelerator
+     */
+    system_requirements: Array<SystemRequirement>;
+}
+
+export function AcceleratorFromJSON(json: any): Accelerator {
+    return AcceleratorFromJSONTyped(json, false);
+}
+
+export function AcceleratorFromJSONTyped(json: any, ignoreDiscriminator: boolean): Accelerator {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'accelerator_type': json['accelerator_type'],
+        'cores': !exists(json, 'cores') ? undefined : json['cores'],
+        'memory_gb': !exists(json, 'memory_gb') ? undefined : json['memory_gb'],
+        'system_requirements': ((json['system_requirements'] as Array<any>).map(SystemRequirementFromJSON)),
+    };
+}
+
+export function AcceleratorToJSON(value?: Accelerator | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'accelerator_type': value.accelerator_type,
+        'cores': value.cores,
+        'memory_gb': value.memory_gb,
+        'system_requirements': ((value.system_requirements as Array<any>).map(SystemRequirementToJSON)),
+    };
+}
+