Zahájení překladu

Pomocí tohoto rozhraní API můžete ve službě překladu dokumentů zahájit žádost o překlad. Každý požadavek může obsahovat více dokumentů a musí obsahovat zdrojový a cílový kontejner pro každý dokument.

Filtr předpon a přípon (pokud je zadaný) se používá k filtrování složek. Předpona se použije na dílčí cesta za názvem kontejneru.

Glosáře / Paměť překladu může být součástí požadavku a služba je použije při překladu dokumentu.

Pokud je glosář během překladu neplatný nebo nedostupný, ve stavu dokumentu se zobrazí chyba. Pokud v cíli již existuje soubor se stejným názvem, úloha selže. TargetUrl pro každý cílový jazyk musí být jedinečný.

Adresa URL požadavku

Odešlete POST požadavek na:

POST https://<NAME-OF-YOUR-RESOURCE>.cognitiveservices.azure.com/translator/text/batch/v1.0/batches

Zjistěte, jak najít vlastní název domény.

Důležité

  • Všechny požadavky rozhraní API na službu překladu dokumentů vyžadují vlastní koncový bod domény.
  • Ke požadavkům HTTP na překlad dokumentů nemůžete použít koncový bod, který najdete na stránce klíčů Azure Portal prostředku a koncového bodu, ani globálního koncového bodu api.cognitive.microsofttranslator.com překladače.

Hlavičky požadavku

Hlavičky požadavku jsou:

Hlavičky Description
Ocp-Apim-Subscription-Key Požadovaná hlavička požadavku

Text žádosti: Žádost o odeslání dávky

Název Typ Description
Vstupy BatchRequest[] BatchRequest je uvedený níže. Vstupní seznam dokumentů nebo složek obsahujících dokumenty. Typy médií: "application/json", "text/json", "application/*+json".

Vstupy

Definice pro vstupní požadavek dávkového překladu.

Název Typ Vyžadováno Popis
source SourceInput[] Ano Inputs.source je uvedený níže. Zdroj vstupních dokumentů
storageType (typ úložiště) StorageInputType[] Ne Inputs.storageType je uvedeno níže. Storage typu zdrojového řetězce vstupních dokumentů. Vyžaduje se jenom pro překlad jednoho dokumentu.
Cíle TargetInput[] Ano Inputs.target je uvedeno níže. Umístění cíle pro výstup.

inputs.source

Zdroj vstupních dokumentů

Název Typ Vyžadováno Popis
filter DocumentFilter[] Ne DocumentFilter[] je uvedený níže.
filter.prefix řetězec Ne Řetězec předpony rozlišují malá a velká písmena pro filtrování dokumentů ve zdrojové cestě pro překlad. Pokud například používáte identifikátor URI objektu blob úložiště Azure, použijte předponu k omezení podsložek pro překlad.
filter.suffix řetězec Ne Řetězec přípony rozlišují 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ů.
language řetězec Ne Kód jazyka Pokud není zadán žádný, provedeme v dokumentu automatickou detekci.
vlastnost sourceUrl řetězec True Umístění složky, kontejneru nebo jednoho souboru s dokumenty.
zdroj úložiště Zdroj úložiště Ne StorageSource je uvedený níže.
storageSource.AzureBlob řetězec Ne

inputs.storageType

Storage typu zdrojového řetězce vstupních dokumentů.

Název Typ
– soubor řetězec
Složky řetězec

inputs.target

Cíl dokončených přeložených dokumentů

Název Typ Vyžadováno Popis
category řetězec Ne Kategorie/vlastní systém pro požadavek na překlad
glossaries Glosář [] Ne Glosář uvedený níže. Seznam glosáře
Glossaries. Format řetězec Ne Formátovat.
glossaries.glossaryUrl řetězec True (Pokud používáte Glossaries) Umístění glosáře. Použijeme příponu souboru k extrakci formátování, pokud není zadán parametr format. Pokud se dvojice jazyk překladu v glosáři nenachází, nebude použita.
glossaries.storageSource StorageSource Ne StorageSource uvedené výš.
Glossaries. Version řetězec Ne Volitelná verze. Pokud není zadaný, použije se výchozí.
targetUrl řetězec True Umístění složky nebo kontejneru do vašich dokumentů.
language řetězec True Kód cílového jazyka se dvěma písmeny. Podívejte se na seznam kódů jazyka.
storageSource StorageSource [] Ne StorageSource [] je uveden výše.

Příklad požadavku

Následují příklady požadavků Batch.

Překlad všech dokumentů v kontejneru

{
    "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"
                }
            ]
        }
    ]
}

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

Ujistěte se, že jste vytvořili adresu URL glosáře & token SAS pro konkrétní objekt BLOB nebo dokument (ne pro kontejner).

{
    "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"
                        }
                    ]

                }
            ]
        }
    ]
}

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

Ujistěte se, že jste zadali název složky (rozlišuje velká a malá písmena) jako předponu ve filtru – i když je token SAS pro kontejner stále k dispozici.

{
    "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"
                }
            ]
        }
    ]
}

Překlad konkrétního dokumentu v kontejneru

  • Ujistěte se, že jste zadali "storageType": "File"
  • Ujistěte se, že jste vytvořili zdrojovou adresu URL & token SAS pro konkrétní objekt BLOB nebo dokument (ne pro kontejner).
  • Ujistěte se, že jste zadali název cílového souboru jako součást cílové adresy URL – i když je token SAS pro kontejner stále k dispozici.
  • Vzorový požadavek níže ukazuje jeden dokument, který je 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?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"
                }
            ]
        }
    ]
}

Stavové kódy odpovědí

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

Stavový kód Description
202 Přijata. Úspěšná žádost a služba vytvoří požadavek Batch. Operation-Location hlaviček bude označovat adresu URL stavu s ID operace. HeadersOperation-Location: String
400 Chybný požadavek. Neplatný požadavek Ověřte vstupní parametry.
401 Přístupu. Zkontrolujte prosím své přihlašovací údaje.
429 Frekvence požadavků je příliš vysoká.
500 Došlo k vnitřní chybě serveru.
503 Služba není momentálně k dispozici. Zkuste to později.
Další stavové kódy
  • Příliš mnoho žádostí
  • Server je dočasně nedostupný.

Chybová odezva

Název Typ Description
kód řetězec Výčty obsahující chybové kódy vysoké úrovně. Možné hodnoty:
  • InternalServerError
  • InvalidArgument
  • InvalidRequest
  • RequestRateTooHigh
  • ResourceNotFound
  • ServiceUnavailable
  • Neautorizováno
zpráva řetězec Získá chybovou zprávu vysoké úrovně.
innerError InnerTranslationError Nový formát vnitřních chyb, který odpovídá Cognitive Services API Guidelines. Obsahuje požadované vlastnosti ErrorCode, zprávy a volitelné vlastnosti cíl, details(pár klíč-hodnota), vnitřní chyba (to může být vnořené).
Vnitřní. Errorcode řetězec Získá řetězec chyby kódu.
innerError.message řetězec Získá chybovou zprávu vysoké úrovně.
innerError.target řetězec Získá zdroj chyby. V případě neplatného dokumentu by to byl například "documents" nebo "document id".

Příklady

Příklad úspěšné odpovědi

V úspěšné odpovědi se vrátí následující informace.

ID úlohy najdete v hlavičce odpovědi metody POST Operation-Location URL. Posledním parametrem adresy URL je ID úlohy operace (řetězec za /operation/).

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

Příklad chybové odpovědi

{
  "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žívání překladu dokumentů a klientské knihovny najdete v našem rychlém startu.