Amazonka.Textract.Types.Query

Documentation

data Query

Each query contains the question you want to ask in the Text and the alias you want to associate.

See: newQuery smart constructor.

Constructors

Query'

Fields

• alias :: Maybe Text

  Alias attached to the query, for ease of location.

• pages :: Maybe (NonEmpty Text)

  Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.

  • If a page is not specified, it is set to ["1"] by default.
  • The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.
  • When using * to indicate all pages, it must be the only element in the list.
  • You can use page intervals, such as [“1-3”, “1-1”, “4-*”]. Where * indicates last page of document.
  • Specified pages must be greater than 0 and less than or equal to the number of pages in the document.
• text :: Text

  Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"

Instances

FromJSON Query

Defined in Amazonka.Textract.Types.Query

Methods

parseJSON :: Value -> Parser Query

parseJSONList :: Value -> Parser [Query]

ToJSON Query

Defined in Amazonka.Textract.Types.Query

Methods

toJSON :: Query -> Value

toEncoding :: Query -> Encoding

toJSONList :: [Query] -> Value

toEncodingList :: [Query] -> Encoding

Generic Query

Defined in Amazonka.Textract.Types.Query

Associated Types

type Rep Query :: Type -> Type

Methods

from :: Query -> Rep Query x

to :: Rep Query x -> Query

Read Query

Defined in Amazonka.Textract.Types.Query

Methods

readsPrec :: Int -> ReadS Query

readList :: ReadS [Query]

readPrec :: ReadPrec Query

readListPrec :: ReadPrec [Query]

Show Query

Defined in Amazonka.Textract.Types.Query

Methods

showsPrec :: Int -> Query -> ShowS

show :: Query -> String

showList :: [Query] -> ShowS

NFData Query

Defined in Amazonka.Textract.Types.Query

Methods

rnf :: Query -> ()

Eq Query

Defined in Amazonka.Textract.Types.Query

Methods

(==) :: Query -> Query -> Bool

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

Hashable Query

Defined in Amazonka.Textract.Types.Query

Methods

hashWithSalt :: Int -> Query -> Int

hash :: Query -> Int

type Rep Query

Defined in Amazonka.Textract.Types.Query

type Rep Query = D1 ('MetaData "Query" "Amazonka.Textract.Types.Query" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "Query'" 'PrefixI 'True) (S1 ('MetaSel ('Just "alias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "pages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :*: S1 ('MetaSel ('Just "text") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newQuery

Arguments

:: Text

$sel:text:Query'

-> Query

Create a value of Query with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:alias:Query', query_alias - Alias attached to the query, for ease of location.

$sel:pages:Query', query_pages - Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.

• If a page is not specified, it is set to ["1"] by default.
• The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.
• When using * to indicate all pages, it must be the only element in the list.
• You can use page intervals, such as [“1-3”, “1-1”, “4-*”]. Where * indicates last page of document.
• Specified pages must be greater than 0 and less than or equal to the number of pages in the document.

$sel:text:Query', query_text - Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"

query_alias :: Lens' Query (Maybe Text)

Alias attached to the query, for ease of location.

query_pages :: Lens' Query (Maybe (NonEmpty Text))

Pages is a parameter that the user inputs to specify which pages to apply a query to. The following is a list of rules for using this parameter.

• If a page is not specified, it is set to ["1"] by default.
• The following characters are allowed in the parameter's string: 0 1 2 3 4 5 6 7 8 9 - *. No whitespace is allowed.
• When using * to indicate all pages, it must be the only element in the list.
• You can use page intervals, such as [“1-3”, “1-1”, “4-*”]. Where * indicates last page of document.
• Specified pages must be greater than 0 and less than or equal to the number of pages in the document.

query_text :: Lens' Query Text

Question that Amazon Textract will apply to the document. An example would be "What is the customer's SSN?"