Text Dependent - Verify Profile

  • Reference
Service:
Speaker Recognition
API Version:
2021-09-05

Verify Profile
Verifies existing profiles against input audio.

Limitations:

  • Minimum audio input length per request is 1 second
  • Maximum audio input length per request is 10 seconds
  • Minimum audio Signal-to-noise ratio (SNR) is 10 dB
POST {endpoint}/speaker-recognition/verification/text-dependent/profiles/{profileId}:verify?api-version=2021-09-05

URI Parameters

Name In Required Type Description
endpoint
 path True

string

Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
profileId
 path True

string

uuid

Unique identifier for profile id (guid).
api-version
 query True

string

Specifies the version of the operation to use for this request.

Request Header

Media Types: "audio/wav; codecs=audio/pcm"

Name Required Type Description
Ocp-Apim-Subscription-Key True

string

Request Body

Media Types: "audio/wav; codecs=audio/pcm"

Name Type Description
audioData

object

Binary audio file. Supported formats are audio/wav; codecs=audio/pcm. Supports audio up to 5MB.

Responses

Name Type Description
200 OK

RecognitionInfo

OK
Other Status Codes

SpeakerErrorInfo

Failure

Headers

x-ms-error-code: string

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Query

Sample Request

POST https://westus.api.cognitive.microsoft.com/speaker-recognition/verification/text-dependent/profiles/49a36324-fc4b-4387-aa06-090cfbf0064f:verify?api-version=2021-09-05


"{binary file date}"

Sample Response

Status code:
200 
Content-Type: application/json
Response Body
{
  "recognitionResult": "accept",
  "score": 0.63
}
Status code:
default 
Content-Type: application/json
x-ms-error-code: Error Code
Response Body
{
  "error": {
    "code": "Error Code",
    "message": "Erro Messae"
  }
}

Definitions

Name Description
Error
RecognitionInfo

Speaker recognition result
ResultType

Does audio belong to targeted profile?
SpeakerErrorInfo

Speaker error message

Error

Name Type Description
code

string

message

string

RecognitionInfo

Speaker recognition result

Name Type Description
recognitionResult

ResultType

Does audio belong to targeted profile?
score

number

A float number indicating the similarity between input audio and targeted voice print. This number must be between 0 and 1. A higher number means higher similarity.

ResultType

Does audio belong to targeted profile?

Name Type Description
accept

string

reject

string

SpeakerErrorInfo

Speaker error message

Name Type Description
error

Error