Text Dependent - Reset Profile

Reset Profile
Resets existing profile to its original creation state. The reset operation does the following:

  • Updates enrollmentStatus to Enrolling.
  • Updates lastUpdatedDateTime.
  • Updates enrollmentsCount to 0.
  • Updates enrollmentsLength to 0.
  • Updates enrollmentsSpeechLength to 0.
  • Updates remainingEnrollmentsCount to the initial required number.
  • Removes all associated enrollments from storage.
  • Removes chosen passphrase association.
  • Resets value of modelVersion.
POST {endpoint}/speaker-recognition/verification/text-dependent/profiles/{profileId}:reset?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

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

Responses

Name Type Description
200 OK

Speaker profile reset successfully. Profile is returned with reset values.

Headers

  • Location: string
Other Status Codes

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:reset?api-version=2021-09-05
Ocp-Apim-Subscription-Key: {API key}

Sample Response

Content-Type: application/json
{
  "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f",
  "locale": "en-US",
  "enrollmentStatus": "Enrolling",
  "createdDateTime": "2015-04-23T18:25:43.41Z",
  "lastUpdatedDateTime": "2015-04-23T18:25:43.41Z",
  "enrollmentsCount": 0,
  "enrollmentsLengthInSec": 0,
  "enrollmentsSpeechLengthInSec": 0,
  "remainingEnrollmentsCount": 3,
  "modelVersion": "2019-12-05"
}
Content-Type: application/json
x-ms-error-code: Error Code
{
  "error": {
    "code": "Error Code",
    "message": "Erro Messae"
  }
}

Definitions

Error
SpeakerErrorInfo

Speaker error message

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.

Error

Name Type Description
code
  • string
message
  • string

SpeakerErrorInfo

Speaker error message

Name Type Description
error

TdProfileInfo

Text-Dependent Speaker profile info

Name Type Description
createdDateTime
  • string

Profile creation datetime.

enrollmentStatus

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.

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