@arizeai/phoenix-client 7.5.0 → 7.6.0
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/CHANGELOG.md +769 -0
- package/dist/esm/__generated__/api/v1.d.ts +748 -202
- package/dist/esm/__generated__/api/v1.d.ts.map +1 -1
- package/dist/esm/constants/serverRequirements.d.ts +1 -0
- package/dist/esm/constants/serverRequirements.d.ts.map +1 -1
- package/dist/esm/constants/serverRequirements.js +7 -0
- package/dist/esm/constants/serverRequirements.js.map +1 -1
- package/dist/esm/prompts/deletePrompt.d.ts +39 -0
- package/dist/esm/prompts/deletePrompt.d.ts.map +1 -0
- package/dist/esm/prompts/deletePrompt.js +52 -0
- package/dist/esm/prompts/deletePrompt.js.map +1 -0
- package/dist/esm/prompts/index.d.ts +1 -0
- package/dist/esm/prompts/index.d.ts.map +1 -1
- package/dist/esm/prompts/index.js +1 -0
- package/dist/esm/prompts/index.js.map +1 -1
- package/dist/esm/testing/reporter-format.d.ts.map +1 -1
- package/dist/esm/testing/reporter-format.js +13 -3
- package/dist/esm/testing/reporter-format.js.map +1 -1
- package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
- package/dist/esm/types/prompts.d.ts +9 -0
- package/dist/esm/types/prompts.d.ts.map +1 -1
- package/dist/esm/types/prompts.js.map +1 -1
- package/dist/esm/utils/resolvePromptIdentifier.d.ts +17 -0
- package/dist/esm/utils/resolvePromptIdentifier.d.ts.map +1 -0
- package/dist/esm/utils/resolvePromptIdentifier.js +36 -0
- package/dist/esm/utils/resolvePromptIdentifier.js.map +1 -0
- package/dist/src/__generated__/api/v1.d.ts +748 -202
- package/dist/src/__generated__/api/v1.d.ts.map +1 -1
- package/dist/src/constants/serverRequirements.d.ts +1 -0
- package/dist/src/constants/serverRequirements.d.ts.map +1 -1
- package/dist/src/constants/serverRequirements.js +8 -1
- package/dist/src/constants/serverRequirements.js.map +1 -1
- package/dist/src/prompts/deletePrompt.d.ts +39 -0
- package/dist/src/prompts/deletePrompt.d.ts.map +1 -0
- package/dist/src/prompts/deletePrompt.js +55 -0
- package/dist/src/prompts/deletePrompt.js.map +1 -0
- package/dist/src/prompts/index.d.ts +1 -0
- package/dist/src/prompts/index.d.ts.map +1 -1
- package/dist/src/prompts/index.js +1 -0
- package/dist/src/prompts/index.js.map +1 -1
- package/dist/src/testing/reporter-format.d.ts.map +1 -1
- package/dist/src/testing/reporter-format.js +13 -3
- package/dist/src/testing/reporter-format.js.map +1 -1
- package/dist/src/types/prompts.d.ts +9 -0
- package/dist/src/types/prompts.d.ts.map +1 -1
- package/dist/src/types/prompts.js.map +1 -1
- package/dist/src/utils/resolvePromptIdentifier.d.ts +17 -0
- package/dist/src/utils/resolvePromptIdentifier.d.ts.map +1 -0
- package/dist/src/utils/resolvePromptIdentifier.js +39 -0
- package/dist/src/utils/resolvePromptIdentifier.js.map +1 -0
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/docs/prompts.mdx +19 -1
- package/package.json +11 -11
- package/src/__generated__/api/v1.ts +748 -202
- package/src/constants/serverRequirements.ts +8 -0
- package/src/prompts/deletePrompt.ts +70 -0
- package/src/prompts/index.ts +1 -0
- package/src/testing/reporter-format.ts +13 -3
- package/src/types/prompts.ts +10 -0
- package/src/utils/resolvePromptIdentifier.ts +41 -0
package/docs/prompts.mdx
CHANGED
|
@@ -3,7 +3,7 @@ title: "Prompts"
|
|
|
3
3
|
description: "Manage prompts with @arizeai/phoenix-client"
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
The prompts module lets you create prompt versions in Phoenix, fetch them back by selector, list prompts, update a prompt's description and metadata, and adapt prompt versions to supported provider SDKs.
|
|
6
|
+
The prompts module lets you create prompt versions in Phoenix, fetch them back by selector, list prompts, update a prompt's description and metadata, delete a prompt, and adapt prompt versions to supported provider SDKs.
|
|
7
7
|
|
|
8
8
|
<section className="hidden" data-agent-context="relevant-source-files" aria-label="Relevant source files">
|
|
9
9
|
<h2>Relevant Source Files</h2>
|
|
@@ -59,6 +59,23 @@ await updatePrompt({
|
|
|
59
59
|
|
|
60
60
|
Requires a Phoenix server on 19.18.0 or later.
|
|
61
61
|
|
|
62
|
+
## Delete A Prompt
|
|
63
|
+
|
|
64
|
+
```ts
|
|
65
|
+
import { deletePrompt } from "@arizeai/phoenix-client/prompts";
|
|
66
|
+
|
|
67
|
+
await deletePrompt({ prompt: { name: "support-response" } });
|
|
68
|
+
|
|
69
|
+
// Or by prompt id
|
|
70
|
+
await deletePrompt({ prompt: { promptId: "UHJvbXB0OjE=" } });
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
`prompt` takes the same selector style as `getPrompt`, narrowed to the two selectors that identify a prompt rather than one of its versions: `{ name }` and `{ promptId }`. Passing a version selector — `{ versionId }`, or `{ name, tag }` — rejects instead of falling back to the whole prompt, so a variable holding a version never deletes more than you named.
|
|
74
|
+
|
|
75
|
+
Deletion cascades: every version of the prompt, along with its version tags and labels, is removed with it, and the deletion cannot be undone. A prompt that does not exist rejects with `Prompt not found: <identifier>`.
|
|
76
|
+
|
|
77
|
+
Requires a Phoenix server on 13.20.0 or later.
|
|
78
|
+
|
|
62
79
|
## Convert To Another SDK
|
|
63
80
|
|
|
64
81
|
```ts
|
|
@@ -81,6 +98,7 @@ Supported `sdk` targets:
|
|
|
81
98
|
<h2>Source Map</h2>
|
|
82
99
|
<ul>
|
|
83
100
|
<li><code>src/prompts/createPrompt.ts</code></li>
|
|
101
|
+
<li><code>src/prompts/deletePrompt.ts</code></li>
|
|
84
102
|
<li><code>src/prompts/getPrompt.ts</code></li>
|
|
85
103
|
<li><code>src/prompts/listPrompts.ts</code></li>
|
|
86
104
|
<li><code>src/prompts/updatePrompt.ts</code></li>
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@arizeai/phoenix-client",
|
|
3
|
-
"version": "7.
|
|
3
|
+
"version": "7.6.0",
|
|
4
4
|
"description": "A client for the Phoenix API",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"arize",
|
|
@@ -100,30 +100,30 @@
|
|
|
100
100
|
},
|
|
101
101
|
"dependencies": {
|
|
102
102
|
"@arizeai/openinference-semantic-conventions": "^2.7.0",
|
|
103
|
+
"@arizeai/phoenix-config": "0.5.0",
|
|
104
|
+
"@arizeai/phoenix-otel": "2.2.0",
|
|
103
105
|
"async": "^3.2.6",
|
|
104
106
|
"openapi-fetch": "^0.17.0",
|
|
105
107
|
"tiny-invariant": "^1.3.3",
|
|
106
|
-
"zod": "^4.4.3"
|
|
107
|
-
"@arizeai/phoenix-config": "0.5.0",
|
|
108
|
-
"@arizeai/phoenix-otel": "2.2.0"
|
|
108
|
+
"zod": "^4.4.3"
|
|
109
109
|
},
|
|
110
110
|
"devDependencies": {
|
|
111
|
-
"@ai-sdk/openai": "^4.0.
|
|
112
|
-
"@ai-sdk/otel": "^1.0.
|
|
111
|
+
"@ai-sdk/openai": "^4.0.46",
|
|
112
|
+
"@ai-sdk/otel": "^1.0.77",
|
|
113
113
|
"@anthropic-ai/sdk": "^0.111.0",
|
|
114
|
+
"@arizeai/phoenix-evals": "2.4.0",
|
|
115
|
+
"@arizeai/phoenix-testing": "0.0.0",
|
|
114
116
|
"@opentelemetry/api": "^1.9.1",
|
|
115
117
|
"@opentelemetry/sdk-trace-node": "^2.10.0",
|
|
116
118
|
"@types/async": "^3.2.25",
|
|
117
119
|
"@types/node": "^26.2.0",
|
|
118
|
-
"ai": "^7.0.
|
|
120
|
+
"ai": "^7.0.77",
|
|
119
121
|
"dotenv": "^17.4.2",
|
|
120
122
|
"jest": "^30.4.2",
|
|
121
123
|
"openai": "^6.49.0",
|
|
122
124
|
"openapi-typescript": "^7.13.0",
|
|
123
|
-
"tsx": "^4.23.
|
|
124
|
-
"vitest": "^4.1.
|
|
125
|
-
"@arizeai/phoenix-evals": "2.2.0",
|
|
126
|
-
"@arizeai/phoenix-testing": "0.0.0"
|
|
125
|
+
"tsx": "^4.23.12",
|
|
126
|
+
"vitest": "^4.1.11"
|
|
127
127
|
},
|
|
128
128
|
"peerDependencies": {
|
|
129
129
|
"@anthropic-ai/sdk": "^0.35.0",
|