xref: /plugin/aichat/helper.php (revision 666b8ea780a78b4ff2dd542c18bf1bb6da1ad2d3)

<?php

use dokuwiki\Extension\CLIPlugin;
use dokuwiki\Extension\Plugin;
use dokuwiki\plugin\aichat\AIChat;
use dokuwiki\plugin\aichat\Chunk;
use dokuwiki\plugin\aichat\Embeddings;
use dokuwiki\plugin\aichat\Model\ChatInterface;
use dokuwiki\plugin\aichat\Model\EmbeddingInterface;
use dokuwiki\plugin\aichat\ModelFactory;
use dokuwiki\plugin\aichat\Storage\AbstractStorage;

/**
 * DokuWiki Plugin aichat (Helper Component)
 *
 * @license GPL 2 http://www.gnu.org/licenses/gpl-2.0.html
 * @author  Andreas Gohr <gohr@cosmocode.de>
 */
class helper_plugin_aichat extends Plugin
{
    /** @var ModelFactory */
    public $factory;

    /** @var CLIPlugin $logger */
    protected $logger;

    /** @var Embeddings */
    protected $embeddings;
    /** @var AbstractStorage */
    protected $storage;

    /** @var array where to store meta data on the last run */
    protected $runDataFile;


    /**
     * Constructor. Initializes vendor autoloader
     */
    public function __construct()
    {
        require_once __DIR__ . '/vendor/autoload.php'; // FIXME obsolete from Kaos onwards
        global $conf;
        $this->runDataFile = $conf['metadir'] . '/aichat__run.json';
        $this->loadConfig();
        $this->factory = new ModelFactory($this->conf);
    }

    /**
     * Use the given CLI plugin for logging
     *
     * @param CLIPlugin $logger
     * @return void
     */
    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)
     *
     * @return bool
     */
    public function userMayAccess()
    {
        global $auth;
        global $USERINFO;
        global $INPUT;

        if (!$auth) return true;
        if (!$this->getConf('restrict')) return true;
        if (!isset($USERINFO)) return false;

        return auth_isMember($this->getConf('restrict'), $INPUT->server->str('REMOTE_USER'), $USERINFO['grps']);
    }

    /**
     * Access the Chat Model
     *
     * @return ChatInterface
     */
    public function getChatModel()
    {
        return $this->factory->getChatModel();
    }

    /**
     * @return ChatInterface
     */
    public function getRephraseModel()
    {
        return $this->factory->getRephraseModel();
    }

    /**
     * Access the Embedding Model
     *
     * @return EmbeddingInterface
     */
    public function getEmbeddingModel()
    {
        return $this->factory->getEmbeddingModel();
    }

    /**
     * Access the Embeddings interface
     *
     * @return Embeddings
     */
    public function getEmbeddings()
    {
        if ($this->embeddings instanceof Embeddings) {
            return $this->embeddings;
        }

        $this->embeddings = new Embeddings(
            $this->getChatModel(),
            $this->getEmbeddingModel(),
            $this->getStorage(),
            $this->conf
        );
        if ($this->logger) {
            $this->embeddings->setLogger($this->logger);
        }

        return $this->embeddings;
    }

    /**
     * Access the Storage interface
     *
     * @return AbstractStorage
     */
    public function getStorage()
    {
        if ($this->storage instanceof AbstractStorage) {
            return $this->storage;
        }

        $class = '\\dokuwiki\\plugin\\aichat\\Storage\\' . $this->getConf('storage') . 'Storage';
        $this->storage = new $class($this->conf);

        if ($this->logger) {
            $this->storage->setLogger($this->logger);
        }

        return $this->storage;
    }

    /**
     * Ask a question with a chat history
     *
     * @param string $question
     * @param array[] $history The chat history [[user, ai], [user, ai], ...]
     * @return array ['question' => $question, 'answer' => $answer, 'sources' => $sources]
     * @throws Exception
     */
    public function askChatQuestion($question, $history = [])
    {
        if ($history && $this->getConf('rephraseHistory') > 0) {
            $contextQuestion = $this->rephraseChatQuestion($question, $history);

            // Only use the rephrased question if it has more history than the chat history provides
            if ($this->getConf('rephraseHistory') > $this->getConf('chatHistory')) {
                $question = $contextQuestion;
            }
        } else {
            $contextQuestion = $question;
        }
        return $this->askQuestion($question, $history, $contextQuestion);
    }

    /**
     * Ask a single standalone question
     *
     * @param string $question The question to ask
     * @param array $history [user, ai] of the previous question
     * @param string $contextQuestion The question to use for context search
     * @return array ['question' => $question, 'answer' => $answer, 'sources' => $sources]
     * @throws Exception
     */
    public function askQuestion($question, $history = [], $contextQuestion = '')
    {
        $similar = $this->getEmbeddings()->getSimilarChunks($contextQuestion ?: $question, $this->getLanguageLimit());
        if ($similar) {
            $context = implode(
                "\n",
                array_map(static fn(Chunk $chunk) => "\n```\n" . $chunk->getText() . "\n```\n", $similar)
            );
            $prompt = $this->getPrompt('question', [
                'context' => $context,
                'question' => $question,
                'customprompt' => $this->getConf('customprompt'),
            ]);
        } else {
            $prompt = $this->getPrompt('noanswer', [
                'question' => $question,
            ]);
            $history = [];
        }

        $messages = $this->prepareMessages(
            $this->getChatModel(),
            $prompt,
            $history,
            $this->getConf('chatHistory')
        );
        $answer = $this->getChatModel()->getAnswer($messages);

        return [
            'question' => $question,
            'contextQuestion' => $contextQuestion,
            'answer' => $answer,
            'sources' => $similar,
        ];
    }

    /**
     * Rephrase a question into a standalone question based on the chat history
     *
     * @param string $question The original user question
     * @param array[] $history The chat history [[user, ai], [user, ai], ...]
     * @return string The rephrased question
     * @throws Exception
     */
    public function rephraseChatQuestion($question, $history)
    {
        $prompt = $this->getPrompt('rephrase', [
            'question' => $question,
        ]);
        $messages = $this->prepareMessages(
            $this->getRephraseModel(),
            $prompt,
            $history,
            $this->getConf('rephraseHistory')
        );
        return $this->getRephraseModel()->getAnswer($messages);
    }

    /**
     * Prepare the messages for the AI
     *
     * @param ChatInterface $model The used model
     * @param string $promptedQuestion The user question embedded in a prompt
     * @param array[] $history The chat history [[user, ai], [user, ai], ...]
     * @param int $historySize The maximum number of messages to use from the history
     * @return array An OpenAI compatible array of messages
     */
    protected function prepareMessages(
        ChatInterface $model,
        string $promptedQuestion,
        array $history,
        int $historySize
    ): array {
        // calculate the space for context
        $remainingContext = $model->getMaxInputTokenLength();
        $remainingContext -= $this->countTokens($promptedQuestion);
        $safetyMargin = $remainingContext * 0.05; // 5% safety margin
        $remainingContext -= $safetyMargin;
        // FIXME we may want to also have an upper limit for the history and not always use the full context

        $messages = $this->historyMessages($history, $remainingContext, $historySize);
        $messages[] = [
            'role' => 'user',
            'content' => $promptedQuestion
        ];
        return $messages;
    }

    /**
     * Create an array of OpenAI compatible messages from the given history
     *
     * Only as many messages are used as fit into the token limit
     *
     * @param array[] $history The chat history [[user, ai], [user, ai], ...]
     * @param int $tokenLimit The maximum number of tokens to use
     * @param int $sizeLimit The maximum number of messages to use
     * @return array
     */
    protected function historyMessages(array $history, int $tokenLimit, int $sizeLimit): array
    {
        $remainingContext = $tokenLimit;

        $messages = [];
        $history = array_reverse($history);
        $history = array_slice($history, 0, $sizeLimit);
        foreach ($history as $row) {
            $length = $this->countTokens($row[0] . $row[1]);
            if ($length > $remainingContext) {
                break;
            }
            $remainingContext -= $length;

            $messages[] = [
                'role' => 'assistant',
                'content' => $row[1]
            ];
            $messages[] = [
                'role' => 'user',
                'content' => $row[0]
            ];
        }
        return array_reverse($messages);
    }

    /**
     * Get an aproximation of the token count for the given text
     *
     * @param $text
     * @return int
     */
    protected function countTokens($text)
    {
        return count($this->getEmbeddings()->getTokenEncoder()->encode($text));
    }

    /**
     * Load the given prompt template and fill in the variables
     *
     * @param string $type
     * @param string[] $vars
     * @return string
     */
    protected function getPrompt($type, $vars = [])
    {
        $template = file_get_contents($this->localFN($type, 'prompt'));
        $vars['language'] = $this->getLanguagePrompt();

        $replace = [];
        foreach ($vars as $key => $val) {
            $replace['{{' . strtoupper($key) . '}}'] = $val;
        }

        return strtr($template, $replace);
    }

    /**
     * Construct the prompt to define the answer language
     *
     * @return string
     */
    protected function getLanguagePrompt()
    {
        global $conf;
        $isoLangnames = include(__DIR__ . '/lang/languages.php');

        $currentLang = $isoLangnames[$conf['lang']] ?? 'English';

        if ($this->getConf('preferUIlanguage') > AIChat::LANG_AUTO_ALL) {
            if (isset($isoLangnames[$conf['lang']])) {
                $languagePrompt = 'Always answer in ' . $isoLangnames[$conf['lang']] . '.';
                return $languagePrompt;
            }
        }

        $languagePrompt = 'Always answer in the user\'s language. ' .
            "If you are unsure about the language, speak $currentLang.";
        return $languagePrompt;
    }

    /**
     * Should sources be limited to current language?
     *
     * @return string The current language code or empty string
     */
    public function getLanguageLimit()
    {
        if ($this->getConf('preferUIlanguage') >= AIChat::LANG_UI_LIMITED) {
            global $conf;
            return $conf['lang'];
        } else {
            return '';
        }
    }

    /**
     * Store info about the last run
     *
     * @param array $data
     * @return void
     */
    public function setRunData(array $data)
    {
        file_put_contents($this->runDataFile, json_encode($data, JSON_PRETTY_PRINT));
    }

    /**
     * Get info about the last run
     *
     * @return array
     */
    public function getRunData()
    {
        if (!file_exists($this->runDataFile)) {
            return [];
        }
        return json_decode(file_get_contents($this->runDataFile), true);
    }
}