Web Hooks - Create

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: v3.1

Tworzy nowy element web hook.
Jeśli wpis tajny właściwości w konfiguracji jest obecny i zawiera niepusty ciąg, zostanie użyty do utworzenia skrótu SHA256 ładunku z kluczem tajnym jako klucz HMAC. Ten skrót zostanie ustawiony jako nagłówek X-MicrosoftSpeechServices-Signature podczas wywoływania z powrotem do zarejestrowanego adresu URL.

Podczas wywoływania zarejestrowanego adresu URL żądanie będzie zawierać nagłówek X-MicrosoftSpeechServices-Event zawierający jeden z zarejestrowanych typów zdarzeń. Będzie jedno żądanie na zarejestrowany typ zdarzenia.

Po pomyślnym zarejestrowaniu elementu web hook nie będzie można go używać do momentu ukończenia zadania/odpowiedzi. W tym celu żądanie z wyzwaniem typu zdarzenia zostanie wykonane z parametrem zapytania o nazwie validationToken. Odpowiedź na wyzwanie za pomocą 200 OK zawierającego wartość parametru zapytania validationToken jako treść odpowiedzi. Po pomyślnym zakończeniu zadania/odpowiedzi punkt zaczepienia internetowego rozpocznie odbieranie zdarzeń.

POST {endpoint}/speechtotext/v3.1/webhooks

Parametry identyfikatora URI

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://westus.api.cognitive.microsoft.com).

Treść żądania

Nazwa	Wymagane	Typ	Opis
displayName	True	string	Nazwa wyświetlana obiektu.
events	True	WebHookEvents	WebHookEvents
webUrl	True	string	Zarejestrowany adres URL, który będzie używany do wysyłania żądań POST dla zarejestrowanych zdarzeń.
customProperties		object	Właściwości niestandardowe tej jednostki. Maksymalna dozwolona długość klucza to 64 znaki, maksymalna dozwolona długość wartości to 256 znaków, a liczba dozwolonych wpisów wynosi 10.
description		string	Opis obiektu.
links		WebHookLinks	WebHookLinks
properties		WebHookProperties	Właściwości elementu WebHook

Odpowiedzi

Nazwa	Typ	Opis
201 Created	WebHook	Odpowiedź zawiera informacje o jednostce jako ładunku i jego lokalizacji jako nagłówku. Nagłówki Location: string
Other Status Codes	Error	Wystąpił błąd.

Nazwa

Typ

Opis

201 Created

WebHook

Odpowiedź zawiera informacje o jednostce jako ładunku i jego lokalizacji jako nagłówku.

Nagłówki

Location: string

Other Status Codes

Error

Wystąpił błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Tutaj podaj klucz konta usług Cognitive Services.

Typ: apiKey
W: header

Authorization

Podaj token dostępu z JWT zwrócony przez usługę STS tego regionu. Pamiętaj, aby dodać zakres zarządzania do tokenu, dodając następujący ciąg zapytania do adresu URL usługi STS: ?scope=speechservicesmanagement

Typ: apiKey
W: header

Przykłady

Create a web hook

Przykładowe żądanie

HTTP

POST {endpoint}/speechtotext/v3.1/webhooks

{
  "displayName": "TranscriptionCompletionWebHook",
  "properties": {
    "secret": "$CREDENTIAL_PLACEHOLDER$"
  },
  "webUrl": "https://contoso.com/call/me/back",
  "events": {
    "transcriptionCompletion": true
  },
  "description": "I registered this URL to get a POST request for each completed transcription."
}

Przykładowa odpowiedź

Kod stanu:: 201

Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d

{
  "displayName": "TranscriptionCompletionWebHook",
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d",
  "links": {
    "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test",
    "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping"
  },
  "properties": {
    "apiVersion": "v3.1",
    "secret": "$CREDENTIAL_PLACEHOLDER$"
  },
  "webUrl": "https://contoso.com/call/me/back",
  "events": {
    "transcriptionCompletion": true
  },
  "description": "I registered this URL to get a POST request for each completed transcription.",
  "createdDateTime": "2018-11-11T00:00:00Z",
  "lastActionDateTime": "2018-11-28T00:00:00Z",
  "status": "NotStarted"
}

Definicje

Nazwa	Opis
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
Error	Błąd
ErrorCode	ErrorCode
InnerError	InnerError
Status	Stan
WebHook	Element webhook
WebHookEvents	WebHookEvents
WebHookLinks	WebHookLinks
WebHookProperties	Właściwości elementu WebHook

DetailedErrorCode

Nazwa	Typ	Opis
DataImportFailed	string	Importowanie danych nie powiodło się.
DeleteNotAllowed	string	Usuń niedozwolone.
DeployNotAllowed	string	Wdrażanie jest niedozwolone.
DeployingFailedModel	string	Wdrażanie modelu, który zakończył się niepowodzeniem.
EmptyRequest	string	Puste żądanie.
EndpointCannotBeDefault	string	Punkt końcowy nie może być domyślny.
EndpointNotUpdatable	string	Punkt końcowy nie można zaktualizować.
EndpointWithoutLogging	string	Punkt końcowy bez rejestrowania.
ExceededNumberOfRecordingsUris	string	Przekroczono liczbę nagrań uris.
FailedDataset	string	Zestaw danych, który zakończył się niepowodzeniem.
Forbidden	string	Zakazane.
InUseViolation	string	Naruszenie użycia.
InaccessibleCustomerStorage	string	Niedostępny magazyn klienta.
InvalidAdaptationMapping	string	Nieprawidłowe mapowanie adaptacji.
InvalidBaseModel	string	Nieprawidłowy model podstawowy.
InvalidCallbackUri	string	Nieprawidłowy identyfikator URI wywołania zwrotnego.
InvalidCollection	string	Nieprawidłowa kolekcja.
InvalidDataset	string	Nieprawidłowy zestaw danych.
InvalidDocument	string	Nieprawidłowy dokument.
InvalidDocumentBatch	string	Nieprawidłowa partia dokumentów.
InvalidLocale	string	Nieprawidłowe ustawienia regionalne.
InvalidLogDate	string	Nieprawidłowa data dziennika.
InvalidLogEndTime	string	Nieprawidłowy czas zakończenia dziennika.
InvalidLogId	string	Nieprawidłowy identyfikator dziennika.
InvalidLogStartTime	string	Nieprawidłowy czas rozpoczęcia dziennika.
InvalidModel	string	Nieprawidłowy model.
InvalidModelUri	string	Nieprawidłowy identyfikator URI modelu.
InvalidParameter	string	Nieprawidłowy parametr.
InvalidParameterValue	string	Nieprawidłowa wartość parametru.
InvalidPayload	string	Nieprawidłowy ładunek.
InvalidPermissions	string	Nieprawidłowe uprawnienia.
InvalidPrerequisite	string	Nieprawidłowe wymaganie wstępne.
InvalidProductId	string	Nieprawidłowy identyfikator produktu.
InvalidProject	string	Nieprawidłowy projekt.
InvalidProjectKind	string	Nieprawidłowy rodzaj projektu.
InvalidRecordingsUri	string	Nieprawidłowy identyfikator URI nagrań.
InvalidRequestBodyFormat	string	Nieprawidłowy format treści żądania.
InvalidSasValidityDuration	string	Nieprawidłowy czas trwania ważności sygnatury dostępu współdzielonego.
InvalidSkipTokenForLogs	string	Nieprawidłowy token pomijania dzienników.
InvalidSubscription	string	Nieprawidłowa subskrypcja.
InvalidTest	string	Nieprawidłowy test.
InvalidTimeToLive	string	Nieprawidłowy czas wygaśnięcia.
InvalidTopForLogs	string	Nieprawidłowa górna wierzchołka dzienników.
InvalidTranscription	string	Nieprawidłowa transkrypcja.
InvalidWebHookEventKind	string	Nieprawidłowy rodzaj zdarzenia haka internetowego.
MissingInputRecords	string	Brak rekordów wejściowych.
ModelDeploymentNotCompleteState	string	Wdrożenie modelu nie zostało ukończone.
ModelDeprecated	string	Model przestarzały.
ModelExists	string	Model istnieje.
ModelMismatch	string	Niezgodność modelu.
ModelNotDeployable	string	Model nie można wdrożyć.
ModelVersionIncorrect	string	Wersja modelu jest nieprawidłowa.
NoUtf8WithBom	string	Brak utf8 z bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Tylko jeden z adresów URL lub kontenera lub zestawu danych.
ProjectGenderMismatch	string	Niezgodność płci projektu.
QuotaViolation	string	Naruszenie limitu przydziału.
SingleDefaultEndpoint	string	Pojedynczy domyślny punkt końcowy.
SkuLimitsExist	string	Istnieją limity jednostek SKU.
SubscriptionNotFound	string	Nie można odnaleźć subskrypcji.
UnexpectedError	string	Nieoczekiwany błąd.
UnsupportedClassBasedAdaptation	string	Nieobsługiwana adaptacja oparta na klasach.
UnsupportedDelta	string	Nieobsługiwana delta.
UnsupportedDynamicConfiguration	string	Nieobsługiwana konfiguracja dynamiczna.
UnsupportedFilter	string	Nieobsługiwany filtr.
UnsupportedLanguageCode	string	Nieobsługiwany kod języka.
UnsupportedOrderBy	string	Nieobsługiwane zamówienie według.
UnsupportedPagination	string	Nieobsługiwane stronicowanie.
UnsupportedTimeRange	string	Nieobsługiwany zakres czasu.

EntityError

Nazwa	Typ	Opis
code	string	Kod tego błędu.
message	string	Komunikat o tym błędzie.

Error

Błąd

Nazwa	Typ	Opis
code	ErrorCode	ErrorCode Kody błędów wysokiego poziomu.
details	Error[]	Dodatkowe szczegóły pomocnicze dotyczące błędów i/lub oczekiwanych zasad.
innerError	InnerError	InnerError Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API usług Cognitive Services dostępnymi pod adresem https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Zawiera to wymagane właściwości ErrorCode, komunikat i opcjonalny obiekt docelowy właściwości, szczegóły (para wartości klucza), błąd wewnętrzny (można to zagnieżdżać).
message	string	Komunikat o błędzie wysokiego poziomu.
target	string	Źródło błędu. Na przykład będzie to "dokumenty" lub "identyfikator dokumentu" w przypadku nieprawidłowego dokumentu.

ErrorCode

Nazwa	Typ	Opis
Conflict	string	Reprezentowanie kodu błędu powodującego konflikt.
Forbidden	string	Reprezentuje kod błędu zabronionego.
InternalCommunicationFailed	string	Reprezentowanie kodu błędu komunikacji wewnętrznej nie powiodło się.
InternalServerError	string	Reprezentowanie wewnętrznego kodu błędu serwera.
InvalidArgument	string	Reprezentowanie nieprawidłowego kodu błędu argumentu.
InvalidRequest	string	Reprezentowanie nieprawidłowego kodu błędu żądania.
NotAllowed	string	Reprezentowanie niedozwolonego kodu błędu.
NotFound	string	Reprezentując kod błędu nie znaleziono.
PipelineError	string	Reprezentowanie kodu błędu potoku.
ServiceUnavailable	string	Reprezentuje kod błędu niedostępności usługi.
TooManyRequests	string	Reprezentowanie zbyt wielu żądań kod błędu.
Unauthorized	string	Reprezentowanie nieautoryzowanego kodu błędu.
UnprocessableEntity	string	Reprezentowanie nieprzetworzonego kodu błędu jednostki.
UnsupportedMediaType	string	Reprezentowanie nieobsługiwanego kodu błędu typu nośnika.

InnerError

Nazwa	Typ	Opis
code	DetailedErrorCode	DetailedErrorCode Szczegółowy wyliczenie kodu błędu.
details	object	Dodatkowe szczegóły pomocnicze dotyczące błędów i/lub oczekiwanych zasad.
innerError	InnerError	InnerError Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API usług Cognitive Services dostępnymi pod adresem https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Zawiera to wymagane właściwości ErrorCode, komunikat i opcjonalny obiekt docelowy właściwości, szczegóły (para wartości klucza), błąd wewnętrzny (można to zagnieżdżać).
message	string	Komunikat o błędzie wysokiego poziomu.
target	string	Źródło błędu. Na przykład będzie to "dokumenty" lub "identyfikator dokumentu" w przypadku nieprawidłowego dokumentu.

Status

Stan

Nazwa	Typ	Opis
Failed	string	Długotrwała operacja nie powiodła się.
NotStarted	string	Długotrwała operacja nie została jeszcze uruchomiona.
Running	string	Długotrwała operacja jest obecnie przetwarzana.
Succeeded	string	Operacja długotrwała została pomyślnie ukończona.

WebHook

Element webhook

Nazwa	Typ	Opis
createdDateTime	string	Sygnatura czasowa utworzenia obiektu. Sygnatura czasowa jest kodowana 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).
customProperties	object	Właściwości niestandardowe tej jednostki. Maksymalna dozwolona długość klucza to 64 znaki, maksymalna dozwolona długość wartości to 256 znaków, a liczba dozwolonych wpisów wynosi 10.
description	string	Opis obiektu.
displayName	string	Nazwa wyświetlana obiektu.
events	WebHookEvents	WebHookEvents
lastActionDateTime	string	Sygnatura czasowa po wprowadzeniu bieżącego stanu. Sygnatura czasowa jest kodowana 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).
links	WebHookLinks	WebHookLinks
properties	WebHookProperties	Właściwości elementu WebHook
self	string	Lokalizacja tej jednostki.
status	Status	Stan Opis bieżącego stanu interfejsu API
webUrl	string	Zarejestrowany adres URL, który będzie używany do wysyłania żądań POST dla zarejestrowanych zdarzeń.

WebHookEvents

Nazwa	Typ	Opis
challenge	boolean
datasetCompletion	boolean
datasetCreation	boolean
datasetDeletion	boolean
datasetProcessing	boolean
endpointCompletion	boolean
endpointCreation	boolean
endpointDeletion	boolean
endpointProcessing	boolean
evaluationCompletion	boolean
evaluationCreation	boolean
evaluationDeletion	boolean
evaluationProcessing	boolean
modelCompletion	boolean
modelCreation	boolean
modelDeletion	boolean
modelProcessing	boolean
ping	boolean
transcriptionCompletion	boolean
transcriptionCreation	boolean
transcriptionDeletion	boolean
transcriptionProcessing	boolean

WebHookLinks

Nazwa	Typ	Opis
ping	string	Adres URL, który może służyć do wyzwalania wysyłania zdarzenia ping do zarejestrowanego adresu URL rejestracji elementu web hook. Aby uzyskać więcej informacji, zobacz operację "WebHooks_Ping".
test	string	Adres URL, który może służyć do wysyłania zdarzeń testowych do zarejestrowanego adresu URL rejestracji elementu web hook. Aby uzyskać więcej informacji, zobacz operację "WebHooks_Test".

WebHookProperties

Właściwości elementu WebHook

Nazwa	Typ	Opis
apiVersion	string	Wersja interfejsu API, w ramach którego utworzono element web hook. Definiuje kształt ładunku w wywołaniach zwrotnych. Jeśli typ ładunku nie jest już obsługiwany, ponieważ kształt został zmieniony i wersja interfejsu API przy użyciu niego zostanie usunięta (po wycofaniu), element web hook zostanie wyłączony.
error	EntityError	EntityError
secret	string	Wpis tajny, który zostanie użyty do utworzenia skrótu SHA256 ładunku z kluczem tajnym jako klucz HMAC. Ten skrót zostanie ustawiony jako nagłówek X-MicrosoftSpeechServices-Signature podczas wywoływania z powrotem do zarejestrowanego adresu URL.

Udostępnij za pośrednictwem

Web Hooks - Create

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

Authorization

Przykłady

Create a web hook

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

Dodatkowe zasoby