AI Matching Configuration
The following properties configure AI Matching microservices - Matching Manager and Matching Worker - and are provided via OS environment variables.
Make sure that the
|
Matching Manager
Property | Data Type | Default Value | Description |
---|---|---|---|
|
Boolean |
|
Forwards stdout and stderr streams of the computation process to the respective stdout and stderr streams of the wrapping service for debugging purposes. |
|
String |
/ |
List of job types the service can run in a separate process.
Allowed values are: |
|
String |
|
The path to the |
|
Number |
|
Defines how often the service runs its background processing thread to check if it should run available job in a process. Expressed in seconds. |
|
Number |
|
Defines the amount of time the wrapping service waits for its job subprocess to shutdown gracefully. Kills the subprocess otherwise. Expressed in seconds. |
|
String |
/ |
List of job types the service can run in a separate thread.
Allowed values are: |
|
Number |
|
Defines how often the service runs its background processing thread to check if it should run available job in a thread. Expressed in seconds. |
|
Boolean |
|
Flag used to enable |
|
Number |
|
The dedupe clustering decision threshold that functions as a compromise between precision and recall.
The value needs to be between |
|
Number |
|
The number of records that are uniformly sampled from all the records fetched from MDM. Those records are the only ones used for initializing and training the AI Matching model. |
|
Number |
|
The number of records that the AI Matching selects out of the records covered by the property |
|
Number |
|
The maximum number of columns in one extracted rule. A higher number means that the extracted rules can be more complex, that is, use more columns, but the rule extraction might take significantly longer. |
|
Number |
|
The maximum number of confident negative pairs to be considered for rule extraction. A higher number means that the extraction of rules is significantly slower but the results could be more precise. |
|
Number |
|
The maximum number of confident positive pairs to be considered for rule extraction. A higher number means that the extraction of rules is significantly slower but the results could be more precise. |
|
Boolean |
|
Enables basic authentication on the grpc server. If enabled, Keycloak becomes a mandatory dependency - needs to be running before the microservice starts. |
|
Boolean |
|
Enables bearer authentication on the grpc server. If enabled, Keycloak becomes a mandatory dependency - needs to be running before the microservice starts. |
|
Boolean |
|
Enables internal JWT token authentication on the grpc server. |
|
Boolean |
`True |
Enables basic authentication on the http server. If enabled, Keycloak becomes a mandatory dependency - needs to be running before the microservice starts. |
|
Boolean |
|
Enables bearer authentication on the http server. If enabled, Keycloak becomes a mandatory dependency - needs to be running before the microservice starts. |
|
Boolean |
|
Enables internal JWT token authentication on the http server. |
|
String |
/ |
The private key of the microservice used to generate tokens for internal JWT authentication. |
|
Number |
|
Defines the amount of time after which the token generated by the internal JWT generator expires. Expressed in seconds. |
|
String |
|
Role used for validating that service sending request to the microservice can impersonate a user. |
|
String |
/ |
The name of the Keycloak realm. Used when requesting an access token during authorization. |
|
String |
|
The expected recipients of the Keycloak token.
Used to validate the access (bearer) token obtained from Keycloak.
If the value is |
|
String |
/ |
The client token identifier of the microservice. Used when requesting an access token during authorization. |
|
String |
|
The expected algorithm that was used to sign the access (bearer) token obtained from Keycloak. |
|
String |
|
The issuer of the Keycloak token.
Used to validate the access (bearer) token obtained from Keycloak.
If the value is |
|
Number |
|
Defines the minimum amount of time between two consecutive requests for Keycloak certificates during which Keycloak is not asked for new certificates. This acts as a prevention against DDoS attacks with an unknown key. Expressed in seconds. |
|
Number |
|
Defines how long the public certificates from Keycloak are cached on the microservice side. If this time is exceeded, new certificates are fetched from Keycloak before the microservice makes an attempt to authenticate. If this time is not exceeded, but the public certificate for the key parsed from the authentication attempt was not found in the cache, new certificates are fetched from Keycloak and authentication is attempted again. Expressed in seconds. |
|
String |
/ |
The secret key of the microservice client. Used when requesting an access token during authorization. |
|
String |
/ |
The IP address or the URL of the server where the |
|
Number |
|
The maximum size of gRPC message. KB are used if no unit is specified. |
|
Number |
/ |
The gRPC port of the server where the |
|
String |
|
Points to the |
|
Boolean |
|
Defines whether the grpc client should use TLS when communicating with the server. |
|
Boolean |
|
Defines whether the grpc client should verify the certificate of the server with which it communicates. |
|
String |
|
Base path to which the` <connection_name>` HTTP client sends requests. |
|
Number |
|
Defines after which amount of time the HTTP call is ended if the socket does not receive any bytes. Expressed in seconds. |
|
String |
/ |
The IP address or the URL of the server where the |
|
Number |
|
The HTTP port of the server where the |
|
String |
|
Points to the |
|
Boolean |
|
Defines whether the http client should use TLS when communicating with the server. |
|
Boolean |
|
Defines whether the http client should verify the certificate of the server with which it communicates. |
|
String |
|
Base path to which the keycloak HTTP client sends requests. |
|
Number |
|
Defines after which amount of time the HTTP call is ended if the socket does not receive any bytes. Expressed in seconds. |
|
String |
/ |
The IP address or the URL of the server where the keycloak is running. |
|
Number |
|
The HTTP port of the server where the keycloak is running. |
|
String |
|
Points to the |
|
Boolean |
|
Defines whether the http client should use TLS when communicating with the server. |
|
Boolean |
|
Defines whether the http client should verify the certificate of the server with which it communicates. |
|
String |
/ |
The host for the microservice database. |
|
String |
/ |
The password for the microservice database. |
|
String |
/ |
The username for the microservice database. |
|
String |
|
Sets the SQLAlchemy engine options, such as the maximum length of identifiers used in the database. For more information, see the official SQLAlchemy documentation: Engine Configuration, section Engine Creation API, Parameters. |
|
String |
|
The location of the |
|
Number |
|
Defines how often the database is polled for changes. Used by the Term Suggestions microservice. Expressed in seconds. |
|
String |
|
The network address to which the service gRPC server should bind. |
|
Number |
|
The maximum size of gRPC message. KB are used if no unit is specified. |
|
Number |
/ |
The port where the service gRPC server is running. |
|
String |
|
The network address to which the service http server should bind. |
|
Number |
/ |
The port where the service http server is running. |
|
String |
|
A compression or archive format to which log files should be converted when they are closed. |
|
String |
|
The name of the file used by the file appender. |
|
Boolean |
|
Enables JSON console appender. Only one console appender can be enabled at a time. |
|
Boolean |
|
Enables JSON file appender. Only one file appender can be enabled at a time. |
|
Boolean |
|
Enables plain text console appender. Only one console appender can be enabled at a time. |
|
Boolean |
|
Enables plain text file appender. Only one file appender can be enabled at a time. |
|
String |
|
The minimum severity level starting from which logged messages are sent to the sink. |
|
String |
|
Indicates how often the current log file should be closed and a new one started. |
|
Number |
|
An alternative way of overriding the number of parallel threads spawned by low-level calculations that are used by machine learning algorithms.
If the value is set to |
|
Number |
|
The number of parallel threads or processes spawned by high-level machine learning algorithms with explicit job management.
If the value is set to |
|
Number |
|
The number of parallel threads spawned by low-level calculations that are used by high-level machine learning algorithms.
If the value is set to |
|
Number |
|
An alternative way of setting the number of parallel threads spawned by low-level calculations that are used by machine learning algorithms.
If the value is set to |
|
String |
/ |
The module (component) name that the deployment belongs to (for example |
|
String |
/ |
The public part of the JWT key that is used decode and verify the payload. |
|
String |
/ |
The key id ( |
|
Boolean |
|
If |
|
String |
|
The list of roles that the deployment has (for example, |
|
String |
/ |
The URI where the deployment runs (for example |
|
String |
|
Controls retrying of gRPC and graphQL communication attempts. The property determines when retrying stops. By default, retrying stops after 6 attempts in total, out of which 5 are retries. |
|
String |
|
Controls retrying of gRPC and graphQL communication attempts. The property determines which approach is used to stop retrying. For more information, see the Tenacity documentation: Tenacity API Reference, section Stop Functions. |
|
String |
|
Controls retrying of gRPC and graphQL communication attempts. The property is used to calculate the duration of waiting periods between retries. For more information about how waiting periods between unsuccessful attempts are managed, see the Tenacity documentation: Tenacity API Reference, section Wait Functions. |
|
String |
|
Controls retrying of gRPC and graphQL communication attempts. The property determines which approach is used when waiting. For more information about how waiting periods between unsuccessful attempts are managed, see the Tenacity documentation: Tenacity API Reference, section Wait Functions. |
|
String |
|
The single-line file containing the password for the keystore. When reading the file, UTF-8 encoding is assumed. Used if the keystore is encrypted. If specified, the property overrides the value of internal.encryption.key-store-password. |
|
String |
|
The password for the keystore.
Used if the keystore is encrypted.
For empty password, set the option to empty string ( |
|
String |
/ |
Points to the JCEKS keystore containing symmetric key that is used to decrypt properties with |
|
String |
|
The single-line file containing the password for the keystore. When reading the file, UTF-8 encoding is assumed. Used if the keystore is encrypted. If specified, the property overrides the value of property.encryption.key-store-password. |
|
String |
|
The password for the keystore.
Used if the keystore is encrypted. For empty password, set the option to empty string ( |
|
String |
/ |
Points to the JCEKS keystore containing symmetric key that is used to decrypt properties with |
Matching Worker
Property | Data Type | Default Value | Description |
---|---|---|---|
|
Boolean |
|
Forwards stdout and stderr streams of the computation process to the respective stdout and stderr streams of the wrapping service for debugging purposes. |
|
String |
/ |
List of job types the service can run in a separate process.
Allowed values are: |
|
String |
|
The path to the |
|
Number |
|
Defines how often the service runs its background processing thread to check if it should run available job in a process. Expressed in seconds. |
|
Number |
|
Defines the amount of time the wrapping service waits for its job subprocess to shutdown gracefully. Kills the subprocess otherwise. Expressed in seconds. |
|
String |
/ |
List of job types the service can run in a separate thread.
Allowed values are: |
|
Number |
|
Defines how often the service runs its background processing thread to check if it should run available job in a thread. Expressed in seconds. |
|
Boolean |
|
Flag used to enable |
|
Number |
|
The dedupe clustering decision threshold that functions as a compromise between precision and recall.
The value needs to be between |
|
Number |
|
The number of records that are uniformly sampled from all the records fetched from MDM. Those records are the only ones used for initializing and training the AI Matching model. |
|
Number |
|
The number of records that the AI Matching selects out of the records covered by the property |
|
Number |
|
The maximum number of columns in one extracted rule. A higher number means that the extracted rules can be more complex, that is, use more columns, but the rule extraction might take significantly longer. |
|
Number |
|
The maximum number of confident negative pairs to be considered for rule extraction. A higher number means that the extraction of rules is significantly slower but the results could be more precise. |
|
Number |
|
The maximum number of confident positive pairs to be considered for rule extraction. A higher number means that the extraction of rules is significantly slower but the results could be more precise. |
|
Boolean |
|
Enables basic authentication on the grpc server. If enabled, Keycloak becomes a mandatory dependency - needs to be running before the microservice starts. |
|
Boolean |
|
Enables bearer authentication on the grpc server. If enabled, Keycloak becomes a mandatory dependency - needs to be running before the microservice starts. |
|
Boolean |
|
Enables internal JWT token authentication on the grpc server. |
|
Boolean |
|
Enables basic authentication on the http server. If enabled, Keycloak becomes a mandatory dependency - needs to be running before the microservice starts. |
|
Boolean |
|
Enables bearer authentication on the http server. If enabled, Keycloak becomes a mandatory dependency - needs to be running before the microservice starts. |
|
Boolean |
|
Enables internal JWT token authentication on the http server. |
|
String |
/ |
The private key of the microservice used to generate tokens for internal JWT authentication. |
|
Number |
|
Defines the amount of time after which the token generated by the internal JWT generator expires. Expressed in seconds. |
|
String |
|
Role used for validating that service sending request to the microservice can impersonate a user. |
|
String |
/ |
The name of the Keycloak realm. Used when requesting an access token during authorization. |
|
String |
|
The expected recipients of the Keycloak token.
Used to validate the access (bearer) token obtained from Keycloak.
If the value is |
|
String |
/ |
The client token identifier of the microservice. Used when requesting an access token during authorization. |
|
String |
|
The expected algorithm that was used to sign the access (bearer) token obtained from Keycloak. |
|
String |
|
The issuer of the Keycloak token.
Used to validate the access (bearer) token obtained from Keycloak.
If the value is |
|
Number |
|
Defines the minimum amount of time between two consecutive requests for Keycloak certificates during which Keycloak is not asked for new certificates. This acts as a prevention against DDoS attacks with an unknown key. Expressed in seconds. |
|
Number |
|
Defines how long the public certificates from Keycloak are cached on the microservice side. If this time is exceeded, new certificates are fetched from Keycloak before the microservice makes an attempt to authenticate. If this time is not exceeded, but the public certificate for the key parsed from the authentication attempt was not found in the cache, new certificates are fetched from Keycloak and authentication is attempted again. Expressed in seconds. |
|
String |
/ |
The secret key of the microservice client. Used when requesting an access token during authorization. |
|
String |
/ |
The IP address or the URL of the server where the |
|
Number |
|
The maximum size of gRPC message. KB are used if no unit is specified. |
|
Number |
/ |
The gRPC port of the server where the <connection_name> is running. |
|
String |
|
Points to the |
|
Boolean |
|
Defines whether the grpc client should use TLS when communicating with the server. |
|
Boolean |
|
Defines whether the grpc client should verify the certificate of the server with which it communicates. |
|
String |
|
Base path to which the |
|
Number |
|
Defines after which amount of time the HTTP call is ended if the socket does not receive any bytes. Expressed in seconds. |
|
String |
/ |
The IP address or the URL of the server where the |
|
Number |
|
The HTTP port of the server where the |
|
String |
|
Points to the |
|
Boolean |
|
Defines whether the http client should use TLS when communicating with the server. |
|
Boolean |
|
Defines whether the http client should verify the certificate of the server with which it communicates. |
|
String |
|
Base path to which the keycloak HTTP client sends requests. |
|
Number |
|
Defines after which amount of time the HTTP call is ended if the socket does not receive any bytes. Expressed in seconds. |
|
String |
/ |
The IP address or the URL of the server where the keycloak is running. |
|
Number |
|
The HTTP port of the server where the keycloak is running. |
|
String |
|
Points to the |
|
Boolean |
|
Defines whether the http client should use TLS when communicating with the server. |
|
Boolean |
|
Defines whether the http client should verify the certificate of the server with which it communicates. |
|
String |
/ |
The IP address or the URL of the server where the mdm is running. |
|
Number |
|
The maximum size of gRPC message. KB are used if no unit is specified. |
|
Number |
/ |
The gRPC port of the server where the mdm is running. |
|
String |
|
Points to the |
|
Boolean |
|
Defines whether the grpc client should use TLS when communicating with the server. |
|
Boolean |
|
Defines whether the grpc client should verify the certificate of the server with which it communicates. |
|
String |
/ |
The host for the microservice database. |
|
String |
/ |
The password for the microservice database. |
|
String |
/ |
The username for the microservice database. |
|
String |
|
Sets the SQLAlchemy engine options, such as the maximum length of identifiers used in the database. For more information, see the SQLAlchemy documentation: Engine Configuration, section Engine Creation API, Parameters. |
|
String |
|
The location of the |
|
Number |
|
Defines how often the database is polled for changes. Used by the Term Suggestions microservice. Expressed in seconds. |
|
String |
|
The network address to which the service gRPC server should bind. |
|
Number |
|
The maximum size of gRPC message. KB are used if no unit is specified. |
|
Number |
/ |
The port where the service gRPC server is running. |
|
String |
|
The network address to which the service http server should bind. |
|
Number |
/ |
The port where the service http server is running. |
|
String |
|
A compression or archive format to which log files should be converted when they are closed. |
|
String |
|
The name of the file used by the file appender. |
|
Boolean |
|
Enables JSON console appender. Only one console appender can be enabled at a time. |
|
Boolean |
|
Enables JSON file appender. Only one file appender can be enabled at a time. |
|
Boolean |
|
Enables plain text console appender. Only one console appender can be enabled at a time. |
|
Boolean |
|
Enables plain text file appender. Only one file appender can be enabled at a time. |
|
String |
|
The minimum severity level starting from which logged messages are sent to the sink. |
|
String |
|
Indicates how often the current log file should be closed and a new one started. |
|
Number |
|
An alternative way of overriding the number of parallel threads spawned by low-level calculations that are used by machine learning algorithms.
If the value is set to |
|
Number |
|
The number of parallel threads or processes spawned by high-level machine learning algorithms with explicit job management.
If the value is set to |
|
Number |
|
The number of parallel threads spawned by low-level calculations that are used by high-level machine learning algorithms.
If the value is set to |
|
Number |
|
An alternative way of setting the number of parallel threads spawned by low-level calculations that are used by machine learning algorithms.
If the value is set to |
|
String |
/ |
The module (component) name that the deployment belongs to (for example |
|
String |
/ |
The public part of the JWT key that is used decode and verify the payload. |
|
String |
/ |
The key id ( |
|
Boolean |
|
If |
|
String |
|
The list of roles that the deployment has (for example |
|
String |
/ |
The URI where the deployment runs (for example |
|
String |
|
Controls retrying of gRPC and graphQL communication attempts. The property determines when retrying stops. By default, retrying stops after 6 attempts in total, out of which 5 are retries. |
|
String |
|
Controls retrying of gRPC and graphQL communication attempts. The property determines which approach is used to stop retrying. For more information, see the Tenacity documentation: Tenacity API Reference, section Stop Functions. |
|
String |
|
Controls retrying of gRPC and graphQL communication attempts. The property is used to calculate the duration of waiting periods between retries. For more information about how waiting periods between unsuccessful attempts are managed, see the Tenacity documentation: Tenacity API Reference, section Wait Functions. |
|
String |
|
Controls retrying of gRPC and graphQL communication attempts. The property determines which approach is used when waiting. For more information about how waiting periods between unsuccessful attempts are managed, see the Tenacity documentation: Tenacity API Reference, section Wait Functions. |
|
String |
|
The single-line file containing the password for the keystore. When reading the file, UTF-8 encoding is assumed. Used if the keystore is encrypted. If specified, the property overrides the value of internal.encryption.key-store-password. |
|
String |
|
The password for the keystore.
Used if the keystore is encrypted.
For empty password, set the option to empty string ( |
|
String |
/ |
Points to the JCEKS keystore containing symmetric key that is used to decrypt properties with |
|
String |
|
The single-line file containing the password for the keystore. When reading the file, UTF-8 encoding is assumed. Used if the keystore is encrypted. If specified, the property overrides the value of property.encryption.key-store-password. |
|
String |
|
The password for the keystore.
Used if the keystore is encrypted. For empty password, set the option to empty string ( |
|
String |
/ |
Points to the JCEKS keystore containing symmetric key that is used to decrypt properties with |
Was this page useful?