Analyze Documents Cancel Job - Analyze Documents Cancel Job

Tjänst:

Azure AI Services

API-version:

2024-11-15-preview

Avbryt ett tidskrävande textanalysjobb.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string	Cognitive Services-slutpunkt som stöds (t.ex. https://< resource-name.api.cognitiveservices.azure.com>).
jobId	path	True	string (uuid)	Jobb-ID:t som ska avbrytas.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
202 Accepted		Begäran har godkänts för behandling, men bearbetningen har ännu inte slutförts. Sidhuvuden Operation-Location: string
Other Status Codes	ErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize
Token-webbadress: https://login.microsoftonline.com/common/oauth2/token

Omfattningar

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

Exempel

SuccessfulAnalyzeDocumentsJobsCancelRequest

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

202

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

Definitioner

Name	Description
Error	Felsvarsobjektet som returneras när tjänsten påträffar vissa fel under bearbetningen av begäran.
ErrorCode	Felkod som kan läsas av människor.
ErrorResponse	Felsvar.
InnerErrorCode	Felkod som kan läsas av människor.
InnerErrorModel	Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Error

Objekt

Felsvarsobjektet som returneras när tjänsten påträffar vissa fel under bearbetningen av begäran.

Name	Typ	Description
code	ErrorCode	En av en serverdefinierad uppsättning felkoder.
details	Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorCode

Uppräkning

Felkod som kan läsas av människor.

Värde	Description
InvalidRequest	Ogiltigt begärandefel
InvalidArgument	Ogiltigt argumentfel
Unauthorized	Fel vid obehörig åtkomst
Forbidden	Fel om förbjuden åtkomst
NotFound	Det gick inte att hitta felet
ProjectNotFound	Det gick inte att hitta projektet
OperationNotFound	Det gick inte att hitta åtgärden
AzureCognitiveSearchNotFound	Azure Cognitive Search hittades inte
AzureCognitiveSearchIndexNotFound	Azure Cognitive Search-indexet hittades inte
TooManyRequests	Fel vid för många begäranden
AzureCognitiveSearchThrottling	Azure Cognitive Search-begränsningsfel
AzureCognitiveSearchIndexLimitReached	Azure Cognitive Search-indexgränsen nådde fel
InternalServerError	Internt serverfel.
ServiceUnavailable	Fel som inte är tillgänglig för tjänsten
Timeout	Timeout-fel
QuotaExceeded	Fel om överskriden kvot
Conflict	Konfliktfelmeddelande
Warning	Varningsfel

ErrorResponse

Objekt

Felsvar.

Name	Typ	Description
error	Error	Felobjektet.

InnerErrorCode

Uppräkning

Felkod som kan läsas av människor.

Värde	Description
InvalidRequest	Ogiltigt begärandefel
InvalidParameterValue	Ogiltigt parametervärdefel
KnowledgeBaseNotFound	Det gick inte att hitta kunskapsbasen
AzureCognitiveSearchNotFound	Azure Cognitive Search hittades inte
AzureCognitiveSearchThrottling	Azure Cognitive Search-begränsningsfel
ExtractionFailure	Fel vid extrahering
InvalidRequestBodyFormat	Ogiltigt fel i brödtextformat för begäran
EmptyRequest	Fel vid tom begäran
MissingInputDocuments	Fel i indatadokument saknas
InvalidDocument	Ogiltigt dokumentfel
ModelVersionIncorrect	Fel i modellversion
InvalidDocumentBatch	Ogiltigt dokumentbatchfel
UnsupportedLanguageCode	Fel med språkkod som inte stöds
InvalidCountryHint	Ogiltigt landtipsfel

InnerErrorModel

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	En av en serverdefinierad uppsättning felkoder.
details	object	Felinformation.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	Felmeddelande.
target	string	Felmål.