SurveyJS Java Backend Integration with Spring Boot /

Translate with AI

Commercial AI Provider Required

Translate with AI

Translate form text with AI and let authors review the results. Your backend sends titles, choices, and other text to your chosen provider, keeping its API key on the server.

Documentation

Try this

  1. In the Translations tab, use Add Language to add another language. Click Auto-translate All beside a language, then again in the dialog to translate missing text.
  2. Review and edit the generated translations in the dialog, then click Apply to add them to the form. The sample already has a French title to demonstrate keeping existing translations.
  3. Changes are saved automatically after you click Apply. Reload the page to confirm the translations were saved.
  4. Open the Preview tab and use its language selector to view the translated form or compare it with the original.
  5. Open Requests to inspect the translation request and schema save.

SurveyJS commercial products require a developer license for production use. See SurveyJS Licensing for details.

Running main@d532820

    No requests

      What the server stored

      JSON definition · shared/definitions/ai-translation.json View on GitHub
      {
        "title": {
          "default": "Workshop registration",
          "fr": "Inscription à l'atelier"
        },
        "description": "Choose a session and leave your contact details",
        "elements": [
          {
            "type": "text",
            "name": "full_name",
            "title": "Full name",
            "isRequired": true
          },
          {
            "type": "text",
            "name": "email",
            "title": "Email address",
            "inputType": "email",
            "isRequired": true
          },
          {
            "type": "radiogroup",
            "name": "session",
            "title": "Preferred session",
            "isRequired": true,
            "choices": [
              {
                "value": "morning",
                "text": "Morning"
              },
              {
                "value": "afternoon",
                "text": "Afternoon"
              }
            ]
          }
        ]
      }
      Client · shared/client/ai-translation.js · sjs:ai-translation.client View on GitHub
      // Return translated strings in the original order, and always finish the callback
      creator.onMachineTranslate.add(async (_, options) => {
        showError("");
        try {
          const response = await fetch("/api/translate", {
            method: "POST", headers: { "Content-Type": "application/json" },
            body: JSON.stringify({ strings: options.strings, from: options.fromLocale, to: options.toLocale })
          });
          if (!response.ok) throw await responseError(response, "AI translation failed. Please try again.");
          const strings = await response.json();
          if (!Array.isArray(strings) || strings.length !== options.strings.length || strings.some(text => typeof text !== "string"))
            throw new Error("The translation provider returned an invalid result. Please try again.");
          options.callback(strings);
        } catch (error) {
          options.callback([]);
          showError(`${translationError(error)} Existing translations are kept.`);
          note(error.message, "error");
        }
      });
      Server · src/main/java/io/surveyjs/examples/AiTranslationController.java · sjs:ai-translation.server View on GitHub
      // POST /api/translate — strings in, translated strings out (same order); nothing goes to SurveyJS
      @PostMapping("/api/translate")
      public JsonNode translate(@RequestBody TranslateRequest body) {
          if (settings.aiApiKey() == null) {
              throw new ResponseStatusException(HttpStatus.NOT_IMPLEMENTED, "Set AI_API_KEY to enable translation");
          }
      
          JsonNode translated = ai.translate(body.strings(), body.from(), body.to());   // any OpenAI-compatible provider
          if (translated == null || !translated.isArray() || translated.size() != body.strings().size()
                  || !translated.valueStream().allMatch(JsonNode::isString)) {
              throw new ResponseStatusException(HttpStatus.BAD_GATEWAY, "The AI provider returned an unexpected answer");
          }
      
          return translated;   // what options.callback() takes
      }