Arize Phoenix TS
    Preparing search index...

    Interface PhoenixDescribe

    Declare Phoenix eval test suites.

    Drop-in replacement for the test runner's own describe. The suite name doubles as the dataset and experiment name on the Phoenix server, and the optional SuiteConfig controls dataset naming, repetitions, dry-run mode, and CI acceptance criteria.

    import * as px from "@arizeai/phoenix-client/vitest";

    px.describe("generate sql demo", () => {
      px.test("offtopic input", { input: { question: "hi" } }, async ({ input }) => {
        // ...
      });
    }, { metadata: { model: "gpt-4o-mini" } });
    interface PhoenixDescribe {
        only(name: string, fn: () => void, config?: SuiteConfig): void;
        skip(name: string, fn: () => void, config?: SuiteConfig): void;
        (name: string, fn: () => void, config?: SuiteConfig): void;
    }

    • Declare a Phoenix eval test suite.

      Parameters

      • name: string

        Suite name; doubles as the dataset / experiment name on Phoenix.

      • fn: () => void

        Suite body that declares its test / it cases.

      • Optionalconfig: SuiteConfig

        Optional suite-level config (dataset name, repetitions, dry-run, acceptance criteria).

      Returns void

    Index

    Methods

    only skip

    Methods

    • Run only this suite, skipping all sibling suites (matches the runner's describe.only).

      Parameters

      • name: string

        Suite name; doubles as the dataset / experiment name on Phoenix.

      • fn: () => void

        Suite body that declares its test / it cases.

      • Optionalconfig: SuiteConfig

        Optional suite-level config.

      Returns void

    • Skip this suite entirely (matches the runner's describe.skip). No dataset or experiment is created on Phoenix.

      Parameters

      • name: string

        Suite name; doubles as the dataset / experiment name on Phoenix.

      • fn: () => void

        Suite body (not executed).

      • Optionalconfig: SuiteConfig

        Optional suite-level config.

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods