# abacus_api AbacusApi - JavaScript client for abacus_api Abacus API This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: - API version: 1.1 - Package version: 1.1 - Build package: io.swagger.codegen.languages.JavascriptClientCodegen ## Installation ### For [Node.js](https://nodejs.org/) #### npm To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). Then install it via: ```shell 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: ```shell npm install ``` Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`: ```shell npm link ``` Finally, switch to the directory you want to use your abacus_api from, and run: ```shell npm link /path/to/ ``` 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: ```shell npm install GIT_USER_ID/GIT_REPO_ID --save ``` ### For browser The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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): ```shell 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: ```javascript module: { rules: [ { parser: { amd: false } } ] } ``` ## Getting Started Please follow the [installation](#installation) instruction and execute the following JS code: ```javascript 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**](docs/DatasetApi.md#datasetsDelete) | **DELETE** /datasets/ | Delete selected datasets *AbacusApi.DatasetApi* | [**datasetsGet**](docs/DatasetApi.md#datasetsGet) | **GET** /datasets/ | Get list of datasets *AbacusApi.DatasetApi* | [**datasetsIdDelete**](docs/DatasetApi.md#datasetsIdDelete) | **DELETE** /datasets/{id}/ | Delete dataset *AbacusApi.DatasetApi* | [**datasetsIdGet**](docs/DatasetApi.md#datasetsIdGet) | **GET** /datasets/{id}/ | Get Dataset info *AbacusApi.DatasetApi* | [**datasetsIdPatch**](docs/DatasetApi.md#datasetsIdPatch) | **PATCH** /datasets/{id}/ | Update dataset info *AbacusApi.DatasetApi* | [**datasetsIdPost**](docs/DatasetApi.md#datasetsIdPost) | **POST** /datasets/{id}/ | Copy the dataset and Update dataset info *AbacusApi.DatasetApi* | [**datasetsIdPreprocessPost**](docs/DatasetApi.md#datasetsIdPreprocessPost) | **POST** /datasets/{id}/preprocess/ | Start preprocessing of dataset *AbacusApi.DatasetApi* | [**datasetsPost**](docs/DatasetApi.md#datasetsPost) | **POST** /datasets/ | Create a new dataset *AbacusApi.ModelApi* | [**modelsDelete**](docs/ModelApi.md#modelsDelete) | **DELETE** /models/ | Delete selected models *AbacusApi.ModelApi* | [**modelsGet**](docs/ModelApi.md#modelsGet) | **GET** /models/ | Get list of models *AbacusApi.ModelApi* | [**modelsIdDelete**](docs/ModelApi.md#modelsIdDelete) | **DELETE** /models/{id}/ | Delete model *AbacusApi.ModelApi* | [**modelsIdGet**](docs/ModelApi.md#modelsIdGet) | **GET** /models/{id}/ | Get model info *AbacusApi.ModelApi* | [**modelsIdPatch**](docs/ModelApi.md#modelsIdPatch) | **PATCH** /models/{id}/ | Update model info *AbacusApi.ModelApi* | [**modelsIdTrainPost**](docs/ModelApi.md#modelsIdTrainPost) | **POST** /models/{id}/train/ | Start training of model *AbacusApi.ModelApi* | [**modelsPost**](docs/ModelApi.md#modelsPost) | **POST** /models/ | Create a new model *AbacusApi.PredictionApi* | [**predictionsDelete**](docs/PredictionApi.md#predictionsDelete) | **DELETE** /predictions/ | Delete selected predictions *AbacusApi.PredictionApi* | [**predictionsGet**](docs/PredictionApi.md#predictionsGet) | **GET** /predictions/ | Get list of predictions *AbacusApi.PredictionApi* | [**predictionsIdDelete**](docs/PredictionApi.md#predictionsIdDelete) | **DELETE** /predictions/{id}/ | Delete prediction *AbacusApi.PredictionApi* | [**predictionsIdGet**](docs/PredictionApi.md#predictionsIdGet) | **GET** /predictions/{id}/ | Get prediction info *AbacusApi.PredictionApi* | [**predictionsIdPatch**](docs/PredictionApi.md#predictionsIdPatch) | **PATCH** /predictions/{id}/ | Update prediction info *AbacusApi.PredictionApi* | [**predictionsIdPredictPost**](docs/PredictionApi.md#predictionsIdPredictPost) | **POST** /predictions/{id}/predict/ | Predict a prediction *AbacusApi.PredictionApi* | [**predictionsPost**](docs/PredictionApi.md#predictionsPost) | **POST** /predictions/ | Create a new prediction *AbacusApi.TaskApi* | [**tasksGet**](docs/TaskApi.md#tasksGet) | **GET** /tasks/ | Get list of all tasks *AbacusApi.TaskApi* | [**tasksIdAbortPost**](docs/TaskApi.md#tasksIdAbortPost) | **POST** /tasks/{id}/abort/ | Abort task *AbacusApi.TaskApi* | [**tasksIdGet**](docs/TaskApi.md#tasksIdGet) | **GET** /tasks/{id}/ | Get task info ## Documentation for Models - [AbacusApi.Algorithms](docs/Algorithms.md) - [AbacusApi.AlgorithmsInner](docs/AlgorithmsInner.md) - [AbacusApi.Body](docs/Body.md) - [AbacusApi.Body1](docs/Body1.md) - [AbacusApi.Body2](docs/Body2.md) - [AbacusApi.Body3](docs/Body3.md) - [AbacusApi.Body4](docs/Body4.md) - [AbacusApi.Body5](docs/Body5.md) - [AbacusApi.Body6](docs/Body6.md) - [AbacusApi.Body7](docs/Body7.md) - [AbacusApi.Body8](docs/Body8.md) - [AbacusApi.Body9](docs/Body9.md) - [AbacusApi.DatasetsidTypes](docs/DatasetsidTypes.md) - [AbacusApi.InlineResponse200](docs/InlineResponse200.md) - [AbacusApi.InlineResponse2001](docs/InlineResponse2001.md) - [AbacusApi.InlineResponse20010](docs/InlineResponse20010.md) - [AbacusApi.InlineResponse20010Tasks](docs/InlineResponse20010Tasks.md) - [AbacusApi.InlineResponse20011](docs/InlineResponse20011.md) - [AbacusApi.InlineResponse2002](docs/InlineResponse2002.md) - [AbacusApi.InlineResponse2002Schema](docs/InlineResponse2002Schema.md) - [AbacusApi.InlineResponse2002SchemaOptions](docs/InlineResponse2002SchemaOptions.md) - [AbacusApi.InlineResponse2002SchemaShape](docs/InlineResponse2002SchemaShape.md) - [AbacusApi.InlineResponse2002SchemaTop100](docs/InlineResponse2002SchemaTop100.md) - [AbacusApi.InlineResponse2002SchemaTypes](docs/InlineResponse2002SchemaTypes.md) - [AbacusApi.InlineResponse2003](docs/InlineResponse2003.md) - [AbacusApi.InlineResponse2004](docs/InlineResponse2004.md) - [AbacusApi.InlineResponse2004Dataset](docs/InlineResponse2004Dataset.md) - [AbacusApi.InlineResponse2004Models](docs/InlineResponse2004Models.md) - [AbacusApi.InlineResponse2005](docs/InlineResponse2005.md) - [AbacusApi.InlineResponse2006](docs/InlineResponse2006.md) - [AbacusApi.InlineResponse2006Dataset](docs/InlineResponse2006Dataset.md) - [AbacusApi.InlineResponse2006Performance](docs/InlineResponse2006Performance.md) - [AbacusApi.InlineResponse2006PerformanceAlgorithmName](docs/InlineResponse2006PerformanceAlgorithmName.md) - [AbacusApi.InlineResponse2006PerformanceAlgorithmNameCurves](docs/InlineResponse2006PerformanceAlgorithmNameCurves.md) - [AbacusApi.InlineResponse2006PerformanceAlgorithmNameDecile](docs/InlineResponse2006PerformanceAlgorithmNameDecile.md) - [AbacusApi.InlineResponse2006PerformanceAlgorithmNameFieldImportance](docs/InlineResponse2006PerformanceAlgorithmNameFieldImportance.md) - [AbacusApi.InlineResponse2006PerformanceAlgorithmNameThreshold](docs/InlineResponse2006PerformanceAlgorithmNameThreshold.md) - [AbacusApi.InlineResponse2006PerformanceAlgorithmNameTrain](docs/InlineResponse2006PerformanceAlgorithmNameTrain.md) - [AbacusApi.InlineResponse2006PerformanceAlgorithmNameTrainConfusionMatrix](docs/InlineResponse2006PerformanceAlgorithmNameTrainConfusionMatrix.md) - [AbacusApi.InlineResponse2007](docs/InlineResponse2007.md) - [AbacusApi.InlineResponse2007Predictions](docs/InlineResponse2007Predictions.md) - [AbacusApi.InlineResponse2008](docs/InlineResponse2008.md) - [AbacusApi.InlineResponse2009](docs/InlineResponse2009.md) - [AbacusApi.InlineResponse200Datasets](docs/InlineResponse200Datasets.md) - [AbacusApi.ModelSchema](docs/ModelSchema.md) - [AbacusApi.Sampling](docs/Sampling.md) ## Documentation for Authorization All endpoints do not require authorization.