Dokumentum állapotának lekérése

  • Cikk

Referenciaszolgáltatás
: Azure AI Document Translation
API-verzió: 1.1-es verzió

A Dokumentumállapot lekérése metódus egy adott dokumentum állapotát adja vissza. A metódus egy adott dokumentum fordítási állapotát adja vissza a kérelemazonosító és a dokumentumazonosító alapján.

URL-cím kérése

GET kérés küldése ide:

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

Megtudhatja, hogyan keresheti meg az egyéni tartománynevet.

Fontos

  • A Dokumentumfordítási szolgáltatásnak küldött összes API-kéréshez egyéni tartományvégpont szükséges.
  • Nem használhatja az Azure Portal erőforráskulcsai és végpontoldalán található végpontot, sem a globális fordítóvégpontot –api.cognitive.microsofttranslator.com a dokumentumfordításra irányuló HTTP-kérések igényléséhez.

Kérelemparaméterek

A lekérdezési sztringen átadott kérelemparaméterek a következők:

Lekérdezési paraméter Kötelező Leírás
documentId Igaz A dokumentum azonosítója.
id Igaz A köteg azonosítója.

Kérésfejlécek

A kérelemfejlécek a következők:

Fejlécek Leírás
Ocp-Apim-Subscription-Key Szükséges kérelemfejléc

Válaszállapot-kódok

A következő lehetséges HTTP-állapotkódokat adja vissza egy kérés.

Állapotkód Leírás
200 OK. A szolgáltatás által elfogadott sikeres kérés. A rendszer visszaadja a művelet részleteit. HeadersRetry-After: integerETag: string
401 Nem engedélyezett. Ellenőrizze a hitelesítő adatait.
404 Nem található. Az erőforrás nem található.
500 Belső kiszolgálóhiba.
Egyéb állapotkódok • Túl sok kérés
• A kiszolgáló ideiglenesen nem érhető el

Dokumentumállapot-válasz lekérése

Dokumentumállapot-válasz sikeres lekérése

Név Típus Leírás
ösvény húr A dokumentum vagy mappa helye.
Sourcepath húr A forrásdokumentum helye.
createdDateTimeUtc húr A művelet létrehozta a dátumot.
lastActionDateTimeUtc húr A művelet állapotának frissítésének dátuma.
status Sztring Feladat vagy dokumentum lehetséges állapotainak listája:
•Visszavont
•Érvénytelenítés
•Nem sikerült
• Nincs megadva
•Futás
•Sikerült
• ValidationFailed
felhasználóként a(z) húr A To Language két betűs nyelvkódja. Tekintse meg a nyelvek listáját.
Haladás szám A fordítás előrehaladása, ha elérhető
id húr Dokumentumazonosító.
characterCharged egész szám Az API által felszámított karakterek.

Hibaválasz

Név Típus Leírás
code húr Magas szintű hibakódokat tartalmazó enumerálások. Lehetséges értékek:
• InternalServerError
• InvalidArgument
• InvalidRequest
• RequestRateTooHigh
• ResourceNotFound
• ServiceUnavailable
•Jogosulatlan
üzenet húr Magas szintű hibaüzenetet kap.
innerError InnerTranslationError Új belső hibaformátum, amely megfelel az Azure AI-szolgáltatások API-irányelveinek. Ez a hibaüzenet tartalmazza a szükséges tulajdonságokat: ErrorCode, üzenet és opcionális tulajdonságcél, részletek (kulcsértékpár), belső hiba (beágyazható).
innerError.code húr Kódhiba sztringet kap.
innerError.message húr Magas szintű hibaüzenetet kap.
innerError.target húr Lekéri a hiba forrását. Például érvénytelen dokumentumról van szó documentsdocument id .

Példák

Példa a sikeres válaszra

A következő JSON-objektum egy sikeres válasz példája.

{
  "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élda hibaválaszra

Az alábbi JSON-objektum egy példa egy hibaválaszra. A többi hibakód sémája ugyanaz.

Állapotkód: 401

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

Következő lépések

A dokumentumfordítás és az ügyféloldali kódtár használatával kapcsolatos további információkért kövesse a rövid útmutatót.

Ismerkedés a dokumentumfordítással