@arizeai/phoenix-client 5.5.1 → 5.5.4

package/README.md

@@ -19,6 +19,7 @@
     <a href="https://arize-ai.github.io/phoenix/">
         <img src="https://img.shields.io/badge/docs-blue?logo=typescript&logoColor=white" alt="Documentation">
     </a>
+    <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=8e8e8b34-7900-43fa-a38f-1f070bd48c64&page=js/packages/phoenix-client/README.md" />
 </p>
 
 This package provides a TypeScript client for the [Arize Phoenix](https://github.com/Arize-ai/phoenix) API. It is still under active development and is subject to change.

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

@@ -525,6 +525,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/span_notes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Create a span note
+         * @description Add a note annotation to a span. Notes are special annotations that allow multiple entries per span (unlike regular annotations which are unique by name and identifier). Each note gets a unique timestamp-based identifier.
+         */
+        post: operations["createSpanNote"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/spans/{span_identifier}": {
         parameters: {
             query?: never;
@@ -1095,6 +1115,14 @@ export interface components {
         CreatePromptResponseBody: {
             data: components["schemas"]["PromptVersion"];
         };
+        /** CreateSpanNoteRequestBody */
+        CreateSpanNoteRequestBody: {
+            data: components["schemas"]["SpanNoteData"];
+        };
+        /** CreateSpanNoteResponseBody */
+        CreateSpanNoteResponseBody: {
+            data: components["schemas"]["InsertedSpanAnnotation"];
+        };
         /** CreateSpansRequestBody */
         CreateSpansRequestBody: {
             /** Data */
@@ -1116,7 +1144,7 @@ export interface components {
         /** CreateUserRequestBody */
         CreateUserRequestBody: {
             /** User */
-            user: components["schemas"]["LocalUserData"] | components["schemas"]["OAuth2UserData"];
+            user: components["schemas"]["LocalUserData"] | components["schemas"]["OAuth2UserData"] | components["schemas"]["LDAPUserData"];
             /**
              * Send Welcome Email
              * @default true
@@ -1126,7 +1154,7 @@ export interface components {
         /** CreateUserResponseBody */
         CreateUserResponseBody: {
             /** Data */
-            data: components["schemas"]["LocalUser"] | components["schemas"]["OAuth2User"];
+            data: components["schemas"]["LocalUser"] | components["schemas"]["OAuth2User"] | components["schemas"]["LDAPUser"];
         };
         /** Dataset */
         Dataset: {
@@ -1455,7 +1483,7 @@ export interface components {
         /** GetUsersResponseBody */
         GetUsersResponseBody: {
             /** Data */
-            data: (components["schemas"]["LocalUser"] | components["schemas"]["OAuth2User"])[];
+            data: (components["schemas"]["LocalUser"] | components["schemas"]["OAuth2User"] | components["schemas"]["LDAPUser"])[];
             /** Next Cursor */
             next_cursor: string | null;
         };
@@ -1526,6 +1554,52 @@ export interface components {
              */
             id: string;
         };
+        /** LDAPUser */
+        LDAPUser: {
+            /** Id */
+            id: string;
+            /**
+             * Created At
+             * Format: date-time
+             */
+            created_at: string;
+            /**
+             * Updated At
+             * Format: date-time
+             */
+            updated_at: string;
+            /** Email */
+            email: string;
+            /** Username */
+            username: string;
+            /**
+             * Role
+             * @enum {string}
+             */
+            role: "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER";
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            auth_method: "LDAP";
+        };
+        /** LDAPUserData */
+        LDAPUserData: {
+            /** Email */
+            email: string;
+            /** Username */
+            username: string;
+            /**
+             * Role
+             * @enum {string}
+             */
+            role: "SYSTEM" | "ADMIN" | "MEMBER" | "VIEWER";
+            /**
+             * @description discriminator enum property added by openapi-typescript
+             * @enum {string}
+             */
+            auth_method: "LDAP";
+        };
         /** ListDatasetExamplesData */
         ListDatasetExamplesData: {
             /** Dataset Id */
@@ -2668,6 +2742,19 @@ export interface components {
                 [key: string]: unknown;
             };
         };
+        /** SpanNoteData */
+        SpanNoteData: {
+            /**
+             * Span Id
+             * @description OpenTelemetry Span ID (hex format w/o 0x prefix)
+             */
+            span_id: string;
+            /**
+             * Note
+             * @description The note text to add to the span
+             */
+            note: string;
+        };
         /** SpansResponseBody */
         SpansResponseBody: {
             /** Data */
@@ -4677,6 +4764,57 @@ export interface operations {
             };
         };
     };
+    createSpanNote: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["CreateSpanNoteRequestBody"];
+            };
+        };
+        responses: {
+            /** @description Span note created successfully */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["CreateSpanNoteResponseBody"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** @description Span 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"];
+                };
+            };
+        };
+    };
     deleteSpan: {
         parameters: {
             query?: never;