feat: Enable calling AI services on serverside, instead of from the client

Author: theboxer

_build/gpm.yaml

@@ -10,6 +10,10 @@ plugins:
       - OnManagerPageBeforeRender
 
 systemSettings:
+  - key: api.execute_on_server
+    area: api
+    type: combo-boolean
+    value: 0
   - key: api.chatgpt.key
     type: text-password
     area: api

assets/components/modai/js/mgr/serviceExecutor.js

@@ -1,4 +1,10 @@
 modAI.serviceExecutor = async (details) => {
+    if (!details.forExecutor) {
+        return details;
+    }
+
+    const executorDetails = details.forExecutor;
+
     const callService = async (details) => {
         const res = await fetch(details.url, {
             method: 'POST',
@@ -88,15 +94,15 @@ modAI.serviceExecutor = async (details) => {
         }
     };
 
-    if (!details.service || !details.parser) {
+    if (!executorDetails.service || !executorDetails.parser) {
         throw new Error(_('modai.cmp.service_required'));
     }
 
-    if (!services[details.service]?.[details.parser]) {
+    if (!services[executorDetails.service]?.[executorDetails.parser]) {
         throw new Error(_('modai.cmp.service_unsupported'));
     }
 
-    const data = await callService(details);
+    const data = await callService(executorDetails);
 
-    return services[details.service][details.parser](data);
+    return services[executorDetails.service][executorDetails.parser](data);
 }

core/components/modai/elements/plugins/modai.php

@@ -44,4 +44,4 @@
     $modx->regClientStartupScript($assetsUrl . 'js/mgr/autosummary.js');
     $modx->regClientStartupScript($assetsUrl . 'js/mgr/widgets/image_prompt.window.js');
     $modx->regClientStartupScript($assetsUrl . 'js/mgr/widgets/text_prompt.window.js');
-}
+}

core/components/modai/lexicon/en/default.inc.php

@@ -62,6 +62,8 @@
 $_lang['setting_modai.image.path_desc'] = 'Path including file name where the AI generated image will be stored. Available placeholders: {hash}, {shortHash}, {resourceId}.';
 $_lang['setting_modai.image.download_domains'] = 'Allowed Download Domains';
 $_lang['setting_modai.image.download_domains_desc'] = 'Additional domains to allow downloading generated images from.';
+$_lang['setting_modai.api.execute_on_server'] = 'Execute AI\'s request on server';
+$_lang['setting_modai.api.execute_on_server_desc'] = 'If enabled, allAI requests will be executed on server side. Be aware of increased load for your server.';
 
 $_lang['modai.error.compatability_mode'] = "Unsupported API compatibility mode (modai.api.custom.compatibility).";
 $_lang['modai.error.invalid_api_key'] = "Missing modai.api.[[+service]].key";
@@ -77,4 +79,4 @@
 $_lang['modai.error.image_required'] = "Image or URL is required";
 $_lang['modai.error.ms_required'] = "Media Source is required";
 $_lang['modai.error.prompt_required'] = "Prompt is required";
-$_lang['modai.error.resource_required'] = "Resource is required";
+$_lang['modai.error.resource_required'] = "Resource is required";

core/components/modai/src/Exceptions/LexiconException.php

@@ -0,0 +1,27 @@
+<?php
+namespace modAI\Exceptions;
+
+use Throwable;
+
+class LexiconException extends \Exception {
+    private string $lexicon;
+    private array $lexiconParams = [];
+
+    public function __construct($lexicon = "", array $lexiconParams = [], $code = 0, Throwable $previous = null)
+    {
+        $this->lexicon = $lexicon;
+        $this->lexiconParams = $lexiconParams;
+
+        parent::__construct($lexicon, $code, $previous);
+    }
+
+    public function getLexicon(): string
+    {
+        return $this->lexicon;
+    }
+
+    public function getLexiconParams(): array
+    {
+        return $this->lexiconParams;
+    }
+}

core/components/modai/src/Processors/Prompt/FreeText.php

@@ -44,7 +44,7 @@ public function process()
             $aiService = AIServiceFactory::new($model, $this->modx);
             $result = $aiService->getCompletions([$prompt], CompletionsConfig::new($model)->maxTokens($maxTokens)->temperature($temperature)->systemInstructions($systemInstructions));
 
-            return $this->success('', $result->toArray());
+            return $this->success('', $result->generate());
         } catch (\Exception $e) {
             return $this->failure($e->getMessage());
         }

core/components/modai/src/Processors/Prompt/Image.php

@@ -32,7 +32,7 @@ public function process()
             $aiService = AIServiceFactory::new($model, $this->modx);
             $result = $aiService->generateImage($prompt, ImageConfig::new($model)->size($size)->quality($quality));
 
-            return $this->success('', $result->toArray());
+            return $this->success('', $result->generate());
         } catch (\Exception $e) {
             return $this->failure($e->getMessage());
         }

core/components/modai/src/Processors/Prompt/Text.php

@@ -1,10 +1,12 @@
 <?php
 namespace modAI\Processors\Prompt;
 
+use modAI\Exceptions\LexiconException;
 use modAI\RequiredSettingException;
 use modAI\Services\AIServiceFactory;
 use modAI\Services\ChatGPT;
 use modAI\Services\Config\CompletionsConfig;
+use modAI\Services\Executor\ServiceExecutor;
 use modAI\Settings;
 use MODX\Revolution\Processors\Processor;
 
@@ -79,7 +81,9 @@ public function process()
             $aiService = AIServiceFactory::new($model, $this->modx);
             $result = $aiService->getCompletions([$content], CompletionsConfig::new($model)->maxTokens($maxTokens)->temperature($temperature)->systemInstructions($systemInstructions));
 
-            return $this->success('', $result->toArray());
+            return $this->success('', $result->generate());
+        } catch(LexiconException $e) {
+            return $this->failure($this->modx->lexicon($e->getLexicon(), $e->getLexiconParams()));
         } catch (\Exception $e) {
             return $this->failure($e->getMessage());
         }

core/components/modai/src/Processors/Prompt/Vision.php

@@ -26,7 +26,7 @@ public function process()
             $aiService = AIServiceFactory::new($model, $this->modx);
             $result = $aiService->getVision($prompt, $image, VisionConfig::new($model));
 
-            return $this->success('', $result->toArray());
+            return $this->success('', $result->generate());
         } catch (\Exception $e) {
             return $this->failure($e->getMessage());
         }

core/components/modai/src/Services/AIService.php

@@ -2,14 +2,26 @@
 
 namespace modAI\Services;
 
+use modAI\Exceptions\LexiconException;
 use modAI\Services\Config\CompletionsConfig;
 use modAI\Services\Config\ImageConfig;
 use modAI\Services\Config\VisionConfig;
 use modAI\Services\Response\AIResponse;
 
 interface AIService {
 
+    /**
+     * @throws LexiconException
+     */
     public function getCompletions(array $data, CompletionsConfig $config): AIResponse;
+
+    /**
+     * @throws LexiconException
+     */
     public function getVision(string $prompt, string $image, VisionConfig $config): AIResponse;
+
+    /**
+     * @throws LexiconException
+     */
     public function generateImage(string $prompt, ImageConfig $config): AIResponse;
 }