ai.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2024  Laurent Destailleur     <eldy@users.sourceforge.net>
 * Copyright (C) 2024       Frédéric France             <frederic.france@free.fr>
 * Copyright (C) 2024   MDW             <mdeweerd@users.noreply.github.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 * or see https://www.gnu.org/
 */
 
require_once DOL_DOCUMENT_ROOT."/core/lib/admin.lib.php";
require_once DOL_DOCUMENT_ROOT.'/core/lib/geturl.lib.php';
require_once DOL_DOCUMENT_ROOT."/ai/lib/ai.lib.php";
 
 
class Ai
{
  protected $db;
 
  private $apiService;
 
  private $apiKey;
 
  private $apiEndpoint;
 
  const AI_DEFAULT_PROMPT_FOR_EMAIL = 'You are an email editor. Return all HTML content inside a section tag. Do not add explanation.';
  const AI_DEFAULT_PROMPT_FOR_WEBPAGE = 'You are a website editor. Return all HTML content inside a section tag. Do not add explanation.';
  const AI_DEFAULT_PROMPT_FOR_TEXT_TRANSLATION = 'You are a translator, answer with one and only one translation with no comment and explanation.';
  const AI_DEFAULT_PROMPT_FOR_TEXT_SUMMARIZE = 'You are a writer, make the answer in the same language than the original text to summarize.';
  const AI_DEFAULT_PROMPT_FOR_TEXT_REPHRASER = 'You are a writer, give only one answer with no comment and explanation and give the answer in the same language than the original text to rephrase.';
  const AI_DEFAULT_PROMPT_FOR_EXTRAFIELD_FILLER = 'Give only one answer with no comment and explanation, I want the text to be ready to copy and paste.';
 
  public function __construct($db)
  {
    $this->db = $db;
 
    // Get API key according to enabled AI
    $this->apiService = getDolGlobalString('AI_API_SERVICE', 'chatgpt');
    $this->apiKey = getDolGlobalString('AI_API_'.strtoupper($this->apiService).'_KEY');
  }
 
  public function generateContent($instructions, $model = 'auto', $function = 'textgeneration', $format = '')
  {
    global $dolibarr_main_data_root;
 
    $arrayofai = getListOfAIServices();
 
    // TODO Can store the need for a key into array returned by getListOfAIServices()
    if (empty($this->apiKey) && in_array($this->apiService, array('chatgpt', 'groq', 'mistral'))) {
      return array('error' => true, 'message' => 'API key is not defined for the AI enabled service ('.$this->apiService.')');
    }
 
    // $this->apiEndpoint is already set here only if it was previously forced.
 
    if (empty($this->apiEndpoint) && $this->apiService == 'custom' && !getDolGlobalString('AI_API_CUSTOM_URL')) {
      return array('error' => true, 'message' => 'API URL is not defined for the AI enabled service ('.$this->apiService.')');
    }
 
    // In most cases, it is empty and we must get it from $function and $this->apiService
    if (empty($this->apiEndpoint)) {
      // Return the endpoint from $this->apiService.
      if ($function == 'imagegeneration') {
        $this->apiEndpoint = getDolGlobalString('AI_API_'.strtoupper($this->apiService).'_URL', $arrayofai[$this->apiService]['url']);
        $this->apiEndpoint .= (preg_match('/\/$/', $this->apiEndpoint) ? '' : '/').'images/generations';
      } elseif ($function == 'audiogeneration') {
        $this->apiEndpoint = getDolGlobalString('AI_API_'.strtoupper($this->apiService).'_URL', $arrayofai[$this->apiService]['url']);
        $this->apiEndpoint .= (preg_match('/\/$/', $this->apiEndpoint) ? '' : '/').'audio/speech';
      } elseif ($function == 'transcription') {
        $this->apiEndpoint = getDolGlobalString('AI_API_'.strtoupper($this->apiService).'_URL', $arrayofai[$this->apiService]['url']);
        $this->apiEndpoint .= (preg_match('/\/$/', $this->apiEndpoint) ? '' : '/').'transcriptions';
      } else {
        $this->apiEndpoint = getDolGlobalString('AI_API_'.strtoupper($this->apiService).'_URL', $arrayofai[$this->apiService]['url']);
        $this->apiEndpoint .= (preg_match('/\/$/', $this->apiEndpoint) ? '' : '/').'chat/completions';
      }
    }
 
    // $model may be undefined or 'auto'.
    // If this is the case, we must get it from $function and $this->apiService
    if (empty($model) || $model == 'auto') {
      // Return the model from $this->apiService.
      if ($function == 'imagegeneration') {
        $model = getDolGlobalString('AI_API_'.strtoupper($this->apiService).'_MODEL_IMAGE', $arrayofai[$this->apiService][$function]);
      } elseif ($function == 'audiogeneration') {
        $model = getDolGlobalString('AI_API_'.strtoupper($this->apiService).'_MODEL_AUDIO', $arrayofai[$this->apiService][$function]);
      } elseif ($function == 'transcription') {
        $model = getDolGlobalString('AI_API_'.strtoupper($this->apiService).'_MODEL_TRANSCRIPT', $arrayofai[$this->apiService][$function]);
      } elseif ($function == 'translation') {
        $model = getDolGlobalString('AI_API_'.strtoupper($this->apiService).'_MODEL_TRANSLATE', $arrayofai[$this->apiService][$function]);
      } else {
        // else 'textgenerationemail', 'textgenerationwebpage', 'textgeneration', 'texttranslation', 'textsummarize'
        $model = getDolGlobalString('AI_API_'.strtoupper($this->apiService).'_MODEL_TEXT', $arrayofai[$this->apiService]['textgeneration']);
      }
    }
 
    dol_syslog("Call API for apiKey=".substr($this->apiKey, 0, 5).'***********, apiEndpoint='.$this->apiEndpoint.", model=".$model);
 
    $response = null;
 
    try {
      if (empty($this->apiEndpoint)) {
        throw new Exception('The AI service '.$this->apiService.' is not yet supported for the type of request '.$function);
      }
 
      $configurationsJson = getDolGlobalString('AI_CONFIGURATIONS_PROMPT');
      $configurations = json_decode($configurationsJson, true);
 
      $prePrompt = '';
      $postPrompt = '';
 
      if (isset($configurations[$function])) {
        if (isset($configurations[$function]['prePrompt'])) {
          $prePrompt = $configurations[$function]['prePrompt'];
        }
 
        if (isset($configurations[$function]['postPrompt'])) {
          $postPrompt = $configurations[$function]['postPrompt'];
        }
      }
 
      // Get the default value of prePrompt if not defined
      if (empty($prePrompt) && $function == 'textgenerationemail') {
        $prePrompt = self::AI_DEFAULT_PROMPT_FOR_EMAIL;
      }
      if (empty($prePrompt) && $function == 'textgenerationwebpage') {
        $prePrompt = self::AI_DEFAULT_PROMPT_FOR_WEBPAGE;
      }
      if (empty($prePrompt) && $function == 'textgenerationextrafield') {
        $prePrompt = self::AI_DEFAULT_PROMPT_FOR_EXTRAFIELD_FILLER;
      }
      if (empty($prePrompt) && $function == 'texttranslation') {
        $prePrompt = self::AI_DEFAULT_PROMPT_FOR_TEXT_TRANSLATION;
      }
      if (empty($prePrompt) && $function == 'textsummarize') {
        $prePrompt = self::AI_DEFAULT_PROMPT_FOR_TEXT_SUMMARIZE;
      }
      if (empty($prePrompt) && $function == 'textrephraser') {
        $prePrompt = self::AI_DEFAULT_PROMPT_FOR_TEXT_REPHRASER;
      }
 
      $fullInstructions = $instructions.($postPrompt ? (preg_match('/[\.\!\?]$/', $instructions) ? '' : '.').' '.$postPrompt : '');
 
      // Set payload string
      /*{
        "messages": [
        {
          "content": "You are a helpful assistant.",
          "role": "system"
        },
        {
          "content": "Hello!",
          "role": "user"
        }
        ],
        "model": "tinyllama-1.1b",
        "stream": true,
        "max_tokens": 2048,
        "stop": [
          "hello"
        ],
        "frequency_penalty": 0,
        "presence_penalty": 0,
        "temperature": 0.7,
        "top_p": 0.95
      }*/
 
      $arrayforpayload = array(
        'messages' => array(array('role' => 'user', 'content' => $fullInstructions)),
        'model' => $model,
      );
 
      // Add a system message
      $addDateTimeContext = false;
      if ($addDateTimeContext) {    // @phpstan-ignore-line
        $prePrompt = ($prePrompt ? $prePrompt.(preg_match('/[\.\!\?]$/', $prePrompt) ? '' : '.').' ' : '').'Today we are '.dol_print_date(dol_now(), 'dayhourtext');
      }
      if ($prePrompt) {
        $arrayforpayload['messages'][] = array('role' => 'system', 'content' => $prePrompt);
      }
 
      /*
      $arrayforpayload['temperature'] = 0.7;
      $arrayforpayload['max_tokens'] = -1;
      $arrayforpayload['stream'] = false;
      */
 
      $payload = json_encode($arrayforpayload);
 
      $headers = array(
        'Authorization: Bearer ' . $this->apiKey,
        'Content-Type: application/json'
      );
 
      if (getDolGlobalString("AI_DEBUG")) {
        if (@is_writable($dolibarr_main_data_root)) { // Avoid fatal error on fopen with open_basedir
          $outputfile = $dolibarr_main_data_root."/dolibarr_ai.log";
          $fp = fopen($outputfile, "w");  // overwrite
 
          if ($fp) {
            fwrite($fp, "Call endpoint ".$this->apiEndpoint." with POST and the following HTTP headers and Payload:\n");
            fwrite($fp, var_export($headers, true)."\n");
            fwrite($fp, var_export($payload, true)."\n");
 
            fclose($fp);
            dolChmod($outputfile);
          }
        }
      }
 
      // By default, we accept only external endpoints ($dolibarr_ai_allow_local_endpoints is not set).
      // To allow local endpoints, we must set $dolibarr_ai_allow_local_endpoints to 1 or 2 in conf.php.
      global $dolibarr_ai_allow_local_endpoints;
      $localurl = $dolibarr_ai_allow_local_endpoints ?? 0;
 
      $response = getURLContent($this->apiEndpoint, 'POST', $payload, 1, $headers, array('http', 'https'), $localurl);
 
      if (empty($response['http_code'])) {
        throw new Exception('API request failed. No http received');
      }
      if (!empty($response['http_code']) && $response['http_code'] != 200) {
        if (in_array($response['http_code'], array(400, 401, 403, 429)) && !empty($response['content'])) {
          $tmp = json_decode($response['content'], true);
          if (!empty($tmp['message'])) {
            return array(
              'error' => true,
              'message' => $tmp['message'],
              'code' => (empty($response['http_code']) ? 0 : $response['http_code']),
              'curl_error_no' => (empty($response['curl_error_no']) ? 0 : $response['curl_error_no']),
              'format' => $format,
              'service' => $this->apiService,
              'function' => $function
            );
          }
        }
        throw new Exception('API request on AI endpoint '.$this->apiEndpoint.' failed with status code '.$response['http_code']);
      }
 
      if (getDolGlobalString("AI_DEBUG")) {
        if (@is_writable($dolibarr_main_data_root)) { // Avoid fatal error on fopen with open_basedir
          $outputfile = $dolibarr_main_data_root."/dolibarr_ai.log";
          $fp = fopen($outputfile, "a");
 
          if ($fp) {
            fwrite($fp, var_export((empty($response['content']) ? 'No content result' : $response['content']), true)."\n");
 
            fclose($fp);
            dolChmod($outputfile);
          }
        }
      }
 
 
      // Decode JSON response
      $decodedResponse = json_decode($response['content'], true);
 
      // Extraction content
      if (!empty($decodedResponse['error'])) {
        if (is_scalar($decodedResponse['error'])) {
          $generatedContent = $decodedResponse['error'];
        } else {
          $generatedContent = var_export($decodedResponse['error'], true);
        }
      } else {
        $generatedContent = $decodedResponse['choices'][0]['message']['content'];
      }
      dol_syslog("ai->generatedContent returned: ".dol_trunc($generatedContent, 50));
 
      // If content is not HTML, we convert it into HTML
      if ($format == 'html') {
        if (!dol_textishtml($generatedContent)) {
          dol_syslog("Result was detected as not HTML so we convert it into HTML.");
          $generatedContent = dol_nl2br($generatedContent);
        } else {
          dol_syslog("Result was detected as already HTML. Do nothing.");
        }
 
        // TODO If content is for website module, we must
        // - clan html header, keep body only and remove ``` ticks added by AI
        // - add tags <section contenEditable="true"> </section>
      }
 
      return $generatedContent;
    } catch (Exception $e) {
      $errormessage = $e->getMessage();
      $errormessagelog = $e->getMessage();
      if (!empty($response['content'])) {
        $decodedResponse = json_decode($response['content'], true);
        $errormessagelog .= ' - '.$response['content'];
 
        if (!empty($decodedResponse['error']['message'])) {
          // With OpenAI, error is into an object error into the content
          $errormessage .= ' - '.$decodedResponse['error']['message'];
        } else {
          $errormessage .= ' - '.$response['content'];
        }
      }
 
      if (getDolGlobalString("AI_DEBUG")) {
        if (@is_writable($dolibarr_main_data_root)) { // Avoid fatal error on fopen with open_basedir
          $outputfile = $dolibarr_main_data_root."/dolibarr_ai.log";
          $fp = fopen($outputfile, "a");
 
          if ($fp) {
            fwrite($fp, "Error: ".$errormessagelog."\n");
 
            fclose($fp);
            dolChmod($outputfile);
          }
        }
      }
 
      return array(
        'error' => true,
        'message' => $errormessage,
        'code' => (empty($response['http_code']) ? 0 : $response['http_code']),
        'curl_error_no' => (empty($response['curl_error_no']) ? 0 : $response['curl_error_no']),
        'format' => $format,
        'service' => $this->apiService,
        'function' => $function
      );
    }
  }
}