martink / chatgpt-site-assistant
A Laravel package to scan website routes and connect to ChatGPT as a smart assistant.
Requires
- php: ^8.1|^8.4
- guzzlehttp/guzzle: ^7.0
- illuminate/support: ^8.0|^9.0|^10.0|^11.0|^12.0
README
A Laravel package that scans your website's sitemap, extracts content, and connects to OpenAI's ChatGPT API to create an intelligent assistant that understands your site's actual content.
📦 Installation
composer require martink/chatgpt-site-assistant
Publish Config and Migrations
php artisan vendor:publish --tag=config php artisan vendor:publish --tag=migrations
Then run:
php artisan migrate
⚙️ Configuration
Add your OpenAI API settings to your .env file:
OPENAI_API_KEY=your-openai-api-key
OPENAI_MODEL=gpt-3.5-turbo
OPENAI_BASE_URI=https://api.openai.com/v1
OPENAI_MAX_RETRIES=3
OPENAI_TIMEOUT=30
OPENAI_SYSTEM_MESSAGE="You are a helpful assistant for a wedding planning website. Use the following context to answer the user's question."
You can override these in the published config file:
config/chatgpt-site-assistant.php🧠 Usage
Step 1: Scan Your Website's Sitemap
php artisan chatgpt:scan-sitemap http://localhost/sitemap.xml
This command will:
-
Read your sitemap.
-
Visit each route listed.
-
Extract the textual content.
-
Store it in the
website_contentstable for future use.
Step 2: Query the Assistant
Make a POST request to:
POST /api/chat
Example JSON body:
{
"question": "What are your opening hours?"
}
The assistant uses your site's content to respond contextually via ChatGPT.
🧩 Components
-
Service: ChatGptService.php – handles OpenAI API interaction.
-
Command:
chatgpt:scan-sitemap– crawls and stores your site's content. -
Controller: ChatGptController.php – exposes the assistant via API.
-
Model: WebsiteContent.php – stores extracted text per URL.
✅ Laravel Compatibility
Laravel 8, 9, 10, and 12 supported.
PHP 8.0 – 8.4 supported.
📄 License
This package is open-source software licensed under the MIT license.