ASasknews
wiki

Link an entity to its Wikidata entity

Changed on

Link an entity name to the Wikidata entity it refers to.

get/v1/wiki/link-entity

Request

Query parameters

entitystring required

Name of the entity to link.

entity_typestring nullable

Optional type of the entity (e.g. 'person', 'location', 'organization').

entity_descriptionstring nullable

Optional description providing additional context to improve entity matching.

n_candidatesinteger

Number of candidates to return alongside the linked entity (does not affect which entity is linked).

relevance_thresholdnumber

Minimum relevance (0-1) the linked entity must have to be accepted.

ambiguity_marginnumber

A same-named rival scoring within this relative margin (0-1) of the winner marks the result 'ambiguous'.

allow_ambiguousboolean

If true, 'ambiguous' links still return their entity; if false, only confident 'linked' matches are accepted.

include_candidatesboolean

If true, include the candidate list alongside the linked entity.

Response

Wikidata entity the entity links to

entitystring required
entity_typestring nullable
relevance_thresholdnumber nullable
link_status'linked' | 'ambiguous' | 'no_match' required
link_confidencenumber required

Changes