4754 - added required property

Author: marko-kriskovic

client/src/pages/platform/workflow-editor/components/properties/hooks/useProperty.ts

@@ -400,12 +400,10 @@ export const useProperty = ({
             mapEntries.push(`'options': {${optionValues}}`);
         }
 
-        if (mapEntries.length === 0) {
-            return `=fromAi('${name}', '${type}')`;
-        }
+        mapEntries.push(`'required': ${required}`);
 
         return `=fromAi('${name}', '${type}', {${mapEntries.join(', ')}})`;
-    }, [defaultValue, description, formattedOptions, name, type]);
+    }, [defaultValue, description, formattedOptions, name, required, type]);
 
     const isValidControlType = useMemo(
         () => controlType && INPUT_PROPERTY_CONTROL_TYPES.includes(controlType),

server/libs/ai/ai-tool-api/src/main/java/com/bytechef/ai/tool/FromAi.java

@@ -80,6 +80,7 @@ public TypedValue execute(EvaluationContext context, Object target, Object... ar
         String description = null;
         Object defaultValue = null;
         List<Object> options = null;
+        boolean required = false;
 
         if (arguments.length > 2) {
             Object thirdArgument = arguments[2];
@@ -106,6 +107,16 @@ public TypedValue execute(EvaluationContext context, Object target, Object... ar
 
                     options = castedOptions;
                 }
+
+                Object requiredArg = paramMap.get("required");
+
+                if (requiredArg != null && !(requiredArg instanceof Boolean)) {
+                    throw new IllegalArgumentException("fromAi 'required' in map must be a boolean.");
+                }
+
+                if (requiredArg instanceof Boolean requiredBool) {
+                    required = requiredBool;
+                }
             } else {
                 if (thirdArgument != null && !(thirdArgument instanceof String)) {
                     throw new IllegalArgumentException("fromAi description argument must be a String or null.");
@@ -134,6 +145,6 @@ public TypedValue execute(EvaluationContext context, Object target, Object... ar
             }
         }
 
-        return new TypedValue(new FromAiResult(name, type, description, defaultValue, options));
+        return new TypedValue(new FromAiResult(name, type, description, defaultValue, options, required));
     }
 }

server/libs/ai/ai-tool-api/src/main/java/com/bytechef/ai/tool/FromAiResult.java

@@ -30,7 +30,7 @@
  * @param defaultValue fallback value when the AI model does not provide one (nullable)
  * @author Ivica Cardic
  */
-public record FromAiResult(String name, String type, String description, Object defaultValue, List<Object> options) {
+public record FromAiResult(String name, String type, String description, Object defaultValue, List<Object> options, boolean required) {
 
     private static final String DEFAULT_TYPE = "STRING";
 
@@ -40,18 +40,18 @@ public record FromAiResult(String name, String type, String description, Object
     }
 
     public FromAiResult(String name) {
-        this(name, DEFAULT_TYPE, null, null, null);
+        this(name, DEFAULT_TYPE, null, null, null, false);
     }
 
     public FromAiResult(String name, String type) {
-        this(name, type, null, null, null);
+        this(name, type, null, null, null, false);
     }
 
     public FromAiResult(String name, String type, String description) {
-        this(name, type, description, null, null);
+        this(name, type, description, null, null, false);
     }
 
     public FromAiResult(String name, String type, String description, Object defaultValue) {
-        this(name, type, description, defaultValue, null);
+        this(name, type, description, defaultValue, null, false);
     }
 }

server/libs/ai/ai-tool-api/src/main/java/com/bytechef/ai/tool/util/FromAiInputSchemaUtils.java

@@ -78,7 +78,7 @@ public static String generateInputSchema(List<FromAiResult> fromAiResults) {
 
             propertiesObjectNode.set(fromAiResult.name(), parameterObjectNode);
 
-            if (defaultValue == null) {
+            if (fromAiResult.required()) {
                 requiredArray.add(fromAiResult.name());
             }
         }

server/libs/ai/ai-tool-api/src/test/java/com/bytechef/ai/tool/FromAiTest.java

@@ -134,6 +134,54 @@ public void testFromAiWithNullDescription() {
         assertEquals(true, fromAiResult.defaultValue());
     }
 
+    @Test
+    public void testFromAiWithRequiredTrue() {
+        Map<String, Object> map = EVALUATOR.evaluate(
+            Map.of("param", "=fromAi('title', 'STRING', {'description': 'The title.', 'required': true})"),
+            Collections.emptyMap());
+
+        Object result = MapUtils.get(map, "param");
+
+        assertInstanceOf(FromAiResult.class, result);
+
+        FromAiResult fromAiResult = (FromAiResult) result;
+
+        assertEquals("title", fromAiResult.name());
+        assertEquals("STRING", fromAiResult.type());
+        assertEquals("The title.", fromAiResult.description());
+        assertEquals(true, fromAiResult.required());
+    }
+
+    @Test
+    public void testFromAiWithRequiredFalse() {
+        Map<String, Object> map = EVALUATOR.evaluate(
+            Map.of("param", "=fromAi('title', 'STRING', {'description': 'The title.', 'required': false})"),
+            Collections.emptyMap());
+
+        Object result = MapUtils.get(map, "param");
+
+        assertInstanceOf(FromAiResult.class, result);
+
+        FromAiResult fromAiResult = (FromAiResult) result;
+
+        assertEquals(false, fromAiResult.required());
+    }
+
+    @Test
+    public void testFromAiWithoutRequiredDefaultsFalse() {
+        Map<String, Object> map = EVALUATOR.evaluate(
+            Map.of("param", "=fromAi('title', 'STRING', {'description': 'The title.'})"),
+            Collections.emptyMap());
+
+        Object result = MapUtils.get(map, "param");
+
+        assertInstanceOf(FromAiResult.class, result);
+
+        FromAiResult fromAiResult = (FromAiResult) result;
+
+        assertEquals(false, fromAiResult.required());
+    }
+
     @Test
     public void testFromAiWithNullTypeDefaultsToString() {
         Map<String, Object> map = EVALUATOR.evaluate(