Added elasticsearch config documentation

Ayuei · Jun 27, 2023 · 9efca4c · 9efca4c
1 parent e14c1a2
commit 9efca4c
Showing 1 changed file with 6 additions and 0 deletions.
diff --git 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