BatchTranslateRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/itsbaba-com/json-schema/itsbaba-com-batch-translate-request-schema.json",
  "title": "BatchTranslateRequest",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/hc-openapi.json#/components/schemas/BatchTranslateRequest",
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 5000
      },
      "minItems": 1,
      "maxItems": 50,
      "description": "1 to 50 strings, each up to 5,000 characters. A protected batch carries at most 20,000 characters in total."
    },
    "target_lang": {
      "type": "string",
      "description": "BCP 47 target language, applied to every item."
    },
    "source_lang": {
      "type": "string",
      "description": "BCP 47 source language, or `auto` (default)."
    },
    "transliterate": {
      "type": "boolean",
      "default": false,
      "description": "Include a Latin transliteration when the target is Hebrew."
    },
    "quality": {
      "type": "string",
      "enum": [
        "fast",
        "balanced",
        "smartest"
      ],
      "default": "balanced",
      "description": "Quality tier, applied to every item."
    },
    "gender": {
      "type": "string",
      "enum": [
        "male",
        "female",
        "general"
      ],
      "description": "Grammatical gender for the reader where the target language marks it."
    },
    "message_format": {
      "type": "string",
      "enum": [
        "icu"
      ],
      "description": "`icu`: every item is an ICU MessageFormat message. Each result is a valid ICU message in the target language: arguments ({name}, {count, number}, {d, date, short}) and `#` are kept, plural and selectordinal branches are rewritten for the target language's CLDR categories (Hebrew one, two, other; Russian one, few, many, other; English one, other; exact matches such as =0 kept), and select keys are kept. A plural or select inside a sentence is moved to the top so every branch is a whole sentence; `protection.segments` lists each branch sentence. Always protected; Hebrew, English and Russian. Invalid ICU returns 400 `invalid_message_format`; a message that cannot be verified comes back unchanged with `protection.status: \"fallback\"`."
    },
    "protect": {
      "type": "boolean",
      "description": "Keep prices, quantities, numbers, dates, codes, identifiers, product names, interface variables ({name}, %s) and <keep>…</keep> text exactly as written, and verify every sentence. Implied by any protection field. Hebrew, English and Russian. Account terms switch it on automatically for these pairs."
    },
    "domain": {
      "type": "string",
      "enum": [
        "general",
        "clinical",
        "finance",
        "legal"
      ],
      "description": "`general` (default) for product, commerce, support and interface text. `clinical` adds clinical register and drug, dose, lab and abbreviation detection. `finance` adds a formal banking register, protects IBANs, SWIFT/BIC codes, bank account numbers (including Israeli bank-branch-account), Israeli ID numbers and card numbers (check digits verified; these values are never shown to the model), invoice, policy and transaction references, signed amounts, rates and basis points, and checks that every money direction (credit/debit, deposit/withdrawal, buy/sell, increase/decrease, gain/loss, who owes whom) is kept. `legal` adds a formal legal register, protects clause and section references (Section 4.2, Clause 7(b), סעיף 12(א), § 3) and case and statute citations, renders each defined term (\"the Company\") the same way throughout, and checks that modality (shall, may, shall not, is not required to) is kept. Any value implies `protect`."
    },
    "audience": {
      "type": "string",
      "enum": [
        "clinician",
        "patient"
      ],
      "description": "Clinical domain register. `clinician` (default) keeps shorthand such as BID and PO; `patient` writes it as plain words."
    },
    "protected_terms": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 500,
      "description": "Terms kept exactly as written: product names, brand names, SKUs. Up to 500, each up to 200 characters. Added to the account terms list for this request."
    },
    "redact_terms": {
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "maxItems": 200,
      "description": "Kept exactly and never shown to the model: customer names and other personal data. Up to 200."
    },
    "glossary": {
      "type": "object",
      "additionalProperties": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200
      },
      "description": "Source term → required rendering in the target language. Up to 500 entries. Wins over an account term with the same text."
    },
    "listener_gender": {
      "type": "string",
      "enum": [
        "male",
        "female"
      ],
      "description": "Gender of the reader (\"you\"): תרצי / תרצה. Hebrew and Russian mark it; English does not. Without it, Hebrew interface text uses neutral forms."
    },
    "speaker_gender": {
      "type": "string",
      "enum": [
        "male",
        "female"
      ],
      "description": "Gender of the speaker (\"I\"), for an assistant or brand voice: מצאתי, я нашла / я нашёл."
    },
    "patient_gender": {
      "type": "string",
      "enum": [
        "male",
        "female"
      ],
      "description": "Clinical domain: gender of a patient referred to in the third person."
    },
    "date_order": {
      "type": "string",
      "enum": [
        "MDY",
        "DMY"
      ],
      "description": "How to read ambiguous numeric dates such as 04/03/2026. Default MDY for English sources, DMY for Hebrew and Russian."
    },
    "date_style": {
      "type": "string",
      "enum": [
        "hebrew",
        "iso",
        "keep"
      ],
      "description": "`hebrew` (default) spells the month out in the target language (\"4 במרץ 2026\", \"4 марта 2026 г.\"); `iso`; `keep` (unambiguous dates only)."
    },
    "bidi": {
      "type": "string",
      "enum": [
        "isolate",
        "none"
      ],
      "description": "`isolate` wraps protected values in Unicode isolates in Hebrew output. Default none; see /v1/wrap."
    }
  },
  "required": [
    "items",
    "target_lang"
  ]
}