2017-03-08 21:33:55 +03:00
|
|
|
-- Copyright (c) 2016-present, Facebook, Inc.
|
|
|
|
-- All rights reserved.
|
|
|
|
--
|
|
|
|
-- This source code is licensed under the BSD-style license found in the
|
2019-05-22 20:36:43 +03:00
|
|
|
-- LICENSE file in the root directory of this source tree.
|
2017-03-08 21:33:55 +03:00
|
|
|
|
|
|
|
|
2018-03-07 21:36:02 +03:00
|
|
|
{-# LANGUAGE NamedFieldPuns #-}
|
2018-04-21 00:08:39 +03:00
|
|
|
{-# LANGUAGE NoRebindableSyntax #-}
|
|
|
|
{-# LANGUAGE RecordWildCards #-}
|
2017-03-08 21:33:55 +03:00
|
|
|
|
|
|
|
module Duckling.Api
|
|
|
|
( analyze
|
|
|
|
, formatToken
|
|
|
|
, parse
|
|
|
|
, supportedDimensions
|
|
|
|
) where
|
|
|
|
|
|
|
|
import Data.HashMap.Strict (HashMap)
|
|
|
|
import Data.HashSet (HashSet)
|
|
|
|
import Data.Text (Text)
|
|
|
|
import Prelude
|
Locales support
Summary:
* Locales support for the library, following `<Lang>_<Region>` with ISO 639-1 code for `<Lang>` and ISO 3166-1 alpha-2 code for `<Region>` (#33)
* `Locale` opaque type (composite of `Lang` and `Region`) with `makeLocale` smart constructor to only allow valid `(Lang, Region)` combinations
* API: `Context`'s `lang` parameter has been replaced by `locale`, with optional `Region` and backward compatibility.
* `Rules/<Lang>.hs` exposes
- `langRules`: cross-locale rules for `<Lang>`, from `<Dimension>/<Lang>/Rules.hs`
- `localeRules`: locale-specific rules, from `<Dimension>/<Lang>/<Region>/Rules.hs`
- `defaultRules`: `langRules` + specific rules from select locales to ensure backward-compatibility
* Corpus, tests & classifiers
- 1 classifier per locale, with default classifier (`<Lang>_XX`) when no locale provided (backward-compatible)
- Default classifiers are built on existing corpus
- Locale classifiers are built on
- `<Dimension>/<Lang>/Corpus.hs` exposes a common `corpus` to all locales of `<Lang>`
- `<Dimension>/<Lang>/<Region>/Corpus.hs` exposes `allExamples`: a list of examples specific to the locale (following `<Dimension>/<Lang>/<Region>/Rules.hs`).
- Locale classifiers use the language corpus extended with the locale examples as training set.
- Locale examples need to use the same `Context` (i.e. reference time) as the language corpus.
- For backward compatibility, `<Dimension>/<Lang>/Corpus.hs` can expose also `defaultCorpus`, which is `corpus` augmented with specific examples. This is controlled by `getDefaultCorpusForLang` in `Duckling.Ranking.Generate`.
- Tests run against each classifier to make sure runtime works as expected.
* MM/DD (en_US) vs DD/MM (en_GB) example to illustrate
Reviewed By: JonCoens, blandinw
Differential Revision: D6038096
fbshipit-source-id: f29c28d
2017-10-13 18:15:32 +03:00
|
|
|
import qualified Data.HashMap.Strict as HashMap
|
|
|
|
import qualified Data.HashSet as HashSet
|
|
|
|
import qualified Data.Text as Text
|
2017-03-08 21:33:55 +03:00
|
|
|
|
|
|
|
import Duckling.Dimensions.Types
|
|
|
|
import Duckling.Dimensions
|
|
|
|
import Duckling.Engine
|
Locales support
Summary:
* Locales support for the library, following `<Lang>_<Region>` with ISO 639-1 code for `<Lang>` and ISO 3166-1 alpha-2 code for `<Region>` (#33)
* `Locale` opaque type (composite of `Lang` and `Region`) with `makeLocale` smart constructor to only allow valid `(Lang, Region)` combinations
* API: `Context`'s `lang` parameter has been replaced by `locale`, with optional `Region` and backward compatibility.
* `Rules/<Lang>.hs` exposes
- `langRules`: cross-locale rules for `<Lang>`, from `<Dimension>/<Lang>/Rules.hs`
- `localeRules`: locale-specific rules, from `<Dimension>/<Lang>/<Region>/Rules.hs`
- `defaultRules`: `langRules` + specific rules from select locales to ensure backward-compatibility
* Corpus, tests & classifiers
- 1 classifier per locale, with default classifier (`<Lang>_XX`) when no locale provided (backward-compatible)
- Default classifiers are built on existing corpus
- Locale classifiers are built on
- `<Dimension>/<Lang>/Corpus.hs` exposes a common `corpus` to all locales of `<Lang>`
- `<Dimension>/<Lang>/<Region>/Corpus.hs` exposes `allExamples`: a list of examples specific to the locale (following `<Dimension>/<Lang>/<Region>/Rules.hs`).
- Locale classifiers use the language corpus extended with the locale examples as training set.
- Locale examples need to use the same `Context` (i.e. reference time) as the language corpus.
- For backward compatibility, `<Dimension>/<Lang>/Corpus.hs` can expose also `defaultCorpus`, which is `corpus` augmented with specific examples. This is controlled by `getDefaultCorpusForLang` in `Duckling.Ranking.Generate`.
- Tests run against each classifier to make sure runtime works as expected.
* MM/DD (en_US) vs DD/MM (en_GB) example to illustrate
Reviewed By: JonCoens, blandinw
Differential Revision: D6038096
fbshipit-source-id: f29c28d
2017-10-13 18:15:32 +03:00
|
|
|
import Duckling.Locale
|
2017-03-08 21:33:55 +03:00
|
|
|
import Duckling.Ranking.Classifiers
|
|
|
|
import Duckling.Ranking.Rank
|
|
|
|
import Duckling.Resolve
|
|
|
|
import Duckling.Rules
|
|
|
|
import Duckling.Types
|
|
|
|
|
|
|
|
-- | Parses `input` and returns a curated list of entities found.
|
2020-09-28 11:31:58 +03:00
|
|
|
parse :: Text -> Context -> Options -> [Seal Dimension] -> [Entity]
|
2018-03-20 00:34:58 +03:00
|
|
|
parse input ctx options = map (formatToken input) . analyze input ctx options .
|
|
|
|
HashSet.fromList
|
2017-03-08 21:33:55 +03:00
|
|
|
|
2020-09-28 11:31:58 +03:00
|
|
|
supportedDimensions :: HashMap Lang [Seal Dimension]
|
2017-03-08 21:33:55 +03:00
|
|
|
supportedDimensions =
|
|
|
|
HashMap.fromList [ (l, allDimensions l) | l <- [minBound..maxBound] ]
|
|
|
|
|
|
|
|
-- | Returns a curated list of resolved tokens found
|
|
|
|
-- When `targets` is non-empty, returns only tokens of such dimensions.
|
2020-09-28 11:31:58 +03:00
|
|
|
analyze :: Text -> Context -> Options -> HashSet (Seal Dimension)
|
2018-03-20 00:34:58 +03:00
|
|
|
-> [ResolvedToken]
|
|
|
|
analyze input context@Context{..} options targets =
|
Locales support
Summary:
* Locales support for the library, following `<Lang>_<Region>` with ISO 639-1 code for `<Lang>` and ISO 3166-1 alpha-2 code for `<Region>` (#33)
* `Locale` opaque type (composite of `Lang` and `Region`) with `makeLocale` smart constructor to only allow valid `(Lang, Region)` combinations
* API: `Context`'s `lang` parameter has been replaced by `locale`, with optional `Region` and backward compatibility.
* `Rules/<Lang>.hs` exposes
- `langRules`: cross-locale rules for `<Lang>`, from `<Dimension>/<Lang>/Rules.hs`
- `localeRules`: locale-specific rules, from `<Dimension>/<Lang>/<Region>/Rules.hs`
- `defaultRules`: `langRules` + specific rules from select locales to ensure backward-compatibility
* Corpus, tests & classifiers
- 1 classifier per locale, with default classifier (`<Lang>_XX`) when no locale provided (backward-compatible)
- Default classifiers are built on existing corpus
- Locale classifiers are built on
- `<Dimension>/<Lang>/Corpus.hs` exposes a common `corpus` to all locales of `<Lang>`
- `<Dimension>/<Lang>/<Region>/Corpus.hs` exposes `allExamples`: a list of examples specific to the locale (following `<Dimension>/<Lang>/<Region>/Rules.hs`).
- Locale classifiers use the language corpus extended with the locale examples as training set.
- Locale examples need to use the same `Context` (i.e. reference time) as the language corpus.
- For backward compatibility, `<Dimension>/<Lang>/Corpus.hs` can expose also `defaultCorpus`, which is `corpus` augmented with specific examples. This is controlled by `getDefaultCorpusForLang` in `Duckling.Ranking.Generate`.
- Tests run against each classifier to make sure runtime works as expected.
* MM/DD (en_US) vs DD/MM (en_GB) example to illustrate
Reviewed By: JonCoens, blandinw
Differential Revision: D6038096
fbshipit-source-id: f29c28d
2017-10-13 18:15:32 +03:00
|
|
|
rank (classifiers locale) targets
|
2018-01-30 03:41:23 +03:00
|
|
|
. filter (\Resolved{node = Node{token = (Token d _)}} ->
|
2020-09-28 11:31:58 +03:00
|
|
|
HashSet.null targets || HashSet.member (Seal d) targets
|
2017-03-08 21:33:55 +03:00
|
|
|
)
|
2018-03-20 00:34:58 +03:00
|
|
|
$ parseAndResolve (rulesFor locale targets) input context options
|
2017-03-08 21:33:55 +03:00
|
|
|
|
|
|
|
-- | Converts the resolved token to the API format
|
|
|
|
formatToken :: Text -> ResolvedToken -> Entity
|
2018-03-07 21:36:02 +03:00
|
|
|
formatToken sentence
|
2018-03-20 00:34:58 +03:00
|
|
|
(Resolved (Range start end) node@Node{token = Token dimension _} value latent)
|
|
|
|
= Entity (toName dimension) body value start end latent node
|
2017-03-08 21:33:55 +03:00
|
|
|
where
|
|
|
|
body = Text.drop start $ Text.take end sentence
|