-
Notifications
You must be signed in to change notification settings - Fork 467
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
…29236) Removing hardcoded OpenAI models at enum class OpenAIModel. Instead they are now part of the `dotAI.yml` application descriptor so the user can be the one who configures them not only one but multiple models for `text`, `image` and `embeddings`. The way to specify more than one is to provide a comma delimited list in the new dotAI App params. Sometimes we accept a model to use in the payload of our AI endpoints, for this matter we will validate that model and if it's invalid we will throw an exception. When is not present in the payload, then our backend will inject the current model. Which leads us to the question: How will the current model be determined? This is part of the work defined for #29284 (model fallback)
- Loading branch information
1 parent
c5f3961
commit da61861
Showing
50 changed files
with
2,328 additions
and
698 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,169 @@ | ||
| package com.dotcms.ai.app; | ||
|
|
||
| import com.dotcms.security.apps.AppsUtil; | ||
| import com.dotcms.security.apps.Secret; | ||
| import com.dotmarketing.util.UtilMethods; | ||
| import com.liferay.util.StringPool; | ||
| import io.vavr.Lazy; | ||
| import io.vavr.control.Try; | ||
|
|
||
| import java.util.Arrays; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.Optional; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| /** | ||
| * Utility class for handling AI application configurations and secrets. | ||
| * This class provides methods to resolve secrets, normalize model names, | ||
| * split model names, and create AI model instances based on the provided | ||
| * configuration and secrets. | ||
| * | ||
| * @author vico | ||
| */ | ||
| public class AIAppUtil { | ||
|
|
||
| private static final Lazy<AIAppUtil> INSTANCE = Lazy.of(AIAppUtil::new); | ||
|
|
||
| private AIAppUtil() { | ||
| // Private constructor to prevent instantiation | ||
| } | ||
|
|
||
| public static AIAppUtil get() { | ||
| return INSTANCE.get(); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a text model instance based on the provided secrets. | ||
| * | ||
| * @param secrets the map of secrets | ||
| * @return the created text model instance | ||
| */ | ||
| public AIModel createTextModel(final Map<String, Secret> secrets) { | ||
| return AIModel.builder() | ||
| .withType(AIModelType.TEXT) | ||
| .withNames(discoverSecret(secrets, AppKeys.TEXT_MODEL_NAMES)) | ||
| .withTokensPerMinute(discoverIntSecret(secrets, AppKeys.TEXT_MODEL_TOKENS_PER_MINUTE)) | ||
| .withApiPerMinute(discoverIntSecret(secrets, AppKeys.TEXT_MODEL_API_PER_MINUTE)) | ||
| .withMaxTokens(discoverIntSecret(secrets, AppKeys.TEXT_MODEL_MAX_TOKENS)) | ||
| .withIsCompletion(discoverBooleanSecret(secrets, AppKeys.TEXT_MODEL_COMPLETION)) | ||
| .build(); | ||
| } | ||
|
|
||
| /** | ||
| * Creates an image model instance based on the provided secrets. | ||
| * | ||
| * @param secrets the map of secrets | ||
| * @return the created image model instance | ||
| */ | ||
| public AIModel createImageModel(final Map<String, Secret> secrets) { | ||
| return AIModel.builder() | ||
| .withType(AIModelType.IMAGE) | ||
| .withNames(discoverSecret(secrets, AppKeys.IMAGE_MODEL_NAMES)) | ||
| .withTokensPerMinute(discoverIntSecret(secrets, AppKeys.IMAGE_MODEL_TOKENS_PER_MINUTE)) | ||
| .withApiPerMinute(discoverIntSecret(secrets, AppKeys.IMAGE_MODEL_API_PER_MINUTE)) | ||
| .withMaxTokens(discoverIntSecret(secrets, AppKeys.IMAGE_MODEL_MAX_TOKENS)) | ||
| .withIsCompletion(discoverBooleanSecret(secrets, AppKeys.IMAGE_MODEL_COMPLETION)) | ||
| .build(); | ||
| } | ||
|
|
||
| /** | ||
| * Creates an embeddings model instance based on the provided secrets. | ||
| * | ||
| * @param secrets the map of secrets | ||
| * @return the created embeddings model instance | ||
| */ | ||
| public AIModel createEmbeddingsModel(final Map<String, Secret> secrets) { | ||
| return AIModel.builder() | ||
| .withType(AIModelType.EMBEDDINGS) | ||
| .withNames(splitDiscoveredSecret(secrets, AppKeys.EMBEDDINGS_MODEL_NAMES)) | ||
| .withTokensPerMinute(discoverIntSecret(secrets, AppKeys.EMBEDDINGS_MODEL_TOKENS_PER_MINUTE)) | ||
| .withApiPerMinute(discoverIntSecret(secrets, AppKeys.EMBEDDINGS_MODEL_API_PER_MINUTE)) | ||
| .withMaxTokens(discoverIntSecret(secrets, AppKeys.EMBEDDINGS_MODEL_MAX_TOKENS)) | ||
| .withIsCompletion(discoverBooleanSecret(secrets, AppKeys.EMBEDDINGS_MODEL_COMPLETION)) | ||
| .build(); | ||
| } | ||
|
|
||
| /** | ||
| * Resolves a secret value from the provided secrets map using the specified key. | ||
| * If the secret is not found, the default value is returned. | ||
| * | ||
| * @param secrets the map of secrets | ||
| * @param key the key to look up the secret | ||
| * @param defaultValue the default value to return if the secret is not found | ||
| * @return the resolved secret value or the default value if the secret is not found | ||
| */ | ||
| public String discoverSecret(final Map<String, Secret> secrets, final AppKeys key, final String defaultValue) { | ||
| return Try.of(() -> secrets.get(key.key).getString()).getOrElse(defaultValue); | ||
| } | ||
|
|
||
| /** | ||
| * Resolves a secret value from the provided secrets map using the specified key. | ||
| * If the secret is not found, the default value defined in the key is returned. | ||
| * | ||
| * @param secrets the map of secrets | ||
| * @param key the key to look up the secret | ||
| * @return the resolved secret value or the default value defined in the key if the secret is not found | ||
| */ | ||
| public String discoverSecret(final Map<String, Secret> secrets, final AppKeys key) { | ||
| return discoverSecret(secrets, key, key.defaultValue); | ||
| } | ||
|
|
||
| /** | ||
| * Splits a model-specific secret value from the provided secrets map using the specified key. | ||
| * | ||
| * @param secrets the map of secrets | ||
| * @param key the key to look up the secret | ||
| * @return the list of split secret values | ||
| */ | ||
| public List<String> splitDiscoveredSecret(final Map<String, Secret> secrets, final AppKeys key) { | ||
| return Arrays.stream(discoverSecret(secrets, key).split(",")) | ||
| .map(String::trim) | ||
| .map(String::toLowerCase) | ||
| .collect(Collectors.toList()); | ||
| } | ||
|
|
||
| /** | ||
| * Resolves a model-specific secret value from the provided secrets map using the specified key and model type. | ||
| * | ||
| * @param secrets the map of secrets | ||
| * @param key the key to look up the secret | ||
| */ | ||
| public int discoverIntSecret(final Map<String, Secret> secrets, final AppKeys key) { | ||
| return toInt(discoverSecret(secrets, key)); | ||
| } | ||
|
|
||
| /** | ||
| * Resolves a model-specific secret value from the provided secrets map using the specified key and model type. | ||
| * | ||
| * @param secrets the map of secrets | ||
| * @param key the key to look up the secret | ||
| */ | ||
| public boolean discoverBooleanSecret(final Map<String, Secret> secrets, final AppKeys key) { | ||
| return Boolean.parseBoolean(discoverSecret(secrets, key)); | ||
| } | ||
|
|
||
| /** | ||
| * Resolves an environment-specific secret value from the provided secrets map using the specified key. | ||
| * If the secret is not found, it attempts to discover the value from environment variables. | ||
| * | ||
| * @param secrets the map of secrets | ||
| * @param key the key to look up the secret | ||
| * @return the resolved environment-specific secret value or an empty string if not found | ||
| */ | ||
| public String discoverEnvSecret(final Map<String, Secret> secrets, final AppKeys key) { | ||
| final String secret = discoverSecret(secrets, key, StringPool.BLANK); | ||
| if (UtilMethods.isSet(secret)) { | ||
| return secret; | ||
| } | ||
|
|
||
| return Optional | ||
| .ofNullable(AppsUtil.discoverEnvVarValue(AppKeys.APP_KEY, key.key, null)) | ||
| .orElse(StringPool.BLANK); | ||
| } | ||
|
|
||
| private int toInt(final String value) { | ||
| return Try.of(() -> Integer.parseInt(value)).getOrElse(0); | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.