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

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Enables you to provide feedback to Amazon Kendra to improve the performance of your index.

SubmitFeedback is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Creating a Request

data SubmitFeedback Source #

See: newSubmitFeedback smart constructor.

Constructors

SubmitFeedback'

Fields

clickFeedbackItems :: Maybe [ClickFeedback]
Tells Amazon Kendra that a particular search result link was chosen by the user.
relevanceFeedbackItems :: Maybe [RelevanceFeedback]
Provides Amazon Kendra with relevant or not relevant feedback for whether a particular item was relevant to the search.
indexId :: Text
The identifier of the index that was queried.
queryId :: Text
The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the Query API.

Instances

Instances details

ToJSON SubmitFeedback Source #
Instance details Defined in Amazonka.Kendra.SubmitFeedback Methods toJSON :: SubmitFeedback -> Value # toEncoding :: SubmitFeedback -> Encoding # toJSONList :: [SubmitFeedback] -> Value # toEncodingList :: [SubmitFeedback] -> Encoding #
ToHeaders SubmitFeedback Source #
Instance details Defined in Amazonka.Kendra.SubmitFeedback Methods toHeaders :: SubmitFeedback -> [Header] #
ToPath SubmitFeedback Source #
Instance details Defined in Amazonka.Kendra.SubmitFeedback Methods toPath :: SubmitFeedback -> ByteString #
ToQuery SubmitFeedback Source #
Instance details Defined in Amazonka.Kendra.SubmitFeedback Methods toQuery :: SubmitFeedback -> QueryString #
AWSRequest SubmitFeedback Source #
Instance details Defined in Amazonka.Kendra.SubmitFeedback Associated Types type AWSResponse SubmitFeedback # Methods request :: (Service -> Service) -> SubmitFeedback -> Request SubmitFeedback # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SubmitFeedback -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SubmitFeedback))) #
Generic SubmitFeedback Source #
Instance details Defined in Amazonka.Kendra.SubmitFeedback Associated Types type Rep SubmitFeedback :: Type -> Type # Methods from :: SubmitFeedback -> Rep SubmitFeedback x # to :: Rep SubmitFeedback x -> SubmitFeedback #
Read SubmitFeedback Source #
Instance details Defined in Amazonka.Kendra.SubmitFeedback Methods readsPrec :: Int -> ReadS SubmitFeedback # readList :: ReadS [SubmitFeedback] # readPrec :: ReadPrec SubmitFeedback # readListPrec :: ReadPrec [SubmitFeedback] #
Show SubmitFeedback Source #
Instance details Defined in Amazonka.Kendra.SubmitFeedback Methods showsPrec :: Int -> SubmitFeedback -> ShowS # show :: SubmitFeedback -> String # showList :: [SubmitFeedback] -> ShowS #
NFData SubmitFeedback Source #
Instance details Defined in Amazonka.Kendra.SubmitFeedback Methods rnf :: SubmitFeedback -> () #
Eq SubmitFeedback Source #
Instance details Defined in Amazonka.Kendra.SubmitFeedback Methods (==) :: SubmitFeedback -> SubmitFeedback -> Bool # (/=) :: SubmitFeedback -> SubmitFeedback -> Bool #
Hashable SubmitFeedback Source #
Instance details Defined in Amazonka.Kendra.SubmitFeedback Methods hashWithSalt :: Int -> SubmitFeedback -> Int # hash :: SubmitFeedback -> Int #
type AWSResponse SubmitFeedback Source #
Instance details Defined in Amazonka.Kendra.SubmitFeedback type AWSResponse SubmitFeedback = SubmitFeedbackResponse
type Rep SubmitFeedback Source #
Instance details Defined in Amazonka.Kendra.SubmitFeedback type Rep SubmitFeedback = D1 ('MetaData "SubmitFeedback" "Amazonka.Kendra.SubmitFeedback" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SubmitFeedback'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clickFeedbackItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ClickFeedback])) :: S1 ('MetaSel ('Just "relevanceFeedbackItems") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RelevanceFeedback]))) :: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "queryId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSubmitFeedback Source #

Arguments

:: Text	`$sel:indexId:SubmitFeedback'`
-> Text	`$sel:queryId:SubmitFeedback'`
-> SubmitFeedback

Create a value of SubmitFeedback 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:clickFeedbackItems:SubmitFeedback', submitFeedback_clickFeedbackItems - Tells Amazon Kendra that a particular search result link was chosen by the user.

$sel:relevanceFeedbackItems:SubmitFeedback', submitFeedback_relevanceFeedbackItems - Provides Amazon Kendra with relevant or not relevant feedback for whether a particular item was relevant to the search.

$sel:indexId:SubmitFeedback', submitFeedback_indexId - The identifier of the index that was queried.

$sel:queryId:SubmitFeedback', submitFeedback_queryId - The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the Query API.

Request Lenses

submitFeedback_clickFeedbackItems :: Lens' SubmitFeedback (Maybe [ClickFeedback]) Source #

Tells Amazon Kendra that a particular search result link was chosen by the user.

submitFeedback_relevanceFeedbackItems :: Lens' SubmitFeedback (Maybe [RelevanceFeedback]) Source #

Provides Amazon Kendra with relevant or not relevant feedback for whether a particular item was relevant to the search.

submitFeedback_indexId :: Lens' SubmitFeedback Text Source #

The identifier of the index that was queried.

submitFeedback_queryId :: Lens' SubmitFeedback Text Source #

The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the Query API.

Destructuring the Response

data SubmitFeedbackResponse Source #

See: newSubmitFeedbackResponse smart constructor.

Constructors

SubmitFeedbackResponse'

Instances

Instances details

Generic SubmitFeedbackResponse Source #
Instance details Defined in Amazonka.Kendra.SubmitFeedback Associated Types type Rep SubmitFeedbackResponse :: Type -> Type # Methods from :: SubmitFeedbackResponse -> Rep SubmitFeedbackResponse x # to :: Rep SubmitFeedbackResponse x -> SubmitFeedbackResponse #
Read SubmitFeedbackResponse Source #
Instance details Defined in Amazonka.Kendra.SubmitFeedback Methods readsPrec :: Int -> ReadS SubmitFeedbackResponse # readList :: ReadS [SubmitFeedbackResponse] # readPrec :: ReadPrec SubmitFeedbackResponse # readListPrec :: ReadPrec [SubmitFeedbackResponse] #
Show SubmitFeedbackResponse Source #
Instance details Defined in Amazonka.Kendra.SubmitFeedback Methods showsPrec :: Int -> SubmitFeedbackResponse -> ShowS # show :: SubmitFeedbackResponse -> String # showList :: [SubmitFeedbackResponse] -> ShowS #
NFData SubmitFeedbackResponse Source #
Instance details Defined in Amazonka.Kendra.SubmitFeedback Methods rnf :: SubmitFeedbackResponse -> () #
Eq SubmitFeedbackResponse Source #
Instance details Defined in Amazonka.Kendra.SubmitFeedback Methods (==) :: SubmitFeedbackResponse -> SubmitFeedbackResponse -> Bool # (/=) :: SubmitFeedbackResponse -> SubmitFeedbackResponse -> Bool #
type Rep SubmitFeedbackResponse Source #
Instance details Defined in Amazonka.Kendra.SubmitFeedback type Rep SubmitFeedbackResponse = D1 ('MetaData "SubmitFeedbackResponse" "Amazonka.Kendra.SubmitFeedback" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "SubmitFeedbackResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newSubmitFeedbackResponse :: SubmitFeedbackResponse Source #

Create a value of SubmitFeedbackResponse with all optional fields omitted.

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