pax_global_header00006660000000000000000000000064146000473740014517gustar00rootroot0000000000000052 comment=d9fcba1fc9819764bbf6205f0cf3d58a0d4c24c5 sharpapi-php-client-1.1.0/000077500000000000000000000000001460004737400153665ustar00rootroot00000000000000sharpapi-php-client-1.1.0/.gitignore000066400000000000000000000003421460004737400173550ustar00rootroot00000000000000/vendor/ node_modules/ npm-debug.log yarn-error.log storage/*.key .env Homestead.yaml Homestead.json /.vagrant .phpunit.result.cache .idea build composer.lock .phpunit.result.cache .php-cs-fixer.cache coverage phpstan.neon sharpapi-php-client-1.1.0/CHANGELOG.md000066400000000000000000000115211460004737400171770ustar00rootroot00000000000000# Changelog ## March 23, 2023 - v1.1.0 update ### 1. new methods added #### 1.2. Paraphrase text: `paraphrase()` Generates a paraphrased version of the provided text. [Check Documentation](https://documenter.getpostman.com/view/31106842/2s9Ye8faUp#aea28008-ac67-4245-a79b-26788bce3f44) #### 1.2 Proofread & Grammar Check: `proofread()` Proofreads (and checks grammar) of the provided text. [Check Documentation](https://documenter.getpostman.com/view/31106842/2s9Ye8faUp#dcb4a490-1243-4001-93fc-652c570dbcd7) #### 1.3 Subscription Info / Quota Check: `quota()` Endpoint to check details regarding the subscription's current period. ```json { "timestamp": "2024-03-19T12:49:41.445736Z", "on_trial": false, "trial_ends": "2024-03-17T07:57:46.000000Z", "subscribed": true, "current_subscription_start": "2024-03-18T12:37:39.000000Z", "current_subscription_end": "2024-04-18T12:37:39.000000Z", "subscription_words_quota": 100000, "subscription_words_used": 9608, "subscription_words_used_percentage": 0.1 } ``` * "subscription_words_used_percentage" is a percentage of current monthly quota usage * and might serve as an alert to the user of the depleted credits. * With a value above 80%, it's advised to subscribe to more credits * at https://sharpapi.com/dashboard/credits to avoid service disruption. [Check Documentation](https://documenter.getpostman.com/view/31106842/2s9Ye8faUp#7c401a21-8354-4589-a20a-573d1ae00d65) #### 1.4 Subscription Info / Quota Check: `ping()` Simple PING endpoint to check the availability of the API and it's internal timze zone (timestamp). ```json { "ping": "pong", "timestamp": "2024-03-12T08:50:11.188308Z" } ``` [Check Documentation](https://documenter.getpostman.com/view/31106842/2s9Ye8faUp#12a4aa9e-15cd-49a9-84ff-204ddc1116a3) ### 2. New Parameters added #### 2.1 `max_quantity` - allows to limit the amount of returned items **Added to methods:** - E-commerce > Product Categories / `productCategories()` - Travel, Tourism & Hospitality > Tours & Activities Product Categories / `toursAndActivitiesProductCategories()` - Travel, Tourism & Hospitality > Hospitality Product Categories / `hospitalityProductCategories()` - HR Tech > Related Job Positions / `relatedJobPositions()` - HR Tech > Related Skills / `relatedSkills()` #### 2.2 `max_length` - allows to instruct AI model to limit the output of generated text Please keep in mind that max_length serves as a strong suggestion for the Language Model, rather than a strict requirement, to maintain the general sense of the outcome. **Added to methods:** - E-commerce > Generate Product Intro / `generateProductIntro()` - E-commerce > Generate Thank You E-mail / `generateThankYouEmail()` - Content & Marketing Automation > Summarize Content / `summarizeText()` - Content & Marketing Automation > Paraphrase Text / `paraphrase()` #### 2.3 `voice_tone` - Tone of voice of the generated text You can set your preferred writing style by providing an optional voice_tone parameter. It can be adjectives like `funny` or `joyous`, or even the name of a famous writer. You can provide multiple tones at the same time. **Added to methods:** - SEO > Generate SEO Tags / `generateSeoTags()` - Content & Marketing Automation > Generate Keywords/Tags / `generateKeywords()` - Content & Marketing Automation > Summarize Content / `summarizeText()` - Content & Marketing Automation > Paraphrase Text / `paraphrase()` - Content & Marketing Automation > Translate Text / `translate()` - Travel, Tourism & Hospitality > Tours & Activities Product Categories / `toursAndActivitiesProductCategories()` - Travel, Tourism & Hospitality > Hospitality Product Categories / `hospitalityProductCategories()` - HR Tech > Generate Job Description / `generateJobDescription()` - E-commerce > Product Categories / `productCategories()` - E-commerce > Generate Product Intro / `generateProductIntro()` - E-commerce > Generate Thank You E-mail / `generateThankYouEmail()` #### 2.4 `context` - adds more context/instructions for content processing **Added to methods:** - HR Tech > Generate Job Description / `generateJobDescription()` - E-commerce > Generate Thank You E-mail / `generateThankYouEmail()` - E-commerce > Product Categories / `productCategories()` - Travel, Tourism & Hospitality > Tours & Activities Product Categories / `toursAndActivitiesProductCategories()` - Travel, Tourism & Hospitality > Hospitality Product Categories / `hospitalityProductCategories()` - Content & Marketing Automation > Translate Text / `translate()` - Content & Marketing Automation > Paraphrase Text / `paraphrase()` ### 3.0 Added ENV variable to set custom User-Agent for Affiliate Program members. Now you can set this inside `.env` file of your app: ```bash SHARP_API_USER_AGENT="SharpAPIPHPAgent/1.1.0" ``` More info at https://sharpapi.com/affiliate_program ## December 10, 2023 - v1.0.2 - v1.0.2 initial releasesharpapi-php-client-1.1.0/LICENSE000066400000000000000000000020551460004737400163750ustar00rootroot00000000000000MIT License Copyright (c) 2023 SharpAPI.com Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. sharpapi-php-client-1.1.0/LICENSE.md000066400000000000000000000021051460004737400167700ustar00rootroot00000000000000The MIT License (MIT) Copyright (c) SharpAPI Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. sharpapi-php-client-1.1.0/README.md000066400000000000000000000560711460004737400166560ustar00rootroot00000000000000![SharpAPI GitHub cover](https://sharpapi.com/sharpapi-github-php-bg.jpg "SharpAPI Laravel Client") # SharpAPI PHP Client - #AI Programming Interface ### πŸš€ AI-Powered Swiss Army Knife API ## Save countless hours and supercharge your app with AI capabilities in just 2 lines of code. [![Latest Version on Packagist](https://img.shields.io/packagist/v/sharpapi/sharpapi-php-client.svg?style=flat-square)](https://packagist.org/packages/sharpapi/sharpapi-php-client) [![Total Downloads](https://img.shields.io/packagist/dt/sharpapi/sharpapi-php-client.svg?style=flat-square)](https://packagist.org/packages/sharpapi/sharpapi-php-client) #### Save time on repetitive content analysis and generation tasks that your app users perform daily. See more at [SharpAPI.com Website »](https://sharpapi.com/) ## [If you're looking for a Laravel version - check here »](https://github.com/sharpapi/laravel-client) ## Requirements - PHP >= 8.1 ## β›² What can it do for you? * πŸ›’ **E-commerce** - Quickly generate engaging product introductions to attract customers. - Automatically create personalized thank-you emails for enhanced customer experience. - Streamline product categorization for a well-organized catalog. - Sentiment Analysis: Understand and analyze sentiment in product reviews for data-driven decision-making. * πŸ“οΈ **Content & Marketing Automation** - Easily translate text for a global audience. - Paraphrase and proofread any text (including grammar check) - Spam Content Detection: Identify and filter out spam content effectively. - Contact Information Extraction: Extract phone numbers and email addresses from non-standard formats for streamlined communication. - Generate concise summaries and unique keywords/tags for improved content consumption. - Boost SEO efforts by automatically generating META tags based on content. * β€πŸ’» **HR Tech** - Generate complex job descriptions effortlessly, saving time in the hiring process. - Skills and Position Insights: Identify related job positions and skills to streamline recruitment. - Automated Resume Parsing: Efficiently parse and extract information from resumes files for easy processing. * ✈️ **Travel, Tourism & Hospitality** - Analyze sentiment in travel reviews to improve services. - Streamline categorization for tours, activities, and hospitality products. ## Features Please refer to the official: - [API Documentation](https://sharpapi.com/documentation) - **Multi-language Support**: Supporting 80 languages for every content or data analysis API endpoint. [Check the list here](https://botpress.com/blog/list-of-languages-supported-by-chatgpt). - **Easy-to-Use RESTful Format**: With standardized set of endpoints - gain valuable insights through analysis endpoints, covering product categories, skills, and job positions, providing relevant scores. - **Always the same, clean data formats**: Rest assured with consistent, predictable JSON format for all returned data. No need to worry about fuzzy AI data. - **Tech Support**: Crafted by developers for developers, we provide continuous assistance throughout your journey. ## Installation 1. You can install the package via composer: ```bash composer require sharpapi/sharpapi-php-client ``` 2. Register at [SharpApi.com](https://sharpapi.com/) and get the API key. 3. **That's it!** ## Usage ### Simple example ```php $sharpApi = new \SharpAPI\SharpApiService\SharpApiService(SHARP_API_KEY); $statusUrl = $sharpApi->productCategories( 'Lenovo Chromebook Laptop (2023), 14" FHD Touchscreen Slim 3, 8-Core MediaTek Kompanio 520 CPU, 4GB RAM, 128GB Storage', 'German', // optional language 400, // optional quantity 'optional neutral voice tone', // optional voice tone 'optional current e-store categories' // optional context, current categories to match ); $resultSharpApiJob = $sharpApi->fetchResults($statusUrl); var_dump($resultSharpApiJob->getResultJson()); ``` Typical use case require these steps: 1. Dispatch one of the available AI processing methods (this will return job processing status URL) 2. Run `fetchResults($statusUrl)` method which operates in polling mode, sending underneath requests every 10 seconds for 180 seconds (these values can be customized, check `SharpApiService` source code). 3. `SharpApiJob` object will be returned. 4. For a job finished with `success` return status you can obtain the results with one of the methods, for example `$jobResultJson = $jobResult->getResultJson()`. **Each dispatched job usually takes somewhere between a couple of seconds to a minute.** After that period a returned job will usually have `success` status and it's results will be available for further processing. Each API method returns different return format. [Go to List of API methods/endpoints below for details»](#list-of-api-methodsendpoints) **Our API guarantees to return correct format every time.** AI engines that SharpAPI use in rare cases have a tendency to misbehave and timeout or return incorrect data. In those cases the returned `status` for the job will be `failed`. You can rerun the exact same job request in that case. As long as the job is still being processed by our engine it will keep returning `pending` status. ### Guzzle Exceptions Underlying HTTP requests are powered with Guzzle, so it's a good idea to check for typical [Guzzle Exceptions](https://docs.guzzlephp.org/en/stable/quickstart.html#exceptions): ```php use GuzzleHttp\Exception\ClientException; // Step 1: dispatch the job to the API with one of the methods, for example: try { $statusUrl = \SharpApiService::summarizeText( $text, 'German' // optional language 500, // optional length 'neutral' // optional voice tone ); // $statusUrl example value: 'https://sharpapi.com/api/v1/job/status/75acb6dc-a975-4969-9ef1-c62cebc511cb' } catch (ClientException $e) { $e->getResponse() } // Step 2: request to check job status in polling mode and wait for the result $jobResult = \SharpApiService::fetchResults($statusUrl); // Step 3: get results of dispatched API job, f.e. this returns job result as a prettied JSON $jobResultJson = $jobResult->getResultJson(); // ..or PHP array: $jobResultArray = $jobResult->getResultArray(); // ..or PHP stdClass: $jobResultObject = $jobResult->getResultObject(); ``` ### Framework Controller usage example ```php sharpApiService->detectPhones( 'Where to find us? Call with a sales tech advisor: Call: 1800-394-7486 or our Singapore office +65 8888 8888' ); $result = $this->sharpApiService->fetchResults($statusUrl); dd($result->getResultJson()); /* returned: [ { "detected_number": "1800-394-7486", "parsed_number": "+18003947486" }, { "detected_number": "+65 8888 8888", "parsed_number": "+6588888888" } ] */ } } ``` ## πŸ“‹ List of API methods/endpoints Each method always returns `SharpApiJob` object, where its `getResultJson / getResultArray / getResultObject` methods will return different data structure. Please refer to the detailed examples provided at [SharpAPI.com](https://sharpapi.com/). For methods that have language parameter you can also use `SharpApiLanguages` Enum values to make your code more readable. --- ### πŸ§‘β€πŸ’» HR #### ⭐ Parse Resume/CV File Parses a resume (CV) file from multiple formats (PDF/DOC/DOCX/TXT/RTF) and returns an extensive object of data points. An optional output language parameter can also be provided (`English` value is set as the default one) . ```php $statusUrl = \SharpApiService::parseResume('/test/resume.pdf', 'English'); ``` #### ⭐ Generate Job Description Based on the list of extensive parameters this endpoint provides concise job details in the response format, including the short description, job requirements, and job responsibilities. The only mandatory parameter is `name`. This functionality utilizes a specialized `DTO` class (`Data Transfer Object`) parameter named `JobDescriptionParameters` to aid in the validation of input parameters. Only the `name` parameter in the constructor of this `DTO` is mandatory. You can set your preferred writing style by providing a voice_tone parameter. It can be adjectives like `funny` or `joyous`, or even the name of a famous writer. This API method also provides an optional context parameter, which can be used to supply additional flexible instructions for content processing. ```php $jobDescriptionParameters = new JobDescriptionParameters( name: "PHP Senior Engineer", company_name: "ACME LTD", // optional minimum_work_experience: "5 years", // optional minimum_education: "Bachelor Degree", // optional employment_type: "full time", // optional required_skills: ['PHP8', 'Laravel'], // optional optional_skills: ['AWS', 'Redis'], // optional country: "United Kingdom", // optional remote: true, // optional visa_sponsored: true, // optional voice_tone: 'Professional and Geeky', // optional voice tone context: null, // optional context, additional AI processing instructions language: null // optional output language ); $statusUrl = \SharpApiService::generateJobDescription($jobDescriptionParameters); ``` #### ⭐ Related Skills Generates a list of related skills with their weights as a float value (1.0-10.0) where 10 equals 100%, the highest relevance score. Only first parameter (`name`) is required. You can limit the output with the `max_quantity` parameter. ```php $statusUrl = \SharpApiService::relatedSkills( 'MySQL', 'English', // optional language 10 // optional quantity ); ``` #### ⭐ Related Job Positions Generates a list of related job positions with their weights as float value (1.0-10.0) where 10 equals 100%, the highest relevance score. Only first parameter (`name`) is required. You can limit the output with the `max_quantity` parameter. ```php $statusUrl = \SharpApiService::relatedJobPositions( 'Senior PHP Engineer', 'English', // optional language 10 // optional quantity ); ``` --- ### πŸ›’ E-commerce #### ⭐ Product Review Sentiment Parses the customer's product review and provides its sentiment (POSITIVE/NEGATIVE/NEUTRAL) with a score between 0-100%. Great for sentiment report processing for any online store. ```php $statusUrl = \SharpApiService::productReviewSentiment('customer review contents'); ``` #### ⭐ Product Categories Generates a list of suitable categories for the product with relevance weights as a float value (1.0-10.0) where 10 equals 100%, the highest relevance score. Provide the product name and its parameters to get the best category matches possible. Comes in handy with populating product catalogue data and bulk products' processing. You can limit the output with the `max_quantity` parameter. You can set your preferred writing style by providing a `voice_tone` parameter. It can be adjectives like `funny` or `joyous`, or even the name of a famous writer. Within an additional optional parameter context, you can provide a list of other categories that will be taken into consideration during the mapping process (for example your current e-commerce categories). ```php $statusUrl = \SharpApiService::productCategories( 'Sony Playstation 5', 'English', // optional language 5, // optional quantity 'Tech-savvy', // optional voice tone 'Game Console, PS5 Console' // optional context, current categories to match ); ``` #### ⭐ Generate Product Intro Generates a shorter version of the product description. Provide as many details and parameters of the product to get the best marketing introduction possible. Comes in handy with populating product catalog data and bulk products processing. You can limit the output with the `max_length` parameter. Please keep in mind that `max_length` serves as a strong suggestion for the Language Model, rather than a strict requirement, to maintain the general sense of the outcome. You can set your preferred writing style by providing a `voice_tone` parameter. It can be adjectives like `funny` or `joyous`, or even the name of a famous writer. ```php $statusUrl = \SharpApiService::generateProductIntro( 'Sony Playstation 5', SharpApiLanguages::ENGLISH, // optional language 300, // optional length 'Funny' // optional voice tone ); ``` #### ⭐ Generate Thank You E-mail Generates a personalized thank-you email to the customer after the purchase. The response content does not contain the title, greeting or sender info at the end, so you can personalize the rest of the email easily. You can limit the output with the max_length parameter. Please keep in mind that `max_length` serves as a strong suggestion for the Language Model, rather than a strict requirement, to maintain the general sense of the outcome. You can set your preferred writing style by providing a `voice_tone` parameter. It can be adjectives like funny or joyous, or even the name of a famous writer. This API method also provides an optional context parameter, which can be used to supply additional flexible instructions for content processing. ```php $statusUrl = \SharpApiService::generateThankYouEmail( 'Sony Playstation 5', SharpApiLanguages::ENGLISH, // optional language 250, // optional length 'Neutral', // optional voice tone 'Must invite customer to visit again before Holidays' // optional context ); ``` --- ### πŸ“οΈ Content #### ⭐ Translate Text Translates provided text to selected language. 80 languages are supported. Please check included `SharpApiLanguages` _Enum_ class for details. You can set your preferred writing style by providing a `voice_tone` parameter. It can be adjectives like funny or joyous, or even the name of a famous writer. An optional `context` parameter is also available. It can be used to provide more context to the translated text, like the use case example or some additional explanations. ```php $statusUrl = \SharpApiService::translate( 'turn', SharpApiLanguages::FRENCH, // optional language 'neutral', // optional voice tone 'to turn a page' // optional context ); // will result in : // {"content": "tourner", "to_language": "French", "from_language": "English"} ``` #### ⭐ Paraphrase / Rephrase Generates a paraphrased version of the provided text. Only the `content` parameter is required. You can define the output language, maximum character length, and tone of voice. Additional instructions on how to process the text can be provided in the context parameter. Please keep in mind that `max_length` serves as a strong suggestion for the Language Model, rather than a strict requirement, to maintain the general sense of the outcome. You can set your preferred writing style by providing an optional `voice_tone` parameter. It can be adjectives like `funny` or `joyous`, or even the name of a famous writer. This API method also provides an optional `context` parameter, which can be used to supply additional flexible instructions for content processing. ```php $statusUrl = \SharpApiService::paraphrase( $text, SharpApiLanguages::FRENCH, // optional language 500, // optional length 'neutral', // optional voice tone 'avoid using abbreviations' // optional context ); ``` #### ⭐ Proofread Text + Grammar Check Proofreads (and checks grammar) a provided text. ```php $statusUrl = \SharpApiService::proofread($text); ``` #### ⭐ Detect Spam Checks if provided content passes a spam filtration test. Provides a percentage confidence score and an explanation for whether it is considered spam or not. This information is useful for moderators to make a final decision. ```php $statusUrl = \SharpApiService::detectSpam($text); ``` #### ⭐ Detect Phones Numbers Parses the provided text for any phone numbers and returns the original detected version and its E.164 format. Might come in handy in the case of processing and validating big chunks of data against phone numbers or f.e. if you want to detect phone numbers in places where they're not supposed to be. ```php $statusUrl = \SharpApiService::detectPhones($text); ``` #### ⭐ Detect Emails Parses the provided text for any possible emails. Might come in handy in case of processing and validating big chunks of data against email addresses or f.e. if you want to detect emails in places where they're not supposed to be. ```php $statusUrl = \SharpApiService::detectEmails($text); ``` #### ⭐ Generate Keywords/Tags Generates a list of unique keywords/tags based on the provided content. You can limit the output with the `max_quantity` parameter. You can set your preferred writing style by providing a `voice_tone` parameter. ```php $statusUrl = \SharpApiService::generateKeywords( $text, 'English', // optional language 5, // optional length 'Freaky & Curious' // optional voice tone ); ``` #### ⭐ Summarize Text Generates a summarized version of the provided content. Perfect for generating marketing introductions of longer texts. You can limit the output with the `max_length` parameter. Please keep in mind that `max_length` serves as a strong suggestion for the Language Model, rather than a strict requirement, to maintain the general sense of the outcome. You can set your preferred writing style by providing a `voice_ton`e parameter. It can be adjectives like `funny` or `joyous`, or even the name of a famous writer. ```php $statusUrl = \SharpApiService::summarizeText( $text, 'English', // optional language 'David Attenborough' // optional voice tone ); ``` --- ### πŸ—’ SEO #### ⭐ Generate SEO Tags Generates all most important META tags based on the content provided. Make sure to include link to the website and pictures URL to get as many tags populated as possible. You can set your preferred writing style by providing a `voice_ton`e parameter. It can be adjectives like `funny` or `joyous`, or even the name of a famous writer. ```php $statusUrl = \SharpApiService::generateSeoTags( $text, 'English', // optional language 'David Attenborough' // optional voice tone ); ``` --- ### ✈️ Travel, Tourism & Hospitality #### ⭐ Travel Review Sentiment Parses the Travel/Hospitality product review and provides its sentiment (POSITIVE/NEGATIVE/NEUTRAL) with a score between 0-100%. Great for sentiment report processing for any online store. ```php $statusUrl = \SharpApiService::travelReviewSentiment($text); ``` #### ⭐ Tours & Activities Product Categories Generates a list of suitable categories for the Tours & Activities product with relevance weights as float value (1.0-10.0) where 10 equals 100%, the highest relevance score. Provide the product name and its parameters to get the best category matches possible. Comes in handy with populating product catalogue data and bulk product processing. Only first parameter `productName` is required. You can limit the output with the `max_quantity` parameter. You can set your preferred writing style by providing a `voice_tone` parameter. It can be adjectives like `funny` or `joyous`, or even the name of a famous writer. Within an additional optional parameter `context`, you can provide a list of other categories that will be taken into consideration during the mapping process (for example your current e-commerce categories). ```php $statusUrl = \SharpApiService::toursAndActivitiesProductCategories( 'Oasis of the Bay' 'Ha Long', // optional city 'Vietnam', // optional country 'English', // optional language 10, // optional quantity 'Adventurous', // optional voice tone 'Bay Hotels, Ha Long Hotels' // optional context, current categories to match ); ``` #### ⭐ Hospitality Product Categories Generates a list of suitable categories for the Hospitality type product with relevance weights as float value (1.0-10.0) where 10 equals 100%, the highest relevance score. Provide the product name and its parameters to get the best category matches possible. Comes in handy with populating products catalogs data and bulk products' processing. Only first parameter `productName` is required. You can limit the output with the `max_quantity` parameter. You can set your preferred writing style by providing a `voice_tone` parameter. It can be adjectives like `funny` or `joyous`, or even the name of a famous writer. Within an additional optional parameter `context`, you can provide a list of other categories that will be taken into consideration during the mapping process (for example your current e-commerce categories). ```php $statusUrl = \SharpApiService::hospitalityProductCategories( 'Hotel Crystal 倧人専用' 'Tokyo', // optional city 'Japan', // optional country 'English', // optional language 10, // optional quantity 'Adventurous', // optional voice tone 'Tokyo Hotels, Crystal Hotels' // optional context, current categories to match ); ``` --- ### πŸ€– Technical API Endpoints #### ⭐ Subscription information / quota check Endpoint to check details regarding the subscription's current period ```php $statusUrl = \SharpApiService::quota(); ``` will result in: ```json { "timestamp": "2024-03-19T12:49:41.445736Z", "on_trial": false, "trial_ends": "2024-03-17T07:57:46.000000Z", "subscribed": true, "current_subscription_start": "2024-03-18T12:37:39.000000Z", "current_subscription_end": "2024-04-18T12:37:39.000000Z", "subscription_words_quota": 100000, "subscription_words_used": 9608, "subscription_words_used_percentage": 0.1 } ``` `subscription_words_used_percentage` is a percentage of current monthly quota usage and might serve as an alert to the user of the depleted credits. With a value above 80%, it's advised to subscribe to more credits at https://sharpapi.com/dashboard/credits to avoid service disruption. These values are also available in the Dashboard at https://sharpapi.com/dashboard #### ⭐ Ping Simple PING endpoint to check the availability of the API and it's internal timze zone (timestamp). ```php $statusUrl = \SharpApiService::ping(); ``` will result in: ```json { "ping": "pong", "timestamp": "2024-03-12T08:50:11.188308Z" } ``` --- ### Do you think our API is missing some obvious functionality? [Please let us knowΒ»](https://github.com/sharpapi/sharpapi-php-client/issues) ## Changelog Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. ## Credits - [A2Z WEB LTD](https://github.com/a2zwebltd) - [Dawid Makowski](https://github.com/makowskid) ## License The MIT License (MIT). Please see [License File](LICENSE.md) for more information. sharpapi-php-client-1.1.0/composer.json000066400000000000000000000026571460004737400201220ustar00rootroot00000000000000{ "name": "sharpapi/sharpapi-php-client", "description": "SharpAPI.com - AI-Powered Swiss Army Knife API. Save countless coding hours and supercharge your app with AI capabilities in just 2 lines of code.", "keywords": [ "sharpapi", "ai-powered", "ai capabilities", "api", "ai api", "api integration", "artificial intelligence", "natural language processing", "restful api", "php", "software development", "content generation", "content analysis", "e-commerce", "hr tech", "travel", "tourism", "hospitality", "marketing automation", "api integration" ], "homepage": "https://github.com/sharpapi/sharpapi-php-client", "license": "MIT", "authors": [ { "name": "Dawid Makowski", "email": "contact@sharpapi.com", "role": "Developer" } ], "require": { "php": "^8.1", "guzzlehttp/guzzle": "^7.8", "kongulov/interact-with-enum": "^1.0", "nesbot/carbon": "^3.0" }, "autoload": { "psr-4": { "SharpAPI\\SharpApiService\\": "src/" } }, "autoload-dev": { "psr-4": { "SharpAPI\\SharpApiService\\Tests\\": "tests/" } }, "scripts": { "post-autoload-dump": "", "build": [ ], "start": [ "Composer\\Config::disableProcessTimeout", "@composer run build" ] }, "config": { "sort-packages": true }, "minimum-stability": "dev", "prefer-stable": true } sharpapi-php-client-1.1.0/src/000077500000000000000000000000001460004737400161555ustar00rootroot00000000000000sharpapi-php-client-1.1.0/src/Dto/000077500000000000000000000000001460004737400167035ustar00rootroot00000000000000sharpapi-php-client-1.1.0/src/Dto/JobDescriptionParameters.php000066400000000000000000000026021460004737400243560ustar00rootroot00000000000000 $this->name, 'company_name' => $this->company_name, 'minimum_work_experience' => $this->minimum_work_experience, 'employment_type' => $this->employment_type, 'required_skills' => $this->required_skills, 'optional_skills' => $this->optional_skills, 'country' => $this->country, 'remote' => $this->remote, 'visa_sponsored' => $this->visa_sponsored, 'voice_tone' => $this->voice_tone, 'context' => $this->context, 'language' => $this->language, ]; } } sharpapi-php-client-1.1.0/src/Dto/SharpApiJob.php000066400000000000000000000036041460004737400215610ustar00rootroot00000000000000 $this->id, 'type' => $this->type, 'status' => $this->status, 'result' => $this->result, ]; } /** * Returns SharpAPI job ID (UUID format) * * @api */ public function getId(): string { return $this->id; } /** * Returns one of the job types available in SharpApiJobTypeEnum * * @api */ public function getType(): SharpApiJobTypeEnum { return SharpApiJobTypeEnum::from($this->type); } /** * Returns one of the job statuses available in SharpApiJobStatusEnum * * @api */ public function getStatus(): SharpApiJobStatusEnum { return SharpApiJobStatusEnum::from($this->status); } /** * Returns job result as a prettied JSON * * @api */ public function getResultJson(): string|bool|null { return $this->result ? json_encode(json_decode($this->result), JSON_PRETTY_PRINT) : null; } /** * Returns job result contents as PHP associative array * * @api */ public function getResultArray(): ?array { return $this->result ? json_decode($this->result, true) : null; } /** * Returns job result contents as PHP stdClass object * * @api */ public function getResultObject(): ?stdClass { return $this->result ? json_decode($this->result) : null; } } sharpapi-php-client-1.1.0/src/Dto/SharpApiSubscriptionInfo.php000066400000000000000000000043121460004737400243440ustar00rootroot00000000000000 $this->timestamp, 'on_trial' => $this->on_trial, 'trial_ends' => $this->trial_ends, 'subscribed' => $this->subscribed, 'current_subscription_start' => $this->current_subscription_start, 'current_subscription_end' => $this->current_subscription_end, 'subscription_words_quota' => $this->subscription_words_quota, 'subscription_words_used' => $this->subscription_words_used, 'subscription_words_used_percentage' => $this->subscription_words_used_percentage, ]; } } sharpapi-php-client-1.1.0/src/Enums/000077500000000000000000000000001460004737400172445ustar00rootroot00000000000000sharpapi-php-client-1.1.0/src/Enums/SharpApiJobStatusEnum.php000066400000000000000000000014001460004737400241430ustar00rootroot00000000000000 'New', self::PENDING => 'Pending', self::FAILED => 'Failed', self::SUCCESS => 'Success', }; } public function color(): string { return match ($this) { self::NEW => 'gray', self::PENDING => 'yellow', self::FAILED => 'red', self::SUCCESS => 'green', }; } } sharpapi-php-client-1.1.0/src/Enums/SharpApiJobTypeEnum.php000066400000000000000000000123131460004737400236060ustar00rootroot00000000000000 '/ecommerce/review_sentiment', self::ECOMMERCE_PRODUCT_CATEGORIES => '/ecommerce/product_categories', self::ECOMMERCE_PRODUCT_INTRO => '/ecommerce/product_intro', self::ECOMMERCE_THANK_YOU_EMAIL => '/ecommerce/thank_you_email', self::HR_PARSE_RESUME => '/hr/parse_resume', self::HR_JOB_DESCRIPTION => '/hr/job_description', self::HR_RELATED_SKILLS => '/hr/related_skills', self::HR_RELATED_JOB_POSITIONS => '/hr/related_job_positions', self::TTH_REVIEW_SENTIMENT => '/tth/review_sentiment', self::TTH_TA_PRODUCT_CATEGORIES => '/tth/ta_product_categories', self::TTH_HOSPITALITY_PRODUCT_CATEGORIES => '/tth/hospitality_product_categories', self::CONTENT_DETECT_PHONES => '/content/detect_phones', self::CONTENT_DETECT_EMAILS => '/content/detect_emails', self::CONTENT_DETECT_SPAM => '/content/detect_spam', self::CONTENT_SUMMARIZE => '/content/summarize', self::CONTENT_KEYWORDS => '/content/keywords', self::CONTENT_TRANSLATE => '/content/translate', self::CONTENT_PARAPHRASE => '/content/paraphrase', self::CONTENT_PROOFREAD => '/content/proofread', self::SEO_GENERATE_TAGS => '/seo/generate_tags', }; } public function label(): string { return match ($this) { self::ECOMMERCE_REVIEW_SENTIMENT => 'Product Review Sentiment', self::ECOMMERCE_PRODUCT_CATEGORIES => 'Product Categories', self::ECOMMERCE_PRODUCT_INTRO => 'Generate Product Intro', self::ECOMMERCE_THANK_YOU_EMAIL => 'Generate Thank You E-mail', self::HR_PARSE_RESUME => 'Parse Resume/CV File', self::HR_JOB_DESCRIPTION => 'Generate Job Description', self::HR_RELATED_SKILLS => 'Related Skills', self::HR_RELATED_JOB_POSITIONS => 'Related Job Positions', self::TTH_REVIEW_SENTIMENT => 'Travel Review Sentiment', self::TTH_TA_PRODUCT_CATEGORIES => 'Tours & Activities Product Categories', self::TTH_HOSPITALITY_PRODUCT_CATEGORIES => 'Hospitality Product Categories', self::CONTENT_DETECT_PHONES => 'Detect Phone Numbers', self::CONTENT_DETECT_EMAILS => 'Detect Emails', self::CONTENT_DETECT_SPAM => 'Detect Spam', self::CONTENT_SUMMARIZE => 'Summarize Content', self::CONTENT_KEYWORDS => 'Generate Keywords/Tags', self::CONTENT_TRANSLATE => 'Translate Text', self::CONTENT_PARAPHRASE => 'Paraphrase Text', self::CONTENT_PROOFREAD => 'Proofread & Grammar check', self::SEO_GENERATE_TAGS => 'Generate SEO Tags', }; } public function category(): string { return match ($this) { self::ECOMMERCE_REVIEW_SENTIMENT, self::ECOMMERCE_PRODUCT_CATEGORIES, self::ECOMMERCE_THANK_YOU_EMAIL, self::ECOMMERCE_PRODUCT_INTRO => 'E-commerce', self::HR_PARSE_RESUME, self::HR_JOB_DESCRIPTION, self::HR_RELATED_SKILLS, self::HR_RELATED_JOB_POSITIONS => 'HR Tech', self::TTH_REVIEW_SENTIMENT, self::TTH_TA_PRODUCT_CATEGORIES, self::TTH_HOSPITALITY_PRODUCT_CATEGORIES => 'Travel, Tourism & Hospitality', self::CONTENT_DETECT_PHONES, self::CONTENT_DETECT_EMAILS, self::CONTENT_DETECT_SPAM, self::CONTENT_TRANSLATE, self::CONTENT_PARAPHRASE, self::CONTENT_PROOFREAD, self::CONTENT_KEYWORDS, self::CONTENT_SUMMARIZE => 'Content', self::SEO_GENERATE_TAGS => 'SEO', }; } } sharpapi-php-client-1.1.0/src/Enums/SharpApiLanguages.php000066400000000000000000000064311460004737400233170ustar00rootroot00000000000000setApiKey($apiKey); if (empty($this->apiKey)) { throw new InvalidArgumentException('API key is required.'); } $this->setApiBaseUrl($apiBaseUrl ?? 'https://sharpapi.com/api/v1'); $this->setUserAgent($userAgent ?? 'SharpAPIPHPAgent/1.1.0'); } /** * Fetch the main API URL * @return string */ public function getApiBaseUrl(): string { return $this->apiBaseUrl; } /** * Might come in handy if case some API mocking is needed * @param string $apiBaseUrl * @return void */ public function setApiBaseUrl(string $apiBaseUrl): void { $this->apiBaseUrl = $apiBaseUrl; } public function getApiKey(): string { return $this->apiKey; } public function setApiKey(string $apiKey): void { $this->apiKey = $apiKey; } public function getUserAgent(): string { return $this->userAgent; } /** * Handy method to set custom User-Agent header for Affiliate Program members. * * More at: https://sharpapi.com/affiliate_program */ public function setUserAgent(string $userAgent): void { $this->userAgent = $userAgent; } public function getApiJobStatusPollingInterval(): int { return $this->apiJobStatusPollingInterval; } /** * @param int $apiJobStatusPollingInterval * @return void * @api */ public function setApiJobStatusPollingInterval(int $apiJobStatusPollingInterval): void { $this->apiJobStatusPollingInterval = $apiJobStatusPollingInterval; } public function isUseCustomInterval(): bool { return $this->useCustomInterval; } /** * @param bool $useCustomInterval * @return void * @api */ public function setUseCustomInterval(bool $useCustomInterval): void { $this->useCustomInterval = $useCustomInterval; } public function getApiJobStatusPollingWait(): int { return $this->apiJobStatusPollingWait; } /** * @param int $apiJobStatusPollingWait * @return void * @api */ public function setApiJobStatusPollingWait(int $apiJobStatusPollingWait): void { $this->apiJobStatusPollingWait = $apiJobStatusPollingWait; } /** * Generic request method to run Guzzle client * * @throws GuzzleException */ private function makeRequest( string $method, string $url, array $data = [], string $filePath = null ): ResponseInterface { $client = new Client(); $options = [ 'headers' => $this->getHeaders(), ]; if ($method === 'POST') { if (is_string($filePath) && strlen($filePath)) { $options['multipart'][] = [ 'name' => 'file', 'contents' => file_get_contents($filePath), 'filename' => basename($filePath), ]; } else { $options['json'] = $data; } } return $client->request($method, $this->getApiBaseUrl() . $url, $options); } private function parseStatusUrl(ResponseInterface $response) { return json_decode($response->getBody()->__toString(), true)['status_url']; } /** * Generic method to check job status in polling mode and then fetch results of the dispatched job * * @throws ClientException|GuzzleException * * @api */ public function fetchResults(string $statusUrl): SharpApiJob { $client = new Client(); $waitingTime = 0; do { $response = $client->request( 'GET', $statusUrl, ['headers' => $this->getHeaders()] ); $jobStatus = json_decode($response->getBody()->__toString(), true)['data']['attributes']; if ( $jobStatus['status'] === SharpApiJobStatusEnum::SUCCESS->value || $jobStatus['status'] === SharpApiJobStatusEnum::FAILED->value ) { break; } // it's still `pending` status, let's wait a bit more $retryAfter = isset($response->getHeader('Retry-After')[0]) ? (int)$response->getHeader('Retry-After')[0] : $this->getApiJobStatusPollingInterval(); // fallback if no Retry-After header if ($this->isUseCustomInterval()) { // let's force to use the value from config $retryAfter = $this->getApiJobStatusPollingInterval(); } $waitingTime = $waitingTime + $retryAfter; if ($waitingTime >= $this->getApiJobStatusPollingWait()) { break; } // otherwise wait a bit more and try again sleep($retryAfter); } while (true); $data = json_decode($response->getBody()->__toString(), true)['data']; return new SharpApiJob( id: $data['id'], type: $data['attributes']['type'], status: $data['attributes']['status'], result: $data['attributes']['result'] ?? null ); } /** * Prepare shared headers * * @return string[] */ private function getHeaders(): array { return [ 'Authorization' => 'Bearer ' . $this->getApiKey(), 'Accept' => 'application/json', 'User-Agent' => $this->getUserAgent() ]; } /** * Simple PING endpoint to check the availability of the API and its internal time zone (timestamp). * { * "ping": "pong", * "timestamp": "2024-03-12T08:50:11.188308Z" * } * * @throws GuzzleException * * @api */ public function ping(): ?array { $response = $this->makeRequest('GET', '/ping'); return json_decode($response->getBody()->__toString(), true); } /** * Endpoint to check details regarding the subscription's current period * * "subscription_words_used_percentage" is a percentage of current monthly quota usage * and might serve as an alert to the user of the depleted credits. * With a value above 80%, it's advised to subscribe to more credits * at https://sharpapi.com/dashboard/credits to avoid service disruption. * * These values are also available in the Dashboard at https://sharpapi.com/dashboard * * @throws GuzzleException * * @api */ public function quota(): ?SharpApiSubscriptionInfo { $response = $this->makeRequest('GET', '/quota'); $info = json_decode($response->getBody()->__toString(), true); if (!array_key_exists('timestamp', $info)) { return null; } return new SharpApiSubscriptionInfo( timestamp: new Carbon($info['timestamp']), on_trial: $info['on_trial'], trial_ends: new Carbon($info['trial_ends']), subscribed: $info['subscribed'], current_subscription_start: new Carbon($info['current_subscription_start']), current_subscription_end: new Carbon($info['current_subscription_end']), subscription_words_quota: $info['subscription_words_quota'], subscription_words_used: $info['subscription_words_used'], subscription_words_used_percentage: $info['subscription_words_used_percentage'] ); } /** * Parses a resume (CV) file from multiple formats (PDF/DOC/DOCX/TXT/RTF) * and returns an extensive JSON object of data points. * * An optional language parameter can also be provided (`English` value is set as the default one) . * * @param string $filePath The path to the resume file. * @param string|null $language The language of the resume file. Defaults to 'English'. * @return string The parsed data or an error message. * * @throws GuzzleException * * @api */ public function parseResume( string $filePath, ?string $language = null ): string { $response = $this->makeRequest( 'POST', SharpApiJobTypeEnum::HR_PARSE_RESUME->url(), ['language' => $language], $filePath ); return $this->parseStatusUrl($response); } /** * Generates a job description based on a set of parameters * provided via JobDescriptionParameters DTO object. * This endpoint provides concise job details in the response format, * including the short description, job requirements, and job responsibilities. * * Only the job position `name` parameter is required inside $jobDescriptionParameters * * @throws GuzzleException * * @api */ public function generateJobDescription(JobDescriptionParameters $jobDescriptionParameters): string { $response = $this->makeRequest( 'POST', SharpApiJobTypeEnum::HR_JOB_DESCRIPTION->url(), $jobDescriptionParameters->toArray()); return $this->parseStatusUrl($response); } /** * Generates a list of related skills with their weights as a float value (1.0-10.0) * where 10 equals 100%, the highest relevance score. * * @throws GuzzleException * * @api */ public function relatedSkills( string $skillName, ?string $language = null, ?int $maxQuantity = null ): string { $response = $this->makeRequest( 'POST', SharpApiJobTypeEnum::HR_RELATED_SKILLS->url(), [ 'content' => $skillName, 'language' => $language, 'max_quantity' => $maxQuantity, ]); return $this->parseStatusUrl($response); } /** * Generates a list of related job positions with their weights as float value (1.0-10.0) * where 10 equals 100%, the highest relevance score. * * @throws GuzzleException * * @api */ public function relatedJobPositions( string $jobPositionName, ?string $language = null, ?int $maxQuantity = null ): string { $response = $this->makeRequest( 'POST', SharpApiJobTypeEnum::HR_RELATED_JOB_POSITIONS->url(), [ 'content' => $jobPositionName, 'language' => $language, 'max_quantity' => $maxQuantity, ]); return $this->parseStatusUrl($response); } /** * Parses the customer's product review and provides its sentiment (POSITIVE/NEGATIVE/NEUTRAL) * with a score between 0-100%. Great for sentiment report processing for any online store. * * @throws GuzzleException * * @api */ public function productReviewSentiment(string $review): string { $response = $this->makeRequest( 'POST', SharpApiJobTypeEnum::ECOMMERCE_REVIEW_SENTIMENT->url(), ['content' => $review] ); return $this->parseStatusUrl($response); } /** * Generates a list of suitable categories for the product with relevance weights as a float value (1.0-10.0) * where 10 equals 100%, the highest relevance score. Provide the product name and its parameters * to get the best category matches possible. Comes in handy with populating * product catalogue data and bulk products' processing. * * @throws GuzzleException * * @api */ public function productCategories( string $productName, ?string $language = null, ?int $maxQuantity = null, ?string $voiceTone = null, ?string $context = null ): string { $response = $this->makeRequest( 'POST', SharpApiJobTypeEnum::ECOMMERCE_PRODUCT_CATEGORIES->url(), [ 'content' => $productName, 'language' => $language, 'max_quantity' => $maxQuantity, 'voice_tone' => $voiceTone, 'context' => $context, ]); return $this->parseStatusUrl($response); } /** * Generates a shorter version of the product description. * Provide as many details and parameters of the product to get the best marketing introduction possible. * Comes in handy with populating product catalog data and bulk products processing. * * @throws GuzzleException * * @api */ public function generateProductIntro( string $productData, ?string $language = null, ?int $maxLength = null, ?string $voiceTone = null ): string { $response = $this->makeRequest( 'POST', SharpApiJobTypeEnum::ECOMMERCE_PRODUCT_INTRO->url(), [ 'content' => $productData, 'language' => $language, 'max_length' => $maxLength, 'voice_tone' => $voiceTone, ]); return $this->parseStatusUrl($response); } /** * Generates a personalized thank-you email to the customer after the purchase. * The response content does not contain the title, greeting or sender info at the end, * so you can personalize the rest of the email easily. * * @throws GuzzleException * * @api */ public function generateThankYouEmail( string $productName, ?string $language = null, ?int $maxLength = null, ?string $voiceTone = null, ?string $context = null ): string { $response = $this->makeRequest( 'POST', SharpApiJobTypeEnum::ECOMMERCE_THANK_YOU_EMAIL->url(), [ 'content' => $productName, 'language' => $language, 'max_length' => $maxLength, 'voice_tone' => $voiceTone, 'context' => $context, ]); return $this->parseStatusUrl($response); } /** * Parses the provided text for any phone numbers and returns the original detected version and its E.164 format. * Might come in handy in the case of processing and validating big chunks of data against phone numbers * or f.e. if you want to detect phone numbers in places where they're not supposed to be. * * @throws GuzzleException * * @api */ public function detectPhones(string $text): string { $response = $this->makeRequest( 'POST', SharpApiJobTypeEnum::CONTENT_DETECT_PHONES->url(), ['content' => $text] ); return $this->parseStatusUrl($response); } /** * Parses the provided text for any possible emails. Might come in handy in case of processing and validating * big chunks of data against email addresses or f.e. if you want to detect emails in places * where they're not supposed to be. * * @throws GuzzleException * * @api */ public function detectEmails(string $text): string { $response = $this->makeRequest( 'POST', SharpApiJobTypeEnum::CONTENT_DETECT_EMAILS->url(), ['content' => $text] ); return $this->parseStatusUrl($response); } /** * Parses the provided text for any possible spam content. * It returns * * @throws GuzzleException * * @api */ public function detectSpam(string $text): string { $response = $this->makeRequest( 'POST', SharpApiJobTypeEnum::CONTENT_DETECT_SPAM->url(), ['content' => $text] ); return $this->parseStatusUrl($response); } /** * Generates a summarized version of the provided content. * Perfect for generating marketing introductions of longer texts. * * @throws GuzzleException * * @api */ public function summarizeText( string $text, ?string $language = null, ?int $maxLength = null, ?string $voiceTone = null ): string { $response = $this->makeRequest( 'POST', SharpApiJobTypeEnum::CONTENT_SUMMARIZE->url(), [ 'content' => $text, 'language' => $language, 'max_length' => $maxLength, 'voice_tone' => $voiceTone, ]); return $this->parseStatusUrl($response); } /** * Generates a list of unique keywords/tags based on the provided content. * * @throws GuzzleException * * @api */ public function generateKeywords( string $text, ?string $language = null, ?int $maxQuantity = null, ?string $voiceTone = null ): string { $response = $this->makeRequest( 'POST', SharpApiJobTypeEnum::CONTENT_KEYWORDS->url(), [ 'content' => $text, 'language' => $language, 'max_quantity' => $maxQuantity, 'voice_tone' => $voiceTone, ]); return $this->parseStatusUrl($response); } /** * Translates the provided text into selected language * Perfect for generating marketing introductions of longer texts. * * @throws GuzzleException * * @api */ public function translate( string $text, string $language, ?string $voiceTone = null, ?string $context = null ): string { $response = $this->makeRequest( 'POST', SharpApiJobTypeEnum::CONTENT_TRANSLATE->url(), [ 'content' => $text, 'language' => $language, 'voice_tone' => $voiceTone, 'context' => $context, ]); return $this->parseStatusUrl($response); } /** * Generates a paraphrased version of the provided text. * Only the `content` parameter is required. You can define the output language, * maximum character length, and tone of voice. Additional instructions * on how to process the text can be provided in the context parameter. * Please keep in mind that `max_length` serves as a strong suggestion * for the Language Model, rather than a strict requirement, * to maintain the general sense of the outcome. * You can set your preferred writing style by providing an optional `voice_tone` parameter. * It can be adjectives like `funny` or `joyous`, or even the name of a famous writer. * This API method also provides an optional context parameter, * which can be used to supply additional flexible instructions for content processing. * * @throws GuzzleException * * @api */ public function paraphrase( string $text, ?string $language = null, ?int $maxLength = null, ?string $voiceTone = null, ?string $context = null ): string { $response = $this->makeRequest( 'POST', SharpApiJobTypeEnum::CONTENT_PARAPHRASE->url(), [ 'content' => $text, 'language' => $language, 'max_length' => $maxLength, 'voice_tone' => $voiceTone, 'context' => $context, ]); return $this->parseStatusUrl($response); } /** * Proofreads (and checks grammar) of the provided text. * * @throws GuzzleException * * @api */ public function proofread(string $text): string { $response = $this->makeRequest( 'POST', SharpApiJobTypeEnum::CONTENT_PROOFREAD->url(), ['content' => $text] ); return $this->parseStatusUrl($response); } /** * Generates all most important META tags based on the content provided. * Make sure to include link to the website and pictures URL to get as many tags populated as possible. * * @throws GuzzleException * * @api */ public function generateSeoTags( string $text, ?string $language = null, ?string $voiceTone = null ): string { $response = $this->makeRequest( 'POST', SharpApiJobTypeEnum::SEO_GENERATE_TAGS->url(), [ 'content' => $text, 'language' => $language, 'voice_tone' => $voiceTone, ]); return $this->parseStatusUrl($response); } /** * Parses the Travel/Hospitality product review and provides its sentiment (POSITIVE/NEGATIVE/NEUTRAL) * with a score between 0-100%. Great for sentiment report processing for any online store. * * @throws GuzzleException * * @api */ public function travelReviewSentiment(string $text): string { $response = $this->makeRequest( 'POST', SharpApiJobTypeEnum::TTH_REVIEW_SENTIMENT->url(), ['content' => $text] ); return $this->parseStatusUrl($response); } /** * Generates a list of suitable categories for the Tours & Activities product * with relevance weights as float value (1.0-10.0) where 10 equals 100%, the highest relevance score. * Provide the product name and its parameters to get the best category matches possible. * Comes in handy with populating product catalogue data and bulk product processing. * * @throws GuzzleException * * @api */ public function toursAndActivitiesProductCategories( string $productName, ?string $city = null, ?string $country = null, ?string $language = null, ?int $maxQuantity = null, ?string $voiceTone = null, ?string $context = null ): string { $response = $this->makeRequest( 'POST', SharpApiJobTypeEnum::TTH_TA_PRODUCT_CATEGORIES->url(), [ 'content' => $productName, 'city' => $city, 'country' => $country, 'language' => $language, 'max_quantity' => $maxQuantity, 'voice_tone' => $voiceTone, 'context' => $context, ]); return $this->parseStatusUrl($response); } /** * Generates a list of suitable categories for the Hospitality type product * with relevance weights as float value (1.0-10.0) where 10 equals 100%, the highest relevance score. * Provide the product name and its parameters to get the best category matches possible. * Comes in handy with populating products catalogs data and bulk products' processing. * * @throws GuzzleException * * @api */ public function hospitalityProductCategories( string $productName, ?string $city = null, ?string $country = null, ?string $language = null, ?int $maxQuantity = null, ?string $voiceTone = null, ?string $context = null ): string { $response = $this->makeRequest( 'POST', SharpApiJobTypeEnum::TTH_HOSPITALITY_PRODUCT_CATEGORIES->url(), [ 'content' => $productName, 'city' => $city, 'country' => $country, 'language' => $language, 'max_quantity' => $maxQuantity, 'voice_tone' => $voiceTone, 'context' => $context, ]); return $this->parseStatusUrl($response); } }