@arizeai/phoenix-client 7.2.0 → 7.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -2
- package/dist/esm/__generated__/api/v1.d.ts +548 -0
- package/dist/esm/__generated__/api/v1.d.ts.map +1 -1
- package/dist/esm/client.d.ts +10 -2
- package/dist/esm/client.d.ts.map +1 -1
- package/dist/esm/client.js +6 -0
- package/dist/esm/client.js.map +1 -1
- package/dist/esm/config.d.ts +10 -0
- package/dist/esm/config.d.ts.map +1 -1
- package/dist/esm/config.js +13 -9
- package/dist/esm/config.js.map +1 -1
- package/dist/esm/experiments/resumeEvaluation.d.ts.map +1 -1
- package/dist/esm/experiments/resumeEvaluation.js +5 -5
- package/dist/esm/experiments/resumeEvaluation.js.map +1 -1
- package/dist/esm/experiments/resumeExperiment.d.ts.map +1 -1
- package/dist/esm/experiments/resumeExperiment.js +5 -5
- package/dist/esm/experiments/resumeExperiment.js.map +1 -1
- package/dist/esm/experiments/runExperiment.d.ts.map +1 -1
- package/dist/esm/experiments/runExperiment.js +5 -5
- package/dist/esm/experiments/runExperiment.js.map +1 -1
- package/dist/esm/experiments/tracing.d.ts +27 -0
- package/dist/esm/experiments/tracing.d.ts.map +1 -1
- package/dist/esm/experiments/tracing.js +27 -0
- package/dist/esm/experiments/tracing.js.map +1 -1
- package/dist/esm/testing/phoenix-test-tracking.d.ts.map +1 -1
- package/dist/esm/testing/phoenix-test-tracking.js +9 -9
- package/dist/esm/testing/phoenix-test-tracking.js.map +1 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/src/__generated__/api/v1.d.ts +548 -0
- package/dist/src/__generated__/api/v1.d.ts.map +1 -1
- package/dist/src/client.d.ts +10 -2
- package/dist/src/client.d.ts.map +1 -1
- package/dist/src/client.js +6 -1
- package/dist/src/client.js.map +1 -1
- package/dist/src/config.d.ts +10 -0
- package/dist/src/config.d.ts.map +1 -1
- package/dist/src/config.js +11 -7
- package/dist/src/config.js.map +1 -1
- package/dist/src/experiments/resumeEvaluation.d.ts.map +1 -1
- package/dist/src/experiments/resumeEvaluation.js +4 -4
- package/dist/src/experiments/resumeEvaluation.js.map +1 -1
- package/dist/src/experiments/resumeExperiment.d.ts.map +1 -1
- package/dist/src/experiments/resumeExperiment.js +4 -4
- package/dist/src/experiments/resumeExperiment.js.map +1 -1
- package/dist/src/experiments/runExperiment.d.ts.map +1 -1
- package/dist/src/experiments/runExperiment.js +4 -4
- package/dist/src/experiments/runExperiment.js.map +1 -1
- package/dist/src/experiments/tracing.d.ts +27 -0
- package/dist/src/experiments/tracing.d.ts.map +1 -1
- package/dist/src/experiments/tracing.js +30 -0
- package/dist/src/experiments/tracing.js.map +1 -1
- package/dist/src/testing/phoenix-test-tracking.d.ts.map +1 -1
- package/dist/src/testing/phoenix-test-tracking.js +8 -8
- package/dist/src/testing/phoenix-test-tracking.js.map +1 -1
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/docs/ci-evals-jest.mdx +1 -1
- package/docs/ci-evals-vitest.mdx +1 -1
- package/docs/ci-evals.mdx +1 -1
- package/docs/overview.mdx +5 -5
- package/package.json +9 -9
- package/src/__generated__/api/v1.ts +548 -0
- package/src/client.ts +17 -1
- package/src/config.ts +28 -11
- package/src/experiments/resumeEvaluation.ts +11 -9
- package/src/experiments/resumeExperiment.ts +11 -9
- package/src/experiments/runExperiment.ts +9 -11
- package/src/experiments/tracing.ts +35 -0
- package/src/testing/phoenix-test-tracking.ts +12 -9
package/docs/ci-evals-jest.mdx
CHANGED
|
@@ -23,7 +23,7 @@ module.exports = {
|
|
|
23
23
|
- `testMatch` keeps eval suites separate from regular tests.
|
|
24
24
|
- `reporters` keeps Jest's default reporter and adds the Phoenix
|
|
25
25
|
summary block at the end of the run.
|
|
26
|
-
- `setupFiles: ["dotenv/config"]` loads `
|
|
26
|
+
- `setupFiles: ["dotenv/config"]` loads `PHOENIX_ENDPOINT`, `PHOENIX_API_KEY`,
|
|
27
27
|
and other env vars from `.env`.
|
|
28
28
|
- `testTimeout` is bumped because LLM calls can be slow.
|
|
29
29
|
|
package/docs/ci-evals-vitest.mdx
CHANGED
|
@@ -28,7 +28,7 @@ export default defineConfig({
|
|
|
28
28
|
`*.eval.ts` convention.
|
|
29
29
|
- `reporters` keeps Vitest's default diagnostics and enables the Phoenix
|
|
30
30
|
summary block.
|
|
31
|
-
- `setupFiles: ["dotenv/config"]` loads `
|
|
31
|
+
- `setupFiles: ["dotenv/config"]` loads `PHOENIX_ENDPOINT`, `PHOENIX_API_KEY`,
|
|
32
32
|
and any other env vars from `.env`.
|
|
33
33
|
- `testTimeout` is bumped because LLM calls can be slow.
|
|
34
34
|
|
package/docs/ci-evals.mdx
CHANGED
|
@@ -94,7 +94,7 @@ standard Phoenix env vars.
|
|
|
94
94
|
|
|
95
95
|
| Variable | Purpose |
|
|
96
96
|
| --- | --- |
|
|
97
|
-
| `
|
|
97
|
+
| `PHOENIX_ENDPOINT` | Phoenix base URL |
|
|
98
98
|
| `PHOENIX_API_KEY` | Bearer token for Phoenix |
|
|
99
99
|
| `PHOENIX_CLIENT_HEADERS` | Optional JSON headers forwarded to the Phoenix client and tracer |
|
|
100
100
|
| `PHOENIX_TEST_TRACKING=false` | Disable sync to Phoenix for the current run (tracking is on by default) |
|
package/docs/overview.mdx
CHANGED
|
@@ -50,18 +50,18 @@ That gives the agent version-matched docs plus the exact implementation and gene
|
|
|
50
50
|
|
|
51
51
|
## Configuration
|
|
52
52
|
|
|
53
|
-
`createClient()` resolves Phoenix client options in this order: library defaults, environment variables, then explicit options. In most applications, the normal setup is to set `
|
|
53
|
+
`createClient()` resolves Phoenix client options in this order: library defaults, environment variables, then explicit options. In most applications, the normal setup is to set `PHOENIX_ENDPOINT` and `PHOENIX_API_KEY` in the environment and call `createClient()` with no overrides.
|
|
54
54
|
|
|
55
55
|
### Recommended Setup
|
|
56
56
|
|
|
57
57
|
Use the environment-driven path unless you have a specific reason to override client options in code.
|
|
58
58
|
|
|
59
59
|
```bash
|
|
60
|
-
export
|
|
60
|
+
export PHOENIX_ENDPOINT=http://localhost:6006
|
|
61
61
|
export PHOENIX_API_KEY=<your-api-key>
|
|
62
62
|
```
|
|
63
63
|
|
|
64
|
-
For a remote deployment, `
|
|
64
|
+
For a remote deployment, `PHOENIX_ENDPOINT` is that instance's base URL, e.g. `https://your-phoenix.example.com`.
|
|
65
65
|
|
|
66
66
|
```ts
|
|
67
67
|
import { createClient } from "@arizeai/phoenix-client";
|
|
@@ -103,7 +103,7 @@ These are the Phoenix-specific options this package resolves before creating the
|
|
|
103
103
|
|
|
104
104
|
| Option | Type | Description |
|
|
105
105
|
|--------|------|-------------|
|
|
106
|
-
| `baseUrl` | `string` | Base Phoenix URL. Defaults to `http://localhost:6006`, or `
|
|
106
|
+
| `baseUrl` | `string` | Base Phoenix URL. Defaults to `http://localhost:6006`, or `PHOENIX_ENDPOINT` when that environment variable is set. |
|
|
107
107
|
| `headers` | `ClientOptions["headers"]` | Headers sent on every request. `PHOENIX_API_KEY` populates `Authorization` automatically. Explicit `headers` replace environment-derived headers. |
|
|
108
108
|
|
|
109
109
|
### Header Override Rule
|
|
@@ -124,7 +124,7 @@ const client = createClient({
|
|
|
124
124
|
|
|
125
125
|
| Variable | Maps to | Description |
|
|
126
126
|
|--------|---------|-------------|
|
|
127
|
-
| `
|
|
127
|
+
| `PHOENIX_ENDPOINT` | `options.baseUrl` | Base Phoenix URL, for example `http://localhost:6006`. |
|
|
128
128
|
| `PHOENIX_API_KEY` | `options.headers.Authorization` | Bearer token for authenticated environments. |
|
|
129
129
|
| `PHOENIX_CLIENT_HEADERS` | `options.headers` | Optional JSON-encoded object of additional headers to send on every request. Most setups do not need this. |
|
|
130
130
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@arizeai/phoenix-client",
|
|
3
|
-
"version": "7.
|
|
3
|
+
"version": "7.3.1",
|
|
4
4
|
"description": "A client for the Phoenix API",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"arize",
|
|
@@ -99,28 +99,28 @@
|
|
|
99
99
|
}
|
|
100
100
|
},
|
|
101
101
|
"dependencies": {
|
|
102
|
-
"@arizeai/openinference-semantic-conventions": "^2.
|
|
102
|
+
"@arizeai/openinference-semantic-conventions": "^2.7.0",
|
|
103
103
|
"async": "^3.2.6",
|
|
104
104
|
"openapi-fetch": "^0.17.0",
|
|
105
105
|
"tiny-invariant": "^1.3.3",
|
|
106
106
|
"zod": "^4.4.3",
|
|
107
|
-
"@arizeai/phoenix-otel": "2.
|
|
108
|
-
"@arizeai/phoenix-config": "0.
|
|
107
|
+
"@arizeai/phoenix-otel": "2.2.0",
|
|
108
|
+
"@arizeai/phoenix-config": "0.5.0"
|
|
109
109
|
},
|
|
110
110
|
"devDependencies": {
|
|
111
|
-
"@ai-sdk/openai": "^4.0.
|
|
112
|
-
"@ai-sdk/otel": "^1.0.
|
|
111
|
+
"@ai-sdk/openai": "^4.0.36",
|
|
112
|
+
"@ai-sdk/otel": "^1.0.58",
|
|
113
113
|
"@anthropic-ai/sdk": "^0.111.0",
|
|
114
114
|
"@opentelemetry/api": "^1.9.1",
|
|
115
115
|
"@opentelemetry/sdk-trace-node": "^2.10.0",
|
|
116
116
|
"@types/async": "^3.2.25",
|
|
117
|
-
"@types/node": "^26.
|
|
118
|
-
"ai": "^7.0.
|
|
117
|
+
"@types/node": "^26.2.0",
|
|
118
|
+
"ai": "^7.0.58",
|
|
119
119
|
"dotenv": "^17.4.2",
|
|
120
120
|
"jest": "^30.4.2",
|
|
121
121
|
"openai": "^6.49.0",
|
|
122
122
|
"openapi-typescript": "^7.13.0",
|
|
123
|
-
"tsx": "^4.23.
|
|
123
|
+
"tsx": "^4.23.11",
|
|
124
124
|
"vitest": "^4.1.10",
|
|
125
125
|
"@arizeai/phoenix-evals": "2.2.0",
|
|
126
126
|
"@arizeai/phoenix-testing": "0.0.0"
|