albocode/ccatphp-sdk

There is no license information available for the latest version (0.2.4) of this package.

Cheshire Cat PHP Sdk

0.2.4 2024-11-19 13:23 UTC

Requires

• guzzlehttp/guzzle: ^7.0
• phpdocumentor/reflection-docblock: ^5.3
• phrity/websocket: ^2.0
• symfony/property-access: ^7.0
• symfony/serializer: ^7.0

Requires (Dev)

• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10

Unknown License

• Riccardo Albero

README

CCat PHP SDK (Cheshire cat PHP SDK) is a library to help the implementation of Cheshire Cat on a PHP Project

• Installation
• Usage

Installation

To install CCatPHP-SDK you can run this command:

composer require albocode/ccatphp-sdk

Usage

Initialization and usage:

use Albocode\CcatphpSdk\CCatClient;
use Albocode\CcatphpSdk\Clients\HttpClient;
use Albocode\CcatphpSdk\Clients\WSClient;


$cCatClient = new CCatClient(
new WSClient('cheshire_cat_core', 1865, null),
new HttpClient('cheshire_cat_core', 1865, null)
);

Send a message to the websocket:

$notificationClosure = function (string $message) {
 // handle websocket notification, like chat token stream
}

// result is the result of the message
$result = $cCatClient->sendMessage(
new Message("Hello world!", 'user', []),  // message body
$notificationClosure // websocket notification closure handle
);

Load data to the rabbit hole:

//file
$promise = $this->client->rabbitHole($uploadedFile->getPathname(), null, null);
$promise->wait();

//url
$promise = $this->client->rabbitHoleWeb($url, null,null);
$promise->wait();

Memory management utilities:

$this->client->getMemoryCollection(); // get number of vectors in the working memory
$this->client->getMemoryRecall("HELLO"); // recall memories by text

//delete memory points by metadata, like this example delete by source
$this->client->deleteDeclarativeMemoryByMetadata(["source" => $url]);