{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.Comprehend.Types.SyntaxToken
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.Comprehend.Types.SyntaxToken where

import Amazonka.Comprehend.Types.PartOfSpeechTag
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude

-- | Represents a work in the input text that was recognized and assigned a
-- part of speech. There is one syntax token record for each word in the
-- source text.
--
-- /See:/ 'newSyntaxToken' smart constructor.
data SyntaxToken = SyntaxToken'
  { -- | The zero-based offset from the beginning of the source text to the first
    -- character in the word.
    SyntaxToken -> Maybe Int
beginOffset :: Prelude.Maybe Prelude.Int,
    -- | The zero-based offset from the beginning of the source text to the last
    -- character in the word.
    SyntaxToken -> Maybe Int
endOffset :: Prelude.Maybe Prelude.Int,
    -- | Provides the part of speech label and the confidence level that Amazon
    -- Comprehend has that the part of speech was correctly identified. For
    -- more information, see
    -- <https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html Syntax>
    -- in the Comprehend Developer Guide.
    SyntaxToken -> Maybe PartOfSpeechTag
partOfSpeech :: Prelude.Maybe PartOfSpeechTag,
    -- | The word that was recognized in the source text.
    SyntaxToken -> Maybe Text
text :: Prelude.Maybe Prelude.Text,
    -- | A unique identifier for a token.
    SyntaxToken -> Maybe Int
tokenId :: Prelude.Maybe Prelude.Int
  }
  deriving (SyntaxToken -> SyntaxToken -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: SyntaxToken -> SyntaxToken -> Bool
$c/= :: SyntaxToken -> SyntaxToken -> Bool
== :: SyntaxToken -> SyntaxToken -> Bool
$c== :: SyntaxToken -> SyntaxToken -> Bool
Prelude.Eq, ReadPrec [SyntaxToken]
ReadPrec SyntaxToken
Int -> ReadS SyntaxToken
ReadS [SyntaxToken]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [SyntaxToken]
$creadListPrec :: ReadPrec [SyntaxToken]
readPrec :: ReadPrec SyntaxToken
$creadPrec :: ReadPrec SyntaxToken
readList :: ReadS [SyntaxToken]
$creadList :: ReadS [SyntaxToken]
readsPrec :: Int -> ReadS SyntaxToken
$creadsPrec :: Int -> ReadS SyntaxToken
Prelude.Read, Int -> SyntaxToken -> ShowS
[SyntaxToken] -> ShowS
SyntaxToken -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [SyntaxToken] -> ShowS
$cshowList :: [SyntaxToken] -> ShowS
show :: SyntaxToken -> String
$cshow :: SyntaxToken -> String
showsPrec :: Int -> SyntaxToken -> ShowS
$cshowsPrec :: Int -> SyntaxToken -> ShowS
Prelude.Show, forall x. Rep SyntaxToken x -> SyntaxToken
forall x. SyntaxToken -> Rep SyntaxToken x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep SyntaxToken x -> SyntaxToken
$cfrom :: forall x. SyntaxToken -> Rep SyntaxToken x
Prelude.Generic)

-- |
-- Create a value of 'SyntaxToken' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'beginOffset', 'syntaxToken_beginOffset' - The zero-based offset from the beginning of the source text to the first
-- character in the word.
--
-- 'endOffset', 'syntaxToken_endOffset' - The zero-based offset from the beginning of the source text to the last
-- character in the word.
--
-- 'partOfSpeech', 'syntaxToken_partOfSpeech' - Provides the part of speech label and the confidence level that Amazon
-- Comprehend has that the part of speech was correctly identified. For
-- more information, see
-- <https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html Syntax>
-- in the Comprehend Developer Guide.
--
-- 'text', 'syntaxToken_text' - The word that was recognized in the source text.
--
-- 'tokenId', 'syntaxToken_tokenId' - A unique identifier for a token.
newSyntaxToken ::
  SyntaxToken
newSyntaxToken :: SyntaxToken
newSyntaxToken =
  SyntaxToken'
    { $sel:beginOffset:SyntaxToken' :: Maybe Int
beginOffset = forall a. Maybe a
Prelude.Nothing,
      $sel:endOffset:SyntaxToken' :: Maybe Int
endOffset = forall a. Maybe a
Prelude.Nothing,
      $sel:partOfSpeech:SyntaxToken' :: Maybe PartOfSpeechTag
partOfSpeech = forall a. Maybe a
Prelude.Nothing,
      $sel:text:SyntaxToken' :: Maybe Text
text = forall a. Maybe a
Prelude.Nothing,
      $sel:tokenId:SyntaxToken' :: Maybe Int
tokenId = forall a. Maybe a
Prelude.Nothing
    }

-- | The zero-based offset from the beginning of the source text to the first
-- character in the word.
syntaxToken_beginOffset :: Lens.Lens' SyntaxToken (Prelude.Maybe Prelude.Int)
syntaxToken_beginOffset :: Lens' SyntaxToken (Maybe Int)
syntaxToken_beginOffset = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SyntaxToken' {Maybe Int
beginOffset :: Maybe Int
$sel:beginOffset:SyntaxToken' :: SyntaxToken -> Maybe Int
beginOffset} -> Maybe Int
beginOffset) (\s :: SyntaxToken
s@SyntaxToken' {} Maybe Int
a -> SyntaxToken
s {$sel:beginOffset:SyntaxToken' :: Maybe Int
beginOffset = Maybe Int
a} :: SyntaxToken)

-- | The zero-based offset from the beginning of the source text to the last
-- character in the word.
syntaxToken_endOffset :: Lens.Lens' SyntaxToken (Prelude.Maybe Prelude.Int)
syntaxToken_endOffset :: Lens' SyntaxToken (Maybe Int)
syntaxToken_endOffset = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SyntaxToken' {Maybe Int
endOffset :: Maybe Int
$sel:endOffset:SyntaxToken' :: SyntaxToken -> Maybe Int
endOffset} -> Maybe Int
endOffset) (\s :: SyntaxToken
s@SyntaxToken' {} Maybe Int
a -> SyntaxToken
s {$sel:endOffset:SyntaxToken' :: Maybe Int
endOffset = Maybe Int
a} :: SyntaxToken)

-- | Provides the part of speech label and the confidence level that Amazon
-- Comprehend has that the part of speech was correctly identified. For
-- more information, see
-- <https://docs.aws.amazon.com/comprehend/latest/dg/how-syntax.html Syntax>
-- in the Comprehend Developer Guide.
syntaxToken_partOfSpeech :: Lens.Lens' SyntaxToken (Prelude.Maybe PartOfSpeechTag)
syntaxToken_partOfSpeech :: Lens' SyntaxToken (Maybe PartOfSpeechTag)
syntaxToken_partOfSpeech = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SyntaxToken' {Maybe PartOfSpeechTag
partOfSpeech :: Maybe PartOfSpeechTag
$sel:partOfSpeech:SyntaxToken' :: SyntaxToken -> Maybe PartOfSpeechTag
partOfSpeech} -> Maybe PartOfSpeechTag
partOfSpeech) (\s :: SyntaxToken
s@SyntaxToken' {} Maybe PartOfSpeechTag
a -> SyntaxToken
s {$sel:partOfSpeech:SyntaxToken' :: Maybe PartOfSpeechTag
partOfSpeech = Maybe PartOfSpeechTag
a} :: SyntaxToken)

-- | The word that was recognized in the source text.
syntaxToken_text :: Lens.Lens' SyntaxToken (Prelude.Maybe Prelude.Text)
syntaxToken_text :: Lens' SyntaxToken (Maybe Text)
syntaxToken_text = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SyntaxToken' {Maybe Text
text :: Maybe Text
$sel:text:SyntaxToken' :: SyntaxToken -> Maybe Text
text} -> Maybe Text
text) (\s :: SyntaxToken
s@SyntaxToken' {} Maybe Text
a -> SyntaxToken
s {$sel:text:SyntaxToken' :: Maybe Text
text = Maybe Text
a} :: SyntaxToken)

-- | A unique identifier for a token.
syntaxToken_tokenId :: Lens.Lens' SyntaxToken (Prelude.Maybe Prelude.Int)
syntaxToken_tokenId :: Lens' SyntaxToken (Maybe Int)
syntaxToken_tokenId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SyntaxToken' {Maybe Int
tokenId :: Maybe Int
$sel:tokenId:SyntaxToken' :: SyntaxToken -> Maybe Int
tokenId} -> Maybe Int
tokenId) (\s :: SyntaxToken
s@SyntaxToken' {} Maybe Int
a -> SyntaxToken
s {$sel:tokenId:SyntaxToken' :: Maybe Int
tokenId = Maybe Int
a} :: SyntaxToken)

instance Data.FromJSON SyntaxToken where
  parseJSON :: Value -> Parser SyntaxToken
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"SyntaxToken"
      ( \Object
x ->
          Maybe Int
-> Maybe Int
-> Maybe PartOfSpeechTag
-> Maybe Text
-> Maybe Int
-> SyntaxToken
SyntaxToken'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"BeginOffset")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"EndOffset")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"PartOfSpeech")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Text")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"TokenId")
      )

instance Prelude.Hashable SyntaxToken where
  hashWithSalt :: Int -> SyntaxToken -> Int
hashWithSalt Int
_salt SyntaxToken' {Maybe Int
Maybe Text
Maybe PartOfSpeechTag
tokenId :: Maybe Int
text :: Maybe Text
partOfSpeech :: Maybe PartOfSpeechTag
endOffset :: Maybe Int
beginOffset :: Maybe Int
$sel:tokenId:SyntaxToken' :: SyntaxToken -> Maybe Int
$sel:text:SyntaxToken' :: SyntaxToken -> Maybe Text
$sel:partOfSpeech:SyntaxToken' :: SyntaxToken -> Maybe PartOfSpeechTag
$sel:endOffset:SyntaxToken' :: SyntaxToken -> Maybe Int
$sel:beginOffset:SyntaxToken' :: SyntaxToken -> Maybe Int
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
beginOffset
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
endOffset
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe PartOfSpeechTag
partOfSpeech
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
text
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
tokenId

instance Prelude.NFData SyntaxToken where
  rnf :: SyntaxToken -> ()
rnf SyntaxToken' {Maybe Int
Maybe Text
Maybe PartOfSpeechTag
tokenId :: Maybe Int
text :: Maybe Text
partOfSpeech :: Maybe PartOfSpeechTag
endOffset :: Maybe Int
beginOffset :: Maybe Int
$sel:tokenId:SyntaxToken' :: SyntaxToken -> Maybe Int
$sel:text:SyntaxToken' :: SyntaxToken -> Maybe Text
$sel:partOfSpeech:SyntaxToken' :: SyntaxToken -> Maybe PartOfSpeechTag
$sel:endOffset:SyntaxToken' :: SyntaxToken -> Maybe Int
$sel:beginOffset:SyntaxToken' :: SyntaxToken -> Maybe Int
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
beginOffset
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
endOffset
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe PartOfSpeechTag
partOfSpeech
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
text
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
tokenId