Analyze Documents Cancel Job - Analyze Documents Cancel Job

Usługa:

Azure AI Services

Wersja interfejsu API:

2024-11-15-preview

Anuluj długotrwałe zadanie analizy tekstu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwany punkt końcowy usług Cognitive Services (np. https://< nazwa-zasobu.api.cognitiveservices.azure.com>).
jobId	path	True	string (uuid)	Identyfikator zadania do anulowania.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
202 Accepted		Żądanie zostało przyjęte do przetworzenia, ale przetwarzanie nie zostało jeszcze zakończone. Nagłówki Operation-Location: string
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd. Nagłówki x-ms-error-code: string

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize
Adres URL tokenu: https://login.microsoftonline.com/common/oauth2/token

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default

Przykłady

SuccessfulAnalyzeDocumentsJobsCancelRequest

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

202

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

Definicje

Nazwa	Opis
Error	Obiekt odpowiedzi na błąd zwracany, gdy usługa napotka pewne błędy podczas przetwarzania żądania.
ErrorCode	Kod błędu czytelny dla człowieka.
ErrorResponse	Odpowiedź na błąd.
InnerErrorCode	Kod błędu czytelny dla człowieka.
InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Error

Objekt

Obiekt odpowiedzi na błąd zwracany, gdy usługa napotka pewne błędy podczas przetwarzania żądania.

Nazwa	Typ	Opis
code	ErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorCode

Wyliczanie

Kod błędu czytelny dla człowieka.

Wartość	Opis
InvalidRequest	Błąd nieprawidłowego żądania
InvalidArgument	Błąd nieprawidłowego argumentu
Unauthorized	Błąd nieautoryzowanego dostępu
Forbidden	Błąd dostępu zabronionego
NotFound	Nie znaleziono błędu
ProjectNotFound	Błąd nie znaleziono projektu
OperationNotFound	Błąd nie znaleziono operacji
AzureCognitiveSearchNotFound	Nie znaleziono błędu usługi Azure Cognitive Search
AzureCognitiveSearchIndexNotFound	Nie znaleziono błędu indeksu usługi Azure Cognitive Search
TooManyRequests	Błąd zbyt wielu żądań
AzureCognitiveSearchThrottling	Błąd ograniczania usługi Azure Cognitive Search
AzureCognitiveSearchIndexLimitReached	Błąd osiągnięto limit indeksu usługi Azure Cognitive Search
InternalServerError	Wewnętrzny błąd serwera.
ServiceUnavailable	Błąd niedostępności usługi
Timeout	Błąd przekroczenia limitu czasu
QuotaExceeded	Błąd przekroczenia limitu przydziału
Conflict	Błąd konfliktu
Warning	Błąd ostrzeżenia

ErrorResponse

Objekt

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

InnerErrorCode

Wyliczanie

Kod błędu czytelny dla człowieka.

Wartość	Opis
InvalidRequest	Błąd nieprawidłowego żądania
InvalidParameterValue	Błąd nieprawidłowej wartości parametru
KnowledgeBaseNotFound	Nie znaleziono błędu bazy wiedzy
AzureCognitiveSearchNotFound	Nie znaleziono błędu usługi Azure Cognitive Search
AzureCognitiveSearchThrottling	Błąd ograniczania usługi Azure Cognitive Search
ExtractionFailure	Błąd wyodrębniania
InvalidRequestBodyFormat	Błąd nieprawidłowego formatu treści żądania
EmptyRequest	Błąd pustego żądania
MissingInputDocuments	Błąd brakujących dokumentów wejściowych
InvalidDocument	Błąd nieprawidłowego dokumentu
ModelVersionIncorrect	Błąd nieprawidłowej wersji modelu
InvalidDocumentBatch	Błąd wsadowy nieprawidłowego dokumentu
UnsupportedLanguageCode	Nieobsługiwany błąd kodu języka
InvalidCountryHint	Błąd nieprawidłowej wskazówki dotyczącej kraju

InnerErrorModel

Objekt

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	InnerErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	object	Szczegóły błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.