augnitosdk v0.0.28

Augnito Speech SDK

You can use Augnito SDK to make use of the Speech Recognition AI. To get access credentials or talk to us about your project, get in touch with us at partnerships@augnito.ai.

Installation

Install the library in your project

npm install augnitosdk

Basic Usage

1- Import the library

import { Augnito, AugnitoConfig, AugnitoAPIServer } from 'augnitosdk';

2- Create the configuration file and instantiate Augnito Client

const augnitoConfig: AugnitoConfig = {
  server: <your server>,
  accountCode: '<your accountcode>',
  accessKey: '<your accesskey>',
  userTag: '<your usertag>',
  sourceApp: '<your sourceapp>',
  lmId: '<your lmid>',
};

const augnito = new Augnito(augnitoConfig);

3- Toogle the client!

Now all you have to do is toggle the status when you want to connect/disconnect!

// Toggles the Speech API connection
augnito.toggleListening();

That's all!

Note: If the client does not start, it may be that onMicrophoneOnError was called. This was implemented to prevent a user from opening a conection in multiple tabs. You can use requestMicOff to force close other connections.

augnito.onMicrophoneOnError = (isWebClient: boolean) => {
  //If you want to use Augnito in this tab.
  augnito.requestMicOff();
  augnito.toggleListening();
};

Mobile Application

Whether you want to use the Augnito App as your microphone, or you want to develop your own app, we got you covered.

All you have to do is initialize the mobile configuration. The SDK will generate a value that you need to use to generate a QR code which should be scanned in the App.

import { AugnitoMobileConfig } from 'augnitosdk';

const mobileConfig: AugnitoMobileConfig = {
  enableLogs: false
};
const augnitoMobile = augnito.initMobileClient(mobileConfig);

//Generate a QR Code with the following value
const code = augnito.getQRCode();

Augnito - Speech Related Callbacks

Augnito Mobile - Speech Related Callbacks

Augnito Methods

MacrosAPI

MacrosAPI Methods

1- Create Macros Client

// If you already have an augnito client..
const macrosClient = augnito.apisFactory.getMacrosAPI();

// OR
import { MacrosAPI } from 'augnitosdk';
const macrosClient = new MacrosAPI(
  accountCode,
  accessKey,
  AugnitoAPIServer.INDIA
);

2- Use the Macros Client to list, create, update or delete user macros

macrosClient
  .getMacros({
    UserTag: userTag
  })
  .then((result) => {
    console.log(result);
  });