What does this prompt chain demonstrate?

It evaluates OpenAI function calls with promptfoo, showing two different ways to define functions: in an external YAML file and directly inline in the configuration file.

What API key do I need to run this example?

You need to set up an `OPENAI_API_KEY`, which is pre-configured in the `promptfooconfig.yaml` file.

How do I set up and run this example?

Run `npx promptfoo@latest init --example openai-function-call`, then execute `promptfoo eval` and `promptfoo view` to see the results.

When should I use this prompt chain?

Use it when you want to compare external-file versus inline function definitions for OpenAI function calling side by side; it's not necessary if you only need one definition style.

Prompt Chain

Integrate OpenAI Function Calls into Your Apps

Name: Openai Function Call
Availability: OnlineOnly
Author: Promptfoo

Promptfoo example evaluating OpenAI function calls, comparing external-YAML versus inline function definitions.

Copy chain

Works with openai

Promptfoo

Own this? Claim it

Spark score

out of 100

Updated last month

Version code-scan-action-0.1

Models

gpt 4o

Add to Favorites

Why it matters

Enable your applications to leverage OpenAI's function calling capabilities for structured data extraction and task execution.

Outcomes

What it gets done

Generate code that utilizes OpenAI function calls.

Extract structured data from LLM responses.

Classify user intents based on LLM output.

Summarize information using function calls.

Install

Add it to your toolbox

Run in your project directory:

curl -fsSL https://spark.entire.vc/get/pfoo-openai-function-call | bash

Steps

Steps in the chain

Set OPENAI_API_KEY environment variable

Review and modify configuration

Run the evaluation

View the results

Overview

Openai Function Call

This example evaluates OpenAI function calls with promptfoo, comparing external-YAML and inline function definitions side by side. Use it when deciding whether to define OpenAI function-calling schemas externally or inline in a promptfoo config.

What it does

This example evaluates OpenAI function calls with promptfoo, demonstrating two ways to define functions: in an external YAML file, and directly inline in the configuration file.

When to use - and when NOT to

Use it when you want a working comparison of external-file versus inline function definitions for OpenAI function calling. Do not use it if you only need one definition style - the value here is seeing both approaches side by side.

Inputs and outputs

Requires OPENAI_API_KEY. The example is pre-configured in promptfooconfig.yaml, which you can review or modify; running the evaluation produces results viewable via promptfoo view.

Integrations

Set up via npx promptfoo@latest init --example openai-function-call, then run promptfoo eval and promptfoo view.

Who it's for

Developers deciding whether to define OpenAI function-calling schemas in a separate YAML file or inline in their promptfoo config.

Source README

openai-function-call (OpenAI Function Call Example)

You can run this example with:

npx promptfoo@latest init --example openai-function-call
cd openai-function-call

This example demonstrates how to use promptfoo to evaluate OpenAI function calls. It showcases two different methods of defining functions: in an external YAML file and directly in the configuration file.

Setup

Set your OPENAI_API_KEY environment variable:
```
export OPENAI_API_KEY=your_api_key_here
```
This example is pre-configured in promptfooconfig.yaml. You can review and modify it if needed.
Run the evaluation:
```
promptfoo eval
```
View the results:
```
promptfoo view
```

FAQ

Common questions

Discussion