Udostępnij za pośrednictwem

Anulowanie tłumaczenia

  • Artykuł

Funkcja referencyjna
: Azure AI Translator → interfejsu API tłumaczenia
dokumentów Wersja: 2024-05-01
metoda HTTP: DELETE

  • Ta metoda anuluje zadanie tłumaczenia, które jest obecnie przetwarzane lub kolejkowane (oczekujące) zgodnie z żądaniem id przez parametr zapytania.
  • Operacja nie jest anulowana, jeśli została jeszcze ukończona, nie powiodła się lub nadal anuluje. W tych przypadkach zwracane jest nieprawidłowe żądanie.
  • Ukończonych tłumaczeń nie można anulować i są naliczane opłaty.

Adres URL żądania

Ważne

Wszystkie żądania interfejsu API do funkcji tłumaczenia dokumentów wymagają niestandardowego punktu końcowego domeny znajdującego się na stronie przeglądu zasobu w witrynie Azure Portal.

  curl -i -X  DELETE "{document-translation-endpoint}/translator/document/batches/{id}?api-version={date}"

Parametry żądania

Parametry żądania przekazane w ciągu zapytania to:

Parametr zapytania Wymagania opis
id Prawda Identyfikator operacji.

Lokalizowanie id wartości

Zadanie id można znaleźć w wartości adresu URL nagłówka Operation-Location odpowiedzi metody POSTstart-batch-translation. Ciąg alfanumeryczny po parametrze /document/ jest zadaniem idoperacji :

Nagłówek odpowiedzi Adres URL odpowiedzi
Lokalizacja operacji {document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec?api-version=2024-05-01

Nagłówki żądań

Nagłówki żądań to:

Nagłówki opis
Ocp-Apim-Subscription-Key Wymagany nagłówek żądania

Kody stanu odpowiedzi

Poniżej przedstawiono możliwe kody stanu HTTP zwracane przez żądanie.

Kod stanu opis
200 OK. Anulowanie przesłanego żądania
401 Brak autoryzacji. Sprawdź poświadczenia.
404 Nie znaleziono. Nie można odnaleźć zasobu.
500 Wewnętrzny błąd serwera.
Inne kody stanu • Zbyt wiele żądań
• Serwer tymczasowy niedostępny

Anulowanie odpowiedzi na tłumaczenie

Odpowiedź pomyślna

Następujące informacje są zwracane w pomyślnej odpowiedzi.

Nazwisko Pisz opis
id string Identyfikator operacji.
createdDateTimeUtc string Operacja utworzona data/godzina.
lastActionDateTimeUtc string Data i godzina aktualizacji stanu operacji.
status String Lista możliwych stanów zadania lub dokumentu: • Anulowano
•Anulowanie
•Nie powiodło się
• Niestartowane
•Bieganie
•Zakończyła się pomyślnie
• ValidationFailed
Podsumowanie StatusSummary Podsumowanie zawierające listę szczegółów.
summary.total integer Liczba wszystkich dokumentów.
summary.failed integer Liczba dokumentów nie powiodła się.
summary.success integer Liczba pomyślnie przetłumaczonych dokumentów.
summary.inProgress integer Liczba dokumentów w toku.
summary.notYetStarted integer Liczba dokumentów, które nie rozpoczęły jeszcze przetwarzania.
summary.cancelled integer Liczba anulowanych.
summary.totalCharacterCharged integer Łączna liczba znaków naliczanych przez interfejs API.

Odpowiedź błędna

Nazwisko Pisz Opis
code string Wyliczenia zawierające kody błędów wysokiego poziomu. Możliwe wartości:
• InternalServerError
• InvalidArgument
• InvalidRequest
• RequestRateTooHigh
• ResourceNotFound
• ServiceUnavailable
•Nieautoryzowanych
wiadomość string Pobiera komunikat o błędzie wysokiego poziomu.
target string Pobiera źródło błędu. Na przykład będzie to "dokumenty" lub document id nieprawidłowy dokument.
innerError InnerTranslationError Nowy format błędu wewnętrznego zgodny z wytycznymi interfejsu API usług AI platformy Azure. Ten komunikat o błędzie zawiera wymagane właściwości ErrorCode, message i optional properties target, details (key value pair), wewnętrzny błąd (można go zagnieżdżać).
innerError.code string Pobiera ciąg błędu kodu.
innerError.message string Pobiera komunikat o błędzie wysokiego poziomu.
innerError.target string Pobiera źródło błędu. Na przykład byłoby documents to lub document id gdyby dokument był nieprawidłowy.

Przykłady

Przykład pomyślnej odpowiedzi

Poniższy obiekt JSON jest przykładem pomyślnej odpowiedzi.

Kod stanu: 200

{
  "id": "727bf148-f327-47a0-9481-abae6362f11e",
  "createdDateTimeUtc": "2020-03-26T00:00:00Z",
  "lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
  "status": "Succeeded",
  "summary": {
    "total": 10,
    "failed": 1,
    "success": 9,
    "inProgress": 0,
    "notYetStarted": 0,
    "cancelled": 0,
    "totalCharacterCharged": 0
  }
}

Przykładowa odpowiedź na błąd

Poniższy obiekt JSON jest przykładem odpowiedzi na błąd. Schemat innych kodów błędów jest taki sam.

Kod stanu: 500

{
  "error": {
    "code": "InternalServerError",
    "message": "Internal Server Error",
    "target": "Operation",
    "innerError": {
      "code": "InternalServerError",
      "message": "Unexpected internal server error has occurred"
    }
  }
}

Następne kroki

Postępuj zgodnie z naszym przewodnikiem Szybki start, aby dowiedzieć się więcej na temat korzystania z tłumaczenia dokumentów i biblioteki klienta.

Wprowadzenie do tłumaczenia dokumentów