javascript

vision

Vision - JavaScript client for vision Sphereon Vision APIs This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.2
• Package version: 0.2
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit https://sphereon.com

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 vision --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 vision from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('vision') 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/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --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 Vision = require('vision');

var defaultClient = Vision.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2schema
var oauth2schema = defaultClient.authentications['oauth2schema'];
oauth2schema.accessToken = "YOUR ACCESS TOKEN"

var api = new Vision.VisionApi()

var visionSettings = new Vision.VisionSettings(); // {VisionSettings} visionSettings


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

Documentation for API Endpoints

All URIs are relative to https://gw.api.cloud.sphereon.com/vision/0.2

Class	Method	HTTP request	Description
Vision.VisionApi	createVisionJob	POST /jobs	Create a new vision job
Vision.VisionApi	deleteVisionJob	DELETE /jobs/{jobId}	Delete a vision job manually
Vision.VisionApi	getVisionJob	GET /jobs/{jobId}	Get a vision job
Vision.VisionApi	submitVisionJob	PUT /jobs/{jobId}	Start classification of a vision job
Vision.VisionApi	uploadFile	POST /jobs/{jobId}/streams/multipart	Upload an image for a vision job

Documentation for Models

• Vision.Credentials
• Vision.Error
• Vision.ErrorResponse
• Vision.InputResource
• Vision.Lifecycle
• Vision.Result
• Vision.StatusMessage
• Vision.StorageSettings
• Vision.StreamLocation
• Vision.Tag
• Vision.VendorResult
• Vision.VisionJob
• Vision.VisionSettings

Documentation for Authorization

oauth2schema

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
  • global: accessEverything