added:

- GenerateQuery support
- multimodal demo
- kick support

Author: maximerenou

README.md

@@ -13,6 +13,14 @@ This is an unofficial PHP client for **Bing AI**, including **Chat (GPT-4)** and
 
     composer require maximerenou/bing-ai
 
+## Demo
+
+This demo program uses both Chat and Image Creator:
+
+![Demo](examples/demo.gif)
+
+Source: `examples/multi.php`.
+
 ## Usage
 
 - [Chat AI](#chat-ai)
@@ -50,9 +58,7 @@ $valid = $ai->checkCookie();
 
 ### Chat AI
 
-![Chat demo](examples/demo-chat.gif)
-
-**Demo**: clone this repo, edit and run `examples/chat.php` to test it.
+**Demo**: clone this repo, edit and run `examples/chat.php`.
 
 ```php
 use MaximeRenou\BingAI\BingAI;
@@ -64,11 +70,11 @@ $ai = new BingAI($cookie);
 $conversation = $ai->createChatConversation();
 
 // $text - Text-only version of Bing's answer
-// $messages - Message objects array
-list($text, $messages) = $conversation->ask(new Prompt("Hello World"));
+// $cards - Message objects array
+list($text, $cards) = $conversation->ask(new Prompt("Hello World"));
 ```
 
-> Every "card" from Bing AI is fetched. Check `Message.php` to learn more 
+> `$cards` contains all "messages" exchanged with Bing AI. It can be text (prompt or answer), signals, suggestions, image generation requests, etc. Check `Message.php` to learn more 
 about its format.
 
 <details>
@@ -78,8 +84,8 @@ You may pass a function as second argument to get real-time progression:
 
 ```php
 // $text - Incomplete text version
-// $messages - Incomplete messages fleet
-list($final_text, $final_messages) = $conversation->ask($prompt, function ($text, $messages) {
+// $cards - Incomplete messages fleet
+list($final_text, $final_cards) = $conversation->ask($prompt, function ($text, $cards) {
     echo $text;
 });
 ```
@@ -149,7 +155,7 @@ $conversation->ask($prompt->withoutCache(), ...)
 </details>
 
 <details>
-  <summary>Throttling</summary>
+  <summary>Handle throttling  and kicks</summary>
 
 Bing is limiting messages count per conversations. You can monitor it by calling `getRemainingMessages()` after every interaction.
 
@@ -161,15 +167,29 @@ if ($remaining === 0) {
 }
 ```
 
+After every interaction, you should also check if you have been kicked from the conversation:
+
+```php
+if ($conversation->kicked()) {
+    // You have been kicked, you should start a new conversation
+}
+```
+
+You may combine both checks with:
+
+```php
+if ($conversation->ended()) {
+    // You reached the limit or have been kicked
+}
+```
+
 </details>
 
 ---------------------------------------
 
 ### Image Creator
 
-![Image Creator demo](examples/demo-images.gif)
-
-**Demo**: clone this repo, edit and run `examples/images.php` to test it.
+**Demo**: clone this repo, edit and run `examples/images.php`.
 
 ```php
 use MaximeRenou\BingAI\BingAI;

examples/chat.php

@@ -36,7 +36,7 @@
 
         // Print partial answer
         echo "- $text";
-        $padding = mb_strlen($text) + 2;
+        $padding = strlen($text) + 2;
     });
 
     // Erase the last line
@@ -46,6 +46,11 @@
     // Print final answer
     echo "- $text" . PHP_EOL;
 
+    if ($conversation->kicked()) {
+        echo "[Conversation ended]" . PHP_EOL;
+        break;
+    }
+
     $remaining = $conversation->getRemainingMessages();
 
     if ($remaining != 0) {

examples/demo-chat.gif

@@ -0,0 +1,84 @@
+<?php
+
+$cookie = "YOUR_COOKIE_HERE"; //@TODO change
+
+if ($cookie == 'YOUR_COOKIE_HERE') {
+    echo 'Please add your _U cookie to multi.php (line 3)' . PHP_EOL;
+    exit(1);
+}
+
+require __DIR__ . '/../vendor/autoload.php';
+
+$ai = new \MaximeRenou\BingAI\BingAI($cookie);
+
+$conversation = $ai->createChatConversation()
+    ->withTone(\MaximeRenou\BingAI\Chat\Tone::Creative);
+
+\MaximeRenou\BingAI\Tools::$debug = false; // Set true for verbose
+
+echo 'Type "q" to quit' . PHP_EOL;
+
+while (true) {
+    echo PHP_EOL . "> ";
+    $text = rtrim(fgets(STDIN));
+
+    if ($text == 'q')
+        break;
+
+    $prompt = new \MaximeRenou\BingAI\Chat\Prompt($text);
+    $padding = 0;
+
+    list($text, $cards) = $conversation->ask($prompt, function ($text, $cards) use (&$padding) {
+        // Erase the last line
+        for ($i = 0; $i < $padding; $i++)
+            echo chr(8);
+
+        $text = trim($text);
+
+        // Print partial answer
+        echo "- $text";
+        $padding = strlen($text) + 2;
+    });
+
+    // Erase the last line
+    for ($i = 0; $i < $padding; $i++)
+        echo chr(8);
+
+    // Print final answer
+    echo "- $text" . PHP_EOL;
+
+    // Generative cards
+    foreach ($cards as $card) {
+        if ($card->type == \MaximeRenou\BingAI\Chat\MessageType::GenerateQuery && $card->data['contentType'] == 'IMAGE') {
+            $loader = "Generating: {$card->text}...";
+            echo $loader;
+
+            // Create the image
+            $creator = $ai->createImages($card->text);
+            $creator->wait();
+
+            // Result
+            for ($i = 0; $i < strlen($loader); $i++)
+                echo chr(8);
+
+            if ($creator->hasFailed()) {
+                echo "[Image generation failed]" . PHP_EOL;
+            }
+            else {
+                foreach ($creator->getImages() as $image) {
+                    echo "* $image" . PHP_EOL;
+                }
+
+                $remaining = $creator->getRemainingBoosts();
+                echo "[$remaining remaining boosts]" . PHP_EOL;
+            }
+        }
+    }
+
+    if ($conversation->ended()) {
+        echo "[Conversation ended]" . PHP_EOL;
+        break;
+    }
+}
+
+exit(0);

examples/demo-images.gif

@@ -27,6 +27,7 @@ class Conversation
     protected $current_messages;
     protected $user_messages_count;
     protected $max_messages_count;
+    protected $kicked = false;
 
     public function __construct($cookie, $identifiers = null, $invocations = 0)
     {
@@ -76,6 +77,16 @@ public function getRemainingMessages()
         return $this->max_messages_count - $this->user_messages_count;
     }
 
+    public function kicked()
+    {
+        return $this->kicked;
+    }
+
+    public function ended()
+    {
+        return $this->kicked || $this->getRemainingMessages() <= 0;
+    }
+
     public function createIdentifiers($cookie)
     {
         $data = Tools::request("https://www.bing.com/turing/conversation/create", [
@@ -241,7 +252,11 @@ public function handlePacket($raw, $connection, $message, $callback)
                             'InternalLoaderMessage',
                             'RenderCardRequest',
                             'AdsQuery',
-                            'SemanticSerp'
+                            'SemanticSerp',
+                            'Disengaged',
+                            'ActionRequest',
+                            'GenerateContentQuery',
+                            'SearchQuery',
                         ],
                         'sliceIds' => [],
                         'traceId' => $trace_id,
@@ -358,6 +373,8 @@ public function handleObject($object, $callback = null)
         foreach ($this->current_messages as $message) {
             if ($message->type == MessageType::Answer)
                 $text_parts[] = $message->toText();
+            elseif ($message->type == MessageType::Disengaged)
+                $this->kicked = true;
         }
 
         $this->current_text = trim(implode('. ', array_filter($text_parts)));

examples/demo.gif

@@ -19,17 +19,35 @@ public static function fromData($data)
 
         switch ($data['messageType'] ?? '') {
             case 'InternalSearchQuery':
-                $message->type = MessageType::SearchQuery;
+                $message->type = MessageType::InternalSearchQuery;
                 break;
             case 'InternalSearchResult':
                 $message->type = MessageType::SearchResult;
                 break;
             case 'InternalLoaderMessage':
                 $message->type = MessageType::Loader;
                 break;
+            case 'SemanticSerp':
+                $message->type = MessageType::SemanticSerp;
+                break;
+            case 'Disengaged':
+                $message->type = MessageType::Disengaged;
+                break;
+            case 'AdsQuery':
+                $message->type = MessageType::AdsQuery;
+                break;
+            case 'ActionRequest':
+                $message->type = MessageType::ActionRequest;
+                break;
             case 'RenderCardRequest':
                 $message->type = MessageType::RenderRequest;
                 break;
+            case 'SearchQuery':
+                $message->type = MessageType::SearchQuery;
+                break;
+            case 'GenerateContentQuery':
+                $message->type = MessageType::GenerateQuery;
+                break;
             default:
                 $message->type = $data['author'] == 'user' ? MessageType::Prompt : MessageType::Answer;
         }
@@ -76,4 +94,4 @@ public function jsonSerialize(): mixed
     {
         return $this->toArray();
     }
-}
+}

examples/multi.php

@@ -6,8 +6,14 @@ class MessageType
 {
     const Answer = "answer";
     const Prompt = "prompt";
-    const SearchQuery = "search_query";
+    const InternalSearchQuery = "internal_search_query";
     const SearchResult = "search_result";
     const Loader = "loader";
     const RenderRequest = "render_request";
-}
+    const SemanticSerp = "semantic_serp";
+    const Disengaged = "disengaged";
+    const AdsQuery = "ads_query";
+    const ActionRequest = "action_request";
+    const SearchQuery = "search_query";
+    const GenerateQuery = "generate_query";
+}