shaharsol / oneai_sdk_node

Node.js SDK for One AI APIs. One AI is an NLP-as-a-service platform. Our APIs enables language comprehension in context, transforming texts from any source into structured data to use in code.

One AI Node.js SDK

This SDK provides safe and convenient access to One AI's pipeline API from a Node environment.

One AI is an NLP as a service platform. Our APIs enables language comprehension in context, transforming texts from any source into structured data to use in code.

Documentation

See the One AI documentation

Getting started

Installation

npm install oneai

Authentication

Register and create a key for your project in the Studio. As a security measure we only show the key once, so make sure to keep it somewhere safe. Attach your key via the oneai.api_key field or by passing it to individual calls. Requests must be authenticated, and will fail without an active token.

Example

import oneai from 'oneai';
oneai.api_key = '<YOUR-API-KEY>';

let pipeline = new oneai.Pipeline(
    oneai.skills.entities(),
    oneai.skills.summarize({ min_length: 20 }),
    oneai.skills.highlights()
);
my_text = `One month after the United States began what has become a troubled rollout of a national COVID vaccination campaign, the effort is finally 
gathering real steam. Close to a million doses -- over 951,000, to be more exact -- made their way into the arms of Americans in the past 24 hours, the 
U.S. Centers for Disease Control and Prevention reported Wednesday. That's the largest number of shots given in one day since the rollout began and a big 
jump from the previous day, when just under 340,000 doses were given, CBS News reported. That number is likely to jump quickly after the federal government 
on Tuesday gave states the OK to vaccinate anyone over 65 and said it would release all the doses of vaccine it has available for distribution. Meanwhile, 
a number of states have now opened mass vaccination sites in an effort to get larger numbers of people inoculated, CBS News reported.`;
let output = await pipeline.run(my_text);
console.log(output);

Pipeline API

Language Skills

A Language Skill is a package of trained NLP models, available via API. Skills accept text from various language sources and respond with processed texts and extracted metadata.

Pipelines

Language AI pipelines allow invoking and chaining multiple Language Skills to process your input text with a single API call. Pipelines can be defined by listing the desired Skills.

let pipeline = new oneai.Pipeline(
    oneai.skills.entities(),
    oneai.skills.summarize({ min_length: 20 }),
    oneai.skills.highlights()
);

Output

The structure of the output is dynamic, and corresponds to the Skills used and their order in the pipeline. Each output object contains the input text (which can be the original input or text produced by generator Skills), and a list of labels detected by analyzer Skills, that contain the extracted data.

let output = await pipeline.run(my_text);

console.log(output.entities);
console.log(output.summary.text);
console.log(output.summary.highlights);