Re-comment out optional support (#567)

Release  coordination issue -- engine-side support still to come

Author: eob

src/steamship/agents/schema/functions.py

@@ -17,6 +17,10 @@ class JSONType(str, Enum):
 class FunctionProperty(BaseModel):
     """Schema for an individual parameter used in an OpenAI function."""
 
+    class Config:
+        use_enum_values = True
+        """This tells Pydantic to serialize the Enum values as strings, which is VERY IMPORTANT for OpenAI"""
+
     type: JSONType = JSONType.object
     """Type of the property. Defaults to object."""
 
@@ -27,6 +31,10 @@ class FunctionProperty(BaseModel):
 class FunctionParameters(BaseModel):
     """Schema for the description of how to invoke an OpenAI function."""
 
+    class Config:
+        use_enum_values = True
+        """This tells Pydantic to serialize the Enum values as strings, which is VERY IMPORTANT for OpenAI"""
+
     type: JSONType = JSONType.object
     """Type of this object. DO NOT MODIFY."""
 

src/steamship/data/manifest.py

@@ -27,7 +27,7 @@ def from_python_type(t: Type):
 class ConfigParameter(BaseModel):
     type: ConfigParameterType
     description: Optional[str] = None
-    optional: Optional[bool] = None
+    # optional: Optional[bool] = None
 
     # Use strict so that Pydantic doesn't coerce values into the first one that fits
     default: Optional[Union[StrictStr, StrictBool, StrictFloat, StrictInt]] = None

src/steamship/invocable/config.py

@@ -63,10 +63,12 @@ def get_config_parameters(cls) -> Dict[str, ConfigParameter]:
             # the notion of whether the absense of a value will truly be treated as absence.
             # That way it can provide hints to the user to minimize surprise about how their inputs will be interpreted.
 
-            optional_ = field.required is False and field.allow_none is True
+            # optional_ = field.required is False and field.allow_none is True
 
             result[field_name] = ConfigParameter(
-                type=type_, default=default_, description=description, optional=optional_
+                type=type_,
+                default=default_,
+                description=description,  # optional=optional_
             )
 
         return result

tests/steamship_tests/app/unit/test_config_template_extraction.py

@@ -52,8 +52,8 @@ class BoolConfig(Config):
     assert "x" in names
     assert "y" in names
 
-    assert config_template["x"].optional is False
-    assert config_template["y"].optional is False
+    # assert config_template["x"].optional is False
+    # assert config_template["y"].optional is False
 
 
 def test_config_parameter_with_defaults():
@@ -69,16 +69,16 @@ class DefaultsConfig(Config):
 
     assert config_template["w"].type == ConfigParameterType.STRING
     assert config_template["w"].default == "deeeefault"
-    assert config_template["w"].optional is False
+    # assert config_template["w"].optional is False
     assert config_template["x"].type == ConfigParameterType.BOOLEAN
     assert config_template["x"].default  # Assert that the default == True
-    assert config_template["x"].optional is False
+    # assert config_template["x"].optional is False
     assert config_template["y"].type == ConfigParameterType.NUMBER
     assert config_template["y"].default == 3
-    assert config_template["y"].optional is False
+    # assert config_template["y"].optional is False
     assert config_template["z"].type == ConfigParameterType.NUMBER
     assert config_template["z"].default == 7.5
-    assert config_template["z"].optional is False
+    # assert config_template["z"].optional is False
 
 
 def test_optional_config_parameters():
@@ -102,42 +102,42 @@ class DefaultsConfig(Config):
 
     assert config_template["w"].type == ConfigParameterType.STRING
     assert config_template["w"].default == "deeeefault"
-    assert config_template["w"].optional
+    # assert config_template["w"].optional
     assert config_template["x"].type == ConfigParameterType.BOOLEAN
     assert config_template["x"].default  # Assert that the default == True
-    assert config_template["x"].optional
+    # assert config_template["x"].optional
     assert config_template["y"].type == ConfigParameterType.NUMBER
     assert config_template["y"].default == 3
-    assert config_template["y"].optional
+    # assert config_template["y"].optional
     assert config_template["z"].type == ConfigParameterType.NUMBER
     assert config_template["z"].default == 7.5
-    assert config_template["z"].optional
+    # assert config_template["z"].optional
 
     assert config_template["w2"].type == ConfigParameterType.STRING
     assert config_template["w2"].default is None
-    assert config_template["w2"].optional
+    # assert config_template["w2"].optional
     assert config_template["x2"].type == ConfigParameterType.BOOLEAN
     assert config_template["x2"].default is None
-    assert config_template["x2"].optional
+    # assert config_template["x2"].optional
     assert config_template["y2"].type == ConfigParameterType.NUMBER
     assert config_template["y2"].default is None
-    assert config_template["y2"].optional
+    # assert config_template["y2"].optional
     assert config_template["z2"].type == ConfigParameterType.NUMBER
     assert config_template["z2"].default is None
-    assert config_template["z2"].optional
+    # assert config_template["z2"].optional
 
     assert config_template["w3"].type == ConfigParameterType.STRING
     assert config_template["w3"].default is None
-    assert config_template["w3"].optional
+    # assert config_template["w3"].optional
     assert config_template["x3"].type == ConfigParameterType.BOOLEAN
     assert config_template["x3"].default is None
-    assert config_template["x3"].optional
+    # assert config_template["x3"].optional
     assert config_template["y3"].type == ConfigParameterType.NUMBER
     assert config_template["y3"].default is None
-    assert config_template["y3"].optional
+    # assert config_template["y3"].optional
     assert config_template["z3"].type == ConfigParameterType.NUMBER
     assert config_template["z3"].default is None
-    assert config_template["z3"].optional
+    # assert config_template["z3"].optional
 
 
 def test_descriptions():

tests/steamship_tests/utils/test_enums.py

@@ -4,6 +4,7 @@
 import json
 from enum import Enum
 
+from steamship.agents.schema.functions import FunctionParameters, FunctionProperty, JSONType
 from steamship.base.model import CamelModel
 
 
@@ -28,3 +29,17 @@ def test_enum_serialization_behavior():
     assert t2.training_platform == TrainingPlatform.LAMBDA
     assert t1.training_platform == "ecs"
     assert t2.training_platform == "lambda"
+
+
+def test_function_serialization_behavior():
+    property = FunctionProperty(type=JSONType.integer, description="An Int")
+
+    assert property.dict() == {"type": "integer", "description": "An Int"}
+
+    typed_one = FunctionParameters(type=JSONType.object, properties={"key": property})
+
+    assert typed_one.dict() == {
+        "type": "object",
+        "properties": {"key": {"type": "integer", "description": "An Int"}},
+        "required": [],
+    }