document.on_demand_translate - Fluid Topics - Latest

Fluid Topics Analytics Guide

Category
Reference Guides
Audience
public
Version
Latest

This web application event occurs when a user uses the On-demand translation component.

This event contains the following fields:

Field Description
translationOrigin Can be OFFICIAL or AI, depending if the translation comes from an officially translated version of the document or if it is AI generated.
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.
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 available in the Analytics events section.

Example:

[
    {
        "translationOrigin": "AI",
        "sourceLanguage":
        {
            "languageCode": "en",
            "countryCode": "US"
        },
        "destinationLanguage":
        {
            "languageCode": "bg",
            "countryCode": ""
        },
        "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"
    }
]