Fordítások állapotának lekérése

  • Cikk

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

A Fordítások lekérése állapotmetódus az elküldött kötegkérelmek listáját és az egyes kérések állapotát adja vissza. Ez a lista csak a felhasználó által (az erőforrás alapján) küldött kötegelt kérelmeket tartalmazza.

Ha a kérelmek száma meghaladja a lapozási korlátot, a rendszer kiszolgálóoldali lapozást használ. A lapszámozott válaszok részleges eredményt jeleznek, és mellékelnek egy folytatási jogkivonatot a válaszba. A folytatási jogkivonat hiánya azt jelenti, hogy nincs más lap.

$top, $skipés $maxpagesize lekérdezési paraméterekkel megadhatja a visszaadni kívánt eredmények számát és a gyűjtemény eltolását.

$top Azt jelzi, hogy a felhasználó hány rekordot szeretne visszaadni az összes oldalon. $skip A megadott rendezési módszer alapján a kötegek listájából kihagyandó rekordok számát jelzi. Alapértelmezés szerint csökkenő kezdési időpont szerint rendezünk. $maxpagesize A lapon visszaadott maximális elemek száma. Ha több elem kérése $top történik (vagy $top nincs megadva, és több elemet kell visszaadni), @nextLink a következő lapra mutató hivatkozást fogja tartalmazni.

$orderBy lekérdezési paraméter használható a visszaadott lista rendezéséhez (pl. "$orderBy=createdDateTimeUtc asc" vagy "$orderBy=createdDateTimeUtc desc"). Az alapértelmezett rendezés a createdDateTimeUtc szerint csökkenő. Egyes lekérdezési paraméterek a visszaadott lista szűrésére használhatók (pl. "status=Succeeded,Canceled") a sikeres és a megszakított műveleteket adja vissza. A createdDateTimeUtcStart és a createdDateTimeUtcEnd együttes vagy külön-külön használható a visszaadott lista szűréséhez használt dátumtartomány megadásához. A támogatott szűrési lekérdezési paraméterek (állapot, azonosítók, createdDateTimeUtcStart, createdDateTimeUtcEnd).

A kiszolgáló tiszteletben tartja az ügyfél által megadott értékeket. Az ügyfeleknek azonban fel kell készülniük arra, hogy más oldalméretet vagy folytatási jogkivonatot tartalmazó válaszokat kezeljenek.

Ha mindkettőt $top$skip tartalmazza, a kiszolgálónak először alkalmaznia $skip kell, majd $top a gyűjteményre.

Feljegyzés

Ha a kiszolgáló nem tudja tiszteletben tartani $top és/vagy $skip, a kiszolgálónak hibaüzenetet kell visszaadnia az ügyfélnek, amely tájékoztatja arról a lekérdezési beállítások figyelmen kívül hagyása helyett. Ez csökkenti annak a kockázatát, hogy az ügyfél feltételezi a visszaadott adatokkal kapcsolatos feltételezéseket.

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

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 In Kötelező Típus Leírás
$maxpagesize Lekérdezés Hamis egész szám int32 $maxpagesize A lapon visszaadott maximális elemek száma. Ha több elem kérése $top történik (vagy $top nincs megadva, és több elemet kell visszaadni), @nextLink a következő lapra mutató hivatkozást fogja tartalmazni. Az ügyfelek egy adott oldalmérettel igényelhetnek kiszolgálóalapú lapozást egy $maxpagesize beállítás megadásával. A kiszolgálónak meg kell tartania ezt a beállítást, ha a megadott oldalméret kisebb, mint a kiszolgáló alapértelmezett oldalmérete.
$orderBy Lekérdezés Hamis array A gyűjtemény rendezési lekérdezése (például: CreatedDateTimeUtc asc, CreatedDateTimeUtc desc)
$skip Lekérdezés Hamis egész szám int32 $skip A kiszolgáló által tárolt rekordok listájából kihagyandó rekordok számát jelzi a megadott rendezési módszer alapján. Alapértelmezés szerint csökkenő kezdési időpont szerint rendezünk. Az ügyfelek használhatják és $skip lekérdezhetik $top a paramétereket a visszaadandó eredmények számának és a gyűjteménybe való eltolásnak a megadásához. Amikor az ügyfél mindkettőt $top$skipvisszaadja, a kiszolgálónak először alkalmaznia $skip kell, majd $top a gyűjteményre. Megjegyzés: Ha a kiszolgáló nem tudja tiszteletben tartani $top és/vagy $skip, a kiszolgálónak hibaüzenetet kell visszaadnia az ügyfélnek, amely tájékoztatja arról a lekérdezési beállítások figyelmen kívül hagyása helyett.
$top Lekérdezés Hamis egész szám int32 $top Azt jelzi, hogy a felhasználó hány rekordot szeretne visszaadni az összes oldalon. Az ügyfelek használhatják és $skip lekérdezhetik $top a paramétereket a visszaadandó eredmények számának és a gyűjteménybe való eltolásnak a megadásához. Amikor az ügyfél mindkettőt $top$skipvisszaadja, a kiszolgálónak először alkalmaznia $skip kell, majd $top a gyűjteményre. Megjegyzés: Ha a kiszolgáló nem tudja tiszteletben tartani $top és/vagy $skip, a kiszolgálónak hibaüzenetet kell visszaadnia az ügyfélnek, amely tájékoztatja arról a lekérdezési beállítások figyelmen kívül hagyása helyett.
createdDateTimeUtcEnd Lekérdezés Hamis sztring dátum-idő Az elemek korábbi lekéréséhez tartozó befejezési dátum.
createdDateTimeUtcStart Lekérdezés Hamis sztring dátum-idő A kezdési dátum, amely után elemeket szeretne lekérni.
ids Lekérdezés Hamis array A szűréshez használandó azonosítók.
Állapotok Lekérdezés Hamis array A szűréshez használandó állapotok.

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. Sikeres kérés, és visszaadja az összes művelet állapotát. HeadersRetry-After: integerETag: string
400 Hibás kérés. Érvénytelen kérelem. Ellenőrizze a bemeneti paramétereket.
401 Nem engedélyezett. Ellenőrizze a hitelesítő adatait.
500 Belső kiszolgálóhiba.
Egyéb állapotkódok • Túl sok kérés
• A kiszolgáló ideiglenesen nem érhető el

Fordítások állapotválaszának lekérése

Fordítások állapotának sikeres lekérése – válasz

A rendszer a következő adatokat adja vissza egy sikeres válaszban.

Név Típus Leírás
@nextLink húr A következő oldal URL-címe. Null érték, ha nincs több lap.
Érték TranslationStatus[] TranslationStatus[] Tömb
value.id húr A művelet azonosítója.
value.createdDateTimeUtc húr A művelet létrehozta a dátumot.
value.lastActionDateTimeUtc húr A művelet állapotának frissítésének dátuma.
value.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
value.summary StatusSummary[] A felsorolt adatokat tartalmazó összegzés.
value.summary.total egész szám Az összes dokumentum száma.
value.summary.failed egész szám A dokumentumok száma sikertelen.
value.summary.success egész szám A sikeresen lefordított dokumentumok száma.
value.summary.inProgress egész szám Folyamatban lévő dokumentumok száma.
value.summary.notYetStarted egész szám A még nem megkezdett dokumentumok száma.
value.summary.cancelled egész szám A törölt dokumentumok száma.
value.summary.totalCharacterCharged egész szám A felszámolt karakterek teljes száma.

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.
target húr Lekéri a hiba forrását. Például az lenne documents , vagy document id ha érvénytelen dokumentum lenne.
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 az lenne documents , vagy document id ha érvénytelen dokumentum lenne.

Példák

Példa a sikeres válaszra

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

{
    "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é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: 500

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

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