topic.ai_translate - Fluid Topics - Latest

Fluid Topics Analytics Guide

Category
Reference Guides
Audience
public
Version
Latest

This web application event occurs when a topic translation is requested through the AI translate mechanism.

Field Description
sourceLanguage An object containing details about the original language of the document submitted for on-demand translation.
languageCode A two letter language code. For example fr.
countryCode A two letter country code. For example CA.
destinationLanguage An object containing details about the original language of the document submitted for on-demand translation.
languageCode A two letter language code. For example fr.
countryCode A two letter country code. For example CA. It is returned when the translation provider requires it as part of its translation parameter.
breadcrumb An object containing the list of topics leading to this topic in the document's table of contents. Each topic contains a tocId and title field.
tocId The topic's identifier based on its position in the document's table of contents.
title The topic's title
document An object containing information about the translated document.
id The document's unique identifier.
title The title of the document.
type The document's type. For example STRUCTURED_DOCUMENT.
metadata A list of the document's metadata, each containing the key, label, and values fields.
profileId The ID of the translation profile.

A table for the most common fields is in Analytics events.

Example:

[
  {
    "sourceLanguage": {
      "languageCode": "en",
      "countryCode": "US"
    },
    "destinationLanguage": {
      "languageCode": "bg",
      "countryCode": ""
    },
    "breadcrumb": [
      {
        "tocId": "8RvdIClEszmgJ0oDr",
        "title": "Latin languages"
      }
    ],
    "document": {
      "id": "8RvdIClEszmgJ0oDrCUABC",
      "title": "Book relative with lang and version switchable",
      "type": "STRUCTURED_DOCUMENT",
      "metadata": [
        {
          "key": "dataset",
          "label": "dataset",
          "values": [
            "test-switch-to-relative"
          ]
        }
      ]
    },
    "profileId": "translate"
  }
]