@arizeai/phoenix-client
Version:
A client for the Phoenix API
142 lines • 4.07 kB
JavaScript
/**
* 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.
*/
export const GET_SESSION = {
kind: "route",
method: "GET",
path: "/v1/sessions/{session_id}",
minServerVersion: [13, 5, 0],
};
export const DELETE_SESSION = {
kind: "route",
method: "DELETE",
path: "/v1/sessions/{session_id}",
minServerVersion: [13, 13, 0],
};
export const DELETE_SESSIONS = {
kind: "route",
method: "POST",
path: "/v1/sessions/delete",
minServerVersion: [13, 13, 0],
};
export const LIST_PROJECT_SESSIONS = {
kind: "route",
method: "GET",
path: "/v1/projects/{project_id}/sessions",
minServerVersion: [13, 5, 0],
};
export const ANNOTATE_SESSIONS = {
kind: "route",
method: "POST",
path: "/v1/session_annotations",
minServerVersion: [12, 0, 0],
};
export const ADD_TRACE_NOTE = {
kind: "route",
method: "POST",
path: "/v1/trace_notes",
minServerVersion: [14, 13, 0],
};
export const ADD_SESSION_NOTE = {
kind: "route",
method: "POST",
path: "/v1/session_notes",
minServerVersion: [14, 17, 0],
};
export const GET_SPANS_TRACE_IDS = {
kind: "parameter",
parameterName: "trace_id",
parameterLocation: "query",
route: "GET /v1/projects/{id}/spans",
minServerVersion: [13, 9, 0],
};
export const GET_SPANS_SPAN_IDS = {
kind: "parameter",
parameterName: "span_id",
parameterLocation: "query",
route: "GET /v1/projects/{id}/spans",
minServerVersion: [19, 6, 0],
};
export const GET_SPANS_FILTERS = {
kind: "parameter",
parameterName: "span_kind",
parameterLocation: "query",
route: "GET /v1/projects/{id}/spans",
minServerVersion: [13, 15, 0],
};
export const LIST_PROJECT_TRACES = {
kind: "route",
method: "GET",
path: "/v1/projects/{project_identifier}/traces",
minServerVersion: [13, 15, 0],
};
export const GET_SPANS_BY_ATTRIBUTE = {
kind: "parameter",
parameterName: "attribute",
parameterLocation: "query",
route: "GET /v1/projects/{id}/spans",
minServerVersion: [14, 9, 0],
};
export const DATASET_UPLOAD_EXAMPLE_IDS = {
kind: "parameter",
parameterName: "example_ids",
parameterLocation: "body",
route: "POST /v1/datasets/upload",
minServerVersion: [15, 0, 0],
};
export const ADD_TRACE_NOTE_IDENTIFIER = {
kind: "parameter",
parameterName: "identifier",
parameterLocation: "body",
route: "POST /v1/trace_notes",
minServerVersion: [15, 5, 0],
};
export const ADD_SPAN_NOTE_IDENTIFIER = {
kind: "parameter",
parameterName: "identifier",
parameterLocation: "body",
route: "POST /v1/span_notes",
minServerVersion: [15, 5, 0],
};
export const ADD_SESSION_NOTE_IDENTIFIER = {
kind: "parameter",
parameterName: "identifier",
parameterLocation: "body",
route: "POST /v1/session_notes",
minServerVersion: [15, 5, 0],
};
/**
* 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 const ALL_REQUIREMENTS = [
GET_SESSION,
DELETE_SESSION,
DELETE_SESSIONS,
LIST_PROJECT_SESSIONS,
ANNOTATE_SESSIONS,
ADD_TRACE_NOTE,
ADD_SESSION_NOTE,
GET_SPANS_TRACE_IDS,
GET_SPANS_SPAN_IDS,
GET_SPANS_FILTERS,
GET_SPANS_BY_ATTRIBUTE,
LIST_PROJECT_TRACES,
DATASET_UPLOAD_EXAMPLE_IDS,
ADD_TRACE_NOTE_IDENTIFIER,
ADD_SPAN_NOTE_IDENTIFIER,
ADD_SESSION_NOTE_IDENTIFIER,
];
//# sourceMappingURL=serverRequirements.js.map