@arizeai/phoenix-client 7.9.0 → 7.11.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @arizeai/phoenix-client
 
+## 7.11.0
+
+### Minor Changes
+
+- 2b73847: Accept `metadata` in `promptVersion()` so prompt versions can carry arbitrary JSON metadata.
+
+## 7.10.0
+
+### Minor Changes
+
+- c839254: Add `error`, `minLatencyMs`, and `maxLatencyMs` filters to `getTraces`, matching the query parameters on `GET /v1/projects/{id}/traces` (requires Phoenix server >= 20.8.0).
+
 ## 7.9.0
 
 ### Minor Changes

package/README.md

@@ -421,19 +421,29 @@ const sessionTraces = await getTraces({
   project: { projectName: "my-project" },
   sessionId: "my-session-id",
 });
+
+// Filter by error status and latency (requires Phoenix server >= 20.8.0)
+const slowFailures = await getTraces({
+  project: { projectName: "my-project" },
+  error: true,
+  minLatencyMs: 1000,
+});
 ```
 
-| Parameter      | Type                           | Description                                |
-| -------------- | ------------------------------ | ------------------------------------------ |
-| `project`      | `ProjectIdentifier`            | The project (by name or ID) — **required** |
-| `startTime`    | `Date \| string \| null`       | Inclusive lower bound on trace start time  |
-| `endTime`      | `Date \| string \| null`       | Exclusive upper bound on trace start time  |
-| `sort`         | `"start_time" \| "latency_ms"` | Sort field                                 |
-| `order`        | `"asc" \| "desc"`              | Sort direction                             |
-| `limit`        | `number`                       | Maximum number of traces to return         |
-| `cursor`       | `string \| null`               | Pagination cursor                          |
-| `includeSpans` | `boolean`                      | Include full span details for each trace   |
-| `sessionId`    | `string \| string[] \| null`   | Filter traces by session identifier(s)     |
+| Parameter      | Type                           | Description                                                  |
+| -------------- | ------------------------------ | ------------------------------------------------------------ |
+| `project`      | `ProjectIdentifier`            | The project (by name or ID) — **required**                   |
+| `startTime`    | `Date \| string \| null`       | Inclusive lower bound on trace start time                    |
+| `endTime`      | `Date \| string \| null`       | Exclusive upper bound on trace start time                    |
+| `sort`         | `"start_time" \| "latency_ms"` | Sort field                                                   |
+| `order`        | `"asc" \| "desc"`              | Sort direction                                               |
+| `limit`        | `number`                       | Maximum number of traces to return                           |
+| `cursor`       | `string \| null`               | Pagination cursor                                            |
+| `includeSpans` | `boolean`                      | Include full span details for each trace                     |
+| `sessionId`    | `string \| string[] \| null`   | Filter traces by session identifier(s)                       |
+| `error`        | `boolean \| null`              | Only traces with (`true`) or without (`false`) errored spans |
+| `minLatencyMs` | `number \| null`               | Inclusive lower bound on trace latency (ms)                  |
+| `maxLatencyMs` | `number \| null`               | Inclusive upper bound on trace latency (ms)                  |
 
 ### Pagination
 

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

@@ -5295,6 +5295,13 @@ export interface components {
         PromptVersion: {
             /** Description */
             description?: string | null;
+            /**
+             * Metadata
+             * @description Arbitrary JSON metadata for the prompt version.
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
             model_provider: components["schemas"]["ModelProvider"];
             /** Model Name */
             model_name: string;
@@ -5314,6 +5321,13 @@ export interface components {
         PromptVersionData: {
             /** Description */
             description?: string | null;
+            /**
+             * Metadata
+             * @description Arbitrary JSON metadata for the prompt version.
+             */
+            metadata?: {
+                [key: string]: unknown;
+            };
             model_provider: components["schemas"]["ModelProvider"];
             /** Model Name */
             model_name: string;