Consents - Create

Service:

Azure AI Services

API-versie:

2024-02-01-preview

Hiermee maakt u een nieuwe toestemming voor spraaktalent met de opgegeven audio-URL.

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

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://eastus.api.cognitive.microsoft.com).
id	path	True	string	De id van de resource. Regex-patroon: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$
api-version	query	True	string	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string	Geef hier uw spraakresourcesleutel op.
Operation-Id		string	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 ongeldige 400-aanvraag. Regex-patroon: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Aanvraagbody

Name	Vereist	Type	Description
companyName	True	string	Bedrijfsnaam. Moet overeenkomen met de bedrijfsnaam in het toestemmingsaudiobestand.
locale	True	string	De landinstelling van deze toestemming. Landinstellingscode volgt BCP-47. U vindt de lijst met landinstellingen voor tekst naar spraak hier https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	True	string	Resource-id
voiceTalentName	True	string	Naam van stemtalent. Moet overeenkomen met de naam van het stemtalent in het toestemmingsaudiobestand.
audioUrl		string	De openbaar toegankelijke URL van het toestemmingsaudiobestand. Het wordt aanbevolen om een Azure-blob-URL met SAS te zijn. Deze eigenschap is alleen beschikbaar in aanvraag.
description		string	Beschrijving van toestemming.
displayName		string	Naam van toestemming.
id		string	Resource-id
properties		ConsentProperties	Toestemmingseigenschappen
status		Status	Status van een resource.

Antwoorden

Name	Type	Description
201 Created	Consent	Gemaakt 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

Create a consent

Voorbeeldaanvraag

HTTP

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



{
  "description": "Consent for Jessica voice",
  "projectId": "Jessica",
  "voiceTalentName": "Jessica Smith",
  "companyName": "Contoso",
  "audioUrl": "https://contoso.blob.core.windows.net/public/jessica-consent.wav?mySasToken",
  "locale": "en-US"
}

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 fout bij het maken van toestemming
ConsentProperties	Toestemmingseigenschappen
Error	Fout op het hoogste niveau volgt de Microsoft Azure REST API-richtlijnen 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 de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Interne fout volgt de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappen foutcode, bericht en optionele eigenschappen doel, interne fout (dit kan worden genest).
Status	Status van een resource.

Consent

Toestemmingsobject

Name	Type	Description
audioUrl	string	De openbaar toegankelijke URL van het toestemmingsaudiobestand. Het wordt aanbevolen om een Azure-blob-URL met SAS te zijn. Deze eigenschap is alleen beschikbaar in aanvraag.
companyName	string	Bedrijfsnaam. Moet overeenkomen met de bedrijfsnaam in het toestemmingsaudiobestand.
createdDateTime	string	De tijdstempel waarop het object is gemaakt. De tijdstempel is 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	Naam van toestemming.
id	string	Resource-id
lastActionDateTime	string	De tijdstempel waarop de huidige status is ingevoerd. Het tijdstempel is 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 landinstellingen voor tekst naar spraak hier https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string	Resource-id
properties	ConsentProperties	Toestemmingseigenschappen
status	Status	Status van een resource.
voiceTalentName	string	Naam van stemtalent. Moet overeenkomen met de naam van het stemtalent in het toestemmingsaudiobestand.

ConsentFailureReason

Reden voor fout bij het maken van toestemming

Name	Type	Description
AudioAndScriptNotMatch	string	De toestemmingsaudio komt niet overeen met de mondelinge verklaring. Controleer de mondelinge verklaring.
Internal	string	Custom Voice Service-fout.

ConsentProperties

Toestemmingseigenschappen

Name	Type	Description
failureReason	ConsentFailureReason	Reden voor fout bij het maken van toestemming

Error

Fout op het hoogste niveau volgt de Microsoft Azure REST API-richtlijnen 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 met betrekking tot de fout en/of het verwachte beleid.
innererror	InnerError	Interne fout volgt de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappen foutcode, bericht en optionele eigenschappen doel, 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

Foutcode op het hoogste niveau

Name	Type	Description
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

Foutreactie volgt de Microsoft Azure REST API-richtlijnen 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 Microsoft Azure REST API-richtlijnen 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

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

Name	Type	Description
code	string	Gedetailleerde foutcode voor diagnostische gegevens.
innererror	InnerError	Interne fout volgt de Microsoft Azure REST API-richtlijnen die beschikbaar zijn op https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Dit bevat de vereiste eigenschappen foutcode, bericht en optionele eigenschappen doel, 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

Status van een resource.

Name	Type	Description
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string