@arizeai/phoenix-client 7.4.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.
Files changed (76) hide show
  1. package/CHANGELOG.md +769 -0
  2. package/dist/esm/__generated__/api/v1.d.ts +4033 -2286
  3. package/dist/esm/__generated__/api/v1.d.ts.map +1 -1
  4. package/dist/esm/client.d.ts.map +1 -1
  5. package/dist/esm/client.js +2 -3
  6. package/dist/esm/client.js.map +1 -1
  7. package/dist/esm/constants/serverRequirements.d.ts +9 -0
  8. package/dist/esm/constants/serverRequirements.d.ts.map +1 -1
  9. package/dist/esm/constants/serverRequirements.js +63 -0
  10. package/dist/esm/constants/serverRequirements.js.map +1 -1
  11. package/dist/esm/index.d.ts +6 -0
  12. package/dist/esm/index.d.ts.map +1 -1
  13. package/dist/esm/index.js +4 -0
  14. package/dist/esm/index.js.map +1 -1
  15. package/dist/esm/prompts/deletePrompt.d.ts +39 -0
  16. package/dist/esm/prompts/deletePrompt.d.ts.map +1 -0
  17. package/dist/esm/prompts/deletePrompt.js +52 -0
  18. package/dist/esm/prompts/deletePrompt.js.map +1 -0
  19. package/dist/esm/prompts/index.d.ts +1 -0
  20. package/dist/esm/prompts/index.d.ts.map +1 -1
  21. package/dist/esm/prompts/index.js +1 -0
  22. package/dist/esm/prompts/index.js.map +1 -1
  23. package/dist/esm/testing/reporter-format.d.ts.map +1 -1
  24. package/dist/esm/testing/reporter-format.js +13 -3
  25. package/dist/esm/testing/reporter-format.js.map +1 -1
  26. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  27. package/dist/esm/types/prompts.d.ts +9 -0
  28. package/dist/esm/types/prompts.d.ts.map +1 -1
  29. package/dist/esm/types/prompts.js.map +1 -1
  30. package/dist/esm/utils/resolvePromptIdentifier.d.ts +17 -0
  31. package/dist/esm/utils/resolvePromptIdentifier.d.ts.map +1 -0
  32. package/dist/esm/utils/resolvePromptIdentifier.js +36 -0
  33. package/dist/esm/utils/resolvePromptIdentifier.js.map +1 -0
  34. package/dist/src/__generated__/api/v1.d.ts +4033 -2286
  35. package/dist/src/__generated__/api/v1.d.ts.map +1 -1
  36. package/dist/src/client.d.ts.map +1 -1
  37. package/dist/src/client.js +4 -5
  38. package/dist/src/client.js.map +1 -1
  39. package/dist/src/constants/serverRequirements.d.ts +9 -0
  40. package/dist/src/constants/serverRequirements.d.ts.map +1 -1
  41. package/dist/src/constants/serverRequirements.js +64 -1
  42. package/dist/src/constants/serverRequirements.js.map +1 -1
  43. package/dist/src/index.d.ts +6 -0
  44. package/dist/src/index.d.ts.map +1 -1
  45. package/dist/src/index.js +19 -0
  46. package/dist/src/index.js.map +1 -1
  47. package/dist/src/prompts/deletePrompt.d.ts +39 -0
  48. package/dist/src/prompts/deletePrompt.d.ts.map +1 -0
  49. package/dist/src/prompts/deletePrompt.js +55 -0
  50. package/dist/src/prompts/deletePrompt.js.map +1 -0
  51. package/dist/src/prompts/index.d.ts +1 -0
  52. package/dist/src/prompts/index.d.ts.map +1 -1
  53. package/dist/src/prompts/index.js +1 -0
  54. package/dist/src/prompts/index.js.map +1 -1
  55. package/dist/src/testing/reporter-format.d.ts.map +1 -1
  56. package/dist/src/testing/reporter-format.js +13 -3
  57. package/dist/src/testing/reporter-format.js.map +1 -1
  58. package/dist/src/types/prompts.d.ts +9 -0
  59. package/dist/src/types/prompts.d.ts.map +1 -1
  60. package/dist/src/types/prompts.js.map +1 -1
  61. package/dist/src/utils/resolvePromptIdentifier.d.ts +17 -0
  62. package/dist/src/utils/resolvePromptIdentifier.d.ts.map +1 -0
  63. package/dist/src/utils/resolvePromptIdentifier.js +39 -0
  64. package/dist/src/utils/resolvePromptIdentifier.js.map +1 -0
  65. package/dist/tsconfig.tsbuildinfo +1 -1
  66. package/docs/prompts.mdx +19 -1
  67. package/package.json +11 -11
  68. package/src/__generated__/api/v1.ts +4033 -2286
  69. package/src/client.ts +4 -3
  70. package/src/constants/serverRequirements.ts +72 -0
  71. package/src/index.ts +26 -0
  72. package/src/prompts/deletePrompt.ts +70 -0
  73. package/src/prompts/index.ts +1 -0
  74. package/src/testing/reporter-format.ts +13 -3
  75. package/src/types/prompts.ts +10 -0
  76. package/src/utils/resolvePromptIdentifier.ts +41 -0
@@ -1 +1 @@
1
- {"version":3,"file":"prompts.js","sourceRoot":"","sources":["../../../src/types/prompts.ts"],"names":[],"mappings":";;;;AA2KA,yBAAgC,IAAgB;IAC9C,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC;AAC7B,CAAC;AAED,8BACE,IAAgB;IAEhB,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC;AAClC,CAAC"}
1
+ {"version":3,"file":"prompts.js","sourceRoot":"","sources":["../../../src/types/prompts.ts"],"names":[],"mappings":";;;;AAqLA,yBAAgC,IAAgB;IAC9C,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC;AAC7B,CAAC;AAED,8BACE,IAAgB;IAEhB,OAAO,IAAI,CAAC,IAAI,KAAK,UAAU,CAAC;AAClC,CAAC"}
@@ -0,0 +1,17 @@
1
+ import type { PromptIdentifier } from "../types/prompts";
2
+ /**
3
+ * Resolve a prompt-level selector to the `{prompt_identifier}` path segment the
4
+ * Phoenix REST API expects.
5
+ *
6
+ * Version-level selectors are rejected rather than silently widened: structural
7
+ * typing lets a `{ name, tag }` or `{ versionId }` value reach a
8
+ * {@link PromptIdentifier} parameter, and quietly dropping the version would
9
+ * point the caller at the whole prompt instead of the version they named.
10
+ *
11
+ * @param prompt - the prompt, selected by `name` or by `promptId`
12
+ * @returns The identifier to interpolate into the request path.
13
+ * @throws An error if the selector is empty, or selects a version rather than a
14
+ * prompt.
15
+ */
16
+ export declare function resolvePromptIdentifier(prompt: PromptIdentifier): string;
17
+ //# sourceMappingURL=resolvePromptIdentifier.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"resolvePromptIdentifier.d.ts","sourceRoot":"","sources":["../../../src/utils/resolvePromptIdentifier.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEzD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,gBAAgB,GAAG,MAAM,CAwBxE"}
@@ -0,0 +1,39 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.resolvePromptIdentifier = resolvePromptIdentifier;
4
+ /**
5
+ * Resolve a prompt-level selector to the `{prompt_identifier}` path segment the
6
+ * Phoenix REST API expects.
7
+ *
8
+ * Version-level selectors are rejected rather than silently widened: structural
9
+ * typing lets a `{ name, tag }` or `{ versionId }` value reach a
10
+ * {@link PromptIdentifier} parameter, and quietly dropping the version would
11
+ * point the caller at the whole prompt instead of the version they named.
12
+ *
13
+ * @param prompt - the prompt, selected by `name` or by `promptId`
14
+ * @returns The identifier to interpolate into the request path.
15
+ * @throws An error if the selector is empty, or selects a version rather than a
16
+ * prompt.
17
+ */
18
+ function resolvePromptIdentifier(prompt) {
19
+ if ("versionId" in prompt) {
20
+ throw new Error("A prompt version id selects a single version, not a prompt. Select the prompt by name or promptId.");
21
+ }
22
+ if ("tag" in prompt) {
23
+ throw new Error("A tag selects a single version, not a prompt. Select the prompt by name or promptId.");
24
+ }
25
+ if ("promptId" in prompt) {
26
+ if (!prompt.promptId) {
27
+ throw new Error("promptId must be a non-empty prompt id.");
28
+ }
29
+ return prompt.promptId;
30
+ }
31
+ if ("name" in prompt) {
32
+ if (!prompt.name) {
33
+ throw new Error("name must be a non-empty prompt name.");
34
+ }
35
+ return prompt.name;
36
+ }
37
+ throw new Error("A prompt must be selected by either name or promptId.");
38
+ }
39
+ //# sourceMappingURL=resolvePromptIdentifier.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"resolvePromptIdentifier.js","sourceRoot":"","sources":["../../../src/utils/resolvePromptIdentifier.ts"],"names":[],"mappings":";;;AAEA;;;;;;;;;;;;;GAaG;AACH,iCAAwC,MAAwB;IAC9D,IAAI,WAAW,IAAI,MAAM,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CACb,oGAAoG,CACrG,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,IAAI,MAAM,EAAE,CAAC;QACpB,MAAM,IAAI,KAAK,CACb,sFAAsF,CACvF,CAAC;IACJ,CAAC;IACD,IAAI,UAAU,IAAI,MAAM,EAAE,CAAC;QACzB,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC7D,CAAC;QACD,OAAO,MAAM,CAAC,QAAQ,CAAC;IACzB,CAAC;IACD,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC;QACrB,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC3D,CAAC;QACD,OAAO,MAAM,CAAC,IAAI,CAAC;IACrB,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;AAC3E,CAAC"}