Package org.ametys.plugins.ai

Class AIHelper

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.ai.AIHelper

All Implemented Interfaces:

DeferredServiceable, LogEnabled, Initializable, Component, Contextualizable, Serviceable

public class AIHelper
extends AbstractLogEnabled
implements Component, DeferredServiceable, Contextualizable, Serviceable, Initializable

This is helper to use AI as image or text generation.

Field Summary

Fields

Modifier and Type	Field	Description
protected AIProviderExtensionPoint	_aiProviderEP	The extension point providing access to registered AI providers.
protected AmetysObjectResolver	_ametysObjectResolver	The ametys object resolver
protected AbstractCacheManager	_cacheManager	The Ametys cache manager
protected Context	_context	The avalon context
protected CurrentUserProvider	_currentUserProvider	The current user provider
protected JSONUtils	_jsonUtils	The JSON utils used to convert JSON to objects
protected RenderingContextHandler	_renderingContextHandler	The rendering context handler
protected javax.jcr.Repository	_repository	The jcr repository
protected SearcherFactory	_searcherFactory	The searcher factory
protected SiteManager	_siteManager	The site manager
protected SolrClientProvider	_solrClientProvider	The solr client provider
protected UploadManager	_uploadManager	The upload manager used to upload images
protected URIResolverExtensionPoint	_uriResolverEP	The ametys uri resolver
protected WorkspaceSelector	_workspaceSelector	The workspace selector
static final String	ROLE	Avalon role
static final String	SITE_CONFIG_CHAT_ACTIVATE	The site configuration parameter for the chatbot activation
static final String	SITE_CONFIG_CHAT_NAME	The site configuration parameter for the chatbot name
static final String	SITE_CONFIG_CHAT_PROMPT	The site configuration parameter for the chatbot prompt
static final String	SITE_CONFIG_IMAGE_PROMPT	The site configuration parameter for the a specific image prompt
static final String	SITE_CONFIG_SEMANTIC_INDEXATION_ACTIVATE	The site configuration parameter for the semantic indexation activation
static final String	SITE_CONFIG_TEXT_PROMPT	The site configuration parameter for the a specific text prompt

Constructor Summary

Constructors

Constructor	Description
AIHelper()

Method Summary

Modifier and Type	Method	Description
String	askChatbot(String userMessage, String historyJson, String siteName, String sitemapName)	Get the chatbot response according to the current provider.
List<Float>	computeEmbedding(String text)	Get the embedding of a text
void	contextualize(Context context)
void	deferredService(ServiceManager manager)	Pass the ServiceManager used to access other components.
protected AIProvider	getCurrentAIProvider()	Get the current AI Provider class
int	getEmbeddingDimension()	Get the dimension of the embedding vector
String	getEmbeddingGeneratorKey()	Get a string key identifying the embedding generator.
String	getImageGenerationPrompt()	Initialize the prompt for image generation.
String	getTextSummaryPrompt(int maxLength)	Initialize the prompt with a given maximum length minus 10 characters to prevent the LLM to exceed the limit.
void	initialize()
boolean	isChatbotEnabled(String siteName)	Checks if a configured AI provider is available and supports embedding and semantic indexation and chatbot are activated on the current site.
boolean	isEmbeddingSupported()	Checks if a configured AI provider is available and supports embedding.
boolean	isEnabled()	Checks if a configured AI provider is available and supports text summarization.
boolean	isImageGenerationSupported()	Checks if a configured AI provider is available and supports image generation.
boolean	isSemanticIndexationActivated(String siteName)	Checks if a configured AI provider is available and supports embedding and semantic indexation is activated on the current site.
String	resourceToSummary(Resource resource, int maxLength)	Summarize a resource
void	service(ServiceManager manager)
Map<String,Object>	textToImage(String text, String name)	Generate an image with a given text
Map<String,String>	textToSummary(String text, int maxLength)	Summarize a given text

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Details

ROLE

public static final String ROLE

Avalon role

SITE_CONFIG_IMAGE_PROMPT

public static final String SITE_CONFIG_IMAGE_PROMPT

The site configuration parameter for the a specific image prompt

See Also:

• Constant Field Values

SITE_CONFIG_TEXT_PROMPT

public static final String SITE_CONFIG_TEXT_PROMPT

The site configuration parameter for the a specific text prompt

See Also:

• Constant Field Values

SITE_CONFIG_SEMANTIC_INDEXATION_ACTIVATE

public static final String SITE_CONFIG_SEMANTIC_INDEXATION_ACTIVATE

The site configuration parameter for the semantic indexation activation

See Also:

• Constant Field Values

SITE_CONFIG_CHAT_ACTIVATE

public static final String SITE_CONFIG_CHAT_ACTIVATE

The site configuration parameter for the chatbot activation

See Also:

• Constant Field Values

SITE_CONFIG_CHAT_PROMPT

public static final String SITE_CONFIG_CHAT_PROMPT

The site configuration parameter for the chatbot prompt

See Also:

• Constant Field Values

SITE_CONFIG_CHAT_NAME

public static final String SITE_CONFIG_CHAT_NAME

The site configuration parameter for the chatbot name

See Also:

• Constant Field Values

_aiProviderEP

protected AIProviderExtensionPoint _aiProviderEP

The extension point providing access to registered AI providers.

_uploadManager

protected UploadManager _uploadManager

The upload manager used to upload images

_currentUserProvider

protected CurrentUserProvider _currentUserProvider

The current user provider

_jsonUtils

protected JSONUtils _jsonUtils

The JSON utils used to convert JSON to objects

_searcherFactory

protected SearcherFactory _searcherFactory

The searcher factory

_uriResolverEP

protected URIResolverExtensionPoint _uriResolverEP

The ametys uri resolver

_ametysObjectResolver

protected AmetysObjectResolver _ametysObjectResolver

The ametys object resolver

_solrClientProvider

protected SolrClientProvider _solrClientProvider

The solr client provider

_siteManager

protected SiteManager _siteManager

The site manager

_context

protected Context _context

The avalon context

_workspaceSelector

protected WorkspaceSelector _workspaceSelector

The workspace selector

_repository

protected javax.jcr.Repository _repository

The jcr repository

_cacheManager

protected AbstractCacheManager _cacheManager

The Ametys cache manager

_renderingContextHandler

protected RenderingContextHandler _renderingContextHandler

The rendering context handler

Constructor Details

AIHelper

public AIHelper()

Method Details

service

public void service(ServiceManager manager)
             throws ServiceException

Specified by:

service in interface Serviceable

Throws:

ServiceException

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

deferredService

public void deferredService(ServiceManager manager)
                     throws ServiceException

Description copied from interface: DeferredServiceable

Pass the ServiceManager used to access other components.

Specified by:

deferredService in interface DeferredServiceable

Parameters:

manager - The ServiceManager which this DeferredServiceable uses. Must not be null.

Throws:

ServiceException - if an error occurs

contextualize

public void contextualize(Context context)
                   throws ContextException

Specified by:

contextualize in interface Contextualizable

Throws:

ContextException

isEnabled

public boolean isEnabled()

Checks if a configured AI provider is available and supports text summarization. This includes verifying the provider exists, has a valid text model, and is properly configured.

Returns:

true if all is good, false otherwise

textToSummary

public Map<String,String> textToSummary(String text,
 int maxLength)

Summarize a given text

Parameters:

text - The input text to be summarized.

maxLength - The maximum number of characters for the summary.

Returns:

A map with the Ai-generated summary under the key "summary".

isImageGenerationSupported

public boolean isImageGenerationSupported()

Checks if a configured AI provider is available and supports image generation. This includes verifying the provider exists, has a valid text model, and is properly configured.

Returns:

true if all is good, false otherwise

isEmbeddingSupported

public boolean isEmbeddingSupported()

Checks if a configured AI provider is available and supports embedding.

Returns:

true if supported, false otherwise

isSemanticIndexationActivated

public boolean isSemanticIndexationActivated(String siteName)

Checks if a configured AI provider is available and supports embedding and semantic indexation is activated on the current site.

Parameters:

siteName - The site to consider

Returns:

true if activated

isChatbotEnabled

public boolean isChatbotEnabled(String siteName)

Checks if a configured AI provider is available and supports embedding and semantic indexation and chatbot are activated on the current site. This includes verifying the provider exists, has a valid text model, and is properly configured.

Parameters:

siteName - The site to consider

Returns:

true if all is good, false otherwise

textToImage

public Map<String,Object> textToImage(String text,
 String name)

Generate an image with a given text

Parameters:

text - The input text to generate the image with.

name - The name for the generated image file.

Returns:

A map with the URL of the Ai-generated image under the key "image".

resourceToSummary

public String resourceToSummary(Resource resource,
 int maxLength)
                         throws Exception

Summarize a resource

Parameters:

resource - the resource to be summarized.

maxLength - The maximum number of characters for the summary.

Returns:

the summary.

Throws:

Exception - if an error occurred

getCurrentAIProvider

protected AIProvider getCurrentAIProvider()

Get the current AI Provider class

Returns:

the AI provider

getTextSummaryPrompt

public String getTextSummaryPrompt(int maxLength)

Initialize the prompt with a given maximum length minus 10 characters to prevent the LLM to exceed the limit.

Parameters:

maxLength - the number of characters allowed

Returns:

the text of the prompt

getImageGenerationPrompt

public String getImageGenerationPrompt()

Initialize the prompt for image generation.

Returns:

the text of the prompt

askChatbot

public String askChatbot(String userMessage,
 String historyJson,
 String siteName,
 String sitemapName)
                  throws IOException

Get the chatbot response according to the current provider.

Parameters:

userMessage - text

historyJson - the history of the conversation in JSON format

siteName - The current site name

sitemapName - The current sitemap name

Returns:

the chatbot response message

Throws:

IOException - if an error occurs

computeEmbedding

public List<Float> computeEmbedding(String text)

Get the embedding of a text

Parameters:

text - The text to get the embedding for

Returns:

The embedding vector for the given text or null if an error occurred or embedding is not supported

getEmbeddingDimension

public int getEmbeddingDimension()

Get the dimension of the embedding vector

Returns:

The embedding dimension or -1 if not supported

getEmbeddingGeneratorKey

public String getEmbeddingGeneratorKey()

Get a string key identifying the embedding generator. Comparing this key between two calls allows to know if an existing embedding is still valid.

Returns:

The embedding generator key or null if embedding is not supported