Analyze Documents Cancel Job - Analyze Documents Cancel Job

Servizio:

Azure AI Services

Versione API:

2026-05-01

Annulla un processo di analisi del testo a esecuzione prolungata.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
Endpoint	path	True	string	Endpoint di Servizi cognitivi supportato, ad esempio https://< nome-risorsa.api.cognitiveservices.azure.com>).
jobId	path	True	string (uuid)	ID processo da annullare.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
202 Accepted		La richiesta è stata accettata per l'elaborazione, ma l'elaborazione non è ancora stata completata. Intestazioni Operation-Location: string
Other Status Codes	ErrorResponse	Risposta di errore imprevista. Intestazioni x-ms-error-code: string

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

OAuth2Auth

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize
URL token: https://login.microsoftonline.com/common/oauth2/token

Ambiti

Nome	Descrizione
https://cognitiveservices.azure.com/.default

Esempio

SuccessfulAnalyzeDocumentsJobsCancelRequest

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

202

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

Definizioni

Nome	Descrizione
Error	L'oggetto risposta all'errore viene restituito quando il servizio rileva alcuni errori durante l'elaborazione della richiesta.
ErrorCode	Codice di errore leggibile.
ErrorResponse	Risposta di errore.
InnerErrorCode	Codice di errore leggibile.
InnerErrorModel	Oggetto contenente informazioni più specifiche sull'errore. Secondo le linee guida API di Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Error

Oggetto

L'oggetto risposta all'errore viene restituito quando il servizio rileva alcuni errori durante l'elaborazione della richiesta.

Nome	Tipo	Descrizione
code	ErrorCode	Uno di un set definito dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorCode

Enumerazione

Codice di errore leggibile.

Valore	Descrizione
InvalidRequest	Errore di richiesta non valido
InvalidArgument	Errore di argomento non valido
Unauthorized	Errore di accesso non autorizzato
Forbidden	Errore di accesso negato
NotFound	Errore non trovato
ProjectNotFound	Project non trovato errore
OperationNotFound	Errore di operazione non trovata
AzureCognitiveSearchNotFound	Ricerca cognitiva di Azure errore non trovato
AzureCognitiveSearchIndexNotFound	Ricerca cognitiva di Azure Index errore non trovato
TooManyRequests	Errore di troppe richieste
AzureCognitiveSearchThrottling	Ricerca cognitiva di Azure throttling error
AzureCognitiveSearchIndexLimitReached	Ricerca cognitiva di Azure limite di errore raggiunto
InternalServerError	Errore interno del server
ServiceUnavailable	Errore di servizio non disponibile
Timeout	Errore di timeout
QuotaExceeded	Errore di superamento della quota
Conflict	Errore di conflitto
Warning	Errore di avviso

ErrorResponse

Oggetto

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

InnerErrorCode

Enumerazione

Codice di errore leggibile.

Valore	Descrizione
InvalidRequest	Errore di richiesta non valido
InvalidParameterValue	Errore del valore del parametro non valido
KnowledgeBaseNotFound	Errore della Knowledge Base non trovato
AzureCognitiveSearchNotFound	Ricerca cognitiva di Azure errore non trovato
AzureCognitiveSearchThrottling	Ricerca cognitiva di Azure throttling error
ExtractionFailure	Errore di estrazione
InvalidRequestBodyFormat	Errore di formato del corpo della richiesta non valido
EmptyRequest	Errore di richiesta vuota
MissingInputDocuments	Errore dei documenti di input mancanti
InvalidDocument	Errore del documento non valido
ModelVersionIncorrect	Errore di versione del modello non corretto
InvalidDocumentBatch	Errore del batch di documenti non valido
UnsupportedLanguageCode	Errore di codice della lingua non supportato
InvalidCountryHint	Errore di hint paese non valido

InnerErrorModel

Oggetto

Oggetto contenente informazioni più specifiche sull'errore. Secondo le linee guida API di Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Descrizione
code	InnerErrorCode	Uno di un set definito dal server di codici di errore.
details	object	Dettagli dell'errore.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Messaggio di errore.
target	string	Destinazione errore.