28 Commits

Author SHA1 Message Date
Omri Mendels
94f866a96b Docs/dps migration phase1 (#2104) 2026-06-28 10:27:33 +03:00
Omri Mendels
23888dcab9 Revert accidental migration push to main
Reverts a725ecfa ("updates to docs and markdown") and bee25c35 ("docs and md renames"), which were pushed to main by mistake. The migration work is preserved on a separate branch and will be reintroduced via a proper branch/PR.
2026-06-25 23:38:24 +03:00
Omri Mendels
a725ecfa38 updates to docs and markdown (phase 1. Phase 2 is the code + readmes) 2026-06-25 23:29:21 +03:00
Sharon Hart
a6f9b7aed1 docs: rebrand site to Data Privacy Stack (Inky) (#2100)
Apply the Data Privacy Stack community brand to the documentation site
ahead of the project transition.

- mkdocs.yml: rename site to "Presidio", add light/dark palette toggle,
  Inky icon as logo + favicon, brand fonts, and UX features
- stylesheets/extra.css: full violet/indigo theme (light + dark), hero
  wordmark lockup, and component polish
- index.md: add hero block (mascot + "Presidio" / "by data privacy stack")
- api-docs: replace Microsoft logo with the Inky mascot and recolor the
  ReDoc theme to match the new palette
- assets: add Inky mascot, favicon, and app-icon SVGs

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-06-25 16:27:40 +03:00
AKIOS
6942ba5ff7 fix validation_result type in api docs and type hint (#1869) 2026-02-22 21:51:29 +02:00
Thomas E Lackey
662cf2d70e Support batch processing over the REST API. (#1806)
* Support batch processing over the REST API.

* Partially fix e2e tests

* Fix e2e tests

* ruff

* ruff

* consistent use of strings

* Update API docs

* Support batch processing over the REST API.

* Partially fix e2e tests

* Fix e2e tests

* ruff

* ruff

* consistent use of strings

* Update API docs
2026-02-04 16:44:39 +02:00
Sharon Hart
9bfd4c50a0 Exclude 'recognition_metadata' attribute from REST Analyze Response DTO (#1627)
* Exclude 'recognition_metadata' attribute from REST Analyze Response DTO

* json format

---------

Co-authored-by: Omri Mendels <omri374@users.noreply.github.com>
2025-06-16 17:32:56 +03:00
Stef Heyenrath
8bf80d104c Fix typo in api-docs.yml (#1602) 2025-05-29 01:04:20 +03:00
Sharon Hart
dcf1ae0359 drop blake2b (#1552)
* drop blake2b

* Update docs/anonymizer/index.md

Co-authored-by: Omri Mendels <omri374@users.noreply.github.com>

* Update test_anonymize_engine.py

---------

Co-authored-by: Omri Mendels <omri374@users.noreply.github.com>
2025-03-17 14:08:29 +02:00
Sharon Hart
a0484ddc2c Replace MD5 with Blake2 (#1550) 2025-03-17 11:25:11 +02:00
Sharon Hart
3a40683841 Fix Anonymize API documentation (#1018)
* Fix Anonymize API documentation

* Fi deanonymize endpoint

Co-authored-by: sharon <sharon.hart@microsoft.com>
2023-01-25 12:12:32 +02:00
Guy Bertental
a0c071b798 refactor and modularize context words logic (#828) 2022-02-22 09:12:50 +02:00
Anat Balzam
81c8c49ebb URL Recognizer (#825)
* initial url recognizer

* fix linting

* CR comments

* Added to api-docs

* Adding a different validator to url recognizer

* change credit

* remove domain_recognizer.py

* More elegant regex

* Add change log

Co-authored-by: Anat Balzam <anatbalzam@microsoft.com>
Co-authored-by: Omri Mendels <omri374@users.noreply.github.com>
2022-02-21 13:26:23 +02:00
Sharon Hart
cedcb4cb4c Remove AnonymizerResult in favor of OperatorResult (#795)
* Remove AnonymizerResult in favor of OperatorResult

* fix test

* documentation changes + align rest api

* operator_name

Co-authored-by: sharon <sharon.hart@microsoft.com>
2021-11-16 11:17:07 +02:00
Omri Mendels
67cb019ff0 Two new samples + docs refactoring (#744) 2021-07-14 12:17:35 +03:00
Sharon Hart
aea7804219 Add Medical License as a Predefined Recognizer (#719) 2021-05-27 11:42:42 +03:00
Omri Mendels
d5d9551d57 Ad-hoc recognizers (#677) 2021-05-05 10:18:01 +03:00
Shiran Rubin
1c79c91e67 Fix deanonymizer documentation (#657)
* Add decryption mechanism.
On purpose we separate it from the anonymizer/

* Fix tests

* Remove unneeded params
fix docs and tests

* Add decryption engine to match the anonymizer engine.
Refactor code so the text builder and text manipulator will be mutual.

* Change engine result to be unified with different items inheriting from result item.

* Fix decrypt elements and implmentations

* Add hints

* Fix naming

* Change manipulators to operators.

* Change manipulators to operators.

* Move initialization of text manipulator
Change the analyzer results json to receive the list and not the entire content.
Fix tests

* Move getting operators classes into the operator factory.

* Fix entities.
Make sure all engines can use the same entities by using factories, builders and inheritance more.

* revert unneeded change

* Code cleanup

* Add tests and clean up code.

* Move anonymizer configuration to inherit from operator metadata and add decryptor config

* More cleanup

* More cleanup

* revert

* cleanup

* Fix imports and renaming

* Start working on linting.

* Start working on linting.

* add tests

* add tests

* add tests

* add tests

* remove unneeded formating.

* fix linting

* try to understand why it fails in pipe

* try to understand why it fails in pipe

* Fix equal check for recognizer result

* revert change for test investigation

* fix imports and add test

* fix dictionary

* add test for dictionary fix

* Fix example

* Fix E2E entities

* Fix PR comments

* Fix PR comments

* Fix PR comments

* Fix PR comments

* Fix PR comments

* Fix PR comments - use comprehensions

* Fix PR comments - Change names and move classes accordingly.

* fix linting

* fix linting

* use dictionary comprehensions

* Fix documentation and nameing.

* Fix documentation and nameing.

* remove unused code.

* PR comments

* fix linting

* PR review -> be background compatible.

* fix linting

* fix linting due to merge

* Fix PR comments

* linting

* remove my name from code.

* Add engine test for encrypt decrypt in integration tests
Add helper method to change anonymized entity into encrypt result.

* add docs

* fix import

* Remove unneeded field

* Replace decrypt with deanonymize.

* Replace decrypt with deanonymize.

* revert

* Change to anonymizer_results

* Remove entities and merge them together.

* Remove entities and merge them together + renaming

* Remove entities and merge them together + renaming

* fix linting

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix tests

* fix tests

* fix tests

* rename

* fix docs

* Change docs to the new deanonymization functionality.

* Change docs to the new deanonymization functionality.

* Fix PR comments

* Fix linting

* Fix linting

* fux PR comments

* fux PR comments

* fix PR comments

* fix PR comments

* add tests

* add tests

* fix PR comments

* fix PR comments

* fix PR comments

* fix PR comments

* fix PR comments

* bump version for breaking changes

* fix API doc

* Update docs/anonymizer/adding_operators.md

Co-authored-by: Omri Mendels <omri374@users.noreply.github.com>

* Update docs/anonymizer/index.md

Co-authored-by: Omri Mendels <omri374@users.noreply.github.com>

* Update docs/anonymizer/index.md

Co-authored-by: Omri Mendels <omri374@users.noreply.github.com>

* Update docs/api-docs/api-docs.yml

Co-authored-by: Omri Mendels <omri374@users.noreply.github.com>

* PR comments

* Add documentation

* Fix merge issue

* Update docs/anonymizer/index.md

Co-authored-by: Omri Mendels <omri374@users.noreply.github.com>

* Update docs/anonymizer/index.md

Co-authored-by: Omri Mendels <omri374@users.noreply.github.com>

* fix PR comments

* Update presidio-anonymizer/README.MD

Co-authored-by: Omri Mendels <omri374@users.noreply.github.com>

* fix PR comments

* fix PR comments

* fix PR comments

* fix PR comments

* Update docs/anonymizer/index.md

Co-authored-by: Omri Mendels <omri374@users.noreply.github.com>

Co-authored-by: Omri Mendels <omri374@users.noreply.github.com>
2021-04-07 15:34:22 +03:00
Shiran Rubin
3afec0c958 Poc deanonymize docs (#652)
* Add decryption mechanism.
On purpose we separate it from the anonymizer/

* Fix tests

* Remove unneeded params
fix docs and tests

* Add decryption engine to match the anonymizer engine.
Refactor code so the text builder and text manipulator will be mutual.

* Change engine result to be unified with different items inheriting from result item.

* Fix decrypt elements and implmentations

* Add hints

* Fix naming

* Change manipulators to operators.

* Change manipulators to operators.

* Move initialization of text manipulator
Change the analyzer results json to receive the list and not the entire content.
Fix tests

* Move getting operators classes into the operator factory.

* Fix entities.
Make sure all engines can use the same entities by using factories, builders and inheritance more.

* revert unneeded change

* Code cleanup

* Add tests and clean up code.

* Move anonymizer configuration to inherit from operator metadata and add decryptor config

* More cleanup

* More cleanup

* revert

* cleanup

* Fix imports and renaming

* Start working on linting.

* Start working on linting.

* add tests

* add tests

* add tests

* add tests

* remove unneeded formating.

* fix linting

* try to understand why it fails in pipe

* try to understand why it fails in pipe

* Fix equal check for recognizer result

* revert change for test investigation

* fix imports and add test

* fix dictionary

* add test for dictionary fix

* Fix example

* Fix E2E entities

* Fix PR comments

* Fix PR comments

* Fix PR comments

* Fix PR comments

* Fix PR comments

* Fix PR comments - use comprehensions

* Fix PR comments - Change names and move classes accordingly.

* fix linting

* fix linting

* use dictionary comprehensions

* Fix documentation and nameing.

* Fix documentation and nameing.

* remove unused code.

* PR comments

* fix linting

* PR review -> be background compatible.

* fix linting

* fix linting due to merge

* Fix PR comments

* linting

* remove my name from code.

* Add engine test for encrypt decrypt in integration tests
Add helper method to change anonymized entity into encrypt result.

* add docs

* fix import

* Remove unneeded field

* Replace decrypt with deanonymize.

* Replace decrypt with deanonymize.

* revert

* Change to anonymizer_results

* Remove entities and merge them together.

* Remove entities and merge them together + renaming

* Remove entities and merge them together + renaming

* fix linting

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix tests

* fix tests

* fix tests

* rename

* fix docs

* Change docs to the new deanonymization functionality.

* Change docs to the new deanonymization functionality.

* Fix PR comments

* Fix linting

* Fix linting

* fux PR comments

* fux PR comments

* fix PR comments

* fix PR comments

* add tests

* add tests

* fix PR comments

* fix PR comments

* fix PR comments

* fix PR comments

* fix PR comments

* bump version for breaking changes

* fix API doc

* Update docs/anonymizer/adding_operators.md

Co-authored-by: Omri Mendels <omri374@users.noreply.github.com>

* Update docs/anonymizer/index.md

Co-authored-by: Omri Mendels <omri374@users.noreply.github.com>

* Update docs/anonymizer/index.md

Co-authored-by: Omri Mendels <omri374@users.noreply.github.com>

* Update docs/api-docs/api-docs.yml

Co-authored-by: Omri Mendels <omri374@users.noreply.github.com>

* PR comments

Co-authored-by: Omri Mendels <omri374@users.noreply.github.com>
2021-04-07 11:01:39 +03:00
Shiran Rubin
771d38c5bd Add deanonymize (#639)
* Add decryption mechanism.
On purpose we separate it from the anonymizer/

* Fix tests

* Remove unneeded params
fix docs and tests

* Add decryption engine to match the anonymizer engine.
Refactor code so the text builder and text manipulator will be mutual.

* Change engine result to be unified with different items inheriting from result item.

* Fix decrypt elements and implmentations

* Add hints

* Fix naming

* Change manipulators to operators.

* Change manipulators to operators.

* Move initialization of text manipulator
Change the analyzer results json to receive the list and not the entire content.
Fix tests

* Move getting operators classes into the operator factory.

* Fix entities.
Make sure all engines can use the same entities by using factories, builders and inheritance more.

* revert unneeded change

* Code cleanup

* Add tests and clean up code.

* Move anonymizer configuration to inherit from operator metadata and add decryptor config

* More cleanup

* More cleanup

* revert

* cleanup

* Fix imports and renaming

* Start working on linting.

* Start working on linting.

* add tests

* add tests

* add tests

* add tests

* remove unneeded formating.

* fix linting

* try to understand why it fails in pipe

* try to understand why it fails in pipe

* Fix equal check for recognizer result

* revert change for test investigation

* fix imports and add test

* fix dictionary

* add test for dictionary fix

* Fix example

* Fix E2E entities

* Fix PR comments

* Fix PR comments

* Fix PR comments

* Fix PR comments

* Fix PR comments

* Fix PR comments - use comprehensions

* Fix PR comments - Change names and move classes accordingly.

* fix linting

* fix linting

* use dictionary comprehensions

* Fix documentation and nameing.

* Fix documentation and nameing.

* remove unused code.

* PR comments

* fix linting

* PR review -> be background compatible.

* fix linting

* fix linting due to merge

* Fix PR comments

* linting

* remove my name from code.

* Add engine test for encrypt decrypt in integration tests
Add helper method to change anonymized entity into encrypt result.

* add docs

* fix import

* Remove unneeded field

* Replace decrypt with deanonymize.

* Replace decrypt with deanonymize.

* revert

* Change to anonymizer_results

* Remove entities and merge them together.

* Remove entities and merge them together + renaming

* Remove entities and merge them together + renaming

* fix linting

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix documentation and naming

* fix tests

* fix tests

* fix tests

* rename

* fix docs

* Fix PR comments

* Fix linting

* Fix linting

* fux PR comments

* fux PR comments

* fix PR comments

* fix PR comments

* add tests

* add tests

* fix PR comments

* fix PR comments

* fix PR comments

* fix PR comments

* bump version for breaking changes
2021-04-06 15:45:10 +03:00
Itye Richter
13920dbec9 Anonymizer Indexes in response (WIP) (#604)
* added indexes

* fix tests

* linting

* e2e fixes

* fix e2e tests

* pr fix

* linting

* added types

* added types

* more tests

* pr fixes

* more tests

* pr fixes

* Update presidio-anonymizer/presidio_anonymizer/entities/anonymizer_result.py

Co-authored-by: Omri Mendels <omri374@users.noreply.github.com>

* pr fixes

* pr fixes

* pr fixes

* pr fixes

* swagger update

* swagger

* type fix

Co-authored-by: Itye <itye@ityer-2.local>
Co-authored-by: Omri Mendels <omri374@users.noreply.github.com>
2021-03-11 16:15:07 +02:00
Sharon Hart
059a38f9e8 Add Decryption for Single PII (#601)
* Add decryption

* Fix e2e tests

* change todo

* Add e2e test
Fix error text

* Fix error text

Co-authored-by: sharon <sharon.hart@microsoft.com>
2021-03-10 10:06:28 +02:00
Sharon Hart
9e2bbb1dab Anonymizer - Encrypt anonymizer (#596)
* Add AES Encryption Logics

* Update NOTICE

* Key as method argument

* Anonymizer - Add encrypt anonymizer

* Anonymizer - Add encrypt anonymizer

* space

* Add documentation, tests

* Revert "Add AES Encryption Logics"

This reverts commit 18d991bc

* rename private method

* add key

* V1 to V2

* Add AES Encryption Logics

* Rebase to AES API change

* Add assertion on encryption

* change test names

Co-authored-by: sharon <sharon.hart@microsoft.com>
2021-03-08 11:39:45 +02:00
Omri Mendels
a6d720eb86 Align analyzer and anonymizer RecognizerResult objects (#591) 2021-03-03 18:28:47 +02:00
Nava Vaisman Levy
33d8ff8c70 docs update (#557) 2021-02-28 16:31:07 +02:00
Omri Mendels
61ed5452b8 Feature/rename interpretability (#553) 2021-02-25 13:00:45 +02:00
Shiran Rubin
a3eb6e09db remove FPE from anonymizer since we do not support it. (#552)
Co-authored-by: Nava Vaisman Levy <navalev@users.noreply.github.com>
2021-02-24 19:54:43 +02:00
Sharon Hart
e6e791667e Move swagger to project root + Add Analyzer (#537)
* Add api-docs

* Add example

* Move to docs, remove names

* typo

* remove image redactor

* Remove flasgger from pipenvs

* Add more descriptions

* revert upper branch commit

* Remove enum

Co-authored-by: sharon <sharon.hart@microsoft.com>
2021-02-21 17:15:28 +02:00