Získání stavu dokumentu
Referenční
služba: Verze rozhraní API pro překlad
dokumentů Azure AI: verze 1.1
Metoda Get Document Status vrátí stav konkrétního dokumentu. Metoda vrátí stav překladu pro konkrétní dokument na základě ID požadavku a ID dokumentu.
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/{documentId}
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ý bod
api.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 | Požadováno | Popis |
---|---|---|
documentId | True | ID dokumentu. |
id |
True | ID dávky. |
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á žádost přijatá službou Vrátí se podrobnosti o operaci. HeadersRetry-After: integerETag: string |
401 | Neautorizováno Zkontrolujte přihlašovací údaje. |
404 | Nenalezena. 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 dokumentu
Úspěšná odpověď na získání stavu dokumentu
Name | Typ | Popis |
---|---|---|
path | string | Umístění dokumentu nebo složky |
sourcePath | string | Umístění zdrojového dokumentu |
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. |
na | string | Dvoumísmenný kód jazyka jazyka To Language. Podívejte se na seznam jazyků. |
Průběh | Číslo | Průběh překladu, pokud je k dispozici |
id |
string | ID dokumentu. |
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ě. |
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 něj. |
Příklady
Příklad úspěšné odpovědi
Následující objekt JSON je příkladem úspěšné odpovědi.
{
"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
}
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.