Consents - Post

Usługa:

Azure AI Services

Wersja interfejsu API:

2024-02-01-preview

Tworzy nową zgodę talentu głosowego z podanym plikiem audio.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
audiodata	formData	True	file	Plik audio zawierający dane audio.
companyName	formData	True	string	Nazwa firmy.
locale	formData	True	string	Ustawienia regionalne tej zgody. Kod ustawień regionalnych jest zgodny z kodem BCP-47. Tekst na liście ustawień regionalnych mowy można znaleźć tutaj 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]$	Identyfikator projektu.
voiceTalentName	formData	True	string	Nazwa talentów głosowych.
description	formData		string	Opcjonalny opis tej zgody.
displayName	formData		string	Nazwa wyświetlana tej zgody.
properties	formData		string	Właściwości.
endpoint	path	True	string	Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: 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]$	Identyfikator zasobu.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Media Types: "multipart/form-data"

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string	Tutaj podaj klucz zasobu usługi Mowa.
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identyfikator monitora stanu dla operacji. Jeśli nagłówek Operation-Id pasuje do istniejącej operacji, a żądanie nie jest identyczne z poprzednim żądaniem, zakończy się niepowodzeniem z błędem 400 Nieprawidłowe żądanie.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	Consent	Utworzono Nagłówki Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Wystąpił błąd. Nagłówki x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Tutaj podaj klucz zasobu usługi Mowa.

Typ: apiKey
W: header

Przykłady

Create a consent

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
Consent	Obiekt zgody
ConsentFailureReason	Przyczyna niepowodzenia tworzenia zgody
ConsentProperties	Właściwości zgody
Error	Błąd najwyższego poziomu jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi w https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on błąd najwyższego poziomu z kodem błędu, komunikatem, szczegółami, elementem docelowym i wewnętrznym błędem z bardziej opisowymi szczegółami.
ErrorCode	Kod błędu najwyższego poziomu
ErrorResponse	Odpowiedź na błąd jest zgodna z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi w witrynie https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Błąd wewnętrzny jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi w https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on wymagany kod błędu właściwości, komunikat i opcjonalny obiekt docelowy właściwości, błąd wewnętrzny (można to zagnieżdżać).
Status	Stan zasobu.

Consent

Objekt

Obiekt zgody

Nazwa	Typ	Opis
audioUrl	string (uri)	Publiczny dostępny adres URL pliku audio zgody. Zaleca się, aby był to adres URL obiektu blob platformy Azure z sygnaturą dostępu współdzielonego. Ta właściwość jest dostępna tylko w żądaniu.
companyName	string minLength: 1	Nazwa firmy. Musi być zgodna z nazwą firmy w pliku audio zgody.
createdDateTime	string (date-time)	Sygnatura czasowa utworzenia obiektu. Znacznik czasu jest zakodowany jako format daty i godziny ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", zobacz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)
description	string	Opis zgody.
displayName	string minLength: 1	Nazwa zgody.
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identyfikator zasobu
lastActionDateTime	string (date-time)	Sygnatura czasowa po wprowadzeniu bieżącego stanu. Znacznik czasu jest zakodowany jako format daty i godziny ISO 8601 ("RRRR-MM-DDThh:mm:ssZ", zobacz https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	Ustawienia regionalne tej zgody. Kod ustawień regionalnych jest zgodny z kodem BCP-47. Tekst na liście ustawień regionalnych mowy można znaleźć tutaj 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]$	Identyfikator zasobu
properties	ConsentProperties	Właściwości zgody
status	Status	Stan zasobu.
voiceTalentName	string minLength: 1	Nazwa talentu głosowego. Musi być zgodna z nazwą talentu głosowego w pliku audio zgody.

ConsentFailureReason

Wyliczanie

Przyczyna niepowodzenia tworzenia zgody

Wartość	Opis
AudioAndScriptNotMatch	Niezgodność dźwięku zgody z instrukcją słowną. Sprawdź ustną instrukcję.
Internal	Niestandardowy błąd usługi głosowej.

ConsentProperties

Objekt

Właściwości zgody

Nazwa	Typ	Opis
failureReason	ConsentFailureReason	Przyczyna niepowodzenia tworzenia zgody

Error

Objekt

Błąd najwyższego poziomu jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi w https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on błąd najwyższego poziomu z kodem błędu, komunikatem, szczegółami, elementem docelowym i wewnętrznym błędem z bardziej opisowymi szczegółami.

Nazwa	Typ	Opis
code	ErrorCode	Kod błędu najwyższego poziomu
details	Error[]	Dodatkowe szczegóły pomocnicze dotyczące błędów i/lub oczekiwanych zasad.
innererror	InnerError	Błąd wewnętrzny jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi w https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on wymagany kod błędu właściwości, komunikat i opcjonalny obiekt docelowy właściwości, błąd wewnętrzny (można to zagnieżdżać).
message	string	Komunikat o błędzie najwyższego poziomu.
target	string	Źródło błędu. Na przykład będzie to "model" lub "identyfikator modelu" w przypadku nieprawidłowego modelu.

ErrorCode

Wyliczanie

Kod błędu najwyższego poziomu

Wartość	Opis
BadArgument
BadRequest
Forbidden
InternalServerError
NotFound
ServiceUnavailable
TooManyRequests
Unauthorized
UnsupportedMediaType

ErrorResponse

Objekt

Odpowiedź na błąd jest zgodna z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi w witrynie https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nazwa	Typ	Opis
error	Error	Błąd najwyższego poziomu jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi w https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on błąd najwyższego poziomu z kodem błędu, komunikatem, szczegółami, elementem docelowym i wewnętrznym błędem z bardziej opisowymi szczegółami.

InnerError

Objekt

Błąd wewnętrzny jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi w https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on wymagany kod błędu właściwości, komunikat i opcjonalny obiekt docelowy właściwości, błąd wewnętrzny (można to zagnieżdżać).

Nazwa	Typ	Opis
code	string	Szczegółowy kod błędu pomocny w diagnostyce.
innererror	InnerError	Błąd wewnętrzny jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi w https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera on wymagany kod błędu właściwości, komunikat i opcjonalny obiekt docelowy właściwości, błąd wewnętrzny (można to zagnieżdżać).
message	string	Szczegółowy komunikat o błędzie.
target	string	Źródło błędu. Na przykład będzie to "model" lub "identyfikator modelu" w przypadku nieprawidłowego modelu.

Status

Wyliczanie

Stan zasobu.

Wartość	Opis
Disabled
Disabling
Failed
NotStarted
Running
Succeeded