Consents - Create

Referens

Tjänst:: Azure AI Services

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

Skapar ett nytt rösttalangmedgivande med den angivna ljud-URL:en.

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

URI-parametrar

Name I Obligatorisk Typ Description

Name	I	Obligatorisk	Typ	Description
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	Resursens ID. Reguljärt uttrycksmönster: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.

endpoint

path

True

string

Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://eastus.api.cognitive.microsoft.com).

path

True

string

Resursens ID.

Reguljärt uttrycksmönster: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

api-version

query

True

string

Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name Obligatorisk Typ Description

Ocp-Apim-Subscription-Key

True

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string	Ange din Speech-resursnyckel här.
Operation-Id		string	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. Reguljärt uttrycksmönster: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`

string

Ange din Speech-resursnyckel här.

Operation-Id

string

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.

Reguljärt uttrycksmönster: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Begärandetext

Name	Obligatorisk	Typ	Description
companyName	True	string	Företagsnamn. Måste matcha företagsnamnet i ljudfilen för medgivande.
locale	True	string	Språkvarianten för det här medgivandet. Språkkod följer BCP-47. Du hittar text-till-tal-språklistan här https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	True	string	Resurs-ID
voiceTalentName	True	string	Rösttalangnamn. Måste matcha rösttalangens namn i ljudfilen för medgivande.
audioUrl		string	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.
description		string	Beskrivning av medgivande.
displayName		string	Namn på medgivande.
id		string	Resurs-ID
properties		ConsentProperties	Egenskaper för medgivande
status		Status	Status för en resurs.

Svar

Name	Typ	Description
201 Created	Consent	Skapad Sidhuvuden Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Ett fel inträffade. 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 inträffade.

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

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

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 finns 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.

Medgivandeobjekt

Name	Typ	Description
audioUrl	string	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	Företagsnamn. Måste matcha företagsnamnet i ljudfilen för medgivande.
createdDateTime	string	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	Namn på medgivande.
id	string	Resurs-ID
lastActionDateTime	string	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 text-till-tal-språklistan här https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string	Resurs-ID
properties	ConsentProperties	Egenskaper för medgivande
status	Status	Status för en resurs.
voiceTalentName	string	Rösttalangnamn. Måste matcha rösttalangens namn i ljudfilen för medgivande.

ConsentFailureReason

Orsak till fel vid skapande av medgivande

Name	Typ	Description
AudioAndScriptNotMatch	string	Medgivandeljudet stämmer inte överens med verbala instruktioner. Kontrollera verbala instruktioner.
Internal	string	Custom Voice Service-fel.

ConsentProperties

Egenskaper för medgivande

Name	Typ	Description
failureReason	ConsentFailureReason	Orsak till fel vid skapande av 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.

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å översta nivån.
target	string	Källan till felet. Det skulle till exempel vara "modell" eller "modell-ID" om modellen är ogiltig.

ErrorCode

Felkod på toppnivå

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

ErrorResponse

Felsvaret 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.

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

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" om modellen är ogiltig.

Status

Status för en resurs.

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

Dela via

Consents - Create

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

Ocp-Apim-Subscription-Key

Exempel

Exempelbegäran

Exempelsvar

Definitioner

ConsentFailureReason

ConsentProperties

Error

ErrorCode

ErrorResponse

InnerError

Status

Ytterligare resurser

Dela via

Consents - Create

URI-parametrar

Begärandehuvud

Begärandetext

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