Consents - Post

Service:: Azure AI Services

API-versie:: 2024-02-01-preview

Hiermee maakt u een nieuwe stemtalenttoestemming met het opgegeven audiobestand.

POST {endpoint}/customvoice/consents/{id}?api-version=2024-02-01-preview

URI-parameters

Name	In	Vereist	Type	Description
audiodata	formData	True	file	Een audiobestand met de audiogegevens.
companyName	formData	True	string	De naam van het bedrijf.
locale	formData	True	string	De landinstelling van deze toestemming. Landinstellingscode volgt BCP-47. U vindt de lijst met spraakinstellingen hier https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	formData	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	De project-id.
voiceTalentName	formData	True	string	De naam van stemtalent.
description	formData		string	Optionele beschrijving van deze toestemming.
displayName	formData		string	De weergavenaam van deze toestemming.
properties	formData		string	Eigenschappen.
endpoint	path	True	string	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://eastus.api.cognitive.microsoft.com).
id	path	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	De id van de resource.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Media Types: "multipart/form-data"

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string	Geef hier uw spraakresourcesleutel op.
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Id van de statusmonitor voor de bewerking. Als de Operation-Id header overeenkomt met een bestaande bewerking en de aanvraag niet identiek is aan de vorige aanvraag, mislukt deze met een 400 ongeldige aanvraag.

Antwoorden

Name	Type	Description
201 Created	Consent	Geschapen Kopteksten Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Er is een fout opgetreden. Kopteksten x-ms-error-code: string

Name

Type

Description

201 Created

Consent

Geschapen

Kopteksten

Operation-Id: string
Operation-Location: string

Other Status Codes

ErrorResponse

Er is een fout opgetreden.

Kopteksten

x-ms-error-code: string

Beveiliging

Ocp-Apim-Subscription-Key

Geef hier uw spraakresourcesleutel op.

Type: apiKey
In: header

Voorbeelden

Voorbeeldaanvraag

HTTP

POST {endpoint}/customvoice/consents/Jessica?api-version=2024-02-01-preview

Voorbeeldrespons

Statuscode:: 201

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/070f7986-ef17-41d0-ba2b-907f0f28e314?api-version=2024-02-01-preview
Operation-Id: 070f7986-ef17-41d0-ba2b-907f0f28e314

{
  "id": "Jessica",
  "description": "Consent for Jessica voice",
  "projectId": "Jessica",
  "voiceTalentName": "Jessica Smith",
  "companyName": "Contoso",
  "locale": "en-US",
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

Definities

Name	Description
Consent	Toestemmingsobject
ConsentFailureReason	Reden voor het maken van toestemming
ConsentProperties	Toestemmingseigenschappen
Error	Fout op het hoogste niveau volgt de Richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat een fout op het hoogste niveau met foutcode, bericht, details, doel en een interne fout met meer beschrijvende details.
ErrorCode	Foutcode op het hoogste niveau
ErrorResponse	Foutreactie volgt richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Interne fout volgt richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappenfoutcode, bericht en optionele eigenschappendoel, interne fout (dit kan worden genest).
Status	Status van een resource.

Object

Toestemmingsobject

Name	Type	Description
audioUrl	string (uri)	De openbare toegankelijke URL van het toestemmingsaudiobestand. Het is raadzaam om een Azure-blob-URL te zijn met SAS-. Deze eigenschap is alleen beschikbaar in aanvraag.
companyName	string minLength: 1	Bedrijfsnaam. Moet overeenkomen met de bedrijfsnaam in het toestemmingsaudiobestand.
createdDateTime	string (date-time)	De tijdstempel waarop het object is gemaakt. De tijdstempel wordt gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)
description	string	Beschrijving van toestemming.
displayName	string minLength: 1	Naam van toestemming.
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resource-id
lastActionDateTime	string (date-time)	De tijdstempel waarop de huidige status is ingevoerd. De tijdstempel wordt gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	De landinstelling van deze toestemming. Landinstellingscode volgt BCP-47. U vindt de lijst met spraakinstellingen hier https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resource-id
properties	ConsentProperties	Toestemmingseigenschappen
status	Status	Status van een resource.
voiceTalentName	string minLength: 1	Naam van stemtalent. Moet overeenkomen met de naam van het stemtalent in het toestemmingsaudiobestand.

ConsentFailureReason

Opsomming

Reden voor het maken van toestemming

Waarde	Description
AudioAndScriptNotMatch	De audio van toestemming komt niet overeen met mondelinge instructie. Controleer mondelinge verklaring.
Internal	Custom Voice Service-fout.

ConsentProperties

Object

Toestemmingseigenschappen

Name	Type	Description
failureReason	ConsentFailureReason	Reden voor het maken van toestemming

Error

Object

Fout op het hoogste niveau volgt de Richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat een fout op het hoogste niveau met foutcode, bericht, details, doel en een interne fout met meer beschrijvende details.

Name	Type	Description
code	ErrorCode	Foutcode op het hoogste niveau
details	Error[]	Aanvullende ondersteunende informatie over de fout en/of het verwachte beleid.
innererror	InnerError	Interne fout volgt richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappenfoutcode, bericht en optionele eigenschappendoel, interne fout (dit kan worden genest).
message	string	Foutbericht op het hoogste niveau.
target	string	De bron van de fout. Dit is bijvoorbeeld 'model' of 'model-id' in het geval van een ongeldig model.

ErrorCode

Opsomming

Foutcode op het hoogste niveau

Waarde	Description
BadRequest
BadArgument
Unauthorized
Forbidden
NotFound
UnsupportedMediaType
TooManyRequests
InternalServerError
ServiceUnavailable

ErrorResponse

Object

Foutreactie volgt richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Type	Description
error	Error	Fout op het hoogste niveau volgt de Richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat een fout op het hoogste niveau met foutcode, bericht, details, doel en een interne fout met meer beschrijvende details.

InnerError

Object

Interne fout volgt richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappenfoutcode, bericht en optionele eigenschappendoel, interne fout (dit kan worden genest).

Name	Type	Description
code	string	Gedetailleerde foutcode voor diagnostische gegevens.
innererror	InnerError	Interne fout volgt richtlijnen voor Microsoft Azure REST API die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappenfoutcode, bericht en optionele eigenschappendoel, interne fout (dit kan worden genest).
message	string	Gedetailleerd foutbericht.
target	string	De bron van de fout. Dit is bijvoorbeeld 'model' of 'model-id' in het geval van een ongeldig model.

Status

Opsomming

Status van een resource.

Waarde	Description
NotStarted
Running
Succeeded
Failed
Disabling
Disabled

Consents - Post

URI-parameters

Aanvraagkoptekst

Antwoorden

Beveiliging

Ocp-Apim-Subscription-Key

Voorbeelden

Create a consent

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Consent

ConsentFailureReason

ConsentProperties

Error

ErrorCode

ErrorResponse

InnerError

Status