README

A powerful Filament plugin that integrates AI chat capabilities directly into your admin panel.

Features

• AI Chat Interface: Seamless chat experience with AI models
• Multiple AI Providers: Support for various AI services
• Conversation History: Keep track of all your AI conversations
• Customizable Prompts: Create and save custom prompt templates
• File Upload Support: Send files to AI for analysis
• Response Export: Save and share AI responses
• Real-time Chat: Live chat experience with streaming responses

Installation

1. Install via Composer

composer require filaforge/chat-ai

2. Publish & Migrate

# Publish provider groups (config, views, migrations)
php artisan vendor:publish --provider="Filaforge\\ChatAi\\Providers\\ChatAiServiceProvider"

# Run migrations
php artisan migrate

3. Register Plugin

Add the plugin to your Filament panel provider:

use Filament\Panel;

public function panel(Panel $panel): Panel
{
    return $panel
        // ... other configuration
        ->plugin(\Filaforge\ChatAi\Providers\ChatAiPanelPlugin::make());
}

Setup

Configuration

The plugin will automatically:

• Publish configuration files to config/chat-ai.php
• Publish view files to resources/views/vendor/chat-ai/
• Publish migration files to database/migrations/
• Register necessary routes and middleware

AI Provider Configuration

Configure your AI provider in the published config file:

// config/chat-ai.php
return [
    'default_provider' => 'openai',
    'providers' => [
        'openai' => [
            'api_key' => env('OPENAI_API_KEY'),
            'model' => 'gpt-4',
        ],
        'anthropic' => [
            'api_key' => env('ANTHROPIC_API_KEY'),
            'model' => 'claude-3-sonnet',
        ],
    ],
];

Environment Variables

Add these to your .env file:

OPENAI_API_KEY=your_openai_api_key_here
ANTHROPIC_API_KEY=your_anthropic_api_key_here

Usage

Accessing the Chat AI

1. Navigate to your Filament admin panel
2. Look for the "Chat AI" menu item
3. Start chatting with AI models

Starting a Conversation

1. Select AI Model: Choose from available AI providers
2. Type Your Message: Enter your question or prompt
3. Send Message: Submit your message to the AI
4. View Response: See the AI's response in real-time
5. Continue Chat: Keep the conversation going

Advanced Features

• File Uploads: Send documents, images, or other files
• Prompt Templates: Save and reuse common prompts
• Conversation Export: Download chat history
• Custom Settings: Adjust AI parameters and behavior

Troubleshooting

Common Issues

• API key errors: Verify your API keys are correct and have sufficient credits
• Rate limiting: Check your AI provider's rate limits
• Model not available: Ensure the selected model is available in your plan
• File upload issues: Check file size limits and supported formats

Debug Steps

1. Check the plugin configuration:

php artisan config:show chat-ai

1. Verify routes are registered:

php artisan route:list | grep chat-ai

1. Test API connectivity:

php artisan tinker
# Test your API keys manually

1. Clear caches:

php artisan optimize:clear

1. Check logs for errors:

tail -f storage/logs/laravel.log

Uninstall

1. Remove Plugin Registration

Remove the plugin from your panel provider:

// remove ->plugin(\Filaforge\ChatAi\Providers\ChatAiPanelPlugin::make())

2. Roll Back Migrations (Optional)

php artisan migrate:rollback
# or roll back specific published files if needed

3. Remove Published Assets (Optional)

rm -f config/chat-ai.php
rm -rf resources/views/vendor/chat-ai

4. Remove Package and Clear Caches

composer remove filaforge/chat-ai
php artisan optimize:clear

Support

• Documentation: GitHub Repository
• Issues: GitHub Issues
• Discussions: GitHub Discussions

Contributing

We welcome contributions! Please see our Contributing Guide for details.

License

This plugin is open-sourced software licensed under the MIT license.

Made with ❤️ by the Filaforge Team