Text Dependent - List Profiles

Service:

Speaker Recognition

API Version:

2021-09-05

List Profiles
Retrieves a set of profiles. Profiles are sorted alphabetically by ProfileId

GET {endpoint}/speaker-recognition/verification/text-dependent/profiles?api-version=2021-09-05

With optional parameters:

GET {endpoint}/speaker-recognition/verification/text-dependent/profiles?api-version=2021-09-05&maxpagesize={maxpagesize}

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).
api-version	query	True	string	Specifies the version of the operation to use for this request.
maxpagesize	query		integer	The number of profiles to return. Default is 100 and the maximum is 500

Request Header

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

Responses

Name	Type	Description
200 OK	TdProfileInfoList	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

HTTP

GET https://westus.api.cognitive.microsoft.com/speaker-recognition/verification/text-dependent/profiles?api-version=2021-09-05

Sample Response

Status code:

200

Content-Type: application/json

Response Body

{
  "value": [
    {
      "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f",
      "locale": "en-US",
      "enrollmentStatus": "Enrolling",
      "createdDateTime": "2015-04-23T18:25:43.41Z",
      "lastUpdatedDateTime": "2015-04-23T19:34:51.52Z",
      "enrollmentsCount": 1,
      "enrollmentsLengthInSec": 1.83,
      "enrollmentsSpeechLengthInSec": 1.35,
      "remainingEnrollmentsCount": 2,
      "modelVersion": "2019-12-05"
    }
  ],
  "nextLink": "{opaqueUrl}"
}

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
SpeakerErrorInfo	Speaker error message
TdProfileInfo	Text-Dependent Speaker profile info
TdProfileInfoList	Text-Dependent Speaker profile info list
TrainingStatusType	Status representing the current state of the profile. Available values are: Enrolling: profile has no voice print and not ready for recognition requests. Training: voice print of profile is being created and can’t be used for recognition at the moment. Enrolled: profile has a voice print and ready for recognition requests.

Error

Name	Type	Description
code	string
message	string

SpeakerErrorInfo

Speaker error message

Name	Type	Description
error	Error

TdProfileInfo

Text-Dependent Speaker profile info

Name	Type	Description
createdDateTime	string	Profile creation datetime.
enrollmentStatus	TrainingStatusType	Status representing the current state of the profile. Available values are: Enrolling: profile has no voice print and not ready for recognition requests. Training: voice print of profile is being created and can’t be used for recognition at the moment. Enrolled: profile has a voice print and ready for recognition requests.
enrollmentsCount	integer	Number of enrollment audios accepted for this profile.
enrollmentsLengthInSec	number	Total length of enrollment audios accepted for this profile in seconds.
enrollmentsSpeechLengthInSec	number	Summation of pure speech (which is the amount of audio after removing silence and non-speech segments) across all profile enrollments in seconds.
lastUpdatedDateTime	string	Last datetime when the profile was updated.
locale	string	Language identifier consisting of a combination of language code and country code.
modelVersion	string	Date specifying the model assigned to this profile. Format is yyyy-mm-dd. If profile has no enrollments, this value will be empty.
profileId	string	Unique identifier for profile id (guid).
remainingEnrollmentsCount	integer	Number of enrollment audios needed to complete profile enrollment.

TdProfileInfoList

Text-Dependent Speaker profile info list

Name	Type	Description
nextLink	string
value	TdProfileInfo[]	Text-Dependent Speaker profile info

TrainingStatusType

Status representing the current state of the profile. Available values are:

• Enrolling: profile has no voice print and not ready for recognition requests.
• Training: voice print of profile is being created and can’t be used for recognition at the moment.
• Enrolled: profile has a voice print and ready for recognition requests.

Name	Type	Description
Enrolled	string
Enrolling	string
Training	string