Consents - Create

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: 2024-02-01-preview

Tworzy nową zgodę na talent głosowy z podanym adresem URL dźwięku.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis

Nazwa	W	Wymagane	Typ	Opis
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	Identyfikator zasobu. Wzorzec wyrażenia regularnego: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.

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

path

True

string

Identyfikator zasobu.

Wzorzec wyrażenia regularnego: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

api-version

query

True

string

Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa Wymagane Typ Opis

Ocp-Apim-Subscription-Key

True

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string	Tutaj podaj klucz zasobu usługi Mowa.
Operation-Id		string	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. Wzorzec wyrażenia regularnego: `^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$`

string

Tutaj podaj klucz zasobu usługi Mowa.

Operation-Id

string

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.

Wzorzec wyrażenia regularnego: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Treść żądania

Nazwa	Wymagane	Typ	Opis
companyName	True	string	Nazwa firmy. Musi być zgodna z nazwą firmy w pliku audio zgody.
locale	True	string	Ustawienia regionalne tej zgody. Kod ustawień regionalnych jest zgodny z kodem BCP-47. Tekst do ustawień regionalnych mowy można znaleźć tutaj https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	True	string	Identyfikator zasobu
voiceTalentName	True	string	Nazwa talentu głosowego. Musi być zgodna z nazwą talentu głosowego w pliku audio zgody.
audioUrl		string	Publiczny dostępny adres URL pliku audio zgody. Zalecane jest, aby być adresem URL obiektu blob platformy Azure z sygnaturą dostępu współdzielonego. Ta właściwość jest dostępna tylko w żądaniu.
description		string	Opis zgody.
displayName		string	Nazwa zgody.
id		string	Identyfikator zasobu
properties		ConsentProperties	Właściwości zgody
status		Status	Stan zasobu.

Odpowiedzi

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

Nazwa

Typ

Opis

201 Created

Consent

Utworzone

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

Przykładowe żądanie

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

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 pod adresem https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera to 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, które są dostępne pod adresem 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 pod adresem 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 obiekt docelowy właściwości opcjonalnych, błąd wewnętrzny (można go zagnieżdżać).
Status	Stan zasobu.

Obiekt zgody

Nazwa	Typ	Opis
audioUrl	string	Publiczny dostępny adres URL pliku audio zgody. Zalecane jest, aby być adresem URL obiektu blob platformy Azure z sygnaturą dostępu współdzielonego. Ta właściwość jest dostępna tylko w żądaniu.
companyName	string	Nazwa firmy. Musi być zgodna z nazwą firmy w pliku audio zgody.
createdDateTime	string	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	Nazwa zgody.
id	string	Identyfikator zasobu
lastActionDateTime	string	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 do ustawień regionalnych mowy można znaleźć tutaj https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string	Identyfikator zasobu
properties	ConsentProperties	Właściwości zgody
status	Status	Stan zasobu.
voiceTalentName	string	Nazwa talentu głosowego. Musi być zgodna z nazwą talentu głosowego w pliku audio zgody.

ConsentFailureReason

Przyczyna niepowodzenia tworzenia zgody

Nazwa	Typ	Opis
AudioAndScriptNotMatch	string	Niezgodność dźwięku zgody z instrukcją słowną. Sprawdź instrukcję słowną.
Internal	string	Błąd niestandardowej usługi głosowej.

ConsentProperties

Właściwości zgody

Nazwa	Typ	Opis
failureReason	ConsentFailureReason	Przyczyna niepowodzenia tworzenia zgody

Error

Błąd najwyższego poziomu jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi pod adresem https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera to 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 pod adresem 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 obiekt docelowy właściwości opcjonalnych, błąd wewnętrzny (można go 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

Kod błędu najwyższego poziomu

Nazwa	Typ	Opis
BadArgument	string
BadRequest	string
Forbidden	string
InternalServerError	string
NotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string
UnsupportedMediaType	string

ErrorResponse

Odpowiedź na błąd jest zgodna z wytycznymi interfejsu API REST platformy Microsoft Azure, które są dostępne pod adresem 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 pod adresem https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Zawiera to 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

Błąd wewnętrzny jest zgodny z wytycznymi interfejsu API REST platformy Microsoft Azure dostępnymi pod adresem 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 obiekt docelowy właściwości opcjonalnych, błąd wewnętrzny (można go 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 pod adresem 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 obiekt docelowy właściwości opcjonalnych, błąd wewnętrzny (można go 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

Stan zasobu.

Nazwa	Typ	Opis
Disabled	string
Disabling	string
Failed	string
NotStarted	string
Running	string
Succeeded	string

Udostępnij za pośrednictwem

Consents - Create

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

Przykłady

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ConsentFailureReason

ConsentProperties

Error

ErrorCode

ErrorResponse

InnerError

Status

Dodatkowe zasoby

Udostępnij za pośrednictwem

Consents - Create

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

Przykłady

Create a consent

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

Consent

ConsentFailureReason

ConsentProperties

Error

ErrorCode

ErrorResponse

InnerError

Status

Dodatkowe zasoby