Update Hook - Update Hook

Tjänst:: Azure AI Services

API-version:: v3.0

Uppdaterar webbkroken som identifieras av det angivna ID:t.
Om egenskapshemligheten i konfigurationen utelämnas eller innehåller en tom sträng innehåller framtida återanrop inte X-MicrosoftSpeechServices-Signature rubriker. Om egenskapen innehåller en icke-tom sträng används den för att skapa en SHA256-hash för nyttolasten med hemligheten som HMAC-nyckel. Denna hash anges som X-MicrosoftSpeechServices-Signature rubrik när du anropar tillbaka till den registrerade URL:en.

Om URL:en ändras slutar webbkroken att ta emot händelser tills en utmaning/ett svar har slutförts. För att göra detta görs en begäran med händelsetypsutmaningen med en frågeparameter som kallas validationToken. Svara på utmaningen med en 200 OK som innehåller värdet för frågeparametern validationToken som svarstext. När utmaningen/svaret har slutförts börjar webbkroken ta emot händelser.

PATCH {Endpoint}/speechtotext/v3.0/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.

Begärandetext

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

Name	Typ	Description
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	Namnet på objektet.
events	WebHookEvents	WebHookEvents
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
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.

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

Update a web hook

Exempelbegäran

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"
  }
}

Exempelsvar

Statuskod:: 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"
}

Definitioner

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

DetailedErrorCode

Uppräkning

DetailedErrorCode

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

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

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
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.
Failed	Den tidskrävande åtgärden misslyckades.

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

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.

WebHookPropertiesUpdate

Objekt

WebHookPropertiesUpdate

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

WebHookUpdate

Objekt

WebHookUpdate

Name	Typ	Description
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	Namnet på objektet.
events	WebHookEvents	WebHookEvents
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
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.

Dela via

Update Hook - Update Hook

URI-parametrar

Begärandetext

Svar

Säkerhet

Ocp-Apim-Subscription-Key

Authorization

Exempel

Update a web hook

Exempelbegäran

Exempelsvar

Definitioner

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

WebHookPropertiesUpdate

WebHookUpdate