Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

API Fields

  • "type" must always be specified as "application".
  • "_type" must always be specified as "application".
  • "description" must be a descriptive string without spaces.
  • "config" must always be specified as "com.accenture.aspire:app-languageslide-detectorextractor".
  • "appType" must always be specified as "languageslide-detectorextractor".
  • "appName" must always be specified as "Language DetectorSlide Extractor".


FieldRequiredDefaultMultipleNotesExample
propertiesYes-NoConfiguration object
sourceFieldsetTempFileYesfalsetrueNoSelects how to enter the Elasticsearch URL. True: server and port are specified. False: full URL is specified.

The path to the folder where the temporal files were processed. Furthermore, you can set a System Variable "user.dir" with the path

true/false
detectedLanguageFieldtempFilesPathYes

No

"detected_language${aspire.home}/temp"No

The

field where the main detected language will be written.
"detected_language"
detectionTypeYes"All"NoSelect the type of detection to be used."All"
languagePoolNo"languagePool"NoIf detectionType "All" is selected, the value must be "languagePool" "languagePool" 

path to the folder where the temporal files were being processed

"${aspire.home}/temp"
maxFileSizeYesfalseNo

Maximum characters for the file loaded into memory to be parsed. (False will be set to unlimited)

true/false
charactersNo1000000No

The max number of characters as a limit for the number of characters to be processed, to prevent memory consumption

1000000
addParentInfoYesextractConfidenceValuesNofalseNo

Check if

confidence statistics extraction is required.
false

you want to add extra info from the parent to every slide of the file

true/false
parentFielddetectionOutputNo"detection_outputdatamodel"NoOnly required if "extractConfidenceValues" is enabled. The field where all detected languages and its statistics will be written."detection_output"
debugNofalseNoCheck to enable debug messages.false
limitTextSizeNofalseNoLimit Source Field text sizefalse
textSizeLimitNo128NoOnly required if "limitTextSize" is enabled. Maximum size for Source Field's text.128
includeISOCodesNofalseNoIf enabled, ISO codes will be included in the document.false
includeISO639_1NofalseNoCheck to include the ISO 639-1 codes in the document.false

Specify the name of the field from the parent job to add as extra info to every slide

"datamodel"
threadTimeoutYes15No

Maximum time (in minutes) for the processing thread to wait for the parsing result

15
subJobSleepYes60000No

Time to wait (in milliseconds) until all sub jobs are done

60000
debugincludeISO639_3NofalseNoCheck to include the ISO 639-3 codes in the document.Set to true to enable debug messages.true/false



Create example

...

Code Block
themeRDark
titlePOST /aspire/_api/workflows/:id/connectionsrules
# All languages
{
    "type": "application",
    "_type": "application",
    "description": "sample-ldslide-2extractor",
    "config": "com.accenture.aspire:app-language-detector",
    "appType": "language-detector",
    "appName": "Language Detector",
    "properties": {
        "sourceField": "content",
        "detectedLanguageField": "detected_language",
        "detectionType": "All",
        "languagePool": "languagePool",
        "extractConfidenceValues": false,
        "detectionOutput": "detection_output",
        "debug": false,
        "limitTextSize": false,
        "textSizeLimit": 128,
        "includeISOCodes": false,
        "includeISO639_1": false,
        "includeISO639_3": false
    }
}

# Spoken Language
{
    "type": "application",
    "_type": "application",
    "description": "sample-ld-3",
    "config": "com.accenture.aspire:app-languageslide-detectorextractor",
    "appType": "languageslide-detectorextractor",
    "appName": "LanguageSlide DetectorExtractor",
    "properties": {
        "sourceField		"setTempFile": "content"true,
        "detectedLanguageField": "detected_language",
        "detectionType": "Spoken",
        "languagePool": "languagePool",
        "extractConfidenceValues": false,
        "detectionOutput": "detection_output",
        "debug": false,
        "limitTextSize": false,
        "textSizeLimit": 128,
        "includeISOCodes": false,
        "includeISO639_1": false,
        "includeISO639_3": false
    }
}

# Cyrillic Language
{
    "type": "application",
    "_type": "application",
    "description": "sample-ld-3",
    "config": "com.accenture.aspire:app-language-detector",
    "appType": "language-detector",
    "appName": "Language Detector",
    "properties": {
        "sourceField": "content",
        "detectedLanguageField": "detected_language",
        "detectionType": "Cyrillic",
        "languagePool": "languagePool",
        "extractConfidenceValues": false,
        "detectionOutput": "detection_output",
        "debug": false,
        "limitTextSize": false,
        "textSizeLimit": 128,
        "includeISOCodes": false,
        "includeISO639_1": false,
        "includeISO639_3": false
    }
}

#Specific
{
    "type": "application",
    "_type": "application",
    "description": "sample-ld-1",
    "config": "com.accenture.aspire:app-language-detector",
    "appType": "language-detector",
    "appName": "Language Detector",
    "properties": {
        "sourceField": "content",
        "detectedLanguageField": "detected_language",
        "detectionType": "Specific",
        "languagePool": [
            "Afrikaans",
            "Albanian"
        ],
        "extractConfidenceValues": false,
        "detectionOutput": "detection_output",
        "debug": false,
        "limitTextSize": false,
        "textSizeLimit": 128,
        "includeISOCodes": false,
        "includeISO639_1": false,
        "includeISO639_3": false
    }
}

#Except
{
    "type": "application",
    "_type": "application",
    "description": "sample-ld-1",
    "config": "com.accenture.aspire:app-language-detector",
    "appType": "language-detector",
    "appName": "Language Detector",
    "properties": {
        "sourceField": "content",
        "detectedLanguageField": "detected_language",
        "detectionType": "Except",
        "languagePool": [
            "Afrikaans",
            "Albanian"
        ],
        "extractConfidenceValues": false,
        "detectionOutput": "detection_output",
        "debug": false,
        "limitTextSize": false,
        "textSizeLimit": 128,
        "includeISOCodes": false,
        "includeISO639_1": false,
        "includeISO639_3": false
    }		"tempFilesPath": "${aspire.home}/temp",
  		"maxFileSize": true,
  		"characters": "1000000",
 		"addParentInfo": true,
		"parentField": "datamodel",
  		"threadTimeout": 15,
  		"subJobSleep": 60000,
  		"debug": false
	} 
}