Semarchy Person Name enricher

The Semarchy Person Name enricher extracts from a person’s full name his/her Given Name, Surname and Gender.

Plugin ID

Semarchy Person Name Enricher - com.semarchy.engine.plugins.convergence.personname.PersonNameEnricher

Description

This enricher parses the Input Name and identifies a Given Name and Surname (with a Name Parsing Score confidence percentage). Then the given name is searched in a database of names for the source country code provided in the input. If a given name is matched, a Gender and a Most Frequent Gender (if the given name is unisex) are returned.

This plugin is thread-safe and supports parallel execution.

Plugin parameters

The following table lists the plugin parameters.

Parameter name Mandatory Type Description

Surname Position

Yes

String

Position of the Surname. This parameter is used for parsing the input name to detect the first and last names, and for generating the Full Name output. Possible values (SURNAME_LAST ,SURNAME_FIRST )

Case Transformation

Yes

String

Case transformation for the name. Possible values: NONE, UPPER_CASE, LOWER_CASE and CAMEL_CASE.

Plugin inputs

The following table lists the plugin inputs.

Input name Mandatory Type Description

Input name

Yes

String

Person full name to enrich.

Source Country Code

Yes

String

Code of the country of origin for the name. This code indicates the database of names to search to determine a gender for the given name. Built-in databases include fr for France, us for the USA and ru for Russia.

Plugin outputs

The following table lists the plugin outputs.

Output name Type Description

Full Name

String

The reconstructed full name, with the surname positioned according to the Surname Position parameter.

Gender

String

The gender of the Matched Given Name. One of MALE, FEMALE, UNISEX, UNKNOWN.

Gender Score

String

Confidence with which for Most Frequent Gender can be used [0-100].

Given Name

String

The part identified as Given Name in the input name.

Matched Given Name

String

Given name matched in the given name database.

Most Frequent Gender

String

The more frequent gender of the Matched Given Name for the given country. One of MALE, FEMALE, UNKNOWN.

Names Parsing Score

String

Names Parsing confidence [0-100]

Surname

String

The part identified as Surname in the input name.

Surname Position

String

Position at which the surname was detected.