Download the PHP package kolasai/clean-talk-php-client without Composer
On this page you can find all versions of the php package kolasai/clean-talk-php-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download kolasai/clean-talk-php-client
More information about kolasai/clean-talk-php-client
Files in kolasai/clean-talk-php-client
Package clean-talk-php-client
Short Description Official Clean Talk client for PHP applications.
License Apache-2.0
Homepage https://kolas.ai/clean-talk/
Informations about the package clean-talk-php-client
Clean Talk PHP Client for Kolas.Ai Public API
Welcome to the Kolas.Ai Public API documentation! This repository hosts the PHP client for Kolas.Ai's Clean Talk public API, making it easy for developers to integrate Kolas.Ai’s machine learning services into your applications.
Overview
Clean Talk API is designed to classify message categories based on a trained dataset within a configured project. Use this API to accurately categorize messages into types like "Neutral", "Insult", "Spam" , etc. We support different languages, including English, Russian, Ukrainian, and we can add any languages by request (message to [email protected]).
Key Features
- Predict Message Categories: Use the
/predictions/predictendpoint to sync classify messages based on your project-specific datasets and/predictions/asyncPredictendpoint to async classify messages. - High Accuracy: Predictions include probability scores, giving you confidence in the classification results.
- OAuth2 Authentication: Secure access via OAuth2 client credentials flow.
Usage
The Kolas.Ai API follows the OpenAPI 3.1 standard. To get started:
- Create a new account on the Kolas.Ai platform.
- Create a new project Clean Talk and configure your datasets.
- Authentication: Obtain an access token using OAuth2 client credentials.
- Make Predictions: Send a POST request to
/predictions/predict(or/predictions/asyncPredict) with yourprojectIdand messages. - Receive Predictions: Retrieve predicted categories and their probabilities in the API response.
Installation
You can install the CleanTalk PHP client via Composer. Run the following command in your project directory:
Authentication
This API uses OAuth2 client credentials for secure access. You’ll need to request a token using your client credentials from the Kolas.Ai platform.
$authResult contains the access token and expires_in information, which you will use to authenticate your API requests. You need to update token after its expiration.
Example for Sync Request
Once you have your access token, you can make a request like this:
Example Response
Example for Async Request
Once you have your access token, you can make a request like this:
Responses will be sent to the configured webhook URL in your project settings.
Documentation Links
- Kolas.Ai OpenAPI schema: Explore our OpenAPI specification.
- Kolas.Ai Platform Documentation: Learn more about configuring projects and using Kolas.Ai’s platform.
License
This API specification is released under the Apache 2.0 License. See the LICENSE for more details.
__
Feel free to explore, test, and integrate Kolas.Ai's API, and reach out with any questions!