Arize Phoenix TS
    Preparing search index...

    Interface SuiteState

    State for a single describe() block. Created during test collection and shared across all tests in the suite.

    interface SuiteState {
        acceptanceResults?: AcceptanceResult[];
        client?: {
            config: ClientOptions;
            DELETE: ClientMethod<paths, "delete", `${string}/${string}`>;
            GET: ClientMethod<paths, "get", `${string}/${string}`>;
            getServerVersion: () => Promise<SemanticVersion>;
            HEAD: ClientMethod<paths, "head", `${string}/${string}`>;
            OPTIONS: ClientMethod<paths, "options", `${string}/${string}`>;
            PATCH: ClientMethod<paths, "patch", `${string}/${string}`>;
            POST: ClientMethod<paths, "post", `${string}/${string}`>;
            PUT: ClientMethod<paths, "put", `${string}/${string}`>;
            request: ClientRequestMethod<paths, `${string}/${string}`>;
            TRACE: ClientMethod<paths, "trace", `${string}/${string}`>;
            eject(...middleware: Middleware[]): void;
            use(...middleware: Middleware[]): void;
        };
        config: SuiteConfig;
        datasetId?: string;
        evaluatorTracer?: Tracer;
        exampleIdsByTest: Map<string, { exampleId: string; nodeId: string }>;
        experimentId?: string;
        globalRegistration?: GlobalTracerProviderRegistration | null;
        links: { label: string; url: string }[];
        maxRepetitions?: number;
        name: string;
        projectName?: string;
        registeredExamples: Map<string, RegisteredExample>;
        results: TestResult[];
        setupError?: Error;
        tracer?: Tracer;
        tracerProvider?: NodeTracerProvider;
        trackingDisabled: boolean;
        trackingDisabledReason?: string;
        uploadFailureCount?: number;
    }
    Index

    Properties

    acceptanceResults? client? config datasetId? evaluatorTracer? exampleIdsByTest experimentId? globalRegistration? links maxRepetitions? name projectName? registeredExamples results setupError? tracer? tracerProvider? trackingDisabled trackingDisabledReason? uploadFailureCount?

    Properties

    acceptanceResults?: AcceptanceResult[]

    Computed aggregate acceptance results for this suite.

    client?: {
        config: ClientOptions;
        DELETE: ClientMethod<paths, "delete", `${string}/${string}`>;
        GET: ClientMethod<paths, "get", `${string}/${string}`>;
        getServerVersion: () => Promise<SemanticVersion>;
        HEAD: ClientMethod<paths, "head", `${string}/${string}`>;
        OPTIONS: ClientMethod<paths, "options", `${string}/${string}`>;
        PATCH: ClientMethod<paths, "patch", `${string}/${string}`>;
        POST: ClientMethod<paths, "post", `${string}/${string}`>;
        PUT: ClientMethod<paths, "put", `${string}/${string}`>;
        request: ClientRequestMethod<paths, `${string}/${string}`>;
        TRACE: ClientMethod<paths, "trace", `${string}/${string}`>;
        eject(...middleware: Middleware[]): void;
        use(...middleware: Middleware[]): void;
    }

    Phoenix client used for this suite (resolved lazily).

    Type Declaration

    • config: ClientOptions
    • DELETE: ClientMethod<paths, "delete", `${string}/${string}`>

      Call a DELETE endpoint

    • GET: ClientMethod<paths, "get", `${string}/${string}`>

      Call a GET endpoint

    • getServerVersion: () => Promise<SemanticVersion>

      Get the Phoenix server version, returning a cached value if available.

      The version is first populated from the x-phoenix-server-version response header on any API call. If no version has been seen yet, this method fetches GET /arize_phoenix_version to populate the cache.

      If the server version cannot be determined (e.g. the server is unreachable or returned an unparseable version string).

    • HEAD: ClientMethod<paths, "head", `${string}/${string}`>

      Call a HEAD endpoint

    • OPTIONS: ClientMethod<paths, "options", `${string}/${string}`>

      Call a OPTIONS endpoint

    • PATCH: ClientMethod<paths, "patch", `${string}/${string}`>

      Call a PATCH endpoint

    • POST: ClientMethod<paths, "post", `${string}/${string}`>

      Call a POST endpoint

    • PUT: ClientMethod<paths, "put", `${string}/${string}`>

      Call a PUT endpoint

    • request: ClientRequestMethod<paths, `${string}/${string}`>
    • TRACE: ClientMethod<paths, "trace", `${string}/${string}`>

      Call a TRACE endpoint

    • eject: function
      • eject(...middleware: Middleware[]): void

        Unregister middleware

        Parameters

        • ...middleware: Middleware[]

        Returns void

    • use: function
      • use(...middleware: Middleware[]): void

        Register middleware

        Parameters

        • ...middleware: Middleware[]

        Returns void

    config: SuiteConfig
    datasetId?: string

    Phoenix dataset id (after upload).

    evaluatorTracer?: Tracer

    OpenInference tracer for evaluator spans.

    exampleIdsByTest: Map<string, { exampleId: string; nodeId: string }>

    Map of test name → resolved server-side example id. Populated after the dataset is synced.

    experimentId?: string

    Phoenix experiment id (created at suite start).

    globalRegistration?: GlobalTracerProviderRegistration | null

    Global tracer registration owned by this suite (if any).

    links: { label: string; url: string }[]

    Links printed at the end of the suite (Phoenix dataset / experiment URLs).

    maxRepetitions?: number

    Highest per-test repetition count seen in this suite. Used as the experiment's repetitions value (informational; runs are keyed by example + repetition number regardless).

    name: string

    The user-facing suite (and dataset/experiment) name.

    projectName?: string

    Phoenix project name used for the experiment.

    registeredExamples: Map<string, RegisteredExample>

    Map of test name → registered example metadata. Filled as tests are declared inside the describe callback. Keys are test names.

    results: TestResult[]

    Recorded test results for the reporter / summary.

    setupError?: Error

    Setup error captured during suite initialization.

    tracer?: Tracer

    OpenInference tracer for task spans.

    tracerProvider?: NodeTracerProvider

    Tracer provider owned by this suite (cleaned up at suite end).

    trackingDisabled: boolean

    Whether sync to Phoenix is disabled for this run.

    trackingDisabledReason?: string

    Reason the suite became inert (no tracking), if applicable.

    uploadFailureCount?: number

    Count of best-effort POSTs (runs + annotations) that failed during upload.

    Settings

    Member Visibility

    On This Page

    Properties