notebook: Enable PII detection in tests

[validbeck]

Pull Request Description

What and why?

sc-11822

• I took the sample notebook John introduced in SC-2886: PII Detection for Uploaded Test Results #410 and cleaned it up with some more distinct/expanded examples.
• It has been renamed to follow our style guide conventions, etc. (configure_pii_detection.ipynb > enable_pii_detection.ipynb)

How to test

I checked that everything ran fine locally, but you might want to pull the file down just to check: https://github.com/validmind/validmind-library/blob/beck/sc-11822/documentation-pii-detection/notebooks/how_to/enable_pii_detection.ipynb

What needs special review?

I took some liberties with the examples so please make sure they make sense/are accurate.

Dependencies, breaking changes, and deployment notes

n/a

Release notes

Learn how to enable and configure Personally Identifiable Information (PII) detection when running tests with the ValidMind Library with our new notebook. Choose whether or not to include PII in test descriptions generated, or whether or not to include PII in test results logged to the ValidMind Platform.

Enable PII detection in tests

Checklist

• What and why
• Screenshots or videos (Frontend)
• How to test
• What needs special review
• Dependencies, breaking changes, and deployment notes
• Labels applied
• PR linked to Shortcut
• Unit tests added (Backend)
• Tested locally
• Documentation updated (if required)
• Environment variable additions/changes documented (if required)

[github-actions]

PR Summary

This PR replaces the deprecated 'configure_pii_detection.ipynb' notebook with a new, comprehensive 'enable_pii_detection.ipynb' notebook. The new notebook provides detailed instructions on how to enable and configure PII detection within the ValidMind Library. It steps through the process of installing the library with the pii-detection extra, initializing the library, and creating custom tests that emit PII. Different PII detection modes (disabled, test_results, test_descriptions, and all) are demonstrated with code examples. In addition, the notebook illustrates how to override detection using an unsafe flag, while also explaining the potential risks. Overall, the changes aim to streamline the user experience for configuring PII detection and provide clearer guidance on managing sensitive data in testing scenarios.

Test Suggestions

• Run the notebook under each PII detection mode (disabled, test_results, test_descriptions, and all) and verify that the output behavior matches the expected logging and description generation.
• Test the override functionality with the unsafe flag to ensure that the blocking logic is bypassed as documented.
• Confirm that the custom test output containing sample PII data properly triggers PII detection and handles exceptions as expected.
• Verify that no sensitive PII is actually transmitted when not using the unsafe override.

[johnwalz97]

beautiful stuff!