> ## Documentation Index
> Fetch the complete documentation index at: https://arize-ax.mintlify.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenAI

> Use OpenAI as the judge LLM for evaluations with the arize-phoenix-evals library.

The [`arize-phoenix-evals`](https://pypi.org/project/arize-phoenix-evals/) library uses an LLM-as-judge to grade model output — hallucinations, factuality, helpfulness, toxicity, custom rubrics. Plug OpenAI in as the judge by passing `provider="openai"` to the `LLM(...)` wrapper, then build a `create_classifier(...)` evaluator and run it over a DataFrame with `evaluate_dataframe(...)`.

## Prerequisites

* Python 3.11+
* An `OPENAI_API_KEY` from the [OpenAI Platform](https://platform.openai.com/api-keys)

## Install

```bash theme={null}
pip install arize-phoenix-evals openai pandas
```

## Configure credentials

```bash theme={null}
export OPENAI_API_KEY="<your-openai-api-key>"
```

## Setup the eval LLM

```python theme={null}
# eval_setup.py
from phoenix.evals import LLM

# `LLM(provider=..., model=...)` reads the appropriate provider key
# from the environment — OPENAI_API_KEY for OpenAI.
llm = LLM(provider="openai", model="gpt-5")
```

Use `gpt-5-mini` for a cheaper judge if you're evaluating large batches; the judge's job is classification, not generation, so a smaller model is often sufficient.

## Run an evaluation

This example builds a hallucination classifier and grades two sample question/answer pairs against a reference. The pattern generalizes: replace the prompt template, choices, and DataFrame columns with whatever metric you want to evaluate.

```python theme={null}
# example.py
import pandas as pd

from phoenix.evals import LLM, create_classifier, evaluate_dataframe

llm = LLM(provider="openai", model="gpt-5")

HALLUCINATION_PROMPT = """\
Determine whether the answer below is factually supported by the
reference. Reply with exactly one of: factual, hallucinated.

Question: {input}
Answer: {output}
Reference: {reference}
"""

evaluator = create_classifier(
    name="hallucination",
    prompt_template=HALLUCINATION_PROMPT,
    llm=llm,
    # `choices` maps each label the LLM may emit to a numeric score.
    # `direction="maximize"` (the default) means higher score is better.
    choices={"factual": 1.0, "hallucinated": 0.0},
)

df = pd.DataFrame([
    {
        "input":     "What is the capital of France?",
        "output":    "Paris is the capital of France.",
        "reference": "Paris is the capital and most populous city of France.",
    },
    {
        "input":     "What is the capital of France?",
        "output":    "Berlin is the capital of France.",
        "reference": "Paris is the capital and most populous city of France.",
    },
])

results = evaluate_dataframe(dataframe=df, evaluators=[evaluator])

# `hallucination_score` is a Score row (a dict-like with `score`, `label`,
# `explanation`, …) — pull the numeric out for a flat display column.
results["score"] = results["hallucination_score"].apply(lambda r: r["score"])
print(results[["input", "output", "score"]].to_string())
```

### Expected output

```text wrap theme={null}
                            input                            output  score
0  What is the capital of France?   Paris is the capital of France.    1.0
1  What is the capital of France?  Berlin is the capital of France.    0.0
```

The full returned DataFrame also includes `hallucination_execution_details` (status + exceptions + timing) and the original `hallucination_score` column with each evaluator result's full dict (`name`, `score`, `label`, `explanation`, `metadata`, `kind`, `direction`) — useful for surfacing the LLM's reasoning, persisting eval rows back to Arize AX, or filtering retries.

## Troubleshooting

* **`401` from OpenAI.** Verify `OPENAI_API_KEY` is set and has access to `gpt-5`. Swap the `model=` argument for any model your key can call (e.g. `gpt-5-mini` for cheaper batch evaluations).
* **All rows return the same label.** Your prompt template isn't differentiating cases. Make sure each row's `{input}`/`{output}`/`{reference}` columns expose enough context for the judge to discriminate, and that `choices` lists every label your prompt asks the LLM to emit.
* **Some rows fail with timeout / rate-limit.** Pass `max_retries=` to `evaluate_dataframe(...)` (defaults to 3). For large batches, also pass `initial_per_second_request_rate=...` to `LLM(...)` to throttle.
* **Logging results back to Arize AX.** This guide stops at producing the eval DataFrame. To attach those evals to existing spans in an Arize AX project, use [`log_evaluations_sync`](/ax/cookbooks/evaluation/evaluations-quickstart#log-evaluations-back-to-arize) on `arize.Client`.
* **Using Azure OpenAI instead.** Pass `sync_client_kwargs={"azure_endpoint": ..., "api_version": ...}` to `LLM(...)`. The same evaluator code works against an Azure-deployed model.

## Resources

<CardGroup>
  <Card icon="book-open" href="https://arize.com/docs/phoenix/evaluation/llm-evals" title="Phoenix Evals Documentation" horizontal />

  <Card icon="terminal" href="https://pypi.org/project/arize-phoenix-evals/" title="arize-phoenix-evals on PyPI" horizontal />

  <Card icon="github" href="https://github.com/Arize-ai/phoenix/tree/main/packages/phoenix-evals" title="Phoenix Evals Source" horizontal />

  <Card icon="book-open" href="/ax/integrations/llm-providers/openai/openai-tracing" title="OpenAI Tracing (instrument app calls)" horizontal />
</CardGroup>
