diff --git a/docs/asr-api.md b/docs/asr-api.md new file mode 100644 index 0000000..99172df --- /dev/null +++ b/docs/asr-api.md @@ -0,0 +1,216 @@ +--- +id: speech-to-text-api +title: Speech-to-Text API +sidebar_label: Automatic Speech Recognition API +--- + +Automatic Speech Recognition API provides high-quality speech-to-text conversion powered by machine learning. The api also supports speaker diarization and smart punctuation to further enhance the utility of the transcribed output. + +### POST Request + +`POST https://proxy.api.deepaffects.com/audio/generic/api/v1/async/asr` + +### Sample Code + +### Shell + +```shell +curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v1/async/asr?apikey=&webhook=" -H 'content-type: application/json' -d @data.json + +# contents of data.json with content +{"content": "bytesEncodedAudioString", "sampleRate": 8000, "encoding": "FLAC", "languageCode": "en-US", "audioType": "callcenter", "enableSpeakerDiarization": true} + +# contents of data.json with url +{"url": "https://publicly-facing-url.flac", "sampleRate": 8000, "encoding": "FLAC", "languageCode": "en-US", "audioType": "callcenter", "enableSpeakerDiarization": true} +``` + +### Javascript + +```javascript +var request = require("request"); + +var options = { method: 'POST', + url: 'https://proxy.api.deepaffects.com/audio/generic/api/v1/async/asr', + qs: + { apikey: '', + webhook: ''}, + headers: + { 'Content-Type': 'application/json' }, + body: + { encoding: 'FLAC', + languageCode: 'en-US', + url: 'https://publicly-facing-url.flac', + sampleRate: 8000, + enableSpeakerDiarization: true, + audioType: "callcenter" }, + json: true }; + +request(options, function (error, response, body) { + if (error) throw new Error(error); + + console.log(body); +}); +``` + +### Python + +```python +import requests +import base64 + +url = "https://proxy.api.deepaffects.com/audio/generic/api/v1/async/asr" + +querystring = {"apikey":"", "webhook":""} + +payload = { + "encoding": "FLAC", + "languageCode": "en-US", + "sampleRate": 8000 + "audioType": "callcenter", + "enableSpeakerDiarization": true +} + +# The api accepts data either as a url or as base64 encoded content +# passing payload as url: +payload["url"] = "https://publicly-facing-url.flac" +# alternatively, passing payload as content: +with open(audio_file_name, 'rb') as fin: + audio_content = fin.read() +payload["content"] = base64.b64encode(audio_content).decode('utf-8') + +headers = { + 'Content-Type': "application/json", +} + +response = requests.post(url, json=payload, headers=headers, params=querystring) + +print(response.text) +``` + +### Output + +```shell + +# Async: + +{ +"request_id": "8bdd983a-c6bd-4159-982d-6a2471406d62", +"api": "requested_api_name" +} + +# Webhook: + +{ +"request_id": "8bdd983a-c6bd-4159-982d-6a2471406d62", +"response": { + "num_speakers": 2, + "confidence": 0.97, + "words":[ + { + "speaker_id": "1", + "start": 0, + "end": 1, + "word": "Hi", + "confidence": 0.97 + }, + { + "speaker_id": "2", + "start": 1.2, + "end": 2, + "word": "Hello", + "confidence": 0.97 + }, + { + "speaker_id": "2", + "start": 2, + "end": 2.6, + "word": "this", + "confidence": 0.97 + }, + { + "speaker_id": "2", + "start": 2.6, + "end": 3, + "word": "is", + "confidence": 0.97 + }, + { + "speaker_id": "2", + "start": 3, + "end": 4, + "word": "Susan", + "confidence": 0.97 + } + ], + "transcript": "Hi! Hello, this is Susan." + } +} +``` + +### Body Parameters + +| Parameter | Type | Description | Notes | +| ------------ | ------ | -------------------------------------------------------- | ---------------------------- | +| encoding | String | Encoding of audio file like MP3, WAV etc. | | +| sampleRate | Number | Sample rate of the audio file. | | +| languageCode | String | Language spoken in the audio file. | [default to 'en-US'] | +| audioType | String | Type of the audio based on number of speakers | [default to callcenter] | +| content | String | base64 encoding of the audio file. | Optional | +| url | String | Publicly facing url | Optional | +| source | String | The source for the audio file: webex, zoom, gotomeeting, phone | Optional | +| enableSpeakerDiarization | Boolean | Tags each word corresponding to the speaker | [default to false] | + +audioType: can have the following values: + 1) callcenter + 2) meeting + 3) earningscalls + 4) interview + 5) media-broadcast + +> We recommend using callcenter when there are upto 6 speakers expected to be identified and meeting when more than 6 speakers are expected. + +> Exactly one of url and content should be passed. In case both values are passed, error is thrown + +> source: Adding source information enables an enhanced model which is built specifically for those audio sources. + +### Query Parameters + +| Parameter | Type | Description | Notes | +| ---------- | ------ | ---------------------------------------------------------------------- | ----------------------------------------------- | +| apikey | String | The apikey | Required for authentication inside all requests | +| webhook | String | The webhook url at which the responses will be sent | Required for async requests | +| request_id | String | An optional unique id to link async response with the original request | Optional | + +### Output Parameters (Async) + +| Parameter | Type | Description | Notes | +| ---------- | ------ | ------------------------------- | ------------------------------------------------------------------ | +| request_id | String | The request id | This defaults to the originally sent id or is generated by the api | +| api | String | The api method which was called | | + +### Output Parameters (Webhook) + +| Parameter | Type | Description | Notes | +| ---------- | ------ | ------------------------------------ | ------------------------------------------------------------------ | +| request_id | String | The request id | This defaults to the originally sent id or is generated by the api | +| response | Object | The actual output of the transcription | The Transcribed object is defined below | + +#### Transcribed Object + +| Parameter | Type | Description | Notes | +| ------------ | ------ | ------------------------------- | ------------------------------------------------------------------------------- | +| num_speakers | Number | The number of speakers detected | Field is set only when `enableSpeakerDiarization` is `true` | +| words | List | List of word segments | The Word Segment is defined below | +| transcript | String | The entire transcript along with the punctuations powered by the Smart Punctuations API | | +| confidence | Number | Overall transcription confidence | | + + +#### Word Segment + +| Parameter | Type | Description | Notes | +| ---------- | ------ | -------------------------------------------------- | ----- | +| speaker_id | String | The speaker id for the corresponding audio segment | Field is set only when `enableSpeakerDiarization` is `true` | +| start | Number | Start time of the audio segment in seconds | | +| end | Number | End time of the audio segment in seconds | | +| word | String | The word corresponding to the audio segment | | +| confidence | Number | Confidence score for the word | | diff --git a/docs/audio-denoising-api.md b/docs/audio-denoising-api.md index 14de10e..69c1d50 100644 --- a/docs/audio-denoising-api.md +++ b/docs/audio-denoising-api.md @@ -1,7 +1,7 @@ --- id: audio-denoising-api -title: Audio Denoising Api -sidebar_label: Audio Denoising Api +title: Audio Denoising API +sidebar_label: Audio Denoising API --- Audio denoising api removes noise from your audio signals and returns the denoised audio clip @@ -44,7 +44,7 @@ apiInstance.asyncDenoiseAudio(body, webhook, callback); ```shell # async request -curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v2/async/denoise?apikey=>&webhook=&request_id=abcd-1234" -H 'content-type: application/json' -d @data.json +curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v2/async/denoise?apikey=>&webhook=" -H 'content-type: application/json' -d @data.json # contents of data.json {"content": "bytesEncodedAudioString", "sampleRate": 8000, "encoding": "FLAC", "languageCode": "en-US"} @@ -58,7 +58,7 @@ import base64 url = "https://proxy.api.deepaffects.com/audio/generic/api/v2/async/denoise" -querystring = {"apikey":"", "webhook":"", "request_id":""} +querystring = {"apikey":"", "webhook":""} payload = { "encoding": "Wave", @@ -125,7 +125,7 @@ print(response.text) | ---------- | ------ | ---------------------------------------------------------------------- | ----------------------------------------------- | | apikey | String | The apikey | Required for authentication inside all requests | | webhook | String | The webhook url at which the responses will be sent | Required for async requests | -| request_id | Number | An optional unique id to link async response with the original request | Optional | +| request_id | String | An optional unique id to link async response with the original request | Optional | ### Output Parameters (Async) diff --git a/docs/concepts.md b/docs/concepts.md index d94e9ad..7094c9f 100644 --- a/docs/concepts.md +++ b/docs/concepts.md @@ -18,7 +18,7 @@ To link up your requests to webhooks you can pass a `webhook` parameter when mak If you return anything other than a HTTP 200 status to the webhook POST then we’ll try to deliver the response to the webhook for up to 5 times with an exponential backoff. If we don't receive a 200 response from your server, we stop delivering the response. -For testing you can create a temporary webhook using https://beeceptor.com/ +For testing you can create a temporary webhook using https://webhook.site/ To know more about webhooks visit https://simonfredsted.com/1583 diff --git a/docs/depression-prediction-api.md b/docs/depression-prediction-api.md index e1d49de..7a3d277 100644 --- a/docs/depression-prediction-api.md +++ b/docs/depression-prediction-api.md @@ -1,7 +1,7 @@ --- id: depression-prediction-api -title: Depression Prediction Api -sidebar_label: Depression Prediction Api +title: Depression Prediction API +sidebar_label: Depression Prediction API --- Depression prediction api predicts whether the audio clip contains a depressed person @@ -27,7 +27,7 @@ Depression prediction api predicts whether the audio clip contains a depressed p ```shell curl -X POST "https://proxy.api.deepaffects.com/audio/custom/ellipsis/api/v1/sync/is_depressed?apikey=" -H 'content-type: application/json' -d @data.json -curl -X POST "https://proxy.api.deepaffects.com/audio/custom/ellipsis/api/v1/async/is_depressed?apikey=&webhook=&request_id=abcd-1234" -H 'content-type: application/json' -d @data.json +curl -X POST "https://proxy.api.deepaffects.com/audio/custom/ellipsis/api/v1/async/is_depressed?apikey=&webhook=" -H 'content-type: application/json' -d @data.json # contents of data.json {"content": "bytesEncodedAudioString", "sampleRate": 8000, "encoding": "FLAC", "languageCode": "en-US"} @@ -124,7 +124,7 @@ True | ---------- | ------ | ---------------------------------------------------------------------- | ----------------------------------------------- | | apikey | String | The apikey | Required for authentication inside all requests | | webhook | String | The webhook url at which the responses will be sent | Required for async requests | -| request_id | Number | An optional unique id to link async response with the original request | Optional | +| request_id | String | An optional unique id to link async response with the original request | Optional | ### Output Parameters (Sync) diff --git a/docs/emotion-recognition-api.md b/docs/emotion-recognition-api.md index 8ad3dc6..fa514a7 100644 --- a/docs/emotion-recognition-api.md +++ b/docs/emotion-recognition-api.md @@ -1,7 +1,7 @@ --- id: emotion-recognition-api -title: Emotion Recognition Api -sidebar_label: Emotion Recognition Api +title: Emotion Recognition API +sidebar_label: Emotion Recognition API --- Emotion recognition api extract basic emotions from the audio file @@ -19,7 +19,7 @@ Emotion recognition api extract basic emotions from the audio file ```shell curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v2/sync/recognise_emotion?apikey=" -H 'content-type: application/json' -d @data.json -curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v2/async/recognise_emotion?apikey=&webhook=&request_id=abcd-1234" -H 'content-type: application/json' -d @data.json +curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v2/async/recognise_emotion?apikey=&webhook=" -H 'content-type: application/json' -d @data.json # contents of data.json {"content": "bytesEncodedAudioString", "sampleRate": 8000, "encoding": "FLAC", "languageCode": "en-US"} @@ -80,7 +80,7 @@ curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v2/async/recog | ---------- | ------ | ---------------------------------------------------------------------- | ----------------------------------------------- | | apikey | String | The apikey | Required for authentication inside all requests | | webhook | String | The webhook url at which the responses will be sent | Required for async requests | -| request_id | Number | An optional unique id to link async response with the original request | Optional | +| request_id | String | An optional unique id to link async response with the original request | Optional | ### Output Parameters diff --git a/docs/interaction-analytics-api.md b/docs/interaction-analytics-api.md index d14ece0..f72ec3b 100644 --- a/docs/interaction-analytics-api.md +++ b/docs/interaction-analytics-api.md @@ -1,7 +1,7 @@ --- id: interaction-analytics-api -title: Interaction Analytics Api -sidebar_label: Interaction Analytics Api +title: Interaction Analytics API +sidebar_label: Interaction Analytics API --- DeepAffects Interaction Analytics API extracts comprehensive interaction based metrics from your audio data @@ -15,7 +15,7 @@ DeepAffects Interaction Analytics API extracts comprehensive interaction based m ### Shell ```shell -curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v1/async/analytics/interaction?apikey=&webhook=&request_id=" -H 'content-type: application/json' -d @data.json +curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v1/async/analytics/interaction?apikey=&webhook=" -H 'content-type: application/json' -d @data.json # contents of data.json {"content": "bytesEncodedAudioString", "sampleRate": 8000, "encoding": "FLAC", "languageCode": "en-US"} @@ -60,7 +60,7 @@ import base64 url = "https://proxy.api.deepaffects.com/audio/generic/api/v1/async/analytics/interaction" -querystring = {"apikey":"", "webhook":"", "request_id":""} +querystring = {"apikey":"", "webhook":""} payload = { "encoding": "FLAC", @@ -209,7 +209,7 @@ print(response.text) | ---------- | ------ | ---------------------------------------------------------------------- | ----------------------------------------------- | | apikey | String | The apikey | Required for authentication inside all requests | | webhook | String | The webhook url at which the responses will be sent | Required for async requests | -| request_id | Number | An optional unique id to link async response with the original request | Optional | +| request_id | String | An optional unique id to link async response with the original request | Optional | ### Output Parameters (Async) diff --git a/docs/job-status-api.md b/docs/job-status-api.md new file mode 100644 index 0000000..58cdc03 --- /dev/null +++ b/docs/job-status-api.md @@ -0,0 +1,131 @@ +--- +id: job-status-api +title: Job Status API +sidebar_label: Job Status API +--- + +Job Status API returns information about the status of the job and its corresponding output. + +### GET Request + +`GET https://proxy.api.deepaffects.com/transaction/generic/api/v1/async/status` + +### Sample Code + +### Shell + +```shell +curl -X GET \ + 'https://proxy.api.deepaffects.com/transaction/generic/api/v1/async/status?apikey=&request_id=' +``` + +### Javascript +```javascript +var request = require("request"); + +var options = { method: 'GET', + url: 'https://proxy.api.deepaffects.com/transaction/generic/api/v1/async/status', + qs: + { apikey: '', + request_id: '' }}; + +request(options, function (error, response, body) { + if (error) throw new Error(error); + + console.log(body); +}); +``` + +### Python +```python +import requests + +url = "https://proxy.api.deepaffects.com/transaction/generic/api/v1/async/status" + +querystring = {"apikey":"","request_id":""} + +payload = "" +headers = { + 'cache-control': "no-cache" + } + +response = requests.get(url, data=payload, headers=headers, params=querystring) + +print(response.text) +``` + +### Output + +```shell +{ + "response": { + "request_id": "", + "response": { + "confidence": 0.97, + "num_speakers": 2, + "transcript": "Hi! Hello, this is Susan.", + "words": [ + { + "confidence": 0.97, + "end": 1, + "speaker_id": "1", + "start": 0, + "word": "Hi" + }, + { + "confidence": 0.97, + "end": 2, + "speaker_id": "2", + "start": 1.2, + "word": "Hello" + }, + { + "confidence": 0.97, + "end": 2.6, + "speaker_id": "2", + "start": 2, + "word": "this" + }, + { + "confidence": 0.97, + "end": 3, + "speaker_id": "2", + "start": 2.6, + "word": "is" + }, + { + "confidence": 0.97, + "end": 4, + "speaker_id": "2", + "start": 3, + "word": "Susan" + } + ] + } + }, + "status": "Completed" +} +``` +### Query Parameters + +| Parameter | Type | Description | Notes | +| ---------- | ------ | ---------------------------------------------------------------------- | ----------------------------------------------- | +| apikey | String | The apikey | Required for authentication inside all requests | +| request_id | String | The request_id corresponding to the request | Required | + +> Note: Polling is NOT recommended in a production server. Rather, use webhooks to asynchronously recieve notifications once the job completes. If you have any further questions, contact us at support@seernet.io + + +### Output Parameters +| Parameter | Type | Description | Notes | +| ---------- | ------ | ---------------------------------------------------------------------- | ----------------------------------------------- | +| status | String | The status of the job: `Completed`, `Failed`, `Running` | | +| response | Object | The response corresponding to the transaction id | The Response Object defined below | + + +### Response Object + +| Parameter | Type | Description | Notes | +| ---------- | ------ | ---------------------------------------------------------------------- | ----------------------------------------------- | +| request_id | String | The request_id corresponding to the request | +| response | Object | The response object as defined in the required API type | | diff --git a/docs/paralinguistic-feature-extraction-api.md b/docs/paralinguistic-feature-extraction-api.md index a71557f..4bfd8bf 100644 --- a/docs/paralinguistic-feature-extraction-api.md +++ b/docs/paralinguistic-feature-extraction-api.md @@ -1,7 +1,7 @@ --- id: paralinguistic-feature-extraction-api -title: Paralinguistic Feature Extraction Api -sidebar_label: Paralinguistic Feature Extraction Api +title: Paralinguistic Feature Extraction API +sidebar_label: Paralinguistic Feature Extraction API --- Paralingustic feature extraction api extracts features from audio file as explained in the next section @@ -24,7 +24,7 @@ There are two stages in the audio feature extraction methodology: ```shell curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v1/sync/featurize?apikey=" -H 'content-type: application/json' -d @data.json -curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v1/async/featurize?apikey=&webhook=&request_id=abcd-1234" -H 'content-type: application/json' -d @data.json +curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v1/async/featurize?apikey=&webhook=" -H 'content-type: application/json' -d @data.json # contents of data.json {"content": "bytesEncodedAudioString", "sampleRate": 8000, "encoding": "FLAC", "languageCode": "en-US"} @@ -133,7 +133,7 @@ apiInstance.asyncFeaturizeAudio(body, webhook, callback); | ---------- | ------ | ---------------------------------------------------------------------- | ----------------------------------------------- | | apikey | String | The apikey | Required for authentication inside all requests | | webhook | String | The webhook url at which the responses will be sent | Required for async requests | -| request_id | Number | An optional unique id to link async response with the original request | Optional | +| request_id | String | An optional unique id to link async response with the original request | Optional | ### Output Parameters diff --git a/docs/realtime-emotion-recognition-api.md b/docs/realtime-emotion-recognition-api.md index dcc9787..fa2af56 100644 --- a/docs/realtime-emotion-recognition-api.md +++ b/docs/realtime-emotion-recognition-api.md @@ -1,7 +1,7 @@ --- id: realtime-emotion-recognition-api -title: Realtime Emotion Recognition Api -sidebar_label: Realtime Emotion Recognition Api +title: Realtime Emotion Recognition API +sidebar_label: Realtime Emotion Recognition API --- Realtime emotion recognition api Extracts basic emotions from the audio file in realtime diff --git a/docs/realtime-speaker-identification-api.md b/docs/realtime-speaker-identification-api.md index 8ca35c5..deb3bb4 100644 --- a/docs/realtime-speaker-identification-api.md +++ b/docs/realtime-speaker-identification-api.md @@ -1,7 +1,7 @@ --- id: realtime-speaker-identification-api -title: Realtime Speaker Identification Api -sidebar_label: Realtime Speaker Identification Api +title: Realtime Speaker Identification API +sidebar_label: Realtime Speaker Identification API --- Realtime speaker identification api identifies speakers from the audio file in realtime diff --git a/docs/speaker-diarization-api.md b/docs/speaker-diarization-api.md index da1a2e1..516c0e0 100644 --- a/docs/speaker-diarization-api.md +++ b/docs/speaker-diarization-api.md @@ -1,7 +1,7 @@ --- id: speaker-diarization-api -title: Speaker Diarization Api -sidebar_label: Speaker Diarization Api +title: Speaker Diarization API +sidebar_label: Speaker Diarization API --- Speaker diarization api tries to figure out "Who Speaks When". @@ -16,10 +16,10 @@ Splits audio clip into segments corresponding to a unique speaker ### Shell ```shell -curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v2/async/diarize?apikey=&webhook=&request_id=" -H 'content-type: application/json' -d @data.json +curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v2/async/diarize?apikey=&webhook=" -H 'content-type: application/json' -d @data.json # contents of data.json -{"content": "bytesEncodedAudioString", "sampleRate": 8000, "encoding": "FLAC", "languageCode": "en-US", "speakers": 2, "audioType": "callcenter"} +{"content": "bytesEncodedAudioString", "sampleRate": 8000, "encoding": "FLAC", "languageCode": "en-US", "audioType": "callcenter"} ``` ### Javascript @@ -57,7 +57,7 @@ import base64 url = "https://proxy.api.deepaffects.com/audio/generic/api/v2/async/diarize" -querystring = {"apikey":"", "webhook":"", "request_id":""} +querystring = {"apikey":"", "webhook":""} payload = { "encoding": "Wave", @@ -148,7 +148,7 @@ audioType: can have the following values: | ---------- | ------ | ---------------------------------------------------------------------- | ----------------------------------------------- | | apikey | String | The apikey | Required for authentication inside all requests | | webhook | String | The webhook url at which the responses will be sent | Required for async requests | -| request_id | Number | An optional unique id to link async response with the original request | Optional | +| request_id | String | An optional unique id to link async response with the original request | Optional | ### Output Parameters (Async) @@ -175,6 +175,6 @@ audioType: can have the following values: | Parameter | Type | Description | Notes | | ---------- | ------ | -------------------------------------------------- | ----- | -| speaker_id | Number | The speaker id for the corresponding audio segment | | +| speaker_id | String | The speaker id for the corresponding audio segment | | | start | Number | Start time of the audio segment in seconds | | | end | Number | End time of the audio segment in seconds | | diff --git a/docs/speaker-enrollment-api.md b/docs/speaker-enrollment-api.md index 7282984..ae0d3a6 100644 --- a/docs/speaker-enrollment-api.md +++ b/docs/speaker-enrollment-api.md @@ -1,7 +1,7 @@ --- id: speaker-enrollment-api -title: Speaker Enrollment Api -sidebar_label: Speaker Enrollment Api +title: Speaker Enrollment API +sidebar_label: Speaker Enrollment API ---

Speaker Enrollment API for Identification (REST Api)

diff --git a/docs/speaker-identification-api.md b/docs/speaker-identification-api.md index 7386934..ef8a014 100644 --- a/docs/speaker-identification-api.md +++ b/docs/speaker-identification-api.md @@ -1,7 +1,7 @@ --- id: speaker-identification-api -title: Speaker Identification Api -sidebar_label: Speaker Identification Api +title: Speaker Identification API +sidebar_label: Speaker Identification API --- Speaker identification api tries to figure out "Who Speaks When" for already enrolled speakers. @@ -24,7 +24,7 @@ Splits audio clip into segments corresponding to a unique speaker and returns st ### Shell ```shell -curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v2/async/diarization/identify?apikey=&webhook=&request_id=" -H 'content-type: application/json' -d @data.json +curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v2/async/diarization/identify?apikey=&webhook=" -H 'content-type: application/json' -d @data.json curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v2/sync/diarization/identify?apikey=" -H 'content-type: application/json' -d @data.json @@ -89,7 +89,7 @@ curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v2/sync/diariz | ---------- | ------ | ---------------------------------------------------------------------- | ----------------------------------------------- | | apikey | String | The apikey | Required for authentication inside all requests | | webhook | String | The webhook url at which the responses will be sent | Required for async requests | -| request_id | Number | An optional unique id to link async response with the original request | Optional | +| request_id | String | An optional unique id to link async response with the original request | Optional | ### Output Parameters (Async) diff --git a/docs/text-emotion-recognition-api.md b/docs/text-emotion-recognition-api.md index 697452f..63b4bd7 100644 --- a/docs/text-emotion-recognition-api.md +++ b/docs/text-emotion-recognition-api.md @@ -1,7 +1,7 @@ --- id: text-emotion-recognition-api -title: Text Emotion Recognition Api -sidebar_label: Text Emotion Recognition Api +title: Text Emotion Recognition API +sidebar_label: Text Emotion Recognition API --- Text emotion api extracts basic emotions from the text input diff --git a/docs/text-punctuation-api.md b/docs/text-punctuation-api.md index 1945cf2..add1198 100644 --- a/docs/text-punctuation-api.md +++ b/docs/text-punctuation-api.md @@ -1,7 +1,7 @@ --- id: text-punctuation-api -title: Smart Punctuation Api -sidebar_label: Smart Punctuation Api +title: Smart Punctuation API +sidebar_label: Smart Punctuation API --- Do you've incorrectly formatted or unformatted text? The DeepAffects Smart Punctuation takes a text blob and adds relevant punctuations to the text. The Punctuation API is specifically trained to accurately punctuate noisy asr output. @@ -25,7 +25,7 @@ Currently, the following punctuations are added to the text: ### Shell ```shell -curl -X POST "https://proxy.api.deepaffects.com/text/generic/api/v1/async/punctuate?apikey=&webhook=&request_id=" -H 'content-type: application/json' -d @data.json +curl -X POST "https://proxy.api.deepaffects.com/text/generic/api/v1/async/punctuate?apikey=&webhook=" -H 'content-type: application/json' -d @data.json # contents of data.json {"texts": ["so its more fluid than it is and you know its not the best kind of feedback right"]} @@ -39,7 +39,6 @@ var options = { method: 'POST', url: 'https://proxy.api.deepaffects.com/text/generic/api/v1/async/punctuate', qs: { apikey: '', - request_id: '', webhook: '' }, headers: { 'Content-Type': 'application/json' }, @@ -62,7 +61,7 @@ import base64 url = "https://proxy.api.deepaffects.com/text/generic/api/v1/async/punctuate" -querystring = {"apikey":"", "webhook":"", "request_id":""} +querystring = {"apikey":"", "webhook":""} {"texts": ["so its more fluid than it is and you know its not the best kind of feedback right"]} @@ -112,7 +111,7 @@ print(response.text) | ---------- | ------ | ---------------------------------------------------------------------- | ----------------------------------------------- | | apikey | String | The apikey | Required for authentication inside all requests | | webhook | String | The webhook url at which the responses will be sent | Required for async requests | -| request_id | Number | An optional unique id to link async response with the original request | Optional | +| request_id | String | An optional unique id to link async response with the original request | Optional | ### Output Parameters (Async) diff --git a/docs/voice-activity-detection-api.md b/docs/voice-activity-detection-api.md index 7228528..d3593ad 100644 --- a/docs/voice-activity-detection-api.md +++ b/docs/voice-activity-detection-api.md @@ -1,7 +1,7 @@ --- id: voice-activity-detection-api -title: Voice Activity Detection Api -sidebar_label: Voice Activity Detection Api +title: Voice Activity Detection API +sidebar_label: Voice Activity Detection API --- Voice activity detection (VAD) is a technique used in speech processing to detect the presence (or absence) of human speech. The DeepAffects Voice activity detection API analyzes the audio input and returns specific segments where human speech is detected. @@ -18,7 +18,7 @@ Voice activity detection (VAD) is a technique used in speech processing to detec ### Shell ```shell -curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v1/async/vad?apikey=&webhook=&request_id=" -H 'content-type: application/json' -d @data.json +curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v1/async/vad?apikey=&webhook=" -H 'content-type: application/json' -d @data.json # contents of data.json {"content": "bytesEncodedAudioString", "sampleRate": 8000, "encoding": "FLAC", "languageCode": "en-US", "minNonSpeechDuration": 1} @@ -32,7 +32,6 @@ var options = { method: 'POST', url: 'https://proxy.api.deepaffects.com/audio/generic/api/v1/async/vad', qs: { apikey: '', - request_id: '', webhook: '' }, headers: { 'Content-Type': 'application/json' }, @@ -58,7 +57,7 @@ import base64 url = "https://proxy.api.deepaffects.com/audio/generic/api/v1/async/vad" -querystring = {"apikey":"", "webhook":"", "request_id":""} +querystring = {"apikey":"", "webhook":""} payload = { "encoding": "Wave", @@ -128,7 +127,7 @@ print(response.text) | ---------- | ------ | ---------------------------------------------------------------------- | ----------------------------------------------- | | apikey | String | The apikey | Required for authentication inside all requests | | webhook | String | The webhook url at which the responses will be sent | Required for async requests | -| request_id | Number | An optional unique id to link async response with the original request | Optional | +| request_id | String | An optional unique id to link async response with the original request | Optional | ### Output Parameters (Async) diff --git a/website/sidebars.json b/website/sidebars.json index 9b521f8..3b1dcec 100755 --- a/website/sidebars.json +++ b/website/sidebars.json @@ -7,8 +7,12 @@ "errors", "concepts" ], + "Jobs": [ + "job-status-api" + ], "Generic Audio Analysis": [ "speaker-diarization-api", + "speech-to-text-api", "speaker-enrollment-api", "speaker-identification-api", "realtime-speaker-identification-api", diff --git a/website/siteConfig.js b/website/siteConfig.js index ead27be..8f0469e 100755 --- a/website/siteConfig.js +++ b/website/siteConfig.js @@ -21,7 +21,7 @@ const users = [ ]; const siteConfig = { - title: "DeepAffects Developer Docs" /* title for your website */, + title: "" /* title for your website */, tagline: "The new standard for speech analysis APIs for developers", url: "https://docs.deepaffects.com" /* your website url */, baseUrl: "/" /* base url for your project */, diff --git a/website/static/img/favicon/favicon.ico b/website/static/img/favicon/favicon.ico index fae20dc..bae2ad7 100755 Binary files a/website/static/img/favicon/favicon.ico and b/website/static/img/favicon/favicon.ico differ