chore: import upstream snapshot with attribution

2026-07-13 13:24:08 +08:00
commit 0d3cb498a3
5438 changed files with 1316560 additions and 0 deletions
@@ -0,0 +1,42 @@
+# getting-started (Getting Started Example)
+
+You can run this example with:
+
+```bash
+npx promptfoo@latest init --example getting-started
+cd 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:
+
+```bash
+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:
+
+```bash
+promptfoo eval
+```
+
+## What's happening?
+
+This example:
+
+- Tests two different ways to phrase a translation prompt
+- Compares outputs between GPT-5.2 and GPT-5 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
@@ -0,0 +1,29 @@
+# yaml-language-server: $schema=https://promptfoo.dev/config-schema.json
+description: 'Getting started'
+# Optionally set API keys here instead of exporting environment variables.
+# Never commit real keys to source control.
+# env:
+#   OPENAI_API_KEY: sk-...
+prompts:
+  - 'Convert the following English text to {{language}}: {{input}}'
+
+providers:
+  - openai:chat:gpt-5.5
+  - openai:chat:gpt-5.4-mini
+  # Or setup models from other providers
+  # - anthropic:messages:claude-sonnet-4-6
+  # - google:gemini-3.1-pro-preview
+
+tests:
+  - vars:
+      language: French
+      input: Hello world
+    assert:
+      - type: contains
+        value: 'Bonjour le monde'
+  - vars:
+      language: Spanish
+      input: Where is the library?
+    assert:
+      - type: icontains
+        value: 'Dónde está la biblioteca'