Web Hooks - Test
Wysyła żądanie dla każdego zarejestrowanego typu zdarzenia do zarejestrowanego adresu URL.
Ładunek zostanie wygenerowany na podstawie ostatniej jednostki, która wywołałaby element webhook. Jeśli żadna jednostka nie jest obecna dla żadnego z zarejestrowanych typów zdarzeń, post odpowie 204. Jeśli można wysłać żądanie testowe, odpowie 200.
Żądanie będzie zawierać nagłówek X-MicrosoftSpeechServices-Event z odpowiednim typem zarejestrowanego zdarzenia.
Jeśli element webhook został zarejestrowany przy użyciu wpisu tajnego, będzie zawierać nagłówek X-MicrosoftSpeechServices-Signature z skrótem SHA256 ładunku z kluczem tajnym jako klucz HMAC. Skrót jest zakodowany w formacie base64.
POST {endpoint}/speechtotext/v3.2-preview.2/webhooks/{id}:testParametry 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). |
|
id
|
path | True |
string (uuid) |
Identyfikator elementu webhook do polecenia ping. |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 202 Accepted |
Żądanie testowe z ostatnią jednostką jest wysyłane do zarejestrowanego elementu webhook. Nagłówki Retry-After: integer |
|
| 204 No Content |
Nie można odnaleźć jednostki dla dowolnego typu zdarzenia, więc żadne żądanie testowe nie jest wysyłane do zarejestrowanego elementu webhook. |
|
| Other Status Codes |
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 zestawu JWT zwróconego 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
Test a web hook
Przykładowe żądanie
POST {endpoint}/speechtotext/v3.2-preview.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test
Przykładowa odpowiedź
Definicje
| Nazwa | Opis |
|---|---|
|
Detailed |
DetailedErrorCode |
| Error |
Błąd |
|
Error |
Kod błędu |
|
Inner |
InnerError |
DetailedErrorCode
DetailedErrorCode
| Wartość | Opis |
|---|---|
| InvalidParameterValue |
Nieprawidłowa wartość parametru. |
| InvalidRequestBodyFormat |
Nieprawidłowy format treści żądania. |
| EmptyRequest |
Puste żądanie. |
| MissingInputRecords |
Brak rekordów wejściowych. |
| InvalidDocument |
Nieprawidłowy dokument. |
| ModelVersionIncorrect |
Nieprawidłowa wersja modelu. |
| InvalidDocumentBatch |
Nieprawidłowa partia dokumentów. |
| UnsupportedLanguageCode |
Nieobsługiwany kod języka. |
| DataImportFailed |
Importowanie danych nie powiodło się. |
| InUseViolation |
Naruszenie użycia. |
| InvalidLocale |
Nieprawidłowe ustawienia regionalne. |
| InvalidBaseModel |
Nieprawidłowy model podstawowy. |
| InvalidAdaptationMapping |
Nieprawidłowe mapowanie adaptacji. |
| InvalidDataset |
Nieprawidłowy zestaw danych. |
| InvalidTest |
Nieprawidłowy test. |
| FailedDataset |
Zestaw danych, który zakończył się niepowodzeniem. |
| InvalidModel |
Nieprawidłowy model. |
| InvalidTranscription |
Nieprawidłowa transkrypcja. |
| InvalidPayload |
Nieprawidłowy ładunek. |
| InvalidParameter |
Nieprawidłowy parametr. |
| EndpointWithoutLogging |
Punkt końcowy bez rejestrowania. |
| InvalidPermissions |
Nieprawidłowe uprawnienia. |
| InvalidPrerequisite |
Nieprawidłowe wymaganie wstępne. |
| InvalidProductId |
Nieprawidłowy identyfikator produktu. |
| InvalidSubscription |
Nieprawidłowa subskrypcja. |
| InvalidProject |
Nieprawidłowy projekt. |
| InvalidProjectKind |
Nieprawidłowy rodzaj projektu. |
| InvalidRecordingsUri |
Nieprawidłowy identyfikator URI nagrań. |
| OnlyOneOfUrlsOrContainerOrDataset |
Tylko jeden z adresów URL lub kontenera lub zestawu danych. |
| ExceededNumberOfRecordingsUris |
Przekroczono liczbę nagrań uris. |
| ModelMismatch |
Niezgodność modelu. |
| ProjectGenderMismatch |
Niezgodność płci projektu. |
| ModelDeprecated |
Model jest przestarzały. |
| ModelExists |
Model istnieje. |
| ModelNotDeployable |
Nie można wdrożyć modelu. |
| EndpointNotUpdatable |
Punkt końcowy nie można aktualizować. |
| SingleDefaultEndpoint |
Pojedynczy domyślny punkt końcowy. |
| EndpointCannotBeDefault |
Punkt końcowy nie może być domyślny. |
| InvalidModelUri |
Nieprawidłowy identyfikator URI modelu. |
| SubscriptionNotFound |
Nie można odnaleźć subskrypcji. |
| QuotaViolation |
Naruszenie limitu przydziału. |
| UnsupportedDelta |
Nieobsługiwana delta. |
| UnsupportedFilter |
Nieobsługiwany filtr. |
| UnsupportedPagination |
Nieobsługiwane stronicowanie. |
| UnsupportedDynamicConfiguration |
Nieobsługiwana konfiguracja dynamiczna. |
| UnsupportedOrderBy |
Nieobsługiwana kolejność według. |
| NoUtf8WithBom |
Brak utf8 z bom. |
| ModelDeploymentNotCompleteState |
Wdrożenie modelu nie zostało ukończone. |
| SkuLimitsExist |
Istnieją limity jednostek SKU. |
| DeployingFailedModel |
Wdrażanie modelu nie powiodło się. |
| UnsupportedTimeRange |
Nieobsługiwany zakres czasu. |
| InvalidLogDate |
Nieprawidłowa data dziennika. |
| InvalidLogId |
Nieprawidłowy identyfikator dziennika. |
| InvalidLogStartTime |
Nieprawidłowy czas rozpoczęcia dziennika. |
| InvalidLogEndTime |
Nieprawidłowy czas zakończenia dziennika. |
| InvalidTopForLogs |
Nieprawidłowy górny element dla dzienników. |
| InvalidSkipTokenForLogs |
Nieprawidłowy token pomijania dzienników. |
| DeleteNotAllowed |
Usuń niedozwolone. |
| Forbidden |
Zakazany. |
| DeployNotAllowed |
Wdrażanie jest niedozwolone. |
| UnexpectedError |
Nieoczekiwany błąd. |
| InvalidCollection |
Nieprawidłowa kolekcja. |
| InvalidCallbackUri |
Nieprawidłowy identyfikator URI wywołania zwrotnego. |
| InvalidSasValidityDuration |
Nieprawidłowy czas ważności sygnatury dostępu współdzielonego. |
| InaccessibleCustomerStorage |
Niedostępny magazyn klienta. |
| UnsupportedClassBasedAdaptation |
Nieobsługiwana adaptacja oparta na klasach. |
| InvalidWebHookEventKind |
Nieprawidłowy rodzaj zdarzenia elementu webhook. |
| InvalidTimeToLive |
Nieprawidłowy czas wygaśnięcia. |
| InvalidSourceAzureResourceId |
Nieprawidłowy źródłowy identyfikator zasobu platformy Azure. |
| ModelCopyOperationExists |
Istnieje operacja kopiowania modelu. |
Error
Błąd
| Nazwa | Typ | Opis |
|---|---|---|
| code |
Kod błędu |
|
| details |
Error[] |
Dodatkowe szczegóły pomocnicze dotyczące błędów i/lub oczekiwanych zasad. |
| innerError |
InnerError |
|
| 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
Kod błędu
| Wartość | Opis |
|---|---|
| InvalidRequest |
Reprezentowanie nieprawidłowego kodu błędu żądania. |
| InvalidArgument |
Reprezentowanie nieprawidłowego kodu błędu argumentu. |
| InternalServerError |
Reprezentowanie wewnętrznego kodu błędu serwera. |
| ServiceUnavailable |
Reprezentowanie niedostępnego kodu błędu usługi. |
| NotFound |
Reprezentacja kodu błędu, który nie został znaleziony. |
| PipelineError |
Reprezentowanie kodu błędu potoku. |
| Conflict |
Reprezentowanie kodu błędu powodującego konflikt. |
| InternalCommunicationFailed |
Reprezentowanie wewnętrznego kodu błędu komunikacji nie powiodło się. |
| Forbidden |
Reprezentowanie niedozwolonego kodu błędu. |
| NotAllowed |
Reprezentowanie niedozwolonego kodu błędu. |
| Unauthorized |
Reprezentowanie nieautoryzowanego kodu błędu. |
| UnsupportedMediaType |
Reprezentowanie nieobsługiwanego kodu błędu typu nośnika. |
| TooManyRequests |
Reprezentując kod błędu zbyt wielu żądań. |
| UnprocessableEntity |
Reprezentowanie nieprzetworzonego kodu błędu jednostki. |
InnerError
InnerError
| Nazwa | Typ | Opis |
|---|---|---|
| code |
DetailedErrorCode |
|
| details |
object |
Dodatkowe szczegóły pomocnicze dotyczące błędów i/lub oczekiwanych zasad. |
| innerError |
InnerError |
|
| 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. |