Dokumentacja

WYJERNIE API

Uprość i przetłumacz treść na 24 języki wyjściowe.

Synchroniczny punkt końcowy akceptuje tekst źródłowy, wyjściowe ustawienia regionalne i jeden z dwóch trybów. Automatycznie wykrywa język źródłowy i zwraca gotowy do użycia wynik w wybranym języku wyjściowym.

{
  "text": "Kompleksowa treść źródłowa w wybranym języku.",
  "locale": "pl",
  "mode": "simple-language"
}

Dostępne przykłady SDK i cURL

Wynik końcowy

POST /api/v2/translate

Utwórz jeden wynik w języku Plain Language lub Easy Language i zwróć go w tej samej odpowiedzi HTTP.

Wymagane nagłówki

WpisWymógCelem
AuthorizationBearer <API_KEY>Uwierzytelnia projekt przy użyciu bieżącego schematu nośnika HTTP
Content-Typewniosek/jsonOświadcza format składu wniosku
Acceptwniosek/jsonWymaganie odpowiedzi JSON
Idempotency-KeyWymagane tylko w przypadku zadań i partiiZapobiega tworzeniu się duplikatów pracy przy powtarzających się, asynchronicznych zgłoszeniach

Organ wnioskowy

Żadne inne ustawienie treści nie jest częścią schematu żądania publicznego.

PołowoTypWymaganeWartość dopuszczalnaOpis
textwiersz- Tak .Od 1 do 10 000 znaków UnicodeZawartość źródła w wybranej lokalizacji
localewiersz- Tak .Jeden z 24 obsługiwanych kodów dwu liternychJęzyk wyjściowy. Język źródłowy jest wykrywany automatycznie.
modewiersz- Tak .Prosta, łatwa.Tryb uproszczenia
json
{
  "text": "Applicants must provide the required documentation before the deadline.",
  "locale": "en",
  "mode": "easy-language"
}

Organ odpowiedzi

Odpowiedź nie może zawierać wycofanych ustawień żądań ani oddzielnej tablicy informacji o jakości.

PołowoTypOpis
requestIdwierszUnikalny identyfikator wsparcia i dzienników
localewierszWybrane ustawienia regionalne wyjścia
modewierszWybrany tryb uproszczenia
outputwierszGotowy wynik w wybranych ustawieniach wyjściowych
usage.inputCharactersliczba całaZnaki zliczone dla tego żądania lub 0 dla trafienia w pamięci podręcznej
usage.cacheHitwartość logicznaCzy wynik pochodzi z 30-dniowej pamięci podręcznej
json
{
  "requestId": "req_sync_002",
  "locale": "en",
  "mode": "easy-language",
  "output": "You need to send documents.\nSend the documents before the deadline.",
  "usage": {
    "inputCharacters": 78,
    "cacheHit": false
  }
}

Zachowanie w zakresie weryfikacji

  • Brak tekstu: odrzucić z udokumentowanym błędem pola.
  • Puste tekst: odrzucić z udokumentowanym błędem pola.
  • Niepodpanowana lokalizacja: odrzuć; nigdy nie zastępuj w milczeniu innej lokalizacji.
  • Niepodparty tryb: odrzuć; nigdy nie wybieraj tryb automatycznie.
  • Nieznane pole zmarne: odrzucić błędem zwrotnym na migrację lub obsługiwać tylko poprzez wyraźnie wprowadzoną wersję warstwy zgodności.
  • Tekst źródłowy może używać języka innego niż lokalne. Simple8 automatycznie wykrywa język źródłowy i zapisuje wynik w wybranych ustawieniach wyjściowych.