feat: Add tts / text-based recipe import feature #4561

itsrubberduck · 2024-11-15T22:17:32Z

What type of PR is this?

feature

What this PR does / why we need it:

This PR introduces a new text-based recipe import feature using OpenAI's API to automatically parse and structure recipe content. This allows users to paste in plain text recipes and have them automatically formatted into Mealie's recipe structure, with optional translation support.

Changes include:

Add new /api/recipes/create/text endpoint for text-based recipe creation
Implement OpenAI integration for intelligent recipe parsing:
- recipe_service.py: Add create_from_text and build_recipe_from_text methods
- Update OpenAI service to handle text-based recipe extraction
- Add JSON schema validation for parsed recipes

The changes make recipe import more accessible by allowing users to simply paste text / use tts rather than requiring structured input or image uploads.

Special notes for your reviewer:

Currently, no automated tests have been implemented for this feature yet
The feature requires proper recipe input with actual ingredients and instructions
OpenAI will reject the processing if the input doesn't resemble a proper recipe format
Successfully tested with real recipe inputs containing ingredients and preparation steps
The OpenAI integration requires the OPENAI_ENABLED setting to be true
Translation support is optional and uses the user's locale settings

Current Limitations:

Only works with proper recipe formats (ingredients list + instructions)
Invalid or too short inputs will be rejected by OpenAI
Empty responses will be returned for non-recipe text input
Automated testing still needs to be implemented

Testing

Manual testing has been performed with:

Real recipe inputs in different formats
Various recipe lengths and complexities
Different languages with translation
Error cases for invalid inputs

TODO:

Add automated tests for the text import feature
Add input validation tests
Add OpenAI response validation tests
Add translation functionality tests

• 🎯 Add new endpoints for text-based recipe creation • 🔍 Implement OpenAI integration for recipe parsing • 🌐 Add language translation support • 🏷️ Add new translation keys • ♻️ Refactor OpenAI service for better text handling • 🐛 Fix model configuration for OpenAI API • 📝 Update prompts for better recipe extraction • 🚨 Add proper error handling and validation

✨ Allow reasonable interpretation of ambiguous text 🎯 Focus on practical usability over strict formatting

Kuchenpirat · 2024-11-15T23:13:07Z

Hey, thanks for your PR.
Please prepend your PR title with feat: and check your poetry file. It seems like you upgraded a whole bunch of dependencies with this PR which should not be part of this PR as we use renovate to keep our deps up to date.

itsrubberduck · 2024-11-15T23:30:45Z

Thanks, didn't get the part with the PR naming and somehow also overlooked the poetry.lock file. Is there anything else - would you like me to delete the german translation file as well?

Kuchenpirat · 2024-11-15T23:34:39Z

Yeah, you should only include the english base translation.
Also you should not delete the poetry file in this repo, just don't include changes to it if you are not adding/removing any dependencies in this PR.

itsrubberduck · 2024-11-15T23:40:25Z

Sorry, I must admit my git skills aren't advanced enough to remove the poetry.lock and translation files from the existing commits. I apologize for including these files in the first place - I should have been more careful. Would you be able to guide me through the process, or would it be better to close this PR and create a new one with just the feature-related changes?

Kuchenpirat · 2024-11-15T23:44:33Z

git checkout upstream/mealie-next -- poetry.lock

I think this sould revert it to the state in main

Fuckingnameless · 2024-11-20T12:45:01Z

in view of #4582 i approve this PR

michael-genson

Love this PR! I think this adds a ton of accessibility to creating recipes, and makes things easier for "weird" imports from unstructured sources (like a text document or similar).

A few comments, but nothing major. Other than those, if you could write a test for this that would be great. We don't want to actually call an OpenAI endpoint for the tests so you'll need to mock a response; you can check out the "create from image" test. If you run into any issues let me know, happy to jump in and write the test myself as well.

The create from image test: https://github.com/mealie-recipes/mealie/blob/mealie-next/tests/integration_tests/user_recipe_tests/test_recipe_create_from_image.py

michael-genson · 2024-11-26T18:04:33Z

frontend/pages/g/_groupSlug/r/create.vue

+      {
+        // just textarea dump voice actived icon
+        icon: $globals.icons.text,


Suggested change

{

// just textarea dump voice actived icon

icon: $globals.icons.text,

{

icon: $globals.icons.text,

michael-genson · 2024-11-26T18:05:17Z

mealie/services/recipe/recipe_service.py

+            message += f" Please translate the recipe to {translate_language}."
+
+        try:
+            # Explizit das model und response_format setzen


Suggested change

# Explizit das model und response_format setzen

# Explicitly set the model and response_format

michael-genson · 2024-11-26T18:08:20Z

frontend/pages/g/_groupSlug/r/create/plaintext.vue

+            </v-row>
+          </v-container>
+        </v-card-text>
+        <v-card-actions v-if="recipeText">


Instead of hiding this, can we disable the create button? It's a bit jarring to see it pop in and out. Something like:
<BaseButton :disabled="!recipeText" ... />

michael-genson · 2024-11-26T18:09:01Z

frontend/pages/g/_groupSlug/r/create/plaintext.vue

+            <p v-if="loading" class="mb-0">
+              {{ $t('recipe.please-wait-processing') }}
+            </p>


You can probably get rid of this since the submit button already indicates that it's loading

frontend/pages/g/_groupSlug/r/create/plaintext.vue

frontend/lang/messages/en-US.json

frontend/pages/g/_groupSlug/r/create.vue

itsrubberduck

did everything

itsrubberduck · 2024-12-19T15:09:57Z

is there anything left to do for the pr?

michael-genson · 2024-12-27T17:42:18Z

Hey there! Sorry for the delay, been swamped with the holidays. Once I get the chance I'll take a look and approve if it's good to go or add some more feedback. Appreciate your patience!

michael-genson

It looks like some of my feedback got marked as resolved, but wasn't addressed. If you could take a look at those that would be great. I went and marked the ones not addressed as unresolved above

github-actions bot added the feature label Nov 15, 2024

🔧 refactor(prompt): make recipe parser more lenient

c287c79

✨ Allow reasonable interpretation of ambiguous text 🎯 Focus on practical usability over strict formatting

itsrubberduck changed the title ~~✨ Add tts / text-based recipe import feature~~ feat: Add tts / text-based recipe import feature Nov 15, 2024

Delete poetry.lock

648fdd8

domezi added 3 commits November 16, 2024 00:48

chore: restore poetry.lock from mealie-next branch

9b0d113

chore: keep existing poetry.lock file

5dc050d

chore: restore German translation file from mealie-next

a9a233c

This comment was marked as duplicate.

Sign in to view

michael-genson requested changes Nov 26, 2024

View reviewed changes

domezi added 3 commits December 3, 2024 21:25

add tests for test_recipe_create_from_text

4cf74f9

conditional to hide import from text if OpenAI isn't enabled

e0be273

add a more descriptive create-recipe-from-text-description placeholder

f4fab70

itsrubberduck commented Dec 19, 2024

View reviewed changes

itsrubberduck requested a review from michael-genson December 19, 2024 15:09

michael-genson requested changes Dec 30, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add tts / text-based recipe import feature #4561

feat: Add tts / text-based recipe import feature #4561

itsrubberduck commented Nov 15, 2024 •

edited

Loading

Kuchenpirat commented Nov 15, 2024

itsrubberduck commented Nov 15, 2024

Kuchenpirat commented Nov 15, 2024

itsrubberduck commented Nov 15, 2024

Kuchenpirat commented Nov 15, 2024

Fuckingnameless commented Nov 20, 2024

This comment was marked as duplicate.

michael-genson left a comment

michael-genson Nov 26, 2024

michael-genson Nov 26, 2024

michael-genson Nov 26, 2024 •

edited

Loading

michael-genson Nov 26, 2024

itsrubberduck left a comment

itsrubberduck commented Dec 19, 2024

michael-genson commented Dec 27, 2024

michael-genson left a comment •

edited

Loading

	# Explizit das model und response_format setzen
	# Explicitly set the model and response_format

feat: Add tts / text-based recipe import feature #4561

Are you sure you want to change the base?

feat: Add tts / text-based recipe import feature #4561

Conversation

itsrubberduck commented Nov 15, 2024 • edited Loading

What type of PR is this?

What this PR does / why we need it:

Special notes for your reviewer:

Current Limitations:

Testing

Kuchenpirat commented Nov 15, 2024

itsrubberduck commented Nov 15, 2024

Kuchenpirat commented Nov 15, 2024

itsrubberduck commented Nov 15, 2024

Kuchenpirat commented Nov 15, 2024

Fuckingnameless commented Nov 20, 2024

This comment was marked as duplicate.

michael-genson left a comment

Choose a reason for hiding this comment

michael-genson Nov 26, 2024

Choose a reason for hiding this comment

michael-genson Nov 26, 2024

Choose a reason for hiding this comment

michael-genson Nov 26, 2024 • edited Loading

Choose a reason for hiding this comment

michael-genson Nov 26, 2024

Choose a reason for hiding this comment

itsrubberduck left a comment

Choose a reason for hiding this comment

itsrubberduck commented Dec 19, 2024

michael-genson commented Dec 27, 2024

michael-genson left a comment • edited Loading

Choose a reason for hiding this comment

itsrubberduck commented Nov 15, 2024 •

edited

Loading

michael-genson Nov 26, 2024 •

edited

Loading

michael-genson left a comment •

edited

Loading