Merge pull request #17 from Ayuei/documentation

Improved Elasticsearch Documentation
Ayuei · Jun 27, 2023 · b25dd9e · b25dd9e
2 parents e14c1a2 + bc5a1e6
commit b25dd9e
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/configs/elasticsearch.toml b/configs/elasticsearch.toml
@@ -1,4 +1,4 @@
 protocol = "http"
 ip = "127.0.0.1"
 port = "9200"
-timeout = 600
+timeout = 600 # 10 minutes timeout, dense retrieval requests are expensive and may take a while to return results
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