Translator 3.0: Przerwanie

Artykuł
09/02/2024

Określa położenie granic zdań w tekście.

Adres URL żądania

Wyślij żądanie POST do:

https://api.cognitive.microsofttranslator.com/breaksentence?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:

Parametry zapytania	opis
wersja interfejsu API	Wymagany parametr zapytania. Wersja interfejsu API żądanego przez klienta. Wartość musi mieć wartość `3.0`.
język	Opcjonalny parametr zapytania. Tag języka identyfikujący język tekstu wejściowego. Jeśli kod nie zostanie określony, zostanie zastosowane automatyczne wykrywanie języka.
skrypt	Opcjonalny parametr zapytania. Tag skryptu identyfikujący skrypt używany przez tekst wejściowy. Jeśli skrypt nie zostanie określony, przyjmuje się domyślny skrypt języka.

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. Granice zdań są obliczane dla wartości Text właściwości. Przykładowa treść żądania z jednym fragmentem tekstu wygląda następująco:

[
    { "Text": "How are you? I am fine. What did you do today?" }
]

Obowiązują następujące ograniczenia:

Tablica może zawierać co najwyżej 100 elementów.
Wartość tekstowa elementu tablicy nie może przekraczać 50 000 znaków, w tym spacji.
Cały tekst zawarty w żądaniu nie może przekraczać 50 000 znaków, w tym spacji.
language Jeśli określono parametr zapytania, wszystkie elementy tablicy muszą być w tym samym języku. W przeciwnym razie autodetection języka jest stosowana do każdego elementu tablicy niezależnie.

Treść odpowiedzi

Pomyślna odpowiedź to tablica JSON z jednym wynikiem dla każdego ciągu w tablicy wejściowej. Obiekt wynikowy zawiera następujące właściwości:

sentLen: tablica liczb całkowitych reprezentujących długości zdań w elemencie tekstowym. Długość tablicy to liczba zdań, a wartości są długością każdego zdania.
detectedLanguage: Obiekt opisujący wykryty język za pomocą następujących właściwości:
- language: kod wykrytego języka.
- score: wartość zmiennoprzecinkowa wskazująca pewność wyniku. Wynik wynosi od zera (0) do jednego (1,0). Niski wynik (<= 0,4) wskazuje niską pewność siebie.

Właściwość detectedLanguage jest obecna tylko w obiekcie wynikowym, gdy zażądano autodetection języka.

Przykładowa odpowiedź JSON to:

[
    {
        "detectedLanguage": {
            "language": "en",
            "score": 1.0
        },
        "sentLen": [
            13,
            11,
            22
        ]
    }
]

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 odpowiedzi 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-RequestIdX-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-RequestIdX-ClientTraceId`żądania .

Jeśli wystąpi błąd, żądanie zwraca odpowiedź błędu 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 uzyskać granice zdań dla pojedynczego zdania. Usługa automatycznie wykrywa język zdań.

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?'}]"

Udostępnij za pośrednictwem