Repository navigation
Document enabling country-specific recognizers via registry override - #2310
Closed
bhaskargurram-ai wants to merge 1 commit into
Closed
bhaskargurram-ai wants to merge 1 commit into
bhaskargurram-ai wants to merge 1 commit into
Conversation
Several country-specific pattern recognizers (ItFiscalCodeRecognizer, EsNifRecognizer, PlPeselRecognizer, ...) are registered in default_recognizers.yaml for their native language only. The published presidio-analyzer image ships with supported_languages: [en], so on that image entities such as IT_FISCAL_CODE cannot be detected at all, and a request that mixes them with supported entities returns 200 with the unsupported entity silently missing. There was no documentation of how to enable those recognizers without rebuilding the image. Add a how-to section to the recognizer registry page describing the RECOGNIZER_REGISTRY_CONF_FILE override: copy default_recognizers.yaml, set supported_languages to en on the recognizer entry, mount the file into the container, and verify via /supportedentities and /analyze. State that the file replaces (does not merge with) the default registry, that adding "it" to the registry alone breaks startup because the analyzer and NLP engine only support "en", and that since data-privacy-stack#2259 partially unsupported entity requests log a deprecation warning while still returning partial results. Cross-link the section from the supported entities (Italy), installation, languages, filtering by country and analyzer engine provider pages. Refs data-privacy-stack#2256. Completes the docs part left open when PR data-privacy-stack#2271 was closed.
github-actions
Bot
added
external
PII recognizers
documentation
analyzer
and removed
external
labels
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Several country-specific pattern recognizers (ItFiscalCodeRecognizer, EsNifRecognizer, PlPeselRecognizer, ...) are registered in default_recognizers.yaml for their native language only. The published presidio-analyzer image ships with supported_languages: [en], so on that image entities such as IT_FISCAL_CODE cannot be detected at all, and a request that mixes them with supported entities returns 200 with the unsupported entity silently missing. There was no documentation of how to enable those recognizers without rebuilding the image.
Add a how-to section to the recognizer registry page describing the RECOGNIZER_REGISTRY_CONF_FILE override: copy default_recognizers.yaml, set supported_languages to en on the recognizer entry, mount the file into the container, and verify via /supportedentities and /analyze. State that the file replaces (does not merge with) the default registry, that adding "it" to the registry alone breaks startup because the analyzer and NLP engine only support "en", and that since #2259 partially unsupported entity requests log a deprecation warning while still returning partial results. Cross-link the section from the supported entities (Italy), installation, languages, filtering by country and analyzer engine provider pages.
Refs #2256. Completes the docs part left open when PR #2271 was closed.
Change Description
Describe your changes
Issue reference
Fixes #XX
Checklist