Získání stavu dokumentů

Referenční
služba: Verze rozhraní API pro překlad
dokumentů Azure AI: verze 1.1

Pokud počet dokumentů v odpovědi překročí náš limit stránkování, použije se stránkování na straně serveru. Stránkované odpovědi označují částečný výsledek a do odpovědi zahrnou token pro pokračování. Absence tokenu pokračování znamená, že nejsou k dispozici žádné další stránky.

$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 označuje celkový počet záznamů, které chce uživatel vrátit na všech stránkách. $skip určuje počet záznamů, které se mají přeskočit ze seznamu stavu dokumentu uchovávaného serverem na základě zadané metody řazení. Ve výchozím nastavení seřadíme sestupně podle počátečního času. $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.

$orderBy parametr dotazu lze použít k seřazení vráceného seznamu (např. "$orderBy=createdDateTimeUtc asc" nebo "$orderBy=createdDateTimeUtc desc"). Výchozí řazení je sestupné podle vytvořeníDateTimeUtc. Některé parametry dotazu lze použít k filtrování vráceného seznamu (např. "status=Succeeded,Cancelled") vrátí pouze úspěšné a zrušené dokumenty. createdDateTimeUtcStart a createdDateTimeUtcEnd lze použít kombinaci nebo samostatně k určení rozsahu data a času k filtrování vráceného seznamu. Podporované parametry dotazu filtrování jsou (stav, ID, createdDateTimeUtcStart, createdDateTimeUtcEnd).

Pokud se zahrne obojí $top , $skip server by se měl nejprve použít $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.

Adresa URL požadavku

Odešlete požadavek GET do:

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

Zjistěte, jak najít vlastní název domény.

Důležité

• Všechny požadavky rozhraní API na službu překladu dokumentů vyžadují vlastní koncový bod domény.
• Koncový bod, který najdete na stránce klíčů prostředků a koncovém bodu webu Azure Portal, ani globální koncový bodapi.cognitive.microsofttranslator.com překladače – nemůžete použít k provádění požadavků HTTP na překlad dokumentů.

Parametry požadavku

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

Parametr dotazu	V	Požaduje se	Type	Popis
id	path	True	string	ID operace.
$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 označ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 a $skip parametry dotazu k určení počtu 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. 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í 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 můžou použít $top parametry dotazu $skip 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. 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í 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í
Stavy	query	False	pole	Stavy, které se mají použít při filtrování.

Záhlaví žádosti

Hlavičky požadavku jsou:

Hlavičky	Popis
Ocp-Apim-Subscription-Key	Požadovaná hlavička požadavku

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 dokumentů. HeadersRetry-After: integerETag: string
400	Neplatný požadavek Zkontrolujte vstupní parametry.
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 dokumentů

Úspěšné získání odpovědi na stav dokumentů

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	DocumentStatus []	Podrobný seznam stavů jednotlivých dokumentů.
value.path	string	Umístění dokumentu nebo složky
value.sourcePath	string	Umístění zdrojového dokumentu
value.createdDateTimeUtc	string	Operace vytvořila datum a čas.
value.lastActionDateTimeUtc	string	Datum a čas, kdy se aktualizuje stav operace.
value.status	stav	Seznammožnýchch • Zrušeno •Zrušení •Se nezdařilo • NotStarted •Spuštění •Podařilo • Ověření se nezdařilo.
value.to	string	Do jazyka.
value.progress	Číslo	Průběh překladu, pokud je k dispozici.
value.id	string	ID dokumentu.
value.characterCharged	integer	Znaky účtované 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 (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

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

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

{
  "value": [
    {
      "path": "https://myblob.blob.core.windows.net/destinationContainer/fr/mydoc.txt",
      "sourcePath": "https://myblob.blob.core.windows.net/sourceContainer/fr/mydoc.txt",
      "createdDateTimeUtc": "2020-03-26T00:00:00Z",
      "lastActionDateTimeUtc": "2020-03-26T01:00:00Z",
      "status": "Running",
      "to": "fr",
      "progress": 0.1,
      "id": "273622bd-835c-4946-9798-fd8f19f6bbf2",
      "characterCharged": 0
    }
  ],
  "@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55/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ů