augnitosdk

Augnito Speech SDK

You’ve found the Augnito Speech SDK! You can use Augnito SDK to make use of the Speech Recognition AI. You can edit, format and complete reports at the speed of human speech, with the best-in-class accuracy. Now use your personal templates and short forms from any workstation whether you are in office, or at home or in the journey in between.

Set up Augnito SDK.

Install the library in your project

npm install augnitosdk

Create the configuration file and instantiate Augnito Client

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

const augnitoConfig: AugnitoConfig = {
  server: AugnitoAPIServer.INDIA,
  accountCode: 'XXXXXXXXXXXXXXXXXXXXXX',
  accessKey: 'XXXXXXXXXXXXXXXXXXXXXX',
  userTag: 'user123',
  sourceApp: 'MyAppName',
  lmId: '38'
  enableLogs: false,
  _listOfControls: myControlsArray
};

const augnito = new Augnito(augnitoConfig);

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!

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.

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

const code = augnito.getQRCode();

Augnito - Callbacks

Name	Signature	Description
onPartialResult?	(text: string) => void	Partial Result generated from the server
onFinalResult?	(finalText: Partial<Recipe>) => boolean	A final result is called when text has been processed by the Speech Server. Returns true to stop the processing in the SDK
onCommandResult?	(command: Partial<Recipe>) => boolean	A command generated from the server. Returns true to stop the processing in the SDK
onStateChanged?	(isConnected: boolean) => void	Callback to indicate the status of the connection has changed.
onSessionEvent?	(data: AugnitoSocketResponse) => void	Callback to intercept Session Events
onIdleMic?	() => void	Callback when the Mic is idle for 5 minutes

Augnito Mobile - Callbacks

Name	Signature	Description
onConnectionRequest?	() => void	Callback when a mobile client is requesting to connect
onMobileScan?	() => void	Callback when a mobile client has scanned the QR Code