amazonka-kendra-2.0: Amazon KendraFrontendService SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Kendra.Types.TableCell

Description

 
Synopsis

Documentation

data TableCell Source #

Provides information about a table cell in a table excerpt.

See: newTableCell smart constructor.

Constructors

TableCell' 

Fields

  • header :: Maybe Bool

    TRUE means that the table cell should be treated as a header.

  • highlighted :: Maybe Bool

    TRUE means that the table cell has a high enough confidence and is relevant to the query, so the value or content should be highlighted.

  • topAnswer :: Maybe Bool

    TRUE if the response of the table cell is the top answer. This is the cell value or content with the highest confidence score or is the most relevant to the query.

  • value :: Maybe Text

    The actual value or content within a table cell. A table cell could contain a date value of a year, or a string value of text, for example.

Instances

Instances details
FromJSON TableCell Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableCell

Generic TableCell Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableCell

Associated Types

type Rep TableCell :: Type -> Type #

Read TableCell Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableCell

Show TableCell Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableCell

NFData TableCell Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableCell

Methods

rnf :: TableCell -> () #

Eq TableCell Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableCell

Hashable TableCell Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableCell

type Rep TableCell Source # 
Instance details

Defined in Amazonka.Kendra.Types.TableCell

type Rep TableCell = D1 ('MetaData "TableCell" "Amazonka.Kendra.Types.TableCell" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "TableCell'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "header") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "highlighted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "topAnswer") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newTableCell :: TableCell Source #

Create a value of TableCell 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:header:TableCell', tableCell_header - TRUE means that the table cell should be treated as a header.

$sel:highlighted:TableCell', tableCell_highlighted - TRUE means that the table cell has a high enough confidence and is relevant to the query, so the value or content should be highlighted.

$sel:topAnswer:TableCell', tableCell_topAnswer - TRUE if the response of the table cell is the top answer. This is the cell value or content with the highest confidence score or is the most relevant to the query.

$sel:value:TableCell', tableCell_value - The actual value or content within a table cell. A table cell could contain a date value of a year, or a string value of text, for example.

tableCell_header :: Lens' TableCell (Maybe Bool) Source #

TRUE means that the table cell should be treated as a header.

tableCell_highlighted :: Lens' TableCell (Maybe Bool) Source #

TRUE means that the table cell has a high enough confidence and is relevant to the query, so the value or content should be highlighted.

tableCell_topAnswer :: Lens' TableCell (Maybe Bool) Source #

TRUE if the response of the table cell is the top answer. This is the cell value or content with the highest confidence score or is the most relevant to the query.

tableCell_value :: Lens' TableCell (Maybe Text) Source #

The actual value or content within a table cell. A table cell could contain a date value of a year, or a string value of text, for example.