Text Dependent - List Phrases

Pass Phrases
Retrieves list of supported passphrases for a specific locale.

GET {endpoint}/speaker-recognition/verification/text-dependent/phrases/{locale}?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).

locale
path True
  • string

A combination of language code and country code.

Regex pattern: ^[a-zA-Z]{2}-?[a-zA-Z]{2}$

api-version
query True
  • string

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

Request Header

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

Responses

Name Type Description
200 OK

OK

Other Status Codes

Failure

Headers

  • x-ms-error-code: string

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful Query

Sample Request

GET https://westus.api.cognitive.microsoft.com/speaker-recognition/verification/text-dependent/phrases/en-US?api-version=2021-09-05
Ocp-Apim-Subscription-Key: {API key}

Sample Response

Content-Type: application/json
{
  "value": [
    {
      "passPhrase": "my voice is my passport verify me"
    },
    {
      "passPhrase": "my voice is stronger than passwords"
    }
  ]
}
Content-Type: application/json
x-ms-error-code: Error Code
{
  "error": {
    "code": "Error Code",
    "message": "Erro Messae"
  }
}

Definitions

Error
PassPhraseInfo

Pass phrase list

SpeakerErrorInfo

Speaker error message

Value

Error

Name Type Description
code
  • string
message
  • string

PassPhraseInfo

Pass phrase list

Name Type Description
value

SpeakerErrorInfo

Speaker error message

Name Type Description
error

Value

Name Type Description
passPhrase
  • string

Passphrase associated with this enrollment.