Skip to content

entitizer/entity-finder-js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

57 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

entity-finder

A nodejs entity finder. entity-finder that searchs the wikipedia for titles and returns the most correct answers.

It will omit any wikipedia disambiguization pages.

Usage

import { find } from 'entity-finder';

const name = 'democratic party thailand';
const lang = 'en';
const titles = await find(name, lang, { limit: 1 });
const title = titles[0];
// title =
// {
//   title: 'Democrat Party (Thailand)',
//   simple: 'Democrat Party',
//   special: 'Thailand',
//   description: 'The Democrat Party (Thai: พรรคประชาธิปัตย์; RTGS: prachathipat) is a Thai political party...',
// }

API

find(name: string, lang: string, options?): Promise<PageTitle[]>

Finds entities. Returns an array of entities ordered by relevance.

  • name (String), required - Entity name: Italy. Maybe any text: David the sculpture.
  • lang (String), required - Language 2 chars code: en.
  • options (Object), optional - Options object:
    • limit (Number) - Maxim number of entities to return. Default: 2.

PageTitle

export type PageTitle = {
  title: string
  simple?: string
  special?: string
  description?: string
  about?: string
  categories?: string[]
}

Changelog

v1.0.0 - Apr 29, 2026

  • modernize codebase: TypeScript strict mode, ES2020 target, Node >=18
  • replace require("debug") with ES imports; bump debug to v4
  • fix dropped headers in wikipedia.openSearch (typo readersheaders)
  • fix searchTitles crashing when description is undefined
  • fix find accidentally filtering primary results that lacked a (special) suffix
  • request User-Agent is now derived from package.json (with contact URL) and overridable via ENTITY_FINDER_USER_AGENT
  • convert promise chains in findTitles to async/await
  • modernize run.js CLI (arg validation, error handling)
  • bump dev deps: typescript v5, rimraf v5, add @types/debug
  • remove dead wiki-entity commented code

v0.7.0 - Jan 16, 2025

  • expose only find function

v0.6.0 - May 31, 2021

  • remove wiki-entity dependency.
  • remove request dependency.
  • sixes

v0.5.1 - March 21, 2018

  • New option: orderByTagsLimit - Limits titles ordered by tags.

v0.5.0 - March 17, 2018

  • search only for titles
  • updated API
  • filters dezambiguization titles (Category:Dezambiguization)
  • updated options param

v0.4.0 - March 18, 2017

v0.3.0 - March 6, 2017

  • TypeScript code
  • changed entity type: group to org

v0.2.0 - November 4, 2016

  • node4;
  • new wikipedia parser: n3 - better performance;
  • added option: tags;
  • news model fields: types and props;

About

A Nodejs Named entity finder module.

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors