dolibarr 25.0.0-alpha
Ai Class Reference

Class for AI feature. More...

Collaboration diagram for Ai:

Public Member Functions

 __construct ($db)
 Constructor.
 
 getApiService ()
 get API Service
 
 generateContent ($instructions, $model='auto', $function='textgeneration', $format='', $moreheaders=array(), $moreendpoint='')
 Generate the response of an AI prompt.
 
 decodeJsonIntoArray ($json, $type)
 Decode JSON into array.
 

Detailed Description

Class for AI feature.

Definition at line 35 of file ai.class.php.

Constructor & Destructor Documentation

◆ __construct()

Ai::__construct ( $db)

Constructor.

Parameters
DoliDB$dbDatabase handler

Definition at line 72 of file ai.class.php.

References getDolGlobalString().

Member Function Documentation

◆ decodeJsonIntoArray()

Ai::decodeJsonIntoArray ( $json,
$type )

Decode JSON into array.

Parameters
array{document_info?:array{reference?:string,invoice_number?:string,title?:string,issue_date?:string,due_date?:string,vendor?:array{name?:string,siren?:string,siret?:string,email?:string,professional_id?:array{siren?:string},vat_number?:string}}|null,summary?:array{currency?:string,subtotal_excluding_tax?:float,tax?:array{rate?:float,amount?:float}},items?:array<int|string,array{description?:string,service?:string,quantity?:float,tax?:array{vat_rate?:float,rate?:float,amount?:float},unit_price?:float,total_excluding_tax?:float,total_including_tax?:float,period_start?:string,period_end?:string,period?:array{start_date?:string,end_date?:string}}>}$json JSON
string$typeType of document to get ('supplier_invoice', 'thirdparty', ...)
Returns
array<string,string|float> Array of values

Definition at line 505 of file ai.class.php.

References dol_stringtotime().

◆ generateContent()

Ai::generateContent ( $instructions,
$model = 'auto',
$function = 'textgeneration',
$format = '',
$moreheaders = array(),
$moreendpoint = '' )

Generate the response of an AI prompt.

Parameters
string|array<mixed,mixed>$instructions String instruction to generate content (or file path) or array of payload or ID of file with function threads
string$modelModel name ('gpt-4.1-turbo', 'gpt-4.1', 'dall-e-3', ...)
string$functionCode of the feature we want to use ('textgeneration', 'transcription', 'audiogeneration', 'imagegeneration', 'translation', 'docparsing')
string$formatFormat for output ('', 'html', ...)
array<string,string>$moreheaders More headers
string$moreendpointAdd a part to endpoint url
Returns
string|array{error:bool,message:string,code?:int,curl_error_no?:int,format?:string,service?:string,function?:string} $response Text or array if error

Definition at line 102 of file ai.class.php.

References dol_nl2br(), dol_now(), dol_print_date(), dol_syslog(), dol_textishtml(), dol_trunc(), dolChmod(), getDolGlobalString(), getListOfAIServices(), and getURLContent().

◆ getApiService()

Ai::getApiService ( )

get API Service

Returns
string API service

Definition at line 86 of file ai.class.php.


The documentation for this class was generated from the following file: