@tilde-nlp/asr-api-client - npm Package Compare versions

Comparing version 2.0.0 to 2.0.1

tilde-nlp-asr-api-client-2.0.1.tgz

package.json

		{
		"name": "@tilde-nlp/asr-api-client",
		"version": "2.0.0",
		"version": "2.0.1",
		"description": "Library with services for communicating with Tilde TSP platform",
		@@ -5,0 +5,0 @@ "private": false,

README.md

		# asr-api-client library
		Library is created for implementing dictation. There is no UI components as this package is meant to be only as service for comunication.
		Library is created for implementing dictation. There is no UI components as this package is meant to be only as service for comunication. It is written with typescript and also includes typescript models.

		## Build

		Library is compiled with webpack. To prepare solution for packaging, execute ``` npm run build```. Packaged library is written into dist folder and ```npm publish``` should be run from that folder.

		## Examples

		Execute this code when you need to start recording voice, and replace configuration values as necessary.
		Here is small example to use service in html with plain javascript.

		First, you need to create new AsrClient. For more info about configuration - check asr-client-configuration* interface.*
		```javascript
		const config: AsrClientConfiguration = {
		appId: YOUR_APP_ID, // ask from person responsible for implementation
		appSecret: YOUR_APP_SECRET, // ask from person responsible for implementation
		language: LANGUAGE, // input language
		apiUrl: API_URL, // defaults to "runa.tilde.lv"
		visualizerId: VISUALIZER_ID, // id for canvas element if you would like to see audio visualization
		onResult: result => console.log(result), // partial or final result
		onRecordingStartStop: isRecording=> console.log(isRecording), // boolean value emitted whenever isRecording changes
		onError: error=> console.error(error) // error callback
		}
		const asrClient = new AsrClient(config);
		```
		then you have access to method to start recording
		```javascript
		asrClient.beginVoiceRecognition();
		```
		to stop recording
		```javascript
		asrClient.endVoiceRecognition();
		```
		```html
		<!DOCTYPE html>
		<html lang="en">

		When you have created client, you can also access visualizer and see input visualization
		```javascript
		asrClient.audioVisualizer?.visualizeAudio()
		```
		<head>
		<meta charset="UTF-8">
		<meta http-equiv="X-UA-Compatible" content="IE=edge">
		<meta name="viewport" content="width=device-width, initial-scale=1.0">
		<title>Tilde speech recognition example</title>
		<!-- Include mediarecorder api -->
		<script src="https://cdn.webrtc-experiment.com/MediaStreamRecorder.js"> </script>
		<!-- Include Tilde asr api client -->
		<script src="https://unpkg.com/@tilde-nlp/asr-api-client@latest/index.js"></script>
		</head>

		## Good to know
		To autonomate build and publish process, there is additional scripts that are executed.
		<body>
		<script language="javascript">
		// set up config
		var config = {
		url: "wss://services.tilde.com/service/asr/ws/${SYSTEM_NAME}/?contentType=audio/x-raw&sampleRate=44100&channelCount=1&x-api-key=${API_KEY}",
		onResult: result => { if (result.final) console.log(result) }, // partial or final result
		onRecordingStartStop: isRecording => console.log(isRecording), // boolean value emitted whenever isRecording changes
		onError: error => console.error(error) // error callback
		}
		// Create asr client
		var asrClient = new window["asr-api-client"].AsrClient(config);
		// Start voice recognition
		asrClient.beginVoiceRecognition();
		</script>
		</body>

		auto_version_patch.ps1 - script for automatically updating package patch version. To execute it - just run ```npm run autoVersionUpdate``` in console.

		set-up-package.js - this file is responsible for cleaning up package.json from devdependencies and scripts, since they are not necessary in release build. This script also makes sure that this edited package.json file is copied to dist folder, together with readme file.

		NOTE - autoversion script should be executed before set-up-package.js, so that correct version is in package.json end file
		</html>
		```

tilde-nlp-asr-api-client-2.0.0.tgz

@tilde-nlp/asr-api-client - npm Package Compare versions

New alerts

Fixed alerts

Worsened metrics