Check the details at SharpAPI's E-commerce API page.
- PHP >= 8.1
- Laravel >= 9.0
Follow these steps to install and set up the SharpAPI Laravel Product Review Sentiment Analysis package.
- Install the package via
composer:
composer require sharpapi/laravel-ecommerce-review-sentiment-
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-ecommerce-review-sentiment- AI-Powered Sentiment Analysis: Efficiently analyze sentiment in product reviews with confidence scores.
- Sentiment Classification: Automatically classify reviews as POSITIVE, NEGATIVE, or NEUTRAL.
- Confidence Scoring: Get a confidence score (0-100%) for each sentiment classification.
- 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 EcommerceReviewSentimentService class to access sentiment analysis functionality. For best results, especially with batch processing, use Laravel's queuing system to optimize job dispatch and result polling.
- Dispatch Job: Send a product review to the API using
productReviewSentiment, 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 EcommerceReviewSentimentService within a Laravel controller:
<?php
namespace App\Http\Controllers;
use GuzzleHttp\Exception\GuzzleException;
use SharpAPI\EcommerceReviewSentiment\EcommerceReviewSentimentService;
class ReviewController extends Controller
{
protected EcommerceReviewSentimentService $reviewSentimentService;
public function __construct(EcommerceReviewSentimentService $reviewSentimentService)
{
$this->reviewSentimentService = $reviewSentimentService;
}
/**
* @throws GuzzleException
*/
public function analyzeSentiment(string $review)
{
$statusUrl = $this->reviewSentimentService->productReviewSentiment($review);
$result = $this->reviewSentimentService->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->reviewSentimentService->productReviewSentiment('This product is amazing! I love it.');
} 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": "7f829234-0e87-4796-a820-4f9fe5de5aab",
"attributes": {
"status": "success",
"type": "ecommerce_review_sentiment",
"result": {
"score": "85",
"opinion": "NEGATIVE"
}
}
}
}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:
