Laravel Chatbot provides a robust and easy-to-use solution for integrating AI chatbots into your Laravel applications. Leveraging the power of OpenAI, it allows you to create, manage, and interact with chat threads directly from your Laravel application. Whether you're building a customer service chatbot or an interactive AI assistant, laravel-chatbot offers a streamlined, Laravel-friendly interface to the OpenAI API.
You can install the package via composer:
composer require halilcosdu/laravel-chatbotYou can publish the config file with:
php artisan vendor:publish --tag="chatbot-config"This is the contents of the published config file:
You have to create an assistant on OpenAI and get the API key and assistant ID.
https://platform.openai.com/assistants
return [
'assistant_id' => env('OPENAI_API_ASSISTANT_ID'),
'api_key' => env('OPENAI_API_KEY'),
'organization' => env('OPENAI_ORGANIZATION'),
'request_timeout' => env('OPENAI_TIMEOUT'),
'sleep_seconds' => env('OPENAI_SLEEP_SECONDS'), // Sleep seconds between requests default .1
'models' => [
// Thread model must have threadMessages(): HasMany relation
// ThreadMessage model mush have thread(): BelongsTo relation
'thread' => \HalilCosdu\ChatBot\Models\Thread::class,
'thread_messages' => \HalilCosdu\ChatBot\Models\ThreadMessage::class
],
];You can publish and run the migrations with:
php artisan vendor:publish --tag="chatbot-migrations"
php artisan migrateThis will migrate the following tables:
Schema::create('threads', function (Blueprint $table) {
$table->id();
$table->string('owner_id')->nullable()->index();
$table->string('subject');
$table->string('remote_thread_id')->index();
$table->timestamps();
});Schema::create('thread_messages', function (Blueprint $table) {
$table->id();
$table->foreignIdFor(config('chatbot.models.thread'))->constrained()->cascadeOnDelete();
$table->string('role')->index();
$table->longText('content');
$table->timestamps();
});public function listThreads(mixed $ownerId = null, mixed $search = null, mixed $appends = null): \Illuminate\Contracts\Pagination\LengthAwarePaginator
public function createThread(string $subject, mixed $ownerId = null): \Illuminate\Database\Eloquent\Model|\Illuminate\Database\Eloquent\Builder
public function thread(int $id, mixed $ownerId = null): \Illuminate\Database\Eloquent\Model|\Illuminate\Database\Eloquent\Builder
public function updateThread(string $message, int $id, mixed $ownerId = null): \Illuminate\Database\Eloquent\Model|\Illuminate\Database\Eloquent\Builder
public function deleteThread(int $id, mixed $ownerId = null): voidChatBot::listThreads(): LengthAwarePaginator; /* List all threads */
ChatBot::createThread('Hello, what is the capital of Turkey?'): Model; /* Create a new thread */
ChatBot::thread($id): Model; /* Get a thread with messages */
ChatBot::updateThread('Where should I visit?', $id): Model; /* Continue the conversation */
ChatBot::deleteThread($id): void; /* Delete the thread */public function createThreadAsRaw(string $subject)
public function listThreadMessagesAsRaw(string $remoteThreadId)
public function updateThreadAsRaw(string $remoteThreadId, array $data) /* $data = ['role' => 'user or assistant', 'content' => 'Hello'] */
public function deleteThreadAsRaw(string $remoteThreadId)
public function threadAsRaw(string $threadId)
public function messageAsRaw(string $threadId, string $messageId)
public function modifyMessageAsRaw(string $threadId, string $messageId, array $parameters)ChatBot::createThreadAsRaw(string $subject);
ChatBot::listThreadMessagesAsRaw(string $remoteThreadId);
ChatBot::updateThreadAsRaw(string $remoteThreadId, array $data);
ChatBot::deleteThreadAsRaw(string $remoteThreadId);
ChatBot::threadAsRaw(string $threadId);
ChatBot::messageAsRaw(string $threadId, string $messageId);
ChatBot::modifyMessageAsRaw(string $threadId, string $messageId, array $parameters);composer testPlease see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.
