Web Hooks - Test
Skickar en begäran för varje registrerad händelsetyp till den registrerade URL:en.
Nyttolasten genereras från den senaste entiteten som skulle ha anropat webbhooken. Om ingen entitet finns för någon av de registrerade händelsetyperna svarar POST med 204. Om en testbegäran kan göras svarar den med 200.
Begäran innehåller en X-MicrosoftSpeechServices-Event-rubrik med respektive registrerad händelsetyp.
Om webbhooken registrerades med en hemlighet innehåller den en X-MicrosoftSpeechServices-Signature-rubrik med en SHA256-hash för nyttolasten med hemligheten som HMAC-nyckel. Hashen är base64-kodad.
POST {endpoint}/speechtotext/v3.1/webhooks/{id}:test
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus.api.cognitive.microsoft.com). |
id
|
path | True |
string uuid |
Identifieraren för den webbhook som ska pingas. |
Svar
Name | Typ | Description |
---|---|---|
202 Accepted |
En testbegäran med den sista entiteten skickas till den registrerade webbhooken. Sidhuvuden Retry-After: integer |
|
204 No Content |
Det gick inte att hitta någon entitet för någon händelsetyp, så ingen testbegäran skickas till den registrerade webbhooken. |
|
Other Status Codes |
Ett fel inträffade. |
Säkerhet
Ocp-Apim-Subscription-Key
Ange din cognitive services-kontonyckel här.
Typ:
apiKey
I:
header
Authorization
Ange en åtkomsttoken från den JWT som returneras av STS i den här regionen. Se till att lägga till hanteringsomfånget i token genom att lägga till följande frågesträng i STS-URL:en: ?scope=speechservicesmanagement
Typ:
apiKey
I:
header
Exempel
Test a web hook
Exempelbegäran
POST {endpoint}/speechtotext/v3.1/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test
Exempelsvar
Definitioner
Name | Description |
---|---|
Detailed |
DetailedErrorCode |
Error |
Fel |
Error |
Felkod |
Inner |
InnerError |
DetailedErrorCode
DetailedErrorCode
Name | Typ | Description |
---|---|---|
DataImportFailed |
string |
Dataimporten misslyckades. |
DeleteNotAllowed |
string |
Ta bort tillåts inte. |
DeployNotAllowed |
string |
Distribution tillåts inte. |
DeployingFailedModel |
string |
Distributionen av en misslyckad modell. |
EmptyRequest |
string |
Tom begäran. |
EndpointCannotBeDefault |
string |
Slutpunkten kan inte vara standard. |
EndpointNotUpdatable |
string |
Slutpunkten kan inte uppdateras. |
EndpointWithoutLogging |
string |
Slutpunkt utan loggning. |
ExceededNumberOfRecordingsUris |
string |
Överskred antalet inspelningar uris. |
FailedDataset |
string |
Datauppsättningen misslyckades. |
Forbidden |
string |
Förbjudet. |
InUseViolation |
string |
Vid användningsöverträdelse. |
InaccessibleCustomerStorage |
string |
Otillgänglig kundlagring. |
InvalidAdaptationMapping |
string |
Ogiltig anpassningsmappning. |
InvalidBaseModel |
string |
Ogiltig basmodell. |
InvalidCallbackUri |
string |
Ogiltig återanrops-URI. |
InvalidCollection |
string |
Ogiltig samling. |
InvalidDataset |
string |
Ogiltig datauppsättning. |
InvalidDocument |
string |
Ogiltigt dokument. |
InvalidDocumentBatch |
string |
Ogiltig dokumentbatch. |
InvalidLocale |
string |
Ogiltigt språk. |
InvalidLogDate |
string |
Ogiltigt loggdatum. |
InvalidLogEndTime |
string |
Ogiltig loggsluttid. |
InvalidLogId |
string |
Ogiltigt logg-ID. |
InvalidLogStartTime |
string |
Ogiltig starttid för loggen. |
InvalidModel |
string |
Ogiltig modell. |
InvalidModelUri |
string |
Ogiltig modell-URI. |
InvalidParameter |
string |
Ogiltig parameter. |
InvalidParameterValue |
string |
Ogiltigt parametervärde. |
InvalidPayload |
string |
Ogiltig nyttolast. |
InvalidPermissions |
string |
Ogiltiga behörigheter. |
InvalidPrerequisite |
string |
Ogiltig förutsättning. |
InvalidProductId |
string |
Ogiltigt produkt-ID. |
InvalidProject |
string |
Ogiltigt projekt. |
InvalidProjectKind |
string |
Ogiltig projekttyp. |
InvalidRecordingsUri |
string |
Ogiltig inspelnings-URI. |
InvalidRequestBodyFormat |
string |
Ogiltigt brödtextformat för begäran. |
InvalidSasValidityDuration |
string |
Ogiltig varaktighet för SAS-giltighet. |
InvalidSkipTokenForLogs |
string |
Ogiltig hopptoken för loggar. |
InvalidSubscription |
string |
Ogiltig prenumeration. |
InvalidTest |
string |
Ogiltigt test. |
InvalidTimeToLive |
string |
Ogiltigt time to live. |
InvalidTopForLogs |
string |
Ogiltig överkant för loggar. |
InvalidTranscription |
string |
Ogiltig transkription. |
InvalidWebHookEventKind |
string |
Ogiltig webhookhändelsetyp. |
MissingInputRecords |
string |
Indataposter saknas. |
ModelDeploymentNotCompleteState |
string |
Modelldistributionen är inte fullständigt. |
ModelDeprecated |
string |
Modellen är inaktuell. |
ModelExists |
string |
Modellen finns. |
ModelMismatch |
string |
Modellmatchningsfel. |
ModelNotDeployable |
string |
Modellen kan inte distribueras. |
ModelVersionIncorrect |
string |
Modellversionen är felaktig. |
NoUtf8WithBom |
string |
Ingen utf8 med bom. |
OnlyOneOfUrlsOrContainerOrDataset |
string |
Endast en av URL:erna eller containern eller datauppsättningen. |
ProjectGenderMismatch |
string |
Matchningsfel för projektkön. |
QuotaViolation |
string |
Kvotöverträdelse. |
SingleDefaultEndpoint |
string |
Enskild standardslutpunkt. |
SkuLimitsExist |
string |
Det finns SKU-gränser. |
SubscriptionNotFound |
string |
Det går inte att hitta prenumerationen. |
UnexpectedError |
string |
Oväntat fel. |
UnsupportedClassBasedAdaptation |
string |
Klassbaserad anpassning stöds inte. |
UnsupportedDelta |
string |
Delta stöds inte. |
UnsupportedDynamicConfiguration |
string |
Dynamisk konfiguration stöds inte. |
UnsupportedFilter |
string |
Filter som inte stöds. |
UnsupportedLanguageCode |
string |
Språkkod som inte stöds. |
UnsupportedOrderBy |
string |
Order som inte stöds av. |
UnsupportedPagination |
string |
Sidnumrering stöds inte. |
UnsupportedTimeRange |
string |
Tidsintervallet stöds inte. |
Error
Fel
Name | Typ | Description |
---|---|---|
code |
Felkod |
|
details |
Error[] |
Ytterligare stödjande information om fel- och/eller förväntade principer. |
innerError |
InnerError |
|
message |
string |
Felmeddelande på hög nivå. |
target |
string |
Källan till felet. Det skulle till exempel vara "dokument" eller "dokument-ID" om dokumentet är ogiltigt. |
ErrorCode
Felkod
Name | Typ | Description |
---|---|---|
Conflict |
string |
Representerar konfliktfelkoden. |
Forbidden |
string |
Representerar den otillåtna felkoden. |
InternalCommunicationFailed |
string |
Det gick inte att representera felkoden för intern kommunikation. |
InternalServerError |
string |
Representerar felkoden för den interna servern. |
InvalidArgument |
string |
Representerar den ogiltiga argumentfelkoden. |
InvalidRequest |
string |
Representerar felkoden för ogiltig begäran. |
NotAllowed |
string |
Representerar den felkod som inte tillåts. |
NotFound |
string |
Representerar felkoden som inte hittades. |
PipelineError |
string |
Representerar felkoden för pipelinefel. |
ServiceUnavailable |
string |
Representerar felkoden för tjänsten som inte är tillgänglig. |
TooManyRequests |
string |
Representerar felkoden för många begäranden. |
Unauthorized |
string |
Representerar den otillåtna felkoden. |
UnprocessableEntity |
string |
Representerar felkoden för entiteten som inte kan bearbetas. |
UnsupportedMediaType |
string |
Representerar felkoden för medietypen som inte stöds. |
InnerError
InnerError
Name | Typ | Description |
---|---|---|
code |
DetailedErrorCode |
|
details |
object |
Ytterligare stödjande information om fel- och/eller förväntade principer. |
innerError |
InnerError |
|
message |
string |
Felmeddelande på hög nivå. |
target |
string |
Källan till felet. Det skulle till exempel vara "dokument" eller "dokument-ID" om dokumentet är ogiltigt. |