Table of Contents

- Instalation
- Example of use
- Auto detection of numeric strings shape
- API
- learn
- classify
- resetKnowledge
- toJSON
- fromJSON
- toYAML
- fromYAML

Instalation

~~~shell
npm i classifier.js

or

yarn add classifier.js
~~~

Example of use

~~~typescript
import { Classifier } from 'classifier.js'

const classifier = new Classifier({ percentualReturn: true })

classifier.learn('I like cats', ['animal'])
classifier.learn('Cats are cool', ['animal'])
classifier.learn('Dogs are noisy', ['animal'])
classifier.learn('I love animals', ['animal'])
classifier.learn('I like my horse', ['animal'])
classifier.learn('Chocolate is good', ['food'])
classifier.learn('I eat apple', ['food'])
classifier.learn('Juice is very good', ['food'])
classifier.learn('Brazilians eat rice and beans', ['food'])
classifier.learn('Bananas are good for health', ['food'])

classifier.classify('Apple juice is awesome')
// OUTPUT: { unknown: '20%', animal: '0%', food: '80%' }
~~~

$3

~~~typescript
import { Classifier } from 'classifier.js'

const classifier = new Classifier({ percentualReturn: true })

classifier.learn('000.000.000-11', ['cpf'])
classifier.learn('00.000.000/0001-00', ['cnpj'])
classifier.learn('00155-333', ['zipcode'])

classifier.classify('999.999.999-99')
// OUTPUT: { unknown: '0%', cpf: '100%', cnpj: '0%', zipcode: '0%' }
classifier.classify('99.999.999/9999-99')
// OUTPUT: { unknown: '0%', cpf: '0%', cnpj: '100%', zipcode: '0%' }
classifier.classify('99999-999')
// OUTPUT: { unknown: '0%', cpf: '0%', cnpj: '0%', zipcode: '100%' }
~~~

API

$3

Receive data with an array of related categories.
~~~typescript
classifier.learn('Your sentence', ['your-category'])
~~~

$3

Classify a sentence based on received data.
~~~typescript
classifier.classify('Sentence to classify')
~~~

$3

Removes all that was learned.
~~~typescript
classifier.resetKnowledge()
~~~

$3

Saves classifier data to a JSON file that can be imported later.
~~~typescript
classifier.toJSON('myFolder/savedClassifier.json')

Or simply

classifier.toJSON('savedClassifier.json')
~~~

$3

Imports data from a JSON file.
~~~typescript
classifier.fromJSON('myFolder/savedClassifier.json')

Or simply

classifier.fromJSON('savedClassifier.json')
~~~

$3

Saves classifier data to an YAML file that can be imported later.
~~~typescript
classifier.toYAML('myFolder/savedClassifier.yaml')

Or simply

classifier.toYAML('savedClassifier.yaml')
~~~

$3

Imports data from an YAML file.
~~~typescript
classifier.toYAML('myFolder/savedClassifier.yaml')

Or simply

classifier.toYAML('savedClassifier.yaml')
~~~