Package org.ametys.plugins.ai.provider.impl

Class AbstractAIProvider

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.ai.provider.impl.AbstractAIProvider

All Implemented Interfaces:

AIProvider, DeferredServiceable, LogEnabled, PluginAware, Disposable, Initializable, Component, Configurable

Direct Known Subclasses:

GoogleAIGeminiProvider, MistralAIProvider, OllamaProvider, OpenAIProvider

public abstract class AbstractAIProvider
extends AbstractLogEnabled
implements AIProvider, Configurable, Initializable, PluginAware, DeferredServiceable, Component, Disposable

This is an abstract class for AI providers.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	AbstractAIProvider.EmbeddingModelInfo	Info for an embedding model

Field Summary

Fields

Modifier and Type	Field	Description
protected AIHelper	_aiHelper	The AI helper
protected dev.langchain4j.model.embedding.EmbeddingModel	_embeddingModel	Current embedding model
protected List<AbstractAIProvider.EmbeddingModelInfo>	_embeddingModelInfos	The provider models existing for embedding
protected org.apache.hc.client5.http.impl.classic.CloseableHttpClient	_httpClient	The HTTP client used to fetch images
protected String	_id	The provider id
protected dev.langchain4j.model.image.ImageModel	_imageModel	Current image model
protected int	_imageModelContextWindow	The context window for image generation
protected List<String>	_imageModelNames	The provider models existing for image generation
protected I18nizableText	_label	The provider label
protected String	_pluginName	The plugin name
protected dev.langchain4j.model.chat.ChatModel	_textModel	Current text model
protected int	_textModelContextWindow	The context window for text generation
protected List<String>	_textModelNames	The provider models existing for text generation
static final String	CONFIG_API_KEY	The configuration parameter for the API key
static final String	CONFIG_EMBEDDING_MODEL	The configuration parameter for embedding model
static final String	CONFIG_IMAGE_MODEL	The configuration parameter for image model
static final String	CONFIG_IMAGE_TIMEOUT	The configuration parameter for image generation timeout
static final String	CONFIG_SERVER_URL	The configuration parameter for URL
static final String	CONFIG_TEXT_MODEL	The configuration parameter for text model

Constructor Summary

Constructors

Constructor	Description
AbstractAIProvider()

Method Summary

Modifier and Type	Method	Description
protected Path	_download(URI uri)	Helper to download the given url to a temporary file
protected dev.langchain4j.model.TokenCountEstimator	_getTokenCountEstimator()	Creates a token count estimator
String	askChatbot(dev.langchain4j.memory.ChatMemory memory)	Get the response from the chatbot if embedding is supported
List<Float>	computeEmbedding(String text)	Get the embedding of a text
void	configure(Configuration configuration)
protected abstract dev.langchain4j.model.chat.ChatModel	createChatModel(String modelName)	Creates the text model implementation
protected abstract dev.langchain4j.model.embedding.EmbeddingModel	createEmbeddingModel(String modelName)	Creates the embedding model implementation
protected dev.langchain4j.model.image.ImageModel	createImageModel(String modelName)	Creates the image model implementation
void	deferredService(ServiceManager manager)	Pass the ServiceManager used to access other components.
void	dispose()
protected String	getAPIKey()	Get the API key from the configuration
int	getEmbeddingDimension()	Get the dimension of the embedding vector
String	getEmbeddingKey()	Get a string key identifying the embedding generator.
String	getId()	Get the id of the provider
List<AbstractAIProvider.EmbeddingModelInfo>	getKnownEmbeddingModels()	Get the list of known embedding models for this provider
List<String>	getKnownImageModels()	Get the list of known image models for this provider
List<String>	getKnownTextModels()	Get the list of known text models for this provider
I18nizableText	getLabel()	Get the label of the provider
protected String	getServerURL()	Get the server URL from the configuration
void	initialize()
protected boolean	isEmbeddingNormalizationRequired()	Is normalization required for the embeddings of this provider
boolean	isEmbeddingSupported()	Check if the embedding is supported
boolean	isImageGenerationSupported()	Check if the image generation is supported
List<Float>	normalize(List<Float> vector)	Necessary for open models who often are not normalized.
void	setPluginInfo(String pluginName, String featureName, String id)	Sets the plugin info relative to the current component. Note : The feature name may be null if the targeted component in declared at plugin level.
Path	textToImage(String text)	Get the URL of the generated image
String	textToSummary(String text, int maxLength)	Summarized a 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

CONFIG_API_KEY

public static final String CONFIG_API_KEY

The configuration parameter for the API key

See Also:

• Constant Field Values

CONFIG_SERVER_URL

public static final String CONFIG_SERVER_URL

The configuration parameter for URL

See Also:

• Constant Field Values

CONFIG_TEXT_MODEL

public static final String CONFIG_TEXT_MODEL

The configuration parameter for text model

See Also:

• Constant Field Values

CONFIG_IMAGE_MODEL

public static final String CONFIG_IMAGE_MODEL

The configuration parameter for image model

See Also:

• Constant Field Values

CONFIG_IMAGE_TIMEOUT

public static final String CONFIG_IMAGE_TIMEOUT

The configuration parameter for image generation timeout

See Also:

• Constant Field Values

CONFIG_EMBEDDING_MODEL

public static final String CONFIG_EMBEDDING_MODEL

The configuration parameter for embedding model

See Also:

• Constant Field Values

_id

protected String _id

The provider id

_label

protected I18nizableText _label

The provider label

_pluginName

protected String _pluginName

The plugin name

_textModelNames

protected List<String> _textModelNames

The provider models existing for text generation

_imageModelNames

protected List<String> _imageModelNames

The provider models existing for image generation

_embeddingModelInfos

protected List<AbstractAIProvider.EmbeddingModelInfo> _embeddingModelInfos

The provider models existing for embedding

_textModel

protected dev.langchain4j.model.chat.ChatModel _textModel

Current text model

_textModelContextWindow

protected int _textModelContextWindow

The context window for text generation

_imageModel

protected dev.langchain4j.model.image.ImageModel _imageModel

Current image model

_imageModelContextWindow

protected int _imageModelContextWindow

The context window for image generation

_embeddingModel

protected dev.langchain4j.model.embedding.EmbeddingModel _embeddingModel

Current embedding model

_aiHelper

protected AIHelper _aiHelper

The AI helper

_httpClient

protected org.apache.hc.client5.http.impl.classic.CloseableHttpClient _httpClient

The HTTP client used to fetch images

Constructor Details

AbstractAIProvider

public AbstractAIProvider()

Method Details

setPluginInfo

public void setPluginInfo(String pluginName,
 String featureName,
 String id)

Description copied from interface: PluginAware

Sets the plugin info relative to the current component.
Note : The feature name may be null if the targeted component in declared at plugin level.

Specified by:

setPluginInfo in interface PluginAware

Parameters:

pluginName - Unique identifier for the plugin hosting the extension

featureName - Unique feature identifier (unique for a given pluginName)

id - Unique identifier of this component

configure

public void configure(Configuration configuration)
               throws ConfigurationException

Specified by:

configure in interface Configurable

Throws:

ConfigurationException

createChatModel

protected abstract dev.langchain4j.model.chat.ChatModel createChatModel(String modelName)

Creates the text model implementation

Parameters:

modelName - The model name

Returns:

The chat model

createImageModel

protected dev.langchain4j.model.image.ImageModel createImageModel(String modelName)

Creates the image model implementation

Parameters:

modelName - The model name

Returns:

The image model

createEmbeddingModel

protected abstract dev.langchain4j.model.embedding.EmbeddingModel createEmbeddingModel(String modelName)

Creates the embedding model implementation

Parameters:

modelName - The model name

Returns:

The embedding model

initialize

public void initialize()
                throws Exception

Specified by:

initialize in interface Initializable

Throws:

Exception

dispose

public void dispose()

Specified by:

dispose in interface Disposable

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

getId

public String getId()

Description copied from interface: AIProvider

Get the id of the provider

Specified by:

getId in interface AIProvider

Returns:

the id

getLabel

public I18nizableText getLabel()

Description copied from interface: AIProvider

Get the label of the provider

Specified by:

getLabel in interface AIProvider

Returns:

the label

getKnownTextModels

public List<String> getKnownTextModels()

Get the list of known text models for this provider

Returns:

The list

getKnownImageModels

public List<String> getKnownImageModels()

Get the list of known image models for this provider

Returns:

The non null list

getKnownEmbeddingModels

public List<AbstractAIProvider.EmbeddingModelInfo> getKnownEmbeddingModels()

Get the list of known embedding models for this provider

Returns:

the non null list

_getTokenCountEstimator

protected dev.langchain4j.model.TokenCountEstimator _getTokenCountEstimator()

Creates a token count estimator

Returns:

The non null token count estimator

textToSummary

public String textToSummary(String text,
 int maxLength)
                     throws Exception

Description copied from interface: AIProvider

Summarized a text

Specified by:

textToSummary in interface AIProvider

Parameters:

text - the text to summarize

maxLength - the max number of characters that will be generated

Returns:

the summarized text

Throws:

Exception - if an error occurred during summarize process

isImageGenerationSupported

public boolean isImageGenerationSupported()

Description copied from interface: AIProvider

Check if the image generation is supported

Specified by:

isImageGenerationSupported in interface AIProvider

Returns:

boolean true if the generation is enabled, false otherwise

textToImage

public Path textToImage(String text)
                 throws Exception

Description copied from interface: AIProvider

Get the URL of the generated image

Specified by:

textToImage in interface AIProvider

Parameters:

text - the prompt text

Returns:

the generated image

Throws:

Exception - if an error occurred during the image generation

_download

protected Path _download(URI uri)
                  throws IOException

Helper to download the given url to a temporary file

Parameters:

uri - The uri to download

Returns:

The created file

Throws:

IOException - If an error occurred

getAPIKey

protected String getAPIKey()

Get the API key from the configuration

Returns:

the API key

getServerURL

protected String getServerURL()

Get the server URL from the configuration

Returns:

the server URL

isEmbeddingSupported

public boolean isEmbeddingSupported()

Description copied from interface: AIProvider

Check if the embedding is supported

Specified by:

isEmbeddingSupported in interface AIProvider

Returns:

boolean true if the embedding is supported, false otherwise

askChatbot

public String askChatbot(dev.langchain4j.memory.ChatMemory memory)

Description copied from interface: AIProvider

Get the response from the chatbot if embedding is supported

Specified by:

askChatbot in interface AIProvider

Parameters:

memory - the chat history message

Returns:

the response from the chatbot

computeEmbedding

public List<Float> computeEmbedding(String text)

Description copied from interface: AIProvider

Get the embedding of a text

Specified by:

computeEmbedding in interface AIProvider

Parameters:

text - The text to embed

Returns:

The embedding vector as a list of floats or null if an error occurred or if embedding is not supported

isEmbeddingNormalizationRequired

protected boolean isEmbeddingNormalizationRequired()

Is normalization required for the embeddings of this provider

Returns:

true if normalization is required

normalize

public List<Float> normalize(List<Float> vector)

Necessary for open models who often are not normalized.

Parameters:

vector - the vector to normalize

Returns:

the normalized vector

getEmbeddingDimension

public int getEmbeddingDimension()

Description copied from interface: AIProvider

Get the dimension of the embedding vector

Specified by:

getEmbeddingDimension in interface AIProvider

Returns:

The embedding dimension or -1 if not supported

getEmbeddingKey

public String getEmbeddingKey()

Description copied from interface: AIProvider

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

Specified by:

getEmbeddingKey in interface AIProvider

Returns:

The embedding generator key or null if embedding is not supported