Translator 3.0: BreakSentence
Identifikuje 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
Viz Podpora virtuální sítě pro vybranou službu Translator a konfiguraci a podporu privátního koncového bodu.
Parametry požadavku
Parametry požadavku předané v řetězci dotazu jsou:
Parametr dotazu | Popis |
---|---|
api-version | Povinný parametr dotazu. Verze rozhraní API požadovaného klientem Hodnota musí být 3.0 . |
jazyk | Volitelný parametr dotazu. Značka jazyka identifikující jazyk vstupního textu Pokud není zadaný kód, použije se automatické rozpoznávání jazyka. |
. | Volitelný parametr dotazu. Značka skriptu identifikující skript používaný vstupním textem Pokud není zadaný skript, předpokládá se výchozí skript jazyka. |
Hlavičky požadavku zahrnují:
Hlavičky | Popis |
---|---|
Hlavičky ověřování | Požadovaná hlavička požadavku. Podívejte se na 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 | Volitelné. 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ý prvek pole je objekt JSON s řetězcovou vlastností s názvem Text
. Hranice vět se počítají pro hodnotu Text
vlastnosti. Ukázkový text požadavku s jedním textem 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 obsažený v požadavku nesmí překročit 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. Výsledný objekt obsahuje následující vlastnosti:
sentLen
: Pole celých čísel představujících délky vět v textovém prvku. Délka pole je počet vět a hodnoty jsou délkou každé věty.detectedLanguage
: Objekt popisující rozpoznaný jazyk prostřednictvím následujících vlastností:language
: Kód zjištěného jazyka.score
: Hodnota float označující spolehlivost ve výsledku. Skóre je mezi nulou (0) a jedním (1,0). Nízké skóre (<= 0,4) označuje nízkou spolehlivost.
Vlastnost detectedLanguage
je přítomna pouze ve výsledném objektu, pokud je požadováno autodetection jazyka.
Příkladem odpovědi JSON je:
[
{
"detectedLanguage": {
"language": "en",
"score": 1.0
},
"sentLen": [
13,
11,
22
]
}
]
Hlavičky odpovědi
Hlavičky | Popis |
---|---|
X-RequestId | Hodnota vygenerovaná službou k identifikaci požadavku a použití 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í.
Kód stavu | Popis |
---|---|
200 | Akce byla úspěšná. |
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 | Požadavek není autorizovaný. Zkontrolujte chybovou zprávu s podrobnostmi. Tento kód odpovědi často označuje, že se používají všechny bezplatné překlady poskytnuté se zkušebním předplatným. |
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á, nahlašte 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á, nahlašte 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, aby se chyba dále kategorizovala. 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?'}]"