EntityRecord Class

EntityRecord.

Variables are only populated by the server, and will be ignored when sending a request.

Inheritance

Model

EntityRecord

Constructor

EntityRecord(*, name: Optional[str] = None, matches=None, wikipedia_language: Optional[str] = None, wikipedia_id: Optional[str] = None, bing_id: Optional[str] = None, type: Optional[str] = None, sub_type: Optional[str] = None, **kwargs)

Parameters

name

str

Required

Entity formal name.

matches

list[MatchRecord]

Required

List of instances this entity appears in the text.

wikipedia_language

str

Required

Wikipedia language for which the WikipediaId and WikipediaUrl refers to.

wikipedia_id

str

Required

Wikipedia unique identifier of the recognized entity.

bing_id

str

Required

Bing unique identifier of the recognized entity. Use in conjunction with the Bing Entity Search API to fetch additional relevant information.

type

str

Required

Entity type from Named Entity Recognition model

sub_type

str

Required

Entity sub type from Named Entity Recognition model

Variables

wikipedia_url

str

URL for the entity's Wikipedia page.