@arizeai/phoenix-client 7.6.0 → 7.7.1

package/dist/esm/types/sessions.d.ts

@@ -22,6 +22,12 @@ export interface Session extends Node {
     startTime: string;
     /** ISO 8601 timestamp of when the last trace in the session ended */
     endTime: string;
+    /** Cumulative prompt token count across all spans in the session */
+    tokenCountPrompt?: number;
+    /** Cumulative completion token count across all spans in the session */
+    tokenCountCompletion?: number;
+    /** Cumulative total token count across all spans in the session */
+    tokenCountTotal?: number;
     /** The traces that belong to this session */
     traces: SessionTrace[];
 }

package/dist/esm/types/sessions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sessions.d.ts","sourceRoot":"","sources":["../../../src/types/sessions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,IAAI;IACxC,gEAAgE;IAChE,OAAO,EAAE,MAAM,CAAC;IAChB,mDAAmD;IACnD,SAAS,EAAE,MAAM,CAAC;IAClB,iDAAiD;IACjD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,OAAQ,SAAQ,IAAI;IACnC,2CAA2C;IAC3C,SAAS,EAAE,MAAM,CAAC;IAClB,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAC;IAClB,wEAAwE;IACxE,SAAS,EAAE,MAAM,CAAC;IAClB,qEAAqE;IACrE,OAAO,EAAE,MAAM,CAAC;IAChB,6CAA6C;IAC7C,MAAM,EAAE,YAAY,EAAE,CAAC;CACxB"}
+{"version":3,"file":"sessions.d.ts","sourceRoot":"","sources":["../../../src/types/sessions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,IAAI;IACxC,gEAAgE;IAChE,OAAO,EAAE,MAAM,CAAC;IAChB,mDAAmD;IACnD,SAAS,EAAE,MAAM,CAAC;IAClB,iDAAiD;IACjD,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,OAAQ,SAAQ,IAAI;IACnC,2CAA2C;IAC3C,SAAS,EAAE,MAAM,CAAC;IAClB,oDAAoD;IACpD,SAAS,EAAE,MAAM,CAAC;IAClB,wEAAwE;IACxE,SAAS,EAAE,MAAM,CAAC;IAClB,qEAAqE;IACrE,OAAO,EAAE,MAAM,CAAC;IAChB,oEAAoE;IACpE,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,wEAAwE;IACxE,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,mEAAmE;IACnE,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,6CAA6C;IAC7C,MAAM,EAAE,YAAY,EAAE,CAAC;CACxB"}

package/dist/esm/users/getCurrentUser.d.ts

@@ -0,0 +1,25 @@
+import type { components } from "../__generated__/api/v1.js";
+import type { ClientFn } from "../types/core.js";
+/** The user profile returned for the current Phoenix client credentials. */
+export type CurrentUser = components["schemas"]["GetViewerResponseBody"]["data"];
+/**
+ * Get the currently authenticated user.
+ *
+ * When authentication is disabled, Phoenix returns an anonymous user with
+ * `auth_method: "ANONYMOUS"`.
+ *
+ * @param params - The parameters for fetching the current user.
+ * @param params.client - An optional Phoenix client instance.
+ * @returns The current user's generated API profile shape.
+ * @throws {HttpError} If the request is not authenticated or is forbidden.
+ *
+ * @example
+ * ```ts
+ * import { getCurrentUser } from "@arizeai/phoenix-client/users";
+ *
+ * const user = await getCurrentUser();
+ * console.log(user.auth_method);
+ * ```
+ */
+export declare function getCurrentUser({ client: _client, }?: ClientFn): Promise<CurrentUser>;
+//# sourceMappingURL=getCurrentUser.d.ts.map

package/dist/esm/users/getCurrentUser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCurrentUser.d.ts","sourceRoot":"","sources":["../../../src/users/getCurrentUser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE1D,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE9C,4EAA4E;AAC5E,MAAM,MAAM,WAAW,GACrB,UAAU,CAAC,SAAS,CAAC,CAAC,uBAAuB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEzD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,cAAc,CAAC,EACnC,MAAM,EAAE,OAAO,GAChB,GAAE,QAAa,GAAG,OAAO,CAAC,WAAW,CAAC,CAOtC"}

package/dist/esm/users/getCurrentUser.js

@@ -0,0 +1,30 @@
+import invariant from "tiny-invariant";
+import { createClient } from "../client.js";
+/**
+ * Get the currently authenticated user.
+ *
+ * When authentication is disabled, Phoenix returns an anonymous user with
+ * `auth_method: "ANONYMOUS"`.
+ *
+ * @param params - The parameters for fetching the current user.
+ * @param params.client - An optional Phoenix client instance.
+ * @returns The current user's generated API profile shape.
+ * @throws {HttpError} If the request is not authenticated or is forbidden.
+ *
+ * @example
+ * ```ts
+ * import { getCurrentUser } from "@arizeai/phoenix-client/users";
+ *
+ * const user = await getCurrentUser();
+ * console.log(user.auth_method);
+ * ```
+ */
+export async function getCurrentUser({ client: _client, } = {}) {
+    const client = _client ?? createClient();
+    const { data, error } = await client.GET("/v1/user");
+    if (error)
+        throw error;
+    invariant(data?.data, "Failed to get current user");
+    return data.data;
+}
+//# sourceMappingURL=getCurrentUser.js.map

package/dist/esm/users/getCurrentUser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getCurrentUser.js","sourceRoot":"","sources":["../../../src/users/getCurrentUser.ts"],"names":[],"mappings":"AAAA,OAAO,SAAS,MAAM,gBAAgB,CAAC;AAGvC,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAOzC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,EACnC,MAAM,EAAE,OAAO,GAChB,GAAa,EAAE;IACd,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAErD,IAAI,KAAK;QAAE,MAAM,KAAK,CAAC;IACvB,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,4BAA4B,CAAC,CAAC;IACpD,OAAO,IAAI,CAAC,IAAI,CAAC;AACnB,CAAC"}

package/dist/esm/users/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./getCurrentUser.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/users/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/users/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC"}

package/dist/esm/users/index.js

@@ -0,0 +1,2 @@
+export * from "./getCurrentUser.js";
+//# sourceMappingURL=index.js.map

package/dist/esm/users/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/users/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC"}

package/dist/src/__generated__/api/v1.d.ts

@@ -9986,7 +9986,7 @@ export interface operations {
                 order?: "asc" | "desc";
                 /** @description Maximum number of traces to return */
                 limit?: number;
-                /** @description Pagination cursor (Trace GlobalID) */
+                /** @description Pagination cursor returned by a previous request */
                 cursor?: string | null;
                 /** @description If true, include full span details for each trace. This significantly increases response size and query latency, especially with large page sizes. Prefer fetching spans lazily for individual traces when possible. */
                 include_spans?: boolean;