Structured Output, Functions and Prompting

from pydantic import BaseModel
from openai import OpenAI
from typing import List
import json
import time


class Ingredient(BaseModel):
    name: str
    quantity: float
    unit: str


class Recipe(BaseModel):
    name: str
    ingredients: List[Ingredient]
    instructions: List[str]
    prep_time: int
    cook_time: int
    servings: int


MODEL = "gpt-4o-2024-08-06"
client = OpenAI()


def extract_recipe_with_response_format(recipe_text: str) -> Recipe:
    completion = client.beta.chat.completions.parse(
        model=MODEL,
        messages=[
            {
                "role": "system",
                "content": "You are a helpful cooking assistant that extracts recipe information.",
            },
            {"role": "user", "content": recipe_text},
        ],
        response_format=Recipe,
    )
    return completion.choices[0].message.parsed


def extract_recipe_with_function_calling(recipe_text: str) -> Recipe:
    completion = client.chat.completions.create(
        model=MODEL,
        messages=[
            {
                "role": "system",
                "content": "You are a helpful cooking assistant that extracts recipe information.",
            },
            {"role": "user", "content": recipe_text},
        ],
        functions=[
            {
                "name": "create_recipe",
                "description": "Create a structured recipe from the given text",
                "parameters": Recipe.model_json_schema(),
            }
        ],
        function_call={"name": "create_recipe"},
    )

    function_call = completion.choices[0].message.function_call
    response_data = json.loads(function_call.arguments)
    return Recipe(**response_data)


def extract_recipe_with_schema_in_prompt(recipe_text: str) -> Recipe:
    schema = Recipe.model_json_schema()
    completion = client.chat.completions.create(
        model=MODEL,
        messages=[
            {
                "role": "system",
                "content": f"You are a helpful cooking assistant that extracts recipe information. Please format your response as a JSON object matching this schema: {json.dumps(schema)}. No talk. Just JSON.",
            },
            {"role": "user", "content": recipe_text},
        ],
    )
    response_data = json.loads(
        completion.choices[0].message.content.replace("```json", "").replace("```", "")
    )
    return Recipe(**response_data)


def print_recipe(recipe: Recipe):
    print(json.dumps(recipe.model_dump(), indent=2))


if __name__ == "__main__":
    recipe_text = """
    Classic Chocolate Chip Cookies

    Ingredients:
    - 2 1/4 cups all-purpose flour
    - 1 tsp baking soda
    - 1 tsp salt
    - 1 cup unsalted butter, softened
    - 3/4 cup granulated sugar
    - 3/4 cup brown sugar
    - 2 large eggs
    - 2 tsp vanilla extract
    - 2 cups semisweet chocolate chips

    Instructions:
    1. Preheat oven to 375°F (190°C).
    2. In a bowl, mix flour, baking soda, and salt.
    3. In another bowl, cream butter and sugars until light and fluffy.
    4. Beat in eggs and vanilla to the butter mixture.
    5. Gradually stir in the flour mixture.
    6. Fold in chocolate chips.
    7. Drop spoonfuls of dough onto ungreased baking sheets.
    8. Bake for 9 to 11 minutes or until golden brown.
    9. Cool on baking sheets for 2 minutes, then transfer to wire racks.

    Prep Time: 15 minutes
    Cook Time: 10 minutes
    Servings: 24 cookies
    """

    print("Using response_format:")
    start_time = time.time()
    recipe_response_format = extract_recipe_with_response_format(recipe_text)
    end_time = time.time()
    print(f"Time taken: {end_time - start_time:.2f} seconds")
    print_recipe(recipe_response_format)

    print("\nUsing function calling:")
    start_time = time.time()
    recipe_function_calling = extract_recipe_with_function_calling(recipe_text)
    end_time = time.time()
    print(f"Time taken: {end_time - start_time:.2f} seconds")
    print_recipe(recipe_function_calling)

    print("\nUsing schema in prompt:")
    start_time = time.time()
    recipe_schema_in_prompt = extract_recipe_with_schema_in_prompt(recipe_text)
    end_time = time.time()
    print(f"Time taken: {end_time - start_time:.2f} seconds")
    print_recipe(recipe_schema_in_prompt)

Using response_format:
Time taken: 5.75 seconds
{
  "name": "Classic Chocolate Chip Cookies",
  ...
  "prep_time": 15,
  "cook_time": 10,
  "servings": 24
}

Using function calling:
Time taken: 4.55 seconds
{
  "name": "Classic Chocolate Chip Cookies",
  ...
  "prep_time": 15,
  "cook_time": 10,
  "servings": 24
}

Using schema in prompt:
Time taken: 4.58 seconds
{
  "name": "Classic Chocolate Chip Cookies",
  ...
  "prep_time": 15,
  "cook_time": 10,
  "servings": 24
}