Skip to content

Commit 9b2fbed

Browse files
committed
Improved documentation.
1 parent 942516b commit 9b2fbed

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,33 @@ FormatterResult formatterResult = executor.execute(command, mode, argument).get(
196196
```
197197

198198

199+
## Risk Detector
200+
201+
Detects various types of possibly fake data in person records.
202+
203+
```java
204+
import org.nameapi.client.services.formatter.personnameformatter.PersonNameFormatterArgument;
205+
import org.nameapi.client.services.formatter.personnameformatter.PersonNameFormatterCommand;
206+
import org.nameapi.ontology5.input.entities.person.NaturalInputPerson;
207+
import org.nameapi.ontology5.input.entities.person.NaturalInputPersonBuilder;
208+
import org.nameapi.ontology5.services.formatter.FormatterProperties;
209+
import org.nameapi.ontology5.services.formatter.FormatterResult;
210+
211+
PersonRiskDetectorCommand command = new PersonRiskDetectorCommand();
212+
InputPerson person = new NaturalInputPersonBuilder()
213+
.name(new WesternInputPersonNameBuilder().givenName("John").surname("Doe").build())
214+
.addEmail(EmailAddressFactory.forAddress("[email protected]"))
215+
.addTelNumber(TelNumberFactory.forNumber("999 999 999"))
216+
.addAddressForAll(
217+
new StructuredAddressBuilder()
218+
.placeInfo(new StructuredPlaceInfoBuilder().locality("Atlantis").postalCode("55555").build())
219+
.streetInfo(new StructuredStreetInfoBuilder().streetName("Hill road").houseNumber("72").build())
220+
.build())
221+
.build();
222+
executor.execute(command, mode, person).get();
223+
```
224+
225+
199226
## Email Name Parser
200227

201228
The Email Name Parser extracts names out of email addresses.

0 commit comments

Comments
 (0)