Sdílet prostřednictvím

Získání stavu pro konkrétní úlohu překladu

  • Článek

Referenční
funkce: Azure AI Translator → rozhraní API pro překlad
dokumentů verze: 2024-05-01
METODA HTTP: GET

  • Použijte metodu get translation status k vyžádání stavu konkrétní úlohy překladu. Odpověď zahrnuje celkový stav úlohy a stav dokumentů, které se překládají jako součást této úlohy.

Adresa URL požadavku

Důležité

Všechny požadavky rozhraní API na funkci Překlad dokumentů vyžadují vlastní koncový bod domény umístěný na stránce přehledu prostředků na webu Azure Portal.

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

Parametry požadavku

Parametry požadavku předané v řetězci dotazu jsou:

Parametr dotazu Požadováno Popis
id True ID operace.

Vyhledání id hodnoty

Úlohu id najdete v hodnotě adresy URL hlavičky Operation-Location odpovědi metody POSTstart-batch-translation. Alfanumerický řetězec za /document/ parametrem je úloha idoperace:

Hlavička odpovědi Adresa URL odpovědi
Umístění operace {document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec?api-version=2024-05-01

Záhlaví žádosti

Hlavičky požadavku jsou:

Hlavičky Popis Podmínka
Ocp-Apim-Subscription-Key Klíč rozhraní API služby Translator z webu Azure Portal. Požaduje se
Ocp-Apim-Subscription-Region Oblast, ve které byl prostředek vytvořen. • Vyžaduje se při použití regionálního (geografického) prostředku, jako je USA – západ.
& odrážka.
Typ obsahu Typ obsahu datové části. Přijatá hodnota je application/json nebo charset=UTF-8. • Povinné

Stavové kódy odpovědí

Níže jsou uvedené možné stavové kódy HTTP, které požadavek vrátí.

Kód stavu Popis
200 OK. Úspěšný požadavek a vrátí stav operace dávkového překladu. HeadersRetry-After: integerETag: string
401 Neautorizováno Zkontrolujte přihlašovací údaje.
404 Prostředek nebyl nalezen.
500 Vnitřní chyba serveru.
Další stavové kódy • Příliš mnoho požadavků
• Server je dočasný nedostupný

Získání odpovědi na stav překladu

Úspěšná odpověď na stav překladu

Následující informace se vrátí v úspěšné odpovědi.

Name Typ Description
id string ID operace.
createdDateTimeUtc string Operace vytvořila datum a čas.
lastActionDateTimeUtc string Datum a čas, kdy byla operace aktualizována.
stav Řetězcové Seznam možných stavů pro úlohu nebo dokument:
• Zrušeno
•Zrušení
•Se nezdařilo
• NotStarted
•Spuštění
•Podařilo
• Ověření se nezdařilo.
Souhrn StatusSummary Souhrn obsahující uvedené podrobnosti.
summary.total integer Celkový počet.
summary.failed integer Počet neúspěšných chyb
summary.success integer Počet úspěšných.
summary.inProgress integer Počet probíhajících.
summary.notYetStarted integer Počet dosud nezačíná.
summary.cancelled integer Počet zrušených
summary.totalCharacterCharged integer Celkový počet znaků účtovaných rozhraním API

Chybná odpověď

Name Typ Popis
code string Výčty obsahující kódy chyb vysoké úrovně. Možné hodnoty:
• InternalServerError
• InvalidArgument
• InvalidRequest
• RequestRateTooHigh
• ResourceNotFound
• ServiceUnavailable
•Neoprávněným
zpráva string Získá chybovou zprávu vysoké úrovně.
target string Získá zdroj chyby. Jedná se documents například o neplatný dokument nebo document id o něj.
innerError InnerTranslationError Nový formát vnitřní chyby, který odpovídá pokynům rozhraní API služeb Azure AI Tato chybová zpráva obsahuje požadované vlastnosti ErrorCode, message a optional properties target, details(key value pair), inner error(it can be vnořováno).
innerError.code string Získá řetězec chyby kódu.
innerError.message string Získá chybovou zprávu vysoké úrovně.
innerError.target string Získá zdroj chyby. Jedná se documents například o neplatný dokument nebo document id o neplatný dokument.

Příklady

Příklad úspěšné odpovědi

Následující objekt JSON je příkladem úspěšné odpovědi.

{
  "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
  }
}

Příklad odpovědi na chybu

Následující objekt JSON je příkladem chybové odpovědi. Schéma pro jiné kódy chyb je stejné.

Stavový kód: 401

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

Další kroky

Další informace o použití překladu dokumentů a klientské knihovny najdete v našem rychlém startu.

Začínáme s překladem dokumentů