Getting Started with FirstLanguage API

Introduction

Collection of NLP APIs to help developers. We have grouped the APIs under Basic and Advanced. Basic APIs cover all basic text operations like POSTag, Stemmer etc and Advanced cover all the APIs like QA, translation etc.

OpenAPI Specification

This API is documented in OpenAPI v3.0 format. In addition to standard OpenAPI syntax we use a few vendor extensions.

Building

Requirements

The SDK relies on Node.js and npm (to resolve dependencies). You can download and install Node.js and npm from the official Node.js website.

NOTE: npm is installed by default when Node.js is installed.

Verify Successful Installation

Run the following commands in the command prompt or shell of your choice to check if Node.js and npm are successfully installed:

• Node.js: node --version

• npm: npm --version

Usage

You can use our NPM published package by installing it usign below command

npm i firstlanguage-typescript

Or you can clone our repo

Install Dependencies when using from source

• To resolve all dependencies, go to the SDK root directory and run the following command with npm:

npm install

• This will install all dependencies in the node_modules folder.

Installation

The following section explains how to use the generated library in a new project.

1. Initialize the Node Project

• Open an IDE/text editor for JavaScript like Visual Studio Code. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

• Click on File and select Open Folder. Select an empty folder of your project, the folder will become visible in the sidebar on the left.

• To initialize the Node project, click on Terminal and select New Terminal. Execute the following command in the terminal:

npm init --y

2. Add Dependencies to the Client Library

• The created project manages its dependencies using its package.json file. In order to add a dependency on the FirstLanguage APILib client library, double click on the package.json file in the bar on the left and add the dependency to the package in it.

• To install the package in the project, run the following command in the terminal:

npm install

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
timeout	number	Timeout for API calls. Default: 0
apikey	string	API Key can be copied from your dashboard

The API client can be initialized as follows:

const client = new Client({
  timeout: 0,
  apikey: 'apikey',
})

Authorization

This API uses Custom Header Signature.

Example working code

Replace <Your_API_Key> with your API Key from portal dashboard

import { Client, BasicAPIsController, ApiError } from "firstlanguage-typescript";


const client = new Client({
    timeout: 0,
    apikey: '<Your_API_Key>',
  })

const basicAPIsController = new BasicAPIsController(client);

const contentType = null;
const body = `{
     "input":{
      "text":"Smiling makes everyone happy",
      "lang":"en"
    }
  }`;

   
basicAPIsController.getPostag(body).then(response => {
 console.log(response.result);  
}).catch(error => {
    if (error instanceof ApiError) {
        const errors = error.result;        
        console.log(errors);
      }
});

Save the above code into a example.js file. Run the above code using

node example.js

You will get an output like below

[
  { orginalText: 'Smiling', postag: 'VERB' },
  { orginalText: 'makes', postag: 'VERB' },
  { orginalText: 'everyone', postag: 'PRON' },
  { orginalText: 'happy', postag: 'ADJ' }
]

List of APIs

• Basic APIs
• Advanced APIs

Classes Documentation

• ApiResponse
• ApiError