use an enum for field type literals

Author: tylerhutcherson

redisvl/schema/fields.py

@@ -17,6 +17,14 @@
 from redis.commands.search.field import VectorField as RedisVectorField
 
 
+class FieldTypes(str, Enum):
+    TAG = "tag"
+    TEXT = "text"
+    NUMERIC = "numeric"
+    GEO = "geo"
+    VECTOR = "vector"
+
+
 class VectorDistanceMetric(str, Enum):
     COSINE = "COSINE"
     L2 = "L2"
@@ -165,7 +173,7 @@ def as_redis_field(self) -> RedisField:
 class TextField(BaseField):
     """Text field supporting a full text search index"""
 
-    type: Literal["text"] = "text"
+    type: Literal[FieldTypes.TEXT] = FieldTypes.TEXT
     attrs: TextFieldAttributes = Field(default_factory=TextFieldAttributes)
 
     def as_redis_field(self) -> RedisField:
@@ -183,7 +191,7 @@ def as_redis_field(self) -> RedisField:
 class TagField(BaseField):
     """Tag field for simple boolean-style filtering"""
 
-    type: Literal["tag"] = "tag"
+    type: Literal[FieldTypes.TAG] = FieldTypes.TAG
     attrs: TagFieldAttributes = Field(default_factory=TagFieldAttributes)
 
     def as_redis_field(self) -> RedisField:
@@ -200,7 +208,7 @@ def as_redis_field(self) -> RedisField:
 class NumericField(BaseField):
     """Numeric field for numeric range filtering"""
 
-    type: Literal["numeric"] = "numeric"
+    type: Literal[FieldTypes.NUMERIC] = FieldTypes.NUMERIC
     attrs: NumericFieldAttributes = Field(default_factory=NumericFieldAttributes)
 
     def as_redis_field(self) -> RedisField:
@@ -215,7 +223,7 @@ def as_redis_field(self) -> RedisField:
 class GeoField(BaseField):
     """Geo field with a geo-spatial index for location based search"""
 
-    type: Literal["geo"] = "geo"
+    type: Literal[FieldTypes.GEO] = FieldTypes.GEO
     attrs: GeoFieldAttributes = Field(default_factory=GeoFieldAttributes)
 
     def as_redis_field(self) -> RedisField:
@@ -230,7 +238,7 @@ def as_redis_field(self) -> RedisField:
 class FlatVectorField(BaseField):
     "Vector field with a FLAT index (brute force nearest neighbors search)"
 
-    type: Literal["vector"] = "vector"
+    type: Literal[FieldTypes.VECTOR] = FieldTypes.VECTOR
     attrs: FlatVectorFieldAttributes
 
     def as_redis_field(self) -> RedisField: