Translator 3.0: BreakSentence
Určuje umístění hranic vět v části textu.
Adresa URL požadavku
Odešlete požadavek POST
do:
https://api.cognitive.microsofttranslator.com/breaksentence?api-version=3.0
VizVirtual Network Podpora pro konfiguraci a podporu vybrané sítě a privátního koncového bodu služby Translator.
Parametry požadavku
Parametry požadavku předávané řetězci dotazu jsou:
Parametr dotazu | Description |
---|---|
api-version | Povinný parametr dotazu. Verze rozhraní API vyžádaná klientem Hodnota musí být 3.0 . |
language | Volitelný parametr dotazu. Značka jazyka identifikující jazyk vstupního textu. Pokud kód není zadaný, použije se automatická detekce jazyka. |
script | Volitelný parametr dotazu. Značka skriptu identifikující skript použitý vstupním textem Pokud není zadaný skript, předpokládá se výchozí skript jazyka. |
Mezi hlavičky požadavků patří:
Hlavičky | Description |
---|---|
Hlavičky ověřování | Požadovaná hlavička požadavku. Projděte si dostupné možnosti ověřování. |
Typ obsahu | Požadovaná hlavička požadavku. Určuje typ obsahu datové části. Možné hodnoty jsou: application/json . |
Délka obsahu | Požadovaná hlavička požadavku. Délka textu požadavku. |
X-ClientTraceId | Volitelné. Identifikátor GUID vygenerovaný klientem pro jedinečnou identifikaci požadavku. Tuto hlavičku můžete vynechat, pokud do řetězce dotazu zahrnete ID trasování pomocí parametru dotazu s názvem ClientTraceId . |
Text požadavku
Text požadavku je pole JSON. Každý element pole je objekt JSON s vlastností řetězce s názvem Text
. Hranice vět se počítají pro hodnotu Text
vlastnosti. Ukázkový text požadavku s jednou částí textu vypadá takto:
[
{ "Text": "How are you? I am fine. What did you do today?" }
]
Platí následující omezení:
- Pole může mít maximálně 100 prvků.
- Textová hodnota prvku pole nesmí překročit 50 000 znaků včetně mezer.
- Celý text zahrnutý v požadavku nesmí být delší než 50 000 znaků včetně mezer.
language
Pokud je zadaný parametr dotazu, musí být všechny prvky pole ve stejném jazyce. V opačném případě se autodetection jazyka použije na každý prvek pole nezávisle.
Text odpovědi
Úspěšná odpověď je pole JSON s jedním výsledkem pro každý řetězec ve vstupním poli. Objekt výsledku obsahuje následující vlastnosti:
sentLen
: Pole celých čísel představující délky vět v elementu text. Délka matice je počet vět a hodnoty jsou délka každé věty.detectedLanguage
: Objekt popisující zjištěný jazyk prostřednictvím následujících vlastností:language
: Kód zjištěného jazyka.score
: Plovoucí hodnota označující spolehlivost výsledku. Skóre je mezi nulou (0) a 1 (1,0). Nízké skóre (<= 0,4) značí nízkou spolehlivost.
Vlastnost detectedLanguage
je ve výsledném objektu k dispozici pouze v případech, kdy je požadována automatická funkce jazyka.
Příklad odpovědi JSON:
[
{
"detectedLanguage": {
"language": "en",
"score": 1.0
},
"sentLen": [
13,
11,
22
]
}
]
Hlavičky odpovědi
Hlavičky | Description |
---|---|
X-RequestId | Hodnota vygenerovaná službou k identifikaci požadavku. Používá se pro účely řešení potíží. |
Stavové kódy odpovědí
Níže jsou uvedené možné stavové kódy HTTP, které požadavek vrátí.
Stavový kód | Description |
---|---|
200 | Úspěch. |
400 | Jeden z parametrů dotazu chybí nebo je neplatný. Před opakováním opravte parametry požadavku. |
401 | Požadavek nelze ověřit. Zkontrolujte, jestli jsou zadané a platné přihlašovací údaje. |
403 | Žádost není autorizovaná. Zkontrolujte chybovou zprávu s podrobnostmi. Tento kód odpovědi často značí, že všechny bezplatné překlady poskytované se zkušebním předplatným byly využity. |
429 | Server odmítl požadavek, protože klient překročil limity požadavků. |
500 | Došlo k neočekávané chybě. Pokud chyba přetrvává, nahlaste ji s datem a časem selhání, identifikátorem požadavku z hlavičky X-RequestId odpovědi a identifikátorem klienta z hlavičky X-ClientTraceId požadavku . |
503 | Server je dočasně nedostupný. Zkuste požadavek zopakovat. Pokud chyba přetrvává, nahlaste ji s datem a časem selhání, identifikátorem požadavku z hlavičky X-RequestId odpovědi a identifikátorem klienta z hlavičky X-ClientTraceId požadavku . |
Pokud dojde k chybě, požadavek vrátí chybovou odpověď JSON. Kód chyby je 6místné číslo, které kombinuje 3místný stavový kód HTTP následovaný 3místným číslem pro další kategorizaci chyby. Běžné kódy chyb najdete na referenční stránce služby Translator v3.
Příklady
Následující příklad ukazuje, jak získat hranice vět pro jednu větu. Služba automaticky rozpozná jazyk věty.
curl -X POST "https://api.cognitive.microsofttranslator.com/breaksentence?api-version=3.0" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json" -d "[{'Text':'How are you? I am fine. What did you do today?'}]"