release 1.2

Author: makowskid

CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 
-## March 23, 2023 - v1.1.0 update
+## August 26, 2024 - v1.2.0 update
+- Generate Keywords/Tags & Summarize methods aquired optional `context` that allows to pass additional processing instructions for the provided `content`
+- API useage optimized internall, switched to AI job dispatch/result endpoint pairing mode
+
+## March 23, 2024 - v1.1.0 update
 
 ### 1. new methods added
 

README.md

@@ -2,9 +2,9 @@
 
 # SharpAPI PHP Client - #AI Programming Interface
 
-### 🚀 AI-Powered Swiss Army Knife API
+### 🚀 Automate workflows with AI-powered API
 
-## Save countless hours and supercharge your app with AI capabilities in just 2 lines of code.
+## Leverage AI API to streamline workflows in E-Commerce, Marketing, Content Management, HR Tech, Travel, and more.
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/sharpapi/sharpapi-php-client.svg?style=flat-square)](https://packagist.org/packages/sharpapi/sharpapi-php-client)
 [![Total Downloads](https://img.shields.io/packagist/dt/sharpapi/sharpapi-php-client.svg?style=flat-square)](https://packagist.org/packages/sharpapi/sharpapi-php-client)
@@ -64,7 +64,7 @@ Please refer to the official:
 composer require sharpapi/sharpapi-php-client
 ```
 
-2. Register at [SharpApi.com](https://sharpapi.com/) and get the API key.
+2. Register at [SharpAPI.com](https://sharpapi.com/) and get the API key.
 
 3. **That's it!**
 
@@ -483,7 +483,8 @@ $statusUrl = \SharpApiService::generateKeywords(
     $text, 
     'English',    // optional language
     5,  // optional length
-    'Freaky & Curious'    // optional voice tone
+    'Freaky & Curious',    // optional voice tone
+    'add emojis!' // optional extra context instructions for content processing
   );
 ```
 
@@ -503,7 +504,8 @@ It can be adjectives like `funny` or `joyous`, or even the name of a famous writ
 $statusUrl = \SharpApiService::summarizeText(
     $text, 
     'English',     // optional language
-    'David Attenborough'    // optional voice tone
+    'David Attenborough',    // optional voice tone
+    'add emojis!' // optional extra context instructions for content processing
   );
 ```
 

composer.json

@@ -36,7 +36,8 @@
     "php": "^8.1",
     "guzzlehttp/guzzle": "^7.8",
     "kongulov/interact-with-enum": "^1.0",
-    "nesbot/carbon": "^3.0"
+    "nesbot/carbon": "^3.0",
+    "spatie/url": "^2.4"
   },
   "autoload": {
     "psr-4": {

src/Dto/SharpApiJob.php

@@ -14,7 +14,7 @@ public function __construct(
         public string  $id,
         public string  $type,
         public string  $status,
-        public ?string $result
+        public ?stdClass $result
     )
     {
     }
@@ -66,7 +66,7 @@ public function getStatus(): SharpApiJobStatusEnum
      */
     public function getResultJson(): string|bool|null
     {
-        return $this->result ? json_encode(json_decode($this->result), JSON_PRETTY_PRINT) : null;
+        return $this->result ? json_encode($this->result, JSON_PRETTY_PRINT) : null;
     }
 
     /**
@@ -76,7 +76,7 @@ public function getResultJson(): string|bool|null
      */
     public function getResultArray(): ?array
     {
-        return $this->result ? json_decode($this->result, true) : null;
+        return (array) $this->result;
     }
 
     /**
@@ -86,6 +86,6 @@ public function getResultArray(): ?array
      */
     public function getResultObject(): ?stdClass
     {
-        return $this->result ? json_decode($this->result) : null;
+        return $this->result;
     }
 }

src/SharpApiService.php

@@ -15,6 +15,7 @@
 use SharpAPI\SharpApiService\Dto\SharpApiSubscriptionInfo;
 use SharpAPI\SharpApiService\Enums\SharpApiJobStatusEnum;
 use SharpAPI\SharpApiService\Enums\SharpApiJobTypeEnum;
+use Spatie\Url\Url;
 
 /**
  * Main Service to dispatch AI jobs to SharpAPI.com
@@ -49,7 +50,7 @@ public function __construct(string $apiKey, ?string $apiBaseUrl = null, ?string
             throw new InvalidArgumentException('API key is required.');
         }
         $this->setApiBaseUrl($apiBaseUrl ?? 'https://sharpapi.com/api/v1');
-        $this->setUserAgent($userAgent ?? 'SharpAPIPHPAgent/1.1.0');
+        $this->setUserAgent($userAgent ?? 'SharpAPIPHPAgent/1.2.0');
     }
 
     /**
@@ -220,12 +221,17 @@ public function fetchResults(string $statusUrl): SharpApiJob
             sleep($retryAfter);
         } while (true);
         $data = json_decode($response->getBody()->__toString(), true)['data'];
-
+        $url = Url::fromString($statusUrl);
+        if (count($url->getSegments()) == 5) { // shared job result URL
+            $result = (object) json_decode($data['attributes']['result']);
+        } else {    // 7 segments, 1-to-1 job to result url
+            $result = (object) $data['attributes']['result'];
+        }
         return new SharpApiJob(
             id: $data['id'],
             type: $data['attributes']['type'],
             status: $data['attributes']['status'],
-            result: $data['attributes']['result'] ?? null
+            result: $result ?? null
         );
     }
 
@@ -581,7 +587,8 @@ public function summarizeText(
         string  $text,
         ?string $language = null,
         ?int    $maxLength = null,
-        ?string $voiceTone = null
+        ?string $voiceTone = null,
+        ?string $context = null
     ): string
     {
         $response = $this->makeRequest(
@@ -592,6 +599,7 @@ public function summarizeText(
                 'language' => $language,
                 'max_length' => $maxLength,
                 'voice_tone' => $voiceTone,
+                'context' => $context,
             ]);
 
         return $this->parseStatusUrl($response);
@@ -608,7 +616,8 @@ public function generateKeywords(
         string  $text,
         ?string $language = null,
         ?int    $maxQuantity = null,
-        ?string $voiceTone = null
+        ?string $voiceTone = null,
+        ?string $context = null
     ): string
     {
         $response = $this->makeRequest(
@@ -619,6 +628,7 @@ public function generateKeywords(
                 'language' => $language,
                 'max_quantity' => $maxQuantity,
                 'voice_tone' => $voiceTone,
+                'context' => $context,
             ]);
 
         return $this->parseStatusUrl($response);