Example

Create a profile-data-root, called rosette-users in the Users directory.

Create a user with the profileId of group1. The new profile-path is:

/Users/rosette-users/group1

Edit the Rosette Server configuration files:

adding the profile-data-root.

# profile data root folder that may contain app-id/profile-id/{rex,tcat} etc
profile-data-root=file:///Users/rosette-users

Copy the rex-factory-config.yaml file from /config/rosapi into the new directory:

/Users/rosette-users/group1/config/rosapi/rex-factory-config.yaml

Edit the copied file, setting the dataOverlayDirectory parameter and adding the path for the new regex file. The overlay directory is a directory shaped like the data directory. The entities endpoint will look for files in both locations, preferring the version in the overlap directory.

dataOverlayDirectory: "/Users/rosette-users/group1/custom-rex/data"

supplementalRegularExpressionPaths:
- "/Users/rosette-users/group1/custom-rex/data/regex/eng/accept/supplemental/custom-regexes.xml"

Create the file custom-regexes.xml in the /Users/rosette-users/group1/custom-rex/data/regex/eng/accept/supplemental directory.

<regexps>
  <regexp type="COLOR">(?i)red|white|blue|black</regexp>
  <regexp type="ANIMAL">(?i)bear|tiger|whale</regexp>
</regexps>

Call the entities endpoint without using the custom profile:

 curl -s -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Cache-Control: no-cache" \
    -d '{"content": "The black bear fought the white tiger at London Zoo." }' \
    "http://localhost:8181/rest/v1/entities"

The only entity returned is London Zoo:

{
  "entities": [
    {
      "type": "LOCATION",
      "mention": "London Zoo",
      "normalized": "London Zoo",
      "count": 1,
      "mentionOffsets": [
        {
          "startOffset": 41,
          "endOffset": 51
        }
      ],
      "entityId": "T0"
    }
  ]
}

Call the entities endpoint, adding the profileId to the call:

curl -s -X POST \ -H "Content-Type: application/json" \ 
-H "Accept: application/json" \ 
-H "Cache-Control: no-cache" \ 
-d '{"content": "The black bear fought the white tiger at London Zoo.", 
     "profileId": "group1"}' \ 
"http://localhost:8181/rest/v1/entities"

The new colors and animals are also returned:

    "entities": [
        {
            "type": "COLOR",
            "mention": "black",
            "normalized": "black",
            "count": 1,
            "mentionOffsets": [
                {
                    "startOffset": 4,
                    "endOffset": 9
                }
            ],
            "entityId": "T0"
        },
        {
            "type": "ANIMAL",
            "mention": "bear",
            "normalized": "bear",
            "count": 1,
            "mentionOffsets": [
                {
                    "startOffset": 10,
                    "endOffset": 14
                }
            ],
            "entityId": "T1"
        },
        {
            "type": "COLOR",
            "mention": "white",
            "normalized": "white",
            "count": 1,
            "mentionOffsets": [
                {
                    "startOffset": 26,
                    "endOffset": 31
                }
            ],
            "entityId": "T2"
        },
        {
            "type": "ANIMAL",
            "mention": "tiger",
            "normalized": "tiger",
            "count": 1,
            "mentionOffsets": [
                {
                    "startOffset": 32,
                    "endOffset": 37
                }
            ],
            "entityId": "T3"
        },
        {
            "type": "LOCATION",
            "mention": "London Zoo",
            "normalized": "London Zoo",
            "count": 1,
            "mentionOffsets": [
                {
                    "startOffset": 41,
                    "endOffset": 51
                }
            ],
            "entityId": "T4"
        }