Analyze Documents Cancel Job - Analyze Documents Cancel Job

Služba:

Azure AI Services

Verze rozhraní API:

2024-11-15-preview

Zruší dlouhotrvající úlohu analýzy textu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string	Podporovaný koncový bod služeb Cognitive Services (např. https://< resource-name.api.cognitiveservices.azure.com>).
jobId	path	True	string (uuid)	ID úlohy, které chcete zrušit.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
202 Accepted		Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno. Hlavičky Operation-Location: string
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: accessCode
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize
URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Rozsahy

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

Příklady

SuccessfulAnalyzeDocumentsJobsCancelRequest

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:

202

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

Definice

Name	Description
Error	Objekt chybové odpovědi vrácený, když služba během zpracování požadavku narazí na nějaké chyby.
ErrorCode	Kód chyby čitelné člověkem
ErrorResponse	Chybová odpověď.
InnerErrorCode	Kód chyby čitelné člověkem
InnerErrorModel	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Error

Objekt

Objekt chybové odpovědi vrácený, když služba během zpracování požadavku narazí na nějaké chyby.

Name	Typ	Description
code	ErrorCode	Jedna ze serverově definovaných kódů chyb.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

ErrorCode

Výčet

Kód chyby čitelné člověkem

Hodnota	Description
InvalidRequest	Chyba neplatné žádosti
InvalidArgument	Chyba neplatného argumentu
Unauthorized	Chyba neoprávněného přístupu
Forbidden	Chyba zakázaného přístupu
NotFound	Chyba nenalezena
ProjectNotFound	Chyba projektu nebyla nalezena.
OperationNotFound	Chyba operace nebyla nalezena.
AzureCognitiveSearchNotFound	Chyba nenalezena službou Azure Cognitive Search
AzureCognitiveSearchIndexNotFound	Chyba indexu služby Azure Cognitive Search nebyla nalezena.
TooManyRequests	Chyba příliš mnoho požadavků
AzureCognitiveSearchThrottling	Chyba omezování služby Azure Cognitive Search
AzureCognitiveSearchIndexLimitReached	Došlo k chybě dosažení limitu indexu služby Azure Cognitive Search
InternalServerError	Vnitřní chyba serveru
ServiceUnavailable	Chyba nedostupnosti služby
Timeout	Chyba časového limitu
QuotaExceeded	Chyba překročení kvóty
Conflict	Chyba konfliktu
Warning	Chyba upozornění

ErrorResponse

Objekt

Chybová odpověď.

Name	Typ	Description
error	Error	Objekt chyby.

InnerErrorCode

Výčet

Kód chyby čitelné člověkem

Hodnota	Description
InvalidRequest	Chyba neplatné žádosti
InvalidParameterValue	Chyba neplatné hodnoty parametru
KnowledgeBaseNotFound	Chyba nenalezena znalostní báze
AzureCognitiveSearchNotFound	Chyba nenalezena službou Azure Cognitive Search
AzureCognitiveSearchThrottling	Chyba omezování služby Azure Cognitive Search
ExtractionFailure	Chyba selhání extrakce
InvalidRequestBodyFormat	Chyba neplatného formátu textu požadavku
EmptyRequest	Chyba prázdného požadavku
MissingInputDocuments	Chyba chybějících vstupních dokumentů
InvalidDocument	Chyba neplatného dokumentu
ModelVersionIncorrect	Nesprávná chyba verze modelu
InvalidDocumentBatch	Chyba dávky neplatného dokumentu
UnsupportedLanguageCode	Chyba nepodporovaného kódu jazyka
InvalidCountryHint	Neplatná chyba nápovědy pro zemi

InnerErrorModel

Objekt

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	Jedna ze serverově definovaných kódů chyb.
details	object	Podrobnosti o chybě
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby