api-abacus

Abacus_API

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
api-abacus
Minified + gzip package size for api-abacus in KB

Readme

abacus_api

AbacusApi - JavaScript client for abacus_api Abacus API This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.1
  • Package version: 1.1
  • 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 abacus_api --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 abacus_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('abacus_api') 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 AbacusApi = require('abacus_api');

var api = new AbacusApi.DatasetApi()

var opts = { 
  'body': new AbacusApi.Body1() // {Body1} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.datasetsDelete(opts, callback);

Documentation for API Endpoints

All URIs are relative to https://localhost/AizenGlobal/Abacus/1.1

Class Method HTTP request Description
AbacusApi.DatasetApi datasetsDelete DELETE /datasets/ Delete selected datasets
AbacusApi.DatasetApi datasetsGet GET /datasets/ Get list of datasets
AbacusApi.DatasetApi datasetsIdDelete DELETE /datasets/{id}/ Delete dataset
AbacusApi.DatasetApi datasetsIdGet GET /datasets/{id}/ Get Dataset info
AbacusApi.DatasetApi datasetsIdPatch PATCH /datasets/{id}/ Update dataset info
AbacusApi.DatasetApi datasetsIdPost POST /datasets/{id}/ Copy the dataset and Update dataset info
AbacusApi.DatasetApi datasetsIdPreprocessPost POST /datasets/{id}/preprocess/ Start preprocessing of dataset
AbacusApi.DatasetApi datasetsPost POST /datasets/ Create a new dataset
AbacusApi.ModelApi modelsDelete DELETE /models/ Delete selected models
AbacusApi.ModelApi modelsGet GET /models/ Get list of models
AbacusApi.ModelApi modelsIdDelete DELETE /models/{id}/ Delete model
AbacusApi.ModelApi modelsIdGet GET /models/{id}/ Get model info
AbacusApi.ModelApi modelsIdPatch PATCH /models/{id}/ Update model info
AbacusApi.ModelApi modelsIdTrainPost POST /models/{id}/train/ Start training of model
AbacusApi.ModelApi modelsPost POST /models/ Create a new model
AbacusApi.PredictionApi predictionsDelete DELETE /predictions/ Delete selected predictions
AbacusApi.PredictionApi predictionsGet GET /predictions/ Get list of predictions
AbacusApi.PredictionApi predictionsIdDelete DELETE /predictions/{id}/ Delete prediction
AbacusApi.PredictionApi predictionsIdGet GET /predictions/{id}/ Get prediction info
AbacusApi.PredictionApi predictionsIdPatch PATCH /predictions/{id}/ Update prediction info
AbacusApi.PredictionApi predictionsIdPredictPost POST /predictions/{id}/predict/ Predict a prediction
AbacusApi.PredictionApi predictionsPost POST /predictions/ Create a new prediction
AbacusApi.TaskApi tasksGet GET /tasks/ Get list of all tasks
AbacusApi.TaskApi tasksIdAbortPost POST /tasks/{id}/abort/ Abort task
AbacusApi.TaskApi tasksIdGet GET /tasks/{id}/ Get task info

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.