AutorÃa | Ultima modificación | Ver Log |
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle 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.
//
// Moodle 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 Moodle. If not, see <http://www.gnu.org/licenses/>.
namespace aiprovider_azureai;
use core\http_client;
use core_ai\process_base;
use GuzzleHttp\Exception\RequestException;
use GuzzleHttp\RequestOptions;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\UriInterface;
/**
* Class process text generation.
*
* @package aiprovider_azureai
* @copyright 2024 Matt Porritt <matt.porritt@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
abstract class abstract_processor extends process_base {
/**
* Get the endpoint URI.
*
* @return UriInterface
*/
abstract protected function get_endpoint(): UriInterface;
/**
* Get the system instructions.
*
* @return string
*/
protected function get_system_instruction(): string {
return $this->action::get_system_instruction();
}
/**
* Get the deployment name.
*
* @return string
*/
protected function get_deployment_name(): string {
return $this->provider->actionconfig[$this->action::class]['settings']['deployment'];
}
/**
* Get the api version to use.
*
* @return string
*/
protected function get_api_version(): string {
return $this->provider->actionconfig[$this->action::class]['settings']['apiversion'];
}
/**
* Create the request object to send to the OpenAI API.
*
* This object contains all the required parameters for the request.
*
* @param string $userid The user id.
* @return RequestInterface The request object to send to the OpenAI API.
*/
abstract protected function create_request_object(
string $userid,
): RequestInterface;
/**
* Handle a successful response from the external AI api.
*
* @param ResponseInterface $response The response object.
* @return array The response.
*/
abstract protected function handle_api_success(ResponseInterface $response): array;
#[\Override]
protected function query_ai_api(): array {
$request = $this->create_request_object(
userid: $this->provider->generate_userid($this->action->get_configuration('userid')),
);
$request = $this->provider->add_authentication_headers($request);
$client = \core\di::get(http_client::class);
try {
// Call the external AI service.
$response = $client->send($request, [
'base_uri' => $this->get_endpoint(),
RequestOptions::HTTP_ERRORS => false,
]);
} catch (RequestException $e) {
// Handle any exceptions.
return [
'success' => false,
'errorcode' => $e->getCode(),
'errormessage' => $e->getMessage(),
];
}
// Double-check the response codes, in case of a non 200 that didn't throw an error.
$status = $response->getStatusCode();
if ($status === 200) {
return $this->handle_api_success($response);
} else {
return $this->handle_api_error($response);
}
}
/**
* Handle an error from the external AI api.
*
* @param ResponseInterface $response The response object.
* @return array The error response.
*/
protected function handle_api_error(ResponseInterface $response): array {
$responsearr = [
'success' => false,
'errorcode' => $response->getStatusCode(),
];
$status = $response->getStatusCode();
if ($status >= 500 && $status < 600) {
$responsearr['errormessage'] = $response->getReasonPhrase();
} else {
$bodyobj = json_decode($response->getBody()->getContents());
$responsearr['errormessage'] = $bodyobj->error->message;
}
return $responsearr;
}
}