PHPackages                             sharpapi/laravel-ecommerce-product-categories - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. sharpapi/laravel-ecommerce-product-categories

ActiveLibrary[API Development](/categories/api)

sharpapi/laravel-ecommerce-product-categories
=============================================

AI Product Categories Generator for Laravel powered by SharpAPI.com

v1.0.3(1mo ago)00MITPHPPHP ^8.1

Since Jan 9Pushed 1mo agoCompare

[ Source](https://github.com/sharpapi/laravel-ecommerce-product-categories)[ Packagist](https://packagist.org/packages/sharpapi/laravel-ecommerce-product-categories)[ Docs](https://github.com/sharpapi/laravel-ecommerce-product-categories)[ RSS](/packages/sharpapi-laravel-ecommerce-product-categories/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (3)Dependencies (6)Versions (5)Used By (0)

[![SharpAPI GitHub cover](https://camo.githubusercontent.com/82bb36706c1e71276b3dca4ec9120353bb51c8f22bb62543bf056db5c28da36d/68747470733a2f2f73686172706170692e636f6d2f73686172706170692d6769746875622d6c61726176656c2d62672e6a7067 "SharpAPI Laravel Client")](https://camo.githubusercontent.com/82bb36706c1e71276b3dca4ec9120353bb51c8f22bb62543bf056db5c28da36d/68747470733a2f2f73686172706170692e636f6d2f73686172706170692d6769746875622d6c61726176656c2d62672e6a7067)

AI Product Categories Generator for Laravel
===========================================

[](#ai-product-categories-generator-for-laravel)

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

[](#-leverage-ai-api-to-generate-product-categories-for-e-commerce-applications)

[![Latest Version on Packagist](https://camo.githubusercontent.com/1bec07c726c7a6bb0d538aa22664a0b72dc7442c42742372f44149a623764050/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f73686172706170692f6c61726176656c2d65636f6d6d657263652d70726f647563742d63617465676f726965732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/sharpapi/laravel-ecommerce-product-categories)[![Total Downloads](https://camo.githubusercontent.com/8d37bead8546e2f0a844d265887f63d4b7039fdd0b4e71e3de4faac8b26dfb0d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f73686172706170692f6c61726176656c2d65636f6d6d657263652d70726f647563742d63617465676f726965732e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/sharpapi/laravel-ecommerce-product-categories)

Check the details at SharpAPI's [E-commerce API](https://sharpapi.com/en/catalog/ai/e-commerce) page.

---

Requirements
------------

[](#requirements)

- PHP >= 8.1
- Laravel >= 10.48.29

---

Installation
------------

[](#installation)

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

1. Install the package via `composer`:

```
composer require sharpapi/laravel-ecommerce-product-categories
```

2. Register at [SharpAPI.com](https://sharpapi.com/) to obtain your API key.
3. Set the API key in your `.env` file:

```
SHARP_API_KEY=your_api_key_here
```

4. **\[OPTIONAL\]** Publish the configuration file:

```
php artisan vendor:publish --tag=sharpapi-ecommerce-product-categories
```

---

Key Features
------------

[](#key-features)

- **AI-Powered Category Generation**: Efficiently generate relevant categories for products with relevance scores.
- **Multi-language Support**: Generate product categories in multiple languages.
- **Customizable Output**: Control the number of categories returned and the voice tone.
- **Context-Aware Categorization**: Provide context to improve category relevance.
- **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
-----

[](#usage)

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

### Basic Workflow

[](#basic-workflow)

1. **Dispatch Job**: Send a product name to the API using `productCategories`, which returns a status URL.
2. **Poll for Results**: Use `fetchResults($statusUrl)` to poll until the job completes or fails.
3. **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

[](#controller-example)

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

```