README

wiki-entity

Wiki(pedia/data) entity extractor.

Usage

import { getEntities } from 'wiki-entity';

// get Europe by title
getEntities({ language: 'en', titles: ['Europe'] }).then(entities => {});

// get Europe by id
getEntities({ language: 'en', ids: ['Q46'] }).then(entities => {});

API

getEntities(params): Promise<WikiEntity[]>

Gets entities from wikidata and wikipedia.

params

Required. ids or titles require. Params properties:

ids :string[] - wikidata ids; (max 500)
titles :string[] - wikipedia article titles; (max 500)
language :string - language of titles param and of the result object info; default: en
props :string[] - entity props to get. Can by: info|sitelinks|aliases|labels|descriptions|claims|datatype;
claims :string - How to resolve the claims. Can be: none, all, item, property. Default: none. all resolves item and property types.
extract :number - Sentences in the extract. Default: 0. Works only if sitelinks is present.
types :boolean | string[] - true to get entity types. Filter types by prefixes. Example: [dbo, schema] will return only types defined by dbpedia.org/ontology/ and schema.org. Default: false.
redirects : boolean - get wikipedia redirects titles. Default: false. Works only if sitelinks is present.
categories : boolean - get wikipedia article categories. Default: false. Works only if sitelinks is present.
httpTimeout: number - http requests timeout
languages: string[] - languages for WikiEntity.labels
wikiPageId: boolean - get wikiPageId, Default true

convertToSimpleEntity(wikiEntity: WikiEntity): SimpleEntity

Convert a complex WikiEntity object to SimpleEntity object.

WikiEntity

WikiEntity is a simple version of an item returned by Wikidata API. It also may include some extra properties from Wikipadia API.


type WikiEntity = {
    id: string;
    label?: string;
    labels?: PlainObject<string>;
    description?: string;
    extract?: string;
    pageid?: number;
    aliases?: string[];
    sitelinks?: PlainObject<string>;
    claims?: PlainObject<WikidataProperty>;
    types?: string[];
    redirects?: string[];
    categories?: string[];
    redirectsToId?: string;
    redirectsFromId?: string;
}

type WikidataProperty = {
    id: string;
    label?: string;
    description?: string;
    values: WikidataPropertyValue[];
}

type WikidataPropertyValue = {
    datatype: string;
    value: any;
    pageid?: number;
    value_string?: string;
    label?: string;
    description?: string;
    qualifiers?: WikidataEntityClaims | null;
}

type PlainObject<T> = {
    [index: string]: T
}

SimpleEntity


export enum SimpleEntityType {
    EVENT = 'E',
    ORG = 'O',
    PERSON = 'H',
    PLACE = 'P',
    PRODUCT = 'R',
    WORK = 'W',
}

export type SimpleEntityData = { [prop: string]: string[] }

export type SimpleEntity = {
    lang?: string
    wikiDataId?: string
    name?: string
    abbr?: string
    description?: string
    about?: string
    wikiPageId?: number
    wikiPageTitle?: string
    type?: SimpleEntityType
    types?: string[]
    countryCodes?: string[]
    data?: SimpleEntityData
    categories?: string[]
    redirectsToId?: string;
}

Usage no npm install needed!