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 |
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' {}
- newEvaluateSessionResponse :: Int -> EvaluateSessionResponse
- evaluateSessionResponse_authenticationResult :: Lens' EvaluateSessionResponse (Maybe AuthenticationResult)
- evaluateSessionResponse_domainId :: Lens' EvaluateSessionResponse (Maybe Text)
- evaluateSessionResponse_fraudDetectionResult :: Lens' EvaluateSessionResponse (Maybe FraudDetectionResult)
- evaluateSessionResponse_sessionId :: Lens' EvaluateSessionResponse (Maybe Text)
- evaluateSessionResponse_sessionName :: Lens' EvaluateSessionResponse (Maybe Text)
- evaluateSessionResponse_streamingStatus :: Lens' EvaluateSessionResponse (Maybe StreamingStatus)
- evaluateSessionResponse_httpStatus :: Lens' EvaluateSessionResponse Int
Creating a Request
data EvaluateSession Source #
See: newEvaluateSession
smart constructor.
EvaluateSession' | |
|
Instances
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:
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.
EvaluateSessionResponse' | |
|
Instances
newEvaluateSessionResponse Source #
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:authenticationResult:EvaluateSessionResponse'
, evaluateSessionResponse_authenticationResult
- Details resulting from the authentication process, such as
authentication decision and authentication score.
EvaluateSession
, evaluateSessionResponse_domainId
- The identifier of the domain containing the session.
$sel:fraudDetectionResult:EvaluateSessionResponse'
, evaluateSessionResponse_fraudDetectionResult
- Details resulting from the fraud detection process, such as fraud
detection decision and risk score.
$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: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, after 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:httpStatus:EvaluateSessionResponse'
, evaluateSessionResponse_httpStatus
- The response's http status code.
Response Lenses
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_fraudDetectionResult :: Lens' EvaluateSessionResponse (Maybe FraudDetectionResult) Source #
Details resulting from the fraud detection process, such as fraud detection decision and risk score.
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_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, after 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_httpStatus :: Lens' EvaluateSessionResponse Int Source #
The response's http status code.