Articles in this section

Configure

Avatar
Jason Stevens
  • Updated
Follow

Hover over the Configure tab on the navigation bar to see configuration options. The options are:

  • Match Configurations: Adjust the parameters that determine the match score between two tokens. Sets of parameter values can be saved as match configurations and applied to indices.

  • Overrides: Add or remove token pairs that are considered a match regardless of similarity.

  • Stopwords: Add or remove words that are ignored during string matching so that they do not affect the match score.

Match Configurations

Hover over the Configure tab and select Match Configurations to view the Match Configurations page.

RMS_Configure_Page.PNG

Individual name tokens are scored by a number of algorithms. These algorithms can be optimized by modifying configuration parameters, thus changing the final match score. RMS provides an easy way to compare and test different parameter settings based on your data.

A match configuration contains a set of parameters. Each named match configuration contains parameter values for a specific language pair and entity type. A single named match configuration can contain multiple language pairs and entity types.

The Configure page contains a list of existing match configuration files. You can:

  • Edit an existing match configuration. You cannot edit a match configuration if an evaluation has already been created using the configuration. For the default match configuration, which cannot be edited, this option is replaced with View.

  • Copy an existing match configuration, then edit it, making the changes you'd like to test. This is how you modify an existing match configuration that has been used in an evaluation.

  • Export the match configuration as a .yaml file. This file can be used with RNI-Elasticsearch or re-imported into RMS.

    Important

    The exported .yaml file contains a comment with the RNI-Elasticsearch plugin version number. Only use this configuration file with the indicated version of RNI-Elasticsearch.

  • Delete a match configuration. This option is disabled for the default configuration.

  • Create a New Match Configuration.

  • Import Configuration from valid .yaml file.

Parameters

While RNI contains over 100 parameters, RMS exposes a few of the most commonly modified parameters that are the most likely to have an impact on your data.

RMS Field Name

Description

Behavior

RNI Parameter Name

Initials Score

The score that is assigned to an initial matching a token

Increasing leads to higher final score when there is a match between an initial and a token.

initialsScore

Token Deletion Score

Score applied to an unmatched token when surrounding tokens are matched

Increasing leads to higher final score when there is an unmatched token.

deletionScore

Token Reorder Penalty

Penalty applied to matching tokens with different positions

Increasing leads to lower final score when the tokens aren't in the same position.

reorderPenalty

Token Conflict Score

The score that is assigned to unmatched conflict tokens

Increasing leads to higher final score

conflictScore

Right End Boost

A boost applied to the final score applied to the weights of tokens at the right end of the name.

Increasing leads to a higher score for matches between the surnames in English and other languages where the end of the name is more meaningful. It makes the last token more important.

boostWeightAtRightEnd

New Match Configuration

  1. Select the entity type from the top of the window (Person, Organization, or Location).

  2. Select a language pair from the drop-down.

  3. For each parameter you can adjust the score, either by moving the slider or editing the value in the box.

  4. Continue for other language pairs or entity types, as desired.

  5. Save or Save As

    Each configuration must have a name. If you are creating a new configuration, only Save As will be available. Once you've saved it, you can modify and save the configuration under the same name.

Import Configuration

You can create a new match configuration by importing a valid import file. A match configuration created in this way will have all parameters defined in the file, including parameters not exposed in the RMS UI.

Note

You must have a valid import file. A valid import file is in .yaml format and follows the structure of a RNI-ES parameter configuration file. You can create a valid import file by exporting the default configuration and editing it by adding or modifying parameters.

  1. Select Configure from the navigation bar.

  2. Select Import Configuration.

  3. Name the match configuration.

    Note

    If the name of an existing configuration is provided and the configuration is editable, its values will be overwritten by the import. If the name of an existing configuration is provided and the configuration is not editable, the import will fail. Otherwise, a new match configuration will be created with values from the imported file.

    A match configuration is not editable if an evaluation has already been created using the configuration.

  4. Select OK. The new match configuration appears in the match configuration list.

Export Match Configuration For RNI-Elasticsearch

Important

The exported .yaml file contains a comment with the RNI-Elasticsearch plugin version number. Only use this configuration file with the indicated version of RNI-Elasticsearch.

  1. Select Configure from the navigation bar.

  2. Select Export in the Options column for the desired match configuration.

  3. Rename the downloaded file parameter_profiles.yaml.

  4. Navigate to RNI-ES in your file browser.

  5. Replace the existing parameter_profiles.yaml in plugins/rni/bt_root/rlpnc/data/etc with the version exported in step 2.

For more information on RNI-Elasticsearch parameter configuration files, see Optimizing Name Matching with Parameters.

Overrides

Hover over the Configure tab and select Overrides to view the Overrides page. This page allows you to add or remove token pairs that are considered a match regardless of similarity. You can use this list for things like names with unusual nicknames, such as "Margaret" and "Peggy."

To add a new override:

  1. Select New Override.

  2. Select the language pair. This is the language of each token in the pair. A pair can be two tokens in the same language.

  3. Select the entity type. Supported entity types are PERSON, ORGANIZATION, and LOCATION.

  4. Enter the token for the first language in the language pair.

  5. Enter the token for the second language in the language pair.

  6. Select Save & Close or Save & Add Another.

To find an override:

  1. Select the tab for the override's entity type.

  2. Select the language pair for the override using the dropdown menu.

  3. Search for a token in the override pair using the Search token field. This search field will not show results outside the selected entity type and language pair.

To delete an override:

  1. Find the override using the procedure above.

  2. Select Delete in the Action column for that override.

Stopwords

Hover over the Configure tab and select Stopwords to view the Stopwords page. This page allows you to add or remove words that are ignored during string matching so that they do not affect the match score. You can use this list for parts of names or titles that are not significant when determining a match, such as "Mr." or "Prime Minister."

To add a new stopword:

  1. Select New Stopword.

  2. Enter the stopword in the Token field.

  3. Select whether the stopword is a prefix or a regex.

    • Prefix: A word, letter, or number that is placed before another. An example is "Mr."

    • Regex: Regular expression. A string of characters that defines a search pattern. An example is "\bfnu\b."

  4. Select the language of the stopword.

  5. Select the stopword's entity type. Supported entity types are PERSON, ORGANIZATION, and LOCATION.

  6. Select Save & Close or Save & Add Another.

To find a stopword:

  1. Select the tab for the stopword's entity type.

  2. Select the stopword's language using the dropdown menu.

  3. Select whether the stopword is a prefix or regex using the radio buttons.

  4. Search for the stopword using the Search token field. This search field will not show results outside the selected entity type, language pair, and prefix/regex selection.

To delete a stopword:

  1. Find the stopword using the procedure above.

  2. Select Delete in the Options column for that stopword.

Related articles

Comments

0 comments

Article is closed for comments.





Powered by Zendesk