Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/basementuniverse/tf-idf
Search for terms in array of documents using TF-IDF
https://github.com/basementuniverse/tf-idf
Last synced: 23 days ago
JSON representation
Search for terms in array of documents using TF-IDF
- Host: GitHub
- URL: https://github.com/basementuniverse/tf-idf
- Owner: basementuniverse
- License: mit
- Created: 2023-11-26T08:52:38.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-02-09T11:16:37.000Z (11 months ago)
- Last Synced: 2024-11-15T18:39:29.389Z (about 2 months ago)
- Language: TypeScript
- Size: 75.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TF-IDF
Search for terms in an array of documents using [TF-IDF](https://en.wikipedia.org/wiki/Tf%E2%80%93idf).
## Installation
```
npm install -g @basementuniverse/tf-idf
```
## Usage
```typescript
import { Corpus } from '@basementuniverse/tf-idf';
const corpus = new Corpus([
'This is a document',
'Here is another document',
]);
const results = corpus.search('document');
```
`results` will look something like:
```json
[
{
"document": "This is a document",
"score": 0.5
},
{
"document": "Here is another document",
"score": 0.5
}
]
```
The documents passed into the `Corpus` constructor will be treated as strings by default, and will be converted to lowercase and split by non-word characters.
However, it is possible to pass in values of any type here, as long as you provide a function to convert each value to an array of strings. For example:
```typescript
const corpus = new Corpus(
[
{
id: '1234',
name: 'John Doe',
},
{
id: '2345',
name: 'Jane Doe',
},
],
document => [document.id, ...document.name.toLowerCase().split(' ')],
);
```
Partial term matching can be enabled by passing `true` as the second argument to `search()`:
```typescript
const results = corpus.search('doe', true);
```