Uzyskiwanie stanu tłumaczenia

  • Artykuł

Usługa referencyjna
: Wersja interfejsu API tłumaczenia
dokumentów sztucznej inteligencji platformy Azure: wersja 1.1

Metoda Pobierz stan tłumaczenia zwraca stan żądania tłumaczenia dokumentu. Stan zawiera ogólny stan żądania i stan dokumentów, które są tłumaczone w ramach tego żądania.

Adres URL żądania

Wyślij żądanie GET do:

GET https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/batches/{id}

Dowiedz się, jak znaleźć niestandardową nazwę domeny.

Ważne

  • Wszystkie żądania interfejsu API do usługi tłumaczenia dokumentów wymagają niestandardowego punktu końcowego domeny.
  • Nie można użyć punktu końcowego znajdującego się na stronie kluczy zasobów i punktu końcowego witryny Azure Portal, ani globalnego punktu końcowego translatora —api.cognitive.microsofttranslator.com w celu wysłania żądań HTTP do tłumaczenia dokumentów.

Parametry żądania

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

Parametr zapytania Wymagania opis
id Prawda Identyfikator operacji.

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. Pomyślne żądanie i zwraca stan operacji tłumaczenia wsadowego. HeadersRetry-After: integerETag: string
401 Brak autoryzacji. Sprawdź poświadczenia.
404 Nie można odnaleźć zasobu.
500 Wewnętrzny błąd serwera.
Inne kody stanu • Zbyt wiele żądań
• Serwer tymczasowy niedostępny

Uzyskiwanie odpowiedzi na stan tłumaczenia

Pomyślna odpowiedź na stan tłumaczenia

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:
• Anulowana
•Anulowanie
•Nie powiodło się
• Niestartowane
•Uruchomiona
•Zakończyła się pomyślnie
• ValidationFailed
Podsumowanie StatusSummary Podsumowanie zawierające wymienione szczegóły.
summary.total integer Łączna liczba.
summary.failed integer Liczba nieudanych prób.
summary.success integer Liczba pomyślnych.
summary.inProgress integer Liczba w toku.
summary.notYetStarted integer Liczba nie została jeszcze uruchomiona.
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 byłoby documents to lub document id dla nieprawidłowego dokumentu.
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 to documents lub document id dla nieprawidłowego dokumentu.

Przykłady

Przykład pomyślnej odpowiedzi

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

{
  "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: 401

{
  "error": {
    "code": "Unauthorized",
    "message": "User is not authorized",
    "target": "Document",
    "innerError": {
      "code": "Unauthorized",
      "message": "Operation is not authorized"
    }
  }
}

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