Update settings_object.py (#497)

Co-authored-by: Joshua <[email protected]>
marqo-ai · Oct 26, 2023 · 2daf885 · 2daf885
1 parent dbd7d6a
commit 2daf885
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/marqo/tensor_search/models/settings_object.py b/src/marqo/tensor_search/models/settings_object.py
@@ -1,3 +1,7 @@
+"""
+The settings object should be validated by JSON schema, rather than PyDantic, so that it can be used as a template for
+documentation and potentially front-end validation (for usability). 
+"""
 from marqo.tensor_search import enums as ns_enums
 from marqo.tensor_search.enums import IndexSettingsField as NsFields, EnvVars, ObjectStores
 from marqo.tensor_search.utils import read_env_vars_and_defaults, read_env_vars_and_defaults_ints