@arizeai/phoenix-client 7.3.1 → 7.5.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.
Files changed (52) hide show
  1. package/dist/esm/__generated__/api/v1.d.ts +1607 -406
  2. package/dist/esm/__generated__/api/v1.d.ts.map +1 -1
  3. package/dist/esm/client.d.ts.map +1 -1
  4. package/dist/esm/client.js +2 -3
  5. package/dist/esm/client.js.map +1 -1
  6. package/dist/esm/constants/serverRequirements.d.ts +9 -0
  7. package/dist/esm/constants/serverRequirements.d.ts.map +1 -1
  8. package/dist/esm/constants/serverRequirements.js +63 -0
  9. package/dist/esm/constants/serverRequirements.js.map +1 -1
  10. package/dist/esm/index.d.ts +6 -0
  11. package/dist/esm/index.d.ts.map +1 -1
  12. package/dist/esm/index.js +4 -0
  13. package/dist/esm/index.js.map +1 -1
  14. package/dist/esm/prompts/index.d.ts +1 -0
  15. package/dist/esm/prompts/index.d.ts.map +1 -1
  16. package/dist/esm/prompts/index.js +1 -0
  17. package/dist/esm/prompts/index.js.map +1 -1
  18. package/dist/esm/prompts/updatePrompt.d.ts +51 -0
  19. package/dist/esm/prompts/updatePrompt.d.ts.map +1 -0
  20. package/dist/esm/prompts/updatePrompt.js +62 -0
  21. package/dist/esm/prompts/updatePrompt.js.map +1 -0
  22. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  23. package/dist/src/__generated__/api/v1.d.ts +1607 -406
  24. package/dist/src/__generated__/api/v1.d.ts.map +1 -1
  25. package/dist/src/client.d.ts.map +1 -1
  26. package/dist/src/client.js +4 -5
  27. package/dist/src/client.js.map +1 -1
  28. package/dist/src/constants/serverRequirements.d.ts +9 -0
  29. package/dist/src/constants/serverRequirements.d.ts.map +1 -1
  30. package/dist/src/constants/serverRequirements.js +64 -1
  31. package/dist/src/constants/serverRequirements.js.map +1 -1
  32. package/dist/src/index.d.ts +6 -0
  33. package/dist/src/index.d.ts.map +1 -1
  34. package/dist/src/index.js +19 -0
  35. package/dist/src/index.js.map +1 -1
  36. package/dist/src/prompts/index.d.ts +1 -0
  37. package/dist/src/prompts/index.d.ts.map +1 -1
  38. package/dist/src/prompts/index.js +1 -0
  39. package/dist/src/prompts/index.js.map +1 -1
  40. package/dist/src/prompts/updatePrompt.d.ts +51 -0
  41. package/dist/src/prompts/updatePrompt.d.ts.map +1 -0
  42. package/dist/src/prompts/updatePrompt.js +66 -0
  43. package/dist/src/prompts/updatePrompt.js.map +1 -0
  44. package/dist/tsconfig.tsbuildinfo +1 -1
  45. package/docs/prompts.mdx +18 -1
  46. package/package.json +3 -3
  47. package/src/__generated__/api/v1.ts +1607 -406
  48. package/src/client.ts +4 -3
  49. package/src/constants/serverRequirements.ts +72 -0
  50. package/src/index.ts +26 -0
  51. package/src/prompts/index.ts +1 -0
  52. package/src/prompts/updatePrompt.ts +95 -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, 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, 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>
@@ -43,6 +43,22 @@ const prompt = await getPrompt({
43
43
 
44
44
  `prompt` can be selected by `{ name }`, `{ name, tag }`, or `{ versionId }`.
45
45
 
46
+ ## Update Description And Metadata
47
+
48
+ ```ts
49
+ import { updatePrompt } from "@arizeai/phoenix-client/prompts";
50
+
51
+ await updatePrompt({
52
+ promptIdentifier: "support-response",
53
+ description: "Customer support reply prompt",
54
+ metadata: { team: "ml", env: "production" },
55
+ });
56
+ ```
57
+
58
+ `promptIdentifier` is a prompt name or ID. Omit a field to leave it unchanged, and pass `description: null` to clear it. `metadata` replaces the existing metadata object as a whole rather than merging into it.
59
+
60
+ Requires a Phoenix server on 19.18.0 or later.
61
+
46
62
  ## Convert To Another SDK
47
63
 
48
64
  ```ts
@@ -67,6 +83,7 @@ Supported `sdk` targets:
67
83
  <li><code>src/prompts/createPrompt.ts</code></li>
68
84
  <li><code>src/prompts/getPrompt.ts</code></li>
69
85
  <li><code>src/prompts/listPrompts.ts</code></li>
86
+ <li><code>src/prompts/updatePrompt.ts</code></li>
70
87
  <li><code>src/prompts/sdks/toSDK.ts</code></li>
71
88
  <li><code>src/types/prompts.ts</code></li>
72
89
  </ul>
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@arizeai/phoenix-client",
3
- "version": "7.3.1",
3
+ "version": "7.5.0",
4
4
  "description": "A client for the Phoenix API",
5
5
  "keywords": [
6
6
  "arize",
@@ -104,8 +104,8 @@
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.2.0",
108
- "@arizeai/phoenix-config": "0.5.0"
107
+ "@arizeai/phoenix-config": "0.5.0",
108
+ "@arizeai/phoenix-otel": "2.2.0"
109
109
  },
110
110
  "devDependencies": {
111
111
  "@ai-sdk/openai": "^4.0.36",