There are two groupings of configuration files.
-
The system configuration files are found in config
. These are the files for overall service configuration. These are files whose names end in .cfg
. These files are in Java property file syntax, and define name-value pairs.
-
The more complex Endpoint and transport rules configuration files are found in launcher/config/rosapi
. These are the files you need to edit to change the input parameters, transport rules, and configuration requirements of the individual endpoints.
System configuration files
These are the configuration files for overall service operation. The perceptive reader may notice that there are endpoint specific configuration files here as well, e.g. dedupe, rni, rnt. The architecture is still evolving.
Location: server/launcher/config
Endpoint and transport rules configuration files
The following files contain configuration parameters for Rosette Server, individual endpoints, and transport rules.
Location: /server/launcher/config/rosapi
Factory configuration files
The worker-config.yaml
file details component factories and the pipelines for each endpoint. A single endpoint may use multiple factories. Use this file to determine which factories you may have to modify to set the configuration values for a task. Some factories, such as rbl-factory-config.yaml
are used by multiple endpoints.
Table 3. Factory Files
File Name
|
Primary Endpoint
|
analyze-factory-config.yaml
|
topics
|
cat-factory-config.yaml
|
categories
|
dp-factory-config.yaml
|
syntax/dependencies
|
rbl-factory-config.yaml
|
morphology
sentences
|
rct-factory-config.yaml
|
transliteration
|
relax-factory-config.yaml
|
relationships
|
rex-factory-config.yaml
|
entities
|
rex-no-resolution-factory-config.yaml
|
topics
entities
|
rli-factory-config.yaml
|
language
|
rni-dedup-factory-config.yaml
|
name-deduplication
|
rni-factory-config.yaml
|
name-similarity
|
rnt-factor-config.yaml
|
name-translation
|
semantic-vectors-factory-config.yaml
|
semantics/vector
|
sent-factory-config.yaml
|
sentiment
|
similar-terms-factory-config.yaml
|
semantics/similar
|
tokenization-factory-config.yaml
|
tokens
|
topics-factory-config.yaml
|
topics
|
Disabling licensed endpoints
Typically, all endpoints which you have active licenses for will load and run when called. Use these instructions to disable specific endpoints.
Warning
We recommend that you do not disable the /language
endpoint as it is used by many endpoints to identify the language of the request.
-
In the server/launcher/config
directory, create a file named override-endpoints.yaml
listing only the endpoints that you want enabled.
endpoints:
- /language
- /entities
- /categories
- /semantics/vector
- /morphology
- /sentences
- /tokens
-
In the server/launcher/config
directory, edit the file com.basistech.ws.worker.config
and specify the overrideEndpointsPathname
parameter. This will be the full path name of the file you created in the previous step. For example, if you installed Rosette in the directory /Users/user/rosette-1.20.3
, the parameter would be:
overrideEndpointsPathname=/Users/user/rosette-1.20.3/server/launcher/config/override-endpoints.yaml
-
Restart Rosette Server for the changes to take effect.
If you call a disabled endpoint, you will receive an "unknownError"
. For example, if you are licensed for the /topics endpoint, but disable it, a call to the endpoint will return the following JSON:
{
"code": "unknownError",
"message": "Worker unsupported target Endpoint{path=/topics}/eng",
"stack": null
}
The /ping
and /info
endpoints are always enabled. They do not have to be listed in the override-endpoints.yaml
file.
Name similarity configuration files
There are two .yaml
files located in the installDirectory/roots/rni-rnt/<version>/rlpnc/data/etc
directory to guide you in configuring the name-similarity endpoint, parameter_defs.yaml
and parameter_profiles.yaml
. The parameter_defs.yaml
file lists the default value for all parameters, along with a short description. This file should not be modified.
To configure the name-similarity results, change the values of the parameters in the parameter_defs.yaml
file. Parameter values can be for all language pairs, or for a specific language pair. If the change is for all languages, use the any:
profile. If a parameter change is for a specific language pair, use the appropriate language code pair. The two language codes are always written in alphabetical order, except for eng
, which always comes last.
Example 1. Add a parameter for all languages
-
Edit the installDirectory/roots/rni-rnt/<version>/rlpnc/data/etc/parameter_defs.yaml
file.
-
Search for any:
-
Add parameterName: parameter value
-
Save
Example 2. Add a parameter for Spanish-English matching
-
Edit the installDirectory/roots/rni-rnt/<version>/rlpnc/data/etc/parameter_defs.yaml
file.
-
Search for the language combination spa_eng:
-
Add parameterName: parameter value
-
Save