Dokumentumok állapotának lekérése

  • Cikk

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

Ha a válaszban szereplő dokumentumok 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 kiszolgáló által a megadott rendezési módszer alapján a dokumentum állapotlistá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 (például "status=Succeeded,Canceled") csak a sikeres és a megszakított dokumentumokat 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).

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/{id}/documents

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
id ösvény Igaz húr A művelet azonosítója.
$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 azt jelzi, hogy hány rekordot kell kihagyni a kiszolgáló által tárolt rekordok listájából a megadott rendezési módszer alapján. Alapértelmezés szerint csökkenő kezdési időpont szerint rendezünk. Az ügyfelek $top és $skip lekérdezési paramétereket használhatnak a visszaadandó eredmények számának és a gyűjtemény eltolásának 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. 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 paramétereket használhatnak $top és $skip kérdezhetnek le 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. 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érelem, és visszaadja a dokumentumok állapotát. HeadersRetry-After: integerETag: string
400 Érvénytelen kérelem. Ellenőrizze a bemeneti paramétereket.
401 Nem engedélyezett. Ellenőrizze a hitelesítő adatait.
404 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ó átmenetileg nem érhető el

Dokumentumok állapotválaszának lekérése

Dokumentumok á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 DocumentStatus [] Az egyes dokumentumok részletes állapotlistája.
value.path húr A dokumentum vagy mappa helye.
value.sourcePath húr A forrásdokumentum helye.
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 status Feladat vagy dokumentum lehetséges állapotainak listája.
•Visszavont
•Érvénytelenítés
•Nem sikerült
• Nincs megadva
•Futás
•Sikerült
• ValidationFailed
value.to húr Nyelvre.
value.progress szám A fordítás előrehaladása, ha elérhető.
value.id húr Dokumentumazonosító.
value.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.
target húr Lekéri a hiba forrását. Például érvénytelen dokumentumról van szó documentsdocument id .
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": [
    {
      "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é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