DexterHealth.STT 1.0.0-alpha

This is a prerelease version of DexterHealth.STT.
dotnet add package DexterHealth.STT --version 1.0.0-alpha
NuGet\Install-Package DexterHealth.STT -Version 1.0.0-alpha
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="DexterHealth.STT" Version="1.0.0-alpha" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add DexterHealth.STT --version 1.0.0-alpha
#r "nuget: DexterHealth.STT, 1.0.0-alpha"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install DexterHealth.STT as a Cake Addin
#addin nuget:?package=DexterHealth.STT&version=1.0.0-alpha&prerelease

// Install DexterHealth.STT as a Cake Tool
#tool nuget:?package=DexterHealth.STT&version=1.0.0-alpha&prerelease

Introduction

The DexterHealth.STT package enables users to record documentation of vital parameters of residents in nursing homes through voice and further transcripts the recorded audio into text. Additionally, important entities like lastname of the resident and the vital parameter values are extracted from the transcripted audio. The currently available parameters are Puls, Blutdruck, and Blutzucker.

Some example sentences are "der blutdruck von frau schneider ist einhundertvier", "frau peter hat einen puls von dreiundsiebzig", "herr schreiber hat einen blutzucker von hundertdreizehn". Please make sure to precede the resident's last name with salutation like "herr/frau".

Steps to Use

  1. Install the package with name DexterHealth.STT from nuget.org into the target application. Please check the "Include Pre-release" option while searching for the package as this is only a POC version.

  2. Make sure the following permissions are set in the AndroidManifest.xml. These are needed for recording audio and processing it further.

    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
    <uses-permission android:name="android.permission.RECORD_AUDIO" />
    
  3. Import the DexterHealth.STT interface as shown below:

     using Plugin.DexterHealthSTT;
    
  4. To start the recording, instantiate the DexterHealthSTTImplementation class as shown below:

     IDexterHealthSTT dexterHealthSTT;
     dexterHealthSTT = new DexterHealthSTTImplementation();
    

    Then, call the InitialiseRecorderAsync method with the security key provided to you by the dexter health team.

     var status = await dexterHealthSTT.InitialiseRecorderAsync("securityToken");
    
  5. If the initialisation has been successful, call the StartRecordingAsync method to record the user audio. Please make sure your microphone is on in the emulator/device before you let the users start their recording.

      if(status == "Initialisation Successful.")
      {
         var recordingStatus = await dexterHealthSTT.StartRecordingAsync();
      }
    
  6. Finally, when the user wants to stop recording, call the method StopRecordingAndGetResult and wait for the results.

     String results = await dexterHealthSTT.StopRecordingAndGetResultAsync();
    

    The output from this method is a json string that has the transcripted text from the audio along with the extracted entities like shown below:

     {
     	"data":
     		{
     			"category":"Blutzuckermessung",
     			"entities": {"lastname":"Arnold","quantities":["91"]},
     			"text":"dokumentiere blutzucker von einundneunzig bei frau arnold"
     		}
     }
    

If there is any error message/exception, please restart the app or retry the recording from the beginning. Please contact the dexter health team if the issue persists.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard1.0 is compatible.  netstandard1.1 was computed.  netstandard1.2 was computed.  netstandard1.3 was computed.  netstandard1.4 was computed.  netstandard1.5 was computed.  netstandard1.6 was computed.  netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net45 was computed.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed.  monoandroid90 is compatible. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen30 was computed.  tizen40 was computed.  tizen60 was computed. 
Universal Windows Platform uap was computed.  uap10.0 was computed. 
Windows Phone wp8 was computed.  wp81 was computed.  wpa81 was computed. 
Windows Store netcore was computed.  netcore45 was computed.  netcore451 was computed. 
Xamarin.iOS xamarinios was computed.  xamarinios10 is compatible. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.0-alpha 136 3/7/2022

This is the initial version that functions as a proof-of-concept for the integration of Speech-to-text functionality.