Analyze Documents Cancel Job - Analyze Documents Cancel Job

Service:

Azure AI Services

Version d'API:

2026-05-01

Annule un travail d’analyse de texte de longue durée.

POST {Endpoint}/language/analyze-documents/jobs/{jobId}:cancel?api-version=2026-05-01

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
Endpoint	path	True	string	Point de terminaison Cognitive Services pris en charge (par exemple, https://< nom-ressource.api.cognitiveservices.azure.com>).
jobId	path	True	string (uuid)	ID de travail à annuler.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Réponses

Nom	Type	Description
202 Accepted		La demande a été acceptée pour traitement, mais le traitement n’a pas encore été terminé. En-têtes Operation-Location: string
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: accessCode
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize
URL du jeton: https://login.microsoftonline.com/common/oauth2/token

Étendues

Nom	Description
https://cognitiveservices.azure.com/.default

Exemples

SuccessfulAnalyzeDocumentsJobsCancelRequest

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:

202

Operation-Location: {Endpoint}/language/analyze-documents/jobs/{jobId}?api-version=2026-05-01

Définitions

Nom	Description
Error	L’objet de réponse d’erreur renvoyé lorsque le service rencontre des erreurs lors du traitement de la demande.
ErrorCode	Code d’erreur lisible par l’homme.
ErrorResponse	Réponse d’erreur.
InnerErrorCode	Code d’erreur lisible par l’homme.
InnerErrorModel	Objet contenant des informations plus spécifiques sur l’erreur. Selon les directives de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Error

Objet

L’objet de réponse d’erreur renvoyé lorsque le service rencontre des erreurs lors du traitement de la demande.

Nom	Type	Description
code	ErrorCode	Un ensemble de codes d’erreur définis par le serveur.
details	Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	InnerErrorModel	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

ErrorCode

Énumération

Code d’erreur lisible par l’homme.

Valeur	Description
InvalidRequest	Erreur de requête non valide
InvalidArgument	Erreur d’argument non valide
Unauthorized	Erreur d’accès non autorisé
Forbidden	Erreur d’accès interdit
NotFound	Erreur introuvable
ProjectNotFound	Erreur Project non trouvée
OperationNotFound	Erreur d’opération introuvable
AzureCognitiveSearchNotFound	Recherche cognitive Azure erreur not found
AzureCognitiveSearchIndexNotFound	Recherche cognitive Azure index erreur not found
TooManyRequests	Trop d’erreurs de requêtes
AzureCognitiveSearchThrottling	Recherche cognitive Azure throttling error
AzureCognitiveSearchIndexLimitReached	Recherche cognitive Azure index limite reached error
InternalServerError	Erreur interne du serveur
ServiceUnavailable	Erreur d’indisponibilité du service
Timeout	Erreur de temporisation
QuotaExceeded	Erreur de dépassement du quota
Conflict	Erreur de conflit
Warning	Erreur d’avertissement

ErrorResponse

Objet

Réponse d’erreur.

Nom	Type	Description
error	Error	Objet d’erreur.

InnerErrorCode

Énumération

Code d’erreur lisible par l’homme.

Valeur	Description
InvalidRequest	Erreur de requête non valide
InvalidParameterValue	Erreur de valeur de paramètre non valide
KnowledgeBaseNotFound	Erreur introuvable dans la base de connaissances
AzureCognitiveSearchNotFound	Recherche cognitive Azure erreur not found
AzureCognitiveSearchThrottling	Recherche cognitive Azure throttling error
ExtractionFailure	Erreur d’échec d’extraction
InvalidRequestBodyFormat	Erreur de format du corps de la demande non valide
EmptyRequest	Erreur de requête vide
MissingInputDocuments	Erreur des documents d’entrée manquants
InvalidDocument	Erreur de document non valide
ModelVersionIncorrect	Erreur incorrecte de version du modèle
InvalidDocumentBatch	Erreur de lot de documents non valide
UnsupportedLanguageCode	Erreur de code de langue non prise en charge
InvalidCountryHint	Erreur d’indicateur de pays non valide

InnerErrorModel

Objet

Objet contenant des informations plus spécifiques sur l’erreur. Selon les directives de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nom	Type	Description
code	InnerErrorCode	Un ensemble de codes d’erreur définis par le serveur.
details	object	Détails de l’erreur.
innererror	InnerErrorModel	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.