Analyze Documents Cancel Job - Analyze Documents Cancel Job

Dienst:

Azure AI Services

API-Version:

2024-11-15-preview

Abbrechen eines lang ausgeführten Textanalyseauftrags.

POST {Endpoint}/language/analyze-documents/jobs/{jobId}:cancel?api-version=2024-11-15-preview

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string	Unterstützter Cognitive Services-Endpunkt (z. B. https://< resource-name.api.cognitiveservices.azure.com>).
jobId	path	True	string (uuid)	Die auftrags-ID, die abgebrochen werden soll.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
202 Accepted		Die Anforderung wurde zur Verarbeitung angenommen, die Verarbeitung ist jedoch noch nicht abgeschlossen. Header Operation-Location: string
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

Name	Beschreibung
https://cognitiveservices.azure.com/.default

Beispiele

SuccessfulAnalyzeDocumentsJobsCancelRequest

Beispielanforderung

HTTP

POST {Endpoint}/language/analyze-documents/jobs/c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18:cancel?api-version=2024-11-15-preview

Beispiel für eine Antwort

Statuscode:

202

Operation-Location: {Endpoint}/language/analyze-documents/jobs/{jobId}?api-version=2024-11-15-preview

Definitionen

Name	Beschreibung
Error	Das Fehlerantwortobjekt, das zurückgegeben wird, wenn der Dienst während der Verarbeitung der Anforderung auf Fehler stößt.
ErrorCode	Lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
InnerErrorCode	Lesbarer Fehlercode.
InnerErrorModel	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Error

Objekt

Das Fehlerantwortobjekt, das zurückgegeben wird, wenn der Dienst während der Verarbeitung der Anforderung auf Fehler stößt.

Name	Typ	Beschreibung
code	ErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorCode

Enumeration

Lesbarer Fehlercode.

Wert	Beschreibung
InvalidRequest	Ungültiger Anforderungsfehler
InvalidArgument	Ungültiger Argumentfehler
Unauthorized	Fehler beim nicht autorisierten Zugriff
Forbidden	Fehler beim unzulässigen Zugriff
NotFound	Fehler nicht gefunden
ProjectNotFound	Fehler beim Fehler "Projekt nicht gefunden"
OperationNotFound	Fehler beim Vorgang nicht gefunden
AzureCognitiveSearchNotFound	Fehler bei Azure Cognitive Search nicht gefunden
AzureCognitiveSearchIndexNotFound	Der Azure Cognitive Search-Index wurde nicht gefunden
TooManyRequests	Fehler bei zu vielen Anforderungen
AzureCognitiveSearchThrottling	Fehler bei der Drosselung von Azure Cognitive Search
AzureCognitiveSearchIndexLimitReached	Azure Cognitive Search Index limit reached error
InternalServerError	Interner Serverfehler
ServiceUnavailable	Fehler "Dienst nicht verfügbar"
Timeout	Timeout-Fehler
QuotaExceeded	Fehler "Kontingent überschritten"
Conflict	Konfliktfehler
Warning	Warnungsfehler

ErrorResponse

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InnerErrorCode

Enumeration

Lesbarer Fehlercode.

Wert	Beschreibung
InvalidRequest	Ungültiger Anforderungsfehler
InvalidParameterValue	Ungültiger Parameterwertfehler
KnowledgeBaseNotFound	Fehler in der Knowledge Base nicht gefunden
AzureCognitiveSearchNotFound	Fehler bei Azure Cognitive Search nicht gefunden
AzureCognitiveSearchThrottling	Fehler bei der Drosselung von Azure Cognitive Search
ExtractionFailure	Fehler bei Extraktionsfehlern
InvalidRequestBodyFormat	Ungültiger Fehler beim Anforderungstextformat
EmptyRequest	Fehler "Leere Anforderung"
MissingInputDocuments	Fehler bei fehlenden Eingabedokumenten
InvalidDocument	Ungültiger Dokumentfehler
ModelVersionIncorrect	Fehler bei der Modellversion
InvalidDocumentBatch	Ungültiger Dokumentbatchfehler
UnsupportedLanguageCode	Fehler beim nicht unterstützten Sprachcode
InvalidCountryHint	Ungültiger Fehler im Landhinweis

InnerErrorModel

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
code	InnerErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	object	Fehlerdetails.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Fehlermeldung.
target	string	Fehlerziel.