@arizeai/phoenix-client
Version:
A client for the Phoenix API
23 lines • 748 B
TypeScript
import type { ClientFn } from "../types/core";
import type { Session } from "../types/sessions";
export type GetSessionParams = ClientFn & {
/**
* The session identifier: either a GlobalID or user-provided session_id string.
*/
sessionId: string;
};
/**
* Fetch a single session by its GlobalID or user-provided session_id string.
*
* @requires Phoenix server >= 13.5.0
*
* @example
* ```ts
* import { getSession } from "@arizeai/phoenix-client/sessions";
*
* const session = await getSession({ sessionId: "my-session-id" });
* console.log(session.traces.length);
* ```
*/
export declare function getSession({ client: _client, sessionId, }: GetSessionParams): Promise<Session>;
//# sourceMappingURL=getSession.d.ts.map