Package org.opencms.ai

Class CmsAiProviderConfig

java.lang.Object

org.opencms.ai.CmsAiProviderConfig

public class CmsAiProviderConfig
extends Object

Simple configuration bean for AI provider access settings.

Since:

21.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SECRET_PREFIX

Constructor Summary

Constructors

Constructor	Description
CmsAiProviderConfig(String apiKey, String providerUrl, String modelName)	Creates a new provider configuration.

Method Summary

Modifier and Type	Method	Description
String	getApiKey()	Returns the API key used to access the provider.
String	getModelName()	Returns the model name used for requests.
String	getProviderUrl()	Returns the provider base URL.
static CmsAiProviderConfig	loadFromJsonFile(String path)	Loads the provider configuration from a JSON file in the RFS.
static CmsAiProviderConfig	loadFromSecretStore()	Loads the configuration from the secret store.

Methods inherited from class java.lang.Object

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

Field Details

SECRET_PREFIX

public static final String SECRET_PREFIX

See Also:

• Constant Field Values

Constructor Details

CmsAiProviderConfig

public CmsAiProviderConfig(String apiKey,
 String providerUrl,
 String modelName)

Creates a new provider configuration.

Parameters:

apiKey - the API key to use

providerUrl - the provider base URL

modelName - the model name

Method Details

loadFromJsonFile

public static CmsAiProviderConfig loadFromJsonFile(String path)
                                            throws Exception

Loads the provider configuration from a JSON file in the RFS.

Parameters:

path - the path of the config file

Returns:

the provider configuration

Throws:

Exception - if loading the file fails

loadFromSecretStore

public static CmsAiProviderConfig loadFromSecretStore()

Loads the configuration from the secret store.

Returns null if one or more of the credentials could not be read from the secret store.

Returns:

the loaded configuration

Throws:

Exception - if something goes wrong

getApiKey

public String getApiKey()

Returns the API key used to access the provider.

Returns:

the API key

getModelName

public String getModelName()

Returns the model name used for requests.

Returns:

the model name

getProviderUrl

public String getProviderUrl()

Returns the provider base URL.

Returns:

the provider URL