From 60b77f24074a2d4043107cb074e309b41049f663 Mon Sep 17 00:00:00 2001 From: Mnn-Devnagri Date: Tue, 12 Nov 2024 13:45:50 +0530 Subject: [PATCH] remove-voice-api-documentation --- guide/VoiceTranslationApi.md | 50 ------------------------------------ 1 file changed, 50 deletions(-) delete mode 100644 guide/VoiceTranslationApi.md diff --git a/guide/VoiceTranslationApi.md b/guide/VoiceTranslationApi.md deleted file mode 100644 index 3a29a390..00000000 --- a/guide/VoiceTranslationApi.md +++ /dev/null @@ -1,50 +0,0 @@ -# Voice Translation APIs - -This document contains the APIs related to the ASR, speech to text translation and text to speech translation. - -## Speech to text API - -> **POST** `https://voice-alpha.devnagri.dev/api/audio/speech-to-text` - -### Request - -```curl -curl --location --request POST 'https://voice-alpha.devnagri.dev/api/audio/speech-to-text' \ ---header 'accept: application/json, text/plain, */*' \ ---form 'soundBlob=@"//Devnagri/audio/hindi.wav"' \ ---form 'lang="hi-IN"' ---form 'hasFlag="1"' -``` - -### Response - -```json -{ - "status": "success", - "data": { - "status": "success", - "transcript": "एक एक पाँच आठ चार एक पाँच पाँच दस", - "transliterated_transcript": "ek ek paanch aath char ek paanch paanch das", - "flag": 0 - } -} -``` - -This API is responsible to take audio file as input and return the text. - -#### Request parameters - -The request requires input in the form data - -| Key | Is Required | Sample value | Description -| ------------- |:-------------:|:-------------:|:-------------:| -| soundBlob | Required | hindi.wav | This will be the actual audio file. Supported formats are `.wav` and `.amr-wb` | -| lang | Required | hi-IN | language code of the audio file. | -| hasFlag | Optional | 1 | If this is set to `1`, the API will check for the flagged words which is present in the response "transcript" and return with `flag` as `0`(does not contains flagged words) and `1`(contains flagged words) | - -##### Languages codes with sample files - -| Language | Code | Sample File -| ------------- |:-------------:|:-------------:| -| English | en-IN | | -| Hindi | hi-IN | | \ No newline at end of file