text-dependent

Retrieve Single Profile

Retrieves a single profile by ID.

get/text-dependent/profiles/{profileId}

Response

profileIdstring uuid

Unique identifier for profile id (guid).

localestring

Language identifier consisting of a combination of language code and country code.

enrollmentStatus'Enrolling' | 'Training' | 'Enrolled'

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.

createdDateTimestring

Profile creation datetime.

lastUpdatedDateTimestring

Last datetime when the profile was updated.

enrollmentsCountinteger

Number of enrolment audios accepted for this profile.

enrollmentsLengthnumber

Total length of enrollment audios accepted for this profile in seconds.

enrollmentsSpeechLengthnumber

Summation of pure speech (which is the amount of audio after removing silence and non-speech segments) across all profile enrollments in seconds.

remainingEnrollmentsCountinteger

Number of enrollment audios needed to complete profile enrollment.

modelVersionstring

Date specifying the model assigned to this profile. Format is yyyy-mm-dd. If profile has no enrollments, this value will be empty.

Example response

{
  "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,
  "enrollmentsLength": 1.83,
  "enrollmentsSpeechLength": 1.35,
  "remainingEnrollmentsCount": 2,
  "modelVersion": "2019-12-05"
}

Changes

Changed in 2 of the 3 revisions of this API.228

Jul 13, 20262021-09-05b4c1a68ff13f24See the full diff
- ●
  deleted the path request parameter profileId
  request-parameter-removed
- ●
  deleted the query request parameter api-version
  request-parameter-removed
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
Sep 22, 20212021-09-05f6acd0b8c29424See the full diff
- ▲
  added the new path request parameter profileId
  new-request-path-parameter
- ▲
  added the new required query request parameter api-version
  new-required-request-parameter
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed

Full history