testaugnitoambientsdk/README.md

Use this typescript SDK to integrate Augnito’s Ambient Tech within your EMR. To get access credentials or know more about how Augnito Ambient can benefit you, please visit our website and connect with our sales team: https://augnito.ai/

# Augnito Ambient SDK

Use this typescript SDK to integrate Augnito’s Ambient Tech within your EMR. To get access credentials or know more about how Augnito Ambient can benefit you, please visit our website and connect with our sales team: https://augnito.ai/

## Installation

Install the library in your project

      npm install augnitoambientsdk

## Basic Usage

### 1- Import the library

```js
import AmbientConfig  from 'augnitoambientsdk/src/config/AmbientConfig';
import {AugnitoAmbient} from 'augnitoambientsdk/src/AugnitoAmbient';
```

### 2- Create the configuration file and instantiate Augnito Ambient Manager

```js
private ambientConfig: AmbientConfig = {
    server: '<your server>',
    subscriptionCode: '<your subscriptionCode>',
    accessKey: '<your accessKey>',
    userTag: '<your usertag>'
};

const augnitoAmbient = new AugnitoAmbient(ambientConfig);
```

### 3- Get Note Parameters

Get all parameters (category and values) that are allowed fields to be passed when creating a job to generate note.

```js
//Returns JSON of Note Parameters
const noteParamsJson = augnitoAmbient.getNoteParams();
```

### 4- Toogle the client

Now all you have to do is toggle the status when you want to start/stop recording!

```js
// Toggles the recodring
augnitoAmbient.toggleListening(filetype:string, noteparams:JSON);

//#region Callbacks

//Callback to change recording buton style
public onStateChanged?: (isRecording: boolean)

//Callback to receive the JOb Id
public onJobCreated?: (text: string)

//Callback to receive when an error occurs within the SDK
public onError?: (errorMessage: string)

//#endregion
```

### 5- Fetch Job Output

Get Transcript & Note for a JobID created against a UserTag

```js
//Returns Job Output JSON
const JobOutput = augnitoAmbient.getSummarizedNote(JobId:string);
```

### 6- Send Final Note

Send the final edited Note to help increase accuracy of output in future.

```js
augnitoAmbient.sendSummarizedNote(JobId:string, NoteDate:string);
```