Fordítás indítása

Cikk
02/23/2024

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

Ezzel az API-val elindíthat egy fordítási kérelmet a Dokumentumfordítás szolgáltatással. Minden kérelem több dokumentumot tartalmazhat, és minden dokumentumhoz tartalmaznia kell egy forrás- és céltárolót.

Az előtag- és utótagszűrő (ha van megadva) a mappák szűrésére szolgál. Az előtagot a rendszer a tároló neve után alkalmazza a segédútra.

Szószedetek/fordítási memória szerepelhet a kérelemben, és a szolgáltatás alkalmazhatja a dokumentum lefordításakor.

Ha a szószedet érvénytelen vagy nem érhető el a fordítás során, a dokumentum állapota hibát jelez. Ha egy azonos nevű fájl már létezik a célhelyen, a feladat meghiúsul. Az egyes célnyelvek targetUrl elemének egyedinek kell lennie.

URL-cím kérése

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

POST 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é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

BatchRequest (törzs)

A bemeneti kötegfordítási kérelem definíciója. Minden kérelem több dokumentumot tartalmazhat, és mindegyik dokumentumhoz tartalmaznia kell egy forrás- és céltárolót. Forrás médiatípusai: application/json, text/json. application/*+json


{
  "inputs": [
    {
      "source": {
        "sourceUrl": "https://myblob.blob.core.windows.net/Container/",
        "filter": {
          "prefix": "FolderA",
          "suffix": ".txt"
        },
        "language": "en",
        "storageSource": "AzureBlob"
      },
      "targets": [
        {
          "targetUrl": "https://myblob.blob.core.windows.net/TargetUrl/",
          "category": "general",
          "language": "fr",
          "glossaries": [
            {
              "glossaryUrl": "https://myblob.blob.core.windows.net/Container/myglossary.tsv",
              "format": "XLIFF",
              "version": "2.0",
              "storageSource": "AzureBlob"
            }
          ],
          "storageSource": "AzureBlob"
        }
      ],
      "storageType": "Folder"
    }
  ],
  "options": {
    "experimental": true
  }
}

Bevitelek

A bemeneti kötegfordítási kérelem definíciója.

Kulcsparaméter	Típus	Kötelező	Kérelemparaméterek	Leírás
Bemenetek	`array`	Igaz	• forrás (objektum) • célok (tömb) • storageType (sztring)	Bemeneti forrásadatok.

inputs.source

A forrásadatok definíciója.

Kulcsparaméter	Típus	Kötelező	Kérelemparaméterek	Leírás
inputs.source	`object`	Igaz	• sourceUrl (sztring) • szűrő (objektum) • nyelv (sztring) • storageSource (sztring)	Bemeneti dokumentumok forrásadatai.
inputs.source.sourceUrl	`string`	Igaz	•Karakterlánc	A forrásfájl vagy mappa tárolóhelye.
inputs.source.filter	`object`	Hamis	• előtag (sztring) • utótag (sztring)	Kis- és nagybetűket megkülönböztető sztringek a forrásútvonal dokumentumainak szűréséhez.
inputs.source.filter.prefix	`string`	Hamis	•Karakterlánc	Kis- és nagybetűkre érzékeny előtagsztring a fordítás forrásútvonalában lévő dokumentumok szűréséhez. Gyakran használják almappák fordításhoz való kijelölésére. Példa: "FolderA".
inputs.source.filter.utótag	`string`	Hamis	•Karakterlánc	Kis- és nagybetűkre érzékeny utótagsztring a fordítás forrásútvonalában lévő dokumentumok szűréséhez. Leggyakrabban fájlkiterjesztésekhez használják. Példa: ".txt"
inputs.source.language	`string`	Hamis	•Karakterlánc	A forrásdokumentumok nyelvi kódja. Ha nincs megadva, az automatikus észlelés implementálva lesz.
inputs.source.storageSource	`string`	Hamis	•Karakterlánc	A bemenetek tárolási forrása. Alapértelmezett érték: `AzureBlob`.

inputs.targets

Cél- és szószedetadatok definíciója.

Kulcsparaméter	Típus	Kötelező	Kérelemparaméterek	Leírás
inputs.targets	`array`	Igaz	• targetUrl (sztring) • kategória (sztring) • nyelv (sztring) • szószedetek (tömb) • storageSource (sztring)	A lefordított dokumentumok cél- és szószedetadatai.
inputs.targets.targetUrl	`string`	Igaz	•Karakterlánc	A lefordított dokumentumok tárolóhelyének helye.
inputs.targets.category	`string`	Hamis	•Karakterlánc	A fordítási kérelem besorolása vagy kategóriája. Példa: általános.
inputs.targets.language	`string`	Igaz	•Karakterlánc	Célnyelvi kód. Példa: "fr".
inputs.targets.glossaries	`array`	Hamis	• glossaryUrl (sztring) • formátum (sztring) • verzió (sztring) • storageSource (sztring)	Lásd:Szószedetek létrehozása és használata
inputs.targets.glossaries.glossaryUrl	`string`	Igaz (szószedetek használata esetén)	•Karakterlánc	A szószedet helye. A fájlkiterjesztés a formázás kinyerésére szolgál, ha a formátumparaméter nincs megadva. Ha a fordítási nyelvi pár nem szerepel a szószedetben, az nem lesz alkalmazva.
inputs.targets.glossaries.format	`string`	Hamis	•Karakterlánc	A szószedet megadott fájlformátuma. Ha ellenőrizni szeretné, hogy a fájlformátum támogatott-e, olvassa el a támogatott szószedetformátumok lekérése című témakört.
inputs.targets.glossaries.version	`string`	Hamis	•Karakterlánc	Verziójelző. Példa: "2.0".
inputs.targets.glossaries.storageSource	`string`	Hamis	•Karakterlánc	Szószedetek tárolási forrása. Alapértelmezett érték: `_AzureBlob_`.
inputs.targets.storageSource	`string`	Hamis	•Karakterlánc	Tárolóforrás a célokhoz. Alapértelmezett érték: `_AzureBlob_`.

inputs.storageType

A bemeneti dokumentumok tárolási entitásának definíciója.

Kulcsparaméter	Típus	Kötelező	Kérelemparaméterek	Leírás
inputs.storageType	`string`	Hamis	•`Folder` • `File`	A bemeneti dokumentumok forrássztringjének tárolási típusa. Csak a "Mappa" vagy a "Fájl" érték érvényes.

Beállítások

A bemeneti kötegfordítási kérelem definíciója.

Kulcsparaméter	Típus	Kötelező	Kérelemparaméterek	Leírás
Lehetőségek	`object`	Hamis	Bemeneti dokumentumok forrásadatai.
options.experimental	`boolean`	Hamis	•`true` • `false`	Azt jelzi, hogy a kérelem tartalmaz-e kísérleti funkciót (ha van ilyen). Csak a logikai értékek `true` vagy `false` az érvényes értékek.

Példa kérésre:

Az alábbiakban példákat láthat a kötegkérelmekre.

Feljegyzés

Az alábbi példákban korlátozott hozzáférés lett engedélyezve egy Azure Storage-tároló tartalmához egy közös hozzáférésű jogosultságkód (SAS) jogkivonat használatával.

Az összes dokumentum fordítása egy tárolóban

{
    "inputs": [
        {
            "source": {
                "sourceUrl": "https://my.blob.core.windows.net/source-en?sv=2019-12-12&st=2021-03-05T17%3A45%3A25Z&se=2021-03-13T17%3A45%3A00Z&sr=c&sp=rl&sig=SDRPMjE4nfrH3csmKLILkT%2Fv3e0Q6SWpssuuQl1NmfM%3D"
            },
            "targets": [
                {
                    "targetUrl": "https://my.blob.core.windows.net/target-fr?sv=2019-12-12&st=2021-03-05T17%3A49%3A02Z&se=2021-03-13T17%3A49%3A00Z&sr=c&sp=wdl&sig=Sq%2BYdNbhgbq4hLT0o1UUOsTnQJFU590sWYo4BOhhQhs%3D",
                    "language": "fr"
                }
            ]
        }
    ]
}

Szószedeteket alkalmazó tároló összes dokumentumának fordítása

{
    "inputs": [
        {
            "source": {
                "sourceUrl": "https://my.blob.core.windows.net/source-en?sv=2019-12-12&st=2021-03-05T17%3A45%3A25Z&se=2021-03-13T17%3A45%3A00Z&sr=c&sp=rl&sig=SDRPMjE4nfrH3csmKLILkT%2Fv3e0Q6SWpssuuQl1NmfM%3D"
            },
            "targets": [
                {
                    "targetUrl": "https://my.blob.core.windows.net/target-fr?sv=2019-12-12&st=2021-03-05T17%3A49%3A02Z&se=2021-03-13T17%3A49%3A00Z&sr=c&sp=wdl&sig=Sq%2BYdNbhgbq4hLT0o1UUOsTnQJFU590sWYo4BOhhQhs%3D",
                    "language": "fr",
                    "glossaries": [
                        {
                            "glossaryUrl": "https://my.blob.core.windows.net/glossaries/en-fr.xlf?sv=2019-12-12&st=2021-03-05T17%3A45%3A25Z&se=2021-03-13T17%3A45%3A00Z&sr=c&sp=rl&sig=BsciG3NWoOoRjOYesTaUmxlXzyjsX4AgVkt2AsxJ9to%3D",
                            "format": "xliff",
                            "version": "1.2"
                        }
                    ]

                }
            ]
        }
    ]
}

Adott mappa fordítása egy tárolóban

Győződjön meg arról, hogy a mappa nevét (kis- és nagybetűk megkülönböztetése) előtagként adja meg a szűrőben.

{
    "inputs": [
        {
            "source": {
                "sourceUrl": "https://my.blob.core.windows.net/source-en?sv=2019-12-12&st=2021-03-05T17%3A45%3A25Z&se=2021-03-13T17%3A45%3A00Z&sr=c&sp=rl&sig=SDRPMjE4nfrH3csmKLILkT%2Fv3e0Q6SWpssuuQl1NmfM%3D",
                "filter": {
                    "prefix": "MyFolder/"
                }
            },
            "targets": [
                {
                    "targetUrl": "https://my.blob.core.windows.net/target-fr?sv=2019-12-12&st=2021-03-05T17%3A49%3A02Z&se=2021-03-13T17%3A49%3A00Z&sr=c&sp=wdl&sig=Sq%2BYdNbhgbq4hLT0o1UUOsTnQJFU590sWYo4BOhhQhs%3D",
                    "language": "fr"
                }
            ]
        }
    ]
}

Adott dokumentum fordítása tárolóban

Adja meg a "storageType": Fileértéket.
Hozzon létre forrás URL- és SAS-jogkivonatot az adott blobhoz/dokumentumhoz.
Adja meg a célfájlnevet a cél URL-cím részeként – bár az SAS-jogkivonat továbbra is a tárolóhoz tartozik.

Ez a mintakérelem egyetlen dokumentumot jelenít meg két célnyelvre lefordítva.

{
    "inputs": [
        {
            "storageType": "File",
            "source": {
                "sourceUrl": "https://my.blob.core.windows.net/source-en/source-english.docx?sv=2019-12-12&st=2021-01-26T18%3A30%3A20Z&se=2021-02-05T18%3A30%3A00Z&sr=c&sp=rl&sig=d7PZKyQsIeE6xb%2B1M4Yb56I%2FEEKoNIF65D%2Fs0IFsYcE%3D"
            },
            "targets": [
                {
                    "targetUrl": "https://my.blob.core.windows.net/target/try/Target-Spanish.docx?sv=2019-12-12&st=2021-01-26T18%3A31%3A11Z&se=2021-02-05T18%3A31%3A00Z&sr=c&sp=wl&sig=AgddSzXLXwHKpGHr7wALt2DGQJHCzNFF%2F3L94JHAWZM%3D",
                    "language": "es"
                },
                {
                    "targetUrl": "https://my.blob.core.windows.net/target/try/Target-German.docx?sv=2019-12-12&st=2021-01-26T18%3A31%3A11Z&se=2021-02-05T18%3A31%3A00Z&sr=c&sp=wl&sig=AgddSzXLXwHKpGHr7wALt2DGQJHCzNFF%2F3L94JHAWZM%3D",
                    "language": "de"
                }
            ]
        }
    ]
}

Válaszállapot-kódok

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

Állapotkód	Leírás
202	Elfogadott. A sikeres kérés és a létrehozott kötegelt kérelem. A fejléc műveleti helye egy állapot URL-címét jelzi a műveletazonosító.HeadersOperation-Location: sztringgel
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.
429	A kérések aránya túl magas.
500	Belső kiszolgálóhiba.
503	A szolgáltatás jelenleg nem érhető el. Próbálkozzon újra később.
Egyéb állapotkódok	• Túl sok kérés • A kiszolgáló ideiglenesen nem érhető el

Hibaválasz

Kulcsparaméter	Típus	Leírás
code	`string`	Magas szintű hibakódokat tartalmazó enumerálások. Lehetséges értékek: InternalServerError InvalidArgument InvalidRequest RequestRateTooHigh ResourceNotFound ServiceUnavailable Nem engedélyezett
üzenet	`string`	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 a szükséges tulajdonságokat tartalmazza: ErrorCode, message, and optional properties target, details(key value pair) és inner error (ez beágyazható).
Belső. Hibakód	`string`	Kódhiba sztringet kap.
innerError.message	`string`	Magas szintű hibaüzenetet kap.
innerError.target	`string`	Lekéri a hiba forrását. Például az lenne `documents` , vagy `document id` ha a dokumentum érvénytelen lenne.

Példák

Példa a sikeres válaszra

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

A feladatazonosító a POST metódus válaszfejléc művelet-hely URL-értékében található. Az URL-cím utolsó paramétere a művelet feladatazonosítója (a következő sztring: "/operation/").

Operation-Location: https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55

Példa hibaválaszra

{
  "error": {
    "code": "ServiceUnavailable",
    "message": "Service is temporary unavailable",
    "innerError": {
      "code": "ServiceTemporaryUnavailable",
      "message": "Service is currently unavailable.  Please try again later"
    }
  }
}

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