Web Hooks - Get

Referens

Tjänst:: Azure AI Services

API-version:: v3.2-preview.2

Hämtar webbkroken identifierad av det angivna ID:t.

GET {endpoint}/speechtotext/v3.2-preview.2/webhooks/{id}

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

Svar

Name	Typ	Description
200 OK	WebHook	OK Sidhuvuden Retry-After: integer
Other Status Codes	Error	Ett fel uppstod.

Name

Typ

Description

200 OK

WebHook

Sidhuvuden

Retry-After: integer

Other Status Codes

Error

Ett fel uppstod.

Säkerhet

Ocp-Apim-Subscription-Key

Ange din cognitive services-kontonyckel här.

Typ: apiKey
I: header

Authorization

Ange en åtkomsttoken från 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

Get a web hook

Exempelbegäran

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d

Exempelsvar

Statuskod:: 200

{
  "displayName": "TranscriptionCompletionWebHook",
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d",
  "links": {
    "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test",
    "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping"
  },
  "properties": {
    "apiVersion": "v3.2-preview.2",
    "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": "Succeeded"
}

Definitioner

Name	Description
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
Error	Fel
ErrorCode	Felkod
InnerError	InnerError
Status	Status
WebHook	WebHook
WebHookEvents	WebHookEvents
WebHookLinks	WebHookLinks
WebHookProperties	WebHookProperties

DetailedErrorCode

Uppräkning

DetailedErrorCode

Värde	Description
DataImportFailed	Dataimporten misslyckades.
DeleteNotAllowed	Ta bort tillåts inte.
DeployNotAllowed	Distribution tillåts inte.
DeployingFailedModel	Distribution av en misslyckad modell.
EmptyRequest	Tom begäran.
EndpointCannotBeDefault	Slutpunkten kan inte vara standard.
EndpointNotUpdatable	Slutpunkten kan inte uppdateras.
EndpointWithoutLogging	Slutpunkt utan loggning.
ExceededNumberOfRecordingsUris	Överskred antalet inspelningar uris.
FailedDataset	Datauppsättningen misslyckades.
Forbidden	Förbjuden.
InUseViolation	Vid användningsöverträdelse.
InaccessibleCustomerStorage	Otillgänglig kundlagring.
InvalidAdaptationMapping	Ogiltig anpassningsmappning.
InvalidBaseModel	Ogiltig basmodell.
InvalidCallbackUri	Ogiltig återanrops-URI.
InvalidCollection	Ogiltig samling.
InvalidDataset	Ogiltig datauppsättning.
InvalidDocument	Ogiltigt dokument.
InvalidDocumentBatch	Ogiltig dokumentbatch.
InvalidLocale	Ogiltigt språk.
InvalidLogDate	Ogiltigt loggdatum.
InvalidLogEndTime	Ogiltig loggsluttid.
InvalidLogId	Ogiltigt logg-ID.
InvalidLogStartTime	Ogiltig starttid för loggen.
InvalidModel	Ogiltig modell.
InvalidModelUri	Ogiltig modell-URI.
InvalidParameter	Ogiltig parameter.
InvalidParameterValue	Ogiltigt parametervärde.
InvalidPayload	Ogiltig nyttolast.
InvalidPermissions	Ogiltiga behörigheter.
InvalidPrerequisite	Ogiltigt krav.
InvalidProductId	Ogiltigt produkt-ID.
InvalidProject	Ogiltigt projekt.
InvalidProjectKind	Ogiltig projekttyp.
InvalidRecordingsUri	Ogiltig inspelnings-URI.
InvalidRequestBodyFormat	Ogiltigt brödtextformat för begäran.
InvalidSasValidityDuration	Ogiltig varaktighet för sas-giltighet.
InvalidSkipTokenForLogs	Ogiltig hopptoken för loggar.
InvalidSourceAzureResourceId	Ogiltigt azure-källresurs-ID.
InvalidSubscription	Ogiltig prenumeration.
InvalidTest	Ogiltigt test.
InvalidTimeToLive	Ogiltig tid att leva.
InvalidTopForLogs	Ogiltig topp för loggar.
InvalidTranscription	Ogiltig transkription.
InvalidWebHookEventKind	Ogiltig typ av webbhookhändelse.
MissingInputRecords	Indataposter saknas.
ModelCopyOperationExists	Modellkopieringsåtgärden finns.
ModelDeploymentNotCompleteState	Modelldistributionen har inte slutförts.
ModelDeprecated	Modellen är inaktuell.
ModelExists	Modellen finns.
ModelMismatch	Modellmatchningsfel.
ModelNotDeployable	Modellen kan inte distribueras.
ModelVersionIncorrect	Modellversionen är felaktig.
NoUtf8WithBom	Ingen utf8 med bom.
OnlyOneOfUrlsOrContainerOrDataset	Endast en av url:erna eller containern eller datamängden.
ProjectGenderMismatch	Matchningsfel för projektkön.
QuotaViolation	Kvotöverträdelse.
SingleDefaultEndpoint	Enskild standardslutpunkt.
SkuLimitsExist	Det finns SKU-gränser.
SubscriptionNotFound	Det går inte att hitta prenumerationen.
UnexpectedError	Oväntat fel.
UnsupportedClassBasedAdaptation	Klassbaserad anpassning som inte stöds.
UnsupportedDelta	Delta stöds inte.
UnsupportedDynamicConfiguration	Dynamisk konfiguration stöds inte.
UnsupportedFilter	Filter som inte stöds.
UnsupportedLanguageCode	Språkkod som inte stöds.
UnsupportedOrderBy	Order som inte stöds av.
UnsupportedPagination	Sidnumrering stöds inte.
UnsupportedTimeRange	Tidsintervall som inte stöds.

EntityError

Objekt

EntityError

Name	Typ	Description
code	string	Koden för det här felet.
message	string	Meddelandet för det här felet.

Error

Objekt

Fel

Name	Typ	Description
code	ErrorCode	Felkod Felkoder på hög nivå.
details	Error[]	Ytterligare stödjande information om fel och/eller förväntade principer.
innerError	InnerError	InnerError Nytt format för inre fel som överensstämmer med Cognitive Services API Guidelines som finns på https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Detta innehåller nödvändiga egenskaper ErrorCode, meddelande och valfria egenskaper mål, information (nyckel värde par), inre fel (detta kan kapslas).
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

Uppräkning

Felkod

Värde	Description
Conflict	Representerar konfliktfelkoden.
Forbidden	Representerar den otillåtna felkoden.
InternalCommunicationFailed	Det gick inte att ange felkoden för intern kommunikation.
InternalServerError	Representerar felkoden för den interna servern.
InvalidArgument	Representerar den ogiltiga argumentfelkoden.
InvalidRequest	Representerar den ogiltiga felkoden för begäran.
NotAllowed	Representerar den felkod som inte tillåts.
NotFound	Representerar felkoden som inte hittades.
PipelineError	Representerar felkoden för pipelinefel.
ServiceUnavailable	Representerar felkoden för tjänsten som inte är tillgänglig.
TooManyRequests	Representerar felkoden för för många begäranden.
Unauthorized	Representerar den obehöriga felkoden.
UnprocessableEntity	Representerar felkoden för entitetsfel som inte kan bearbetas.
UnsupportedMediaType	Representerar felkoden för medietypen som inte stöds.

InnerError

Objekt

InnerError

Name	Typ	Description
code	DetailedErrorCode	DetailedErrorCode Detaljerad felkodsuppräkning.
details	object	Ytterligare stödjande information om fel och/eller förväntade principer.
innerError	InnerError	InnerError Nytt format för inre fel som överensstämmer med Cognitive Services API Guidelines som finns på https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Detta innehåller nödvändiga egenskaper ErrorCode, meddelande och valfria egenskaper mål, information (nyckel värde par), inre fel (detta kan kapslas).
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.

Status

Uppräkning

Status

Värde	Description
Failed	Den tidskrävande åtgärden misslyckades.
NotStarted	Den tidskrävande åtgärden har ännu inte startats.
Running	Den tidskrävande åtgärden bearbetas för närvarande.
Succeeded	Den tidskrävande åtgärden har slutförts.

WebHook

Objekt

WebHook

Name	Typ	Description
createdDateTime	string (date-time)	Tidsstämpeln när objektet skapades. Tidsstämpeln är kodad som ISO 8601-datum- och tidsformat ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	De anpassade egenskaperna för den här entiteten. Den maximala tillåtna nyckellängden är 64 tecken, den maximala tillåtna värdelängden är 256 tecken och antalet tillåtna poster är 10.
description	string	Beskrivningen av objektet.
displayName	string minLength: 1	Objektets visningsnamn.
events	WebHookEvents	WebHookEvents
lastActionDateTime	string (date-time)	Tidsstämpeln när den aktuella statusen angavs. Tidsstämpeln är kodad som ISO 8601-datum- och tidsformat ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	WebHookLinks	WebHookLinks
properties	WebHookProperties	WebHookProperties
self	string (uri)	Platsen för den här entiteten.
status	Status	Status Beskriva api:ets aktuella tillstånd
webUrl	string (uri)	Den registrerade URL:en som ska användas för att skicka POST-begäranden för de registrerade händelserna till.

WebHookEvents

Objekt

WebHookEvents

Name	Typ	Description
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

Objekt

WebHookLinks

Name	Typ	Description
ping	string (uri)	Den URL som kan användas för att utlösa sändning av en ping-händelse till den registrerade URL:en för en web hook-registrering. Mer information finns i åtgärden "WebHooks_Ping".
test	string (uri)	Den URL som kan användas för att skicka testhändelser till den registrerade URL:en för en web hook-registrering. Mer information finns i åtgärden "WebHooks_Test".

WebHookProperties

Objekt

WebHookProperties

Name	Typ	Description
apiVersion	string	API-versionen som webbkroken skapades i. Detta definierar nyttolastens form i återanropen. Om nyttolasttypen inte längre stöds eftersom formen har ändrats och API-versionen som använder den tas bort (efter utfasningen) inaktiveras webbkroken.
error	EntityError	EntityError
secret	string	En hemlighet som ska användas för att skapa en SHA256-hash av nyttolasten med hemligheten som HMAC-nyckel. Denna hash anges som X-MicrosoftSpeechServices-Signature rubrik när du anropar tillbaka till den registrerade URL:en.

Dela via

Web Hooks - Get

URI-parametrar

Svar

Säkerhet

Ocp-Apim-Subscription-Key

Authorization

Exempel

Get a web hook

Exempelbegäran

Exempelsvar

Definitioner

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

Ytterligare resurser