feat: add to the tool's getParameters and getPrompt methods as an argument

Author: theboxer

core/components/modai/controllers/tool/update.class.php

@@ -22,7 +22,7 @@ public function process(array $scriptProperties = [])
 
         $this->toolData = $tool->toArray();
         $this->toolData['classConfig'] = $this->toolData['class']::getConfig($this->modx);
-        $this->toolData['defaultPrompt'] = $this->toolData['class']::getPrompt();
+        $this->toolData['defaultPrompt'] = $this->toolData['class']::getPrompt($this->modx);
     }
 
     public function getPageTitle()
@@ -44,7 +44,7 @@ public function loadCustomCssJs()
         $this->addHtml('
         <script type="text/javascript">
             Ext.onReady(function() {
-                MODx.load({ 
+                MODx.load({
                     xtype: "modai-page-tool",
                     record: ' . $this->modx->toJSON($this->toolData) . ',
                     permissions: ' . json_encode($this->permissions) . '

core/components/modai/src/API/Prompt/Chat.php

@@ -96,7 +96,6 @@ public function post(ServerRequestInterface $request): void
 
                         Settings::setSetting($this->modx, "$customOptionsKey.agent_options", json_encode($customOptionsValue));
                     }
-
                 }
             }
         }
@@ -167,7 +166,7 @@ public function post(ServerRequestInterface $request): void
         $aiService = AIServiceFactory::new($model, $this->modx);
         $result = $aiService->getCompletions(
             $userMessages,
-            CompletionsConfig::new($model)
+            CompletionsConfig::new($model, $this->modx)
                 ->tools($tools)
                 ->messages($messages)
                 ->options(['max_tokens' => $maxTokens, 'temperature' => $temperature], $customOptions, $agentOptions, $additionalOptions)

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

@@ -46,7 +46,7 @@ public function post(ServerRequestInterface $request): void
         $aiService = AIServiceFactory::new($model, $this->modx);
         $result = $aiService->generateImage(
             $prompt,
-            ImageConfig::new($model)
+            ImageConfig::new($model, $this->modx)
                 ->options(['quality' => $quality, 'style' => $style, 'size' => $size, 'response_format' => $responseFormat], $customOptions, $additionalOptions)
                 ->attachments($attachments)
         );

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

@@ -91,7 +91,7 @@ public function post(ServerRequestInterface $request): void
         $aiService = AIServiceFactory::new($model, $this->modx);
         $result = $aiService->getCompletions(
             [['content' => $content]],
-            CompletionsConfig::new($model)
+            CompletionsConfig::new($model, $this->modx)
                 ->options(['max_tokens' => $maxTokens, 'temperature' => $temperature], $customOptions)
                 ->systemInstructions($systemInstructions)
                 ->stream($stream)

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

@@ -43,7 +43,7 @@ public function post(ServerRequestInterface $request): void
         $result = $aiService->getVision(
             $prompt,
             $image,
-            VisionConfig::new($model)
+            VisionConfig::new($model, $this->modx)
                 ->options(['max_tokens' => $maxTokens], $customOptions)
                 ->stream($stream)
         );

core/components/modai/src/Processors/Combos/ToolClass.php

@@ -40,13 +40,13 @@ public function process()
             }
         }
 
-        return $this->outputArray(array_map(function($class) {
+        return $this->outputArray(array_map(function ($class) {
             return [
                 'class' => $class,
                 'config' => $class::getConfig($this->modx),
                 'suggestedName' => $class::getSuggestedName(),
                 'description' => $class::getDescription(),
-                'defaultPrompt' => $class::getPrompt(),
+                'defaultPrompt' => $class::getPrompt($this->modx),
             ];
         }, $classes), count($classes));
     }

core/components/modai/src/Services/Config/CompletionsConfig.php

@@ -76,8 +76,8 @@ public function getTools(): array
             $prompt = $tool->get('prompt');
             $tools[] = [
                 'name' => $toolName,
-                'description' => !empty($prompt) ? $prompt : $toolClass::getPrompt(),
-                'parameters' => $toolClass::getParameters(),
+                'description' => !empty($prompt) ? $prompt : $toolClass::getPrompt($this->modx),
+                'parameters' => $toolClass::getParameters($this->modx),
             ];
         }
 

core/components/modai/src/Services/Config/Model.php

@@ -2,18 +2,22 @@
 
 namespace modAI\Services\Config;
 
+use MODX\Revolution\modX;
+
 trait Model
 {
     private string $model;
+    private modX $modx;
 
-    private function __construct(string $model)
+    private function __construct(string $model, modX $modx)
     {
         $this->model = $model;
+        $this->modx = $modx;
     }
 
-    public static function new(string $model): self
+    public static function new(string $model, modX $modx): self
     {
-        return new self($model);
+        return new self($model, $modx);
     }
 
     public function getModel(): string

core/components/modai/src/Tools/CreateCategory.php

@@ -14,12 +14,12 @@ public static function getSuggestedName(): string
         return 'create_category';
     }
 
-    public static function getPrompt(): string
+    public static function getPrompt(modX $modx): string
     {
         return "Creates a new Category that any element (chunks or templates) can be grouped by. Use the get categories tool first to check if a category already exists. When successful, this tool returns the category ID to use when creating chunks or templates.";
     }
 
-    public static function getParameters(): array
+    public static function getParameters(modX $modx): array
     {
         return [
             'type' => 'object',

core/components/modai/src/Tools/CreateChunk.php

@@ -14,12 +14,12 @@ public static function getSuggestedName(): string
         return 'create_chunk';
     }
 
-    public static function getPrompt(): string
+    public static function getPrompt(modX $modx): string
     {
         return "Creates a new Chunk, which is a reusable piece of HTML or other code that can be inserted into pages, templates, or other elements. Use when explicitly asked to create a chunk or when creating templates to break up reusable pieces. Once created, chunks can be rendered by using [[\$name_of_chunk]] in a template or elsewhere. ALWAYS ask for explicit user confirmation with the chunk name, description, and category name in a separate message BEFORE calling this function.";
     }
 
-    public static function getParameters(): array
+    public static function getParameters(modX $modx): array
     {
         return [
             'type' => 'object',