https://github.com/kudashevs/keywords-extractor
A flexible and customizable PHP library that extracts relevant keywords from text.
https://github.com/kudashevs/keywords-extractor
Last synced: 4 months ago
JSON representation
A flexible and customizable PHP library that extracts relevant keywords from text.
- Host: GitHub
- URL: https://github.com/kudashevs/keywords-extractor
- Owner: kudashevs
- License: mit
- Created: 2025-01-25T15:38:20.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2025-01-25T15:58:05.000Z (4 months ago)
- Last Synced: 2025-01-25T16:27:39.801Z (4 months ago)
- Language: PHP
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Keywords Extractor
[](https://packagist.org/packages/kudashevs/keywords-extractor)
[](https://github.com/kudashevs/keywords-extractor/actions/workflows/run-tests.yml)
[](LICENSE.md)
The `keywords-extractor` is a flexible and customizable PHP library that extracts relevant keywords from text.
## Installation
You can install the package via composer:
```bash
composer require kudashevs/keywords-extractor
```
## Usage
The key feature of the `keywords-extractor` library is the possibility to extract not just individual nouns, but the
meaningful sequences of words that make more sense in some contexts. This possibility is provided by the [RAKE PHP](https://github.com/kudashevs/rake-php)
library that is used as the default extraction algorithm. If this library doesn't suit your needs, it can be easily
substituted with something more appropriate or relevant.
The behavior of the `KeywordsExtractor` class is pretty straightforward. To extract keywords just call the `extract` method:
```php
use Kudashevs\KeywordsExtractor\KeywordsExtractor;
$extractor = new KeywordsExtractor([
'add_words' => 'some',
'remove_words' => 'interesting'
]);
$keywords = $extractor->extract('this is some interesting text');
print_r($keywords); // some, text
```
To make this library even more convenient to use in some specific cases, it provides a fluent interface.
```php
use Kudashevs\KeywordsExtractor\KeywordsExtractor;
$extractor = new KeywordsExtractor();
$keywords = $extractor->addWords(['this', 'example'])
->extract('this is a usage example');
print_r($keywords); // usage example, this
```
### Result length
By default, the returning result is limitless, meaning that the length of the result is not limited. However, in some
cases the length of the result does matter. For these cases the package introduces the concept of a [Limiter](Limiters/Limiter.php).
The library provides two possibilities to limit the result:
- using the `limit_length` option (for more information please refer to [options](#options))
- using a custom Limiter with a pre-defined max length (the library contains `LengthLimiter` and `PercentLimiter` classes)
## Options
The `KeywordsExtractor` class accepts some configuration options:
```
'extractor' # An Extractor instance that does all the extraction work.
'add_words' => value # A string or an array of words to add to the result (if they are ignored by an Extractor).
'remove_words' => value # A string or an array of words to remove from the result (if they are not ignored by an Extractor).
'limiter' # A Limiter instance that limits the length of the end result.
'limit_length' # An integer defines the maximum length of the result (is used only when a Limiter is not provided).
```
**Note:** At the moment of instantiation, the `KeywordsExtractor` class can throw a few exceptions: `InvalidOptionType`,
`InvalidOptionType`. These exceptions extend a built-in `InvalidArgumentException` class, so they are easy to deal with.
## Testing
```bash
composer test
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
**Note:** Please make sure to update tests as appropriate.
## License
The MIT License (MIT). Please see the [License file](LICENSE.md) for more information