Evaluate Session

voiceid_evaluate_session

R Documentation

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

Description

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

Usage

voiceid_evaluate_session(DomainId, SessionNameOrId)

Arguments

DomainId

[required] The identifier of the domain where the session started.

SessionNameOrId

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

Value

A list with the following syntax:

list(
  AuthenticationResult = list(
    AudioAggregationEndedAt = as.POSIXct(
      "2015-01-01"
    ),
    AudioAggregationStartedAt = as.POSIXct(
      "2015-01-01"
    ),
    AuthenticationResultId = "string",
    Configuration = list(
      AcceptanceThreshold = 123
    ),
    CustomerSpeakerId = "string",
    Decision = "ACCEPT"|"REJECT"|"NOT_ENOUGH_SPEECH"|"SPEAKER_NOT_ENROLLED"|"SPEAKER_OPTED_OUT"|"SPEAKER_ID_NOT_PROVIDED"|"SPEAKER_EXPIRED",
    GeneratedSpeakerId = "string",
    Score = 123
  ),
  DomainId = "string",
  FraudDetectionResult = list(
    AudioAggregationEndedAt = as.POSIXct(
      "2015-01-01"
    ),
    AudioAggregationStartedAt = as.POSIXct(
      "2015-01-01"
    ),
    Configuration = list(
      RiskThreshold = 123,
      WatchlistId = "string"
    ),
    Decision = "HIGH_RISK"|"LOW_RISK"|"NOT_ENOUGH_SPEECH",
    FraudDetectionResultId = "string",
    Reasons = list(
      "KNOWN_FRAUDSTER"|"VOICE_SPOOFING"
    ),
    RiskDetails = list(
      KnownFraudsterRisk = list(
        GeneratedFraudsterId = "string",
        RiskScore = 123
      ),
      VoiceSpoofingRisk = list(
        RiskScore = 123
      )
    )
  ),
  SessionId = "string",
  SessionName = "string",
  StreamingStatus = "PENDING_CONFIGURATION"|"ONGOING"|"ENDED"
)

Request syntax

svc$evaluate_session(
  DomainId = "string",
  SessionNameOrId = "string"
)