Generate azure-cognitiveservices-customvision-training package (#5036)

* Generate azure-cognitiveservices-customvision-training package

* Bump the version
This commit is contained in:
Kamil Pajdzik 2019-03-22 14:55:27 -07:00 коммит произвёл GitHub
Родитель 25c99e43a8
Коммит 93b6097799
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
43 изменённых файлов: 1860 добавлений и 421 удалений

Просмотреть файл

@ -0,0 +1,41 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License. See License.txt in the project root for
// license information.
//
// Code generated by Microsoft (R) AutoRest Code Generator.
// Changes may cause incorrect behavior and will be lost if the code is
// regenerated.
const resetColor = "\x1b[0m";
const brightColor = "\x1b[1m";
const highlightColor = "\x1b[31m";
try {
const invisibleCharactersLength = resetColor.length + brightColor.length + highlightColor.length;
const firstLine = `Active development of this SDK has been moved to ${highlightColor}@azure/cognitiveservices-customvision-training${resetColor}${brightColor} package.`;
const secondLine = "This package is in maintenance mode and will be deprecated in July 2019.";
const thirdLine = "Visit https://aka.ms/azure-sdk-for-js-migration for more information.";
const framePadding = 4;
const adjustedFirstLineLength = firstLine.length - invisibleCharactersLength;
const width = Math.max(adjustedFirstLineLength, secondLine.length, thirdLine.length) + framePadding;
const getPaddingLength = (strLength) => width - strLength - framePadding;
const firstLinePaddingLength = getPaddingLength(adjustedFirstLineLength);
const secondLinePaddingLength = getPaddingLength(secondLine.length);
const thirdLinePaddingLength = getPaddingLength(thirdLine.length);
const line = "#".repeat(width);
const formatTextLine = (text, padding) => `#${" ".repeat(Math.floor(padding / 2))} ${text} ${" ".repeat(Math.ceil(padding / 2))}#`;
console.log(brightColor);
console.log("\n" + line);
console.log(formatTextLine(firstLine, firstLinePaddingLength));
console.log(formatTextLine(secondLine, secondLinePaddingLength));
console.log(formatTextLine(thirdLine, thirdLinePaddingLength));
console.log(line + "\n");
console.log(resetColor);
} catch (err) {
// ignore
}

Просмотреть файл

@ -1,6 +1,6 @@
The MIT License (MIT)
Copyright (c) 2018 Microsoft
Copyright (c) 2019 Microsoft
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

Просмотреть файл

@ -1,47 +1,45 @@
---
uid: azure-cognitiveservices-customvision-training
summary: *content
---
**This SDK will be deprecated next year and will be replaced by a new TypeScript-based isomorphic SDK (found at https://github.com/Azure/azure-sdk-for-js) which works on Node.js and browsers.**
## Microsoft Azure SDK for Node.js - TrainingAPIClient
This project provides a Node.js package for accessing Azure. Right now it supports:
- **Node.js version 6.x.x or higher**
### Features
### How to Install
```bash
npm install azure-cognitiveservices-customvision-training
```
### How to use
#### Authentication, client creation, and getDomains as an example.
```javascript
const msRest = require("ms-rest");
const TrainingAPIClient = require("azure-cognitiveservices-customvision-training");
const token = "<access_token>";
const creds = new msRest.TokenCredentials(token);
const subscriptionId = "<Subscription_Id>";
const client = new TrainingAPIClient(creds, subscriptionId);
client.getDomains().then((result) => {
console.log("The result is:");
console.log(result);
}).catch((err) => {
console.log('An error occurred:');
console.dir(err, {depth: null, colors: true});
});
```
### Related projects
- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node)
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-node%2Flib%2Fservices%2FcustomVision%2Ftraining%2FREADME.png)
---
uid: azure-cognitiveservices-customvision-training
summary: *content
---
**This SDK will be deprecated next year and will be replaced by a new TypeScript-based isomorphic SDK (found at https://www.npmjs.com/package/@azure/cognitiveservices-customvision-training) which works on Node.js and browsers.**
**See https://aka.ms/azure-sdk-for-js-migration to learn more.**
## Microsoft Azure SDK for Node.js - TrainingAPIClient
This project provides a Node.js package for accessing Azure. Right now it supports:
- **Node.js version 6.x.x or higher**
### Features
### How to Install
```bash
npm install azure-cognitiveservices-customvision-training
```
### How to use
#### Authentication, client creation, and getDomains as an example.
```javascript
const msRest = require("ms-rest");
const TrainingAPIClient = require("azure-cognitiveservices-customvision-training");
const token = "<access_token>";
const creds = new msRest.TokenCredentials(token);
const subscriptionId = "<Subscription_Id>";
const client = new TrainingAPIClient(creds, subscriptionId);
client.getDomains().then((result) => {
console.log("The result is:");
console.log(result);
}).catch((err) => {
console.log('An error occurred:');
console.dir(err, {depth: null, colors: true});
});
```
### Related projects
- [Microsoft Azure SDK for Node.js](https://github.com/Azure/azure-sdk-for-node)

Просмотреть файл

@ -11,15 +11,16 @@
'use strict';
/**
* Class representing a BoundingBox.
* Bounding box that defines a region of an image.
*
*/
class BoundingBox {
/**
* Create a BoundingBox.
* @property {number} [left]
* @property {number} [top]
* @property {number} [width]
* @property {number} [height]
* @property {number} left Coordinate of the left boundary.
* @property {number} top Coordinate of the top boundary.
* @property {number} width Width.
* @property {number} height Height.
*/
constructor() {
}
@ -39,7 +40,7 @@ class BoundingBox {
className: 'BoundingBox',
modelProperties: {
left: {
required: false,
required: true,
nullable: false,
serializedName: 'left',
type: {
@ -47,7 +48,7 @@ class BoundingBox {
}
},
top: {
required: false,
required: true,
nullable: false,
serializedName: 'top',
type: {
@ -55,7 +56,7 @@ class BoundingBox {
}
},
width: {
required: false,
required: true,
nullable: false,
serializedName: 'width',
type: {
@ -63,7 +64,7 @@ class BoundingBox {
}
},
height: {
required: false,
required: true,
nullable: false,
serializedName: 'height',
type: {

Просмотреть файл

@ -0,0 +1,124 @@
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is
* regenerated.
*/
'use strict';
/**
* Class representing a CustomVisionError.
*/
class CustomVisionError {
/**
* Create a CustomVisionError.
* @property {string} code The error code. Possible values include:
* 'NoError', 'BadRequest', 'BadRequestExceededBatchSize',
* 'BadRequestNotSupported', 'BadRequestInvalidIds', 'BadRequestProjectName',
* 'BadRequestProjectNameNotUnique', 'BadRequestProjectDescription',
* 'BadRequestProjectUnknownDomain',
* 'BadRequestProjectUnknownClassification',
* 'BadRequestProjectUnsupportedDomainTypeChange',
* 'BadRequestProjectUnsupportedExportPlatform', 'BadRequestIterationName',
* 'BadRequestIterationNameNotUnique', 'BadRequestIterationDescription',
* 'BadRequestIterationIsNotTrained', 'BadRequestWorkspaceCannotBeModified',
* 'BadRequestWorkspaceNotDeletable', 'BadRequestTagName',
* 'BadRequestTagNameNotUnique', 'BadRequestTagDescription',
* 'BadRequestTagType', 'BadRequestMultipleNegativeTag',
* 'BadRequestImageTags', 'BadRequestImageRegions',
* 'BadRequestNegativeAndRegularTagOnSameImage',
* 'BadRequestRequiredParamIsNull', 'BadRequestIterationIsPublished',
* 'BadRequestInvalidPublishName', 'BadRequestInvalidPublishTarget',
* 'BadRequestUnpublishFailed', 'BadRequestIterationNotPublished',
* 'BadRequestSubscriptionApi', 'BadRequestExceedProjectLimit',
* 'BadRequestExceedIterationPerProjectLimit',
* 'BadRequestExceedTagPerProjectLimit', 'BadRequestExceedTagPerImageLimit',
* 'BadRequestExceededQuota', 'BadRequestCannotMigrateProjectWithName',
* 'BadRequestNotLimitedTrial', 'BadRequestImageBatch',
* 'BadRequestImageStream', 'BadRequestImageUrl', 'BadRequestImageFormat',
* 'BadRequestImageSizeBytes', 'BadRequestImageExceededCount',
* 'BadRequestTrainingNotNeeded',
* 'BadRequestTrainingNotNeededButTrainingPipelineUpdated',
* 'BadRequestTrainingValidationFailed',
* 'BadRequestClassificationTrainingValidationFailed',
* 'BadRequestMultiClassClassificationTrainingValidationFailed',
* 'BadRequestMultiLabelClassificationTrainingValidationFailed',
* 'BadRequestDetectionTrainingValidationFailed',
* 'BadRequestTrainingAlreadyInProgress',
* 'BadRequestDetectionTrainingNotAllowNegativeTag',
* 'BadRequestInvalidEmailAddress',
* 'BadRequestDomainNotSupportedForAdvancedTraining',
* 'BadRequestExportPlatformNotSupportedForAdvancedTraining',
* 'BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining',
* 'BadRequestExportValidationFailed', 'BadRequestExportAlreadyInProgress',
* 'BadRequestPredictionIdsMissing', 'BadRequestPredictionIdsExceededCount',
* 'BadRequestPredictionTagsExceededCount',
* 'BadRequestPredictionResultsExceededCount',
* 'BadRequestPredictionInvalidApplicationName',
* 'BadRequestPredictionInvalidQueryParameters', 'BadRequestInvalid',
* 'UnsupportedMediaType', 'Forbidden', 'ForbiddenUser',
* 'ForbiddenUserResource', 'ForbiddenUserSignupDisabled',
* 'ForbiddenUserSignupAllowanceExceeded', 'ForbiddenUserDoesNotExist',
* 'ForbiddenUserDisabled', 'ForbiddenUserInsufficientCapability',
* 'ForbiddenDRModeEnabled', 'ForbiddenInvalid', 'NotFound',
* 'NotFoundProject', 'NotFoundProjectDefaultIteration', 'NotFoundIteration',
* 'NotFoundIterationPerformance', 'NotFoundTag', 'NotFoundImage',
* 'NotFoundDomain', 'NotFoundApimSubscription', 'NotFoundInvalid',
* 'Conflict', 'ConflictInvalid', 'ErrorUnknown',
* 'ErrorProjectInvalidWorkspace',
* 'ErrorProjectInvalidPipelineConfiguration', 'ErrorProjectInvalidDomain',
* 'ErrorProjectTrainingRequestFailed', 'ErrorProjectExportRequestFailed',
* 'ErrorFeaturizationServiceUnavailable', 'ErrorFeaturizationQueueTimeout',
* 'ErrorFeaturizationInvalidFeaturizer',
* 'ErrorFeaturizationAugmentationUnavailable',
* 'ErrorFeaturizationUnrecognizedJob',
* 'ErrorFeaturizationAugmentationError', 'ErrorExporterInvalidPlatform',
* 'ErrorExporterInvalidFeaturizer', 'ErrorExporterInvalidClassifier',
* 'ErrorPredictionServiceUnavailable', 'ErrorPredictionModelNotFound',
* 'ErrorPredictionModelNotCached', 'ErrorPrediction',
* 'ErrorPredictionStorage', 'ErrorRegionProposal', 'ErrorInvalid'
* @property {string} message A message explaining the error reported by the
* service.
*/
constructor() {
}
/**
* Defines the metadata of CustomVisionError
*
* @returns {object} metadata of CustomVisionError
*
*/
mapper() {
return {
required: false,
serializedName: 'CustomVisionError',
type: {
name: 'Composite',
className: 'CustomVisionError',
modelProperties: {
code: {
required: true,
serializedName: 'code',
type: {
name: 'String'
}
},
message: {
required: true,
serializedName: 'message',
type: {
name: 'String'
}
}
}
}
};
}
}
module.exports = CustomVisionError;

Просмотреть файл

@ -51,7 +51,7 @@ class Domain {
},
name: {
required: false,
nullable: true,
nullable: false,
readOnly: true,
serializedName: 'name',
type: {

Просмотреть файл

@ -17,12 +17,12 @@ class ExportModel {
/**
* Create a ExportModel.
* @property {string} [platform] Platform of the export. Possible values
* include: 'CoreML', 'TensorFlow', 'DockerFile', 'ONNX'
* include: 'CoreML', 'TensorFlow', 'DockerFile', 'ONNX', 'VAIDK'
* @property {string} [status] Status of the export. Possible values include:
* 'Exporting', 'Failed', 'Done'
* @property {string} [downloadUri] URI used to download the model.
* @property {string} [flavor] Flavor of the export. Possible values include:
* 'Linux', 'Windows', 'ONNX10', 'ONNX12'
* 'Linux', 'Windows', 'ONNX10', 'ONNX12', 'ARM'
* @property {boolean} [newerVersionAvailable] Indicates an updated version
* of the export package is available and should be re-exported for the
* latest changes.
@ -64,7 +64,7 @@ class ExportModel {
},
downloadUri: {
required: false,
nullable: true,
nullable: false,
readOnly: true,
serializedName: 'downloadUri',
type: {

Просмотреть файл

@ -85,7 +85,7 @@ class Image {
},
resizedImageUri: {
required: false,
nullable: true,
nullable: false,
readOnly: true,
serializedName: 'resizedImageUri',
type: {
@ -94,7 +94,7 @@ class Image {
},
thumbnailUri: {
required: false,
nullable: true,
nullable: false,
readOnly: true,
serializedName: 'thumbnailUri',
type: {
@ -103,7 +103,7 @@ class Image {
},
originalImageUri: {
required: false,
nullable: true,
nullable: false,
readOnly: true,
serializedName: 'originalImageUri',
type: {

Просмотреть файл

@ -55,7 +55,7 @@ class ImageCreateResult {
modelProperties: {
sourceUrl: {
required: false,
nullable: true,
nullable: false,
readOnly: true,
serializedName: 'sourceUrl',
type: {
@ -73,6 +73,7 @@ class ImageCreateResult {
},
image: {
required: false,
nullable: false,
readOnly: true,
serializedName: 'image',
type: {

Просмотреть файл

@ -48,7 +48,6 @@ class ImageCreateSummary {
},
images: {
required: false,
nullable: true,
readOnly: true,
serializedName: 'images',
type: {

Просмотреть файл

@ -38,7 +38,6 @@ class ImageFileCreateBatch {
modelProperties: {
images: {
required: false,
nullable: true,
serializedName: 'images',
type: {
name: 'Sequence',
@ -54,7 +53,6 @@ class ImageFileCreateBatch {
},
tagIds: {
required: false,
nullable: true,
serializedName: 'tagIds',
type: {
name: 'Sequence',

Просмотреть файл

@ -40,7 +40,7 @@ class ImageFileCreateEntry {
modelProperties: {
name: {
required: false,
nullable: true,
nullable: false,
serializedName: 'name',
type: {
name: 'String'
@ -48,7 +48,7 @@ class ImageFileCreateEntry {
},
contents: {
required: false,
nullable: true,
nullable: false,
serializedName: 'contents',
type: {
name: 'ByteArray'
@ -56,7 +56,6 @@ class ImageFileCreateEntry {
},
tagIds: {
required: false,
nullable: true,
serializedName: 'tagIds',
type: {
name: 'Sequence',
@ -71,7 +70,6 @@ class ImageFileCreateEntry {
},
regions: {
required: false,
nullable: true,
serializedName: 'regions',
type: {
name: 'Sequence',

Просмотреть файл

@ -38,7 +38,6 @@ class ImageIdCreateBatch {
modelProperties: {
images: {
required: false,
nullable: true,
serializedName: 'images',
type: {
name: 'Sequence',
@ -54,7 +53,6 @@ class ImageIdCreateBatch {
},
tagIds: {
required: false,
nullable: true,
serializedName: 'tagIds',
type: {
name: 'Sequence',

Просмотреть файл

@ -16,7 +16,7 @@
class ImageIdCreateEntry {
/**
* Create a ImageIdCreateEntry.
* @property {uuid} [id]
* @property {uuid} [id] Id of the image.
* @property {array} [tagIds]
* @property {array} [regions]
*/
@ -47,7 +47,6 @@ class ImageIdCreateEntry {
},
tagIds: {
required: false,
nullable: true,
serializedName: 'tagIds',
type: {
name: 'Sequence',
@ -62,7 +61,6 @@ class ImageIdCreateEntry {
},
regions: {
required: false,
nullable: true,
serializedName: 'regions',
type: {
name: 'Sequence',

Просмотреть файл

@ -99,7 +99,7 @@ class ImagePerformance {
},
imageUri: {
required: false,
nullable: true,
nullable: false,
readOnly: true,
serializedName: 'imageUri',
type: {
@ -108,7 +108,7 @@ class ImagePerformance {
},
thumbnailUri: {
required: false,
nullable: true,
nullable: false,
readOnly: true,
serializedName: 'thumbnailUri',
type: {

Просмотреть файл

@ -11,16 +11,17 @@
'use strict';
/**
* Class representing a ImagePrediction.
* Result of an image prediction request.
*
*/
class ImagePrediction {
/**
* Create a ImagePrediction.
* @property {uuid} [id]
* @property {uuid} [project]
* @property {uuid} [iteration]
* @property {date} [created]
* @property {array} [predictions]
* @property {uuid} [id] Prediction Id.
* @property {uuid} [project] Project Id.
* @property {uuid} [iteration] Iteration Id.
* @property {date} [created] Date this prediction was created.
* @property {array} [predictions] List of predictions.
*/
constructor() {
}
@ -77,7 +78,6 @@ class ImagePrediction {
},
predictions: {
required: false,
nullable: true,
readOnly: true,
serializedName: 'predictions',
type: {

Просмотреть файл

@ -19,11 +19,11 @@ class ImageRegion {
* @property {uuid} [regionId]
* @property {string} [tagName]
* @property {date} [created]
* @property {uuid} [tagId] Id of the tag associated with this region.
* @property {number} [left]
* @property {number} [top]
* @property {number} [width]
* @property {number} [height]
* @property {uuid} tagId Id of the tag associated with this region.
* @property {number} left Coordinate of the left boundary.
* @property {number} top Coordinate of the top boundary.
* @property {number} width Width.
* @property {number} height Height.
*/
constructor() {
}
@ -53,7 +53,7 @@ class ImageRegion {
},
tagName: {
required: false,
nullable: true,
nullable: false,
readOnly: true,
serializedName: 'tagName',
type: {
@ -70,7 +70,7 @@ class ImageRegion {
}
},
tagId: {
required: false,
required: true,
nullable: false,
serializedName: 'tagId',
type: {
@ -78,7 +78,7 @@ class ImageRegion {
}
},
left: {
required: false,
required: true,
nullable: false,
serializedName: 'left',
type: {
@ -86,7 +86,7 @@ class ImageRegion {
}
},
top: {
required: false,
required: true,
nullable: false,
serializedName: 'top',
type: {
@ -94,7 +94,7 @@ class ImageRegion {
}
},
width: {
required: false,
required: true,
nullable: false,
serializedName: 'width',
type: {
@ -102,7 +102,7 @@ class ImageRegion {
}
},
height: {
required: false,
required: true,
nullable: false,
serializedName: 'height',
type: {

Просмотреть файл

@ -38,7 +38,6 @@ class ImageRegionCreateBatch {
modelProperties: {
regions: {
required: false,
nullable: true,
serializedName: 'regions',
type: {
name: 'Sequence',

Просмотреть файл

@ -17,12 +17,12 @@
class ImageRegionCreateEntry {
/**
* Create a ImageRegionCreateEntry.
* @property {uuid} [imageId] Id of the image.
* @property {uuid} [tagId] Id of the tag associated with this region.
* @property {number} [left]
* @property {number} [top]
* @property {number} [width]
* @property {number} [height]
* @property {uuid} imageId Id of the image.
* @property {uuid} tagId Id of the tag associated with this region.
* @property {number} left Coordinate of the left boundary.
* @property {number} top Coordinate of the top boundary.
* @property {number} width Width.
* @property {number} height Height.
*/
constructor() {
}
@ -42,7 +42,7 @@ class ImageRegionCreateEntry {
className: 'ImageRegionCreateEntry',
modelProperties: {
imageId: {
required: false,
required: true,
nullable: false,
serializedName: 'imageId',
type: {
@ -50,7 +50,7 @@ class ImageRegionCreateEntry {
}
},
tagId: {
required: false,
required: true,
nullable: false,
serializedName: 'tagId',
type: {
@ -58,7 +58,7 @@ class ImageRegionCreateEntry {
}
},
left: {
required: false,
required: true,
nullable: false,
serializedName: 'left',
type: {
@ -66,7 +66,7 @@ class ImageRegionCreateEntry {
}
},
top: {
required: false,
required: true,
nullable: false,
serializedName: 'top',
type: {
@ -74,7 +74,7 @@ class ImageRegionCreateEntry {
}
},
width: {
required: false,
required: true,
nullable: false,
serializedName: 'width',
type: {
@ -82,7 +82,7 @@ class ImageRegionCreateEntry {
}
},
height: {
required: false,
required: true,
nullable: false,
serializedName: 'height',
type: {

Просмотреть файл

@ -20,11 +20,11 @@ class ImageRegionCreateResult {
* @property {uuid} [regionId]
* @property {string} [tagName]
* @property {date} [created]
* @property {uuid} [tagId] Id of the tag associated with this region.
* @property {number} [left]
* @property {number} [top]
* @property {number} [width]
* @property {number} [height]
* @property {uuid} tagId Id of the tag associated with this region.
* @property {number} left Coordinate of the left boundary.
* @property {number} top Coordinate of the top boundary.
* @property {number} width Width.
* @property {number} height Height.
*/
constructor() {
}
@ -63,7 +63,7 @@ class ImageRegionCreateResult {
},
tagName: {
required: false,
nullable: true,
nullable: false,
readOnly: true,
serializedName: 'tagName',
type: {
@ -80,7 +80,7 @@ class ImageRegionCreateResult {
}
},
tagId: {
required: false,
required: true,
nullable: false,
serializedName: 'tagId',
type: {
@ -88,7 +88,7 @@ class ImageRegionCreateResult {
}
},
left: {
required: false,
required: true,
nullable: false,
serializedName: 'left',
type: {
@ -96,7 +96,7 @@ class ImageRegionCreateResult {
}
},
top: {
required: false,
required: true,
nullable: false,
serializedName: 'top',
type: {
@ -104,7 +104,7 @@ class ImageRegionCreateResult {
}
},
width: {
required: false,
required: true,
nullable: false,
serializedName: 'width',
type: {
@ -112,7 +112,7 @@ class ImageRegionCreateResult {
}
},
height: {
required: false,
required: true,
nullable: false,
serializedName: 'height',
type: {

Просмотреть файл

@ -57,7 +57,6 @@ class ImageRegionProposal {
},
proposals: {
required: false,
nullable: true,
readOnly: true,
serializedName: 'proposals',
type: {

Просмотреть файл

@ -48,7 +48,7 @@ class ImageTag {
},
tagName: {
required: false,
nullable: true,
nullable: false,
readOnly: true,
serializedName: 'tagName',
type: {

Просмотреть файл

@ -38,7 +38,6 @@ class ImageTagCreateBatch {
modelProperties: {
tags: {
required: false,
nullable: true,
serializedName: 'tags',
type: {
name: 'Sequence',

Просмотреть файл

@ -11,12 +11,13 @@
'use strict';
/**
* Class representing a ImageUrl.
* Image url.
*
*/
class ImageUrl {
/**
* Create a ImageUrl.
* @property {string} [url]
* @property {string} url Url of the image.
*/
constructor() {
}
@ -36,8 +37,8 @@ class ImageUrl {
className: 'ImageUrl',
modelProperties: {
url: {
required: false,
nullable: true,
required: true,
nullable: false,
serializedName: 'url',
type: {
name: 'String'

Просмотреть файл

@ -38,7 +38,6 @@ class ImageUrlCreateBatch {
modelProperties: {
images: {
required: false,
nullable: true,
serializedName: 'images',
type: {
name: 'Sequence',
@ -54,7 +53,6 @@ class ImageUrlCreateBatch {
},
tagIds: {
required: false,
nullable: true,
serializedName: 'tagIds',
type: {
name: 'Sequence',

Просмотреть файл

@ -16,7 +16,7 @@
class ImageUrlCreateEntry {
/**
* Create a ImageUrlCreateEntry.
* @property {string} [url]
* @property {string} url Url of the image.
* @property {array} [tagIds]
* @property {array} [regions]
*/
@ -38,8 +38,8 @@ class ImageUrlCreateEntry {
className: 'ImageUrlCreateEntry',
modelProperties: {
url: {
required: false,
nullable: true,
required: true,
nullable: false,
serializedName: 'url',
type: {
name: 'String'
@ -47,7 +47,6 @@ class ImageUrlCreateEntry {
},
tagIds: {
required: false,
nullable: true,
serializedName: 'tagIds',
type: {
name: 'Sequence',
@ -62,7 +61,6 @@ class ImageUrlCreateEntry {
},
regions: {
required: false,
nullable: true,
serializedName: 'regions',
type: {
name: 'Sequence',

Просмотреть файл

@ -56,15 +56,27 @@ export interface ImageRegionCreateEntry {
/**
* Id of the image.
*/
imageId?: string;
imageId: string;
/**
* Id of the tag associated with this region.
*/
tagId?: string;
left?: number;
top?: number;
width?: number;
height?: number;
tagId: string;
/**
* Coordinate of the left boundary.
*/
left: number;
/**
* Coordinate of the top boundary.
*/
top: number;
/**
* Width.
*/
width: number;
/**
* Height.
*/
height: number;
}
/**
@ -82,11 +94,23 @@ export interface ImageRegionCreateResult {
/**
* Id of the tag associated with this region.
*/
tagId?: string;
left?: number;
top?: number;
width?: number;
height?: number;
tagId: string;
/**
* Coordinate of the left boundary.
*/
left: number;
/**
* Coordinate of the top boundary.
*/
top: number;
/**
* Width.
*/
width: number;
/**
* Height.
*/
height: number;
}
export interface ImageRegionCreateSummary {
@ -108,11 +132,23 @@ export interface ImageRegion {
/**
* Id of the tag associated with this region.
*/
tagId?: string;
left?: number;
top?: number;
width?: number;
height?: number;
tagId: string;
/**
* Coordinate of the left boundary.
*/
left: number;
/**
* Coordinate of the top boundary.
*/
top: number;
/**
* Width.
*/
width: number;
/**
* Height.
*/
height: number;
}
/**
@ -190,11 +226,23 @@ export interface Region {
/**
* Id of the tag associated with this region.
*/
tagId?: string;
left?: number;
top?: number;
width?: number;
height?: number;
tagId: string;
/**
* Coordinate of the left boundary.
*/
left: number;
/**
* Coordinate of the top boundary.
*/
top: number;
/**
* Width.
*/
width: number;
/**
* Height.
*/
height: number;
}
export interface ImageFileCreateEntry {
@ -210,7 +258,10 @@ export interface ImageFileCreateBatch {
}
export interface ImageUrlCreateEntry {
url?: string;
/**
* Url of the image.
*/
url: string;
tagIds?: string[];
regions?: Region[];
}
@ -221,6 +272,9 @@ export interface ImageUrlCreateBatch {
}
export interface ImageIdCreateEntry {
/**
* Id of the image.
*/
id?: string;
tagIds?: string[];
regions?: Region[];
@ -231,11 +285,26 @@ export interface ImageIdCreateBatch {
tagIds?: string[];
}
/**
* Bounding box that defines a region of an image.
*/
export interface BoundingBox {
left?: number;
top?: number;
width?: number;
height?: number;
/**
* Coordinate of the left boundary.
*/
left: number;
/**
* Coordinate of the top boundary.
*/
top: number;
/**
* Width.
*/
width: number;
/**
* Height.
*/
height: number;
}
export interface RegionProposal {
@ -249,22 +318,61 @@ export interface ImageRegionProposal {
readonly proposals?: RegionProposal[];
}
/**
* Image url.
*/
export interface ImageUrl {
url?: string;
/**
* Url of the image.
*/
url: string;
}
/**
* Prediction result.
*/
export interface Prediction {
/**
* Probability of the tag.
*/
readonly probability?: number;
/**
* Id of the predicted tag.
*/
readonly tagId?: string;
/**
* Name of the predicted tag.
*/
readonly tagName?: string;
/**
* Bounding box of the prediction.
*/
readonly boundingBox?: BoundingBox;
}
/**
* Result of an image prediction request.
*/
export interface ImagePrediction {
/**
* Prediction Id.
*/
readonly id?: string;
/**
* Project Id.
*/
readonly project?: string;
/**
* Iteration Id.
*/
readonly iteration?: string;
/**
* Date this prediction was created.
*/
readonly created?: Date;
/**
* List of predictions.
*/
readonly predictions?: Prediction[];
}
@ -309,10 +417,25 @@ export interface StoredImagePrediction {
* Domain used for the prediction.
*/
readonly domain?: string;
/**
* Prediction Id.
*/
readonly id?: string;
/**
* Project Id.
*/
readonly project?: string;
/**
* Iteration Id.
*/
readonly iteration?: string;
/**
* Date this prediction was created.
*/
readonly created?: Date;
/**
* List of predictions.
*/
readonly predictions?: Prediction[];
}
@ -407,6 +530,10 @@ export interface ProjectSettings {
* 'Multilabel'
*/
classificationType?: string;
/**
* A list of ExportPlatform that the trained model should be able to support.
*/
targetExportPlatforms?: string[];
}
/**
@ -414,33 +541,37 @@ export interface ProjectSettings {
*/
export interface Project {
/**
* Gets The project id.
* Gets the project id.
*/
readonly id?: string;
/**
* Gets or sets the name of the project.
*/
name?: string;
name: string;
/**
* Gets or sets the description of the project.
*/
description?: string;
description: string;
/**
* Gets or sets the project settings.
*/
settings?: ProjectSettings;
settings: ProjectSettings;
/**
* Gets the date this project was created.
*/
readonly created?: Date;
/**
* Gets the date this project was last modifed.
* Gets the date this project was last modified.
*/
readonly lastModified?: Date;
/**
* Gets the thumbnail url representing the project.
* Gets the thumbnail url representing the image.
*/
readonly thumbnailUri?: string;
/**
* Gets if the DR mode is on.
*/
readonly drModeEnabled?: boolean;
}
/**
@ -454,12 +585,7 @@ export interface Iteration {
/**
* Gets or sets the name of the iteration.
*/
name?: string;
/**
* Gets or sets a value indicating whether the iteration is the default iteration for the
* project.
*/
isDefault?: boolean;
name: string;
/**
* Gets the current iteration status.
*/
@ -477,13 +603,17 @@ export interface Iteration {
*/
readonly trainedAt?: Date;
/**
* Gets The project id. of the iteration.
* Gets the project id of the iteration.
*/
readonly projectId?: string;
/**
* Whether the iteration can be exported to another format for download.
*/
readonly exportable?: boolean;
/**
* A set of platforms this iteration can export to.
*/
readonly exportableTo?: string[];
/**
* Get or sets a guid of the domain the iteration has been trained on.
*/
@ -493,11 +623,28 @@ export interface Iteration {
* 'Multilabel'
*/
readonly classificationType?: string;
/**
* Gets the training type of the iteration. Possible values include: 'Regular', 'Advanced'
*/
readonly trainingType?: string;
/**
* Gets the reserved advanced training budget for the iteration.
*/
readonly reservedBudgetInHours?: number;
/**
* Name of the published model.
*/
readonly publishName?: string;
/**
* Resource Provider Id this iteration was originally published to.
*/
readonly originalPublishResourceId?: string;
}
export interface ExportModel {
/**
* Platform of the export. Possible values include: 'CoreML', 'TensorFlow', 'DockerFile', 'ONNX'
* Platform of the export. Possible values include: 'CoreML', 'TensorFlow', 'DockerFile', 'ONNX',
* 'VAIDK'
*/
readonly platform?: string;
/**
@ -509,7 +656,7 @@ export interface ExportModel {
*/
readonly downloadUri?: string;
/**
* Flavor of the export. Possible values include: 'Linux', 'Windows', 'ONNX10', 'ONNX12'
* Flavor of the export. Possible values include: 'Linux', 'Windows', 'ONNX10', 'ONNX12', 'ARM'
*/
readonly flavor?: string;
/**
@ -530,17 +677,77 @@ export interface Tag {
/**
* Gets or sets the name of the tag.
*/
name?: string;
name: string;
/**
* Gets or sets the description of the tag.
*/
description?: string;
description: string;
/**
* Gets or sets the type of the tag. Possible values include: 'Regular', 'Negative'
*/
type?: string;
type: string;
/**
* Gets the number of images with this tag.
*/
readonly imageCount?: number;
}
export interface CustomVisionError {
/**
* The error code. Possible values include: 'NoError', 'BadRequest',
* 'BadRequestExceededBatchSize', 'BadRequestNotSupported', 'BadRequestInvalidIds',
* 'BadRequestProjectName', 'BadRequestProjectNameNotUnique', 'BadRequestProjectDescription',
* 'BadRequestProjectUnknownDomain', 'BadRequestProjectUnknownClassification',
* 'BadRequestProjectUnsupportedDomainTypeChange', 'BadRequestProjectUnsupportedExportPlatform',
* 'BadRequestIterationName', 'BadRequestIterationNameNotUnique',
* 'BadRequestIterationDescription', 'BadRequestIterationIsNotTrained',
* 'BadRequestWorkspaceCannotBeModified', 'BadRequestWorkspaceNotDeletable', 'BadRequestTagName',
* 'BadRequestTagNameNotUnique', 'BadRequestTagDescription', 'BadRequestTagType',
* 'BadRequestMultipleNegativeTag', 'BadRequestImageTags', 'BadRequestImageRegions',
* 'BadRequestNegativeAndRegularTagOnSameImage', 'BadRequestRequiredParamIsNull',
* 'BadRequestIterationIsPublished', 'BadRequestInvalidPublishName',
* 'BadRequestInvalidPublishTarget', 'BadRequestUnpublishFailed',
* 'BadRequestIterationNotPublished', 'BadRequestSubscriptionApi',
* 'BadRequestExceedProjectLimit', 'BadRequestExceedIterationPerProjectLimit',
* 'BadRequestExceedTagPerProjectLimit', 'BadRequestExceedTagPerImageLimit',
* 'BadRequestExceededQuota', 'BadRequestCannotMigrateProjectWithName',
* 'BadRequestNotLimitedTrial', 'BadRequestImageBatch', 'BadRequestImageStream',
* 'BadRequestImageUrl', 'BadRequestImageFormat', 'BadRequestImageSizeBytes',
* 'BadRequestImageExceededCount', 'BadRequestTrainingNotNeeded',
* 'BadRequestTrainingNotNeededButTrainingPipelineUpdated', 'BadRequestTrainingValidationFailed',
* 'BadRequestClassificationTrainingValidationFailed',
* 'BadRequestMultiClassClassificationTrainingValidationFailed',
* 'BadRequestMultiLabelClassificationTrainingValidationFailed',
* 'BadRequestDetectionTrainingValidationFailed', 'BadRequestTrainingAlreadyInProgress',
* 'BadRequestDetectionTrainingNotAllowNegativeTag', 'BadRequestInvalidEmailAddress',
* 'BadRequestDomainNotSupportedForAdvancedTraining',
* 'BadRequestExportPlatformNotSupportedForAdvancedTraining',
* 'BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining',
* 'BadRequestExportValidationFailed', 'BadRequestExportAlreadyInProgress',
* 'BadRequestPredictionIdsMissing', 'BadRequestPredictionIdsExceededCount',
* 'BadRequestPredictionTagsExceededCount', 'BadRequestPredictionResultsExceededCount',
* 'BadRequestPredictionInvalidApplicationName', 'BadRequestPredictionInvalidQueryParameters',
* 'BadRequestInvalid', 'UnsupportedMediaType', 'Forbidden', 'ForbiddenUser',
* 'ForbiddenUserResource', 'ForbiddenUserSignupDisabled',
* 'ForbiddenUserSignupAllowanceExceeded', 'ForbiddenUserDoesNotExist', 'ForbiddenUserDisabled',
* 'ForbiddenUserInsufficientCapability', 'ForbiddenDRModeEnabled', 'ForbiddenInvalid',
* 'NotFound', 'NotFoundProject', 'NotFoundProjectDefaultIteration', 'NotFoundIteration',
* 'NotFoundIterationPerformance', 'NotFoundTag', 'NotFoundImage', 'NotFoundDomain',
* 'NotFoundApimSubscription', 'NotFoundInvalid', 'Conflict', 'ConflictInvalid', 'ErrorUnknown',
* 'ErrorProjectInvalidWorkspace', 'ErrorProjectInvalidPipelineConfiguration',
* 'ErrorProjectInvalidDomain', 'ErrorProjectTrainingRequestFailed',
* 'ErrorProjectExportRequestFailed', 'ErrorFeaturizationServiceUnavailable',
* 'ErrorFeaturizationQueueTimeout', 'ErrorFeaturizationInvalidFeaturizer',
* 'ErrorFeaturizationAugmentationUnavailable', 'ErrorFeaturizationUnrecognizedJob',
* 'ErrorFeaturizationAugmentationError', 'ErrorExporterInvalidPlatform',
* 'ErrorExporterInvalidFeaturizer', 'ErrorExporterInvalidClassifier',
* 'ErrorPredictionServiceUnavailable', 'ErrorPredictionModelNotFound',
* 'ErrorPredictionModelNotCached', 'ErrorPrediction', 'ErrorPredictionStorage',
* 'ErrorRegionProposal', 'ErrorInvalid'
*/
code: string;
/**
* A message explaining the error reported by the service.
*/
message: string;
}

Просмотреть файл

@ -52,3 +52,4 @@ exports.Project = require('./project');
exports.Iteration = require('./iteration');
exports.ExportModel = require('./exportModel');
exports.Tag = require('./tag');
exports.CustomVisionError = require('./customVisionError');

Просмотреть файл

@ -18,22 +18,29 @@ class Iteration {
/**
* Create a Iteration.
* @property {uuid} [id] Gets the id of the iteration.
* @property {string} [name] Gets or sets the name of the iteration.
* @property {boolean} [isDefault] Gets or sets a value indicating whether
* the iteration is the default iteration for the project.
* @property {string} name Gets or sets the name of the iteration.
* @property {string} [status] Gets the current iteration status.
* @property {date} [created] Gets the time this iteration was completed.
* @property {date} [lastModified] Gets the time this iteration was last
* modified.
* @property {date} [trainedAt] Gets the time this iteration was last
* modified.
* @property {uuid} [projectId] Gets The project id. of the iteration.
* @property {uuid} [projectId] Gets the project id of the iteration.
* @property {boolean} [exportable] Whether the iteration can be exported to
* another format for download.
* @property {array} [exportableTo] A set of platforms this iteration can
* export to.
* @property {uuid} [domainId] Get or sets a guid of the domain the iteration
* has been trained on.
* @property {string} [classificationType] Gets the classification type of
* the project. Possible values include: 'Multiclass', 'Multilabel'
* @property {string} [trainingType] Gets the training type of the iteration.
* Possible values include: 'Regular', 'Advanced'
* @property {number} [reservedBudgetInHours] Gets the reserved advanced
* training budget for the iteration.
* @property {string} [publishName] Name of the published model.
* @property {string} [originalPublishResourceId] Resource Provider Id this
* iteration was originally published to.
*/
constructor() {
}
@ -62,24 +69,16 @@ class Iteration {
}
},
name: {
required: false,
nullable: true,
required: true,
nullable: false,
serializedName: 'name',
type: {
name: 'String'
}
},
isDefault: {
required: false,
nullable: false,
serializedName: 'isDefault',
type: {
name: 'Boolean'
}
},
status: {
required: false,
nullable: true,
nullable: false,
readOnly: true,
serializedName: 'status',
type: {
@ -131,6 +130,21 @@ class Iteration {
name: 'Boolean'
}
},
exportableTo: {
required: false,
readOnly: true,
serializedName: 'exportableTo',
type: {
name: 'Sequence',
element: {
required: false,
serializedName: 'StringElementType',
type: {
name: 'String'
}
}
}
},
domainId: {
required: false,
nullable: true,
@ -148,6 +162,42 @@ class Iteration {
type: {
name: 'String'
}
},
trainingType: {
required: false,
nullable: false,
readOnly: true,
serializedName: 'trainingType',
type: {
name: 'String'
}
},
reservedBudgetInHours: {
required: false,
nullable: false,
readOnly: true,
serializedName: 'reservedBudgetInHours',
type: {
name: 'Number'
}
},
publishName: {
required: false,
nullable: true,
readOnly: true,
serializedName: 'publishName',
type: {
name: 'String'
}
},
originalPublishResourceId: {
required: false,
nullable: true,
readOnly: true,
serializedName: 'originalPublishResourceId',
type: {
name: 'String'
}
}
}
}

Просмотреть файл

@ -47,7 +47,6 @@ class IterationPerformance {
modelProperties: {
perTagPerformance: {
required: false,
nullable: true,
readOnly: true,
serializedName: 'perTagPerformance',
type: {

Просмотреть файл

@ -11,19 +11,20 @@
'use strict';
/**
* Class representing a Prediction.
* Prediction result.
*
*/
class Prediction {
/**
* Create a Prediction.
* @property {number} [probability]
* @property {uuid} [tagId]
* @property {string} [tagName]
* @property {object} [boundingBox]
* @property {number} [boundingBox.left]
* @property {number} [boundingBox.top]
* @property {number} [boundingBox.width]
* @property {number} [boundingBox.height]
* @property {number} [probability] Probability of the tag.
* @property {uuid} [tagId] Id of the predicted tag.
* @property {string} [tagName] Name of the predicted tag.
* @property {object} [boundingBox] Bounding box of the prediction.
* @property {number} [boundingBox.left] Coordinate of the left boundary.
* @property {number} [boundingBox.top] Coordinate of the top boundary.
* @property {number} [boundingBox.width] Width.
* @property {number} [boundingBox.height] Height.
*/
constructor() {
}
@ -71,6 +72,7 @@ class Prediction {
},
boundingBox: {
required: false,
nullable: true,
readOnly: true,
serializedName: 'boundingBox',
type: {

Просмотреть файл

@ -48,6 +48,7 @@ class PredictionQueryResult {
modelProperties: {
token: {
required: false,
nullable: false,
readOnly: true,
serializedName: 'token',
type: {
@ -57,7 +58,6 @@ class PredictionQueryResult {
},
results: {
required: false,
nullable: true,
readOnly: true,
serializedName: 'results',
type: {

Просмотреть файл

@ -46,7 +46,7 @@ class PredictionQueryToken {
modelProperties: {
session: {
required: false,
nullable: true,
nullable: false,
serializedName: 'session',
type: {
name: 'String'
@ -54,7 +54,7 @@ class PredictionQueryToken {
},
continuation: {
required: false,
nullable: true,
nullable: false,
serializedName: 'continuation',
type: {
name: 'String'
@ -78,7 +78,6 @@ class PredictionQueryToken {
},
tags: {
required: false,
nullable: true,
serializedName: 'tags',
type: {
name: 'Sequence',
@ -118,7 +117,7 @@ class PredictionQueryToken {
},
application: {
required: false,
nullable: true,
nullable: false,
serializedName: 'application',
type: {
name: 'String'

Просмотреть файл

@ -17,21 +17,24 @@
class Project {
/**
* Create a Project.
* @property {uuid} [id] Gets The project id.
* @property {string} [name] Gets or sets the name of the project.
* @property {string} [description] Gets or sets the description of the
* @property {uuid} [id] Gets the project id.
* @property {string} name Gets or sets the name of the project.
* @property {string} description Gets or sets the description of the
* project.
* @property {object} [settings] Gets or sets the project settings.
* @property {object} settings Gets or sets the project settings.
* @property {uuid} [settings.domainId] Gets or sets the id of the Domain to
* use with this project.
* @property {string} [settings.classificationType] Gets or sets the
* classification type of the project. Possible values include: 'Multiclass',
* 'Multilabel'
* @property {array} [settings.targetExportPlatforms] A list of
* ExportPlatform that the trained model should be able to support.
* @property {date} [created] Gets the date this project was created.
* @property {date} [lastModified] Gets the date this project was last
* modifed.
* modified.
* @property {string} [thumbnailUri] Gets the thumbnail url representing the
* project.
* image.
* @property {boolean} [drModeEnabled] Gets if the DR mode is on.
*/
constructor() {
}
@ -60,23 +63,24 @@ class Project {
}
},
name: {
required: false,
nullable: true,
required: true,
nullable: false,
serializedName: 'name',
type: {
name: 'String'
}
},
description: {
required: false,
nullable: true,
required: true,
nullable: false,
serializedName: 'description',
type: {
name: 'String'
}
},
settings: {
required: false,
required: true,
nullable: false,
serializedName: 'settings',
type: {
name: 'Composite',
@ -103,12 +107,21 @@ class Project {
},
thumbnailUri: {
required: false,
nullable: true,
nullable: false,
readOnly: true,
serializedName: 'thumbnailUri',
type: {
name: 'String'
}
},
drModeEnabled: {
required: false,
nullable: true,
readOnly: true,
serializedName: 'drModeEnabled',
type: {
name: 'Boolean'
}
}
}
}

Просмотреть файл

@ -21,6 +21,8 @@ class ProjectSettings {
* this project.
* @property {string} [classificationType] Gets or sets the classification
* type of the project. Possible values include: 'Multiclass', 'Multilabel'
* @property {array} [targetExportPlatforms] A list of ExportPlatform that
* the trained model should be able to support.
*/
constructor() {
}
@ -54,6 +56,20 @@ class ProjectSettings {
type: {
name: 'String'
}
},
targetExportPlatforms: {
required: false,
serializedName: 'targetExportPlatforms',
type: {
name: 'Sequence',
element: {
required: false,
serializedName: 'StringElementType',
type: {
name: 'String'
}
}
}
}
}
}

Просмотреть файл

@ -16,11 +16,11 @@
class Region {
/**
* Create a Region.
* @property {uuid} [tagId] Id of the tag associated with this region.
* @property {number} [left]
* @property {number} [top]
* @property {number} [width]
* @property {number} [height]
* @property {uuid} tagId Id of the tag associated with this region.
* @property {number} left Coordinate of the left boundary.
* @property {number} top Coordinate of the top boundary.
* @property {number} width Width.
* @property {number} height Height.
*/
constructor() {
}
@ -40,7 +40,7 @@ class Region {
className: 'Region',
modelProperties: {
tagId: {
required: false,
required: true,
nullable: false,
serializedName: 'tagId',
type: {
@ -48,7 +48,7 @@ class Region {
}
},
left: {
required: false,
required: true,
nullable: false,
serializedName: 'left',
type: {
@ -56,7 +56,7 @@ class Region {
}
},
top: {
required: false,
required: true,
nullable: false,
serializedName: 'top',
type: {
@ -64,7 +64,7 @@ class Region {
}
},
width: {
required: false,
required: true,
nullable: false,
serializedName: 'width',
type: {
@ -72,7 +72,7 @@ class Region {
}
},
height: {
required: false,
required: true,
nullable: false,
serializedName: 'height',
type: {

Просмотреть файл

@ -18,10 +18,10 @@ class RegionProposal {
* Create a RegionProposal.
* @property {number} [confidence]
* @property {object} [boundingBox]
* @property {number} [boundingBox.left]
* @property {number} [boundingBox.top]
* @property {number} [boundingBox.width]
* @property {number} [boundingBox.height]
* @property {number} [boundingBox.left] Coordinate of the left boundary.
* @property {number} [boundingBox.top] Coordinate of the top boundary.
* @property {number} [boundingBox.width] Width.
* @property {number} [boundingBox.height] Height.
*/
constructor() {
}
@ -51,6 +51,7 @@ class RegionProposal {
},
boundingBox: {
required: false,
nullable: false,
readOnly: true,
serializedName: 'boundingBox',
type: {

Просмотреть файл

@ -24,11 +24,11 @@ class StoredImagePrediction {
* @property {string} [originalImageUri] The URI to the original prediction
* image.
* @property {uuid} [domain] Domain used for the prediction.
* @property {uuid} [id]
* @property {uuid} [project]
* @property {uuid} [iteration]
* @property {date} [created]
* @property {array} [predictions]
* @property {uuid} [id] Prediction Id.
* @property {uuid} [project] Project Id.
* @property {uuid} [iteration] Iteration Id.
* @property {date} [created] Date this prediction was created.
* @property {array} [predictions] List of predictions.
*/
constructor() {
}
@ -49,7 +49,7 @@ class StoredImagePrediction {
modelProperties: {
resizedImageUri: {
required: false,
nullable: true,
nullable: false,
readOnly: true,
serializedName: 'resizedImageUri',
type: {
@ -58,7 +58,7 @@ class StoredImagePrediction {
},
thumbnailUri: {
required: false,
nullable: true,
nullable: false,
readOnly: true,
serializedName: 'thumbnailUri',
type: {
@ -67,7 +67,7 @@ class StoredImagePrediction {
},
originalImageUri: {
required: false,
nullable: true,
nullable: false,
readOnly: true,
serializedName: 'originalImageUri',
type: {
@ -121,7 +121,6 @@ class StoredImagePrediction {
},
predictions: {
required: false,
nullable: true,
readOnly: true,
serializedName: 'predictions',
type: {

Просмотреть файл

@ -18,10 +18,10 @@ class Tag {
/**
* Create a Tag.
* @property {uuid} [id] Gets the Tag ID.
* @property {string} [name] Gets or sets the name of the tag.
* @property {string} [description] Gets or sets the description of the tag.
* @property {string} [type] Gets or sets the type of the tag. Possible
* values include: 'Regular', 'Negative'
* @property {string} name Gets or sets the name of the tag.
* @property {string} description Gets or sets the description of the tag.
* @property {string} type Gets or sets the type of the tag. Possible values
* include: 'Regular', 'Negative'
* @property {number} [imageCount] Gets the number of images with this tag.
*/
constructor() {
@ -51,23 +51,23 @@ class Tag {
}
},
name: {
required: false,
nullable: true,
required: true,
nullable: false,
serializedName: 'name',
type: {
name: 'String'
}
},
description: {
required: false,
nullable: true,
required: true,
nullable: false,
serializedName: 'description',
type: {
name: 'String'
}
},
type: {
required: false,
required: true,
nullable: false,
serializedName: 'type',
type: {

Просмотреть файл

@ -56,7 +56,7 @@ class TagPerformance {
},
name: {
required: false,
nullable: true,
nullable: false,
readOnly: true,
serializedName: 'name',
type: {

Просмотреть файл

@ -17,9 +17,9 @@ export default class TrainingAPIClient extends ServiceClient {
* Initializes a new instance of the TrainingAPIClient class.
* @constructor
*
* @param {string} apiKey -
* @param {string} apiKey - API key.
*
* @param {string} endpoint - Supported Cognitive Services endpoints
* @param {string} endpoint - Supported Cognitive Services endpoints.
*
* @param {object} [options] - The parameter options
*
@ -351,7 +351,7 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {array} imageIds Image ids. Limited to 64 images.
*
* @param {array} tagIds Tags to be deleted from the specified images. Limted
* @param {array} tagIds Tags to be deleted from the specified images. Limited
* to 20 tags.
*
* @param {object} [options] Optional Parameters.
@ -374,7 +374,7 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {array} imageIds Image ids. Limited to 64 images.
*
* @param {array} tagIds Tags to be deleted from the specified images. Limted
* @param {array} tagIds Tags to be deleted from the specified images. Limited
* to 20 tags.
*
* @param {object} [options] Optional Parameters.
@ -805,7 +805,8 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {uuid} projectId The project id.
*
* @param {object} imageData Binary image data.
* @param {object} imageData Binary image data. Supported formats are JPEG,
* GIF, PNG, and BMP. Supports images up to 6MB.
*
* @param {object} [options] Optional Parameters.
*
@ -832,7 +833,8 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {uuid} projectId The project id.
*
* @param {object} imageData Binary image data.
* @param {object} imageData Binary image data. Supported formats are JPEG,
* GIF, PNG, and BMP. Supports images up to 6MB.
*
* @param {object} [options] Optional Parameters.
*
@ -874,7 +876,7 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {uuid} projectId The project id.
*
* @param {array} imageIds Ids of the images to be deleted. Limted to 256
* @param {array} imageIds Ids of the images to be deleted. Limited to 256
* images per batch.
*
* @param {object} [options] Optional Parameters.
@ -895,7 +897,7 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {uuid} projectId The project id.
*
* @param {array} imageIds Ids of the images to be deleted. Limted to 256
* @param {array} imageIds Ids of the images to be deleted. Limited to 256
* images per batch.
*
* @param {object} [options] Optional Parameters.
@ -1087,8 +1089,8 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {uuid} projectId The project id.
*
* @param {object} batch Image and tag ids. Limted to 64 images and 20 tags per
* batch.
* @param {object} batch Image and tag ids. Limited to 64 images and 20 tags
* per batch.
*
* @param {array} [batch.images]
*
@ -1115,8 +1117,8 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {uuid} projectId The project id.
*
* @param {object} batch Image and tag ids. Limted to 64 images and 20 tags per
* batch.
* @param {object} batch Image and tag ids. Limited to 64 images and 20 tags
* per batch.
*
* @param {array} [batch.images]
*
@ -1286,10 +1288,10 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {uuid} projectId The project to evaluate against.
*
* @param {object} imageUrl An {Iris.Web.Api.Models.ImageUrl} that contains the
* url of the image to be evaluated.
* @param {object} imageUrl An ImageUrl that contains the url of the image to
* be evaluated.
*
* @param {string} [imageUrl.url]
* @param {string} imageUrl.url Url of the image.
*
* @param {object} [options] Optional Parameters.
*
@ -1313,10 +1315,10 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {uuid} projectId The project to evaluate against.
*
* @param {object} imageUrl An {Iris.Web.Api.Models.ImageUrl} that contains the
* url of the image to be evaluated.
* @param {object} imageUrl An ImageUrl that contains the url of the image to
* be evaluated.
*
* @param {string} [imageUrl.url]
* @param {string} imageUrl.url Url of the image.
*
* @param {object} [options] Optional Parameters.
*
@ -1359,7 +1361,8 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {uuid} projectId The project id.
*
* @param {object} imageData Binary image data.
* @param {object} imageData Binary image data. Supported formats are JPEG,
* GIF, PNG, and BMP. Supports images up to 6MB.
*
* @param {object} [options] Optional Parameters.
*
@ -1383,7 +1386,8 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {uuid} projectId The project id.
*
* @param {object} imageData Binary image data.
* @param {object} imageData Binary image data. Supported formats are JPEG,
* GIF, PNG, and BMP. Supports images up to 6MB.
*
* @param {object} [options] Optional Parameters.
*
@ -1830,6 +1834,9 @@ export default class TrainingAPIClient extends ServiceClient {
* @param {string} [options.classificationType] The type of classifier to
* create for this project. Possible values include: 'Multiclass', 'Multilabel'
*
* @param {array} [options.targetExportPlatforms] List of platforms the trained
* model is intending exporting to.
*
* @param {object} [options.customHeaders] Headers that will be added to the
* request
*
@ -1839,7 +1846,7 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @reject {Error|ServiceError} - The error object.
*/
createProjectWithHttpOperationResponse(name: string, options?: { description? : string, domainId? : string, classificationType? : string, customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.Project>>;
createProjectWithHttpOperationResponse(name: string, options?: { description? : string, domainId? : string, classificationType? : string, targetExportPlatforms? : string[], customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.Project>>;
/**
* @summary Create a project.
@ -1856,6 +1863,9 @@ export default class TrainingAPIClient extends ServiceClient {
* @param {string} [options.classificationType] The type of classifier to
* create for this project. Possible values include: 'Multiclass', 'Multilabel'
*
* @param {array} [options.targetExportPlatforms] List of platforms the trained
* model is intending exporting to.
*
* @param {object} [options.customHeaders] Headers that will be added to the
* request
*
@ -1881,9 +1891,9 @@ export default class TrainingAPIClient extends ServiceClient {
*
* {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur.
*/
createProject(name: string, options?: { description? : string, domainId? : string, classificationType? : string, customHeaders? : { [headerName: string]: string; } }): Promise<models.Project>;
createProject(name: string, options?: { description? : string, domainId? : string, classificationType? : string, targetExportPlatforms? : string[], customHeaders? : { [headerName: string]: string; } }): Promise<models.Project>;
createProject(name: string, callback: ServiceCallback<models.Project>): void;
createProject(name: string, options: { description? : string, domainId? : string, classificationType? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.Project>): void;
createProject(name: string, options: { description? : string, domainId? : string, classificationType? : string, targetExportPlatforms? : string[], customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.Project>): void;
/**
@ -2002,12 +2012,12 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {object} updatedProject The updated project model.
*
* @param {string} [updatedProject.name] Gets or sets the name of the project.
* @param {string} updatedProject.name Gets or sets the name of the project.
*
* @param {string} [updatedProject.description] Gets or sets the description of
* @param {string} updatedProject.description Gets or sets the description of
* the project.
*
* @param {object} [updatedProject.settings] Gets or sets the project settings.
* @param {object} updatedProject.settings Gets or sets the project settings.
*
* @param {uuid} [updatedProject.settings.domainId] Gets or sets the id of the
* Domain to use with this project.
@ -2016,6 +2026,9 @@ export default class TrainingAPIClient extends ServiceClient {
* the classification type of the project. Possible values include:
* 'Multiclass', 'Multilabel'
*
* @param {array} [updatedProject.settings.targetExportPlatforms] A list of
* ExportPlatform that the trained model should be able to support.
*
* @param {object} [options] Optional Parameters.
*
* @param {object} [options.customHeaders] Headers that will be added to the
@ -2036,12 +2049,12 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {object} updatedProject The updated project model.
*
* @param {string} [updatedProject.name] Gets or sets the name of the project.
* @param {string} updatedProject.name Gets or sets the name of the project.
*
* @param {string} [updatedProject.description] Gets or sets the description of
* @param {string} updatedProject.description Gets or sets the description of
* the project.
*
* @param {object} [updatedProject.settings] Gets or sets the project settings.
* @param {object} updatedProject.settings Gets or sets the project settings.
*
* @param {uuid} [updatedProject.settings.domainId] Gets or sets the id of the
* Domain to use with this project.
@ -2050,6 +2063,9 @@ export default class TrainingAPIClient extends ServiceClient {
* the classification type of the project. Possible values include:
* 'Multiclass', 'Multilabel'
*
* @param {array} [updatedProject.settings.targetExportPlatforms] A list of
* ExportPlatform that the trained model should be able to support.
*
* @param {object} [options] Optional Parameters.
*
* @param {object} [options.customHeaders] Headers that will be added to the
@ -2082,6 +2098,87 @@ export default class TrainingAPIClient extends ServiceClient {
updateProject(projectId: string, updatedProject: models.Project, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.Project>): void;
/**
* @summary Queues project for training.
*
* @param {uuid} projectId The project id.
*
* @param {object} [options] Optional Parameters.
*
* @param {string} [options.trainingType] The type of training to use to train
* the project (default: Regular). Possible values include: 'Regular',
* 'Advanced'
*
* @param {number} [options.reservedBudgetInHours] The number of hours reserved
* as budget for training (if applicable).
*
* @param {boolean} [options.forceTrain] Whether to force train even if dataset
* and configuration does not change (default: false).
*
* @param {string} [options.notificationEmailAddress] The email address to send
* notification to when training finishes (default: null).
*
* @param {object} [options.customHeaders] Headers that will be added to the
* request
*
* @returns {Promise} A promise is returned
*
* @resolve {HttpOperationResponse<Iteration>} - The deserialized result object.
*
* @reject {Error|ServiceError} - The error object.
*/
trainProjectWithHttpOperationResponse(projectId: string, options?: { trainingType? : string, reservedBudgetInHours? : number, forceTrain? : boolean, notificationEmailAddress? : string, customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.Iteration>>;
/**
* @summary Queues project for training.
*
* @param {uuid} projectId The project id.
*
* @param {object} [options] Optional Parameters.
*
* @param {string} [options.trainingType] The type of training to use to train
* the project (default: Regular). Possible values include: 'Regular',
* 'Advanced'
*
* @param {number} [options.reservedBudgetInHours] The number of hours reserved
* as budget for training (if applicable).
*
* @param {boolean} [options.forceTrain] Whether to force train even if dataset
* and configuration does not change (default: false).
*
* @param {string} [options.notificationEmailAddress] The email address to send
* notification to when training finishes (default: null).
*
* @param {object} [options.customHeaders] Headers that will be added to the
* request
*
* @param {ServiceCallback} [optionalCallback] - The optional callback.
*
* @returns {ServiceCallback|Promise} If a callback was passed as the last
* parameter then it returns the callback else returns a Promise.
*
* {Promise} A promise is returned.
*
* @resolve {Iteration} - The deserialized result object.
*
* @reject {Error|ServiceError} - The error object.
*
* {ServiceCallback} optionalCallback(err, result, request, response)
*
* {Error|ServiceError} err - The Error object if an error occurred, null otherwise.
*
* {Iteration} [result] - The deserialized result object if an error did not occur.
* See {@link Iteration} for more information.
*
* {WebResource} [request] - The HTTP Request object if an error did not occur.
*
* {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur.
*/
trainProject(projectId: string, options?: { trainingType? : string, reservedBudgetInHours? : number, forceTrain? : boolean, notificationEmailAddress? : string, customHeaders? : { [headerName: string]: string; } }): Promise<models.Iteration>;
trainProject(projectId: string, callback: ServiceCallback<models.Iteration>): void;
trainProject(projectId: string, options: { trainingType? : string, reservedBudgetInHours? : number, forceTrain? : boolean, notificationEmailAddress? : string, customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.Iteration>): void;
/**
* @summary Get iterations for the project.
*
@ -2262,12 +2359,9 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {object} updatedIteration The updated iteration model.
*
* @param {string} [updatedIteration.name] Gets or sets the name of the
* @param {string} updatedIteration.name Gets or sets the name of the
* iteration.
*
* @param {boolean} [updatedIteration.isDefault] Gets or sets a value
* indicating whether the iteration is the default iteration for the project.
*
* @param {object} [options] Optional Parameters.
*
* @param {object} [options.customHeaders] Headers that will be added to the
@ -2290,12 +2384,9 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {object} updatedIteration The updated iteration model.
*
* @param {string} [updatedIteration.name] Gets or sets the name of the
* @param {string} updatedIteration.name Gets or sets the name of the
* iteration.
*
* @param {boolean} [updatedIteration.isDefault] Gets or sets a value
* indicating whether the iteration is the default iteration for the project.
*
* @param {object} [options] Optional Parameters.
*
* @param {object} [options.customHeaders] Headers that will be added to the
@ -2329,10 +2420,17 @@ export default class TrainingAPIClient extends ServiceClient {
/**
* @summary Queues project for training.
* @summary Publish a specific iteration.
*
* @param {uuid} projectId The project id.
*
* @param {uuid} iterationId The iteration id.
*
* @param {string} publishName The name to give the published iteration.
*
* @param {string} predictionId The id of the prediction resource to publish
* to.
*
* @param {object} [options] Optional Parameters.
*
* @param {object} [options.customHeaders] Headers that will be added to the
@ -2340,17 +2438,24 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @returns {Promise} A promise is returned
*
* @resolve {HttpOperationResponse<Iteration>} - The deserialized result object.
* @resolve {HttpOperationResponse<Boolean>} - The deserialized result object.
*
* @reject {Error|ServiceError} - The error object.
*/
trainProjectWithHttpOperationResponse(projectId: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<models.Iteration>>;
publishIterationWithHttpOperationResponse(projectId: string, iterationId: string, publishName: string, predictionId: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<boolean>>;
/**
* @summary Queues project for training.
* @summary Publish a specific iteration.
*
* @param {uuid} projectId The project id.
*
* @param {uuid} iterationId The iteration id.
*
* @param {string} publishName The name to give the published iteration.
*
* @param {string} predictionId The id of the prediction resource to publish
* to.
*
* @param {object} [options] Optional Parameters.
*
* @param {object} [options.customHeaders] Headers that will be added to the
@ -2363,7 +2468,7 @@ export default class TrainingAPIClient extends ServiceClient {
*
* {Promise} A promise is returned.
*
* @resolve {Iteration} - The deserialized result object.
* @resolve {Boolean} - The deserialized result object.
*
* @reject {Error|ServiceError} - The error object.
*
@ -2371,16 +2476,73 @@ export default class TrainingAPIClient extends ServiceClient {
*
* {Error|ServiceError} err - The Error object if an error occurred, null otherwise.
*
* {Iteration} [result] - The deserialized result object if an error did not occur.
* See {@link Iteration} for more information.
* {Boolean} [result] - The deserialized result object if an error did not occur.
*
* {WebResource} [request] - The HTTP Request object if an error did not occur.
*
* {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur.
*/
trainProject(projectId: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<models.Iteration>;
trainProject(projectId: string, callback: ServiceCallback<models.Iteration>): void;
trainProject(projectId: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<models.Iteration>): void;
publishIteration(projectId: string, iterationId: string, publishName: string, predictionId: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<boolean>;
publishIteration(projectId: string, iterationId: string, publishName: string, predictionId: string, callback: ServiceCallback<boolean>): void;
publishIteration(projectId: string, iterationId: string, publishName: string, predictionId: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<boolean>): void;
/**
* @summary Unpublish a specific iteration.
*
* @param {uuid} projectId The project id.
*
* @param {uuid} iterationId The iteration id.
*
* @param {object} [options] Optional Parameters.
*
* @param {object} [options.customHeaders] Headers that will be added to the
* request
*
* @returns {Promise} A promise is returned
*
* @resolve {HttpOperationResponse<null>} - The deserialized result object.
*
* @reject {Error|ServiceError} - The error object.
*/
unpublishIterationWithHttpOperationResponse(projectId: string, iterationId: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<HttpOperationResponse<void>>;
/**
* @summary Unpublish a specific iteration.
*
* @param {uuid} projectId The project id.
*
* @param {uuid} iterationId The iteration id.
*
* @param {object} [options] Optional Parameters.
*
* @param {object} [options.customHeaders] Headers that will be added to the
* request
*
* @param {ServiceCallback} [optionalCallback] - The optional callback.
*
* @returns {ServiceCallback|Promise} If a callback was passed as the last
* parameter then it returns the callback else returns a Promise.
*
* {Promise} A promise is returned.
*
* @resolve {null} - The deserialized result object.
*
* @reject {Error|ServiceError} - The error object.
*
* {ServiceCallback} optionalCallback(err, result, request, response)
*
* {Error|ServiceError} err - The Error object if an error occurred, null otherwise.
*
* {null} [result] - The deserialized result object if an error did not occur.
*
* {WebResource} [request] - The HTTP Request object if an error did not occur.
*
* {http.IncomingMessage} [response] - The HTTP Response stream if an error did not occur.
*/
unpublishIteration(projectId: string, iterationId: string, options?: { customHeaders? : { [headerName: string]: string; } }): Promise<void>;
unpublishIteration(projectId: string, iterationId: string, callback: ServiceCallback<void>): void;
unpublishIteration(projectId: string, iterationId: string, options: { customHeaders? : { [headerName: string]: string; } }, callback: ServiceCallback<void>): void;
/**
@ -2449,12 +2611,12 @@ export default class TrainingAPIClient extends ServiceClient {
* @param {uuid} iterationId The iteration id.
*
* @param {string} platform The target platform. Possible values include:
* 'CoreML', 'TensorFlow', 'DockerFile', 'ONNX'
* 'CoreML', 'TensorFlow', 'DockerFile', 'ONNX', 'VAIDK'
*
* @param {object} [options] Optional Parameters.
*
* @param {string} [options.flavor] The flavor of the target platform. Possible
* values include: 'Linux', 'Windows', 'ONNX10', 'ONNX12'
* values include: 'Linux', 'Windows', 'ONNX10', 'ONNX12', 'ARM'
*
* @param {object} [options.customHeaders] Headers that will be added to the
* request
@ -2475,12 +2637,12 @@ export default class TrainingAPIClient extends ServiceClient {
* @param {uuid} iterationId The iteration id.
*
* @param {string} platform The target platform. Possible values include:
* 'CoreML', 'TensorFlow', 'DockerFile', 'ONNX'
* 'CoreML', 'TensorFlow', 'DockerFile', 'ONNX', 'VAIDK'
*
* @param {object} [options] Optional Parameters.
*
* @param {string} [options.flavor] The flavor of the target platform. Possible
* values include: 'Linux', 'Windows', 'ONNX10', 'ONNX12'
* values include: 'Linux', 'Windows', 'ONNX10', 'ONNX12', 'ARM'
*
* @param {object} [options.customHeaders] Headers that will be added to the
* request
@ -2644,12 +2806,12 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {object} updatedTag The updated tag model.
*
* @param {string} [updatedTag.name] Gets or sets the name of the tag.
* @param {string} updatedTag.name Gets or sets the name of the tag.
*
* @param {string} [updatedTag.description] Gets or sets the description of the
* @param {string} updatedTag.description Gets or sets the description of the
* tag.
*
* @param {string} [updatedTag.type] Gets or sets the type of the tag. Possible
* @param {string} updatedTag.type Gets or sets the type of the tag. Possible
* values include: 'Regular', 'Negative'
*
* @param {object} [options] Optional Parameters.
@ -2674,12 +2836,12 @@ export default class TrainingAPIClient extends ServiceClient {
*
* @param {object} updatedTag The updated tag model.
*
* @param {string} [updatedTag.name] Gets or sets the name of the tag.
* @param {string} updatedTag.name Gets or sets the name of the tag.
*
* @param {string} [updatedTag.description] Gets or sets the description of the
* @param {string} updatedTag.description Gets or sets the description of the
* tag.
*
* @param {string} [updatedTag.type] Gets or sets the type of the tag. Possible
* @param {string} updatedTag.type Gets or sets the type of the tag. Possible
* values include: 'Regular', 'Negative'
*
* @param {object} [options] Optional Parameters.

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -2,9 +2,9 @@
"name": "azure-cognitiveservices-customvision-training",
"author": "Microsoft Corporation",
"description": "TrainingAPIClient Library with typescript type definitions for node",
"version": "2.0.0",
"version": "3.0.0",
"dependencies": {
"ms-rest": "^2.3.3"
"ms-rest": "^2.5.0"
},
"keywords": [
"node",
@ -20,5 +20,8 @@
},
"bugs": {
"url": "https://github.com/azure/azure-sdk-for-node/issues"
},
"scripts": {
"postinstall": "node .scripts/postinstall.js"
}
}