mechanisms to override things on command line

This should help with debugging/evaluating

Author: splitbrain

AbstractCLI.php

@@ -0,0 +1,54 @@
+<?php
+
+namespace dokuwiki\plugin\aichat;
+
+use splitbrain\phpcli\Options;
+
+abstract class AbstractCLI extends \dokuwiki\Extension\CLIPlugin
+{
+    /** @var \helper_plugin_aichat */
+    protected $helper;
+
+    /** @inheritdoc */
+    public function __construct($autocatch = true)
+    {
+        parent::__construct($autocatch);
+        $this->helper = plugin_load('helper', 'aichat');
+        $this->helper->setLogger($this);
+        $this->loadConfig();
+        ini_set('memory_limit', -1);
+    }
+
+    /** @inheritdoc */
+    protected function setup(Options $options)
+    {
+        $options->useCompactHelp();
+
+        $options->registerOption(
+            'lang',
+            'When set to a language code, it overrides the the lang and preferUIlanguage settings and asks the ' .
+            'bot to always use this language instead. ' .
+            'When set to "auto" the bot is asked to detect the language of the input falling back to the wiki lang.',
+            '',
+            'lang'
+        );
+    }
+
+    /** @inheritDoc */
+    protected function main(Options $options)
+    {
+        if ($this->loglevel['debug']['enabled']) {
+            $this->helper->factory->setDebug(true);
+        }
+
+        $lc = $options->getOpt('lang');
+        if ($lc === 'auto') {
+            $this->helper->updateConfig(['preferUIlanguage' => 0]);
+        } else if ($lc) {
+            $this->helper->updateConfig(['preferUIlanguage' => 1]);
+            global $conf;
+            $conf['lang'] = $lc;
+        }
+
+    }
+}

ModelFactory.php

@@ -24,6 +24,19 @@ public function __construct(array $config)
         $this->config = $config;
     }
 
+    /**
+     * Update the configuration and reset the cached models
+     *
+     * @param array $config The new (partial) configuration
+     */
+    public function updateConfig(array $config)
+    {
+        $this->config = array_merge($this->config, $config);
+        $this->chatModel = null;
+        $this->rephraseModel = null;
+        $this->embeddingModel = null;
+    }
+
     /**
      * Set the debug flag for all models
      *
@@ -49,6 +62,7 @@ public function getChatModel()
             return $this->chatModel;
         }
         $this->chatModel = $this->loadModel('chat', $this->config['chatmodel']);
+        $this->chatModel->setDebug($this->debug);
         return $this->chatModel;
     }
 
@@ -64,6 +78,7 @@ public function getRephraseModel()
             return $this->rephraseModel;
         }
         $this->rephraseModel = $this->loadModel('chat', $this->config['chatmodel']);
+        $this->rephraseModel->setDebug($this->debug);
         return $this->rephraseModel;
     }
 
@@ -78,6 +93,7 @@ public function getEmbeddingModel()
             return $this->embeddingModel;
         }
         $this->embeddingModel = $this->loadModel('embedding', $this->config['embedmodel']);
+        $this->embeddingModel->setDebug($this->debug);
         return $this->embeddingModel;
     }
 

cli.php

@@ -1,6 +1,7 @@
 <?php
 
 use dokuwiki\Extension\CLIPlugin;
+use dokuwiki\plugin\aichat\AbstractCLI;
 use dokuwiki\plugin\aichat\Chunk;
 use dokuwiki\plugin\aichat\ModelFactory;
 use dokuwiki\Search\Indexer;
@@ -14,30 +15,28 @@
  * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
  * @author  Andreas Gohr <gohr@cosmocode.de>
  */
-class cli_plugin_aichat extends CLIPlugin
+class cli_plugin_aichat extends AbstractCLI
 {
     /** @var helper_plugin_aichat */
     protected $helper;
 
-    /** @inheritdoc */
-    public function __construct($autocatch = true)
-    {
-        parent::__construct($autocatch);
-        $this->helper = plugin_load('helper', 'aichat');
-        $this->helper->setLogger($this);
-        $this->loadConfig();
-    }
-
     /** @inheritDoc */
     protected function setup(Options $options)
     {
-        $options->useCompactHelp();
+        parent::setup($options);
 
         $options->setHelp(
             'Manage and query the AI chatbot data. Please note that calls to your LLM provider will be made. ' .
             'This may incur costs.'
         );
 
+        $options->registerOption(
+            'model',
+            'Overrides the chat and rephrasing model settings and uses this model instead',
+            '',
+            'model'
+        );
+
         $options->registerCommand(
             'embed',
             'Create embeddings for all pages. This skips pages that already have embeddings'
@@ -80,11 +79,15 @@ protected function setup(Options $options)
     /** @inheritDoc */
     protected function main(Options $options)
     {
-        if ($this->loglevel['debug']['enabled']) {
-            $this->helper->factory->setDebug(true);
+        parent::main($options);
+
+        $model = $options->getOpt('model');
+        if($model) {
+            $this->helper->updateConfig(
+                ['chatmodel' => $model, 'rephasemodel' => $model]
+            );
         }
 
-        ini_set('memory_limit', -1);
         switch ($options->getCmd()) {
             case 'embed':
                 $this->createEmbeddings($options->getOpt('clear'));

cli/simulate.php

@@ -1,6 +1,7 @@
 <?php
 
 use dokuwiki\Extension\CLIPlugin;
+use dokuwiki\plugin\aichat\AbstractCLI;
 use dokuwiki\plugin\aichat\ModelFactory;
 use splitbrain\phpcli\Colors;
 use splitbrain\phpcli\Options;
@@ -11,25 +12,16 @@
  * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
  * @author  Andreas Gohr <gohr@cosmocode.de>
  */
-class cli_plugin_aichat_simulate extends CLIPlugin
+class cli_plugin_aichat_simulate extends AbstractCLI
 {
-    /** @var helper_plugin_aichat */
-    protected $helper;
-
-    /** @inheritdoc */
-    public function __construct($autocatch = true)
-    {
-        parent::__construct($autocatch);
-        $this->helper = plugin_load('helper', 'aichat');
-        $this->helper->setLogger($this);
-        $this->loadConfig();
-    }
 
 
     /** @inheritDoc */
     protected function setup(Options $options)
     {
-        $options->setHelp('Run a prpared chat session against multiple models');
+        parent::setup($options);
+
+        $options->setHelp('Run a prepared chat session against multiple models');
         $options->registerArgument('input', 'A file with the chat questions. Each question separated by two newlines');
         $options->registerArgument('output', 'Where to write the result CSV to');
 
@@ -44,14 +36,12 @@ protected function setup(Options $options)
     /** @inheritDoc */
     protected function main(Options $options)
     {
-        if ($this->loglevel['debug']['enabled']) {
-            $this->helper->factory->setDebug(true);
-        }
+        parent::main($options);
 
         [$input, $output] = $options->getArgs();
         $questions = $this->readInputFile($input);
-        $outfh = @fopen($output, 'w');
-        if (!$outfh) throw new \Exception("Could not open $output for writing");
+        $outFH = @fopen($output, 'w');
+        if (!$outFH) throw new \Exception("Could not open $output for writing");
 
         $models = $this->helper->factory->getModels(true, 'chat');
 
@@ -65,9 +55,9 @@ protected function main(Options $options)
         }
 
         foreach ($this->records2rows($results) as $row) {
-            fputcsv($outfh, $row);
+            fputcsv($outFH, $row);
         }
-        fclose($outfh);
+        fclose($outFH);
         $this->success("Results written to $output");
     }
 
@@ -88,6 +78,7 @@ protected function simulate($questions, $model)
             $this->colors->ptln($q, Colors::C_LIGHTPURPLE);
             $result = $this->helper->askChatQuestion($q, $history);
             $history[] = [$result['question'], $result['answer']];
+            $this->colors->ptln($result['question'], Colors::C_LIGHTBLUE);
 
             $record = [
                 'question' => $q,

helper.php

@@ -56,6 +56,18 @@ public function setLogger($logger)
         $this->logger = $logger;
     }
 
+    /**
+     * Update the configuration
+     *
+     * @param array $config
+     * @return void
+     */
+    public function updateConfig(array $config)
+    {
+        $this->conf = array_merge($this->conf, $config);
+        $this->factory->updateConfig($config);
+    }
+
     /**
      * Check if the current user is allowed to use the plugin (if it has been restricted)
      *
@@ -240,10 +252,11 @@ public function rephraseChatQuestion($question, $history)
      */
     protected function prepareMessages(
         ChatInterface $model,
-        string $promptedQuestion,
-        array $history,
-        int $historySize
-    ): array {
+        string        $promptedQuestion,
+        array         $history,
+        int           $historySize
+    ): array
+    {
         // calculate the space for context
         $remainingContext = $model->getMaxInputTokenLength();
         $remainingContext -= $this->countTokens($promptedQuestion);

lang/en/question.prompt

@@ -1,9 +1,9 @@
-Use the following documents as context to answer the users question.
-If you don't know the answer, just say that you don't know, don't try to make up an answer.
-{{LANGUAGE}}
+Your Task: Use the following documents as context to answer the users question. If you don't know the answer, just say that you don't know, don't try to make up an answer. {{LANGUAGE}}
+
 ----------------
 {{CONTEXT}}
 ----------------
 
 User Question: {{QUESTION}}
+
 Your Reply:

lang/en/rephrase.prompt

@@ -1,6 +1,5 @@
-Given the previous conversation and the users follow-up question, rephrase the user's follow-up question to be a standalone question that is understandable without the previous context.
-{{LANGUAGE}}
-Only reply with the rephrased question, do not answer it.
+Your Task: Given the previous conversation and the users follow-up question, rephrase the user's follow-up question to be a standalone question that is understandable without the previous context. {{LANGUAGE}} Only reply with the rephrased question, do not answer it.
+
+User Follow-up question: {{QUESTION}}
 
-Follow-up question: {{QUESTION}}
 Standalone question: