aiWAREJsClient - JavaScript client for aiware-js-client
This is the API client for the AI Processing API. This SDK is automatically generated by the OpenAPI Generator project:
- API version: 3.44.2.5540
- Package version: 3.44.2.5540
- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
Installation
npm
To publish the library as a npm, please follow the procedure in "Publishing npm packages". Then install it via:
npm install aiware-js-client --save
Finally, you need to build the module:
npm run build
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
To use the link you just defined in your project, switch to the directory you want to use your aiware-js-client from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
git
If the library is hosted at a git repository, e.g. https://github.com/aiware/--api then install it via:
npm install aiware/--api --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):
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
Follow the installation instructions above and execute the following JS code:
var AiwareJsClient = require('aiware-js-client');
var defaultClient = AiwareJsClient.ApiClient.instance;
// Configure API key authorization: api_key
var api_key = defaultClient.authentications['api_key'];
api_key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key.apiKeyPrefix['api_key'] = "Token"
var api = new AiwareJsClient.AdminApi()
var resourceID = null; // {String} ID of Resource
var opts = {
'xCorrelationId': "xCorrelationId_example", // {String} Correlation Id that can be passed, traced in the server and will be returned in the response if present in the request
'addEngineForResourceRequest': new AiwareJsClient.AddEngineForResourceRequest() // {AddEngineForResourceRequest} Add Engine Mapping for Resource
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.addEngineToResource(resourceID, opts, callback);
Documentation for API endpoints
See Javascript documentation for API endpoints.
Documentation for models
See JavaScript documentation for models.
Documentation for authorization
api_key
- Type: API key
- API key parameter name: api_key
- Location: HTTP header
