@arizeai/phoenix-client 2.3.5 → 3.0.0

package/dist/src/spans/deleteSpan.d.ts

@@ -0,0 +1,48 @@
+import { ClientFn } from "../types/core";
+/**
+ * Parameters to delete a span
+ */
+export interface DeleteSpanParams extends ClientFn {
+    /**
+     * The span identifier. Can be either:
+     * - OpenTelemetry span_id (string)
+     * - Phoenix Global ID (string)
+     */
+    spanIdentifier: string;
+}
+/**
+ * Delete a single span by identifier.
+ *
+ * **Important**: This operation deletes ONLY the specified span itself and does NOT
+ * delete its descendants/children. All child spans will remain in the trace and
+ * become orphaned (their parent_id will point to a non-existent span).
+ *
+ * Behavior:
+ * - Deletes only the target span (preserves all descendant spans)
+ * - Child spans become orphaned but remain in the database
+ * - Returns successfully if span is found and deleted
+ * - Throws error if span is not found (404) or other errors occur
+ *
+ * @experimental this function is experimental and may change in the future
+ *
+ * @param params - The parameters to delete a span
+ * @returns Promise that resolves when the span is successfully deleted
+ * @throws Error if the span is not found or deletion fails
+ *
+ * @example
+ * ```ts
+ * // Delete by OpenTelemetry span_id
+ * await deleteSpan({
+ *   client,
+ *   spanIdentifier: "abc123def456"
+ * });
+ *
+ * // Delete by Phoenix Global ID
+ * await deleteSpan({
+ *   client,
+ *   spanIdentifier: "U3BhbjoyMzQ1Njc4OQ=="
+ * });
+ * ```
+ */
+export declare function deleteSpan({ client: _client, spanIdentifier, }: DeleteSpanParams): Promise<void>;
+//# sourceMappingURL=deleteSpan.d.ts.map

package/dist/src/spans/deleteSpan.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteSpan.d.ts","sourceRoot":"","sources":["../../../src/spans/deleteSpan.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,QAAQ;IAChD;;;;OAIG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,wBAAsB,UAAU,CAAC,EAC/B,MAAM,EAAE,OAAO,EACf,cAAc,GACf,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CA4BlC"}

package/dist/src/spans/deleteSpan.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteSpan = deleteSpan;
+const client_1 = require("../client");
+/**
+ * Delete a single span by identifier.
+ *
+ * **Important**: This operation deletes ONLY the specified span itself and does NOT
+ * delete its descendants/children. All child spans will remain in the trace and
+ * become orphaned (their parent_id will point to a non-existent span).
+ *
+ * Behavior:
+ * - Deletes only the target span (preserves all descendant spans)
+ * - Child spans become orphaned but remain in the database
+ * - Returns successfully if span is found and deleted
+ * - Throws error if span is not found (404) or other errors occur
+ *
+ * @experimental this function is experimental and may change in the future
+ *
+ * @param params - The parameters to delete a span
+ * @returns Promise that resolves when the span is successfully deleted
+ * @throws Error if the span is not found or deletion fails
+ *
+ * @example
+ * ```ts
+ * // Delete by OpenTelemetry span_id
+ * await deleteSpan({
+ *   client,
+ *   spanIdentifier: "abc123def456"
+ * });
+ *
+ * // Delete by Phoenix Global ID
+ * await deleteSpan({
+ *   client,
+ *   spanIdentifier: "U3BhbjoyMzQ1Njc4OQ=="
+ * });
+ * ```
+ */
+async function deleteSpan({ client: _client, spanIdentifier, }) {
+    const client = _client !== null && _client !== void 0 ? _client : (0, client_1.createClient)();
+    const { error } = await client.DELETE("/v1/spans/{span_identifier}", {
+        params: {
+            path: {
+                span_identifier: spanIdentifier,
+            },
+        },
+    });
+    if (error) {
+        const isNotFound = typeof error === "object" &&
+            error !== null &&
+            "status" in error &&
+            error.status === 404;
+        if (isNotFound) {
+            throw new Error(`Span not found: ${spanIdentifier}`);
+        }
+        // Extract meaningful error information
+        const errorMessage = typeof error === "object" && error !== null
+            ? JSON.stringify(error, null, 2)
+            : String(error);
+        throw new Error(`Failed to delete span: ${errorMessage}`);
+    }
+}
+//# sourceMappingURL=deleteSpan.js.map

package/dist/src/spans/deleteSpan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deleteSpan.js","sourceRoot":"","sources":["../../../src/spans/deleteSpan.ts"],"names":[],"mappings":";;AAiDA,gCA+BC;AAhFD,sCAAyC;AAezC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACI,KAAK,UAAU,UAAU,CAAC,EAC/B,MAAM,EAAE,OAAO,EACf,cAAc,GACG;IACjB,MAAM,MAAM,GAAG,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,IAAA,qBAAY,GAAE,CAAC;IAEzC,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,6BAA6B,EAAE;QACnE,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,eAAe,EAAE,cAAc;aAChC;SACF;KACF,CAAC,CAAC;IAEH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,UAAU,GACd,OAAO,KAAK,KAAK,QAAQ;YACzB,KAAK,KAAK,IAAI;YACd,QAAQ,IAAI,KAAK;YACjB,KAAK,CAAC,MAAM,KAAK,GAAG,CAAC;QACvB,IAAI,UAAU,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,mBAAmB,cAAc,EAAE,CAAC,CAAC;QACvD,CAAC;QAED,uCAAuC;QACvC,MAAM,YAAY,GAChB,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI;YACzC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YAChC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACpB,MAAM,IAAI,KAAK,CAAC,0BAA0B,YAAY,EAAE,CAAC,CAAC;IAC5D,CAAC;AACH,CAAC"}

package/dist/src/spans/index.d.ts

@@ -2,4 +2,5 @@ export * from "./addSpanAnnotation";
 export * from "./logSpanAnnotations";
 export * from "./getSpans";
 export * from "./getSpanAnnotations";
+export * from "./deleteSpan";
 //# sourceMappingURL=index.d.ts.map

package/dist/src/spans/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/spans/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/spans/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,YAAY,CAAC;AAC3B,cAAc,sBAAsB,CAAC;AACrC,cAAc,cAAc,CAAC"}

package/dist/src/spans/index.js

@@ -18,4 +18,5 @@ __exportStar(require("./addSpanAnnotation"), exports);
 __exportStar(require("./logSpanAnnotations"), exports);
 __exportStar(require("./getSpans"), exports);
 __exportStar(require("./getSpanAnnotations"), exports);
+__exportStar(require("./deleteSpan"), exports);
 //# sourceMappingURL=index.js.map

package/dist/src/spans/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/spans/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC;AACpC,uDAAqC;AACrC,6CAA2B;AAC3B,uDAAqC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/spans/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,sDAAoC;AACpC,uDAAqC;AACrC,6CAA2B;AAC3B,uDAAqC;AACrC,+CAA6B"}

package/dist/src/types/datasets.d.ts

@@ -1,13 +1,19 @@
 import { Node } from "./core";
 /**
- * A dataset can be identified by its datasetId
- * TODO: add support for datasetVersionId via discriminated union
+ * A dataset can be identified by its datasetId, datasetName, or datasetVersionId
  */
 export type DatasetSelector = {
     datasetId: string;
 } | {
     datasetName: string;
 };
+/**
+ * Parameters for selecting a specific version of a dataset
+ */
+export interface DatasetVersionSelector {
+    dataset: DatasetSelector;
+    versionId?: string;
+}
 /**
  * Overview information about a dataset
  */
@@ -16,6 +22,14 @@ export interface DatasetInfo extends Node {
     description?: string | null;
     metadata?: Record<string, unknown>;
 }
+/**
+ * Information about a dataset version
+ */
+export interface DatasetVersionInfo extends Node {
+    description?: string | null;
+    metadata?: Record<string, unknown>;
+    createdAt: Date;
+}
 /**
  * A dataset's examples
  */
@@ -45,4 +59,10 @@ export interface ExampleWithId extends Example, Node {
  */
 export interface Dataset extends DatasetInfo, DatasetExamples, Node {
 }
+/**
+ * A dataset with its version information
+ */
+export interface DatasetWithVersion extends Dataset {
+    versionInfo: DatasetVersionInfo;
+}
 //# sourceMappingURL=datasets.d.ts.map

package/dist/src/types/datasets.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"datasets.d.ts","sourceRoot":"","sources":["../../../src/types/datasets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC;AAE9E;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,IAAI;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACvC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,OAAO,EAAE,IAAI;IAClD,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,OAAQ,SAAQ,WAAW,EAAE,eAAe,EAAE,IAAI;CAAG"}
+{"version":3,"file":"datasets.d.ts","sourceRoot":"","sources":["../../../src/types/datasets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC;AAE9E;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,eAAe,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,IAAI;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,IAAI;IAC9C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACvC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,OAAO,EAAE,IAAI;IAClD,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,OAAQ,SAAQ,WAAW,EAAE,eAAe,EAAE,IAAI;CAAG;AAEtE;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,OAAO;IACjD,WAAW,EAAE,kBAAkB,CAAC;CACjC"}

package/dist/src/utils/formatPromptMessages.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatPromptMessages.d.ts","sourceRoot":"","sources":["../../../src/utils/formatPromptMessages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAO3E;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,oBAAoB,EAC5B,cAAc,EAAE,iBAAiB,EAAE,EACnC,SAAS,GAAE,SAAc;;;;;;;mBA4DsiyE,uDAAsB;;;;;;;;;IAlBtlyE"}
+{"version":3,"file":"formatPromptMessages.d.ts","sourceRoot":"","sources":["../../../src/utils/formatPromptMessages.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,iBAAiB,EAAE,oBAAoB,EAAE,MAAM,kBAAkB,CAAC;AAO3E;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAClC,MAAM,EAAE,oBAAoB,EAC5B,cAAc,EAAE,iBAAiB,EAAE,EACnC,SAAS,GAAE,SAAc;;;;;;;mBA4D+t2E,uDAAsB;;;;;;;;;IAlB/w2E"}

package/dist/src/utils/getPromptBySelector.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getPromptBySelector.d.ts","sourceRoot":"","sources":["../../../src/utils/getPromptBySelector.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAGzC;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,QAAQ,GAAG;IACjD;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;CACxB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,MAAM,EAAE,OAAO,EACf,MAAM,GACP,EAAE,yBAAyB;;oBAkD6/7D,uDAAsB;;cAAkI,uDAAsB,yBAAwB,uDAAsB;mBAAoD,uDAAsB;qBAAoD,uDAAsB;2BAAqG,uDAAsB,uCAAsC,uDAAsB,4CAA2C,uDAAsB,0CAAyC,uDAAsB,uCAAsC,uDAAsB,yCAAwC,uDAAsB,oCAAmC,uDAAsB,uCAAsC,uDAAsB;YAAsD,uDAAsB;sBAAwF,uDAAsB;;UADxm+D"}
+{"version":3,"file":"getPromptBySelector.d.ts","sourceRoot":"","sources":["../../../src/utils/getPromptBySelector.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAGzC;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,QAAQ,GAAG;IACjD;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC;CACxB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,wBAAsB,mBAAmB,CAAC,EACxC,MAAM,EAAE,OAAO,EACf,MAAM,GACP,EAAE,yBAAyB;;oBAkD0qgE,uDAAsB;;cAAkI,uDAAsB,yBAAwB,uDAAsB;mBAAoD,uDAAsB;qBAAoD,uDAAsB;2BAAqG,uDAAsB,uCAAsC,uDAAsB,4CAA2C,uDAAsB,0CAAyC,uDAAsB,uCAAsC,uDAAsB,yCAAwC,uDAAsB,oCAAmC,uDAAsB,uCAAsC,uDAAsB;YAAsD,uDAAsB;sBAAwF,uDAAsB;;UADrxiE"}