generated from susom/redcap-em-template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
SecureChatAI.php
488 lines (426 loc) · 15 KB
/
SecureChatAI.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
<?php
namespace Stanford\SecureChatAI;
require_once "emLoggerTrait.php";
require_once "classes/SecureChatLog.php";
use Google\Exception;
use GuzzleHttp\Client;
use GuzzleHttp\Exception\GuzzleException;
class SecureChatAI extends \ExternalModules\AbstractExternalModule
{
use emLoggerTrait;
private string $api_ai_url;
private string $api_embeddings_url;
private ?string $api_whisper_url;
private string $api_key;
private string $api_embeddings_key;
private ?string $api_whisper_key;
private array $defaultParams;
private $guzzleClient = null;
private $guzzleTimeout = 5.0;
private $modelConfig = [
'gpt-4o' => [
'endpoint' => 'getApiAiUrl',
'required' => ['messages'],
'auth_key_name' => 'subscription-key'
],
'ada-002' => [
'endpoint' => 'getApiEmbeddingsUrl',
'required' => ['input'],
'auth_key_name' => 'api-key'
],
'whisper' => [
'endpoint' => 'getApiWhisperUrl',
'required' => ['input'],
'auth_key_name' => 'api-key'
]
];
public function __construct()
{
parent::__construct();
}
public function initSecureChatAI()
{
//Set default API variables from system settings
$this->setApiAiUrl($this->getSystemSetting('secure-chat-api-url'));
$this->setApiEmbeddingsUrl($this->getSystemSetting('secure-chat-embeddings-api-url'));
$this->setApiWhisperUrl($this->getSystemSetting('secure-chat-whisper-api-url'));
$this->setApiKey($this->getSystemSetting('secure-chat-api-token'));
$this->setApiEmbeddingsKey($this->getSystemSetting('secure-chat-embeddings-api-token'));
$this->setApiWhisperKey($this->getSystemSetting('secure-chat-whisper-api-token'));
//Set default LLM model parameters
$this->setDefaultParams([
'model' => $this->getSystemSetting('gpt-model') ?: 'gpt-4o',
'temperature' => (float)$this->getSystemSetting('gpt-temperature') ?: 0.7,
'top_p' => (float)$this->getSystemSetting('gpt-top-p') ?: 0.9,
'frequency_penalty' => (float)$this->getSystemSetting('gpt-frequency-penalty') ?: 0.5,
'presence_penalty' => (float)$this->getSystemSetting('gpt-presence-penalty') ?: 0,
'max_tokens' => (int)$this->getSystemSetting('gpt-max-tokens') ?: 800,
'stop' => null // Assuming stop is not configurable and kept at default
]);
//Set guzzle info
$timeout = $this->getProjectSetting('guzzle-timeout') ? (float)(strip_tags($this->getProjectSetting('guzzle-timeout'))) : $this->getGuzzleTimeout();
$this->setGuzzleTimeout($timeout);
$this->guzzleClient = $this->getGuzzleClient();
}
/**
* @return array
* @params $offset array offset
* @throws \Exception
*/
public function getSecureChatLogs($offset){
$offset = intval($offset);
return SecureChatLog::getLogs($this, '52', $offset);
}
/**
* Call the AI API with the provided messages and parameters.
*
* @param string $model The model to be used for the API call.
* @param array $params Additional parameters to customize the API call.
* @param int|null $project_id The project ID for tracking purposes.
* @return array The response from the AI API or an error message.
*/
public function callAI($model, $params = [], $project_id = null)
{
$retries = 2; // Maximum number of retries
$attempt = 0;
while ($attempt <= $retries) {
try {
// Ensure the secure chat AI is initialized
$this->initSecureChatAI();
$config = $this->getModelConfig();
// Check if model is supported
if (!isset($config[$model])) {
throw new Exception('Unsupported model: ' . $model);
}
$modelConfig = $config[$model];
$api_endpoint = $this->{$modelConfig['endpoint']}();
// Ensure required parameters are provided
foreach ($modelConfig['required'] as $param) {
if (empty($params[$param])) {
throw new Exception('Missing required parameter: ' . $param);
}
}
// Check if the model is 'whisper'
if ($model === 'whisper') {
$api_endpoint = $api_endpoint . '&'. $modelConfig['auth_key_name']. '=' . $this->getApiWhisperKey();
$this->emDebug("inside whisper api_endpoint", $api_endpoint, $params);
$filePath = $params["input"];
$filename = basename($filePath);
$fileResource = fopen($filePath, 'r');
// Prepare the multipart data
$multipartData = [
[
'name' => 'file',
'contents' => $fileResource,
'filename' => $filename
]
];
$this->emDebug("inside whisper api_endpoint", $multipartData);
// Add Whisper-specific parameters to the multipart data
$this->addWhisperParameters($multipartData, $params);
$this->emDebug("guzzle timeout", $this->getGuzzleTimeout());
// Perform the API call for Whisper
$response = $this->getGuzzleClient()->request('POST', $api_endpoint, [
'headers' => [
'Accept' => 'application/json'
],
'multipart' => $multipartData,
'timeout' => 300
]);
} else {
// Handling for other models like ada-002 , GPT-4o
$params["model"] = $model;
// TODO WILL NEED WAY TO GENERALIZE THIS OUT, wiht more deployments... or maybe this is as good as it gets
if($model == "gpt-4o"){
$data = array_merge($this->getDefaultParams(), $params);
$api_key = $this->getApiKey();
}else {
// for now ada-002
$data = $params;
$api_key = $this->getApiEmbeddingsKey();
}
$api_url = $api_endpoint . '&' . $modelConfig['auth_key_name'] . '=' . $api_key;
$response = $this->getGuzzleClient()->request('POST', $api_url, [
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json'
],
'json' => $data,
'timeout' => 10
]);
}
$responseData = json_decode($response->getBody(), true);
$this->emDebug("gpt response" , $responseData);
// Log interaction of user and response queries
$this->logInteraction($project_id, $params, $responseData);
return $responseData;
} catch (GuzzleException $e) {
$attempt++;
$this->emDebug("Attempt $attempt: Guzzle error", $e->getMessage());
if ($attempt > $retries) {
$error = [
'error' => true,
'message' => "Guzzle error after $retries retries: " . $e->getMessage()
];
// Log interaction and error
$this->logErrorInteraction($project_id, $params, $error);
return $error;
}
} catch (\Exception $e) {
$this->emError("Error: in SecureChat: " . $e->getMessage());
$error = [
'error' => true,
'message' => "Error in SecureChat: " . $e->getMessage()
];
// Log interaction and error
$this->logErrorInteraction($project_id, $params, $error);
return $error;
}
}
}
/*
* Adds whisper parameters to multipart data array
*/
private function addWhisperParameters(&$multipartData, $params): void
{
$fields = [
'initial_prompt',
'prompt'
];
foreach ($fields as $field) {
if (!empty($params[$field])) {
$multipartData[] = [
'name' => $field,
'contents' => $params[$field]
];
}
}
$settings = [
'whisper-language' => 'language',
'whisper-temperature' => 'temperature',
'whisper-top-p' => 'top_p',
'whisper-n' => 'n',
'whisper-logprobs' => 'logprobs',
'whisper-max-alternate-transcriptions' => 'max_alternate_transcriptions',
'whisper-compression-rate' => 'compression_rate',
'whisper-sample-rate' => 'sample_rate',
'whisper-condition-on-previous-text' => 'condition_on_previous_text'
];
foreach ($settings as $settingKey => $fieldName) {
$value = $this->getProjectSetting($settingKey);
if ($value !== null) {
$multipartData[] = [
'name' => $fieldName,
'contents' => is_bool($value) ? ($value ? 'true' : 'false') : (string) $value
];
}
}
}
/**
* Log the interaction with the AI API.
*
* @param int|null $project_id The project ID for tracking purposes.
* @param array $requestData The request data sent to the API.
* @param array $responseData The response data received from the API.
*/
private function logInteraction($project_id, $requestData, $responseData)
{
// Save every data point in log table
$payload = array_merge($requestData, $responseData);
$payload['project_id'] = $project_id;
$action = new SecureChatLog($this);
// Message capacity is currently ~16mb or 16 million characters
$action->setValue('message', json_encode($payload));
$action->setValue('record', 'SecureChatLog');
$action->save();
}
private function logErrorInteraction($project_id, $requestData, $error){
$payload = array_merge($requestData, $error);
$payload['project_id'] = $project_id;
$action = new SecureChatLog($this);
// Message capacity is currently ~16mb or 16 million characters
$action->setValue('message', json_encode($error));
$action->setValue('record', 'SecureChatLogError');
$action->save();
}
/**
* Extract the main response text from the API response.
*
* @param array $response The API response.
* @return string The extracted response text.
*/
public function extractResponseText($response)
{
return $response['choices'][0]['message']['content'] ?? json_encode($response);
}
/**
* Extract the usage tokens from the API response.
*
* @param array $response The API response.
* @return array The extracted usage data.
*/
public function extractUsageTokens($response)
{
return $response['usage'] ?? ['prompt_tokens' => 0, 'completion_tokens' => 0, 'total_tokens' => 0];
}
/**
* Extract metadata from the API response.
*
* @param array $response The API response.
* @return array The extracted metadata.
*/
public function extractMetaData($response)
{
return [
'id' => $response['id'] ?? 'N/A',
'object' => $response['object'] ?? 'N/A',
'created' => $response['created'] ?? 'N/A',
'model' => $response['model'] ?? 'N/A',
'usage' => $response['usage'] ?? 'N/A'
];
}
/**
* @return string
*/
public function getApiAiUrl()
{
return $this->api_ai_url;
}
/**
* @param string $url
*/
public function setApiAiUrl(string $url): void
{
$this->api_ai_url = $url;
}
/**
* @return string
*/
public function getApiEmbeddingsUrl()
{
return $this->api_embeddings_url;
}
/**
* @param ?string $api_embeddings_url
*/
public function setApiEmbeddingsUrl(?string $api_embeddings_url): void
{
$this->api_embeddings_url = $api_embeddings_url;
}
public function getApiWhisperUrl()
{
return $this->api_whisper_url;
}
/**
* @param ?string $api_whisper_url
*/
public function setApiWhisperUrl(?string $api_whisper_url): void
{
$this->api_whisper_url = $api_whisper_url;
}
/**
* @return string
*/
public function getApiKey()
{
return $this->api_key;
}
/**
* @param string $api_key
*/
public function setApiKey(string $api_key): void
{
$this->api_key = $api_key;
}
/**
* @return string
*/
public function getApiEmbeddingsKey()
{
return $this->api_embeddings_key;
}
/**
* @param string $api_key
*/
public function setApiEmbeddingsKey(string $api_key): void
{
$this->api_embeddings_key = $api_key;
}
/**
* @return string
*/
public function getApiWhisperKey()
{
return $this->api_whisper_key;
}
/**
* @param ?string $api_key
*/
public function setApiWhisperKey(?string $api_key): void
{
$this->api_whisper_key = $api_key;
}
/**
* @return array
*/
public function getDefaultParams()
{
return $this->defaultParams;
}
/**
* @param array $defaultParams
*/
public function setDefaultParams(array $defaultParams): void
{
$this->defaultParams = $defaultParams;
}
/**
* @return Client
*/
public function getGuzzleClient()
{
if (!$this->guzzleClient) {
$this->setGuzzleClient(new Client([
'timeout' => 30,
'connect_timeout' => 10,
'verify' => false
]));
}
return $this->guzzleClient;
}
/**
* @param Client $guzzleClient
*/
public function setGuzzleClient(Client $guzzleClient): void
{
$this->guzzleClient = $guzzleClient;
}
/**
* @param array $config
* @return void
*/
public function setModelConfig(array $config): void
{
$this->modelConfig = $config;
}
/**
* @return array
*/
public function getModelConfig(): array
{
return $this->modelConfig;
}
public function setGuzzleTimeout($float)
{
$this->guzzleTimeout = $float;
}
public function getGuzzleTimeout(): float
{
return $this->guzzleTimeout;
}
public function getSecureChatLogObject()
{
return new SecureChatLog($this);
}
}
?>