Package org.opencms.ai

Class CmsAiContentTranslation

java.lang.Object

org.opencms.ai.CmsAiContentTranslation

All Implemented Interfaces:

I_CmsContentTranslator, I_CmsConfigurationParameterHandler

public class CmsAiContentTranslation
extends Object
implements I_CmsContentTranslator

LLM implementation of the I_CmsContentTranslator interface.

Reads the LLM credentials from a JSON file whose file system path is passed via the 'config' configuration parameter.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	CmsAiContentTranslation.Augmentation

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PARAM_CONFIG_FILE	Parameter from which the config file path is read.

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Constructor Summary

Constructors

Constructor	Description
CmsAiContentTranslation()

Method Summary

Modifier and Type	Method	Description
void	addConfigurationParameter(String paramName, String paramValue)	Adds a configuration parameter to this parameter configurable class instance.
CmsParameterConfiguration	getConfiguration()	Returns the parameters of this configurable class instance, or null if the class does not need any parameters.
I_CmsXmlContentAugmentation	getContentAugmentation()	Returns a fresh content augmentation object for doing the actual translation work.
void	initConfiguration()	Initializes a configuration after all parameters have been added.
void	initialize(CmsObject cms)	Initializes the content translator with an admin CmsObject.
boolean	isEnabled(CmsObject cms, CmsADEConfigData config, CmsFile file)	Checks if the translation should be enabled for the current context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

PARAM_CONFIG_FILE

public static final String PARAM_CONFIG_FILE

Parameter from which the config file path is read.

See Also:

• Constant Field Values

Constructor Details

CmsAiContentTranslation

public CmsAiContentTranslation()

Method Details

addConfigurationParameter

public void addConfigurationParameter(String paramName,
 String paramValue)

Description copied from interface: I_CmsConfigurationParameterHandler

Adds a configuration parameter to this parameter configurable class instance.

Specified by:

addConfigurationParameter in interface I_CmsConfigurationParameterHandler

Parameters:

paramName - the name of the parameter

paramValue - the value for the parameter

See Also:

• I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)

getConfiguration

public CmsParameterConfiguration getConfiguration()

Description copied from interface: I_CmsConfigurationParameterHandler

Returns the parameters of this configurable class instance, or null if the class does not need any parameters.

Specified by:

getConfiguration in interface I_CmsConfigurationParameterHandler

Returns:

the parameters of this configurable class instance, or null if the class does not need any parameters

See Also:

• I_CmsConfigurationParameterHandler.getConfiguration()

getContentAugmentation

public I_CmsXmlContentAugmentation getContentAugmentation()

Description copied from interface: I_CmsContentTranslator

Returns a fresh content augmentation object for doing the actual translation work.

Specified by:

getContentAugmentation in interface I_CmsContentTranslator

Returns:

the content augmentation object

See Also:

• I_CmsContentTranslator.getContentAugmentation()

initConfiguration

public void initConfiguration()
                       throws CmsConfigurationException

Description copied from interface: I_CmsConfigurationParameterHandler

Initializes a configuration after all parameters have been added.

Specified by:

initConfiguration in interface I_CmsConfigurationParameterHandler

Throws:

CmsConfigurationException - if something goes wrong

See Also:

• I_CmsConfigurationParameterHandler.initConfiguration()

initialize

public void initialize(CmsObject cms)

Description copied from interface: I_CmsContentTranslator

Initializes the content translator with an admin CmsObject.

If the translator is already initialized, this should do nothing.

Specified by:

initialize in interface I_CmsContentTranslator

Parameters:

cms - an admin CmsObject

See Also:

• I_CmsContentTranslator.initialize(org.opencms.file.CmsObject)

isEnabled

public boolean isEnabled(CmsObject cms,
 CmsADEConfigData config,
 CmsFile file)

Description copied from interface: I_CmsContentTranslator

Checks if the translation should be enabled for the current context.

Specified by:

isEnabled in interface I_CmsContentTranslator

Parameters:

cms - the CMS context

config - the currently active ADE configuration

file - the edited file

Returns:

true if the translation should be enabled

See Also:

• I_CmsContentTranslator.isEnabled(org.opencms.file.CmsObject, org.opencms.ade.configuration.CmsADEConfigData, org.opencms.file.CmsFile)