/AWS1/CL_VIDAUTHNTCTNRESULT¶
The authentication result produced by Voice ID, processed against the current session state and streamed audio of the speaker.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_authenticationresultid TYPE /AWS1/VIDUNIQUEIDLARGE /AWS1/VIDUNIQUEIDLARGE¶
The unique identifier for this authentication result. Because there can be multiple authentications for a given session, this field helps to identify if the returned result is from a previous streaming activity or a new result. Note that in absence of any new streaming activity,
AcceptanceThresholdchanges, orSpeakerIdchanges, Voice ID always returns cached Authentication Result for this API.
iv_audioaggregationstartedat TYPE /AWS1/VIDTIMESTAMP /AWS1/VIDTIMESTAMP¶
A timestamp of when audio aggregation started for this authentication result.
iv_audioaggregationendedat TYPE /AWS1/VIDTIMESTAMP /AWS1/VIDTIMESTAMP¶
A timestamp of when audio aggregation ended for this authentication result.
iv_customerspeakerid TYPE /AWS1/VIDCUSTOMERSPEAKERID /AWS1/VIDCUSTOMERSPEAKERID¶
The client-provided identifier for the speaker whose authentication result is produced. Only present if a
SpeakerIdis provided for the session.
iv_generatedspeakerid TYPE /AWS1/VIDGENERATEDSPEAKERID /AWS1/VIDGENERATEDSPEAKERID¶
The service-generated identifier for the speaker whose authentication result is produced.
iv_decision TYPE /AWS1/VIDAUTHNTCTNDECISION /AWS1/VIDAUTHNTCTNDECISION¶
The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
iv_score TYPE /AWS1/VIDSCORE /AWS1/VIDSCORE¶
The authentication score for the speaker whose authentication result is produced. This value is only present if the authentication decision is either
ACCEPTorREJECT.
io_configuration TYPE REF TO /AWS1/CL_VIDAUTHNTCTNCONF /AWS1/CL_VIDAUTHNTCTNCONF¶
The
AuthenticationConfigurationused to generate this authentication result.
Queryable Attributes¶
AuthenticationResultId¶
The unique identifier for this authentication result. Because there can be multiple authentications for a given session, this field helps to identify if the returned result is from a previous streaming activity or a new result. Note that in absence of any new streaming activity,
AcceptanceThresholdchanges, orSpeakerIdchanges, Voice ID always returns cached Authentication Result for this API.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUTHENTICATIONRESULTID() |
Getter for AUTHENTICATIONRESULTID, with configurable default |
ASK_AUTHENTICATIONRESULTID() |
Getter for AUTHENTICATIONRESULTID w/ exceptions if field has |
HAS_AUTHENTICATIONRESULTID() |
Determine if AUTHENTICATIONRESULTID has a value |
AudioAggregationStartedAt¶
A timestamp of when audio aggregation started for this authentication result.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUDIOAGGRSTARTEDAT() |
Getter for AUDIOAGGREGATIONSTARTEDAT, with configurable defa |
ASK_AUDIOAGGRSTARTEDAT() |
Getter for AUDIOAGGREGATIONSTARTEDAT w/ exceptions if field |
HAS_AUDIOAGGRSTARTEDAT() |
Determine if AUDIOAGGREGATIONSTARTEDAT has a value |
AudioAggregationEndedAt¶
A timestamp of when audio aggregation ended for this authentication result.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_AUDIOAGGREGATIONENDEDAT() |
Getter for AUDIOAGGREGATIONENDEDAT, with configurable defaul |
ASK_AUDIOAGGREGATIONENDEDAT() |
Getter for AUDIOAGGREGATIONENDEDAT w/ exceptions if field ha |
HAS_AUDIOAGGREGATIONENDEDAT() |
Determine if AUDIOAGGREGATIONENDEDAT has a value |
CustomerSpeakerId¶
The client-provided identifier for the speaker whose authentication result is produced. Only present if a
SpeakerIdis provided for the session.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CUSTOMERSPEAKERID() |
Getter for CUSTOMERSPEAKERID, with configurable default |
ASK_CUSTOMERSPEAKERID() |
Getter for CUSTOMERSPEAKERID w/ exceptions if field has no v |
HAS_CUSTOMERSPEAKERID() |
Determine if CUSTOMERSPEAKERID has a value |
GeneratedSpeakerId¶
The service-generated identifier for the speaker whose authentication result is produced.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_GENERATEDSPEAKERID() |
Getter for GENERATEDSPEAKERID, with configurable default |
ASK_GENERATEDSPEAKERID() |
Getter for GENERATEDSPEAKERID w/ exceptions if field has no |
HAS_GENERATEDSPEAKERID() |
Determine if GENERATEDSPEAKERID has a value |
Decision¶
The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DECISION() |
Getter for DECISION, with configurable default |
ASK_DECISION() |
Getter for DECISION w/ exceptions if field has no value |
HAS_DECISION() |
Determine if DECISION has a value |
Score¶
The authentication score for the speaker whose authentication result is produced. This value is only present if the authentication decision is either
ACCEPTorREJECT.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SCORE() |
Getter for SCORE, with configurable default |
ASK_SCORE() |
Getter for SCORE w/ exceptions if field has no value |
HAS_SCORE() |
Determine if SCORE has a value |
Configuration¶
The
AuthenticationConfigurationused to generate this authentication result.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONFIGURATION() |
Getter for CONFIGURATION |