Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

augnitoambientsdk

Package Overview
Dependencies
Maintainers
0
Versions
38
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

augnitoambientsdk

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/

  • 1.1.9
  • npm
  • Socket score

Version published
Weekly downloads
117
decreased by-40%
Maintainers
0
Weekly downloads
 
Created
Source

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

import { AugnitoAmbient, AmbientConfig } from "augnitoambientsdk";

2- Create the configuration file and instantiate Augnito Ambient Manager

private ambientConfig: AmbientConfig = {
    server: '<your server>',
    subscriptionCode: '<your subscriptionCode>',
    accessKey: '<your accessKey>',
    userTag: '<your usertag>',
    enableLogs: false, // set to true to check sdk logs in the browser console
};

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.

//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!

// Toggles the recodring
augnitoAmbient.toggleListening(filetype:string, noteparams:string);
example: augnitoAmbient.toggleListening("wav","{'Region': 801, 'Specialty': 200, 'NoteType': 40, 'Gender': 0}")

//Toggles Pause/Resume recording
augnitoAmbient.togglePauseResumeListening(
    filetype: string,
    noteparams: string
);
example: augnitoAmbient.togglePauseResumeListening("wav","{'Region': 801, 'Specialty': 200, 'NoteType': 40, 'Gender': 0}")

/**
* Stops the recording and cleans up the resources
* This function needs to be explicitly called whenever togglePauseResumeListening() function is used
*/
augnitoAmbient.stopListening();

//#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

//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.

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

Keywords

FAQs

Package last updated on 19 Jul 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc