@arizeai/phoenix-client 6.5.2 → 6.5.4

package/README.md

@@ -492,6 +492,51 @@ console.log(result.data); // array of span annotation objects
 | `cursor`                 | `string \| null`    | Pagination cursor                                |
 | `limit`                  | `number`            | Maximum annotations to return                    |
 
+## Sessions
+
+The `@arizeai/phoenix-client` package provides a `sessions` export for managing conversation sessions and their annotations.
+
+### Fetching Sessions
+
+Use `listSessions` to list all sessions for a project, or `getSession` to retrieve a single session by ID.
+
+```ts
+import {
+  listSessions,
+  getSession,
+  addSessionAnnotation,
+} from "@arizeai/phoenix-client/sessions";
+
+// List all sessions for a project
+const sessions = await listSessions({
+  project: "my-project",
+});
+
+for (const session of sessions) {
+  console.log(
+    `Session: ${session.sessionId}, Traces: ${session.traces.length}`
+  );
+}
+
+// Get a single session by its ID
+const session = await getSession({ sessionId: "my-session-id" });
+console.log(session.traces); // array of trace summaries in the session
+```
+
+### Adding Session Annotations
+
+```ts
+await addSessionAnnotation({
+  sessionAnnotation: {
+    sessionId: "my-session-id",
+    name: "user-satisfaction",
+    label: "satisfied",
+    score: 0.9,
+    annotatorKind: "HUMAN",
+  },
+});
+```
+
 ## Examples
 
 To run examples, install dependencies using `pnpm` and run:

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

@@ -888,6 +888,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/user": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Get the authenticated user
+         * @description Returns the profile of the currently authenticated user. When authentication is disabled, returns an anonymous user representation.
+         */
+        get: operations["getViewer"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/users": {
         parameters: {
             query?: never;
@@ -997,6 +1017,14 @@ export interface components {
              */
             explanation?: string | null;
         };
+        /** AnonymousUser */
+        AnonymousUser: {
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            auth_method: "ANONYMOUS";
+        };
         /** CategoricalAnnotationConfig */
         CategoricalAnnotationConfig: {
             /** Name */
@@ -1592,6 +1620,11 @@ export interface components {
             /** Next Cursor */
             next_cursor: string | null;
         };
+        /** GetViewerResponseBody */
+        GetViewerResponseBody: {
+            /** Data */
+            data: components["schemas"]["LocalUser"] | components["schemas"]["OAuth2User"] | components["schemas"]["LDAPUser"] | components["schemas"]["AnonymousUser"];
+        };
         /** HTTPValidationError */
         HTTPValidationError: {
             /** Detail */
@@ -6382,6 +6415,44 @@ export interface operations {
             };
         };
     };
+    getViewer: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description The authenticated user's profile. */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["GetViewerResponseBody"];
+                };
+            };
+            /** @description User not found. */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
     getUsers: {
         parameters: {
             query?: {