creating-custom-ingredients.md

docs/reference/ingredients/creating-custom-ingredients.md

@@ -0,0 +1,23 @@
+# Creating Custom BlendSQL Ingredients
+
+All the built-in LLM ingredients inherit from the base classes `QAIngredient`, `MapIngredient`, and `JoinIngredient`.
+
+These are intended to be helpful abstractions, so that the user can easily implement their own functions to run within a BlendSQL script.
+
+## QAIngredient
+
+::: blendsql.ingredients.ingredient.QAIngredient.run
+    handler: python
+    show_source: true
+
+## MapIngredient
+
+::: blendsql.ingredients.ingredient.MapIngredient.run
+    handler: python
+    show_source: true
+
+## JoinIngredient
+
+::: blendsql.ingredients.ingredient.JoinIngredient.run
+    handler: python
+    show_source: true

mkdocs.yml

@@ -57,9 +57,11 @@ nav:
       - Execute a BlendSQL Query: reference/execute-blendsql.md
       - Ingredients:
           - reference/ingredients/ingredients.md
-          - MapIngredient: reference/ingredients/map-ingredient.md
-          - QAIngredient: reference/ingredients/qa-ingredient.md
-          - JoinIngredient: reference/ingredients/join-ingredient.md
+          - Creating Custom Ingredients: reference/ingredients/creating-custom-ingredients.md
+          - Built-in:
+            - MapIngredient: reference/ingredients/map-ingredient.md
+            - QAIngredient: reference/ingredients/qa-ingredient.md
+            - JoinIngredient: reference/ingredients/join-ingredient.md
       - Blenders:
           - reference/blenders/blenders.md
           - OpenAI: reference/blenders/openai.md