Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kendra.Types.FacetResult

Description

Documentation

data FacetResult Source #

The facet values for the documents in the response.

See: newFacetResult smart constructor.

Constructors

FacetResult'

Fields

documentAttributeKey :: Maybe Text
The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.
documentAttributeValueCountPairs :: Maybe [DocumentAttributeValueCountPair]
An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.
documentAttributeValueType :: Maybe DocumentAttributeValueType
The data type of the facet value. This is the same as the type defined for the index field when it was created.

Instances

Instances details

FromJSON FacetResult Source #
Instance details Defined in Amazonka.Kendra.Types.FacetResult Methods parseJSON :: Value -> Parser FacetResult # parseJSONList :: Value -> Parser [FacetResult] #
Generic FacetResult Source #
Instance details Defined in Amazonka.Kendra.Types.FacetResult Associated Types type Rep FacetResult :: Type -> Type # Methods from :: FacetResult -> Rep FacetResult x # to :: Rep FacetResult x -> FacetResult #
Read FacetResult Source #
Instance details Defined in Amazonka.Kendra.Types.FacetResult Methods readsPrec :: Int -> ReadS FacetResult # readList :: ReadS [FacetResult] # readPrec :: ReadPrec FacetResult # readListPrec :: ReadPrec [FacetResult] #
Show FacetResult Source #
Instance details Defined in Amazonka.Kendra.Types.FacetResult Methods showsPrec :: Int -> FacetResult -> ShowS # show :: FacetResult -> String # showList :: [FacetResult] -> ShowS #
NFData FacetResult Source #
Instance details Defined in Amazonka.Kendra.Types.FacetResult Methods rnf :: FacetResult -> () #
Eq FacetResult Source #
Instance details Defined in Amazonka.Kendra.Types.FacetResult Methods (==) :: FacetResult -> FacetResult -> Bool # (/=) :: FacetResult -> FacetResult -> Bool #
Hashable FacetResult Source #
Instance details Defined in Amazonka.Kendra.Types.FacetResult Methods hashWithSalt :: Int -> FacetResult -> Int # hash :: FacetResult -> Int #
type Rep FacetResult Source #
Instance details Defined in Amazonka.Kendra.Types.FacetResult type Rep FacetResult = D1 ('MetaData "FacetResult" "Amazonka.Kendra.Types.FacetResult" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "FacetResult'" 'PrefixI 'True) (S1 ('MetaSel ('Just "documentAttributeKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "documentAttributeValueCountPairs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentAttributeValueCountPair])) :: S1 ('MetaSel ('Just "documentAttributeValueType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentAttributeValueType)))))

newFacetResult :: FacetResult Source #

Create a value of FacetResult 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:documentAttributeKey:FacetResult', facetResult_documentAttributeKey - The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

$sel:documentAttributeValueCountPairs:FacetResult', facetResult_documentAttributeValueCountPairs - An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

$sel:documentAttributeValueType:FacetResult', facetResult_documentAttributeValueType - The data type of the facet value. This is the same as the type defined for the index field when it was created.

facetResult_documentAttributeKey :: Lens' FacetResult (Maybe Text) Source #

The key for the facet values. This is the same as the DocumentAttributeKey provided in the query.

facetResult_documentAttributeValueCountPairs :: Lens' FacetResult (Maybe [DocumentAttributeValueCountPair]) Source #

An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.

facetResult_documentAttributeValueType :: Lens' FacetResult (Maybe DocumentAttributeValueType) Source #

The data type of the facet value. This is the same as the type defined for the index field when it was created.