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

Description

Synopsis

data Search = Search' {
- displayable :: Maybe Bool
- facetable :: Maybe Bool
- searchable :: Maybe Bool
- sortable :: Maybe Bool
}
newSearch :: Search
search_displayable :: Lens' Search (Maybe Bool)
search_facetable :: Lens' Search (Maybe Bool)
search_searchable :: Lens' Search (Maybe Bool)
search_sortable :: Lens' Search (Maybe Bool)

Documentation

data Search Source #

Provides information about how a custom index field is used during a search.

See: newSearch smart constructor.

Constructors

Search'

Fields

displayable :: Maybe Bool
Determines whether the field is returned in the query response. The default is true.
facetable :: Maybe Bool
Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .
searchable :: Maybe Bool
Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.
sortable :: Maybe Bool
Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

Instances

Instances details

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

newSearch :: Search Source #

Create a value of Search 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:displayable:Search', search_displayable - Determines whether the field is returned in the query response. The default is true.

$sel:facetable:Search', search_facetable - Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

$sel:searchable:Search', search_searchable - Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

$sel:sortable:Search', search_sortable - Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.

search_displayable :: Lens' Search (Maybe Bool) Source #

Determines whether the field is returned in the query response. The default is true.

search_facetable :: Lens' Search (Maybe Bool) Source #

Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false .

search_searchable :: Lens' Search (Maybe Bool) Source #

Determines whether the field is used in the search. If the Searchable field is true, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true for string fields and false for number and date fields.

search_sortable :: Lens' Search (Maybe Bool) Source #

Determines whether the field can be used to sort the results of a query. If you specify sorting on a field that does not have Sortable set to true, Amazon Kendra returns an exception. The default is false.