{"id":36281655,"url":"https://github.com/sharpapi/laravel-hr-job-description","last_synced_at":"2026-02-21T12:02:37.307Z","repository":{"id":331821959,"uuid":"1131197931","full_name":"sharpapi/laravel-hr-job-description","owner":"sharpapi","description":"Laravel package for SharpAPI.com - laravel-hr-job-description","archived":false,"fork":false,"pushed_at":"2026-01-09T16:12:51.000Z","size":7,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-11T13:48:49.073Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sharpapi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-09T16:12:49.000Z","updated_at":"2026-01-09T16:12:55.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/sharpapi/laravel-hr-job-description","commit_stats":null,"previous_names":["sharpapi/laravel-hr-job-description"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/sharpapi/laravel-hr-job-description","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sharpapi%2Flaravel-hr-job-description","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sharpapi%2Flaravel-hr-job-description/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sharpapi%2Flaravel-hr-job-description/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sharpapi%2Flaravel-hr-job-description/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sharpapi","download_url":"https://codeload.github.com/sharpapi/laravel-hr-job-description/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sharpapi%2Flaravel-hr-job-description/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28405141,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-13T21:51:37.118Z","status":"ssl_error","status_checked_at":"2026-01-13T21:45:14.585Z","response_time":56,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-11T09:06:01.189Z","updated_at":"2026-01-13T23:05:22.352Z","avatar_url":"https://github.com/sharpapi.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"![SharpAPI GitHub cover](https://sharpapi.com/sharpapi-github-laravel-bg.jpg \"SharpAPI Laravel Client\")\n\n# AI Job Description Generator for Laravel\n\n## 🚀 Leverage AI API to streamline job description creation in your HR Tech applications.\n\n[![Latest Version on Packagist](https://img.shields.io/packagist/v/sharpapi/laravel-hr-job-description.svg?style=flat-square)](https://packagist.org/packages/sharpapi/laravel-hr-job-description)\n[![Total Downloads](https://img.shields.io/packagist/dt/sharpapi/laravel-hr-job-description.svg?style=flat-square)](https://packagist.org/packages/sharpapi/laravel-hr-job-description)\n\nCheck the details at SharpAPI's [Job Description Generator API](https://sharpapi.com/en/catalog/ai/hr-tech) page.\n\n---\n\n## Requirements\n\n- PHP \u003e= 8.1\n- Laravel \u003e= 9.0\n\n---\n\n## Installation\n\nFollow these steps to install and set up the SharpAPI Laravel Job Description Generator package.\n\n1. Install the package via `composer`:\n\n```bash\ncomposer require sharpapi/laravel-hr-job-description\n```\n\n2. Register at [SharpAPI.com](https://sharpapi.com/) to obtain your API key.\n\n3. Set the API key in your `.env` file:\n\n```bash\nSHARP_API_KEY=your_api_key_here\n```\n\n4. **[OPTIONAL]** Publish the configuration file:\n\n```bash\nphp artisan vendor:publish --tag=sharpapi-hr-job-description\n```\n\n---\n## Key Features\n\n- **AI-Powered Job Description Generation**: Efficiently create comprehensive job descriptions with customizable parameters.\n- **Customizable Output**: Control various aspects of the job description including required skills, experience, education, and more.\n- **Voice Tone Control**: Set your preferred writing style for the job description.\n- **Robust Polling for Results**: Polling-based API response handling with customizable intervals.\n- **API Availability and Quota Check**: Check API availability and current usage quotas with SharpAPI's endpoints.\n\n---\n\n## Usage\n\nYou can inject the `HrJobDescriptionService` class to access job description generation functionality. For best results, especially with batch processing, use Laravel's queuing system to optimize job dispatch and result polling.\n\n### Basic Workflow\n\n1. **Create Parameters**: Create a JobDescriptionParameters object with your job details.\n2. **Dispatch Job**: Send the parameters to the API using `generateJobDescription`, which returns a status URL.\n3. **Poll for Results**: Use `fetchResults($statusUrl)` to poll until the job completes or fails.\n4. **Process Result**: After completion, retrieve the results from the `SharpApiJob` object returned.\n\n\u003e **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.\n\n---\n\n### Controller Example\n\nHere is an example of how to use `HrJobDescriptionService` within a Laravel controller:\n\n```php\n\u003c?php\n\nnamespace App\\Http\\Controllers;\n\nuse GuzzleHttp\\Exception\\GuzzleException;\nuse SharpAPI\\HrJobDescription\\HrJobDescriptionService;\nuse SharpAPI\\HrJobDescription\\Dto\\JobDescriptionParameters;\n\nclass JobController extends Controller\n{\n    protected HrJobDescriptionService $jobDescriptionService;\n\n    public function __construct(HrJobDescriptionService $jobDescriptionService)\n    {\n        $this-\u003ejobDescriptionService = $jobDescriptionService;\n    }\n\n    /**\n     * @throws GuzzleException\n     */\n    public function generateJobDescription()\n    {\n        $jobDescriptionParameters = new JobDescriptionParameters(\n            name: \"PHP Senior Engineer\",\n            company_name: \"ACME LTD\",   // optional\n            minimum_work_experience: \"5 years\",   // optional\n            minimum_education: \"Bachelor Degree\",   // optional\n            employment_type: \"full time\",   // optional\n            required_skills: ['PHP8', 'Laravel'],   // optional\n            optional_skills: ['AWS', 'Redis'],   // optional\n            country: \"United Kingdom\",   // optional\n            remote: true,   // optional\n            visa_sponsored: true,   // optional\n            voice_tone: 'Professional and Geeky',   // optional voice tone\n            context: null,   // optional context, additional AI processing instructions\n            language: null   // optional output language\n        );\n        \n        $statusUrl = $this-\u003ejobDescriptionService-\u003egenerateJobDescription($jobDescriptionParameters);\n        $result = $this-\u003ejobDescriptionService-\u003efetchResults($statusUrl);\n\n        return response()-\u003ejson($result-\u003egetResultJson());\n    }\n}\n```\n\n### Handling Guzzle Exceptions\n\nAll requests are managed by Guzzle, so it's helpful to be familiar with [Guzzle Exceptions](https://docs.guzzlephp.org/en/stable/quickstart.html#exceptions).\n\nExample:\n\n```php\nuse GuzzleHttp\\Exception\\ClientException;\n\ntry {\n    $statusUrl = $this-\u003ejobDescriptionService-\u003egenerateJobDescription($jobDescriptionParameters);\n} catch (ClientException $e) {\n    echo $e-\u003egetMessage();\n}\n```\n\n---\n\n## Optional Configuration\n\nYou can customize the configuration by setting the following environment variables in your `.env` file:\n\n```bash\nSHARP_API_KEY=your_api_key_here\nSHARP_API_JOB_STATUS_POLLING_WAIT=180\nSHARP_API_JOB_STATUS_USE_POLLING_INTERVAL=true\nSHARP_API_JOB_STATUS_POLLING_INTERVAL=10\nSHARP_API_BASE_URL=https://sharpapi.com/api/v1\n```\n\n---\n\n## Job Description Data Format Example\n\n```json\n{\n  \"data\": {\n    \"type\": \"api_job_result\",\n    \"id\": \"081d6ba5-329d-4723-b88f-a8c88bc3a9cb\",\n    \"attributes\": {\n      \"status\": \"success\",\n      \"type\": \"hr_job_description\",\n      \"result\": {\n        \"job_requirements\": \"- Minimum of 5 years of experience in software engineering\\n- Bachelor's Degree in Computer Science or related field\\n- Proficiency in PHP8, Laravel, and MySQL\\n- Familiarity with AWS RDS, AWS Aurora, and GitFlow is a plus\\n- Strong problem-solving skills and attention to detail\\n- Excellent communication and teamwork abilities\\n- C-class driving license\",\n        \"job_responsibilities\": \"- Develop, test, and maintain high-quality PHP applications\\n- Collaborate with cross-functional teams to define and implement new features\\n- Optimize application performance and scalability\\n- Ensure code quality and maintainability through code reviews and best practices\\n- Troubleshoot and resolve software defects and issues\\n- Stay updated with the latest industry trends and technologies\\n- Mentor and guide junior developers\",\n        \"job_short_description\": \"We are seeking a highly skilled Senior PHP Software Engineer to join our remote team in the United Kingdom. This full-time position requires a minimum of 5 years of experience and a Bachelor's Degree. The ideal candidate will have expertise in PHP8, Laravel, and MySQL, with additional skills in AWS RDS, AWS Aurora, and GitFlow being advantageous. Visa sponsorship is available.\"\n      }\n    }\n  }\n}\n```\n\n---\n\n## Support \u0026 Feedback\n\nFor issues or suggestions, please:\n\n- [Open an issue on GitHub](https://github.com/sharpapi/laravel-hr-job-description/issues)\n- Join our [Telegram community](https://t.me/sharpapi_community)\n\n---\n\n## Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for a detailed list of changes.\n\n---\n\n## Credits\n\n- [A2Z WEB LTD](https://github.com/a2zwebltd)\n- [Dawid Makowski](https://github.com/makowskid)\n- Enhance your [Laravel AI](https://sharpapi.com/) capabilities!\n\n---\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n\n---\n\n## Follow Us\n\nStay updated with news, tutorials, and case studies:\n\n- [SharpAPI on X (Twitter)](https://x.com/SharpAPI)\n- [SharpAPI on YouTube](https://www.youtube.com/@SharpAPI)\n- [SharpAPI on Vimeo](https://vimeo.com/SharpAPI)\n- [SharpAPI on LinkedIn](https://www.linkedin.com/products/a2z-web-ltd-sharpapicom-automate-with-aipowered-api/)\n- [SharpAPI on Facebook](https://www.facebook.com/profile.php?id=61554115896974)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsharpapi%2Flaravel-hr-job-description","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsharpapi%2Flaravel-hr-job-description","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsharpapi%2Flaravel-hr-job-description/lists"}