@arizeai/phoenix-client 7.5.0 → 7.7.0

package/dist/esm/traces/transferTraces.d.ts

@@ -0,0 +1,56 @@
+import type { ClientFn } from "../types/core.js";
+/**
+ * Parameters for moving traces to another project.
+ */
+export interface TransferTracesParams extends ClientFn {
+    /**
+     * Trace GlobalIDs or OpenTelemetry trace IDs to move. All traces must
+     * currently belong to the same source project.
+     */
+    traceIdentifiers: string[];
+    /**
+     * The destination project name or GlobalID.
+     */
+    destinationProjectIdentifier: string;
+}
+/**
+ * The result of moving traces to another project.
+ */
+export interface TransferTracesResult {
+    /** The number of distinct traces moved. */
+    transferredTraceCount: number;
+    /** The destination project's GlobalID. */
+    destinationProjectId: string;
+}
+/**
+ * Move traces from one project to another.
+ *
+ * This operation re-parents the traces; it does not copy them. After the move,
+ * the traces no longer appear in their original project. Every trace must
+ * currently belong to the same source project.
+ *
+ * @param params - The parameters for moving traces.
+ * @param params.traceIdentifiers - Trace GlobalIDs or OpenTelemetry trace IDs to move.
+ * @param params.destinationProjectIdentifier - The destination project name or GlobalID.
+ * @returns The number of traces moved and the destination project's GlobalID.
+ * @throws {RangeError} If no trace identifiers are provided.
+ * @throws {HttpError} If a trace or destination project is missing, the traces
+ * belong to multiple source projects, or the transfer otherwise fails.
+ *
+ * @requires Phoenix server >= 20.4.0
+ *
+ * @example
+ * ```ts
+ * import { transferTraces } from "@arizeai/phoenix-client/traces";
+ *
+ * const result = await transferTraces({
+ *   traceIdentifiers: ["8f3a...", "VHJhY2U6Mg=="],
+ *   destinationProjectIdentifier: "production",
+ * });
+ *
+ * console.log(result.transferredTraceCount);
+ * console.log(result.destinationProjectId);
+ * ```
+ */
+export declare function transferTraces({ client: _client, traceIdentifiers, destinationProjectIdentifier, }: TransferTracesParams): Promise<TransferTracesResult>;
+//# sourceMappingURL=transferTraces.d.ts.map

package/dist/esm/traces/transferTraces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transferTraces.d.ts","sourceRoot":"","sources":["../../../src/traces/transferTraces.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAG9C;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,QAAQ;IACpD;;;OAGG;IACH,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B;;OAEG;IACH,4BAA4B,EAAE,MAAM,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,2CAA2C;IAC3C,qBAAqB,EAAE,MAAM,CAAC;IAC9B,0CAA0C;IAC1C,oBAAoB,EAAE,MAAM,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAsB,cAAc,CAAC,EACnC,MAAM,EAAE,OAAO,EACf,gBAAgB,EAChB,4BAA4B,GAC7B,EAAE,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAwBtD"}

package/dist/esm/traces/transferTraces.js

@@ -0,0 +1,56 @@
+import { createClient } from "../client.js";
+import { TRANSFER_TRACES } from "../constants/serverRequirements.js";
+import { ensureServerCapability } from "../utils/serverVersionUtils.js";
+/**
+ * Move traces from one project to another.
+ *
+ * This operation re-parents the traces; it does not copy them. After the move,
+ * the traces no longer appear in their original project. Every trace must
+ * currently belong to the same source project.
+ *
+ * @param params - The parameters for moving traces.
+ * @param params.traceIdentifiers - Trace GlobalIDs or OpenTelemetry trace IDs to move.
+ * @param params.destinationProjectIdentifier - The destination project name or GlobalID.
+ * @returns The number of traces moved and the destination project's GlobalID.
+ * @throws {RangeError} If no trace identifiers are provided.
+ * @throws {HttpError} If a trace or destination project is missing, the traces
+ * belong to multiple source projects, or the transfer otherwise fails.
+ *
+ * @requires Phoenix server >= 20.4.0
+ *
+ * @example
+ * ```ts
+ * import { transferTraces } from "@arizeai/phoenix-client/traces";
+ *
+ * const result = await transferTraces({
+ *   traceIdentifiers: ["8f3a...", "VHJhY2U6Mg=="],
+ *   destinationProjectIdentifier: "production",
+ * });
+ *
+ * console.log(result.transferredTraceCount);
+ * console.log(result.destinationProjectId);
+ * ```
+ */
+export async function transferTraces({ client: _client, traceIdentifiers, destinationProjectIdentifier, }) {
+    if (traceIdentifiers.length === 0) {
+        throw new RangeError("At least one trace identifier is required");
+    }
+    const client = _client ?? createClient();
+    await ensureServerCapability({ client, requirement: TRANSFER_TRACES });
+    const { data, error } = await client.POST("/v1/traces/transfer", {
+        body: {
+            trace_identifiers: traceIdentifiers,
+            destination_project_identifier: destinationProjectIdentifier,
+        },
+    });
+    if (error)
+        throw error;
+    if (!data?.data) {
+        throw new Error("Failed to transfer traces: no data returned");
+    }
+    return {
+        transferredTraceCount: data.data.transferred_trace_count,
+        destinationProjectId: data.data.destination_project_id,
+    };
+}
+//# sourceMappingURL=transferTraces.js.map

package/dist/esm/traces/transferTraces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transferTraces.js","sourceRoot":"","sources":["../../../src/traces/transferTraces.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAElE,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AA2BrE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAAC,EACnC,MAAM,EAAE,OAAO,EACf,gBAAgB,EAChB,4BAA4B,GACP;IACrB,IAAI,gBAAgB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAClC,MAAM,IAAI,UAAU,CAAC,2CAA2C,CAAC,CAAC;IACpE,CAAC;IAED,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,sBAAsB,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,eAAe,EAAE,CAAC,CAAC;IAEvE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,qBAAqB,EAAE;QAC/D,IAAI,EAAE;YACJ,iBAAiB,EAAE,gBAAgB;YACnC,8BAA8B,EAAE,4BAA4B;SAC7D;KACF,CAAC,CAAC;IAEH,IAAI,KAAK;QAAE,MAAM,KAAK,CAAC;IACvB,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;IACjE,CAAC;IAED,OAAO;QACL,qBAAqB,EAAE,IAAI,CAAC,IAAI,CAAC,uBAAuB;QACxD,oBAAoB,EAAE,IAAI,CAAC,IAAI,CAAC,sBAAsB;KACvD,CAAC;AACJ,CAAC"}