Let's go

Author: maximerenou

.gitignore

@@ -0,0 +1,3 @@
+vendor/
+.idea/
+.DS_Store

README.md

@@ -0,0 +1,80 @@
+![HuggingChat + PHP](logo.png)
+
+# HuggingChat client
+
+[![Latest Stable Version](https://img.shields.io/github/v/release/maximerenou/php-hugging-chat)](https://packagist.org/packages/maximerenou/hugging-chat)
+[![PHP version](https://img.shields.io/packagist/dependency-v/maximerenou/hugging-chat/php)](https://packagist.org/packages/maximerenou/hugging-chat)
+[![cURL extension required](https://img.shields.io/packagist/dependency-v/maximerenou/hugging-chat/ext-curl)](https://packagist.org/packages/maximerenou/hugging-chat)
+
+This is an unofficial Composer package for using **HuggingChat** (OpenAssistant's LLaMA model).
+
+## Installation
+
+    composer require maximerenou/hugging-chat
+
+## Usage
+
+**Demo**: run `examples/chat.php` to test it.
+
+```php
+use MaximeRenou\HuggingChat\Client as HuggingChat;
+use MaximeRenou\HuggingChat\Prompt;
+
+$ai = new HuggingChat();
+
+$conversation = $ai->createConversation();
+
+// $answer - full answer
+$answer = $conversation->ask(new Prompt("Hello World"));
+```
+
+<details>
+  <summary>Real-time / progressive answer</summary>
+
+You may pass a function as second argument to get real-time progression:
+
+```php
+// $current_answer - incomplete answer
+// $tokens - last tokens received
+$final_answer = $conversation->ask($prompt, function ($current_answer, $tokens) {
+    echo $tokens;
+});
+```
+
+</details> 
+
+<details>
+  <summary>Resume a conversation</summary>  
+
+If you want to resume a previous conversation, you can retrieve its identifiers:
+
+```php
+// Get current identifiers
+$identifiers = $conversation->getIdentifiers();
+
+// ...
+// Resume conversation with $identifiers parameter
+$conversation = $ai->resumeChatConversation($identifiers);
+```
+
+</details> 
+
+<details>
+  <summary>Handle HuggingChat errors</summary>
+
+The code throws exceptions when it receives an error from HuggingChat. You can therefore use a try/catch block to handle errors.
+
+</details>
+
+<details>
+  <summary>Answers are sometimes malformed (or dumb)</summary>
+
+That's what OpenAssistant's LLaMA model used by HuggingChat generates...
+
+</details>
+
+---------------------------------------
+
+#### Disclaimer
+
+Using HuggingChat outside huggingface.co/chat may violate HuggingFace terms. Use it at your own risk.

composer.json

@@ -0,0 +1,21 @@
+{
+    "name": "maximerenou/hugging-chat",
+    "description": "HuggingChat client",
+    "type": "library",
+    "autoload": {
+        "psr-4": {
+            "MaximeRenou\\HuggingChat\\": "src/"
+        }
+    },
+    "authors": [
+        {
+            "name": "Maxime Renou",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "php": ">=7.1",
+        "ext-curl": "*",
+        "eislambey/eventsource": "^0.1.0"
+    }
+}

composer.lock

@@ -0,0 +1,34 @@
+<?php
+require __DIR__ . '/../vendor/autoload.php';
+
+\MaximeRenou\HuggingChat\Tools::$debug = false; // Set true for verbose
+
+$ai = new \MaximeRenou\HuggingChat\Client();
+
+$conversation = $ai->createConversation();
+
+echo 'Type "q" to quit' . PHP_EOL;
+
+while (true) {
+    echo PHP_EOL . "> ";
+
+    $text = rtrim(fgets(STDIN));
+
+    if ($text == 'q')
+        break;
+
+    $prompt = new \MaximeRenou\HuggingChat\Prompt($text);
+
+    echo "-";
+
+    try {
+        $full_answer = $conversation->ask($prompt, function ($answer, $tokens) use (&$padding) {
+            echo $tokens;
+        });
+    }
+    catch (\Exception $exception) {
+        echo " Sorry, something went wrong: {$exception->getMessage()}.";
+    }
+}
+
+exit(0);

examples/chat.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace MaximeRenou\HuggingChat;
+
+class Client
+{
+    public function createConversation($identifiers = null)
+    {
+        return $this->resumeConversation($identifiers);
+    }
+
+    public function resumeConversation($identifiers)
+    {
+        return new Conversation($identifiers);
+    }
+}

logo.png

@@ -0,0 +1,168 @@
+<?php
+
+namespace MaximeRenou\HuggingChat;
+
+use EventSource\Event;
+use EventSource\EventSource;
+
+class Conversation
+{
+    const END_CHAR = '<|endoftext|>';
+
+    // Conversation IDs
+    public $id;
+    public $cookie;
+
+    // Conversation data
+    protected $current_started;
+    protected $current_text;
+
+    public function __construct($identifiers = null)
+    {
+        if (is_array($identifiers) && ! empty($identifiers['cookie']))
+            $this->cookie = $identifiers['cookie'];
+
+        if (! is_array($identifiers))
+            $identifiers = $this->initConversation();
+
+        $this->id = $identifiers['id'];
+        $this->cookie = $identifiers['cookie'];
+    }
+
+    public function getIdentifiers()
+    {
+        return [
+            'id' => $this->id,
+            'cookie' => $this->cookie
+        ];
+    }
+
+    public function initConversation()
+    {
+        $headers = [
+            'method: POST',
+            'accept: application/json',
+            "referer: https://huggingface.co/chat",
+            'content-type: application/json',
+        ];
+
+        if (! empty($this->cookie)) {
+            $headers[] = "cookie: hf-chat={$this->cookie}";
+        }
+
+        list($data, $request, $url, $cookies) = Tools::request("https://huggingface.co/chat/conversation", $headers, '', true);
+        $data = json_decode($data, true);
+
+        if (! empty($cookies['hf-chat'])) {
+            $this->cookie = $cookies['hf-chat'];
+        }
+
+        if (! is_array($data) || empty($data['conversationId']))
+            throw new \Exception("Failed to init conversation");
+
+        return [
+            'id' => $data['conversationId'],
+            'cookie' => $this->cookie
+        ];
+    }
+
+    public function ask(Prompt $message, $callback = null)
+    {
+        $this->current_text = '';
+
+        $es = new EventSource("https://huggingface.co/chat/conversation/{$this->id}");
+
+        $data = [
+            'inputs' => $message->text,
+            'options' => [
+                'use_cache' => $message->cache
+            ],
+            'parameters' => [
+                'max_new_tokens' => $message->max_new_tokens,
+                'repetition_penalty' => $message->repetition_penalty,
+                'return_full_text' => $message->return_full_text,
+                'stop' => [self::END_CHAR],
+                'temperature' => $message->temperature,
+                'top_k' => $message->top_k,
+                'top_p' => $message->top_p,
+                'truncate' => $message->truncate,
+                'watermark' => $message->watermark, 
+            ],
+            'stream' => true
+        ];
+
+        $es->setCurlOptions([
+            CURLOPT_HTTPHEADER => [
+                'method: POST',
+                'accept: */*',
+                "referer: https://huggingface.co/chat/conversation/{$this->id}",
+                'content-type: application/json',
+                "cookie: hf-chat={$this->cookie}"
+            ],
+            CURLOPT_POST => 1,
+            CURLOPT_POSTFIELDS => json_encode($data)
+        ]);
+        
+        $es->onMessage(function (Event $event) use ($es, &$callback) {
+            if ($es === 4) {
+                $es->abort();
+            }
+
+            $message = $this->handlePacket($event->data);
+
+            if ($message === false)
+                return;
+
+            $tokens = $message['text'];
+
+            if ($message['final']) {
+                $offset = strlen($this->current_text);
+                $this->current_text = $tokens;
+                $tokens = substr($tokens, $offset);
+            }
+            else {
+                $this->current_text .= $tokens;
+            }
+
+            if (($pos = strpos($this->current_text, self::END_CHAR)) !== false) {
+                $this->current_text = substr($this->current_text, 0, $pos);
+            }
+
+            $callback($this->current_text, $tokens);
+        });
+        
+        @$es->connect();
+
+        return $this->current_text;
+    }
+
+    public function handlePacket($raw)
+    {
+        $data = json_decode($raw, true);
+
+        if (! $data) {
+            return false;
+        }
+
+        if (empty($data['token'])) {
+            Tools::debug("Drop: $raw");
+
+            if (! empty($data['error'])) {
+                throw new \Exception($data['error']);
+            }
+
+            return false;
+        }
+
+        $text = $data['token']['special'] ? $data['generated_text'] : $data['token']['text'];
+        
+        if (($pos = strpos($text, self::END_CHAR)) !== false) {
+            $text = substr($text, 0, $pos);
+        }
+
+        return [
+            'text' => $text,
+            'final' => $data['token']['special']
+        ];
+    }
+}