Web Hooks - Update

Referenz

Dienst:: Azure AI Services

API-Version:: v3.2-preview.2

Updates den Webhook, der durch die angegebene ID identifiziert wird.
Wenn das Eigenschaftsgeheimnis in der Konfiguration weggelassen wird oder eine leere Zeichenfolge enthält, enthalten zukünftige Rückrufe keine X-MicrosoftSpeechServices-Signature-Header. Wenn die Eigenschaft eine nicht leere Zeichenfolge enthält, wird sie verwendet, um einen SHA256-Hash der Nutzlast mit dem Geheimnis als HMAC-Schlüssel zu erstellen. Dieser Hash wird als X-MicrosoftSpeechServices-Signature-Header festgelegt, wenn sie in die registrierte URL zurückgerufen wird.

Wenn sich die URL ändert, empfängt der Webhook nicht mehr Ereignisse, bis eine Anforderung/Antwort abgeschlossen ist. Dazu wird eine Anforderung mit der Ereignistypherausforderung mit einem Abfrageparameter namens validationToken gestellt. Reagieren Sie auf die Herausforderung mit einem Ok 200, der den Wert des validationToken-Abfrageparameters als Antworttext enthält. Wenn die Herausforderung/Antwort erfolgreich abgeschlossen wurde, empfängt der Webhook Ereignisse.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://westus.api.cognitive.microsoft.com
id	path	True	string uuid	Der Bezeichner des Webhooks.

Anforderungstext

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

Name	Typ	Beschreibung
customProperties	object	Die benutzerdefinierten Eigenschaften dieser Entität. Die maximal zulässige Schlüssellänge beträgt 64 Zeichen, die maximal zulässige Wertlänge beträgt 256 Zeichen und die Anzahl der zulässigen Einträge beträgt 10.
description	string	Die Beschreibung des -Objekts.
displayName	string	Der Name des Objekts.
events	WebHookEvents	WebHookEvents
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
webUrl	string	Die registrierte URL, die zum Senden der POST-Anforderungen für die registrierten Ereignisse verwendet wird.

Antworten

Name	Typ	Beschreibung
200 OK	WebHook	OK Header Retry-After: integer
Other Status Codes	Error	Ein Fehler ist aufgetreten.

Name

Typ

Beschreibung

200 OK

WebHook

Header

Retry-After: integer

Other Status Codes

Error

Ein Fehler ist aufgetreten.

Sicherheit

Ocp-Apim-Subscription-Key

Geben Sie hier Ihren Cognitive Services-Kontoschlüssel an.

Typ: apiKey
In: header

Authorization

Stellen Sie ein Zugriffstoken aus dem JWT bereit, das vom STS dieser Region zurückgegeben wird. Stellen Sie sicher, dass Sie dem Token den Verwaltungsbereich hinzufügen, indem Sie der STS-URL die folgende Abfragezeichenfolge hinzufügen: ?scope=speechservicesmanagement

Typ: apiKey
In: header

Beispiele

Update a web hook

Beispielanforderung

HTTP

PATCH {endpoint}/speechtotext/v3.2-preview.2/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"
  }
}

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
Error	Fehler
ErrorCode	ErrorCode
InnerError	InnerError
Status	Status
WebHook	WebHook
WebHookEvents	WebHookEvents
WebHookLinks	WebHookLinks
WebHookProperties	WebHookProperties
WebHookPropertiesUpdate	WebHookPropertiesUpdate
WebHookUpdate	WebHookUpdate

DetailedErrorCode

Name	Typ	Beschreibung
DataImportFailed	string	Fehler beim Datenimport.
DeleteNotAllowed	string	Löschen nicht zulässig.
DeployNotAllowed	string	Bereitstellen ist nicht zulässig.
DeployingFailedModel	string	Bereitstellen eines fehlerhaften Modells.
EmptyRequest	string	Leere Anforderung.
EndpointCannotBeDefault	string	Der Endpunkt kann nicht standardmäßig sein.
EndpointNotUpdatable	string	Endpunkt nicht aktualisierbar.
EndpointWithoutLogging	string	Endpunkt ohne Protokollierung.
ExceededNumberOfRecordingsUris	string	Die Anzahl der Aufzeichnungs-URIs wurde überschritten.
FailedDataset	string	Fehlgeschlagenes Dataset.
Forbidden	string	Unzulässig.
InUseViolation	string	Bei verwendungsverstößen.
InaccessibleCustomerStorage	string	Auf den Kundenspeicher kann nicht zugegriffen werden.
InvalidAdaptationMapping	string	Ungültige Anpassungszuordnung.
InvalidBaseModel	string	Ungültiges Basismodell.
InvalidCallbackUri	string	Ungültiger Rückruf-URI.
InvalidCollection	string	Ungültige Auflistung.
InvalidDataset	string	Ungültiges Dataset.
InvalidDocument	string	Ungültiges Dokument.
InvalidDocumentBatch	string	Ungültiger Dokumentbatch.
InvalidLocale	string	Ungültiges Gebietsschema.
InvalidLogDate	string	Ungültiges Protokolldatum.
InvalidLogEndTime	string	Ungültige Protokollendzeit.
InvalidLogId	string	Ungültige Protokoll-ID.
InvalidLogStartTime	string	Ungültige Protokollstartzeit.
InvalidModel	string	Ungültiges Modell.
InvalidModelUri	string	Ungültiger Modell-URI.
InvalidParameter	string	Ungültiger Parameter.
InvalidParameterValue	string	Ungültiger Parameterwert.
InvalidPayload	string	Ungültige Nutzlast.
InvalidPermissions	string	Ungültige Berechtigungen.
InvalidPrerequisite	string	Ungültige Voraussetzung.
InvalidProductId	string	Ungültige Produkt-ID.
InvalidProject	string	Ungültiges Projekt.
InvalidProjectKind	string	Ungültige Projektart.
InvalidRecordingsUri	string	Ungültiger Aufzeichnungs-URI.
InvalidRequestBodyFormat	string	Ungültiges Anforderungstextformat.
InvalidSasValidityDuration	string	Ungültige SAS-Gültigkeitsdauer.
InvalidSkipTokenForLogs	string	Ungültiges Überspringen des Tokens für Protokolle.
InvalidSourceAzureResourceId	string	Ungültige Azure-Quellressourcen-ID.
InvalidSubscription	string	Ungültiges Abonnement.
InvalidTest	string	Ungültiger Test.
InvalidTimeToLive	string	Ungültige Gültigkeitsdauer.
InvalidTopForLogs	string	Ungültiger Anfang für Protokolle.
InvalidTranscription	string	Ungültige Transkription.
InvalidWebHookEventKind	string	Ungültige Webhookereignisart.
MissingInputRecords	string	Fehlende Eingabedatensätze.
ModelCopyOperationExists	string	Modellkopiervorgang ist vorhanden.
ModelDeploymentNotCompleteState	string	Der Status der Modellbereitstellung ist nicht abgeschlossen.
ModelDeprecated	string	Das Modell ist veraltet.
ModelExists	string	Das Modell ist vorhanden.
ModelMismatch	string	Modellkonflikt.
ModelNotDeployable	string	Das Modell kann nicht bereitgestellt werden.
ModelVersionIncorrect	string	Modellversion falsch.
NoUtf8WithBom	string	Kein utf8 mit bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Nur eine der URLs, container oder datasets.
ProjectGenderMismatch	string	Projizieren von Geschlechtskonflikten.
QuotaViolation	string	Kontingentverletzung.
SingleDefaultEndpoint	string	Einzelner Standardendpunkt.
SkuLimitsExist	string	SKU-Grenzwerte sind vorhanden.
SubscriptionNotFound	string	Das Abonnement wurde nicht gefunden.
UnexpectedError	string	Unerwarteter Fehler.
UnsupportedClassBasedAdaptation	string	Nicht unterstützte klassenbasierte Anpassung.
UnsupportedDelta	string	Nicht unterstütztes Delta.
UnsupportedDynamicConfiguration	string	Nicht unterstützte dynamische Konfiguration.
UnsupportedFilter	string	Nicht unterstützter Filter.
UnsupportedLanguageCode	string	Nicht unterstützter Sprachcode.
UnsupportedOrderBy	string	Nicht unterstützte Reihenfolge nach.
UnsupportedPagination	string	Nicht unterstützte Paginierung.
UnsupportedTimeRange	string	Nicht unterstützter Zeitbereich.

EntityError

Name	Typ	Beschreibung
code	string	Der Code dieses Fehlers.
message	string	Die Meldung für diesen Fehler.

Error

Fehler

Name	Typ	Beschreibung
code	ErrorCode	ErrorCode Allgemeine Fehlercodes.
details	Error[]	Zusätzliche unterstützende Details zum Fehler und/oder zu den erwarteten Richtlinien.
innerError	InnerError	InnerError Neues Format für innere Fehler, das den Cognitive Services-API-Richtlinien entspricht, die unter https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owverfügbar sind. Enthält die erforderlichen Eigenschaften ErrorCode, Message und Optional Properties Target, Details (Key Value Pair), Inner Error (kann geschachtelt werden).
message	string	Allgemeine Fehlermeldung.
target	string	Die Ursache des Fehlers. Dies wäre z. B. „Dokumente“ oder „Dokument-ID“ im Falle eines ungültigen Dokuments.

ErrorCode

Name	Typ	Beschreibung
Conflict	string	Stellt den Konfliktfehlercode dar.
Forbidden	string	Stellt den unzulässigen Fehlercode dar.
InternalCommunicationFailed	string	Stellt den Fehlercode für interne Kommunikationsfehler dar.
InternalServerError	string	Stellt den Fehlercode des internen Servers dar.
InvalidArgument	string	Stellt den Fehlercode des ungültigen Arguments dar.
InvalidRequest	string	Stellt den ungültigen Anforderungsfehlercode dar.
NotAllowed	string	Stellt den nicht zulässigen Fehlercode dar.
NotFound	string	Stellt den Fehlercode nicht gefunden dar.
PipelineError	string	Stellt den Fehlercode für die Pipeline dar.
ServiceUnavailable	string	Stellt den Nicht verfügbaren Fehlercode des Diensts dar.
TooManyRequests	string	Stellt den Fehlercode für zu viele Anforderungen dar.
Unauthorized	string	Stellt den nicht autorisierten Fehlercode dar.
UnprocessableEntity	string	Stellt den Fehlercode für nicht bearbeitbare Entitäten dar.
UnsupportedMediaType	string	Stellt den fehlercode für den nicht unterstützten Medientyp dar.

InnerError

Name	Typ	Beschreibung
code	DetailedErrorCode	DetailedErrorCode Detaillierte Fehlercodeenume.
details	object	Zusätzliche unterstützende Details zum Fehler und/oder zu den erwarteten Richtlinien.
innerError	InnerError	InnerError Neues Format für innere Fehler, das den Cognitive Services-API-Richtlinien entspricht, die unter https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owverfügbar sind. Enthält die erforderlichen Eigenschaften ErrorCode, Message und Optional Properties Target, Details (Key Value Pair), Inner Error (kann geschachtelt werden).
message	string	Allgemeine Fehlermeldung.
target	string	Die Ursache des Fehlers. Dies wäre z. B. „Dokumente“ oder „Dokument-ID“ im Falle eines ungültigen Dokuments.

Status

Name	Typ	Beschreibung
Failed	string	Der Vorgang mit langer Ausführungsdauer ist fehlgeschlagen.
NotStarted	string	Der lang andauernde Vorgang wurde noch nicht gestartet.
Running	string	Der Vorgang mit langer Ausführungszeit wird derzeit verarbeitet.
Succeeded	string	Der lang andauernde Vorgang wurde erfolgreich abgeschlossen.

WebHook

Name	Typ	Beschreibung
createdDateTime	string	Der Zeitstempel, zu dem das Objekt erstellt wurde. Der Zeitstempel ist als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-TTThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	Die benutzerdefinierten Eigenschaften dieser Entität. Die maximal zulässige Schlüssellänge beträgt 64 Zeichen, die maximal zulässige Wertlänge beträgt 256 Zeichen und die Anzahl der zulässigen Einträge beträgt 10.
description	string	Die Beschreibung des -Objekts.
displayName	string	Der Anzeigename des Objekts.
events	WebHookEvents	WebHookEvents
lastActionDateTime	string	Der Zeitstempel, bei dem der aktuelle status eingegeben wurde. Der Zeitstempel ist als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-TTThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	WebHookLinks	WebHookLinks
properties	WebHookProperties	WebHookProperties
self	string	Der Speicherort dieser Entität.
status	Status	Status Beschreiben des aktuellen Zustands der API
webUrl	string	Die registrierte URL, die zum Senden der POST-Anforderungen für die registrierten Ereignisse verwendet wird.

WebHookEvents

Name	Typ	Beschreibung
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	Typ	Beschreibung
ping	string	Die URL, die verwendet werden kann, um das Senden eines Pingereignisses an die registrierte URL einer Webhookregistrierung auszulösen. Weitere Informationen finden Sie unter Vorgang "WebHooks_Ping".
test	string	Die URL, die verwendet werden kann, um Testereignisse an die registrierte URL einer Webhookregistrierung zu senden. Weitere Informationen finden Sie unter Vorgang "WebHooks_Test".

WebHookProperties

Name	Typ	Beschreibung
apiVersion	string	Die API-Version, in der der Webhook erstellt wurde. Dadurch wird die Form der Nutzlast in den Rückrufen definiert. Wenn der Nutzlasttyp nicht mehr unterstützt wird, weil sich die Form geändert hat und die API-Version, die sie verwendet, entfernt wird (nach der Einstellung), wird der Webhook deaktiviert.
error	EntityError	EntityError
secret	string	Ein Geheimnis, das verwendet wird, um einen SHA256-Hash der Nutzlast mit dem Geheimnis als HMAC-Schlüssel zu erstellen. Dieser Hash wird als X-MicrosoftSpeechServices-Signature-Header festgelegt, wenn sie in die registrierte URL zurückgerufen wird.

WebHookPropertiesUpdate

Name	Typ	Beschreibung
secret	string	Ein Geheimnis, das verwendet wird, um einen SHA256-Hash der Nutzlast mit dem Geheimnis als HMAC-Schlüssel zu erstellen. Dieser Hash wird als X-MicrosoftSpeechServices-Signature-Header festgelegt, wenn sie in die registrierte URL zurückgerufen wird.

WebHookUpdate

Name	Typ	Beschreibung
customProperties	object	Die benutzerdefinierten Eigenschaften dieser Entität. Die maximal zulässige Schlüssellänge beträgt 64 Zeichen, die maximal zulässige Wertlänge beträgt 256 Zeichen und die Anzahl der zulässigen Einträge beträgt 10.
description	string	Die Beschreibung des -Objekts.
displayName	string	Der Name des Objekts.
events	WebHookEvents	WebHookEvents
properties	WebHookPropertiesUpdate	WebHookPropertiesUpdate
webUrl	string	Die registrierte URL, die zum Senden der POST-Anforderungen für die registrierten Ereignisse verwendet wird.

Freigeben über

Web Hooks - Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

Authorization

Beispiele

Update a web hook

Beispielanforderung

Beispiel für eine Antwort

Definitionen

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

WebHookPropertiesUpdate

WebHookUpdate

Zusätzliche Ressourcen