Sdílet prostřednictvím

Získání stavu pro všechny úlohy 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 translations status k vyžádání seznamu a stavu všech úloh překladu odeslaných uživatelem (přidruženým k prostředku).

  • $top, $skipa $maxpagesize parametry dotazu lze použít k určení počtu výsledků, které se mají vrátit, a posun pro kolekci.

    • $top určuje celkový počet záznamů, které mají být vráceny na všech stránkách.
    • $skip určuje počet záznamů, které se mají přeskočit ze seznamu dávek na základě zadané metody řazení. Ve výchozím nastavení se záznamy seřadí sestupně podle času zahájení.
    • $maxpagesize je maximální počet vrácených položek na stránce.
    • Pokud je požadováno více položek ( $top nebo $top není zadáno a bude vráceno více položek), @nextLink bude obsahovat odkaz na další stránku.
    • Server respektuje hodnoty zadané klientem. Klienti však musí být připraveni zpracovat odpovědi, které obsahují jinou velikost stránky nebo obsahují token pro pokračování.
    • Jakmile se zahrne obojí $top$skip , server se nejprve použije $skip a pak $top v kolekci.

Poznámka:

Pokud server nemůže respektovat $top a/nebo $skip, server musí klientovi vrátit chybu, která o něm informuje, místo pouhého ignorovánímožnostích Tím se snižuje riziko, že klient předpokládá vrácená data.

  • $orderBy Parametr dotazu lze použít k seřazení vráceného seznamu (např $orderBy=createdDateTimeUtc asc$orderBy=createdDateTimeUtc desc.
    • Výchozí řazení je sestupné podle createdDateTimeUtc. Některé parametry dotazu lze použít k filtrování vráceného seznamu (např status=Succeeded,Cancelled. ) vrátí úspěšné a zrušené operace.
    • Parametry createdDateTimeUtcStart dotazu createdDateTimeUtcEnd lze použít zkombinování nebo samostatně k určení rozsahu data a času k filtrování vráceného seznamu.
    • Podporované parametry dotazu filtrování jsou (status, id, createdDateTimeUtcStarta createdDateTimeUtcEnd).

Adresa URL požadavku

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

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.

Parametry požadavku

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

Parametr dotazu V Požaduje se Type Popis
$maxpagesize query False celé číslo int32 $maxpagesize je maximální počet vrácených položek na stránce. Pokud je požadováno více položek ( $top nebo $top není zadáno a bude vráceno více položek), @nextLink bude obsahovat odkaz na další stránku. Klienti mohou požadovat stránkování řízené serverem s konkrétní velikostí stránky zadáním $maxpagesize předvolby. Server BY měl tuto předvolbu respektovat, pokud je zadaná velikost stránky menší než výchozí velikost stránky serveru.
$orderBy query False pole Dotaz řazení pro kolekci (např. CreatedDateTimeUtc asc, CreatedDateTimeUtc desc)
$skip query False celé číslo int32 $skip určuje počet záznamů, které se mají přeskočit ze seznamu záznamů uložených serverem na základě zadané metody řazení. Ve výchozím nastavení seřadíme sestupně podle počátečního času. Klienti mohou použít $top parametry $skip dotazu a určit počet výsledků, které se mají vrátit, a posun do kolekce. Když klient vrátí oba $top a $skip, server MUSÍ nejprve použít $skip a pak $top v kolekci. Poznámka: Pokud server nemůže respektovat $top nebo , $skipserver musí klientovi vrátit chybu, která o něm informuje, místo pouhého ignorování možností dotazu.
$top query False celé číslo int32 $top označuje celkový počet záznamů, které chce uživatel vrátit na všech stránkách. Klienti mohou použít $top parametry $skip dotazu a určit počet výsledků, které se mají vrátit, a posun do kolekce. Když klient vrátí oba $top a $skip, server MUSÍ nejprve použít $skip a pak $top v kolekci. Poznámka: Pokud server nemůže respektovat $top nebo , $skipserver musí klientovi vrátit chybu, která o něm informuje, místo pouhého ignorování možností dotazu.
createdDateTimeUtcEnd query False řetězcové datum a čas Koncové datum a čas získání položek před.
createdDateTimeUtcStart query False řetězcové datum a čas Počáteční datum a čas pro získání položek po.
ids query False pole ID, která se mají použít při filtrování
statuses query False pole Stavy, které se mají použít při filtrování.

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 všech operací. HeadersRetry-After: integerETag: string
400 Chybný požadavek. Neplatný požadavek Zkontrolujte vstupní parametry.
401 Neautorizováno Zkontrolujte přihlašovací údaje.
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řekladů

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

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

Name Typ Popis
@nextLink string Adresa URL další stránky Null, pokud nejsou k dispozici žádné další stránky.
hodnota TranslationStatus[] TranslationStatus[] Array
value.id string ID operace.
value.createdDateTimeUtc string Operace vytvořila datum a čas.
value.lastActionDateTimeUtc string Datum a čas, kdy byla operace aktualizována.
value.status String 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.
value.summary StatusSummary[] Souhrn obsahující uvedené podrobnosti.
value.summary.total integer Počet celkového počtu dokumentů
value.summary.failed integer Počet dokumentů se nezdařil.
value.summary.success integer Počet dokumentů byl úspěšně přeložen.
value.summary.inProgress integer Počet probíhajících dokumentů
value.summary.notYetStarted integer Počet dokumentů ještě nezačala zpracovávat.
value.summary.cancelled integer Počet zrušených dokumentů
value.summary.totalCharacterCharged integer Celkový počet účtovaných znaků

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. Může se documents jednat například o neplatný dokument nebo document id o neplatný dokument.
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 (může být vnořeno).
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. Může se documents jednat například o neplatný dokument nebo document id o neplatný dokument.

Příklady

Tip

Tuto metodu můžete použít k načtení parametru úlohy id pro řetězec dotazu get-translation-status .

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

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

{
    "value": [
        {
            "id": "36724748-f7a0-4db7-b7fd-f041ddc75033",
            "createdDateTimeUtc": "2021-06-18T03:35:30.153374Z",
            "lastActionDateTimeUtc": "2021-06-18T03:36:44.6155316Z",
            "status": "Succeeded",
            "summary": {
                "total": 3,
                "failed": 2,
                "success": 1,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 0
            }
        },
        {
            "id": "1c7399a7-6913-4f20-bb43-e2fe2ba1a67d",
            "createdDateTimeUtc": "2021-05-24T17:57:43.8356624Z",
            "lastActionDateTimeUtc": "2021-05-24T17:57:47.128391Z",
            "status": "Failed",
            "summary": {
                "total": 1,
                "failed": 1,
                "success": 0,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 0
            }
        },
        {
            "id": "daa2a646-4237-4f5f-9a48-d515c2d9af3c",
            "createdDateTimeUtc": "2021-04-14T19:49:26.988272Z",
            "lastActionDateTimeUtc": "2021-04-14T19:49:43.9818634Z",
            "status": "Succeeded",
            "summary": {
                "total": 2,
                "failed": 0,
                "success": 2,
                "inProgress": 0,
                "notYetStarted": 0,
                "cancelled": 0,
                "totalCharacterCharged": 21899
            }
        }
    ],
    ""@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.1/operations/727BF148-F327-47A0-9481-ABAE6362F11E/documents?`$top`=5&`$skip`=15"
}

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: 500

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

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ů