Class HotwordRule (3.0.1) 

HotwordRule(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The rule that adjusts the likelihood of findings within a certain proximity of hotwords.

Attributes

NameDescription
hotword_regex .storage.CustomInfoType.Regex
Regular expression pattern defining what qualifies as a hotword.
proximity .storage.CustomInfoType.DetectionRule.Proximity
Proximity of the finding within which the entire hotword must reside. The total length of the window cannot exceed 1000 characters. Note that the finding itself will be included in the window, so that hotwords may be used to match substrings of the finding itself. For example, the certainty of a phone number regex "\(\d{3}\) \d{3}-\d{4}" could be adjusted upwards if the area code is known to be the local area code of a company office using the hotword regex "\(xxx\)", where "xxx" is the area code in question.
likelihood_adjustment .storage.CustomInfoType.DetectionRule.LikelihoodAdjustment
Likelihood adjustment to apply to all matching findings.