Consents - Post

Referens

Tjänst:: Azure AI Services

API-version:: 2024-02-01-preview

Skapar ett nytt rösttalangmedgivande med den angivna ljudfilen.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
audiodata	formData	True	file	En ljudfil som innehåller ljuddata.
companyName	formData	True	string	Namnet på företaget.
locale	formData	True	string	Språkvarianten för det här medgivandet. Språkkod följer BCP-47. Du hittar språklistan för text till tal här 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]$	Projekt-ID:t.
voiceTalentName	formData	True	string	Namnet på rösttalangen.
description	formData		string	Valfri beskrivning av det här medgivandet.
displayName	formData		string	Visningsnamnet för det här medgivandet.
properties	formData		string	Egenskaper.
endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: 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]$	Resursens ID.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begärandehuvud

Media Types: "multipart/form-data"

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string	Ange din Speech-resursnyckel här.
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID för statusövervakaren för åtgärden. Om Operation-Id-huvudet matchar en befintlig åtgärd och begäran inte är identisk med den tidigare begäran misslyckas den med en 400 Felaktig begäran.

Svar

Name	Typ	Description
201 Created	Consent	Skapad Sidhuvuden Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Ett fel uppstod. Sidhuvuden x-ms-error-code: string

Name

Typ

Description

201 Created

Consent

Skapad

Sidhuvuden

Operation-Id: string
Operation-Location: string

Other Status Codes

ErrorResponse

Ett fel uppstod.

Sidhuvuden

x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Ange din Speech-resursnyckel här.

Typ: apiKey
I: header

Exempel

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:: 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"
}

Definitioner

Name	Description
Consent	Medgivandeobjekt
ConsentFailureReason	Orsak till fel vid skapande av medgivande
ConsentProperties	Egenskaper för medgivande
Error	Fel på toppnivå följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller ett fel på den översta nivån med felkod, meddelande, information, mål och ett inre fel med mer beskrivande information.
ErrorCode	Felkod på toppnivå
ErrorResponse	Felsvaret följer riktlinjerna för Microsoft Azure REST API som är tillgängliga på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Inre fel följer riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller nödvändig egenskapsfelkod, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).
Status	Status för en resurs.

Objekt

Medgivandeobjekt

Name	Typ	Description
audioUrl	string (uri)	Den offentliga tillgängliga URL:en för medgivandeljudfilen. Vi rekommenderar att du är en Azure-blob-URL med SAS-. Den här egenskapen är endast tillgänglig i begäran.
companyName	string minLength: 1	Företagsnamn. Måste matcha företagsnamnet i ljudfilen för medgivande.
createdDateTime	string (date-time)	Tidsstämpeln när objektet skapades. Tidsstämpeln är kodad som ISO 8601-datum- och tidsformat ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)
description	string	Beskrivning av medgivande.
displayName	string minLength: 1	Namn på medgivande.
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resurs-ID
lastActionDateTime	string (date-time)	Tidsstämpeln när den aktuella statusen angavs. Tidsstämpeln är kodad som ISO 8601-datum- och tidsformat ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	Språkvarianten för det här medgivandet. Språkkod följer BCP-47. Du hittar språklistan för text till tal här 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]$	Resurs-ID
properties	ConsentProperties	Egenskaper för medgivande
status	Status	Status för en resurs.
voiceTalentName	string minLength: 1	Rösttalangnamn. Måste matcha rösttalangens namn i ljudfilen för medgivande.

ConsentFailureReason

Uppräkning

Orsak till fel vid skapande av medgivande

Värde	Description
AudioAndScriptNotMatch	Medgivandeljudet matchar inte med verbalt uttalande. Kontrollera .
Internal	Custom Voice Service-fel.

ConsentProperties

Objekt

Egenskaper för medgivande

Name	Typ	Description
failureReason	ConsentFailureReason	Orsak till fel vid skapande av medgivande

Error

Objekt

Fel på toppnivå följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller ett fel på den översta nivån med felkod, meddelande, information, mål och ett inre fel med mer beskrivande information.

Name	Typ	Description
code	ErrorCode	Felkod på toppnivå
details	Error[]	Ytterligare stödjande information om fel och/eller förväntade principer.
innererror	InnerError	Inre fel följer riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller nödvändig egenskapsfelkod, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).
message	string	Felmeddelande på den översta nivån.
target	string	Källan till felet. Det skulle till exempel vara "modell" eller "modell-ID" i händelse av en ogiltig modell.

ErrorCode

Uppräkning

Felkod på toppnivå

Värde	Description
BadArgument
BadRequest
Forbidden
InternalServerError
NotFound
ServiceUnavailable
TooManyRequests
Unauthorized
UnsupportedMediaType

ErrorResponse

Objekt

Felsvaret följer riktlinjerna för Microsoft Azure REST API som är tillgängliga på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Typ	Description
error	Error	Fel på toppnivå följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller ett fel på den översta nivån med felkod, meddelande, information, mål och ett inre fel med mer beskrivande information.

InnerError

Objekt

Inre fel följer riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller nödvändig egenskapsfelkod, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).

Name	Typ	Description
code	string	Detaljerad felkod för diagnostik.
innererror	InnerError	Inre fel följer riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller nödvändig egenskapsfelkod, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).
message	string	Detaljerat felmeddelande.
target	string	Källan till felet. Det skulle till exempel vara "modell" eller "modell-ID" i händelse av en ogiltig modell.

Status

Uppräkning

Status för en resurs.

Värde	Description
Disabled
Disabling
Failed
NotStarted
Running
Succeeded

Dela via

Consents - Post

URI-parametrar

Begärandehuvud

Svar

Säkerhet

Ocp-Apim-Subscription-Key

Exempel

Exempelbegäran

Exempelsvar

Definitioner

ConsentFailureReason

ConsentProperties

Error

ErrorCode

ErrorResponse

InnerError

Status

Ytterligare resurser

Dela via

Consents - Post

URI-parametrar

Begärandehuvud

Svar

Säkerhet

Ocp-Apim-Subscription-Key

Exempel

Create a consent

Exempelbegäran

Exempelsvar

Definitioner

Consent

ConsentFailureReason

ConsentProperties

Error

ErrorCode

ErrorResponse

InnerError

Status

Ytterligare resurser