Specifications

HTTP Request

GET https://api.botfuel.io/nlp/entity-extraction/v0

Query Parameters

Parameter Default Type Description Required
sentence null String Sentence you want to extract entities from. The sentence's maximum length is 256. If it has more than 256 characters then an empty list will be returned. Required
dimensions null Array Array of strings representing entities.
If provided, the result is filtered by this list
The full list of dimensions available is described below.
Optional
antidimensions [] Array Array of strings representing entities.
If provided, the result is filtered out by this list.
Optional
timezone UTC String Timezone in which timestamps (in milliseconds) from relative and absolute times are computed.
The timezone id must be in long form, e.g. 'America/Matamoros'.
Optional
case_sensitive false Boolean If false , replace capitalized characters by non-capitalized characters before treating the sentence. Optional
keep_quotes false Boolean If false , replace single quotes by blank spaces. Optional
keep_accents false Boolean If false , replace accented characters by non-accented characters. Optional

Response structure

Parameter Type Description
dim String Dimension of the returned entity.
body String Part of the sentence that produced the entity.
values Array Array of details object of each extracted entity.
start Number Start index of the body substring in the whole sentence.
end Number End index of the body substring in the whole sentence.