Duckling.Core

Everything needed to run Duckling.

Documentation

data Context

Constructors

Context

Fields

• referenceTime :: DucklingTime
• locale :: Locale

Instances

Eq Context

Methods

(==) :: Context -> Context -> Bool

(/=) :: Context -> Context -> Bool

Show Context

Methods

showsPrec :: Int -> Context -> ShowS

show :: Context -> String

showList :: [Context] -> ShowS

data Dimension a where

GADT for differentiating between dimensions Each dimension should have its own constructor and provide the data structure for its parsed data

Constructors

RegexMatch :: Dimension GroupMatch

AmountOfMoney :: Dimension AmountOfMoneyData

Distance :: Dimension DistanceData

Duration :: Dimension DurationData

Email :: Dimension EmailData

Numeral :: Dimension NumeralData

Ordinal :: Dimension OrdinalData

PhoneNumber :: Dimension PhoneNumberData

Quantity :: Dimension QuantityData

Temperature :: Dimension TemperatureData

Time :: Dimension TimeData

TimeGrain :: Dimension Grain

Url :: Dimension UrlData

Volume :: Dimension VolumeData

CustomDimension :: CustomDimension a => a -> Dimension (DimensionData a)

Instances

Show (Dimension a)

Methods

showsPrec :: Int -> Dimension a -> ShowS

show :: Dimension a -> String

showList :: [Dimension a] -> ShowS

Hashable (Dimension a)

Methods

hashWithSalt :: Int -> Dimension a -> Int

hash :: Dimension a -> Int

TextShow (Dimension a)

Methods

showbPrec :: Int -> Dimension a -> Builder

showb :: Dimension a -> Builder

showbList :: [Dimension a] -> Builder

showtPrec :: Int -> Dimension a -> Text

showt :: Dimension a -> Text

showtList :: [Dimension a] -> Text

showtlPrec :: Int -> Dimension a -> Text

showtl :: Dimension a -> Text

showtlList :: [Dimension a] -> Text

GEq * Dimension

Methods

geq :: f a -> f b -> Maybe ((Dimension := a) b)

GShow * Dimension

Methods

gshowsPrec :: Int -> t a -> ShowS

Hashable (Some * Dimension)

Methods

hashWithSalt :: Int -> Some * Dimension -> Int

hash :: Some * Dimension -> Int

TextShow (Some * Dimension)

Methods

showbPrec :: Int -> Some * Dimension -> Builder

showb :: Some * Dimension -> Builder

showbList :: [Some * Dimension] -> Builder

showtPrec :: Int -> Some * Dimension -> Text

showt :: Some * Dimension -> Text

showtList :: [Some * Dimension] -> Text

showtlPrec :: Int -> Some * Dimension -> Text

showtl :: Some * Dimension -> Text

showtlList :: [Some * Dimension] -> Text

data Entity

Constructors

Entity

Fields

• dim :: Text
• body :: Text
• value :: Value
• start :: Int
• end :: Int
• latent :: Bool
• enode :: Node

Instances

Eq Entity

Methods

(==) :: Entity -> Entity -> Bool

(/=) :: Entity -> Entity -> Bool

Show Entity

Methods

showsPrec :: Int -> Entity -> ShowS

show :: Entity -> String

showList :: [Entity] -> ShowS

Generic Entity

Associated Types

type Rep Entity :: * -> *

Methods

from :: Entity -> Rep Entity x

to :: Rep Entity x -> Entity

ToJSON Entity

Methods

toJSON :: Entity -> Value

toEncoding :: Entity -> Encoding

NFData Entity

Methods

rnf :: Entity -> ()

type Rep Entity

type Rep Entity = D1 * (MetaData "Entity" "Duckling.Types" "duckling-0.1.5.0-Gv0cL4nVr7C13ZzNyroFYP" False) (C1 * (MetaCons "Entity" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "dim") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)) ((:*:) * (S1 * (MetaSel (Just Symbol "body") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "value") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Value)))) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "start") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "end") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int))) ((:*:) * (S1 * (MetaSel (Just Symbol "latent") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Bool)) (S1 * (MetaSel (Just Symbol "enode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Node))))))

data Lang

ISO 639-1 Language. See https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

Constructors

AR

BG

CS

DA

DE

EL

EN

ES

ET

FR

GA

HE

HI

HR

HU

ID

IT

JA

KA

KO

MY

NB

NE

NL

PL

PT

RO

RU

SV

TA

TR

UK

VI

ZH

Instances

Bounded Lang

Methods

minBound :: Lang

maxBound :: Lang

Enum Lang

Methods

succ :: Lang -> Lang

pred :: Lang -> Lang

toEnum :: Int -> Lang

fromEnum :: Lang -> Int

enumFrom :: Lang -> [Lang]

enumFromThen :: Lang -> Lang -> [Lang]

enumFromTo :: Lang -> Lang -> [Lang]

enumFromThenTo :: Lang -> Lang -> Lang -> [Lang]

Eq Lang

Methods

(==) :: Lang -> Lang -> Bool

(/=) :: Lang -> Lang -> Bool

Ord Lang

Methods

compare :: Lang -> Lang -> Ordering

(<) :: Lang -> Lang -> Bool

(<=) :: Lang -> Lang -> Bool

(>) :: Lang -> Lang -> Bool

(>=) :: Lang -> Lang -> Bool

max :: Lang -> Lang -> Lang

min :: Lang -> Lang -> Lang

Read Lang

Methods

readsPrec :: Int -> ReadS Lang

readList :: ReadS [Lang]

readPrec :: ReadPrec Lang

readListPrec :: ReadPrec [Lang]

Show Lang

Methods

showsPrec :: Int -> Lang -> ShowS

show :: Lang -> String

showList :: [Lang] -> ShowS

Generic Lang

Associated Types

type Rep Lang :: * -> *

Methods

from :: Lang -> Rep Lang x

to :: Rep Lang x -> Lang

Hashable Lang

Methods

hashWithSalt :: Int -> Lang -> Int

hash :: Lang -> Int

TextShow Lang

Methods

showbPrec :: Int -> Lang -> Builder

showb :: Lang -> Builder

showbList :: [Lang] -> Builder

showtPrec :: Int -> Lang -> Text

showt :: Lang -> Text

showtList :: [Lang] -> Text

showtlPrec :: Int -> Lang -> Text

showtl :: Lang -> Text

showtlList :: [Lang] -> Text

type Rep Lang

type Rep Lang = D1 * (MetaData "Lang" "Duckling.Locale" "duckling-0.1.5.0-Gv0cL4nVr7C13ZzNyroFYP" False) ((:+:) * ((:+:) * ((:+:) * ((:+:) * ((:+:) * (C1 * (MetaCons "AR" PrefixI False) (U1 *)) (C1 * (MetaCons "BG" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "CS" PrefixI False) (U1 *)) (C1 * (MetaCons "DA" PrefixI False) (U1 *)))) ((:+:) * ((:+:) * (C1 * (MetaCons "DE" PrefixI False) (U1 *)) (C1 * (MetaCons "EL" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "EN" PrefixI False) (U1 *)) (C1 * (MetaCons "ES" PrefixI False) (U1 *))))) ((:+:) * ((:+:) * ((:+:) * (C1 * (MetaCons "ET" PrefixI False) (U1 *)) (C1 * (MetaCons "FR" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "GA" PrefixI False) (U1 *)) (C1 * (MetaCons "HE" PrefixI False) (U1 *)))) ((:+:) * ((:+:) * (C1 * (MetaCons "HI" PrefixI False) (U1 *)) (C1 * (MetaCons "HR" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "HU" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "ID" PrefixI False) (U1 *)) (C1 * (MetaCons "IT" PrefixI False) (U1 *))))))) ((:+:) * ((:+:) * ((:+:) * ((:+:) * (C1 * (MetaCons "JA" PrefixI False) (U1 *)) (C1 * (MetaCons "KA" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "KO" PrefixI False) (U1 *)) (C1 * (MetaCons "MY" PrefixI False) (U1 *)))) ((:+:) * ((:+:) * (C1 * (MetaCons "NB" PrefixI False) (U1 *)) (C1 * (MetaCons "NE" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "NL" PrefixI False) (U1 *)) (C1 * (MetaCons "PL" PrefixI False) (U1 *))))) ((:+:) * ((:+:) * ((:+:) * (C1 * (MetaCons "PT" PrefixI False) (U1 *)) (C1 * (MetaCons "RO" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "RU" PrefixI False) (U1 *)) (C1 * (MetaCons "SV" PrefixI False) (U1 *)))) ((:+:) * ((:+:) * (C1 * (MetaCons "TA" PrefixI False) (U1 *)) (C1 * (MetaCons "TR" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "UK" PrefixI False) (U1 *)) ((:+:) * (C1 * (MetaCons "VI" PrefixI False) (U1 *)) (C1 * (MetaCons "ZH" PrefixI False) (U1 *))))))))

data Locale

Instances

Eq Locale

Methods

(==) :: Locale -> Locale -> Bool

(/=) :: Locale -> Locale -> Bool

Ord Locale

Methods

compare :: Locale -> Locale -> Ordering

(<) :: Locale -> Locale -> Bool

(<=) :: Locale -> Locale -> Bool

(>) :: Locale -> Locale -> Bool

(>=) :: Locale -> Locale -> Bool

max :: Locale -> Locale -> Locale

min :: Locale -> Locale -> Locale

Show Locale

Methods

showsPrec :: Int -> Locale -> ShowS

show :: Locale -> String

showList :: [Locale] -> ShowS

Generic Locale

Associated Types

type Rep Locale :: * -> *

Methods

from :: Locale -> Rep Locale x

to :: Rep Locale x -> Locale

Hashable Locale

Methods

hashWithSalt :: Int -> Locale -> Int

hash :: Locale -> Int

TextShow Locale

Methods

showbPrec :: Int -> Locale -> Builder

showb :: Locale -> Builder

showbList :: [Locale] -> Builder

showtPrec :: Int -> Locale -> Text

showt :: Locale -> Text

showtList :: [Locale] -> Text

showtlPrec :: Int -> Locale -> Text

showtl :: Locale -> Text

showtlList :: [Locale] -> Text

type Rep Locale

type Rep Locale = D1 * (MetaData "Locale" "Duckling.Locale" "duckling-0.1.5.0-Gv0cL4nVr7C13ZzNyroFYP" False) (C1 * (MetaCons "Locale" PrefixI False) ((:*:) * (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Lang)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Region)))))

data Node

Constructors

Node

Fields

• nodeRange :: Range
• token :: Token
• children :: [Node]
• rule :: Maybe Text

Instances

Eq Node

Methods

(==) :: Node -> Node -> Bool

(/=) :: Node -> Node -> Bool

Show Node

Methods

showsPrec :: Int -> Node -> ShowS

show :: Node -> String

showList :: [Node] -> ShowS

Generic Node

Associated Types

type Rep Node :: * -> *

Methods

from :: Node -> Rep Node x

to :: Rep Node x -> Node

NFData Node

Methods

rnf :: Node -> ()

Hashable Node

Methods

hashWithSalt :: Int -> Node -> Int

hash :: Node -> Int

type Rep Node

type Rep Node = D1 * (MetaData "Node" "Duckling.Types" "duckling-0.1.5.0-Gv0cL4nVr7C13ZzNyroFYP" False) (C1 * (MetaCons "Node" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "nodeRange") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Range)) (S1 * (MetaSel (Just Symbol "token") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Token))) ((:*:) * (S1 * (MetaSel (Just Symbol "children") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [Node])) (S1 * (MetaSel (Just Symbol "rule") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Text))))))

newtype Options

Constructors

Options

Fields

• withLatent :: Bool

Instances

Eq Options

Methods

(==) :: Options -> Options -> Bool

(/=) :: Options -> Options -> Bool

Show Options

Methods

showsPrec :: Int -> Options -> ShowS

show :: Options -> String

showList :: [Options] -> ShowS

data Range

Constructors

Range Int Int

Instances

Eq Range

Methods

(==) :: Range -> Range -> Bool

(/=) :: Range -> Range -> Bool

Ord Range

Methods

compare :: Range -> Range -> Ordering

(<) :: Range -> Range -> Bool

(<=) :: Range -> Range -> Bool

(>) :: Range -> Range -> Bool

(>=) :: Range -> Range -> Bool

max :: Range -> Range -> Range

min :: Range -> Range -> Range

Show Range

Methods

showsPrec :: Int -> Range -> ShowS

show :: Range -> String

showList :: [Range] -> ShowS

Generic Range

Associated Types

type Rep Range :: * -> *

Methods

from :: Range -> Rep Range x

to :: Rep Range x -> Range

NFData Range

Methods

rnf :: Range -> ()

Hashable Range

Methods

hashWithSalt :: Int -> Range -> Int

hash :: Range -> Int

type Rep Range

type Rep Range = D1 * (MetaData "Range" "Duckling.Types" "duckling-0.1.5.0-Gv0cL4nVr7C13ZzNyroFYP" False) (C1 * (MetaCons "Range" PrefixI False) ((:*:) * (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int))))

data Region

ISO 3166-1 alpha-2 Country code (includes regions and territories). See https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

Constructors

AU

BZ

CA

CN

GB

HK

IE

IN

JM

MO

NZ

PH

TT

TW

US

ZA

Instances

Bounded Region

Methods

minBound :: Region

maxBound :: Region

Enum Region

Methods

succ :: Region -> Region

pred :: Region -> Region

toEnum :: Int -> Region

fromEnum :: Region -> Int

enumFrom :: Region -> [Region]

enumFromThen :: Region -> Region -> [Region]

enumFromTo :: Region -> Region -> [Region]

enumFromThenTo :: Region -> Region -> Region -> [Region]

Eq Region

Methods

(==) :: Region -> Region -> Bool

(/=) :: Region -> Region -> Bool

Ord Region

Methods

compare :: Region -> Region -> Ordering

(<) :: Region -> Region -> Bool

(<=) :: Region -> Region -> Bool

(>) :: Region -> Region -> Bool

(>=) :: Region -> Region -> Bool

max :: Region -> Region -> Region

min :: Region -> Region -> Region

Read Region

Methods

readsPrec :: Int -> ReadS Region

readList :: ReadS [Region]

readPrec :: ReadPrec Region

readListPrec :: ReadPrec [Region]

Show Region

Methods

showsPrec :: Int -> Region -> ShowS

show :: Region -> String

showList :: [Region] -> ShowS

Generic Region

Associated Types

type Rep Region :: * -> *

Methods

from :: Region -> Rep Region x

to :: Rep Region x -> Region

Hashable Region

Methods

hashWithSalt :: Int -> Region -> Int

hash :: Region -> Int

TextShow Region

Methods

showbPrec :: Int -> Region -> Builder

showb :: Region -> Builder

showbList :: [Region] -> Builder

showtPrec :: Int -> Region -> Text

showt :: Region -> Text

showtList :: [Region] -> Text

showtlPrec :: Int -> Region -> Text

showtl :: Region -> Text

showtlList :: [Region] -> Text

type Rep Region

type Rep Region = D1 * (MetaData "Region" "Duckling.Locale" "duckling-0.1.5.0-Gv0cL4nVr7C13ZzNyroFYP" False) ((:+:) * ((:+:) * ((:+:) * ((:+:) * (C1 * (MetaCons "AU" PrefixI False) (U1 *)) (C1 * (MetaCons "BZ" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "CA" PrefixI False) (U1 *)) (C1 * (MetaCons "CN" PrefixI False) (U1 *)))) ((:+:) * ((:+:) * (C1 * (MetaCons "GB" PrefixI False) (U1 *)) (C1 * (MetaCons "HK" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "IE" PrefixI False) (U1 *)) (C1 * (MetaCons "IN" PrefixI False) (U1 *))))) ((:+:) * ((:+:) * ((:+:) * (C1 * (MetaCons "JM" PrefixI False) (U1 *)) (C1 * (MetaCons "MO" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "NZ" PrefixI False) (U1 *)) (C1 * (MetaCons "PH" PrefixI False) (U1 *)))) ((:+:) * ((:+:) * (C1 * (MetaCons "TT" PrefixI False) (U1 *)) (C1 * (MetaCons "TW" PrefixI False) (U1 *))) ((:+:) * (C1 * (MetaCons "US" PrefixI False) (U1 *)) (C1 * (MetaCons "ZA" PrefixI False) (U1 *))))))

data Some k (tag :: k -> *) :: forall k. (k -> *) -> * where

Constructors

This :: Some k tag

Instances

GEq k tag => Eq (Some k tag)

Methods

(==) :: Some k tag -> Some k tag -> Bool

(/=) :: Some k tag -> Some k tag -> Bool

GCompare k tag => Ord (Some k tag)

Methods

compare :: Some k tag -> Some k tag -> Ordering

(<) :: Some k tag -> Some k tag -> Bool

(<=) :: Some k tag -> Some k tag -> Bool

(>) :: Some k tag -> Some k tag -> Bool

(>=) :: Some k tag -> Some k tag -> Bool

max :: Some k tag -> Some k tag -> Some k tag

min :: Some k tag -> Some k tag -> Some k tag

GRead k f => Read (Some k f)

Methods

readsPrec :: Int -> ReadS (Some k f)

readList :: ReadS [Some k f]

readPrec :: ReadPrec (Some k f)

readListPrec :: ReadPrec [Some k f]

GShow k tag => Show (Some k tag)

Methods

showsPrec :: Int -> Some k tag -> ShowS

show :: Some k tag -> String

showList :: [Some k tag] -> ShowS

Hashable (Some * Dimension)

Methods

hashWithSalt :: Int -> Some * Dimension -> Int

hash :: Some * Dimension -> Int

TextShow (Some * Dimension)

Methods

showbPrec :: Int -> Some * Dimension -> Builder

showb :: Some * Dimension -> Builder

showbList :: [Some * Dimension] -> Builder

showtPrec :: Int -> Some * Dimension -> Text

showt :: Some * Dimension -> Text

showtList :: [Some * Dimension] -> Text

showtlPrec :: Int -> Some * Dimension -> Text

showtl :: Some * Dimension -> Text

showtlList :: [Some * Dimension] -> Text

fromName :: Text -> Maybe (Some Dimension)

makeLocale :: Lang -> Maybe Region -> Locale

toName :: Dimension a -> Text

parse :: Text -> Context -> Options -> [Some Dimension] -> [Entity]

Parses input and returns a curated list of entities found.

supportedDimensions :: HashMap Lang [Some Dimension]

allLocales :: HashMap Lang (HashSet Region)

currentReftime :: HashMap Text TimeZoneSeries -> Text -> IO DucklingTime

Builds a DucklingTime for timezone tz at current time. If no series found for tz, uses UTC.

fromZonedTime :: ZonedTime -> DucklingTime

Builds a DucklingTime from a ZonedTime.

makeReftime :: HashMap Text TimeZoneSeries -> Text -> UTCTime -> DucklingTime

Builds a DucklingTime for timezone tz at utcTime. If no series found for tz, uses UTC.