Text Independent - Create Profile

Reference

Service:: Speaker Recognition

API Version:: 2021-09-05

Create Profile
Creates a new speaker profile with specified locale.

POST {endpoint}/speaker-recognition/verification/text-independent/profiles?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).
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

Request Body

Name	Required	Type	Description
locale	True	string	Language identifier consisting of a combination of language code and country code.

Responses

Name	Type	Description
201 Created	TiProfileInfo	Speaker profile created successfully. GUID is returned to reference the created profile. Headers location: string
Other Status Codes	SpeakerErrorInfo	Failure Headers x-ms-error-code: string

Name

Type

Description

201 Created

TiProfileInfo

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

Headers

location: string

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

POST https://westus.api.cognitive.microsoft.com/speaker-recognition/verification/text-independent/profiles?api-version=2021-09-05
Ocp-Apim-Subscription-Key: {API key}

Request Body

{
  "locale": "en-us"
}

Sample Response

Status code:: 201

Content-Type: application/json

Response Body

{
  "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f",
  "locale": "en-US",
  "profileStatus": "Active",
  "enrollmentStatus": "Enrolling",
  "createdDateTime": "2015-04-23T18:25:43.41Z",
  "lastUpdatedDateTime": "2015-04-23T18:25:43.41Z",
  "enrollmentsCount": 0,
  "enrollmentsLengthInSec": 0,
  "enrollmentsSpeechLengthInSec": 0,
  "remainingEnrollmentsSpeechLengthInSec": 20,
  "modelVersion": "2019-12-05"
}

Status code:: default

Content-Type: application/json
x-ms-error-code: Error Code

Response Body

{
  "error": {
    "code": "Error Code",
    "message": "Erro Messae"
  }
}

Definitions

Error
LocaleInfo	Speaker profile locale
ProfileStatusType	Status representing the current state of the profile. Available values are: Active: profile is active and can be used if the enrollment status is 'Enrolled'. Inactive: profile has not been activated and an activation phrase must be submitted.
SpeakerErrorInfo	Speaker error message
TiProfileInfo	Text-Independent 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

LocaleInfo

Speaker profile locale

Name	Type	Description
locale	string	Language identifier consisting of a combination of language code and country code.

ProfileStatusType

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

Active: profile is active and can be used if the enrollment status is 'Enrolled'.
Inactive: profile has not been activated and an activation phrase must be submitted.

Name	Type	Description
Active	string
Inactive	string

SpeakerErrorInfo

Speaker error message

Name	Type	Description
error	Error

TiProfileInfo

Text-Independent 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).
profileStatus	ProfileStatusType	Status representing the current state of the profile. Available values are: Active: profile is active and can be used if the enrollment status is 'Enrolled'. Inactive: profile has not been activated and an activation phrase must be submitted.
remainingEnrollmentsSpeechLengthInSec	number	Amount of pure speech (which is the amount of audio after removing silence and non-speech segments) needed to complete profile enrollment in seconds.

TrainingStatusType