diff --git a/docs/speaker-diairization-api.md b/docs/speaker-diairization-api.md index 48a3131..55c832c 100644 --- a/docs/speaker-diairization-api.md +++ b/docs/speaker-diairization-api.md @@ -19,7 +19,7 @@ Splits audio clip into segments corresponding to a unique speaker 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 # 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", "speakers": 2, "audioType": "callcenter", "speakerIds":["speaker1"]} ``` ### Javascript @@ -122,6 +122,7 @@ except ApiException as e: | content | String | base64 encoding of the audio file. | | | speakers | Number | Number of speakers in the file (-1 for unknown speakers) | [default to -1] | | audioType | String | Type of the audio based on number of speakers | [default to callcenter] | +| speakerIds | List of Strings | List of enrolled speaker ids using enrollment api | Optional | > audioType can have two values 1) callcenter 2) meeting. We recommend using callcenter when there are two speakers expected to be identified and meeting when multiple speakers are expected. diff --git a/docs/speaker-enrollment-api.md b/docs/speaker-enrollment-api.md index 974f6f8..a6dd9a4 100644 --- a/docs/speaker-enrollment-api.md +++ b/docs/speaker-enrollment-api.md @@ -6,19 +6,21 @@ sidebar_label: Speaker Enrollment Api

Speaker Enrollment API for Identification (REST Api)

-Speaker enrollment api enrolls user for [Speaker Identification Api](./speaker-identification-api.html) and [Realtime Speaker Identification Api](./realtime-speaker-identification-api.html). +Speaker enrollment api enrolls user for [Speaker Identification Api](./speaker-identification-api.html), [Realtime Speaker Identification Api](./realtime-speaker-identification-api.html). +[Speaker Diarization Api](./speaker-diarization-api.html) + ### POST Request -`POST https://proxy.api.deepaffects.com/audio/generic/api/v1/sync/diarization/enroll` +`POST https://proxy.api.deepaffects.com/audio/generic/api/v2/sync/diarization/enroll` ### Sample Code ```shell -curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v1/sync/diarization/enroll?apikey=" -H 'content-type: application/json' -d @data.json +curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v2/sync/diarization/enroll?apikey=" -H 'content-type: application/json' -d @data.json # contents of data.json -{"content": "bytesEncodedAudioString", "sampleRate": 8000, "encoding": "FLAC", "languageCode": "en-US", "speakerId": "user1" } +{"content": "bytesEncodedAudioString", "sampleRate": 8000, "encoding": "FLAC", "languageCode": "en-US", "speakerId": "speaker1" } ``` ### Output @@ -32,8 +34,6 @@ curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v1/sync/diariz ``` > For every successfull enrollment the response will containe message as "Success". -> Repeat the enrollment with different audios untill the status message changes to -> "Complete". Then proceed with speaker identification
> Enroll a user atleast thrice with 3 different audio, each about 10-12 seconds. @@ -57,9 +57,9 @@ curl -X POST "https://proxy.api.deepaffects.com/audio/generic/api/v1/sync/diariz ### Output Parameters (Sync) -| Parameter | Type | Description | Notes | +| Parameter | Type | Description | Notes | | --------- | ------ | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| message | String | Status of enrollment Success or Complete | Success: Current enrollment is successfull, Complete: Enrollment is completed, Repeat the enrollments with different audio samples until Complete message is received | +| message | String | Status of enrollment Success | Success: enrollment is successfull| ### Speaker Enrollment Delete API for Identification (REST Api) @@ -126,8 +126,7 @@ curl -X GET "https://proxy.api.deepaffects.com/audio/generic/api/v1/sync/diariza "developer_id": "testuser", "enrolled_speaker_ids": [ { - "speaker_id": "speaker_1", - "enrollment_complete" "True" + "speaker_id": "speaker_1" } ] }