amazonka-voice-id-2.0: Amazon Voice ID SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.VoiceId.EvaluateSession

Description

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

Synopsis

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
ToJSON EvaluateSession Source # 
Instance details

Defined in Amazonka.VoiceId.EvaluateSession

ToHeaders EvaluateSession Source # 
Instance details

Defined in Amazonka.VoiceId.EvaluateSession

ToPath EvaluateSession Source # 
Instance details

Defined in Amazonka.VoiceId.EvaluateSession

ToQuery EvaluateSession Source # 
Instance details

Defined in Amazonka.VoiceId.EvaluateSession

AWSRequest EvaluateSession Source # 
Instance details

Defined in Amazonka.VoiceId.EvaluateSession

Associated Types

type AWSResponse EvaluateSession #

Generic EvaluateSession Source # 
Instance details

Defined in Amazonka.VoiceId.EvaluateSession

Associated Types

type Rep EvaluateSession :: Type -> Type #

Read EvaluateSession Source # 
Instance details

Defined in Amazonka.VoiceId.EvaluateSession

Show EvaluateSession Source # 
Instance details

Defined in Amazonka.VoiceId.EvaluateSession

NFData EvaluateSession Source # 
Instance details

Defined in Amazonka.VoiceId.EvaluateSession

Methods

rnf :: EvaluateSession -> () #

Eq EvaluateSession Source # 
Instance details

Defined in Amazonka.VoiceId.EvaluateSession

Hashable EvaluateSession Source # 
Instance details

Defined in Amazonka.VoiceId.EvaluateSession

type AWSResponse EvaluateSession Source # 
Instance details

Defined in Amazonka.VoiceId.EvaluateSession

type Rep EvaluateSession Source # 
Instance details

Defined in Amazonka.VoiceId.EvaluateSession

type Rep EvaluateSession = D1 ('MetaData "EvaluateSession" "Amazonka.VoiceId.EvaluateSession" "amazonka-voice-id-2.0-E9fR3xKghdA6rj9Pl7P2NC" 'False) (C1 ('MetaCons "EvaluateSession'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sessionNameOrId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newEvaluateSession Source #

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.

Constructors

EvaluateSessionResponse' 

Fields

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

  • fraudDetectionResult :: Maybe FraudDetectionResult

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

  • sessionId :: Maybe Text

    The service-generated identifier of the session.

  • sessionName :: Maybe Text

    The client-provided name of the session.

  • 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, 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.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic EvaluateSessionResponse Source # 
Instance details

Defined in Amazonka.VoiceId.EvaluateSession

Associated Types

type Rep EvaluateSessionResponse :: Type -> Type #

Show EvaluateSessionResponse Source # 
Instance details

Defined in Amazonka.VoiceId.EvaluateSession

NFData EvaluateSessionResponse Source # 
Instance details

Defined in Amazonka.VoiceId.EvaluateSession

Methods

rnf :: EvaluateSessionResponse -> () #

Eq EvaluateSessionResponse Source # 
Instance details

Defined in Amazonka.VoiceId.EvaluateSession

type Rep EvaluateSessionResponse Source # 
Instance details

Defined in Amazonka.VoiceId.EvaluateSession

type Rep EvaluateSessionResponse = D1 ('MetaData "EvaluateSessionResponse" "Amazonka.VoiceId.EvaluateSession" "amazonka-voice-id-2.0-E9fR3xKghdA6rj9Pl7P2NC" 'False) (C1 ('MetaCons "EvaluateSessionResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authenticationResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthenticationResult)) :*: (S1 ('MetaSel ('Just "domainId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "fraudDetectionResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FraudDetectionResult)))) :*: ((S1 ('MetaSel ('Just "sessionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sessionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "streamingStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StreamingStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

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