Web Hooks - Update

Referentie

Service:: Azure AI Services

API Version:: v3.1

Updates de webhook die wordt geïdentificeerd door de opgegeven id.
Als het eigenschapsgeheim in de configuratie wordt weggelaten of een lege tekenreeks bevat, bevatten toekomstige callbacks geen X-MicrosoftSpeechServices-Signature-headers. Als de eigenschap een niet-lege tekenreeks bevat, wordt deze gebruikt om een SHA256-hash van de nettolading te maken met het geheim als HMAC-sleutel. Deze hash wordt ingesteld als X-MicrosoftSpeechServices-Signature-header bij het terugroepen naar de geregistreerde URL.

Als de URL wordt gewijzigd, ontvangt de webhook geen gebeurtenissen meer totdat een uitdaging/antwoord is voltooid. Hiervoor wordt een aanvraag met de gebeurtenistypeuitdaging gemaakt met een queryparameter met de naam validationToken. Reageer op de uitdaging met een 200 OK met de waarde van de queryparameter validationToken als antwoordtekst. Wanneer de uitdaging/het antwoord is voltooid, begint de webhook gebeurtenissen te ontvangen.

PATCH {endpoint}/speechtotext/v3.1/webhooks/{id}

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://westus.api.cognitive.microsoft.com).
id	path	True	string uuid	De id van de webhook.

Aanvraagbody

Media Types: "application/json", "application/merge-patch+json"

Name	Type	Description
customProperties	object	De aangepaste eigenschappen van deze entiteit. De maximaal toegestane sleutellengte is 64 tekens, de maximaal toegestane waardelengte is 256 tekens en het aantal toegestane vermeldingen is 10.
description	string	De beschrijving van het object.
displayName	string	De naam van het object.
events	WebHookEvents	WebHookEvents
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
webUrl	string	De geregistreerde URL waarnaar de POST-aanvragen voor de geregistreerde gebeurtenissen worden verzonden.

Antwoorden

Name	Type	Description
200 OK	WebHook	OK Headers Retry-After: integer
Other Status Codes	Error	Er is een fout opgetreden.

Name

Type

Description

200 OK

WebHook

Headers

Retry-After: integer

Other Status Codes

Error

Er is een fout opgetreden.

Beveiliging

Ocp-Apim-Subscription-Key

Geef hier de sleutel van uw Cognitive Services-account op.

Type: apiKey
In: header

Authorization

Geef een toegangstoken op van de JWT die wordt geretourneerd door de STS van deze regio. Zorg ervoor dat u het beheerbereik aan het token toevoegt door de volgende queryreeks toe te voegen aan de STS-URL: ?scope=speechservicesmanagement

Type: apiKey
In: header

Voorbeelden

Update a web hook

Sample Request

HTTP

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

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

Sample Response

Status code:: 200

{
  "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": "Succeeded"
}

Definities

Name	Description
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
Error	Fout
ErrorCode	ErrorCode
InnerError	InnerError
Status	Status
WebHook	WebHook
WebHookEvents	WebHookEvents
WebHookLinks	WebHookLinks
WebHookProperties	WebHookProperties
WebHookPropertiesUpdate	WebHookPropertiesUpdate
WebHookUpdate	WebHookUpdate

DetailedErrorCode

Name	Type	Description
DataImportFailed	string	Het importeren van gegevens is mislukt.
DeleteNotAllowed	string	Verwijderen is niet toegestaan.
DeployNotAllowed	string	Implementeren is niet toegestaan.
DeployingFailedModel	string	Het implementeren van een mislukt model.
EmptyRequest	string	Lege aanvraag.
EndpointCannotBeDefault	string	Eindpunt kan niet standaard zijn.
EndpointNotUpdatable	string	Eindpunt kan niet worden bijgewerkt.
EndpointWithoutLogging	string	Eindpunt zonder logboekregistratie.
ExceededNumberOfRecordingsUris	string	Het aantal opnamen is overschreden.
FailedDataset	string	Mislukte gegevensset.
Forbidden	string	Verboden.
InUseViolation	string	Schending van gebruik.
InaccessibleCustomerStorage	string	Ontoegankelijke klantopslag.
InvalidAdaptationMapping	string	Ongeldige aanpassingstoewijzing.
InvalidBaseModel	string	Ongeldig basismodel.
InvalidCallbackUri	string	Ongeldige callback-URI.
InvalidCollection	string	Ongeldige verzameling.
InvalidDataset	string	Ongeldige gegevensset.
InvalidDocument	string	Ongeldig document.
InvalidDocumentBatch	string	Ongeldige documentbatch.
InvalidLocale	string	Ongeldige landinstelling.
InvalidLogDate	string	Ongeldige logboekdatum.
InvalidLogEndTime	string	Ongeldige eindtijd van logboek.
InvalidLogId	string	Ongeldige logboek-id.
InvalidLogStartTime	string	Ongeldige begintijd van logboek.
InvalidModel	string	Ongeldig model.
InvalidModelUri	string	Ongeldige model-URI.
InvalidParameter	string	Ongeldige parameter.
InvalidParameterValue	string	Ongeldige parameterwaarde.
InvalidPayload	string	Ongeldige nettolading.
InvalidPermissions	string	Ongeldige machtigingen.
InvalidPrerequisite	string	Ongeldige vereiste.
InvalidProductId	string	Ongeldige product-id.
InvalidProject	string	Ongeldig project.
InvalidProjectKind	string	Ongeldige projectsoort.
InvalidRecordingsUri	string	Ongeldige URI voor opnamen.
InvalidRequestBodyFormat	string	Ongeldige indeling van aanvraagbody.
InvalidSasValidityDuration	string	Ongeldige sas-geldigheidsduur.
InvalidSkipTokenForLogs	string	Ongeldig token voor het overslaan van logboeken.
InvalidSubscription	string	Ongeldig abonnement.
InvalidTest	string	Ongeldige test.
InvalidTimeToLive	string	Ongeldige time to live.
InvalidTopForLogs	string	Ongeldige bovenkant voor logboeken.
InvalidTranscription	string	Ongeldige transcriptie.
InvalidWebHookEventKind	string	Ongeldig soort webhook gebeurtenis.
MissingInputRecords	string	Ontbrekende invoerrecords.
ModelDeploymentNotCompleteState	string	De status modelimplementatie is niet voltooid.
ModelDeprecated	string	Het model is afgeschaft.
ModelExists	string	Het model bestaat.
ModelMismatch	string	Model komt niet overeen.
ModelNotDeployable	string	Model kan niet worden geïmplementeerd.
ModelVersionIncorrect	string	Modelversie onjuist.
NoUtf8WithBom	string	Geen utf8 met bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Slechts één van de URL's of container of gegevensset.
ProjectGenderMismatch	string	Het geslacht van het project komt niet overeen.
QuotaViolation	string	Quotumschending.
SingleDefaultEndpoint	string	Eén standaardeindpunt.
SkuLimitsExist	string	Er bestaan SKU-limieten.
SubscriptionNotFound	string	Kan het abonnement niet vinden.
UnexpectedError	string	Onverwachte fout.
UnsupportedClassBasedAdaptation	string	Niet-ondersteunde aanpassing op basis van klassen.
UnsupportedDelta	string	Niet-ondersteunde delta.
UnsupportedDynamicConfiguration	string	Niet-ondersteunde dynamische configuratie.
UnsupportedFilter	string	Niet-ondersteund filter.
UnsupportedLanguageCode	string	Niet-ondersteunde taalcode.
UnsupportedOrderBy	string	Niet-ondersteunde bestelling op.
UnsupportedPagination	string	Niet-ondersteunde paginering.
UnsupportedTimeRange	string	Niet-ondersteund tijdsbereik.

EntityError

Name	Type	Description
code	string	De code van deze fout.
message	string	Het bericht voor deze fout.

Error

Fout

Name	Type	Description
code	ErrorCode	ErrorCode Foutcodes op hoog niveau.
details	Error[]	Aanvullende ondersteunende informatie met betrekking tot de fout en/of het verwachte beleid.
innerError	InnerError	InnerError Nieuwe indeling voor interne fouten die voldoet aan de Api-richtlijnen voor Cognitive Services die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat de vereiste eigenschappen ErrorCode, bericht en optionele eigenschappen doel, details (sleutelwaardepaar), interne fout (dit kan worden genest).
message	string	Foutbericht op hoog niveau.
target	string	De bron van de fout. Dit is bijvoorbeeld 'documenten' of 'document-id' in het geval van een ongeldig document.

ErrorCode

Name	Type	Description
Conflict	string	Vertegenwoordigt de conflictfoutcode.
Forbidden	string	Vertegenwoordigt de verboden foutcode.
InternalCommunicationFailed	string	De foutcode voor de interne communicatie is mislukt.
InternalServerError	string	Vertegenwoordigt de foutcode van de interne serverfout.
InvalidArgument	string	Vertegenwoordigt de foutcode van het ongeldige argument.
InvalidRequest	string	Vertegenwoordigt de ongeldige aanvraagfoutcode.
NotAllowed	string	Vertegenwoordigt de niet-toegestane foutcode.
NotFound	string	Deze vertegenwoordigt de foutcode niet gevonden.
PipelineError	string	Vertegenwoordigt de foutcode van de pijplijnfout.
ServiceUnavailable	string	De foutcode voor de service is niet beschikbaar.
TooManyRequests	string	Vertegenwoordigt de foutcode voor te veel aanvragen.
Unauthorized	string	Vertegenwoordigt de foutcode voor onbevoegden.
UnprocessableEntity	string	Vertegenwoordigt de foutcode van de niet-verwerkbare entiteit.
UnsupportedMediaType	string	Vertegenwoordigt de foutcode van het niet-ondersteunde mediatype.

InnerError

Name	Type	Description
code	DetailedErrorCode	DetailedErrorCode Gedetailleerde foutcode- enum.
details	object	Aanvullende ondersteunende informatie met betrekking tot de fout en/of het verwachte beleid.
innerError	InnerError	InnerError Nieuwe indeling voor interne fouten die voldoet aan de Api-richtlijnen voor Cognitive Services die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat de vereiste eigenschappen ErrorCode, bericht en optionele eigenschappen doel, details (sleutelwaardepaar), interne fout (dit kan worden genest).
message	string	Foutbericht op hoog niveau.
target	string	De bron van de fout. Dit is bijvoorbeeld 'documenten' of 'document-id' in het geval van een ongeldig document.

Status

Name	Type	Description
Failed	string	De langdurige bewerking is mislukt.
NotStarted	string	De langdurige bewerking is nog niet gestart.
Running	string	De langdurige bewerking wordt momenteel verwerkt.
Succeeded	string	De langdurige bewerking is voltooid.

WebHook

Name	Type	Description
createdDateTime	string	De tijdstempel waarop het object is gemaakt. De tijdstempel is gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	De aangepaste eigenschappen van deze entiteit. De maximaal toegestane sleutellengte is 64 tekens, de maximaal toegestane waardelengte is 256 tekens en het aantal toegestane vermeldingen is 10.
description	string	De beschrijving van het object.
displayName	string	De weergavenaam van het object.
events	WebHookEvents	WebHookEvents
lastActionDateTime	string	Het tijdstempel waarop de huidige status is ingevoerd. De tijdstempel is gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	WebHookLinks	WebHookLinks
properties	WebHookProperties	WebHookProperties
self	string	De locatie van deze entiteit.
status	Status	Status De huidige status van de API beschrijven
webUrl	string	De geregistreerde URL waarnaar de POST-aanvragen voor de geregistreerde gebeurtenissen worden verzonden.

WebHookEvents

Name	Type	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

Name	Type	Description
ping	string	De URL die kan worden gebruikt om het verzenden van een ping-gebeurtenis naar de geregistreerde URL van een webhookregistratie te activeren. Zie bewerking 'WebHooks_Ping' voor meer informatie.
test	string	De URL die kan worden gebruikt om testevenementen te verzenden naar de geregistreerde URL van een webhookregistratie. Zie bewerking 'WebHooks_Test' voor meer informatie.

WebHookProperties

Name	Type	Description
apiVersion	string	De API-versie waarin de webhook is gemaakt. Hiermee definieert u de vorm van de nettolading in de callbacks. Als het type nettolading niet meer wordt ondersteund, omdat de shape is gewijzigd en de API-versie die deze gebruikt, wordt verwijderd (na afschaffing), wordt de webhook uitgeschakeld.
error	EntityError	EntityError
secret	string	Een geheim dat wordt gebruikt om een SHA256-hash van de nettolading te maken met het geheim als HMAC-sleutel. Deze hash wordt ingesteld als X-MicrosoftSpeechServices-Signature-header bij het terugroepen naar de geregistreerde URL.

WebHookPropertiesUpdate

Name	Type	Description
secret	string	Een geheim dat wordt gebruikt om een SHA256-hash van de nettolading te maken met het geheim als HMAC-sleutel. Deze hash wordt ingesteld als X-MicrosoftSpeechServices-Signature-header bij het terugroepen naar de geregistreerde URL.

WebHookUpdate

Name	Type	Description
customProperties	object	De aangepaste eigenschappen van deze entiteit. De maximaal toegestane sleutellengte is 64 tekens, de maximaal toegestane waardelengte is 256 tekens en het aantal toegestane vermeldingen is 10.
description	string	De beschrijving van het object.
displayName	string	De naam van het object.
events	WebHookEvents	WebHookEvents
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
webUrl	string	De geregistreerde URL waarnaar de POST-aanvragen voor de geregistreerde gebeurtenissen worden verzonden.

Delen via

Web Hooks - Update

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

Ocp-Apim-Subscription-Key

Authorization

Voorbeelden

Update a web hook

Sample Request

Sample Response

Definities

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

WebHookPropertiesUpdate

WebHookUpdate

Aanvullende resources