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 { findTitles } from 'entity-finder';

const name = 'democratic party';
const lang = 'en';
const titles = await findTitles(name, lang, { limit: 1, tags: 'thailand' });
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...',
//   categories:
//     [ 'Category:1946 establishments in Thailand',
//       'Category:Classical liberal parties' ]
// }

API

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

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

• name (String), required - Entity name: Italy.
• lang (String), required - Language 2 chars code: en.
• options (Object), optional - Options object:
  • limit (Number) - Maxim number of entities to return. Default: 2.
  • tags ([String]) (null) - Order results by tags score.
  • orderByTagsLimit (Number) - Limit titles ordered by tags.

PageTitle

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

Changelog

v0.6.0 - May 31, 2021

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

v0.5.1 - Match 21, 2018

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

v0.5.0 - Match 17, 2018

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

v0.4.0 - Match 18, 2017

• using module wiki-entity
• new results: returns an array of WikiEntity
• updated options param

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;