image_classification

ImageClassification - JavaScript client for image_classification service for image classification This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install image_classification --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your image_classification from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('image_classification') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/image_classification then install it via:

    npm install YOUR_USERNAME/image_classification --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var ImageClassification = require('image_classification');

var defaultClient = ImageClassification.ApiClient.instance;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new ImageClassification.ImageClassificationApi()

var executionId = "executionId_example"; // {String} Execution id of the execution.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.cancelAndDeleteBatchExecution(executionId, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
ImageClassification.ImageClassificationApi	cancelAndDeleteBatchExecution	DELETE /api/ImageClassification/1.0.0/batch/{executionId}	Cancels and deletes all batch executions for ImageClassification.
ImageClassification.ImageClassificationApi	getBatchExecutionFile	GET /api/ImageClassification/1.0.0/batch/{executionId}/{index}/files/{fileName}	Gets a specific file from an execution in ImageClassification.
ImageClassification.ImageClassificationApi	getBatchExecutionFiles	GET /api/ImageClassification/1.0.0/batch/{executionId}/{index}/files	Gets all files from an individual execution in ImageClassification.
ImageClassification.ImageClassificationApi	getBatchExecutionStatus	GET /api/ImageClassification/1.0.0/batch/{executionId}	Gets all batch executions for ImageClassification.
ImageClassification.ImageClassificationApi	getBatchExecutions	GET /api/ImageClassification/1.0.0/batch	Gets all batch executions for ImageClassification.
ImageClassification.ImageClassificationApi	runInferenceOnImage	POST /api/ImageClassification/1.0.0
ImageClassification.ImageClassificationApi	startBatchExecution	POST /api/ImageClassification/1.0.0/batch
ImageClassification.UserApi	login	POST /login	Logs the user in
ImageClassification.UserApi	renewToken	POST /login/refreshToken	The user renews access token and refresh token
ImageClassification.UserApi	revokeRefreshToken	DELETE /login/refreshToken	The user revokes a refresh token

Documentation for Models

• ImageClassification.AccessTokenResponse
• ImageClassification.BatchWebServiceResult
• ImageClassification.Error
• ImageClassification.InputParameters
• ImageClassification.LoginRequest
• ImageClassification.OutputParameters
• ImageClassification.RenewTokenRequest
• ImageClassification.StartBatchExecutionResponse
• ImageClassification.WebServiceResult

Documentation for Authorization

Bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header