edge-impulse-api 1.22.0

package/LICENSE

@@ -0,0 +1,165 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, "control" means (i) the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+"Object" form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+"submitted" means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+If the Work includes a "NOTICE" text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.

package/README.md

@@ -0,0 +1,144 @@
+# Node.js bindings to the Edge Impulse Studio API
+
+This package contains bindings to the [Edge Impulse API](https://docs.edgeimpulse.com/reference/edge-impulse-api/edge-impulse-api) - it lets you automate anything that you can do through the Studio UI (and much more).
+
+We're currently working on updating the [API docs](https://docs.edgeimpulse.com/reference/edge-impulse-api/edge-impulse-api) to reference this library in the examples. Until then we recommend you use the TypeScript types to see the exact specs for calling the API functions.
+
+## Installing this package
+
+```
+$ npm install edge-impulse-api
+```
+
+## Examples
+
+### Instantiating this library
+
+**JavaScript**
+
+```js
+const EdgeImpulseApi = require('edge-impulse-api').EdgeImpulseApi;
+const api = new EdgeImpulseApi();
+```
+
+**TypeScript**
+
+```js
+import { EdgeImpulseApi } from 'edge-impulse-api';
+const api = new EdgeImpulseApi();
+```
+
+### Authenticating
+
+**API Key**
+
+API Keys give access to a single project, and have a permission scope.
+
+```js
+const EdgeImpulseApi = require('edge-impulse-api').EdgeImpulseApi;
+
+(async () => {
+    const api = new EdgeImpulseApi();
+    await api.authenticate({
+        method: 'apiKey',
+        apiKey: 'ei_...', // your API key here
+    });
+})();
+```
+
+**Username / password**
+
+Username / password authentication gives access to every single project in your account. Where possible use API keys instead (which also have permission scoping). You can cache the JWT token (typically valid for 30 days, unless your enterprise administrator has reconfigured this) to avoid putting your username/password into code.
+
+```js
+const EdgeImpulseApi = require('edge-impulse-api').EdgeImpulseApi;
+
+(async () => {
+    try {
+        const api = new EdgeImpulseApi();
+
+        const jwtToken = await api.login.login({
+            username: 'myusername',
+            password: 'mypassword'
+        });
+
+        await api.authenticate({
+            method: 'jwtToken',
+            jwtToken: jwtToken.token || '',
+        });
+    }
+    catch (ex) {
+        // check token expiration via:
+        const tokenExpired = (ex.message || ex.toString()).indexOf('Your JWT token has expired') > -1;
+        if (tokenExpired) {
+            console.log('Token was expired, need to re-log in', ex);
+            process.exit(1);
+        }
+
+        console.log('Failed to make a request', ex);
+        process.exit(1);
+    }
+})();
+```
+
+### Calling API functions
+
+Here's an example of [List active projects](https://docs.edgeimpulse.com/reference/edge-impulse-api/projects/list-active-projects) and [Project information](https://docs.edgeimpulse.com/reference/edge-impulse-api/projects/project-information).
+
+```js
+let projects = await api.projects.listProjects();
+console.log('all projects', projects.projects.map(p => {
+    return {
+        id: p.id,
+        name: p.name,
+        owner: p.owner,
+    };
+}));
+
+let projectInfo = await api.projects.getProjectInfo(projects.projects[0].id);
+console.log('projectInfo', projectInfo);
+```
+
+As stated above, the TypeScript type hints are a good way to discover the request and response types.
+
+### Running jobs
+
+Long-running API calls (e.g. training a network) return a job. Here's how you wait for a job to complete, and how to get job log messages:
+
+```js
+(async () => {
+    try {
+        const PROJECT_ID = 12345
+
+        let impulseRes = await api.impulse.getImpulse(PROJECT_ID);
+        if (!impulseRes.impulse) {
+            throw new Error('Project has no impulse');
+        }
+        let kerasBlock = impulseRes.impulse.learnBlocks.find(x => x.type.indexOf('keras') > -1);
+        if (!kerasBlock) {
+            throw new Error('Failed to find a Keras block in ' + JSON.stringify(impulseRes.impulse, null, 4));
+        }
+
+        // grab the config
+        let kerasConfig = await api.learn.getKeras(PROJECT_ID, kerasBlock.id);
+
+        // and retrain with same config
+        let trainJob = await api.jobs.trainKerasJob(PROJECT_ID, kerasBlock.id, kerasConfig);
+        console.log('Created train job with ID', trainJob.id);
+
+        await api.runJobUntilCompletion({
+            type: 'project',
+            projectId: PROJECT_ID,
+            jobId: trainJob.id,
+        }, data => {
+            process.stdout.write(data);
+        });
+
+        console.log('Train job completed');
+    }
+    catch (ex) {
+        console.log('Failed to make a request', ex);
+        process.exit(1);
+    }
+})();
+```