Check the details at SharpAPI's Content API page.
- PHP >= 8.1
- Laravel >= 9.0
Follow these steps to install and set up the SharpAPI Laravel Spam Detection package.
- Install the package via
composer:
composer require sharpapi/laravel-content-detect-spam-
Register at SharpAPI.com to obtain your API key.
-
Set the API key in your
.envfile:
SHARP_API_KEY=your_api_key_here- [OPTIONAL] Publish the configuration file:
php artisan vendor:publish --tag=sharpapi-content-detect-spam- AI-Powered Spam Detection: Efficiently detect spam content in any text.
- Confidence Scoring: Get a confidence score (0-100%) for spam classification.
- Detailed Explanations: Receive explanations for why content is classified as spam or not.
- Content Moderation: Perfect for moderating user-generated content.
- Robust Polling for Results: Polling-based API response handling with customizable intervals.
- API Availability and Quota Check: Check API availability and current usage quotas with SharpAPI's endpoints.
You can inject the ContentDetectSpamService class to access spam detection functionality. For best results, especially with batch processing, use Laravel's queuing system to optimize job dispatch and result polling.
- Dispatch Job: Send text content to the API using
detectSpam, which returns a status URL. - Poll for Results: Use
fetchResults($statusUrl)to poll until the job completes or fails. - Process Result: After completion, retrieve the results from the
SharpApiJobobject returned.
Note: Each job typically takes a few seconds to complete. Once completed successfully, the status will update to
success, and you can process the results as JSON, array, or object format.
Here is an example of how to use ContentDetectSpamService within a Laravel controller:
<?php
namespace App\Http\Controllers;
use GuzzleHttp\Exception\GuzzleException;
use SharpAPI\ContentDetectSpam\ContentDetectSpamService;
class ContentController extends Controller
{
protected ContentDetectSpamService $spamDetectionService;
public function __construct(ContentDetectSpamService $spamDetectionService)
{
$this->spamDetectionService = $spamDetectionService;
}
/**
* @throws GuzzleException
*/
public function checkForSpam(string $text)
{
$statusUrl = $this->spamDetectionService->detectSpam($text);
$result = $this->spamDetectionService->fetchResults($statusUrl);
return response()->json($result->getResultJson());
}
}All requests are managed by Guzzle, so it's helpful to be familiar with Guzzle Exceptions.
Example:
use GuzzleHttp\Exception\ClientException;
try {
$statusUrl = $this->spamDetectionService->detectSpam('Buy cheap medications now! Click here for amazing deals!');
} catch (ClientException $e) {
echo $e->getMessage();
}You can customize the configuration by setting the following environment variables in your .env file:
SHARP_API_KEY=your_api_key_here
SHARP_API_JOB_STATUS_POLLING_WAIT=180
SHARP_API_JOB_STATUS_USE_POLLING_INTERVAL=true
SHARP_API_JOB_STATUS_POLLING_INTERVAL=10
SHARP_API_BASE_URL=https://sharpapi.com/api/v1{
"data": {
"type": "api_job_result",
"id": "f7d3eec2-7ba6-4104-9f30-ff418428de2c",
"attributes": {
"status": "success",
"type": "content_detect_spam",
"result": {
"pass": false,
"score": 85,
"reason": "The message appears to be a solicitation for financial services, which is a common characteristic of spam."
}
}
}
}For issues or suggestions, please:
Please see CHANGELOG for a detailed list of changes.
- A2Z WEB LTD
- Dawid Makowski
- Enhance your Laravel AI capabilities!
The MIT License (MIT). Please see License File for more information.
Stay updated with news, tutorials, and case studies:
