@arizeai/phoenix-client
Version:
A client for the Phoenix API
30 lines • 1.47 kB
TypeScript
/**
* Known server capability requirements.
*
* Each constant below describes a single Phoenix server capability — an HTTP
* route or query parameter — together with the minimum server version that
* supports it. These constants are passed to
* {@link ensureServerCapability} at call time to produce a clear error when
* the connected server is too old.
*
* When a new version-gated capability is added to the Phoenix REST API, add a
* corresponding requirement constant here and reference it from the client
* function that uses it.
*/
import type { CapabilityRequirement, ParameterRequirement, RouteRequirement } from "../types/serverRequirements";
export declare const GET_SESSION: RouteRequirement;
export declare const DELETE_SESSION: RouteRequirement;
export declare const DELETE_SESSIONS: RouteRequirement;
export declare const LIST_PROJECT_SESSIONS: RouteRequirement;
export declare const ANNOTATE_SESSIONS: RouteRequirement;
export declare const GET_SPANS_TRACE_IDS: ParameterRequirement;
export declare const GET_SPANS_FILTERS: ParameterRequirement;
export declare const LIST_PROJECT_TRACES: RouteRequirement;
/**
* Aggregate list of every known capability requirement.
*
* Useful for manifest scanning or startup diagnostics — iterate over this
* array to check which capabilities the connected server supports.
*/
export declare const ALL_REQUIREMENTS: readonly CapabilityRequirement[];
//# sourceMappingURL=serverRequirements.d.ts.map