Update Hook - Update Hook

Service:: Azure AI Services

API-versie:: v3.0

Hiermee wordt de webhook bijgewerkt die is 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 gebeurtenistype-uitdaging gedaan met een queryparameter met de naam validationToken. Reageer op de uitdaging met een 200 OK met de waarde van de parameter validationToken-query als antwoordtekst. Wanneer de uitdaging/het antwoord is voltooid, ontvangt de webhook gebeurtenissen.

PATCH {Endpoint}/speechtotext/v3.0/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 maximale 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 (uri)	De geregistreerde URL die wordt gebruikt om de POST-aanvragen voor de geregistreerde gebeurtenissen naar te verzenden.

Antwoorden

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

Name

Type

Description

200 OK

WebHook

Kopteksten

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 querytekenreeks toe te voegen aan de STS-URL: ?scope=speechservicesmanagement

Type: apiKey
In: header

Voorbeelden

Update a web hook

Voorbeeldaanvraag

HTTP

PATCH https://westus.api.cognitive.microsoft.com//speechtotext/v3.0/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"
  }
}

Voorbeeldrespons

Statuscode:: 200

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

DetailedErrorCode

Inventarisatie

DetailedErrorCode

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

EntityError

Object

EntityError

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

Error

Object

Fout

Name	Type	Description
code	ErrorCode	ErrorCode Foutcodes op hoog niveau.
details	Error[]	Aanvullende ondersteunende informatie over de fout en/of het verwachte beleid.
innerError	InnerError	InnerError Nieuwe indeling voor interne fouten die voldoet aan de Richtlijnen voor de Cognitive Services-API die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat vereiste eigenschappen ErrorCode, bericht en optionele eigenschappendoel, 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

Inventarisatie

ErrorCode

Waarde	Description
InvalidRequest	De foutcode van de ongeldige aanvraag vertegenwoordigt.
InvalidArgument	De foutcode van het ongeldige argument vertegenwoordigt.
InternalServerError	De foutcode van de interne server vertegenwoordigt.
ServiceUnavailable	Vertegenwoordiging van de service niet-beschikbare foutcode.
NotFound	De foutcode wordt niet gevonden.
PipelineError	De foutcode van de pijplijnfout weergeven.
Conflict	Vertegenwoordiging van de conflictfoutcode.
InternalCommunicationFailed	De foutcode voor de interne communicatie is mislukt.
Forbidden	Vertegenwoordiging van de verboden foutcode.
NotAllowed	Vertegenwoordiging van de niet-toegestane foutcode.
Unauthorized	Vertegenwoordiging van de niet-geautoriseerde foutcode.
UnsupportedMediaType	De foutcode van het niet-ondersteunde mediatype vertegenwoordigt.
TooManyRequests	De foutcode voor te veel aanvragen vertegenwoordigt.
UnprocessableEntity	De foutcode van de niet-verwerkte entiteit vertegenwoordigt.

InnerError

Object

InnerError

Name	Type	Description
code	DetailedErrorCode	DetailedErrorCode Gedetailleerde opsomming van foutcodes.
details	object	Aanvullende ondersteunende informatie over de fout en/of het verwachte beleid.
innerError	InnerError	InnerError Nieuwe indeling voor interne fouten die voldoet aan de Richtlijnen voor de Cognitive Services-API die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat vereiste eigenschappen ErrorCode, bericht en optionele eigenschappendoel, 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

Inventarisatie

Toestand

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

WebHook

Object

WebHook

Name	Type	Description
createdDateTime	string (date-time)	Het tijdstempel waarop het object is gemaakt. De tijdstempel wordt 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 maximale 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 (date-time)	Het tijdstempel waarop de huidige status is ingevoerd. De tijdstempel wordt 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 (uri)	De locatie van deze entiteit.
status	Status	Toestand De huidige status van de API beschrijven
webUrl	string (uri)	De geregistreerde URL die wordt gebruikt om de POST-aanvragen voor de geregistreerde gebeurtenissen naar te verzenden.

WebHookEvents

Object

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

Object

WebHookLinks

Name	Type	Description
ping	string (uri)	De URL die kan worden gebruikt om het verzenden van een ping-gebeurtenis te activeren naar de geregistreerde URL van een webhookregistratie.
test	string (uri)	De URL die kan worden gebruikt voor het verzenden van test gebeurtenissen naar de geregistreerde URL van een webhookregistratie.

WebHookProperties

Object

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 payloadtype 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 voor het maken van een SHA256-hash van de nettolading met het geheim als HMAC-sleutel. Deze hash wordt ingesteld als X-MicrosoftSpeechServices-Signature header bij het terugroepen naar de geregistreerde URL.

WebHookPropertiesUpdate

Object

WebHookPropertiesUpdate

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

WebHookUpdate

Object

WebHookUpdate

Name	Type	Description
customProperties	object	De aangepaste eigenschappen van deze entiteit. De maximaal toegestane sleutellengte is 64 tekens, de maximale 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 (uri)	De geregistreerde URL die wordt gebruikt om de POST-aanvragen voor de geregistreerde gebeurtenissen naar te verzenden.

Delen via

Update Hook - Update Hook

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

Ocp-Apim-Subscription-Key

Authorization

Voorbeelden

Update a web hook

Voorbeeldaanvraag

Voorbeeldrespons

Definities

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

WebHookPropertiesUpdate

WebHookUpdate