README

AI Related Job Positions Generator for Laravel

🚀 Leverage AI API to identify related job positions for HR Tech and recruitment applications.

Check the details at SharpAPI's HR Tech API page.

Requirements

PHP >= 8.1
Laravel >= 9.0

Installation

Follow these steps to install and set up the SharpAPI Laravel Related Job Positions Generator package.

Install the package via composer:

composer require sharpapi/laravel-hr-related-job-positions

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-hr-related-job-positions

Key Features

AI-Powered Related Job Positions Generation: Efficiently identify job positions related to a given position with relevance scores.
Multi-language Support: Generate related job positions in multiple languages.
Customizable Output: Control the number of related job positions returned.
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 HrRelatedJobPositionsService class to access related job positions 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 a job position name to the API using relatedJobPositions, 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 HrRelatedJobPositionsService within a Laravel controller:

<?php

namespace App\Http\Controllers;

use GuzzleHttp\Exception\GuzzleException;
use SharpAPI\HrRelatedJobPositions\HrRelatedJobPositionsService;

class JobPositionsController extends Controller
{
    protected HrRelatedJobPositionsService $relatedJobPositionsService;

    public function __construct(HrRelatedJobPositionsService $relatedJobPositionsService)
    {
        $this->relatedJobPositionsService = $relatedJobPositionsService;
    }

    /**
     * @throws GuzzleException
     */
    public function getRelatedJobPositions(string $jobPositionName)
    {
        $statusUrl = $this->relatedJobPositionsService->relatedJobPositions(
            $jobPositionName,
            'English',   // optional language
            10   // optional maximum quantity
        );
        
        $result = $this->relatedJobPositionsService->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->relatedJobPositionsService->relatedJobPositions('PHP Developer', 'English', 10);
} 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

Related Job Positions Data Format Example

{
  "data": {
    "type": "api_job_result",
    "id": "80d0a822-0e2a-40e1-97fd-e7fd62ec9eb0",
    "attributes": {
      "status": "success",
      "type": "hr_related_job_positions",
      "result": {
        "job_position": "Flutter Mobile Developer",
        "related_job_positions": [
          {
            "name": "Android Developer",
            "weight": 8
          },
          {
            "name": "iOS Developer",
            "weight": 8.5
          },
          {
            "name": "MOBILE APP DEVELOPER",
            "weight": 9.5
          },
          {
            "name": "React Native Developer",
            "weight": 7.5
          },
          {
            "name": "Mobile-Entwickler für Flutter",
            "weight": 10
          },
          {
            "name": "Flutter-App-Entwickler",
            "weight": 9
          },
          {
            "name": "Mobile-App-Entwickler (Flutter)",
            "weight": 8
          },
          {
            "name": "Flutter-Entwickler",
            "weight": 10
          },
          {
            "name": "Cross-Platform Mobile Developer",
            "weight": 7
          },
          {
            "name": "Mobile-App-Entwickler",
            "weight": 9
          },
          {
            "name": "Mobile-Entwickler",
            "weight": 8
          },
          {
            "name": "App-Entwickler",
            "weight": 7
          },
          {
            "name": "iOS-Entwickler",
            "weight": 6
          },
          {
            "name": "Flutter Entwickler",
            "weight": 10
          },
          {
            "name": "Mobile App Entwickler",
            "weight": 9
          },
          {
            "name": "Android Entwickler",
            "weight": 8
          },
          {
            "name": "iOS Entwickler",
            "weight": 7.5
          }
        ]
      }
    }
  }
}

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-hr-related-job-positions

Maintainers

Details