Skip to content





Match Audio

These Steps and Step Details are used to match audio recordings from voice calls against audio reference files to compare their similarity. In order to use this feature, the Audio Matcher must be configured.

Audio Matching
Match Audio Recording Steps
Match Audio Recording Step Details

Match Audio Recording Steps

This step verifies that the recording matches a reference recording within a given similarity score. A higher value indicates a better match:

  • If a best match does not exceed the minimum limit, the step will fail. However, the log output will state which file had the highest score.

  • If multiple best matches occur, one will be selected at random.

Syntax

1
2
ensure audio recording <recording Any> matches <reference String>
    [with a minimum similarity score of <score Number> percent][ using profile <profile>]

Parameters

  • recording - An expression that must evaluate to an audio recording

    • This expression depends on the Steps that produced the audio recording
  • reference - The name of the reference recording to be matched that must evaluate to a string

  • score (Optional) - Percentage between 0 and 100 that defines the extent to which the audio recording must match the reference recording

    • This is not a linear measure: A higher value indicates a better match
    • If no score is given, the minimum score is 0%, thus the best match in the audio reference database is considered a valid/good match (since its percentage is above 0%)
  • profile (optional) - The name of the Audio Match profile to be used for the audio matching that must evaluate to a string

Audio Matching Step Variant without Any Optional Details Example

1
2
3
And start audio recording on A
And stop audio recording on A and save as myrec
And ensure audio recording myrec matches "Announcement_12"

Audio Matching Step Variant with the "Minimum Similarity" Option Example

1
2
3
And start audio recording on A
And stop audio recording on A and save as myrec
And ensure audio recording myrec matches "Announcement_12" with a minimum similarity score of 70 percent

Audio Matching Step Variant with the "Profile" Option Example

1
2
3
And start audio recording on A
And stop audio recording on A and save as myrec
And ensure audio recording myrec matches "Announcement_12" using profile "default"

Audio Matching Step Variant with All Possible Options Example

1
2
3
And start audio recording on A
And stop audio recording on A and save as myrec
And ensure audio recording myrec matches "Announcement_12" with a minimum similarity score of 70 percent using profile "hq-audio"

Recording Produced by Call Compound Step Details Example

1
2
3
4
5
6
And A starts a call to B as MY_CALL:
      * caller records audio from dial to connect
      * callee records audio from connect to disconnect

And ensure audio recording MY_CALL.recordings.A.dial_to_connect matches "Announcement_13"
And ensure audio recording MY_CALL.recordings.B.connect_to_disconnect matches "Announcement_14"

Match Audio Recording Step Details

The following Step Details are used to verify an audio recording matches a reference recording within a given similarity score.

  • If a best match does not exceed the minimum limit, the step will fail. However, the log output will state which file had the highest score.

  • If multiple best matches occur, one will be selected at random.

Syntax

1
2
3
4
5
ensure audio recordings match:
    * recording is <recording Expression>
    * reference is <reference Expression>
    * use matching profile <profile Expression>
    * minimum similarity score is <score Expression> percent

Parameters

  • recording - An expression that must evaluate to an audio recording

    • This expression depends on the Steps that produced the audio recording
  • reference - Name of the reference the recording shall be matched to

    • This is an expression that must evaluate to a string
  • profile - Name of the audio matching profile to be used

    • This is an expression that must evaluate to a string
  • score - Minimum score for a successful match

    • This is an expression that must evaluate to a floating number

The Stepdef Details defines the recording, the reference and the minimum score allow for alternative phrases where the keyword is is replaced by = :

Syntax

1
2
3
4
5
* recording = <recording Expression>

* reference = <reference Expression>

* minimum similarity score = <score Expression>%

Recording Produced by Audio Recording Steps Example

1
2
3
4
5
6
7
8
And start audio recording on A
And stop audio recording on A and save as recA

And ensure audio recordings match:
   * recording = recA
   * reference = "announcement-1"
   * use matching profile "high-quality"
   * minimum similarity score = 60%

Recording Produced by Call Compound Step Details Example

1
2
3
4
5
6
7
And A starts a call to B as MY_CALL:
  * caller records audio from dial to connect
  * callee records audio from connect to disconnect

And ensure audio recordings match:
   * recording = MY_CALL.recordings.A.dial_to_connect
   * reference = "announcement-2"