promptfoo/examples/getting-started

getting-started (Getting Started Example)

You can run this example with:

npx promptfoo@latest init --example getting-started

This is a simple example that demonstrates the basic functionality of promptfoo. It tests two different translation prompts across multiple language models.

Setup

1. Set your OpenAI API key:

export OPENAI_API_KEY=your-key-here

Tip: you can also put this key in a .env file. Be sure not to commit it to git.

2. Run the evaluation:

promptfoo eval

What's happening?

This example:

• Tests two different ways to phrase a translation prompt
• Compares outputs between GPT-4.1 and o4-mini
• Uses two test cases with different languages and inputs

The configuration in promptfooconfig.yaml shows:

• How to define prompts with variables using {{variable_name}}
• How to specify multiple providers (models)
• How to set up test cases with different variable values

This is the same example shown in the Getting Started guide at https://promptfoo.dev/docs/getting-started