🐘 PHP Library
A PHP wrapper for the Tinq.ai API - an easy-to-use text analysis and natural language processing toolkit.
Tinq.ai PHP Library
A PHP wrapper for the Tinq.ai API - an easy-to-use text analysis and natural language processing toolkit.
Documentation
Find the full API documentation here.
Requirements
PHP>=7.4.
Installation
Install the package with:
composer require tinq-ai/tinq-php
To use the bindings, load it via Autoload:
require_once('vendor/autoload.php');
Usage
Table of Contents
- Authentication
- Rewriter
- Summarizer
- Classifier
- Article Extractor
- Sentiment analysis
- Plagiarism Checker
Please note that all methods return associative arrays. Responses can be found in the developer documentation here.
Authentication
Get the API key for your project in Tinq.ai and then instantiate a new client.
$tinq = new Tinq\TinqClient("your api key", "your username");
Alternatively, set the API key and your username in an environment variable named TINQ_API_KEY
& TINQ_USERNAME
, respectively.
$tinq = new Tinq\TinqClient();
Rewriter
Rewrites/paraphrases a given text.
$text
is the piece of content that you'd like to rewrite.
$params
is optional, a list of accepted parameters is available here.
$text = "The process of learning a new piece of music is fantastic. You start from nothing, practise, improve, and finally get the fruits of your hard work, as farmers do during the harvest time.";
$rewritten = $tinq->rewrite($text, $params = []);
Summarizer
Summarizes a given text.
$text
is the piece of content that you'd like to summarize.
$params
is optional, a list of accepted parameters is available here.
$text = "Bernal’s case study is Tullis Mason, a chap who sports “three-quarter length shorts” even in a lab coat. Matson runs an artificial insemination company for racehorses from his family’s farm in Shropshire, England. However, on the side, he is also planning to save the animal kingdom by building the biggest biobank of animal cells in Europe. It’s not always a dignified business, with Bernal describing Mason hooking an elephant penis into a device that looks like “a huge condom,” but the science and the ethics her article explores are fascinating. We may not be about to bring dinosaurs back to life, but with help from biobanking, life already on this planet might still find a way.";
$summary = $tinq->summarize($text, $params = []);
Classifier
Classifies a given text, according to a classifier that you specify
$text
is the piece of content that you'd like to summarize.
$classifier
is the piece of content that you'd like to summarize.
$params
is optional, a list of accepted parameters is available here.
$text = "Hi, I need help with my website.";
$classifier = "fjew833"; // ID of your classifier on Tinq.ai
$account = $tinq->classify($text, $classifier $params = []);
Article Extractor
Extractor API is a feature-rich API and online application that handles all of the tedious work and problems associated with clean text extraction.
$url
URL from which you want to extract an article.
$params
is optional, a list of accepted parameters is available here.
$url = "https://longreads.com/2021/08/19/bringing-species-back-from-the-brink/";
$account = $tinq->extractArticle($text, $classifier $params = []);
Sentiment Analysis
Performs sentiment analysis operations for a given string.
$text
is the piece of content that you'd like to summarize.
$classifier
is the piece of content that you'd like to summarize.
$params
is optional, a list of accepted parameters is available here.
$text = "I really like you.";
$sentimentAnalysis = $tinq->sentiments($text, $params = []);
Plagiarism Checker
Checks for plagiarism and finds online sources for a given content.
$text
is the piece of content that you'd like to summarize.
$params
is optional, a list of accepted parameters is available here.
$text = "Bernal’s case study is Tullis Mason, a chap who sports “three-quarter length shorts” even in a lab coat. Matson runs an artificial insemination company for racehorses from his family’s farm in Shropshire, England.";
$checkPlagiarism = $tinq->checkPlagiarism($text, $params = []);
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/tinq-ai/tinq-php.
License
The package is available as open source under the terms of the MIT License.
Updated about 2 years ago