Neuroflash NLG
Description
Neuroflash is an AI text generator.
| As this Workflow uses write operations to PIM attributes via REST API, the OMN user executing this Workflow needs to be in an admin role. API admin roles are configured in property 'omn.eai.api.admin.roles' in EAI Properties |
Configuration Parameters
Workflow-Name: ext.ai-textcreation-nf
| Key | Type | Default | Description |
|---|---|---|---|
ext.ai-textcreation-nf.apiUrl |
the base url for the Neuroflash API |
Optional (default: "https://backofficeapi.neuro-flash.com/api/v1") |
|
ext.ai-textcreation-nf.apiKey |
the key for the Neuroflash API |
Required |
|
ext.ai-textcreation-nf.apiToken |
the token for the Neuroflash API |
Required |
|
ext.ai-textcreation-nf.targetAttribute |
the PIM2 attribute identifier where to write the generated text(s) to |
Required |
|
ext.ai-textcreation-nf.text |
the input text for Neuroflash |
Required |
|
ext.ai-textcreation-nf.keywords |
the input keywords for Neuroflash |
Optional (for some output types) |
|
ext.ai-textcreation-nf.languageTag |
de-DE |
the language used for input and output. Needs to be a language tag with language and region information. Allowed values are 'de-DE', 'de-AT', 'de-CH', 'en-US', 'en-UK', 'fr-FR', 'fr-CH', 'nl-NL', 'pl-PL', 'it-IT' or 'es-ES' |
Optional |
ext.ai-textcreation-nf.languageTagMappings |
de-DE:de_DE,de-AT:de_DE,de-CH:de_DE,en-US:en_EN,en-UK:en_EN,fr-FR:fr_FR,fr-CH:fr_FR,nl-NL:nl_NL,pl-PL:pl_PL,it-IT:it_IT,es-ES:es_ES |
the mappings from language tags to OMN locales. A comma separated String with mappings in the form '<tag>:<locale>' |
Optional |
ext.ai-textcreation-nf.audienceModelId |
the internal Neuroflash audience model id which is actually the used language. This should not be set manually as for convenience the *.language param should be used. If set it will override the language parameter |
Optional |
|
ext.ai-textcreation-nf.outputType |
the output type for the result text |
Required |
|
ext.ai-textcreation-nf.tonality |
the tonality for the result text |
Optional |
|
ext.ai-textcreation-nf.nTextItems |
1 |
the number of result texts Neuroflash will generate |
Optional |
ext.ai-textcreation-nf.flowMode |
the flow mode of the WFL. Can be "INDIRECT" or "DIRECT" |
Optional (default: "DIRECT") |
|
ext.ai-textcreation-nf.fsDetail.textSelection |
the FSDetail plugin configuration for the text-selection user task. This FSDetail needs to have the following text fields to show the first five generated results from NF: ext.ai-textcreation-nf.output.text1 ext.ai-textcreation-nf.output.text2 ext.ai-textcreation-nf.output.text3 ext.ai-textcreation-nf.output.text4 ext.ai-textcreation-nf.output.text5 In addition it needs to have the following fixe checkbox fields: ext.ai-textcreation-nf.output.text1.isSelected ext.ai-textcreation-nf.output.text2.isSelected ext.ai-textcreation-nf.output.text3.isSelected ext.ai-textcreation-nf.output.text4.isSelected ext.ai-textcreation-nf.output.text5.isSelected |
Required if flowMode is set to INDIRECT |
Example configuration
The following image shows what a sample configuration for Neuroflash NLG might look like.
A detailed step-by-step guide to the configuration of the Workflow Config Function plug-in can be found on this page.