text-dependent

Create Profile

Create a new speaker profile with specified locale. One subscription can create 10,000 speaker profiles at most.

post/text-dependent/profiles

Request body

localestring

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

Example request

{
  "locale": "en-US"
}

Response

Speaker profile created successfully. GUID is returned to reference the created profile.

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.1312

Jul 13, 20262021-09-05b4c1a68ff13f26See the full diff
- ●
  the optional response header location removed for the status 201
  optional-response-header-removed
- ●
  deleted the query request parameter api-version
  request-parameter-removed
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  added the non-success response with the status 403
  response-non-success-status-added
- ○
  added the non-success response with the status 415
  response-non-success-status-added
- ○
  added the non-success response with the status 429
  response-non-success-status-added
- ○
  added the non-success response with the status 500
  response-non-success-status-added
Sep 22, 20212021-09-05f6acd0b8c294116See the full diff
- ▲
  added the new required query request parameter api-version
  new-required-request-parameter
- ●
  the optional response header Location removed for the status 201
  optional-response-header-removed
- ○
  removed the non-success response with the status 400
  response-non-success-status-removed
- ○
  removed the non-success response with the status 401
  response-non-success-status-removed
- ○
  removed the non-success response with the status 403
  response-non-success-status-removed
- ○
  removed the non-success response with the status 415
  response-non-success-status-removed
- ○
  removed the non-success response with the status 429
  response-non-success-status-removed
- ○
  removed the non-success response with the status 500
  response-non-success-status-removed

Full history