@arizeai/phoenix-client 2.1.1 → 2.2.0

package/dist/esm/spans/getSpanAnnotations.js

@@ -0,0 +1,83 @@
+import { createClient } from "../client.js";
+/**
+ * Get span annotations for a list of span IDs.
+ *
+ * This method allows you to retrieve annotations for specific spans within a project.
+ * You can filter annotations by name and support cursor-based pagination.
+ *
+ * @experimental this function is experimental and may change in the future
+ *
+ * @param params - The parameters to get span annotations
+ * @returns A paginated response containing annotations and optional next cursor
+ *
+ * @example
+ * ```ts
+ * // Get annotations for specific spans
+ * const result = await getSpanAnnotations({
+ *   client,
+ *   project: { projectName: "my-project" },
+ *   spanIds: ["span1", "span2", "span3"],
+ *   limit: 50
+ * });
+ *
+ * // Get specific annotation types
+ * const result = await getSpanAnnotations({
+ *   client,
+ *   project: { projectName: "my-project" },
+ *   spanIds: ["span1"],
+ *   includeAnnotationNames: ["quality_score", "sentiment"],
+ *   limit: 100
+ * });
+ *
+ * // Paginate through results
+ * let cursor: string | undefined;
+ * do {
+ *   const result = await getSpanAnnotations({
+ *     client,
+ *     project: { projectName: "my-project" },
+ *     spanIds: ["span1"],
+ *     cursor,
+ *     limit: 100
+ *   });
+ *
+ *   // Process annotations
+ *   result.annotations.forEach(annotation => {
+ *     console.log(`Annotation: ${annotation.name}, Label: ${annotation.result.label}`);
+ *   });
+ *
+ *   cursor = result.nextCursor || undefined;
+ * } while (cursor);
+ * ```
+ */
+export async function getSpanAnnotations({ client: _client, project, spanIds, includeAnnotationNames, excludeAnnotationNames, cursor, limit = 100, }) {
+    const client = _client ?? createClient();
+    const projectIdentifier = "projectId" in project ? project.projectId : project.projectName;
+    const params = {
+        span_ids: spanIds,
+        limit,
+    };
+    if (cursor) {
+        params.cursor = cursor;
+    }
+    if (includeAnnotationNames !== undefined) {
+        params.include_annotation_names = includeAnnotationNames;
+    }
+    if (excludeAnnotationNames !== undefined) {
+        params.exclude_annotation_names = excludeAnnotationNames;
+    }
+    const { data, error } = await client.GET("/v1/projects/{project_identifier}/span_annotations", {
+        params: {
+            path: {
+                project_identifier: projectIdentifier,
+            },
+            query: params,
+        },
+    });
+    if (error)
+        throw error;
+    return {
+        annotations: data?.data ?? [],
+        nextCursor: data?.next_cursor ?? null,
+    };
+}
+//# sourceMappingURL=getSpanAnnotations.js.map

package/dist/esm/spans/getSpanAnnotations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getSpanAnnotations.js","sourceRoot":"","sources":["../../../src/spans/getSpanAnnotations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AA+BzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,EACvC,MAAM,EAAE,OAAO,EACf,OAAO,EACP,OAAO,EACP,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,EACN,KAAK,GAAG,GAAG,GACc;IACzB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,iBAAiB,GACrB,WAAW,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;IAEnE,MAAM,MAAM,GAER;QACF,QAAQ,EAAE,OAAO;QACjB,KAAK;KACN,CAAC;IAEF,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED,IAAI,sBAAsB,KAAK,SAAS,EAAE,CAAC;QACzC,MAAM,CAAC,wBAAwB,GAAG,sBAAsB,CAAC;IAC3D,CAAC;IAED,IAAI,sBAAsB,KAAK,SAAS,EAAE,CAAC;QACzC,MAAM,CAAC,wBAAwB,GAAG,sBAAsB,CAAC;IAC3D,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,GAAG,CACtC,oDAAoD,EACpD;QACE,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,kBAAkB,EAAE,iBAAiB;aACtC;YACD,KAAK,EAAE,MAAM;SACd;KACF,CACF,CAAC;IAEF,IAAI,KAAK;QAAE,MAAM,KAAK,CAAC;IACvB,OAAO;QACL,WAAW,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE;QAC7B,UAAU,EAAE,IAAI,EAAE,WAAW,IAAI,IAAI;KACtC,CAAC;AACJ,CAAC"}

package/dist/esm/spans/getSpans.d.ts

@@ -0,0 +1,78 @@
+import { ClientFn } from "../types/core.js";
+import { operations } from "../__generated__/api/v1.js";
+import { ProjectSelector } from "../types/projects.js";
+/**
+ * Parameters to get spans from a project using auto-generated types
+ */
+interface GetSpansParams extends ClientFn {
+    /** The project to get spans from */
+    project: ProjectSelector;
+    /** Inclusive lower bound time. Must be a valid ISO 8601 string or Date object. */
+    startTime?: Date | string | null;
+    /** Exclusive upper bound time. Must be a valid ISO 8601 string or Date object. */
+    endTime?: Date | string | null;
+    /** Pagination cursor (Span Global ID) */
+    cursor?: string | null;
+    /** Maximum number of spans to return */
+    limit?: number;
+}
+type GetSpansResponse = operations["getSpans"]["responses"]["200"];
+export type GetSpansResult = {
+    spans: GetSpansResponse["content"]["application/json"]["data"];
+    nextCursor: GetSpansResponse["content"]["application/json"]["next_cursor"];
+};
+/**
+ * Get spans from a project with filtering criteria.
+ *
+ * This method allows you to search for spans within a project using various filters
+ * such as time range and supports cursor-based pagination.
+ * The spans are returned in Phoenix's standard format with human-readable timestamps
+ * and simplified attribute structures.
+ *
+ * @experimental this function is experimental and may change in the future
+ *
+ * @param params - The parameters to search for spans
+ * @returns A paginated response containing spans and optional next cursor
+ *
+ * @example
+ * ```ts
+ * // Get recent spans from a project
+ * const result = await getSpans({
+ *   client,
+ *   project: { projectName: "my-project" },
+ *   limit: 50
+ * });
+ *
+ * // Get spans in a time range
+
+ * const result = await getSpans({
+ *   client,
+ *   project: { projectName: "my-project" },
+ *   startTime: new Date("2024-01-01"),
+ *   endTime: new Date("2024-01-02"),
+ *   limit: 100
+ * });
+
+ *
+ * // Paginate through results
+ * let cursor: string | undefined;
+ * do {
+ *   const result = await getSpans({
+ *     client,
+ *     project: { projectName: "my-project" },
+ *     cursor,
+ *     limit: 100
+ *   });
+ *
+ *   // Process spans
+ *   result.spans.forEach(span => {
+ *     console.log(`Span: ${span.name}, Trace: ${span.context.trace_id}`);
+ *   });
+ *
+ *   cursor = result.nextCursor || undefined;
+ * } while (cursor);
+ * ```
+ */
+export declare function getSpans({ client: _client, project, cursor, limit, startTime, endTime, }: GetSpansParams): Promise<GetSpansResult>;
+export {};
+//# sourceMappingURL=getSpans.d.ts.map

package/dist/esm/spans/getSpans.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getSpans.d.ts","sourceRoot":"","sources":["../../../src/spans/getSpans.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEpD;;GAEG;AACH,UAAU,cAAe,SAAQ,QAAQ;IACvC,oCAAoC;IACpC,OAAO,EAAE,eAAe,CAAC;IACzB,kFAAkF;IAClF,SAAS,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IACjC,kFAAkF;IAClF,OAAO,CAAC,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IAC/B,yCAAyC;IACzC,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,KAAK,gBAAgB,GAAG,UAAU,CAAC,UAAU,CAAC,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC;AAEnE,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;IAC/D,UAAU,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC,aAAa,CAAC,CAAC;CAC5E,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,wBAAsB,QAAQ,CAAC,EAC7B,MAAM,EAAE,OAAO,EACf,OAAO,EACP,MAAM,EACN,KAAW,EACX,SAAS,EACT,OAAO,GACR,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAuC1C"}

package/dist/esm/spans/getSpans.js

@@ -0,0 +1,85 @@
+import { createClient } from "../client.js";
+/**
+ * Get spans from a project with filtering criteria.
+ *
+ * This method allows you to search for spans within a project using various filters
+ * such as time range and supports cursor-based pagination.
+ * The spans are returned in Phoenix's standard format with human-readable timestamps
+ * and simplified attribute structures.
+ *
+ * @experimental this function is experimental and may change in the future
+ *
+ * @param params - The parameters to search for spans
+ * @returns A paginated response containing spans and optional next cursor
+ *
+ * @example
+ * ```ts
+ * // Get recent spans from a project
+ * const result = await getSpans({
+ *   client,
+ *   project: { projectName: "my-project" },
+ *   limit: 50
+ * });
+ *
+ * // Get spans in a time range
+
+ * const result = await getSpans({
+ *   client,
+ *   project: { projectName: "my-project" },
+ *   startTime: new Date("2024-01-01"),
+ *   endTime: new Date("2024-01-02"),
+ *   limit: 100
+ * });
+
+ *
+ * // Paginate through results
+ * let cursor: string | undefined;
+ * do {
+ *   const result = await getSpans({
+ *     client,
+ *     project: { projectName: "my-project" },
+ *     cursor,
+ *     limit: 100
+ *   });
+ *
+ *   // Process spans
+ *   result.spans.forEach(span => {
+ *     console.log(`Span: ${span.name}, Trace: ${span.context.trace_id}`);
+ *   });
+ *
+ *   cursor = result.nextCursor || undefined;
+ * } while (cursor);
+ * ```
+ */
+export async function getSpans({ client: _client, project, cursor, limit = 100, startTime, endTime, }) {
+    const client = _client ?? createClient();
+    const projectIdentifier = "projectId" in project ? project.projectId : project.projectName;
+    const params = {
+        limit,
+    };
+    if (cursor) {
+        params.cursor = cursor;
+    }
+    if (startTime) {
+        params.start_time =
+            startTime instanceof Date ? startTime.toISOString() : startTime;
+    }
+    if (endTime) {
+        params.end_time = endTime instanceof Date ? endTime.toISOString() : endTime;
+    }
+    const { data, error } = await client.GET("/v1/projects/{project_identifier}/spans", {
+        params: {
+            path: {
+                project_identifier: projectIdentifier,
+            },
+            query: params,
+        },
+    });
+    if (error)
+        throw error;
+    return {
+        spans: data?.data ?? [],
+        nextCursor: data?.next_cursor ?? null,
+    };
+}
+//# sourceMappingURL=getSpans.js.map

package/dist/esm/spans/getSpans.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getSpans.js","sourceRoot":"","sources":["../../../src/spans/getSpans.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AA4BzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,EAC7B,MAAM,EAAE,OAAO,EACf,OAAO,EACP,MAAM,EACN,KAAK,GAAG,GAAG,EACX,SAAS,EACT,OAAO,GACQ;IACf,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,MAAM,iBAAiB,GACrB,WAAW,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;IAEnE,MAAM,MAAM,GAA+D;QACzE,KAAK;KACN,CAAC;IAEF,IAAI,MAAM,EAAE,CAAC;QACX,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;IAED,IAAI,SAAS,EAAE,CAAC;QACd,MAAM,CAAC,UAAU;YACf,SAAS,YAAY,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;IACpE,CAAC;IAED,IAAI,OAAO,EAAE,CAAC;QACZ,MAAM,CAAC,QAAQ,GAAG,OAAO,YAAY,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;IAC9E,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,GAAG,CACtC,yCAAyC,EACzC;QACE,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,kBAAkB,EAAE,iBAAiB;aACtC;YACD,KAAK,EAAE,MAAM;SACd;KACF,CACF,CAAC;IAEF,IAAI,KAAK;QAAE,MAAM,KAAK,CAAC;IACvB,OAAO;QACL,KAAK,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE;QACvB,UAAU,EAAE,IAAI,EAAE,WAAW,IAAI,IAAI;KACtC,CAAC;AACJ,CAAC"}

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

@@ -1,3 +1,5 @@
 export * from "./addSpanAnnotation.js";
 export * from "./logSpanAnnotations.js";
+export * from "./getSpans.js";
+export * from "./getSpanAnnotations.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/esm/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"}
+{"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"}

package/dist/esm/spans/index.js

@@ -1,3 +1,5 @@
 export * from "./addSpanAnnotation.js";
 export * from "./logSpanAnnotations.js";
+export * from "./getSpans.js";
+export * from "./getSpanAnnotations.js";
 //# sourceMappingURL=index.js.map

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

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