From 9efca4c761202182ee52e986e1975b5ded8f85e3 Mon Sep 17 00:00:00 2001 From: Ayuei Date: Tue, 27 Jun 2023 12:56:20 +1000 Subject: [PATCH] Added elasticsearch config documentation --- src/debeir/core/config.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/debeir/core/config.py b/src/debeir/core/config.py index b76774a..9cb5799 100644 --- a/src/debeir/core/config.py +++ b/src/debeir/core/config.py @@ -168,6 +168,12 @@ def validate(self): class ElasticsearchConfig(Config): """ Basic Elasticsearch configuration file settings from the master nir.toml file + + Attributes: + protool (int): https or http. + ip: IP address of the elasticsearch index/cluster. + port: port of the elasticsearch index + timeout: the maximum time to wait for a request to finish. Recommended to set to 10 minutes, as dense retrieval is an expensive operation. """ protocol: str ip: str