VB Models Schema

For more information regarding Voice Biometrics, please refer to the Voice Biometrics section.

VB Enrolment

Field	Type	Description
`message_type`	string	The event topic name, `vb_enrolment`.
`region`	string	The event generated region.
`vb_version`	string	The version of the Voice Biometrics (VB) Events.
`dialog_id`	string	The IVR dialog id.
`session_id`	string	The session identifier of the unique conversation.
`origin`	string	The origin of the enrolment event (for example, IVR or Agent Side).
`group_name`	string	The OCP Group Name.
`enrolled_user`	dictionary	Information related to the enrolled user.
`biokeys`	array of objects	Information related to biokeys that correspond to profiles.
`profile_id`	string	The VB profile id.
`voiceprint`	dictionary	Information related to the user’s voiceprint.

Example JSON

JSON

{
  "message_type": "vb_enrolment",
  "region": "test-region",
  "vb_version": “6.8.0”,
  "dialog_id": "abcd",
  "session_id": "efg",
  "origin": "",
  "group_name": "",
  "enrolled_user": {
    "user_id": "",
    "organization_name": "",
    "user_creation_ts": "",
    "opted_out": "",
    "optout_ts": "",
    "optin_ts": ""
  },
  "biokeys": [
      {
        "key": "ani",
        "value": "12345"
      }
    ],
  "profile_id": "",
  "voiceprint": 
    {
      "voiceprint_id": "",
      "creation_ts": "",
      "extractor_version": "",
      "method": "",
      "model": "",
      "plda_version": "",
      "speech_frames": "",
      "sw_version": "",
      "vp_fail": "",
      "vp_fail_reason": ""
    }
}

enrolled_user

Field	Type	Description
`user_id`	string	The unique user id.
`organization_name`	string	The OCP Organization Name.
`user_creation_ts`	unix timestamp (with ms)	The timestamp of the user creation.
`opted_out`	boolean	Indicates if a user has opted out from the application.
`optout_ts`	unix timestamp (with ms)	The timestamp of the optout of the user.
`optin_ts`	unix timestamp (with ms)	The timestamp of the optin of the user

biokeys

Field	Type	Description
`key`	string	The biokeys' key.
`value`	string	The biokeys' value.

voiceprint

Field	Type	Description
`voiceprint_id`	integer	The voiceprint id.
`creation_ts`	unix timestamp (with ms)	The creation timestamp of the voiceprint.
`extractor_version`	string	The version of the extractor for building the voiceprint.
`method`	string	The method used for building the voiceprint.
`model`	string	The model user for building the voiceprint.
`plda_version`	string	The PLDA of the model with which the voiceprint was built.
`speech_frames`	integer	The amount of speech frames upon which the voiceprint was built.
`sw_version`	string	The version of deepVB with which the voiceprint was built.
`vp_fail`	boolean	Whether the voiceprint failed to be built.
`vp_fail_reason`	string (enumerated)	The reason why the voiceprint failed to be built. If the build is successful, then the field is `null`.

VB Verification

Field	Type	Description
`message_type`	string	The event topic name, `vb_verification`.
`region`	string	The event generated region.
`vb_version`	string	The version of the Voice Biometrics (VB) Events.
`dialog_id`	string	The IVR dialog ID.
`dialog_step`	integer	The IVR dialog step.
`enrolled_user`	dictionary	The information regarding the enrolled user.
`group_name`	string	The OCP Group Name.
`voiceprint_ids`	list of long	The unique voiceprint id.
`profile_id`	string	The VB profile id.
`verification_id`	long	The unique verification id.
`extractor_version`	string	The base model used for the verification.
`frame_count`	integer	Speech frames accumulated upon the verification.
`llr`	double	The log-likelihood ratio of the verification.
`method`	string	The method used for the verification.
`model`	string	The model used for the verification.
`llr_norm`	double	The normalized log-likelihood ratio of the verification.
`plda_version`	string	The version of the PLDA model used for the verification.
`verification_score`	double	The bioscore of the verification.
`sw_version`	string	The version of deepASR with which the verification took place.
`verification_ts`	long, unix timestamp (with ms)	The timestamp of the verification.
`user_changed`	boolean	Indicates whether the speaker changed.
`verification_result`	string (enumerated)	Results of the VB verification. Possible values include: NO_DATA, LOW_DATA, NOT_SCORED, OK_TMP, FALSE_HIGH, FALSE_MEDIUM, FALSE_LOW, TRUE_HIGH, TRUE_MEDIUM, TRUE_LOW, ERROR.
`fail_reason`	string	Fail reason in the event of verification failure. If no failure, then the value is `OK`.
`scd_llr`	double	The log-likelihood ratio of the speaker change event.
`scd_nllr`	double	The normalized log-likelihood ratio of the speaker change event.
`verification_origin`	string	The origin of the verification event (for example, IVR or Agent Side).
`non_target`	boolean	Whether the verification created is a target/regular one or a non-target one, which is used for reporting purposes.

Example JSON

JSON

{
  "message_type": "vb_verification",
  "vb_version": "6.7.0",
  "dialog_id": "12345",
  "dialog_step": 7,
  "enrolled_user": {
    "user_id": "",
    "organization_name": ""
  },
  "group_name": "DEF",
  "voiceprint_ids": [
    null
  ],
  "profile_id": "DEF",
  "verification_id": 8,
  "extractor_version": "1.0.3",
  "frame_count": 444,
  "llr": 0.0001,
  "method": "man",
  "model": "aadfadf",
  "llr_norm": 0.4,
  "plda_version": "34.333.22",
  "verification_score": 0.13,
  "sw_version": "1.0.0-blsfadf",
  "verification_ts": 1552639569000,
  "user_changed": false,
  "verification_result": "FALSE_HIGH",
  "fail_reason": null,
  "scd_llr": null,
  "scd_nllr": null,
  "verification_origin": null,
  "non_target": true
}

enrolled_user

Field	Type	Description
`user_id`	string	The unique user id.
`organization_name`	string	The OCP Organization Name.