Spuštění dávkového překladu

Článek
09/26/2024

Referenční
funkce: Azure AI Translator → verze rozhraní API pro překlad
dokumentů: 2024-05-01
METODA HTTP: POST

Použijte metodu Start Translation k provedení asynchronní dávkového překladu požadavku.
Tato metoda vyžaduje účet služby Azure Blob Storage s kontejnery úložiště pro vaše zdrojové a přeložené dokumenty.

Adresa URL požadavku

Důležité

Všechny požadavky rozhraní API na funkci Překlad dokumentů vyžadují vlastní koncový bod domény umístěný na stránce přehledu prostředků na webu Azure Portal.

  curl -i -X POST "{document-translation-endpoint}/translator/document/batches?api-version={date}"

Záhlaví žádosti

Hlavičky požadavku jsou:

Hlavičky	Popis	Podmínka
Ocp-Apim-Subscription-Key	Klíč rozhraní API služby Translator z webu Azure Portal.	Povinní účastníci
Ocp-Apim-Subscription-Region	Oblast, ve které byl prostředek vytvořen.	Vyžaduje se při použití regionálního (geografického) prostředku, jako je USA – západ. & odrážka.
Typ obsahu	Typ obsahu datové části. Přijatá hodnota je application/json nebo charset=UTF-8.	Povinní účastníci

BatchRequest (tělo)

Každý požadavek může obsahovat více dokumentů a musí obsahovat zdrojový a cílový kontejner pro každý dokument. Typy zdrojových médií: application/json, application/*+jsontext/json.
Filtr předpony a přípony (pokud je zadán) slouží k filtrování složek. Předpona se použije na dílčí cestu za názvem kontejneru.
Do požadavku je možné zahrnout glosáře. Pokud je glosář během překladu neplatný nebo nedostupný, zobrazí se ve stavu dokumentu chyba.
Pokud v cílovém cíli již existuje soubor se stejným názvem, úloha selže.
Hodnota targetUrl pro každý cílový jazyk musí být jedinečná.


{
  "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.xlf",
              "format": "XLIFF",
              "version": "2.0",
              "storageSource": "AzureBlob"
            }
          ],
          "storageSource": "AzureBlob"
        }
      ],
      "storageType": "Folder"
    }
  ],
}

Vstupy

Definice vstupní dávkového překladu.

Klíčový parametr	Typ	Požaduje se	Parametry požadavku	Popis
vstupy	`array`	True	• zdroj (objekt) • cíle (pole) • storageType (řetězec)	Vstupní zdrojová data

inputs.source

Definice zdrojových dat

Klíčový parametr	Typ	Požaduje se	Parametry požadavku	Popis
inputs.source	`object`	True	• sourceUrl (string) • filtr (objekt) • jazyk (řetězec) • storageSource (řetězec)	Zdrojová data pro vstupní dokumenty
inputs.source.sourceUrl	`string`	True	•řetězec	Umístění kontejneru pro zdrojový soubor nebo složku
inputs.source.filter	`object`	False	• předpona (řetězec) • přípona (řetězec)	Řetězce citlivé na malá a velká písmena pro filtrování dokumentů ve zdrojové cestě.
inputs.source.filter.prefix	`string`	False	•řetězec	Řetězec předpony rozlišující malá a velká písmena pro filtrování dokumentů ve zdrojové cestě pro překlad. Často se používá k určení podsložek pro překlad. Příklad: FolderA.
inputs.source.filter.suffix	`string`	False	•řetězec	Řetězec přípony rozlišující malá a velká písmena pro filtrování dokumentů ve zdrojové cestě pro překlad. Nejčastěji se používá pro přípony souborů. Příklad: ".txt"
inputs.source.language	`string`	False	•řetězec	Kód jazyka pro zdrojové dokumenty. Pokud není zadáno, je implementováno automatické rozpoznávání.
inputs.source.storageSource	`string`	False	•řetězec	Zdroj úložiště pro vstupy Výchozí hodnota `AzureBlob`je .

vstupy.targets

Definice pro data cílových a glosářů

Klíčový parametr	Typ	Požaduje se	Parametry požadavku	Popis
vstupy.targets	`array`	True	• targetUrl (řetězec) • kategorie (řetězec) • jazyk (řetězec) • glosáře (pole) • storageSource (řetězec)	Cíle a data glosářů pro přeložené dokumenty
inputs.targets.targetUrl	`string`	True	•řetězec	Umístění umístění kontejneru pro přeložené dokumenty
inputs.targets.category	`string`	False	•řetězec	Klasifikace nebo kategorie žádosti o překlad Příklad: obecné.
inputs.targets.language	`string`	True	•řetězec	Kód cílového jazyka. Příklad: "fr".
inputs.targets.glossaries	`array`	False	• glosářUrl (řetězec) • formát (řetězec) • verze (řetězec) • storageSource (řetězec)	Viz Vytváření a používání glosářů
inputs.targets.glossaries.glossaryUrl	`string`	True (pokud používáte glosáře)	•řetězec	Umístění glosáře. Přípona souboru se používá k extrahování formátování, pokud není zadaný parametr formátu. Pokud pár jazyka překladu není v glosáři, nepoužije se.
inputs.targets.glossaries.format	`string`	False	•řetězec	Zadaný formát souboru pro glosář. Pokud chcete zkontrolovat, jestli je formát souboru podporovaný, přečtěte si článek Získání podporovaných formátů glosáře.
inputs.targets.glossaries.version	`string`	False	•řetězec	Indikátor verze Příklad: 2.0.
inputs.targets.glossaries.storageSource	`string`	False	•řetězec	Zdroj úložiště pro glosáře Výchozí hodnota `_AzureBlob_`je .
inputs.targets.storageSource	`string`	False	•řetězec	Zdroj úložiště pro targets.defaults na `_AzureBlob_`.

inputs.storageType

Definice entity úložiště pro vstupní dokumenty

Klíčový parametr	Typ	Požaduje se	Parametry požadavku	Popis
inputs.storageType	`string`	False	•`Folder` • `File`	Typ úložiště zdrojového řetězce vstupních dokumentů Platné hodnoty jsou pouze "Složka" nebo "Soubor".

Možnosti

Definice vstupní dávkového překladu.

Klíčový parametr	Typ	Požaduje se	Parametry požadavku	Popis
volby	`object`	False	Informace o zdroji pro vstupní dokumenty
options.experimental	`boolean`	False	•`true` • `false`	Určuje, jestli požadavek obsahuje experimentální funkci (pokud je k dispozici). Pouze logické `true` hodnoty nebo `false` jsou platné hodnoty.

Příklad požadavku

Tady jsou příklady dávkových požadavků.

Poznámka:

V následujících příkladech byl k obsahu kontejneru Azure Storage udělen omezený přístup pomocí tokenu sdíleného přístupového podpisu (SAS).

Překlad všech dokumentů v kontejneru

{
    "inputs": [
        {
            "source": {
                "sourceUrl": "https://my.blob.core.windows.net/source-en?{SAS-token-query-string}"
            },
            "targets": [
                {
                    "targetUrl": "https://my.blob.core.windows.net/target-fr?{SAS-token-query-string}",
                    "language": "fr"
                }
            ]
        }
    ]
}

Překlad všech dokumentů v kontejneru s použitím glosářů

{
    "inputs": [
        {
            "source": {
                "sourceUrl": "https://my.blob.core.windows.net/source-en?{SAS-token-query-string}"
            },
            "targets": [
                {
                    "targetUrl": "https://my.blob.core.windows.net/target-fr?{SAS-token-query-string}",
                    "language": "fr",
                    "glossaries": [
                        {
                            "glossaryUrl": "https://my.blob.core.windows.net/glossaries/en-fr.xlf?{SAS-token-query-string}",
                            "format": "xliff",
                            "version": "1.2"
                        }
                    ]

                }
            ]
        }
    ]
}

Překlad konkrétní složky v kontejneru

Ujistěte se, že jako předponu ve filtru zadáte název složky (rozlišují se malá a velká písmena).

{
    "inputs": [
        {
            "source": {
                "sourceUrl": "https://my.blob.core.windows.net/source-en?{SAS-token-query-string}",
                "filter": {
                    "prefix": "MyFolder/"
                }
            },
            "targets": [
                {
                    "targetUrl": "https://my.blob.core.windows.net/target-fr?{SAS-token-query-string}",
                    "language": "fr"
                }
            ]
        }
    ]
}

Překlad konkrétního dokumentu v kontejneru

Zadejte "storageType": File.
Vytvořte zdrojový token URL a SAS pro konkrétní objekt blob nebo dokument.
Jako součást cílové adresy URL zadejte cílový název souboru, i když token SAS je stále pro kontejner.

Tento ukázkový požadavek ukazuje jeden dokument přeložený do dvou cílových jazyků.

{
    "inputs": [
        {
            "storageType": "File",
            "source": {
                "sourceUrl": "https://my.blob.core.windows.net/source-en/source-english.docx?{SAS-token-query-string}"
            },
            "targets": [
                {
                    "targetUrl": "https://my.blob.core.windows.net/target/try/Target-Spanish.docx?{SAS-token-query-string}",
                    "language": "es"
                },
                {
                    "targetUrl": "https://my.blob.core.windows.net/target/try/Target-German.docx?{SAS-token-query-string}",
                    "language": "de"
                }
            ]
        }
    ]
}

Tip

Tato metoda vrátí parametr úlohy id pro řetězce dotazu get-translation-status, get-documents-status, get-document-status a cancel-translation request query string.

Úlohu id najdete v hodnotě adresy URL hlavičky Operation-Location odpovědi metody POSTstart-batch-translation. Alfanumerický řetězec za /document/ parametrem je úloha idoperace:

Hlavička odpovědi Adresa URL odpovědi

Umístění operace {document-translation-endpoint}/translator/document/9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec?api-version=2024-05-01
Můžete také použít požadavek get-translations-status k načtení seznamu úloh překladu a jejich idúloh.

Hlavička odpovědi	Adresa URL odpovědi
Umístění operace	{document-translation-endpoint}/translator/document/`9dce0aa9-78dc-41ba-8cae-2e2f3c2ff8ec`?api-version=2024-05-01

Stavové kódy odpovědí

Níže jsou uvedené možné stavové kódy HTTP, které požadavek vrátí.

Kód stavu	Popis
202	Přijal. Úspěšný požadavek a vytvořený dávkový požadavek Hlavička Operation-Location označuje stavovou adresu URL s id operace ID.HeadersOperation-Location: řetězec
400	Chybný požadavek. Neplatný požadavek. Zkontrolujte vstupní parametry.
401	Neautorizováno Zkontrolujte přihlašovací údaje.
429	Frekvence požadavků je příliš vysoká.
500	Vnitřní chyba serveru.
503	Služba je momentálně nedostupná. Zkuste to později.
Další stavové kódy	• Příliš mnoho požadavků. Server je dočasný nedostupný.

Chybná odpověď

Klíčový parametr	Typ	Popis
code	`string`	Výčty obsahující kódy chyb vysoké úrovně. Možné hodnoty:</br/>• InternalServerError • InvalidArgument • InvalidRequest • RequestRateTooHigh • ResourceNotFound • ServiceUnavailable• Neautorizováno
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) a inner error(může být vnořena).
vnitřní. Kód chyby	`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. Může to být `documents` například nebo `document id` pokud je dokument neplatný.

Příklad odpovědi na chybu

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

Další kroky

Další informace o použití překladu dokumentů a klientské knihovny najdete v našem rychlém startu.

Začínáme s překladem dokumentů

Sdílet prostřednictvím