dragonzap/openai-chatgpt-assistant

Provides clean abstraction for the chatgpt assistant API. Build and run assistants with a clean easy to use design

Maintainers

Details

github.com/dragonzapeducation/chatgpt-assistant

Source

Issues

Installs: 64

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 1

Open Issues: 1

v2.2.1 2025-04-15 10:23 UTC

Requires

GPL-2.0-or-later 8dd732d5af8f3b8ca7746b1ba53fd8f83a1f1332

  • Dragon Zap Publishing

This package is auto-updated.

Last update: 2025-04-15 16:24:04 UTC

README

Provides clean abstraction layer for the chatgpt assistant API. Build and run assistants with a clean easy to use design, compatible with raw PHP and also Laravel framework.

Documentation for Installation on Laravel framework -- Now compatible with Laravel 9, 10, 11 and 12

Documentation for Installation without Laravel framework

Installation

To install the ChatGPT Assistant wrapper, use Composer. Run the following command in your project directory:

composer require dragonzap/openai-chatgpt-assistant

Simple Usage

// Replace the API Key with your own chatgpt API key
$assistant = new JessicaAssistant(new APIConfiguration('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'));
$conversation = $assistant->newConversation();

while(1)
{
    $input_message = fgets(STDIN);
    echo 'User:' . $input_message . "\n";
    $conversation->sendMessage($input_message);
    $conversation->blockUntilResponded();
    
    echo 'Assistant: ' . $conversation->getResponseData()->getResponse() . "\n";
    
}

JessicaAssistant will override the handleFunction() method which will be called by ChatGPT when ChatGPT needs to execute functions

 public function handleFunction(string $function, array $arguments): string|array
    {
        $response = [];

        switch($function)
        {
            case 'get_weather':
                $response = ['success' => true, 'message' => 'We will pretend its a sunny day where ever you live'];
                break;

            default:
                $response = [
                    'success' => false,
                    'message' => 'Unknown function'
                ];
        }
        return $response;
    }

The handleFunction method will respond with the message to send back to ChatGPT both strings and arrays are allowed. See the full implementation of Jessica Assistant here: https://github.com/dragonzapeducation/chatgpt-assistant-examples/blob/main/JustSimplePhp/src/console-chat-example.php