https://github.com/philterd/philter-sdk-java
Philter Java SDK
https://github.com/philterd/philter-sdk-java
java personally-identifiable-information phi philter pii protected-health-information sensitive-data sensitive-data-security
Last synced: 8 months ago
JSON representation
Philter Java SDK
- Host: GitHub
- URL: https://github.com/philterd/philter-sdk-java
- Owner: philterd
- License: apache-2.0
- Created: 2019-03-19T21:01:44.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-01-15T14:09:54.000Z (9 months ago)
- Last Synced: 2025-01-15T15:59:24.562Z (9 months ago)
- Topics: java, personally-identifiable-information, phi, philter, pii, protected-health-information, sensitive-data, sensitive-data-security
- Language: Java
- Homepage: https://www.philterd.ai
- Size: 157 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Philter SDK for Java
The **Philter SDK for Java** is an API client for [Philter](https://www.philterd.ai). Philter identifies and manipulates sensitive information such as Protected Health Information (PHI) and personally identifiable information (PII) in natural language text. Philter is built upon the open source PII/PHI detection engine [Phileas](https://github.com/philterd/phileas).
Refer to the [Philter API](https://docs.philterd.ai/philter/latest/api-1-readme.html) documentation for details on the methods available.
## Snapshots and Releases
Snapshots and releases are available in our [Maven repositories](https://artifacts.philterd.ai/) so add the following to your Maven configuration:
```
philterd-repository-releases
https://artifacts.philterd.ai/releases
false
philterd-repository-snapshots
https://artifacts.philterd.ai/snapshots
true
```
## Example Usage
With an available running instance of Philter, to filter text:
```
PhilterClient client = new PhilterClient.PhilterClientBuilder().withEndpoint("https://127.0.0.1:8080").build();
FilterResponse filterResponse = client.filter(text);
```
To filter text with explanation:
```
PhilterClient client = new PhilterClient.PhilterClientBuilder().withEndpoint("https://127.0.0.1:8080").build();
ExplainResponse explainResponse = client.explain(text);
```
## Release History
* 1.4.0:
* Modified /api/status response.
* Renamed profiles to policies.
* 1.3.1:
* Changed from com.mtnfog to ai.philterd.
* 1.3.0:
* Added support for SSL authentication.
* Added support for filtering PDF documents.
* Removed token-based API authentication.
* Removed models client.
* 1.2.0:
* Added option for API authentication support.
* Added `salt` to `Span` for when the `HASH_SHA256_REPLACE` filter strategy is applied by Philter.
* Changed artifact name to `philter-sdk-java`
* Added alerts retrieval/deletion to client.
* Added models client.
* 1.1.0:
* Various changes/fixes.
* Split SDKs into separate projects.
* 1.0.0:
* Initial release.
## License
This project is licensed under the Apache License, version 2.0.
Copyright 2024 Philterd, LLC.
Philter is a registered trademark of Philterd, LLC.