Translator 3.0: Transliteracja
Konwertuje tekst w jednym języku z jednego skryptu na inny skrypt.
Adres URL żądania
Wyślij żądanie POST
do:
https://api.cognitive.microsofttranslator.com/transliterate?api-version=3.0
Zobacz Obsługa sieci wirtualnej dla wybranej sieci translator i konfiguracji prywatnego punktu końcowego oraz obsługi.
Parametry żądania
Parametry żądania przekazane w ciągu zapytania to:
Parametr zapytania | opis |
---|---|
api-version | Wymagany parametr. Wersja interfejsu API żądanego przez klienta. Wartość musi mieć wartość 3.0 . |
język | Wymagany parametr. Określa język tekstu, który ma być konwertowany z jednego skryptu na inny. Możliwe języki są wymienione w transliteration zakresie uzyskanym przez odpytywanie usługi pod kątem obsługiwanych języków. |
fromScript | Wymagany parametr. Określa skrypt używany przez tekst wejściowy. Wyszukaj obsługiwane języki przy użyciu transliteration zakresu, aby znaleźć skrypty wejściowe dostępne dla wybranego języka. |
toScript | Wymagany parametr. Określa skrypt wyjściowy. Wyszukaj obsługiwane języki przy użyciu transliteration zakresu, aby znaleźć skrypty wyjściowe dostępne dla wybranej kombinacji języka wejściowego i skryptu wejściowego. |
Nagłówki żądań obejmują:
Nagłówki | opis |
---|---|
Nagłówki uwierzytelniania | Wymagany nagłówek żądania. Zobacz dostępne opcje uwierzytelniania. |
Typ zawartości | Wymagany nagłówek żądania. Określa typ zawartości ładunku. Możliwe wartości to: application/json |
Długość zawartości | Opcjonalne. Długość treści żądania. |
X-ClientTraceId | Opcjonalne. Identyfikator GUID wygenerowany przez klienta w celu unikatowego zidentyfikowania żądania. Ten nagłówek można pominąć, jeśli dołączysz identyfikator śledzenia w ciągu zapytania przy użyciu parametru zapytania o nazwie ClientTraceId . |
Treść żądania
Treść żądania jest tablicą JSON. Każdy element tablicy jest obiektem JSON z właściwością ciągu o nazwie Text
, która reprezentuje ciąg do konwersji.
[
{"Text":"こんにちは"},
{"Text":"さようなら"}
]
Obowiązują następujące ograniczenia:
- Tablica może zawierać co najwyżej 10 elementów.
- Wartość tekstowa elementu tablicy nie może przekraczać 1000 znaków, w tym spacji.
- Cały tekst zawarty w żądaniu nie może przekraczać 5000 znaków, w tym spacji.
Treść odpowiedzi
Pomyślna odpowiedź to tablica JSON z jednym wynikiem dla każdego elementu w tablicy wejściowej. Obiekt wynikowy zawiera następujące właściwości:
text
: ciąg, który wynika z konwertowania ciągu wejściowego na skrypt wyjściowy.script
: ciąg określający skrypt używany w danych wyjściowych.
Przykładowa odpowiedź JSON to:
[
{"text":"konnnichiha","script":"Latn"},
{"text":"sayounara","script":"Latn"}
]
Nagłówki odpowiedzi
Nagłówki | opis |
---|---|
X-RequestId | Wartość wygenerowana przez usługę w celu zidentyfikowania żądania i użycia do celów rozwiązywania problemów. |
Kody stanu odpowiedzi
Poniżej przedstawiono możliwe kody stanu HTTP zwracane przez żądanie.
Kod stanu | opis |
---|---|
200 | Sukces. |
400 | Brakuje jednego z parametrów zapytania lub jest on nieprawidłowy. Popraw parametry żądania przed ponowną próbą. |
401 | Nie można uwierzytelnić żądania. Sprawdź, czy poświadczenia są określone i prawidłowe. |
403 | Żądanie nie jest autoryzowane. Sprawdź szczegóły komunikatu o błędzie. Ten kod często wskazuje, że są używane wszystkie bezpłatne tłumaczenia dostarczone z subskrypcją wersji próbnej. |
429 | Serwer odrzucił żądanie, ponieważ klient przekroczył limity żądań. |
500 | Wystąpił nieoczekiwany błąd. Jeśli błąd będzie się powtarzać, zgłoś go z: datą i godziną niepowodzenia, identyfikatorem żądania z nagłówka odpowiedzi i identyfikatorem klienta z nagłówka X-RequestId X-ClientTraceId żądania . |
503 | Serwer jest tymczasowo niedostępny. Ponów próbę żądania. Jeśli błąd będzie się powtarzać, zgłoś go z: datą i godziną niepowodzenia, identyfikatorem żądania z nagłówka odpowiedzi i identyfikatorem klienta z nagłówka X-RequestId X-ClientTraceId żądania . |
Jeśli wystąpi błąd, żądanie zwróci również odpowiedź o błędzie JSON. Kod błędu to 6-cyfrowy numer łączący 3-cyfrowy kod stanu HTTP, po którym następuje 3-cyfrowy numer w celu dalszego kategoryzowania błędu. Typowe kody błędów można znaleźć na stronie dokumentacji usługi Translator w wersji 3.
Przykłady
W poniższym przykładzie pokazano, jak przekonwertować dwa japońskie ciągi na z romanyzowany japoński.
Ładunek JSON dla żądania w tym przykładzie:
[{"text":"こんにちは","script":"jpan"},{"text":"さようなら","script":"jpan"}]
Jeśli używasz biblioteki cURL w oknie wiersza polecenia, które nie obsługuje znaków Unicode, użyj następującego ładunku JSON i zapisz go w pliku o nazwie request.txt
. Pamiętaj, aby zapisać plik z UTF-8
kodowaniem.
curl -X POST "https://api.cognitive.microsofttranslator.com/transliterate?api-version=3.0&language=ja&fromScript=Jpan&toScript=Latn" -H "X-ClientTraceId: 875030C7-5380-40B8-8A03-63DACCF69C11" -H "Ocp-Apim-Subscription-Key: <client-secret>" -H "Content-Type: application/json" -d @request.txt