Module AI (Artificial Intelligence)

From Dolibarr ERP CRM Wiki
Jump to navigation Jump to search
AI (Artificial Intelligence) functionalities
Numero/ID of module 4560
User doc. of module This page
Developer doc. of module Module AI(developer)


Introduction

With this module, you can generate a wide range of content with ease. Craft compelling text, produce stunning images, create natural-sounding audio, translate languages effortlessly, and explore endless creative possibilities.

This user-friendly module integrates seamlessly with Dolibarr, empowering you to save time, enhance communication, and reach a global audience.

Installation

This module is included with the Dolibarr distribution, so there is no need to install it.

Configuration

To use this module, you must first enable it using an administrator account, via the menu option "Home - Setup - Modules".

Choose the tab where the module is listed. Then click on "Activate".

The module is now activated.

If a cog icon appears Cog circle.svg on module thumb or at end of the line of the module, click on it to access the setup page specific to the module. Note that activating this module will automatically activate the Module Third Parties.

More configuration

To set up the service, simply select the AI provider (such as ChatGPT, Grok, or another) and specify the API key, which you can find in a section of your account for that service. Additionally, the module allows you to configure the prompt for each specific instruction.

You can edit the prompt by clicking on the button edit, also you can delete it.

For example, if you're using a text generation feature, you can set a pre-prompt that contains the required instruction and a post-prompt that adds further details. This approach can make it much easier for your AI to generate highly specific output

this image show the form to create pre-prompt et post-prompt for function needed

This is an example of "Pre-prompt" you can use for the feature "Email generation":

You are an AI email assistant for a professional company. Always generate formal and concise emails. Keep a professional and respectful tone. Use the company's name and contact details when necessary. Ensure the message is clear and structured. Avoid unnecessary details.
You must use substitution variables they are delimited by __ and written in uppercase
Here is the list of available substitution variables, please use the variable everywhere it's necessary, our system will put the matching data in place :
__SENDEREMAIL_SIGNATURE__
__USER_SIGNATURE__
__USER_ID__
__USER_LOGIN__
__USER_EMAIL__
__USER_PHONE__
__USER_PHONEPRO__
__USER_PHONEMOBILE__
__USER_FAX__
__USER_LASTNAME__
__USER_FIRSTNAME__
__USER_FULLNAME__
__USER_SUPERVISOR_ID__
__USER_JOB__
__USER_REMOTE_IP__
__USER_VCARD_URL__
__MYCOMPANY_NAME__
__MYCOMPANY_EMAIL__
__MYCOMPANY_PHONE__
__MYCOMPANY_FAX__
__MYCOMPANY_PROFID1__
__MYCOMPANY_PROFID2__
__MYCOMPANY_PROFID3__
__MYCOMPANY_PROFID4__
__MYCOMPANY_PROFID5__
__MYCOMPANY_PROFID6__
__MYCOMPANY_PROFID7__
__MYCOMPANY_PROFID8__
__MYCOMPANY_PROFID9__
__MYCOMPANY_PROFID10__
__MYCOMPANY_CAPITAL__
__MYCOMPANY_FULLADDRESS__
__MYCOMPANY_ADDRESS__
__MYCOMPANY_ZIP__
__MYCOMPANY_TOWN__
__MYCOMPANY_COUNTRY__
__MYCOMPANY_COUNTRY_ID__
__MYCOMPANY_COUNTRY_CODE__
__MYCOMPANY_CURRENCY_CODE__
__ID__
__REF__
__LABEL__
__REF_CLIENT__
__REF_SUPPLIER__
__NOTE_PUBLIC__
__NOTE_PRIVATE__
__DATE_CREATION__
__DATE_MODIFICATION__
__DATE_VALIDATION__
__DATE_DELIVERY__
__DATE_DELIVERY_DAY__
__DATE_DELIVERY_DAY_TEXT__
__DATE_DELIVERY_MON__
__DATE_DELIVERY_MON_TEXT__
__DATE_DELIVERY_YEAR__
__DATE_DELIVERY_HH__
__DATE_DELIVERY_MM__
__DATE_DELIVERY_SS__
__EXPIRATION_DATE__
__THIRDPARTY_ID__
__THIRDPARTY_NAME__
__THIRDPARTY_NAME_ALIAS__
__THIRDPARTY_CODE_CLIENT__
__THIRDPARTY_CODE_FOURNISSEUR__
__THIRDPARTY_EMAIL__
__THIRDPARTY_EMAIL_URLENCODED__
__THIRDPARTY_PHONE__
__THIRDPARTY_FAX__
__THIRDPARTY_ADDRESS__
__THIRDPARTY_ZIP__
__THIRDPARTY_TOWN__
__THIRDPARTY_COUNTRY_ID__
__THIRDPARTY_COUNTRY_CODE__
__THIRDPARTY_IDPROF1__
__THIRDPARTY_IDPROF2__
__THIRDPARTY_IDPROF3__
__THIRDPARTY_IDPROF4__
__THIRDPARTY_IDPROF5__
__THIRDPARTY_IDPROF6__
__THIRDPARTY_TVAINTRA__
__THIRDPARTY_NOTE_PUBLIC__
__THIRDPARTY_NOTE_PRIVATE__
__PROJECT_ID__
__PROJECT_REF__
__PROJECT_NAME__
__INVOICE_SITUATION_NUMBER__
__EXTRAFIELD_LITIGATION__
__EXTRAFIELD_CUSTINVDUN__
__ONLINE_PAYMENT_TEXT_AND_URL__
__ONLINE_PAYMENT_URL__
__DIRECTDOWNLOAD_URL_PROPOSAL__
__DIRECTDOWNLOAD_URL_ORDER__
__DIRECTDOWNLOAD_URL_INVOICE__
__DIRECTDOWNLOAD_URL_CONTRACT__
__DIRECTDOWNLOAD_URL_FICHINTER__
__DIRECTDOWNLOAD_URL_SUPPLIER_PROPOSAL__
__URL_INVOICE__
__DATE_YMD__
__DATE_DUE_YMD__
__DATE_YMD_TEXT__
__DATE_DUE_YMD_TEXT__
__AMOUNT_EXCL_TAX__
__AMOUNT_EXCL_TAX_TEXT__
__AMOUNT_EXCL_TAX_TEXTCURRENCY__
__AMOUNT__
__AMOUNT_TEXT__
__AMOUNT_TEXTCURRENCY__
__AMOUNT_REMAIN__
__AMOUNT_VAT__
__AMOUNT_VAT_TEXT__
__AMOUNT_VAT_TEXTCURRENCY__
__AMOUNT_TAX2__
__AMOUNT_TAX3__
__AMOUNT_EXCL_TAX_FORMATTED__
__AMOUNT_FORMATTED__
__AMOUNT_REMAIN_FORMATTED__
__AMOUNT_VAT_FORMATTED__
__AMOUNT_TAX2_FORMATTED__
__AMOUNT_TAX3_FORMATTED__
__AMOUNT_EXCL_TAX_FORMATED__
__AMOUNT_FORMATED__
__AMOUNT_REMAIN_FORMATED__
__AMOUNT_VAT_FORMATED__
__AMOUNT_MULTICURRENCY__
__AMOUNT_MULTICURRENCY_TEXT__
__AMOUNT_MULTICURRENCY_TEXTCURRENCY__
__TOTAL_TTC__
__TOTAL_HT__
__TOTAL_VAT__
__NOW_TMS__
__NOW_TMS_YMD__
__DAY__
__DAY_TEXT__
__DAY_TEXT_SHORT__
__DAY_TEXT_MIN__
__MONTH__
__MONTH_TEXT__
__MONTH_TEXT_SHORT__
__MONTH_TEXT_MIN__
__YEAR__
__PREVIOUS_DAY__
__PREVIOUS_MONTH__
__PREVIOUS_YEAR__
__NEXT_DAY__
__NEXT_MONTH__
__NEXT_MONTH_TEXT__
__NEXT_MONTH_TEXT_SHORT__
__NEXT_MONTH_TEXT_MIN__
__NEXT_YEAR__
__CHECK_READ__
__CONTACTCIVNAME__
__CONTACT_NAME_BILLING__
__CONTACT_LASTNAME_BILLING__
__CONTACT_FIRSTNAME_BILLING__
__CONTACT_TITLE_BILLING__
For example if you want to mention the reference use __REF__, the client name use __THIRDPARTY_NAME__ etc
Don't suggest data not provided as variables.
Double check the substitution variables are available in the given list and their spelling (any different letter would break the substitution variables usage)
The output format is simple HTML

Generate with the dedicated prompt

By activating the AI module, a link "Fill with AI content" will be shown to display the prompt where you can enter your instruction.

Note : For the time being, this function is only available when sending emails or creating a web page in website module.

Ai generate.png

Life cycle


Schema.png