AI Recipe Generator

This package provides functionality for generating recipes and images using AI.

Installation

npm install kato-ai-recipe-generator

Usage

Here's a basic example of how to use the package:

import { init, generate_recipe, generate_recipe_list, generate_image } from 'kato-ai-recipe-generator';

// Initialize the module
await init;

// Generate a recipe
const apiToken = 'your-openai-api-token';
const ingredients = 'lamb,potatoes,tomato paste,hawaij spice mix';
const cuisineType = 'Arabic';
const language = 'Arabic';
const recipe = await generate_recipe(apiToken, ingredients, cuisineType, language);
console.log(recipe);

// Generate multiple recipes
const recipeCount = 3;
const recipeList = await generate_recipe_list(apiToken, ingredients, cuisineType, recipeCount, language);
console.log(recipeList);

// Generate an image
const prompt = 'Arabian Buttered Eggs with Mint and Lemon';
const image = await generate_image(apiToken, prompt);
console.log(image);

API Reference

init()

Initializes the module. Must be called before using other functions.

generate_recipe(apiToken, ingredients, cuisineType, language)

Generates a recipe based on the given ingredients, language and cuisine type.

• apiToken: Your OpenAI API token for authentication.
• ingredients: A comma separated string of ingredients.
• cuisineType: The type of cuisine. (default: Arabic)
• language: The language to show the recipe (default: English)

Returns a Promise that resolves to the generated recipe.

generate_recipe_list(apiToken, ingredients, cuisineType, count, language)

Generates a list of recipes based on the given ingredients, count, language and cuisine type.

• apiToken: Your OpenAI API token for authentication.
• ingredients: A comma separated string of ingredients.
• cuisineType: The type of cuisine. (default: Arabic)
• count: The total recipes to generate. (min: 1, max: 8, default: 8)
• language: The language to show the recipe (default: English)

Returns a Promise that resolves to a list of generated recipes.

generate_image(apiToken, prompt)

Generates an image based on the given prompt.

• apiToken: Your OpenAI API token for authentication.
• prompt: A text description of the image to generate.

Returns a Promise that resolves to the generated image data.

Response Format

Recipe Response

{
  "success": true,
  "data": "JSON string of the recipe",
  "parsed_json": {
    "recipe_name": "Recipe Name",
    "prep_time": 20,
    "cooking_time": 60,
    "servings": 4,
    "ingredients": [
      {
        "name": "Ingredient Name",
        "quantity": "Quantity",
        "preparation": "Preparation Instructions"
      }
    ],
    "instructions": [
      "Step 1 instruction",
      "Step 2 instruction"
    ]
  }
}

Recipe List Response

{
  "success": true,
  "data": "JSON string of the recipes",
  "parsed_json": {
    "recipes": [
      {
        "recipe_name": "Recipe Name 1",
        "prep_time": 20,
        "cooking_time": 60,
        "servings": 4,
        "ingredients": [...],
        "instructions": [...]
      },
      {
        "recipe_name": "Recipe Name 2",
        "prep_time": 15,
        "cooking_time": 45,
        "servings": 2,
        "ingredients": [...],
        "instructions": [...]
      }
    ]
  }
}

Image Response

{
  "success": true,
  "data": {
    "b64_json": "base64-encoded image data",
    "revised_prompt": "The revised prompt used for generation"
  }
}

Error Response

{
  "success": false,
  "error": "Error message"
}