Skip to content

docs(api): document global_regex_flags and deny_list_score on PatternRecognizer #2255

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
omri374 merged 3 commits into from
Sep 15, 2026
Merged

docs(api): document global_regex_flags and deny_list_score on PatternRecognizer #2255

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2a36a71
docs(api): document global_regex_flags and deny_list_score on Pattern…
MohammedAlkindi Sep 14, 2026
b3c2614
Merge branch 'main' into docs/pattern-recognizer-schema-fields
omri374 Sep 15, 2026
5dac0d3
Merge branch 'main' into docs/pattern-recognizer-schema-fields
omri374 Sep 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/api-docs/api-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -592,6 +592,10 @@ components:
description: "List of words to be returned as PII if found."
items:
type: string
deny_list_score:
type: number
format: double
description: "Confidence score for a term identified using a deny-list. Defaults to 1.0."
context:
description: "List of words to be used to increase confidence if found in the vicinity of detected entities."
type: array
Expand All @@ -600,6 +604,9 @@ components:
supported_entity:
type: string
description: "The name of entity this ad hoc recognizer detects"
global_regex_flags:
type: integer
description: "Regex flags used when matching the patterns and the deny-list, as a bitmask of Python `re` flags. Defaults to 26 (re.DOTALL | re.MULTILINE | re.IGNORECASE), so matching is case-insensitive unless this is overridden."

EntityTypes:
description: "The supported PII entity types."
Expand Down
Loading