Translator v3.0

Co je nového

Verze 3 Translator poskytuje moderní webové rozhraní API založené na JSON. Zlepšuje použitelnost a výkon tím, že konsoliduje stávající funkce do menšího počtu operací a poskytuje nové funkce.

  • Transkliterace pro převod textu v jednom jazyce z jednoho skriptu do jiného.
  • Překlad do více jazyků v jednom požadavku.
  • Rozpoznávání, překlad a transkliterace jazyka v jednom požadavku.
  • Slovník pro vyhledání alternativních překladů termínů, aby bylo možné najít zpětná překlady a příklady znázorňující termíny používané v kontextu.
  • Informativnější výsledky rozpoznávání jazyka

Základní adresy URL

Žádosti o Translator jsou ve většině případů zpracovávány datovým centrem, které je nejblíže místa, odkud žádost pochází. Pokud při použití globálního koncového bodu dojde k selhání datacentra, požadavek může být směrován mimo zeměpisnou oblast.

Pokud chcete vynutit zpracování požadavku v rámci konkrétní geografické oblasti, použijte požadovaný geografický koncový bod. Všechny žádosti se zpracovávají v datových centrech v rámci zeměpisné oblasti.

Geografie Základní adresa URL (geografický koncový bod) Datová centra
Globální (neregionální) api.cognitive.microsofttranslator.com Nejbližší dostupné datové centrum
Asie a Tichomoří api-apc.cognitive.microsofttranslator.com Jižní Korea – jih, Japonsko – východ, Jihovýchodní Asie a Austrálie – východ
Evropa api-eur.cognitive.microsofttranslator.com Severní Evropa, Západní Evropa
USA api-nam.cognitive.microsofttranslator.com USA – východ, USA – středojih, USA – středozápad a USA – západ 2

1 Zákazníci s prostředky nacházejícími se ve Švýcarskou – sever nebo Švýcarsko – západ mohou zajistit, aby se jejich požadavky rozhraní TEXT API dosloužily ve Švýcarskou. Pokud chcete zajistit zpracování požadavků ve Švýcarskou, vytvořte prostředek Translator v oblasti prostředků Severní Švýcarsko nebo Švýcarsko – západ a pak v požadavcích rozhraní API použijte vlastní koncový bod prostředku. Příklad: Pokud vytvoříte prostředek Translator v nástroji Azure Portal s oblastí prostředků jako "Švýcarsko – sever" a názvem vašeho prostředku je my-ch-n, pak je váš vlastní koncový bod https://my-ch-n.cognitiveservices.azure.com " " . A ukázkový požadavek na překlad je:

// Pass secret key and region using headers to a custom endpoint
curl -X POST " my-ch-n.cognitiveservices.azure.com/translator/text/v3.0/translate?to=fr" \
-H "Ocp-Apim-Subscription-Key: xxx" \
-H "Ocp-Apim-Subscription-Region: switzerlandnorth" \
-H "Content-Type: application/json" \
-d "[{'Text':'Hello'}]" -v

2 Vlastní Translator nejsou aktuálně k dispozici ve Švýcarskou.

Authentication

Přihlaste se Translator nebo Cognitive Services více služeb v Azure Cognitive Services a k ověření použijte svůj klíč předplatného (k dispozici v Azure Portal).

K ověření předplatného můžete použít tři hlavičky. Tato tabulka popisuje, jak se jednotlivé funkce používají:

Hlavičky Description
Ocp-Apim-Subscription-Key S předplatným Cognitive Services použijte , pokud předáváte tajný klíč.
Hodnota je tajný klíč Azure, který má vaše předplatné Translator.
Autorizace S předplatným Cognitive Services, pokud předáváte ověřovací token.
Hodnota je Bearer token: Bearer <token> .
Ocp-Apim-Subscription-Region Použijte s Cognitive Services více služeb a oblastní překladač.
Hodnota je oblast prostředku více služeb nebo oblastní překladač. Tato hodnota je při použití globálního prostředku překladače volitelná.

Tajný klíč

První možností je ověření pomocí Ocp-Apim-Subscription-Key hlavičky . Přidejte Ocp-Apim-Subscription-Key: <YOUR_SECRET_KEY> do požadavku hlavičku .

Ověřování pomocí globálního prostředku

Když použijete prostředek globálního překladače, je potřeba zahrnout jednu hlavičku pro volání Translator.

Hlavičky Description
Ocp-Apim-Subscription-Key Hodnota je tajný klíč Azure, který má vaše předplatné Translator.

Tady je příklad požadavku na volání Translator pomocí globálního prostředku překladače.

// Pass secret key using headers
curl -X POST "https://api.cognitive.microsofttranslator.com/translate?api-version=3.0&to=es" \
     -H "Ocp-Apim-Subscription-Key:<your-key>" \
     -H "Content-Type: application/json" \
     -d "[{'Text':'Hello, what is your name?'}]"

Ověřování pomocí regionálního prostředku

Při použití zdroje regionálního překladače. Existují dvě hlavičky, které je třeba volat Translator.

Hlavičky Description
Ocp-Apim-Subscription-Key Hodnota je tajný klíč Azure, který má vaše předplatné Translator.
Ocp-Apim-Subscription-Region Hodnota je oblast prostředku překladače.

Tady je příklad požadavku na volání Translator s využitím zdroje regionálního překladače.

// Pass secret key and region using headers
curl -X POST "https://api.cognitive.microsofttranslator.com/translate?api-version=3.0&to=es" \
     -H "Ocp-Apim-Subscription-Key:<your-key>" \
     -H "Ocp-Apim-Subscription-Region:<your-region>" \
     -H "Content-Type: application/json" \
     -d "[{'Text':'Hello, what is your name?'}]"

Ověřování pomocí prostředku s více službami

Když používáte prostředek služby Cognitive Service s více službami. To vám umožní použít jeden tajný klíč k ověřování požadavků na více služeb.

Pokud použijete tajný klíč více služeb, musíte do požadavku zahrnout dvě hlavičky ověřování. Existují dvě hlavičky, které je třeba volat Translator.

Hlavičky Description
Ocp-Apim-Subscription-Key Hodnota je tajný klíč Azure pro váš prostředek s více službami.
Ocp-Apim-Subscription-Region Hodnota je oblast prostředku s více službami.

Pro předplatné rozhraní Text API pro více služeb se vyžaduje oblast. Oblast, kterou vyberete, je jediná oblast, kterou můžete použít k překladu textu při použití klíče předplatného s více službami, a musí to být stejná oblast, kterou jste vybrali při přihlášení k předplatnému pro více služeb prostřednictvím Azure Portal.

Pokud předáte tajný klíč v řetězci dotazu s parametrem , musíte zadat Subscription-Key oblast pomocí parametru dotazu Subscription-Region .

Ověřování pomocí přístupového tokenu

Případně můžete tajný klíč vyměnit za přístupový token. Tento token je součástí každého požadavku jako Authorization hlavičky. Pokud chcete získat autorizační token, vytvořte POST požadavek na následující adresu URL:

Typ prostředku Adresa URL ověřovací služby
Globální https://api.cognitive.microsoft.com/sts/v1.0/issueToken
Regionální nebo více služeb https://<your-region>.api.cognitive.microsoft.com/sts/v1.0/issueToken

Tady jsou příklady požadavků na získání tokenu s tajným klíčem:

// Pass secret key using header
curl --header 'Ocp-Apim-Subscription-Key: <your-key>' --data "" 'https://api.cognitive.microsoft.com/sts/v1.0/issueToken'

// Pass secret key using query string parameter
curl --data "" 'https://api.cognitive.microsoft.com/sts/v1.0/issueToken?Subscription-Key=<your-key>'

Úspěšný požadavek vrátí kódovaný přístupový token jako prostý text v textu odpovědi. Platný token se předá službě Translator jako bearer token v autorizaci.

Authorization: Bearer <Base64-access_token>

Ověřovací token je platný po dobu 10 minut. Token by se měl znovu použít při více voláních do Translator. Pokud ale váš program po určitou dobu Translator požadavky na Translator, musí si program v pravidelných intervalech vyžádat nový přístupový token (například každých 8 minut).

Ověřování pomocí Azure Active Directory (Azure AD)

Translator verze 3.0 podporuje ověřování Azure AD, cloudové řešení Microsoftu pro správu identit a přístupu. Autorizační hlavičky umožňují službě Translator ověřit, že žádající klient má oprávnění k používání prostředku a k dokončení požadavku.

Požadavky

Hlavičky

Hlavička Hodnota
Autorizace Hodnota je přístupový token, který generuje Azure AD.
  • Bearer token poskytuje doklad o ověření a ověří autorizaci klienta k používání prostředku.
  • Ověřovací token je platný 10 minut a měl by se znovu použít při více voláních Translator.
  • Viz Ověřování pomocí přístupového tokenuvýše.
Ocp-Apim-Subscription-Region Hodnota je oblast prostředku překladače.
  • Tato hodnota je volitelná, pokud je prostředek globální.
Ocp-Apim-ResourceId Hodnota je ID prostředku vaší instance Translator prostředku.
  • ID prostředku najdete v části Azure Portal Translator Resource → Properties.
  • Formát ID prostředku:
    /subscriptions/<subscriptionId>/resourceGroups/<resourceGroupName>/providers/Microsoft.CognitiveServices/accounts/<resourceName>/
Translator stránky vlastností – Azure Portal

Snímek obrazovky Translator stránce vlastností v Azure Portal

Příklady

Použití globálního koncového bodu

 // Using headers, pass a bearer token generated by Azure AD, resource ID, and the region.

curl -X POST "https://api.cognitive.microsofttranslator.com/translator/text/v3.0/translate?api-version=3.0&to=es" \
     -H "Authorization: Bearer <Base64-access_token>"\
     -H "Ocp-Apim-ResourceId: <Resource ID>" \
     -H "Ocp-Apim-Subscription-Region: <your-region>" \
     -H "Content-Type: application/json" \
     -data-raw "[{'Text':'Hello, friend.'}]"

Použití vlastního koncového bodu

// Using headers, pass a bearer token generated by Azure AD.

curl -X POST https://<your-custom-domain>.cognitiveservices.azure.com/translator/text/v3.0/translate?api-version=3.0&to=es \
     -H "Authorization: Bearer <Base64-access_token>"\
     -H "Content-Type: application/json" \
     -data-raw "[{'Text':'Hello, friend.'}]"

Příklady použití spravovaných identit

Translator v3.0 také podporuje ověřování přístupu ke spravovaným identitám. Pokud je pro prostředek překladače povolená spravovaná identita, můžete v hlavičce požadavku předat nosný token vygenerovaný spravovanou identitou.

S globálním koncovým bodem

// Using headers, pass a bearer token generated either by Azure AD or Managed Identities, resource ID, and the region.

curl -X POST https://api.cognitive.microsofttranslator.com/translator/text/v3.0/translate?api-version=3.0&to=es \
     -H "Authorization: Bearer <Base64-access_token>"\
     -H "Ocp-Apim-ResourceId: <Resource ID>" \
     -H "Ocp-Apim-Subscription-Region: <your-region>" \
     -H "Content-Type: application/json" \
     -data-raw "[{'Text':'Hello, friend.'}]"

S vlastním koncovým bodem

//Using headers, pass a bearer token generated by Managed Identities.

curl -X POST https://<your-custom-domain>.cognitiveservices.azure.com/translator/text/v3.0/translate?api-version=3.0&to=es \
     -H "Authorization: Bearer <Base64-access_token>"\
     -H "Content-Type: application/json" \
     -data-raw "[{'Text':'Hello, friend.'}]"

Podpora virtuální sítě

Služba Translator je teď dostupná s funkcemi Virtual Network (VNET) ve všech oblastech veřejného cloudu Azure. Pokud chcete Virtual Network, podívejte se na téma Azure Cognitive Services virtuálních sítí.

Po zapnutí této funkce musíte vlastní koncový bod použít k volání Translator. Nemůžete použít globální koncový bod překladače ("api.cognitive.microsofttranslator.com") a nemůžete se ověřit pomocí přístupového tokenu.

Vlastní koncový bod najdete po vytvoření prostředku překladače a povolení přístupu z vybraných sítí a privátních koncových bodů.

Hlavičky Description
Ocp-Apim-Subscription-Key Hodnota je tajný klíč Azure, který má vaše předplatné Translator.
Ocp-Apim-Subscription-Region Hodnota je oblast prostředku překladače. Tato hodnota je volitelná, pokud je prostředek global

Tady je příklad požadavku na volání Translator pomocí vlastního koncového bodu.

// Pass secret key and region using headers
curl -X POST "https://<your-custom-domain>.cognitiveservices.azure.com/translator/text/v3.0/translate?api-version=3.0&to=es" \
     -H "Ocp-Apim-Subscription-Key:<your-key>" \
     -H "Ocp-Apim-Subscription-Region:<your-region>" \
     -H "Content-Type: application/json" \
     -d "[{'Text':'Hello, what is your name?'}]"

Chyby

Standardní chybová odpověď je objekt JSON s párem název/hodnota s názvem error . Hodnota je také objekt JSON s vlastnostmi:

  • code: Kód chyby definovaný serverem.
  • message: Řetězec, který poskytuje čitelné znázornění chyby.

Zákazníkovi s bezplatnou zkušební verzí předplatného se například po vyčerpání bezplatné kvóty zobrazí následující chyba:

{
  "error": {
    "code":403001,
    "message":"The operation is not allowed because the subscription has exceeded its free quota."
    }
}

Kód chyby je 6ciferné číslo kombinující 3místný stavový kód HTTP následovaný 3ciferným číslem pro další kategorizaci chyby. Běžné kódy chyb:

Kód Description
400000 Jeden ze vstupů požadavku není platný.
400001 Parametr scope je neplatný.
400002 Parametr "category" je neplatný.
400003 Specifikátor jazyka chybí nebo je neplatný.
400004 Chybí nebo je neplatný specifikátor cílového skriptu (Do skriptu).
400005 Vstupní text chybí nebo je neplatný.
400006 Kombinace jazyka a skriptu není platná.
400018 Chybí nebo je neplatný specifikátor zdrojového skriptu (Ze skriptu).
400019 Jeden ze zadaných jazyků se nepodporuje.
400020 Jeden z prvků v poli vstupního textu není platný.
400021 Parametr verze rozhraní API chybí nebo je neplatný.
400023 Jeden ze zadaných párů jazyků není platný.
400035 Pole zdrojového jazyka ("Od") není platné.
400036 Cílové pole jazyka ("Do") chybí nebo je neplatné.
400042 Jedna ze zadaných možností (pole Možnosti) není platná.
400043 ID trasování klienta (pole ClientTraceId nebo hlavička X-ClientTranceId) chybí nebo je neplatné.
400050 Vstupní text je příliš dlouhý. Zobrazit limity požadavků.
400064 Parametr "translation" chybí nebo je neplatný.
400070 Počet cílových skriptů (parametr ToScriptu) neodpovídá počtu cílových jazyků (parametr To).
400071 Hodnota není platná pro TextType.
400072 Pole vstupního textu má příliš mnoho prvků.
400073 Parametr skriptu je neplatný.
400074 Tělo požadavku není platný formát JSON.
400075 Kombinace jazyků a kategorií není platná.
400077 Překročila se maximální velikost požadavku. Zobrazit omezení požadavků.
400079 Vlastní systém požadovaný pro překlad mezi jazyky a a neexistuje.
400080 Pro jazyk nebo skript není podporováno překódování.
401000 Požadavek není autorizovaný, protože přihlašovací údaje chybí nebo jsou neplatné.
401015 "Poskytnuté přihlašovací údaje jsou určené pro rozhraní API pro rozpoznávání řeči. Tato žádost vyžaduje přihlašovací údaje pro rozhraní text API. K Translator použijte předplatné. "
403000 Tato operace není povolena.
403001 Operace není povolená, protože předplatné překročilo svoji kvótu Free.
405000 Metoda Request není pro požadovaný prostředek podporována.
408001 Připravuje se požadovaný systém překladu. Zkuste to znovu za několik minut.
408002 Při čekání na příchozí datový proud vypršel časový limit žádosti. Klient nevytvořil žádost v době, kdy byl server připraven čekat. Klient může požadavek zopakovat bez pozdějšího provedení změn.
415000 Hlavička Content-Type chybí nebo je neplatná.
429000, 429001, 429002 Server odmítl požadavek, protože klient překročil omezení požadavků.
500000 Došlo k neočekávané chybě. Pokud chyba přetrvává, ohlaste ji pomocí data a času chyby, identifikátor požadavku z hlavičky odpovědi X-RequestId a identifikátor klienta z hlavičky požadavku X-ClientTraceId.
503000 Služba je dočasně nedostupná. Opakujte. Pokud chyba přetrvává, ohlaste ji pomocí data a času chyby, identifikátor požadavku z hlavičky odpovědi X-RequestId a identifikátor klienta z hlavičky požadavku X-ClientTraceId.

Metriky

Metriky umožňují zobrazit informace o využití a dostupnosti překladatele v Azure Portal v části metriky, jak je znázorněno na následujícím snímku obrazovky. Další informace najdete v tématu metriky dat a platforem.

Translator Metriky

Tato tabulka uvádí dostupné metriky s popisem způsobu jejich použití pro monitorování volání rozhraní API pro překlad.

Metriky Description
TotalCalls Celkový počet volání rozhraní API.
TotalTokenCalls Celkový počet volání rozhraní API prostřednictvím služby tokenu pomocí ověřovacího tokenu
SuccessfulCalls Počet úspěšných volání.
TotalErrors Počet volání s chybovou odezvou.
BlockedCalls Počet volání, která překročily limit nebo kvótu.
ServerErrors Počet volání s interní chybou serveru (5XX).
ClientErrors Počet volání s chybou na straně klienta (4XX).
Latence Doba k dokončení žádosti v milisekundách
CharactersTranslated Celkový počet znaků v příchozím textovém požadavku.