Merge pull request #138 from AET-DevOps26/feat/optional-ingredient-unit

Make an ingredient's quantity and unit optional

Author: jschoedl

api/openapi-internal.yaml

@@ -255,16 +255,24 @@ components:
 
     RecipeIngredient:
       type: object
-      required: [quantity, unit, name]
+      required: [name]
       additionalProperties: false
+      description: >-
+        A measured ingredient has both quantity and unit ("200 g flour"); a counted one
+        has a quantity only ("2 eggs"); one added to taste has neither ("salt").
+        A unit without a quantity is meaningless and is rejected by the recipe editor,
+        though the contract tolerates it.
       properties:
         quantity:
           type: number
-          minimum: 0
+          exclusiveMinimum: 0
+          description: Amount of the ingredient. Omitted when the ingredient is added to taste.
         unit:
           type: string
           minLength: 1
-          description: Unit of measurement (e.g. g, ml, cup, tbsp)
+          description: >-
+            Unit of measurement (e.g. g, ml, cup, tbsp). Omitted when the ingredient is
+            counted as whole items rather than measured.
         name:
           type: string
           minLength: 1

api/openapi.yaml

@@ -597,16 +597,24 @@ components:
 
     RecipeIngredient:
       type: object
-      required: [quantity, unit, name]
+      required: [name]
       additionalProperties: false
+      description: >-
+        A measured ingredient has both quantity and unit ("200 g flour"); a counted one
+        has a quantity only ("2 eggs"); one added to taste has neither ("salt").
+        A unit without a quantity is meaningless and is rejected by the recipe editor,
+        though the contract tolerates it.
       properties:
         quantity:
           type: number
-          minimum: 0
+          exclusiveMinimum: 0
+          description: Amount of the ingredient. Omitted when the ingredient is added to taste.
         unit:
           type: string
           minLength: 1
-          description: Unit of measurement (e.g. g, ml, cup, tbsp)
+          description: >-
+            Unit of measurement (e.g. g, ml, cup, tbsp). Omitted when the ingredient is
+            counted as whole items rather than measured.
         name:
           type: string
           minLength: 1

services/py-help-service/client/cooking_assistant_gen_ai_services_api_internal_client/models/recipe_ingredient.py

@@ -225,7 +225,10 @@ async def generate_help(
 			if ingredients:
 				recipe_ctx.append("\nIngredients:")
 				for ing in ingredients:
-					recipe_ctx.append(f"- {ing.quantity} {ing.unit} {ing.name}")
+					# an absent quantity or unit is Unset, which would render as "UNSET"
+					parts = [ing.quantity, ing.unit, ing.name]
+					line = " ".join(str(p) for p in parts if not isinstance(p, Unset))
+					recipe_ctx.append(f"- {line}")
 
 			instructions = getattr(request.recipe, "instructions", None)
 			if instructions:

services/py-help-service/client/pyproject.toml

@@ -54,8 +54,10 @@
 
 # autogenerated classes must be mapped to local ones that are compatible with pydantic
 class LocalRecipeIngredient(BaseModel):
-	quantity: float
-	unit: str
+	# Optional unlike nutrients below: omitting them is sometimes the *correct* answer
+	# ("2 eggs" has no unit, "salt" has neither), so the llm is guided by prompt instead.
+	quantity: float | None = None
+	unit: str | None = None
 	name: str
 
 
@@ -246,8 +248,10 @@ async def generate_recipes(
 			f"Constraint - Allergies: {allergies} (DO NOT USE THESE)\n"
 			f"User Context: {about}\n\n"
 			f"Write all recipe content (title, ingredients, units and instructions) in {language}. "
-			"Strictly use standard, lowercase abbreviated unit names (e.g., use 'tbsp' instead of 'tablespoon', "
-			"'tsp' instead of 'teaspoon', 'g' instead of 'grams', and 'ml' instead of 'milliliters').\n"
+			f"Abbreviate units the way {language} conventionally abbreviates them, not the way English "
+			"does (a tablespoon is 'tbsp' in English but 'EL' in German).\n"
+			"Omit the unit for ingredients counted as whole items (2 eggs, 1 onion) rather than "
+			"inventing one (2 pieces egg). Always give a quantity when you give a unit.\n"
 			"Output the nutrients for the whole recipe in total, not per portion.\n"
 			f"Keep the JSON keys in English as specified."
 		)
@@ -268,7 +272,9 @@ async def generate_recipes(
 		# return array of recipes as expeted from the api spec
 		final_recipes = []
 		for r in response.recipes:
-			recipe_dict = r.model_dump()
+			# exclude_none: the spec marks an absent quantity/unit by omitting the key,
+			# and forbids additional properties — a null would be rejected as neither.
+			recipe_dict = r.model_dump(exclude_none=True)
 			final_recipes.append(RecipeInput.from_dict(recipe_dict))
 
 		return [r.to_dict() for r in final_recipes]
@@ -305,6 +311,9 @@ async def generate_nutrients(
 			"You are an expert nutritional scientist. Calculate the macronutrients and total calories "
 			"for the provided recipe. Output the nutrients for the whole recipe in total, not per portion. "
 			"Evaluate ingredient quantities, units, and base portion sizes carefully. "
+			"An ingredient with a quantity but no unit is counted as whole items ('2 eggs') - assume a "
+			"typical size for one item. An ingredient with neither is added to taste ('salt') - assume a "
+			"negligible amount. "
 			"Ensure the output strictly mirrors the exact target JSON object fields."
 		)
 

services/py-help-service/main.py

@@ -45,7 +45,13 @@ def _stub_provider_dependencies():
 			recipes=[
 				LocalRecipeInput(
 					title="Test Recipe",
-					ingredients=[{"quantity": 1.0, "unit": "cup", "name": "Flour"}],
+					# One of each ingredient kind: an absent quantity/unit must be marked by
+					# omitting the key, since the contract forbids both null and "".
+					ingredients=[
+						{"quantity": 1.0, "unit": "cup", "name": "Flour"},
+						{"quantity": 2.0, "name": "Eggs"},
+						{"name": "Salt"},
+					],
 					instructions=["Mix.", "Bake."],
 					portions=2.0,
 					nutrients=nutrients,

services/py-recipe-service/client/cooking_assistant_gen_ai_services_api_internal_client/models/recipe_ingredient.py

@@ -26,19 +26,20 @@ package org.openapitools.internal.model
 import com.squareup.moshi.Json
 
 /**
+ * A measured ingredient has both quantity and unit (\"200 g flour\"); a counted one has a quantity only (\"2 eggs\"); one added to taste has neither (\"salt\"). A unit without a quantity is meaningless and is rejected by the recipe editor, though the contract tolerates it.
  *
- *
- * @param quantity
- * @param unit Unit of measurement (e.g. g, ml, cup, tbsp)
  * @param name
+ * @param quantity Amount of the ingredient. Omitted when the ingredient is added to taste.
+ * @param unit Unit of measurement (e.g. g, ml, cup, tbsp). Omitted when the ingredient is counted as whole items rather than measured.
  */
 
 data class RecipeIngredient(
-	@Json(name = "quantity")
-	val quantity: kotlin.Double,
-	// Unit of measurement (e.g. g, ml, cup, tbsp)
-	@Json(name = "unit")
-	val unit: kotlin.String,
 	@Json(name = "name")
 	val name: kotlin.String,
+	// Amount of the ingredient. Omitted when the ingredient is added to taste.
+	@Json(name = "quantity")
+	val quantity: kotlin.Double? = null,
+	// Unit of measurement (e.g. g, ml, cup, tbsp). Omitted when the ingredient is counted as whole items rather than measured.
+	@Json(name = "unit")
+	val unit: kotlin.String? = null,
 )