Dynamic Configuration Endpoints

The POST_stopword adds one or more stop words. The entity_type field is optional, but the other fields are all required.

The GET _stopwords method returns all stop words for a given language and stop word type. You can search by just language or by language and type.

Returns all prefix stop words for PERSON types in English:

Returns all regex stop words for ORGANIZATION types in Japanese:

Returns all prefix stop words in English with no type specified:

The DELETE _stopwords method deletes a specified stop word.

The POST _overrides adds one or more token overrides. As shown in the table above, entity_type and force are optional, but the other fields are required.

curl -XPOST "http://localhost:9200/rni_plugin/_overrides" -H 'Content-Type: application/json' -d'{
        "lang1": "eng",
        "lang2": "eng",
        "entity_type": "PERSON",
        "token_pairs": 
        [{
        "token1": "Abigail",
        "token2": "Abbey",
        "score": 0.74,
        "force": true},
        {
        "token1": "Aleksander",
        "token2": "Alex",
        "score": 0.74},
        {
        "token1": "Alfonso",
        "token2": "Alphonse",
        "score": 0.74},
        {
        "token1": "Frederica",
        "token2": "Federica",
        "score": 0.74}]}'

The POST _overrides/_update method updates the score / force values of a given override pair.

The following syntax is also correct. It requires you specify the language profile (using the respective ISO 639-3 codes) the token override pair belongs to and, optionally, the entity type. If the entity type is not specified, it defaults to ALL .

The GET _overrides method returns the overrides of a given language profile.

You can also retrieve the score of a given override pair.

The DELETE _overrides method deletes a given override pair.

The POST _parameter_universe method creates a parameter universe and the parameter profiles within the universe. If you try to add a parameter universe that already exists, it overrides it with the new values. The parameter universe method uses the following syntax:

SomeParameterUniverseName/xxx_yyy where xxx_yyy is the language profile the parameters belong to expressed in ISO 639-3 codes. The parameters field expects a list of parameters for the given profile where the naming of the parameters should match the ones declared in parameter_defs.yaml

curl -XPOST "http://localhost:9200/rni_plugin/_parameter_universe" -H 'Content-Type: application/json' -d'
  {
    "profiles": [
      {
        "name": "SomeParameterUniverseName/any",
        "parameters": {
          "translatorResultsToKeep": 4,
          "deletionScore": 0.269,
          "doQueryTokenOverrides": true,
          "fieldDeletionScore": 0.27,
          "yearDistanceWeight": 0.2
        }
      },
      {
        "name": "SomeParameterUniverseName/eng_eng",
        "parameters": {
          "HMMUsageThreshold": 0.8,
          "stringDistanceThreshold": 0.1,
          "useEditDistanceTokenScorer": true,
          "finalBias": 2.4,
          "reorderPenalty": 0.2
        }
      }
    ]
  }'

The POST _parameter_universe/_update updates the values of existing parameters. You need to provide the parameter universe name along with the parameters and their values. If a parameter doesn’t exist it is ignored.

curl -XPOST "http://localhost:9200/rni_plugin/_parameter_universe/_update" -H 'Content-Type: application/json' -d'{ "profiles": [  {
      "name": "SomeParameterUniverseName/any",
      "parameters": {
        "translatorResultsToKeep": 4
      }
    },
    {
      "name": "SomeParameterUniverseName/eng_eng",
      "parameters": {
        "useEditDistanceTokenScorer": false,
        "finalBias": 2.4,
        "reorderPenalty": 0.2
      }
    }
  ]
}'    

You can also use query parameters to update the value of a parameter. The name of the parameter universe is included as a path parameter. You must then specify two query parameters: param and value. param is made up of the language profile followed by the name of the parameter, value contains the value of the parameter.

curl -XPOST "http://localhost:9200/rni_plugin/_parameter_universe/SomeParameterUniverseName\
/_update?param=eng_eng.reorderPenalty&value=0.2"
        

The GET _parameter_universe method retrieves a given parameter universe. The name of the parameter universe is provided as a path parameter:

If you add the name of the profile and parameter, it returns the value of the parameter.

The DELETE _parameter_universe method deletes the parameter universe provided as a path parameter.

If you add the name of the profile and parameter, it deletes the parameter from the parameter universe. It will then use the value in the parameter_defs.yaml file.