@arizeai/phoenix-client 4.0.3 → 4.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/phoenix-client",
-  "version": "4.0.3",
+  "version": "4.2.0",
   "description": "A client for the Phoenix API",
   "main": "dist/src/index.js",
   "module": "dist/esm/index.js",
@@ -18,6 +18,10 @@
       "import": "./dist/esm/spans/index.js",
       "require": "./dist/src/spans/index.js"
     },
+    "./sessions": {
+      "import": "./dist/esm/sessions/index.js",
+      "require": "./dist/src/sessions/index.js"
+    },
     "./experiments": {
       "import": "./dist/esm/experiments/index.js",
       "require": "./dist/src/experiments/index.js"
@@ -61,8 +65,9 @@
     "openai": "^4.77.0",
     "openapi-typescript": "^7.6.1",
     "tsx": "^4.19.3",
+    "typescript": "^5.8.2",
     "vitest": "^2.1.9",
-    "@arizeai/phoenix-evals": "0.2.1"
+    "@arizeai/phoenix-evals": "0.2.2"
   },
   "dependencies": {
     "@arizeai/openinference-semantic-conventions": "^1.1.0",
@@ -93,7 +98,7 @@
     "prebuild": "pnpm run clean && pnpm run generate",
     "generate": "openapi-typescript --empty-objects-unknown=true --default-non-nullable=false ../../../schemas/openapi.json -o ./src/__generated__/api/v1.ts",
     "build": "tsc --build tsconfig.json tsconfig.esm.json && tsc-alias -p tsconfig.esm.json",
-    "postbuild": "echo '{\"type\": \"module\"}' > ./dist/esm/package.json && rimraf dist/test dist/examples",
+    "postbuild": "echo '{\"type\": \"module\"}' > ./dist/esm/package.json",
     "type:check": "tsc --noEmit",
     "test": "vitest --typecheck"
   }

package/src/__generated__/api/v1.ts

@@ -77,6 +77,40 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/projects/{project_identifier}/trace_annotations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get trace annotations for a list of trace_ids. */
+        get: operations["listTraceAnnotationsByTraceIds"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/v1/projects/{project_identifier}/session_annotations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Get session annotations for a list of session_ids. */
+        get: operations["listSessionAnnotationsBySessionIds"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/datasets": {
         parameters: {
             query?: never;
@@ -321,6 +355,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/trace_annotations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Create trace annotations */
+        post: operations["annotateTraces"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/traces/{trace_identifier}": {
         parameters: {
             query?: never;
@@ -636,6 +687,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/session_annotations": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Create session annotations */
+        post: operations["annotateSessions"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/document_annotations": {
         parameters: {
             query?: never;
@@ -701,6 +769,16 @@ export interface paths {
 export type webhooks = Record<string, never>;
 export interface components {
     schemas: {
+        /** AnnotateSessionsRequestBody */
+        AnnotateSessionsRequestBody: {
+            /** Data */
+            data: components["schemas"]["SessionAnnotationData"][];
+        };
+        /** AnnotateSessionsResponseBody */
+        AnnotateSessionsResponseBody: {
+            /** Data */
+            data: components["schemas"]["InsertedSessionAnnotation"][];
+        };
         /** AnnotateSpanDocumentsRequestBody */
         AnnotateSpanDocumentsRequestBody: {
             /** Data */
@@ -721,6 +799,19 @@ export interface components {
             /** Data */
             data: components["schemas"]["InsertedSpanAnnotation"][];
         };
+        /** AnnotateTracesRequestBody */
+        AnnotateTracesRequestBody: {
+            /**
+             * Data
+             * @description The trace annotations to be upserted
+             */
+            data: components["schemas"]["TraceAnnotationData"][];
+        };
+        /** AnnotateTracesResponseBody */
+        AnnotateTracesResponseBody: {
+            /** Data */
+            data: components["schemas"]["InsertedTraceAnnotation"][];
+        };
         /** AnnotationResult */
         AnnotationResult: {
             /**
@@ -1268,6 +1359,14 @@ export interface components {
         };
         /** Identifier */
         Identifier: string;
+        /** InsertedSessionAnnotation */
+        InsertedSessionAnnotation: {
+            /**
+             * Id
+             * @description The ID of the inserted session annotation
+             */
+            id: string;
+        };
         /** InsertedSpanAnnotation */
         InsertedSpanAnnotation: {
             /**
@@ -1284,6 +1383,14 @@ export interface components {
              */
             id: string;
         };
+        /** InsertedTraceAnnotation */
+        InsertedTraceAnnotation: {
+            /**
+             * Id
+             * @description The ID of the inserted trace annotation
+             */
+            id: string;
+        };
         /** ListDatasetExamplesData */
         ListDatasetExamplesData: {
             /** Dataset Id */
@@ -1345,7 +1452,7 @@ export interface components {
              * Role
              * @enum {string}
              */
-            role: "SYSTEM" | "ADMIN" | "MEMBER";
+            role: "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER";
             /**
              * @description discriminator enum property added by openapi-typescript
              * @enum {string}
@@ -1366,7 +1473,7 @@ export interface components {
              * Role
              * @enum {string}
              */
-            role: "SYSTEM" | "ADMIN" | "MEMBER";
+            role: "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER";
             /**
              * @description discriminator enum property added by openapi-typescript
              * @enum {string}
@@ -1402,7 +1509,7 @@ export interface components {
              * Role
              * @enum {string}
              */
-            role: "SYSTEM" | "ADMIN" | "MEMBER";
+            role: "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER";
             /**
              * @description discriminator enum property added by openapi-typescript
              * @enum {string}
@@ -1425,7 +1532,7 @@ export interface components {
              * Role
              * @enum {string}
              */
-            role: "SYSTEM" | "ADMIN" | "MEMBER";
+            role: "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER";
             /**
              * @description discriminator enum property added by openapi-typescript
              * @enum {string}
@@ -2092,6 +2199,100 @@ export interface components {
              */
             reasoning_effort?: "minimal" | "low" | "medium" | "high";
         };
+        /** SessionAnnotation */
+        SessionAnnotation: {
+            /** Id */
+            id: string;
+            /**
+             * Created At
+             * Format: date-time
+             */
+            created_at: string;
+            /**
+             * Updated At
+             * Format: date-time
+             */
+            updated_at: string;
+            /**
+             * Source
+             * @enum {string}
+             */
+            source: "API" | "APP";
+            /** User Id */
+            user_id: string | null;
+            /**
+             * Name
+             * @description The name of the annotation
+             */
+            name: string;
+            /**
+             * Annotator Kind
+             * @description The kind of annotator used for the annotation
+             * @enum {string}
+             */
+            annotator_kind: "LLM" | "CODE" | "HUMAN";
+            /** @description The result of the annotation */
+            result?: components["schemas"]["AnnotationResult"] | null;
+            /**
+             * Metadata
+             * @description Metadata for the annotation
+             */
+            metadata?: {
+                [key: string]: unknown;
+            } | null;
+            /**
+             * Identifier
+             * @description The identifier of the annotation. If provided, the annotation will be updated if it already exists.
+             * @default
+             */
+            identifier?: string;
+            /**
+             * Session Id
+             * @description Session ID
+             */
+            session_id: string;
+        };
+        /** SessionAnnotationData */
+        SessionAnnotationData: {
+            /**
+             * Name
+             * @description The name of the annotation
+             */
+            name: string;
+            /**
+             * Annotator Kind
+             * @description The kind of annotator used for the annotation
+             * @enum {string}
+             */
+            annotator_kind: "LLM" | "CODE" | "HUMAN";
+            /** @description The result of the annotation */
+            result?: components["schemas"]["AnnotationResult"] | null;
+            /**
+             * Metadata
+             * @description Metadata for the annotation
+             */
+            metadata?: {
+                [key: string]: unknown;
+            } | null;
+            /**
+             * Identifier
+             * @description The identifier of the annotation. If provided, the annotation will be updated if it already exists.
+             * @default
+             */
+            identifier?: string;
+            /**
+             * Session Id
+             * @description Session ID
+             */
+            session_id: string;
+        };
+        /** SessionAnnotationsResponseBody */
+        SessionAnnotationsResponseBody: {
+            /** Data */
+            data: components["schemas"]["SessionAnnotation"][];
+            /** Next Cursor */
+            next_cursor: string | null;
+        };
         /** Span */
         Span: {
             /**
@@ -2375,6 +2576,100 @@ export interface components {
                 [key: string]: unknown;
             } | unknown[] | null;
         };
+        /** TraceAnnotation */
+        TraceAnnotation: {
+            /** Id */
+            id: string;
+            /**
+             * Created At
+             * Format: date-time
+             */
+            created_at: string;
+            /**
+             * Updated At
+             * Format: date-time
+             */
+            updated_at: string;
+            /**
+             * Source
+             * @enum {string}
+             */
+            source: "API" | "APP";
+            /** User Id */
+            user_id: string | null;
+            /**
+             * Name
+             * @description The name of the annotation
+             */
+            name: string;
+            /**
+             * Annotator Kind
+             * @description The kind of annotator used for the annotation
+             * @enum {string}
+             */
+            annotator_kind: "LLM" | "CODE" | "HUMAN";
+            /** @description The result of the annotation */
+            result?: components["schemas"]["AnnotationResult"] | null;
+            /**
+             * Metadata
+             * @description Metadata for the annotation
+             */
+            metadata?: {
+                [key: string]: unknown;
+            } | null;
+            /**
+             * Identifier
+             * @description The identifier of the annotation. If provided, the annotation will be updated if it already exists.
+             * @default
+             */
+            identifier?: string;
+            /**
+             * Trace Id
+             * @description OpenTelemetry Trace ID (hex format w/o 0x prefix)
+             */
+            trace_id: string;
+        };
+        /** TraceAnnotationData */
+        TraceAnnotationData: {
+            /**
+             * Name
+             * @description The name of the annotation
+             */
+            name: string;
+            /**
+             * Annotator Kind
+             * @description The kind of annotator used for the annotation
+             * @enum {string}
+             */
+            annotator_kind: "LLM" | "CODE" | "HUMAN";
+            /** @description The result of the annotation */
+            result?: components["schemas"]["AnnotationResult"] | null;
+            /**
+             * Metadata
+             * @description Metadata for the annotation
+             */
+            metadata?: {
+                [key: string]: unknown;
+            } | null;
+            /**
+             * Identifier
+             * @description The identifier of the annotation. If provided, the annotation will be updated if it already exists.
+             * @default
+             */
+            identifier?: string;
+            /**
+             * Trace Id
+             * @description OpenTelemetry Trace ID (hex format w/o 0x prefix)
+             */
+            trace_id: string;
+        };
+        /** TraceAnnotationsResponseBody */
+        TraceAnnotationsResponseBody: {
+            /** Data */
+            data: components["schemas"]["TraceAnnotation"][];
+            /** Next Cursor */
+            next_cursor: string | null;
+        };
         /** UpdateAnnotationConfigResponseBody */
         UpdateAnnotationConfigResponseBody: {
             /** Data */
@@ -2753,6 +3048,128 @@ export interface operations {
             };
         };
     };
+    listTraceAnnotationsByTraceIds: {
+        parameters: {
+            query: {
+                /** @description One or more trace id to fetch annotations for */
+                trace_ids: string[];
+                /** @description Optional list of annotation names to include. If provided, only annotations with these names will be returned. 'note' annotations are excluded by default unless explicitly included in this list. */
+                include_annotation_names?: string[] | null;
+                /** @description Optional list of annotation names to exclude from results. */
+                exclude_annotation_names?: string[] | null;
+                /** @description A cursor for pagination */
+                cursor?: string | null;
+                /** @description The maximum number of annotations to return in a single request */
+                limit?: number;
+            };
+            header?: never;
+            path: {
+                /** @description The project identifier: either project ID or project name. If using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters. */
+                project_identifier: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["TraceAnnotationsResponseBody"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Project or traces not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Invalid parameters */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    listSessionAnnotationsBySessionIds: {
+        parameters: {
+            query: {
+                /** @description One or more session id to fetch annotations for */
+                session_ids: string[];
+                /** @description Optional list of annotation names to include. If provided, only annotations with these names will be returned. 'note' annotations are excluded by default unless explicitly included in this list. */
+                include_annotation_names?: string[] | null;
+                /** @description Optional list of annotation names to exclude from results. */
+                exclude_annotation_names?: string[] | null;
+                /** @description A cursor for pagination */
+                cursor?: string | null;
+                /** @description The maximum number of annotations to return in a single request */
+                limit?: number;
+            };
+            header?: never;
+            path: {
+                /** @description The project identifier: either project ID or project name. If using a project name as the identifier, it cannot contain slash (/), question mark (?), or pound sign (#) characters. */
+                project_identifier: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SessionAnnotationsResponseBody"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Project or sessions not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Invalid parameters */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
     listDatasets: {
         parameters: {
             query?: {
@@ -3599,6 +4016,60 @@ export interface operations {
             };
         };
     };
+    annotateTraces: {
+        parameters: {
+            query?: {
+                /** @description If true, fulfill request synchronously. */
+                sync?: boolean;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AnnotateTracesRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AnnotateTracesResponseBody"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Trace not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     deleteTrace: {
         parameters: {
             query?: never;
@@ -4671,6 +5142,60 @@ export interface operations {
             };
         };
     };
+    annotateSessions: {
+        parameters: {
+            query?: {
+                /** @description If true, fulfill request synchronously. */
+                sync?: boolean;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["AnnotateSessionsRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Session annotations inserted successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AnnotateSessionsResponseBody"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Session not found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     annotateSpanDocuments: {
         parameters: {
             query?: {