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.DocumentAttributeValueCountPair

Description

Documentation

data DocumentAttributeValueCountPair Source #

Provides the count of documents that match a particular attribute when doing a faceted search.

See: newDocumentAttributeValueCountPair smart constructor.

Constructors

DocumentAttributeValueCountPair'

Fields

count :: Maybe Int
The number of documents in the response that have the attribute value for the key.
documentAttributeValue :: Maybe DocumentAttributeValue
The value of the attribute. For example, "HR".
facetResults :: Maybe [FacetResult]
Contains the results of a document attribute that is a nested facet. A FacetResult contains the counts for each facet nested within a facet.
For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.

Instances

Instances details

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

newDocumentAttributeValueCountPair :: DocumentAttributeValueCountPair Source #

Create a value of DocumentAttributeValueCountPair 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:count:DocumentAttributeValueCountPair', documentAttributeValueCountPair_count - The number of documents in the response that have the attribute value for the key.

$sel:documentAttributeValue:DocumentAttributeValueCountPair', documentAttributeValueCountPair_documentAttributeValue - The value of the attribute. For example, "HR".

$sel:facetResults:DocumentAttributeValueCountPair', documentAttributeValueCountPair_facetResults - Contains the results of a document attribute that is a nested facet. A FacetResult contains the counts for each facet nested within a facet.

For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.

documentAttributeValueCountPair_count :: Lens' DocumentAttributeValueCountPair (Maybe Int) Source #

The number of documents in the response that have the attribute value for the key.

documentAttributeValueCountPair_documentAttributeValue :: Lens' DocumentAttributeValueCountPair (Maybe DocumentAttributeValue) Source #

The value of the attribute. For example, "HR".

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

Contains the results of a document attribute that is a nested facet. A FacetResult contains the counts for each facet nested within a facet.

For example, the document attribute or facet "Department" includes a value called "Engineering". In addition, the document attribute or facet "SubDepartment" includes the values "Frontend" and "Backend" for documents assigned to "Engineering". You can display nested facets in the search results so that documents can be searched not only by department but also by a sub department within a department. The counts for documents that belong to "Frontend" and "Backend" within "Engineering" are returned for a query.