README

AI Product Introduction Generator for Laravel

🚀 Leverage AI API to generate engaging product introductions for E-commerce applications.

Check the details at SharpAPI's E-commerce API page.

Requirements

PHP >= 8.1
Laravel >= 9.0

Installation

Follow these steps to install and set up the SharpAPI Laravel Product Introduction Generator package.

Install the package via composer:

composer require sharpapi/laravel-ecommerce-product-intro

Register at SharpAPI.com to obtain your API key.
Set the API key in your .env file:

SHARP_API_KEY=your_api_key_here

[OPTIONAL] Publish the configuration file:

php artisan vendor:publish --tag=sharpapi-ecommerce-product-intro

Key Features

AI-Powered Product Introduction Generation: Efficiently create engaging product descriptions for your e-commerce platform.
Multi-language Support: Generate product introductions in multiple languages.
Customizable Length: Control the length of the generated product introduction.
Voice Tone Control: Set your preferred writing style for the product introduction.
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.

Usage

You can inject the EcommerceProductIntroService class to access product introduction generation functionality. For best results, especially with batch processing, use Laravel's queuing system to optimize job dispatch and result polling.

Basic Workflow

Dispatch Job: Send product data to the API using generateProductIntro, 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 SharpApiJob object 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.

Controller Example

Here is an example of how to use EcommerceProductIntroService within a Laravel controller:

<?php

namespace App\Http\Controllers;

use GuzzleHttp\Exception\GuzzleException;
use SharpAPI\EcommerceProductIntro\EcommerceProductIntroService;

class ProductController extends Controller
{
    protected EcommerceProductIntroService $productIntroService;

    public function __construct(EcommerceProductIntroService $productIntroService)
    {
        $this->productIntroService = $productIntroService;
    }

    /**
     * @throws GuzzleException
     */
    public function generateProductIntro(string $productData)
    {
        $statusUrl = $this->productIntroService->generateProductIntro(
            $productData,
            'English',   // optional language
            300,   // optional maximum length
            'Enthusiastic'   // optional voice tone
        );
        
        $result = $this->productIntroService->fetchResults($statusUrl);

        return response()->json($result->getResultJson());
    }
}

Handling Guzzle Exceptions

All requests are managed by Guzzle, so it's helpful to be familiar with Guzzle Exceptions.

Example:

use GuzzleHttp\Exception\ClientException;

try {
    $statusUrl = $this->productIntroService->generateProductIntro('Sony PlayStation 5 with 1TB SSD', 'English', 300);
} catch (ClientException $e) {
    echo $e->getMessage();
}

Optional Configuration

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

Product Introduction Data Format Example

{
  "data": {
    "type": "api_job_result",
    "id": "fb0a5ab0-54fe-4283-9a33-ac491962c778",
    "attributes": {
      "status": "success",
      "type": "ecommerce_product_intro",
      "result": {
        "product_intro": "Experience unparalleled gaming with the Razer Blade 16, featuring NVIDIA RTX 4090, 13th Gen Intel i9, dual-mode 4K/FHD display, 32GB RAM, 2TB SSD, and a compact GaN charger."
      }
    }
  }
}

Support & Feedback

For issues or suggestions, please:

Open an issue on GitHub
Join our Telegram community

Changelog

Please see CHANGELOG for a detailed list of changes.

Credits

A2Z WEB LTD
Dawid Makowski
Enhance your Laravel AI capabilities!

License

The MIT License (MIT). Please see License File for more information.

Stay updated with news, tutorials, and case studies:

sharpapi / laravel-ecommerce-product-intro

Maintainers

Details