Refactoring of request processing - in progress

cognesy · Oct 5, 2024 · c033c89 · c033c89
1 parent d20cf91
commit c033c89
Show file tree

Hide file tree

Showing 21 changed files with 190 additions and 116 deletions.
diff --git a/docs/cookbook/examples/advanced/custom_prompts.mdx b/docs/cookbook/examples/advanced/custom_prompts.mdx
@@ -19,9 +19,7 @@ customize how LLM is instructed to process the input.
 $loader = require 'vendor/autoload.php';
 $loader->add('Cognesy\\Instructor\\', __DIR__ . '../../src/');
 
-use Cognesy\Instructor\Enums\Mode;
-use Cognesy\Instructor\Events\Request\RequestSentToLLM;
-use Cognesy\Instructor\Instructor;
+use Cognesy\Instructor\Enums\Mode;use Cognesy\Instructor\Events\HttpClient\RequestSentToLLM;use Cognesy\Instructor\Instructor;
 
 class User {
     public int $age;

diff --git a/docs/cookbook/examples/advanced/demonstrations.mdx b/docs/cookbook/examples/advanced/demonstrations.mdx
@@ -19,10 +19,7 @@ is expected to be a JSON object.
 $loader = require 'vendor/autoload.php';
 $loader->add('Cognesy\\Instructor\\', __DIR__ . '../../src/');
 
-use Cognesy\Instructor\Enums\Mode;
-use Cognesy\Instructor\Events\Request\RequestSentToLLM;
-use Cognesy\Instructor\Instructor;
-use Cognesy\Instructor\Data\Example;
+use Cognesy\Instructor\Data\Example;use Cognesy\Instructor\Enums\Mode;use Cognesy\Instructor\Events\HttpClient\RequestSentToLLM;use Cognesy\Instructor\Instructor;
 
 class User {
     public int $age;

diff --git a/docs/cookbook/examples/basics/self_correction.mdx b/docs/cookbook/examples/basics/self_correction.mdx
@@ -19,12 +19,7 @@ until results meet the requirements or maxRetries is reached.
 $loader = require 'vendor/autoload.php';
 $loader->add('Cognesy\\Instructor\\', __DIR__.'../../src/');
 
-use Cognesy\Instructor\Events\Request\RequestSentToLLM;
-use Cognesy\Instructor\Events\Response\ResponseValidated;
-use Cognesy\Instructor\Events\Response\ResponseValidationAttempt;
-use Cognesy\Instructor\Events\Response\ResponseValidationFailed;
-use Cognesy\Instructor\Instructor;
-use Symfony\Component\Validator\Constraints as Assert;
+use Cognesy\Instructor\Events\HttpClient\RequestSentToLLM;use Cognesy\Instructor\Events\Response\ResponseValidated;use Cognesy\Instructor\Events\Response\ResponseValidationAttempt;use Cognesy\Instructor\Events\Response\ResponseValidationFailed;use Cognesy\Instructor\Instructor;use Symfony\Component\Validator\Constraints as Assert;
 
 class UserDetails
 {

diff --git a/docs/cookbook/examples/troubleshooting/on_event.mdx b/docs/cookbook/examples/troubleshooting/on_event.mdx
@@ -25,10 +25,7 @@ and their properties.
 $loader = require 'vendor/autoload.php';
 $loader->add('Cognesy\\Instructor\\', __DIR__ . '../../src/');
 
-use Cognesy\Instructor\Events\Event;
-use Cognesy\Instructor\Events\Request\RequestSentToLLM;
-use Cognesy\Instructor\Events\Request\ResponseReceivedFromLLM;
-use Cognesy\Instructor\Instructor;
+use Cognesy\Instructor\Events\Event;use Cognesy\Instructor\Events\HttpClient\RequestSentToLLM;use Cognesy\Instructor\Events\HttpClient\ResponseReceivedFromLLM;use Cognesy\Instructor\Instructor;
 
 class User
 {

diff --git a/examples/A01_Basics/SelfCorrection/run.php b/examples/A01_Basics/SelfCorrection/run.php
@@ -19,7 +19,7 @@
 $loader = require 'vendor/autoload.php';
 $loader->add('Cognesy\\Instructor\\', __DIR__.'../../src/');
 
-use Cognesy\Instructor\Events\Request\RequestSentToLLM;
+use Cognesy\Instructor\Events\HttpClient\RequestSentToLLM;
 use Cognesy\Instructor\Events\Response\ResponseValidated;
 use Cognesy\Instructor\Events\Response\ResponseValidationAttempt;
 use Cognesy\Instructor\Events\Response\ResponseValidationFailed;

diff --git a/examples/A02_Advanced/CustomPrompts/run.php b/examples/A02_Advanced/CustomPrompts/run.php
@@ -20,7 +20,7 @@
 $loader->add('Cognesy\\Instructor\\', __DIR__ . '../../src/');
 
 use Cognesy\Instructor\Enums\Mode;
-use Cognesy\Instructor\Events\Request\RequestSentToLLM;
+use Cognesy\Instructor\Events\HttpClient\RequestSentToLLM;
 use Cognesy\Instructor\Instructor;
 
 class User {

diff --git a/examples/A02_Advanced/ProvidingExamples/run.php b/examples/A02_Advanced/ProvidingExamples/run.php
@@ -19,10 +19,10 @@
 $loader = require 'vendor/autoload.php';
 $loader->add('Cognesy\\Instructor\\', __DIR__ . '../../src/');
 
+use Cognesy\Instructor\Data\Example;
 use Cognesy\Instructor\Enums\Mode;
-use Cognesy\Instructor\Events\Request\RequestSentToLLM;
+use Cognesy\Instructor\Events\HttpClient\RequestSentToLLM;
 use Cognesy\Instructor\Instructor;
-use Cognesy\Instructor\Data\Example;
 
 class User {
     public int $age;

diff --git a/examples/A03_Troubleshooting/OnEvent/run.php b/examples/A03_Troubleshooting/OnEvent/run.php
@@ -26,8 +26,8 @@
 $loader->add('Cognesy\\Instructor\\', __DIR__ . '../../src/');
 
 use Cognesy\Instructor\Events\Event;
-use Cognesy\Instructor\Events\Request\RequestSentToLLM;
-use Cognesy\Instructor\Events\Request\ResponseReceivedFromLLM;
+use Cognesy\Instructor\Events\HttpClient\RequestSentToLLM;
+use Cognesy\Instructor\Events\HttpClient\ResponseReceivedFromLLM;
 use Cognesy\Instructor\Instructor;
 
 class User

diff --git a/src/Core/PartialsGenerator.php b/src/Core/PartialsGenerator.php
@@ -63,7 +63,7 @@ public function resetPartialResponse() : void {
     /**
      * @param Generator<PartialLLMResponse> $stream
      * @param ResponseModel $responseModel
-     * @return Generator<mixed>
+     * @return Generator<PartialLLMResponse>
      */
     public function getPartialResponses(Generator $stream, ResponseModel $responseModel) : Generator {
         // reset state
@@ -108,7 +108,9 @@ public function getPartialResponses(Generator $stream, ResponseModel $responseMo
             }
             $this->events->dispatch(new PartialJsonReceived($this->responseJson));
 
-            yield $result->unwrap();
+            yield $partialResponse
+                ->withValue($result->unwrap())
+                ->withContent($this->responseText);
         }
         $this->events->dispatch(new StreamedResponseFinished($this->lastPartialResponse()));
 

diff --git a/src/Core/RequestHandler.php b/src/Core/RequestHandler.php
@@ -9,13 +9,11 @@
 use Cognesy\Instructor\Events\Instructor\InstructorDone;
 use Cognesy\Instructor\Events\Instructor\ResponseGenerated;
 use Cognesy\Instructor\Events\Request\NewValidationRecoveryAttempt;
-use Cognesy\Instructor\Events\Request\RequestSentToLLM;
-use Cognesy\Instructor\Events\Request\RequestToLLMFailed;
-use Cognesy\Instructor\Events\Request\ResponseReceivedFromLLM;
 use Cognesy\Instructor\Events\Request\ValidationRecoveryLimitReached;
 use Cognesy\Instructor\Extras\Http\Contracts\CanHandleHttp;
 use Cognesy\Instructor\Extras\LLM\Contracts\CanHandleInference;
 use Cognesy\Instructor\Extras\LLM\Data\LLMResponse;
+use Cognesy\Instructor\Extras\LLM\Data\PartialLLMResponse;
 use Cognesy\Instructor\Extras\LLM\Inference;
 use Cognesy\Instructor\Extras\LLM\InferenceResponse;
 use Cognesy\Instructor\Stream;
@@ -52,7 +50,7 @@ public function get() : mixed {
         }
         $result = $this->responseFor($this->request);
         $this->events->dispatch(new InstructorDone(['result' => $result]));
-        return $result;
+        return $result->value();
     }
 
     /**
@@ -72,13 +70,12 @@ public function stream() : Stream {
     /**
      * Generates response value
      */
-    protected function responseFor(Request $request) : mixed {
+    protected function responseFor(Request $request) : LLMResponse {
         $this->init();
 
         $processingResult = Result::failure("No response generated");
         while ($processingResult->isFailure() && !$this->maxRetriesReached($request)) {
             $llmResponse = $this->getInference($request)->toLLMResponse();
-
             $llmResponse->content = match($request->mode()) {
                 Mode::Text => $llmResponse->content,
                 default => Json::from($llmResponse->content)->toString(),
@@ -89,13 +86,13 @@ protected function responseFor(Request $request) : mixed {
 
         $value = $this->finalizeResult($processingResult, $request, $llmResponse, $partialResponses);
 
-        return $value;
+        return $llmResponse->withValue($value);
     }
 
     /**
      * Yields response value versions based on streamed responses
      * @param Request $request
-     * @return Generator<mixed>
+     * @return Generator<PartialLLMResponse|LLMResponse>
      */
     protected function streamResponseFor(Request $request) : Generator {
         $this->init();
@@ -112,7 +109,7 @@ protected function streamResponseFor(Request $request) : Generator {
 
         $value = $this->finalizeResult($processingResult, $request, $llmResponse, $partialResponses);
 
-        yield $value;
+        yield $llmResponse->withValue($value);
     }
 
     protected function init() : void {
@@ -121,16 +118,6 @@ protected function init() : void {
     }
 
     protected function getInference(Request $request) : InferenceResponse {
-        $this->events->dispatch(new RequestSentToLLM($request));
-        try {
-            return $this->makeInference($request);
-        } catch (Exception $e) {
-            $this->events->dispatch(new RequestToLLMFailed($request, $e->getMessage()));
-            throw $e;
-        }
-    }
-
-    protected function makeInference(Request $request) : InferenceResponse {
         $inference = new Inference(
             connection: $this->connection,
             httpClient: $this->httpClient,
@@ -150,8 +137,6 @@ protected function makeInference(Request $request) : InferenceResponse {
     }
 
     protected function processResponse(Request $request, LLMResponse $llmResponse, array $partialResponses) : Result {
-        $this->events->dispatch(new ResponseReceivedFromLLM($llmResponse));
-
         // we have LLMResponse here - let's process it: deserialize, validate, transform
         $processingResult = $this->responseGenerator->makeResponse($llmResponse, $request->responseModel());
 

diff --git a/src/Core/ResponseGenerator.php b/src/Core/ResponseGenerator.php
@@ -27,9 +27,9 @@ public function __construct(
     ) {}
 
     public function makeResponse(LLMResponse $response, ResponseModel $responseModel) : Result {
-        $result = Chain::from(fn() => $response->getJson())
+        $result = Chain::from(fn() => $response->json())
             ->through(fn($responseJson) => match(true) {
-                empty($responseJson) => Result::failure('No JSON found in the response'),
+                ($responseJson === '') => Result::failure('No JSON found in the response'),
                 default => Result::success($responseJson)
             })
             ->through(fn($responseJson) => $this->responseDeserializer->deserialize($responseJson, $responseModel))

diff --git a/src/Events/HttpClient/RequestSentToLLM.php b/src/Events/HttpClient/RequestSentToLLM.php
@@ -0,0 +1,29 @@
+<?php
+namespace Cognesy\Instructor\Events\HttpClient;
+
+use Cognesy\Instructor\Events\Event;
+use Cognesy\Instructor\Utils\Json\Json;
+use Psr\Log\LogLevel;
+
+class RequestSentToLLM extends Event
+{
+    public $logLevel = LogLevel::INFO;
+
+    public function __construct(
+        public string $url,
+        public string $method,
+        public array $headers,
+        public array $body,
+    ) {
+        parent::__construct();
+    }
+
+    public function __toString(): string {
+        return Json::encode([
+            'url' => $this->url,
+            'method' => $this->method,
+            'headers' => $this->headers,
+            'body' => $this->body,
+        ]);
+    }
+}
diff --git a/src/Events/Request/RequestToLLMFailed.php → src/Events/HttpClient/RequestToLLMFailed.php b/src/Events/Request/RequestToLLMFailed.php → src/Events/HttpClient/RequestToLLMFailed.php
@@ -1,7 +1,6 @@
 <?php
-namespace Cognesy\Instructor\Events\Request;
+namespace Cognesy\Instructor\Events\HttpClient;
 
-use Cognesy\Instructor\Data\Request;
 use Cognesy\Instructor\Events\Event;
 use Cognesy\Instructor\Utils\Json\Json;
 use Psr\Log\LogLevel;
@@ -11,7 +10,10 @@ class RequestToLLMFailed extends Event
     public $logLevel = LogLevel::ERROR;
 
     public function __construct(
-        public Request $request,
+        public string $url,
+        public string $method,
+        public array $headers,
+        public array $body,
         public string $errors,
     ) {
         parent::__construct();
@@ -20,8 +22,11 @@ public function __construct(
     public function __toString(): string
     {
         return Json::encode([
+            'url' => $this->url,
+            'method' => $this->method,
+            'headers' => $this->headers,
+            'body' => $this->body,
             'errors' => $this->errors,
-            'request' => $this->request->toArray(),
         ]);
     }
 }
diff --git a/...vents/Request/ResponseReceivedFromLLM.php → ...ts/HttpClient/ResponseReceivedFromLLM.php b/...vents/Request/ResponseReceivedFromLLM.php → ...ts/HttpClient/ResponseReceivedFromLLM.php
@@ -1,8 +1,7 @@
 <?php
-namespace Cognesy\Instructor\Events\Request;
+namespace Cognesy\Instructor\Events\HttpClient;
 
 use Cognesy\Instructor\Events\Event;
-use Cognesy\Instructor\Extras\LLM\Data\LLMResponse;
 use Cognesy\Instructor\Utils\Json\Json;
 use Psr\Log\LogLevel;
 
@@ -11,13 +10,15 @@ class ResponseReceivedFromLLM extends Event
     public $logLevel = LogLevel::INFO;
 
     public function __construct(
-        public LLMResponse $response,
+        public int $statusCode,
     ) {
         parent::__construct();
     }
 
     public function __toString(): string
     {
-        return Json::encode($this->response);
+        return Json::encode([
+            'statusCode' => $this->statusCode
+        ]);
     }
 }
diff --git a/src/Events/Request/RequestSentToLLM.php b/src/Events/Request/RequestSentToLLM.php
diff --git a/src/Extras/Http/Drivers/GuzzleHttpClient.php b/src/Extras/Http/Drivers/GuzzleHttpClient.php
@@ -2,9 +2,14 @@
 
 namespace Cognesy\Instructor\Extras\Http\Drivers;
 
+use Cognesy\Instructor\Events\EventDispatcher;
+use Cognesy\Instructor\Events\HttpClient\RequestSentToLLM;
+use Cognesy\Instructor\Events\HttpClient\RequestToLLMFailed;
+use Cognesy\Instructor\Events\HttpClient\ResponseReceivedFromLLM;
 use Cognesy\Instructor\Extras\Debug\Debug;
 use Cognesy\Instructor\Extras\Http\Contracts\CanHandleHttp;
 use Cognesy\Instructor\Extras\Http\Data\HttpClientConfig;
+use Exception;
 use GuzzleHttp\Client;
 use GuzzleHttp\HandlerStack;
 use GuzzleHttp\Middleware;
@@ -22,7 +27,9 @@ class GuzzleHttpClient implements CanHandleHttp
     public function __construct(
         protected HttpClientConfig $config,
         protected ?Client $httpClient = null,
+        protected ?EventDispatcher $events = null,
     ) {
+        $this->events = $events ?? new EventDispatcher();
         if (isset($this->httpClient) && Debug::isEnabled()) {
             throw new InvalidArgumentException("Guzzle does not allow to inject debugging stack into existing client. Turn off debug or use default client.");
         }
@@ -40,14 +47,22 @@ public function handle(
         string $method = 'POST',
         bool $streaming = false
     ) : ResponseInterface {
-        return $this->client->request($method, $url, [
-            'headers' => $headers,
-            'json' => $body,
-            'connect_timeout' => $this->config->connectTimeout ?? 3,
-            'timeout' => $this->config->requestTimeout ?? 30,
-            'debug' => Debug::isFlag('http.trace') ?? false,
-            'stream' => $streaming,
-        ]);
+        $this->events->dispatch(new RequestSentToLLM($url, $method, $headers, $body));
+        try {
+            $response = $this->client->request($method, $url, [
+                'headers' => $headers,
+                'json' => $body,
+                'connect_timeout' => $this->config->connectTimeout ?? 3,
+                'timeout' => $this->config->requestTimeout ?? 30,
+                'debug' => Debug::isFlag('http.trace') ?? false,
+                'stream' => $streaming,
+            ]);
+            $this->events->dispatch(new ResponseReceivedFromLLM($response->getStatusCode()));
+            return $response;
+        } catch (Exception $e) {
+            $this->events->dispatch(new RequestToLLMFailed($url, $method, $headers, $body, $e->getMessage()));
+            throw $e;
+        }
     }
 
     protected function addDebugStack(HandlerStack $stack) : HandlerStack {

diff --git a/src/Extras/Http/HttpClient.php b/src/Extras/Http/HttpClient.php
@@ -48,7 +48,7 @@ public function get() : CanHandleHttp {
 
     private function makeDriver(HttpClientConfig $config) : CanHandleHttp {
         return match ($config->httpClientType) {
-            HttpClientType::Guzzle => new GuzzleHttpClient($config),
+            HttpClientType::Guzzle => new GuzzleHttpClient(config: $config, events: $this->events),
             default => throw new InvalidArgumentException("Client not supported: {$config->httpClientType->value}"),
         };
     }