Recommender Configuration

The path to the etc/application.properties file. Default value: ${ataccama.path.etc}/application.properties.

The location of the default application.properties file. The default value of this property can be overwritten only through environment variables, otherwise the change is ignored. Default value: ${ataccama.path.lib}/application.properties.

The location of the doc folder of the microservice. Default value: ${ataccama.path.root}/doc.

The location of the etc folder of the microservice. The etc/application.properties path is relative to this path. The default value of this property can be overwritten only through environment variables and the default application.properties file. Otherwise, the change is ignored, which can lead to unexpected behavior. Default value: ${ataccama.path.root}/etc.

The location of the lib folder of the microservice. The default application.properties path is relative to this path. The default value of this property can be overwritten only through environment variables, otherwise the change is ignored. Default value: ${ataccama.path.root}/lib.

The location of the log folder of the microservice. Default value: ${ataccama.path.root}/log.

The location of the migrations folder of the microservice. Default value: ${ataccama.path.lib}/migrations.

The location of the root folder of the microservice. Some configuration paths are defined relatively to this path. The default value of this property can be overwritten only through environment variables, otherwise the change is ignored. Default value: ..

The location of the tmp folder of the microservice. Default value: ${ataccama.path.root}/temp.

The timeout period during which the microservice and its subcomponents need to report as running, otherwise the whole microservice becomes unhealthy and its status changes to DOWN. The microservice also proactively shuts itself down when it registers such a situation. Default value: 120.

A compression or archive format to which log files should be converted when they are closed. Default value: zip.

The name of the file used by the file appender. Default value: ${ataccama.path.log}/{self.microservice_id.module_name}_{self.microservice_id.microservice_name}.log.

Indicates how often the current log file should be closed and a new one started. Default value: 4 days.

The minimum severity level starting from which logged messages are sent to the sink. Default value: INFO.

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. Default value: {"max_attempt_number": 6}.

Controls retrying of gRPC and graphQL communication attempts. The property determines which approach is used to stop retrying. For more information, see the Tenacity API Reference, Stop Functions section. Default value: stop_after_attempt.

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 API Reference, Wait Functions section. Default value: {"multiplier": 0.16, "exp_base": 2}.

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 API Reference, Wait Functions section. Default value: wait_exponential.

Sets for how many seconds the microservice waits after requesting health information about its dependencies, for example, when the Recommender waits for the Neighbors or the Autocomplete waits for MMM. For more information, see the Requests Developer Interface Documentation, section about the timeout parameter. Default value: 5.

Defines the behavior of the microservice while it waits on a dependency before starting. Keyword arguments (kwargs) are the arguments used to construct an instance of the specified wait type. In this case, the keyword argument sets the duration of waiting intervals. Default value: {"wait": 2.5}.

Defines the behavior of the microservice while it waits on a dependency before starting. Currently, the microservice either waits to receive information about the health of the dependency or the database readiness (typically, this means waiting for the database to start and for MMM to create the tables needed). The property defines how waiting periods are managed between unsuccessful attempts to verify the readiness of the dependency. For a list of other available wait types, see the Tenacity API Reference, Wait Functions section. Default value: wait_fixed.

Limits the size of messages that the gRPC client can process. Default value: 1GB. Accepted units: B (bytes), KB (kilobytes), MB (megabytes), GB (gigabytes), TB (terabytes). If no unit is specified, KB is used.

Limits the size of messages that the gRPC server can process. Default value: 1GB. Accepted units: B (bytes), KB (kilobytes), MB (megabytes), GB (gigabytes), TB (terabytes). If no unit is specified, KB is used.

The value of the HTTP Strict-Transport-Security (HSTS) response header. Used only when HTTPS is enabled. Informs browsers that the resource should only be accessed using the HTTPS protocol. Default value: max-age=31536000; includeSubDomains; preload.

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 0, all CPU cores run without hyper-threads. If the value is not set (null), other properties are not overridden. Relies on the static OpenBLAS API and might be ignored depending on the compilation options for the OpenBLAS library. When this property is set, OpenBLAS gives it higher priority compared to ataccama.one.apyc.parallelism.omp. This is intended only for exceptional cases and should not be used otherwise. Default value: null.

The number of parallel threads or processes spawned by high-level machine learning algorithms with explicit job management. If the value is set to 0, all CPU cores run without hyper-threads. If the value is not set (null), the library default settings are applied. Use this option together with ataccama.one.apyc.parallelism.omp. For more information, see the Sizing Guidelines. Default value: 1.

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 0, all CPU cores run without hyper-threads. If the value is not set (null), the library default settings are applied. The property relies on the static OpenBLAS API and OpenMP API, which have a lower overhead than the dynamic API used by the property ataccama.one.apyc.parallelism.threads. When this property is set, the OpenBLAS library gives it lower priority compared to ataccama.one.apyc.parallelism.blas. Several low-level libraries other than OpenBLAS and LAPACK, as well as libraries that use OpenMP, respect this option as well. Use this option together with ataccama.one.apyc.parallelism.jobs. For more information, see the Sizing Guidelines. Default value: 1.

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 0, all CPU cores run without hyper-threads. If the value is not set (null), the dynamic API is not used. Relies on the dynamic OpenBLAS API, which has a higher overhead than the static API used by ataccama.one.apyc.parallelism.omp. When this property is set, OpenBLAS gives it higher priority compared to ataccama.one.apyc.parallelism.omp and ataccama.one.apyc.parallelism.blas. The dynamic API is intended only for exceptional cases and should not be used otherwise. Default value: null.

Points to the keystore containing the symmetric key that is used to decrypt properties with I context, for example: file:${ataccama.path.etc}/key-store.pkcs12. Default value: null.

The password for the keystore. Used if the keystore is encrypted. To use an empty password, set the value to an empty string (""). Default value: null.

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. Default value: null.

The type of the keystore. Possible types are PKCS12, JKS, and JCEKS. Default value: null.

Points to the keystore containing the symmetric key that is used to decrypt properties with P context, for example, file:${ataccama.path.etc}/key-store.pkcs12. Default value: null.

The password for the keystore. Used if the keystore is encrypted. To use an empty password, set the value to an empty string (""). Default value: null.

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 properties.encryption.key-store-password. Default value: null.

The type of the keystore. Possible types are PKCS12, JKS, and JCEKS. Default value: null.

Sets the SQLAlchemy engine options, such as the maximum length of identifiers used in the database. For more information, see the Engine Configuration, section Engine Creation API, Parameters. Default value: {"max_identifier_length": 128}.

Defines how often the microservice polls the database for changes. Expressed in seconds. Default value: 1.

The target ratio of term suggestions that users approved to the total number of suggestions, both approved and rejected, that the Recommender is trying to achieve. This is done by slowly adapting the similarity threshold for each term over time. Default value: 0.8.

The default starting distance threshold for newly created terms. The distance threshold defines how close the fingerprints need to be so that, if one of them has some terms assigned, the Recommender suggests those terms to the other one as well. It also affects the confidence of suggestions. Default value: 1.0.

The gRPC port of the server where the Neighbors microservice is running. Default value: 8542.

The IP address or the URL of the server where the Neighbors microservice is running. Default value: localhost.

The HTTP port of the server where the Neighbors microservice is running. Default value: 8042.

The number of attributes for which term suggestions are recomputed at once by the Recommender service. If the batch size is too small, the database is queried too often and the computation is inefficient. If the batch size is too large, the process can take a long time, which in turn can render the Recommender unresponsive for the duration of the request and require more memory resources. Default value: 1000.

The network address to which the Recommender HTTP server should bind. Default value: 0.0.0.0.

The HTTP port where the Recommender microservice is running. Default value: 8041.

Sets the highest possible value for the similarity threshold (see the recommender.target-accuracy property). This value cannot be surpassed even when users consistently accept all term suggestions, which results in the Recommender attempting to further expand the threshold in order to lower the acceptance rate and meet the target accuracy. Default value: 16.