Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.VoiceId.EvaluateSession

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.

Synopsis

data EvaluateSession = EvaluateSession' {
- domainId :: Text
- sessionNameOrId :: Text
}
newEvaluateSession :: Text -> Text -> EvaluateSession
evaluateSession_domainId :: Lens' EvaluateSession Text
evaluateSession_sessionNameOrId :: Lens' EvaluateSession Text
data EvaluateSessionResponse = EvaluateSessionResponse' {
- fraudDetectionResult :: Maybe FraudDetectionResult
- streamingStatus :: Maybe StreamingStatus
- authenticationResult :: Maybe AuthenticationResult
- domainId :: Maybe Text
- sessionId :: Maybe Text
- sessionName :: Maybe Text
- httpStatus :: Int
}
newEvaluateSessionResponse :: Int -> EvaluateSessionResponse
evaluateSessionResponse_fraudDetectionResult :: Lens' EvaluateSessionResponse (Maybe FraudDetectionResult)
evaluateSessionResponse_streamingStatus :: Lens' EvaluateSessionResponse (Maybe StreamingStatus)
evaluateSessionResponse_authenticationResult :: Lens' EvaluateSessionResponse (Maybe AuthenticationResult)
evaluateSessionResponse_domainId :: Lens' EvaluateSessionResponse (Maybe Text)
evaluateSessionResponse_sessionId :: Lens' EvaluateSessionResponse (Maybe Text)
evaluateSessionResponse_sessionName :: Lens' EvaluateSessionResponse (Maybe Text)
evaluateSessionResponse_httpStatus :: Lens' EvaluateSessionResponse Int

Creating a Request

data EvaluateSession Source #

See: newEvaluateSession smart constructor.

Constructors

EvaluateSession'
Fields domainId :: Text The identifier of the domain where the session started. sessionNameOrId :: Text The session identifier, or name of the session, that you want to evaluate. In Voice ID integration, this is the Contact-Id.

Instances

Instances details

Eq EvaluateSession Source #
Instance details Defined in Amazonka.VoiceId.EvaluateSession Methods (==) :: EvaluateSession -> EvaluateSession -> Bool # (/=) :: EvaluateSession -> EvaluateSession -> Bool #
Read EvaluateSession Source #
Instance details Defined in Amazonka.VoiceId.EvaluateSession Methods readsPrec :: Int -> ReadS EvaluateSession # readList :: ReadS [EvaluateSession] # readPrec :: ReadPrec EvaluateSession # readListPrec :: ReadPrec [EvaluateSession] #
Show EvaluateSession Source #
Instance details Defined in Amazonka.VoiceId.EvaluateSession Methods showsPrec :: Int -> EvaluateSession -> ShowS # show :: EvaluateSession -> String # showList :: [EvaluateSession] -> ShowS #
Generic EvaluateSession Source #
Instance details Defined in Amazonka.VoiceId.EvaluateSession Associated Types type Rep EvaluateSession :: Type -> Type # Methods from :: EvaluateSession -> Rep EvaluateSession x # to :: Rep EvaluateSession x -> EvaluateSession #
NFData EvaluateSession Source #
Instance details Defined in Amazonka.VoiceId.EvaluateSession Methods rnf :: EvaluateSession -> () #
Hashable EvaluateSession Source #
Instance details Defined in Amazonka.VoiceId.EvaluateSession Methods hashWithSalt :: Int -> EvaluateSession -> Int # hash :: EvaluateSession -> Int #
ToJSON EvaluateSession Source #
Instance details Defined in Amazonka.VoiceId.EvaluateSession Methods toJSON :: EvaluateSession -> Value # toEncoding :: EvaluateSession -> Encoding # toJSONList :: [EvaluateSession] -> Value # toEncodingList :: [EvaluateSession] -> Encoding #
AWSRequest EvaluateSession Source #
Instance details Defined in Amazonka.VoiceId.EvaluateSession Associated Types type AWSResponse EvaluateSession # Methods request :: EvaluateSession -> Request EvaluateSession # response :: MonadResource m => Logger -> Service -> Proxy EvaluateSession -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse EvaluateSession))) #
ToHeaders EvaluateSession Source #
Instance details Defined in Amazonka.VoiceId.EvaluateSession Methods toHeaders :: EvaluateSession -> [Header] #
ToPath EvaluateSession Source #
Instance details Defined in Amazonka.VoiceId.EvaluateSession Methods toPath :: EvaluateSession -> ByteString #
ToQuery EvaluateSession Source #
Instance details Defined in Amazonka.VoiceId.EvaluateSession Methods toQuery :: EvaluateSession -> QueryString #
type Rep EvaluateSession Source #
Instance details Defined in Amazonka.VoiceId.EvaluateSession type Rep EvaluateSession = D1 ('MetaData "EvaluateSession" "Amazonka.VoiceId.EvaluateSession" "libZSservicesZSamazonka-voice-idZSamazonka-voice-id" 'False) (C1 ('MetaCons "EvaluateSession'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sessionNameOrId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse EvaluateSession Source #
Instance details Defined in Amazonka.VoiceId.EvaluateSession type AWSResponse EvaluateSession = EvaluateSessionResponse

newEvaluateSession Source #

Arguments

:: Text	`$sel:domainId:EvaluateSession'`
-> Text	`$sel:sessionNameOrId:EvaluateSession'`
-> EvaluateSession

Create a value of EvaluateSession 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:domainId:EvaluateSession', evaluateSession_domainId - The identifier of the domain where the session started.

$sel:sessionNameOrId:EvaluateSession', evaluateSession_sessionNameOrId - The session identifier, or name of the session, that you want to evaluate. In Voice ID integration, this is the Contact-Id.

Request Lenses

evaluateSession_domainId :: Lens' EvaluateSession Text Source #

The identifier of the domain where the session started.

evaluateSession_sessionNameOrId :: Lens' EvaluateSession Text Source #

The session identifier, or name of the session, that you want to evaluate. In Voice ID integration, this is the Contact-Id.

Destructuring the Response

data EvaluateSessionResponse Source #

See: newEvaluateSessionResponse smart constructor.

Constructors

EvaluateSessionResponse'

Fields

fraudDetectionResult :: Maybe FraudDetectionResult
Details resulting from the fraud detection process, such as fraud detection decision and risk score.
streamingStatus :: Maybe StreamingStatus
The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call the API again later, once Voice ID has enough audio to produce a result. If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.
authenticationResult :: Maybe AuthenticationResult
Details resulting from the authentication process, such as authentication decision and authentication score.
domainId :: Maybe Text
The identifier of the domain containing the session.
sessionId :: Maybe Text
The service-generated identifier of the session.
sessionName :: Maybe Text
The client-provided name of the session.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq EvaluateSessionResponse Source #
Instance details Defined in Amazonka.VoiceId.EvaluateSession Methods (==) :: EvaluateSessionResponse -> EvaluateSessionResponse -> Bool # (/=) :: EvaluateSessionResponse -> EvaluateSessionResponse -> Bool #
Show EvaluateSessionResponse Source #
Instance details Defined in Amazonka.VoiceId.EvaluateSession Methods showsPrec :: Int -> EvaluateSessionResponse -> ShowS # show :: EvaluateSessionResponse -> String # showList :: [EvaluateSessionResponse] -> ShowS #
Generic EvaluateSessionResponse Source #
Instance details Defined in Amazonka.VoiceId.EvaluateSession Associated Types type Rep EvaluateSessionResponse :: Type -> Type # Methods from :: EvaluateSessionResponse -> Rep EvaluateSessionResponse x # to :: Rep EvaluateSessionResponse x -> EvaluateSessionResponse #
NFData EvaluateSessionResponse Source #
Instance details Defined in Amazonka.VoiceId.EvaluateSession Methods rnf :: EvaluateSessionResponse -> () #
type Rep EvaluateSessionResponse Source #
Instance details Defined in Amazonka.VoiceId.EvaluateSession type Rep EvaluateSessionResponse = D1 ('MetaData "EvaluateSessionResponse" "Amazonka.VoiceId.EvaluateSession" "libZSservicesZSamazonka-voice-idZSamazonka-voice-id" 'False) (C1 ('MetaCons "EvaluateSessionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "fraudDetectionResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FraudDetectionResult)) :: (S1 ('MetaSel ('Just "streamingStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamingStatus)) :: S1 ('MetaSel ('Just "authenticationResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationResult)))) :: ((S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sessionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newEvaluateSessionResponse Source #

Arguments

:: Int	`$sel:httpStatus:EvaluateSessionResponse'`
-> EvaluateSessionResponse

Create a value of EvaluateSessionResponse 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:fraudDetectionResult:EvaluateSessionResponse', evaluateSessionResponse_fraudDetectionResult - Details resulting from the fraud detection process, such as fraud detection decision and risk score.

$sel:streamingStatus:EvaluateSessionResponse', evaluateSessionResponse_streamingStatus - The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call the API again later, once Voice ID has enough audio to produce a result. If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.

$sel:authenticationResult:EvaluateSessionResponse', evaluateSessionResponse_authenticationResult - Details resulting from the authentication process, such as authentication decision and authentication score.

$sel:domainId:EvaluateSession', evaluateSessionResponse_domainId - The identifier of the domain containing the session.

$sel:sessionId:EvaluateSessionResponse', evaluateSessionResponse_sessionId - The service-generated identifier of the session.

$sel:sessionName:EvaluateSessionResponse', evaluateSessionResponse_sessionName - The client-provided name of the session.

$sel:httpStatus:EvaluateSessionResponse', evaluateSessionResponse_httpStatus - The response's http status code.

Response Lenses

evaluateSessionResponse_fraudDetectionResult :: Lens' EvaluateSessionResponse (Maybe FraudDetectionResult) Source #

Details resulting from the fraud detection process, such as fraud detection decision and risk score.

evaluateSessionResponse_streamingStatus :: Lens' EvaluateSessionResponse (Maybe StreamingStatus) Source #

The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call the API again later, once Voice ID has enough audio to produce a result. If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.

evaluateSessionResponse_authenticationResult :: Lens' EvaluateSessionResponse (Maybe AuthenticationResult) Source #

Details resulting from the authentication process, such as authentication decision and authentication score.

evaluateSessionResponse_domainId :: Lens' EvaluateSessionResponse (Maybe Text) Source #

The identifier of the domain containing the session.

evaluateSessionResponse_sessionId :: Lens' EvaluateSessionResponse (Maybe Text) Source #

The service-generated identifier of the session.

evaluateSessionResponse_sessionName :: Lens' EvaluateSessionResponse (Maybe Text) Source #

The client-provided name of the session.

evaluateSessionResponse_httpStatus :: Lens' EvaluateSessionResponse Int Source #

The response's http status code.