Deep Intelligence Node connector
This is a Node.js module available through the npm registry for connect with the Deep Intelligence's API.
This module lets you connect the platform Deep Intelligence,using their functions, to your projects. It encapsulates by means of functions the different calls to the API in order to obtain the required data from it.
Table of Contents
✅ Install
npm i @airinstitute/deepint-connector
🚩 Usage
🔻
Example const deepint = require('@airinstitute/deepint-connector');
deepint.getWorkspaces()
.then(workspaces => {
console.log(workspaces);
})
.catch(err => {
console.log(err);
});
🔻
Functions The module contains all API functions with a characteristic function name: 'methodAPI'+'groupAsociated'+'groupFunctions'+'informationFunction'. Eg: get+Workspace+Visualization+ById = getWorkspaceVisualizationById(params);.
Here there is a list of functions you can use:
-
- postLoginToken
- postRevokeToken
-
- getProfile
- getSession
-
- getWorkspaces
- postWorkspaces
- postWorkspacesImport
- getWorkspaceById
- postWorkspaceById
- deleteWorkspaceById
- postIframe
- postWorkspace
- postWorkspaceClone
-
- getWorkspaceTasks
- getWorkspaceTaskById
- deleteWorkspaceTaskById
-
- getWorkspaceSources
- postWorkspaceSource
- postSourceClone
- postSourceDerived
- postSourceExternal
- postSourceOther
- getWorkspaceSourceById
- postWorkspaceSourceById
- deleteWorkspaceSourceById
- getConnectionSourceById
- postConnectionSourceById
- getAutoUpdateSourceById
- postAutoUpdateSourceById
- postTransformFeaturesSourcesById
- getSourceInstances
- postSourceInstances
- deleteSourceInstances
- postExternalSources
-
- getWorkspaceModels
- postWorkspaceModels
- getWorkspaceModelById
- postWorkspaceModelById
- deleteWorkspaceModelById
- getModelEvaluation
- getModelPredict
- postModelBatchPredict
- postModelPredict1d
-
- getWorkspaceAlerts
- postWorkspaceAlerts
- getWorkspaceAlertById
- postWorkspaceAlertById
- deleteWorkspaceAlertById
- getWorkspaceAlertInstances
-
- getWorkspaceEmails
- postWorkspaceEmails
- deleteWorkspaceEmailById
-
- getWorkspaceVisualizations
- postWorkspaceVisualizations
- getWorkspaceVisualizationById
- postWorkspaceVisualizationById
- deleteWorkspaceVisualizationById
- postCloneVisualizationById
-
- getWorkspaces
- postWorkspaces
- postWorkspacesImport
- getWorkspaceById
- postWorkspaceById
- deleteWorkspaceById
- postIframe
- postWorkspace
- postWorkspaceClone
These functions work asynchronously, so they return a promise.
🔻
Configuration To configure the module, set the following environment variables:
Variable Name | Description |
---|---|
X_AUTH_TOKEN | Token Authorization to connect to the API |
X_DEEPINT_ORGANIZATION | Organization Token |
DEEPINT_API_URL | Deep Intelligence API URL, default is https://app.deepint.net/api/v1/
|
For source configuration, set the following variables:
Variable Name | Description |
---|---|
SOURCE_PUB_KEY | Public key of the external source |
SOURCE_SECRET_KEY | External source secret key |
⌨️ Development Commands
Module repository for more information: https://github.com/deepintdev/deepint-node-connector
Start by running npm install
inside the module folder.
npm run tsc
to build the module,
npm run start
to build the module,
npm run pre
to run it in development mode.
To get the documentation of the module functions: npx typedoc --out docs
.
🌐 Built With
This project has been developed with TypeScript, Node Js and Express languages and technologies.
🙏 Acknowledgments
To express our gratitude to the following people involved in this project:
- Miguel Chaveinte García: https://github.com/miguelchaveinte
- Pablo Chamoso Santos: https://github.com/chamoso
- Francisco Pinto Santos: https://github.com/GandalFran
- Raúl López Blanco: https://github.com/raullb34
- Ángel Martín Domínguez: https://github.com/amartdom
- Alberto Galante Melero: https://github.com/Galazord