@arizeai/phoenix-client 6.5.4 → 6.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 (59) hide show
  1. package/dist/esm/__generated__/api/v1.d.ts +244 -0
  2. package/dist/esm/__generated__/api/v1.d.ts.map +1 -1
  3. package/dist/esm/experiments/resumeEvaluation.d.ts.map +1 -1
  4. package/dist/esm/experiments/resumeEvaluation.js +181 -170
  5. package/dist/esm/experiments/resumeEvaluation.js.map +1 -1
  6. package/dist/esm/experiments/resumeExperiment.d.ts.map +1 -1
  7. package/dist/esm/experiments/resumeExperiment.js +201 -185
  8. package/dist/esm/experiments/resumeExperiment.js.map +1 -1
  9. package/dist/esm/experiments/runExperiment.d.ts.map +1 -1
  10. package/dist/esm/experiments/runExperiment.js +239 -207
  11. package/dist/esm/experiments/runExperiment.js.map +1 -1
  12. package/dist/esm/experiments/tracing.d.ts +10 -0
  13. package/dist/esm/experiments/tracing.d.ts.map +1 -0
  14. package/dist/esm/experiments/tracing.js +21 -0
  15. package/dist/esm/experiments/tracing.js.map +1 -0
  16. package/dist/esm/prompts/sdks/toSDK.d.ts +2 -2
  17. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  18. package/dist/esm/types/experiments.d.ts +6 -0
  19. package/dist/esm/types/experiments.d.ts.map +1 -1
  20. package/dist/esm/utils/formatPromptMessages.d.ts.map +1 -1
  21. package/dist/esm/utils/getPromptBySelector.d.ts.map +1 -1
  22. package/dist/src/__generated__/api/v1.d.ts +244 -0
  23. package/dist/src/__generated__/api/v1.d.ts.map +1 -1
  24. package/dist/src/experiments/resumeEvaluation.d.ts.map +1 -1
  25. package/dist/src/experiments/resumeEvaluation.js +194 -183
  26. package/dist/src/experiments/resumeEvaluation.js.map +1 -1
  27. package/dist/src/experiments/resumeExperiment.d.ts.map +1 -1
  28. package/dist/src/experiments/resumeExperiment.js +214 -198
  29. package/dist/src/experiments/resumeExperiment.js.map +1 -1
  30. package/dist/src/experiments/runExperiment.d.ts.map +1 -1
  31. package/dist/src/experiments/runExperiment.js +229 -197
  32. package/dist/src/experiments/runExperiment.js.map +1 -1
  33. package/dist/src/experiments/tracing.d.ts +10 -0
  34. package/dist/src/experiments/tracing.d.ts.map +1 -0
  35. package/dist/src/experiments/tracing.js +24 -0
  36. package/dist/src/experiments/tracing.js.map +1 -0
  37. package/dist/src/types/experiments.d.ts +6 -0
  38. package/dist/src/types/experiments.d.ts.map +1 -1
  39. package/dist/src/utils/formatPromptMessages.d.ts.map +1 -1
  40. package/dist/src/utils/getPromptBySelector.d.ts.map +1 -1
  41. package/dist/tsconfig.tsbuildinfo +1 -1
  42. package/docs/annotations.mdx +83 -0
  43. package/docs/datasets.mdx +77 -0
  44. package/docs/document-annotations.mdx +208 -0
  45. package/docs/experiments.mdx +376 -0
  46. package/docs/overview.mdx +176 -0
  47. package/docs/prompts.mdx +73 -0
  48. package/docs/session-annotations.mdx +158 -0
  49. package/docs/sessions.mdx +87 -0
  50. package/docs/span-annotations.mdx +283 -0
  51. package/docs/spans.mdx +76 -0
  52. package/docs/traces.mdx +63 -0
  53. package/package.json +9 -3
  54. package/src/__generated__/api/v1.ts +244 -0
  55. package/src/experiments/resumeEvaluation.ts +226 -206
  56. package/src/experiments/resumeExperiment.ts +237 -213
  57. package/src/experiments/runExperiment.ts +282 -243
  58. package/src/experiments/tracing.ts +30 -0
  59. package/src/types/experiments.ts +6 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@arizeai/phoenix-client",
3
- "version": "6.5.4",
3
+ "version": "6.6.0",
4
4
  "description": "A client for the Phoenix API",
5
5
  "keywords": [
6
6
  "arize",
@@ -22,8 +22,12 @@
22
22
  "type": "git",
23
23
  "url": "git+https://github.com/Arize-ai/phoenix.git"
24
24
  },
25
+ "directories": {
26
+ "doc": "./docs"
27
+ },
25
28
  "files": [
26
29
  "dist",
30
+ "docs",
27
31
  "src",
28
32
  "package.json"
29
33
  ],
@@ -76,11 +80,13 @@
76
80
  "tiny-invariant": "^1.3.3",
77
81
  "zod": "^4.0.14",
78
82
  "@arizeai/phoenix-config": "0.1.3",
79
- "@arizeai/phoenix-otel": "0.4.2"
83
+ "@arizeai/phoenix-otel": "0.4.3"
80
84
  },
81
85
  "devDependencies": {
82
86
  "@ai-sdk/openai": "^3.0.29",
83
87
  "@anthropic-ai/sdk": "^0.35.0",
88
+ "@opentelemetry/api": "^1.9.0",
89
+ "@opentelemetry/sdk-trace-node": "^2.5.1",
84
90
  "@types/async": "^3.2.24",
85
91
  "@types/node": "^20.17.22",
86
92
  "ai": "^6.0.90",
@@ -88,7 +94,7 @@
88
94
  "openapi-typescript": "^7.6.1",
89
95
  "tsx": "^4.19.3",
90
96
  "vitest": "^4.1.0",
91
- "@arizeai/phoenix-evals": "1.0.1"
97
+ "@arizeai/phoenix-evals": "1.0.2"
92
98
  },
93
99
  "optionalDependencies": {
94
100
  "@anthropic-ai/sdk": "^0.35.0",
@@ -741,6 +741,46 @@ export interface paths {
741
741
  patch?: never;
742
742
  trace?: never;
743
743
  };
744
+ "/v1/prompt_versions/{prompt_version_id}/tags/{tag_name}": {
745
+ parameters: {
746
+ query?: never;
747
+ header?: never;
748
+ path?: never;
749
+ cookie?: never;
750
+ };
751
+ get?: never;
752
+ put?: never;
753
+ post?: never;
754
+ /**
755
+ * Delete a tag from a prompt version
756
+ * @description Delete a tag from a specific prompt version by tag name. The tag is resolved within the scope of the prompt linked to the version.
757
+ */
758
+ delete: operations["deletePromptVersionTag"];
759
+ options?: never;
760
+ head?: never;
761
+ patch?: never;
762
+ trace?: never;
763
+ };
764
+ "/v1/prompts/{prompt_identifier}": {
765
+ parameters: {
766
+ query?: never;
767
+ header?: never;
768
+ path?: never;
769
+ cookie?: never;
770
+ };
771
+ get?: never;
772
+ put?: never;
773
+ post?: never;
774
+ /**
775
+ * Delete a prompt
776
+ * @description Delete a prompt and all its versions, tags, and labels by identifier.
777
+ */
778
+ delete: operations["deletePrompt"];
779
+ options?: never;
780
+ head?: never;
781
+ patch?: never;
782
+ trace?: never;
783
+ };
744
784
  "/v1/projects": {
745
785
  parameters: {
746
786
  query?: never;
@@ -953,6 +993,26 @@ export interface paths {
953
993
  patch?: never;
954
994
  trace?: never;
955
995
  };
996
+ "/v1/secrets": {
997
+ parameters: {
998
+ query?: never;
999
+ header?: never;
1000
+ path?: never;
1001
+ cookie?: never;
1002
+ };
1003
+ get?: never;
1004
+ /**
1005
+ * Upsert or delete secrets
1006
+ * @description Atomically upsert or delete a batch of secrets. Entries with a non-null `value` are created or updated; entries with `value: null` are deleted. The `value` field is required for every entry, and omitting it returns 422. When the same key appears more than once, the last occurrence wins. Deleting a non-existent key succeeds silently. Secret values are never returned in the response.
1007
+ */
1008
+ put: operations["upsertOrDeleteSecrets"];
1009
+ post?: never;
1010
+ delete?: never;
1011
+ options?: never;
1012
+ head?: never;
1013
+ patch?: never;
1014
+ trace?: never;
1015
+ };
956
1016
  }
957
1017
  export type webhooks = Record<string, never>;
958
1018
  export interface components {
@@ -2745,6 +2805,23 @@ export interface components {
2745
2805
  */
2746
2806
  reasoning_effort?: "none" | "minimal" | "low" | "medium" | "high" | "xhigh";
2747
2807
  };
2808
+ /** ResponseBody[UpsertOrDeleteSecretsResult] */
2809
+ ResponseBody_UpsertOrDeleteSecretsResult_: {
2810
+ data: components["schemas"]["UpsertOrDeleteSecretsResult"];
2811
+ };
2812
+ /**
2813
+ * SecretKeyValue
2814
+ * @description A single secret entry specifying a key and a required nullable value.
2815
+ */
2816
+ SecretKeyValue: {
2817
+ /** Key */
2818
+ key: string;
2819
+ /**
2820
+ * Value
2821
+ * @description Provide a string to create or update the secret, or explicit null to delete it. This field is required; omitting it returns 422.
2822
+ */
2823
+ value: string | null;
2824
+ };
2748
2825
  /** SessionAnnotation */
2749
2826
  SessionAnnotation: {
2750
2827
  /** Id */
@@ -3400,6 +3477,24 @@ export interface components {
3400
3477
  */
3401
3478
  id: string;
3402
3479
  };
3480
+ /**
3481
+ * UpsertOrDeleteSecretsRequest
3482
+ * @description Request body for the PUT /secrets endpoint.
3483
+ */
3484
+ UpsertOrDeleteSecretsRequest: {
3485
+ /** Secrets */
3486
+ secrets: components["schemas"]["SecretKeyValue"][];
3487
+ };
3488
+ /**
3489
+ * UpsertOrDeleteSecretsResult
3490
+ * @description Result payload listing which keys were upserted and which were deleted.
3491
+ */
3492
+ UpsertOrDeleteSecretsResult: {
3493
+ /** Upserted Keys */
3494
+ upserted_keys: string[];
3495
+ /** Deleted Keys */
3496
+ deleted_keys: string[];
3497
+ };
3403
3498
  /** ValidationError */
3404
3499
  ValidationError: {
3405
3500
  /** Location */
@@ -5872,6 +5967,104 @@ export interface operations {
5872
5967
  };
5873
5968
  };
5874
5969
  };
5970
+ deletePromptVersionTag: {
5971
+ parameters: {
5972
+ query?: never;
5973
+ header?: never;
5974
+ path: {
5975
+ /** @description The ID of the prompt version. */
5976
+ prompt_version_id: string;
5977
+ /** @description The name of the tag to delete. */
5978
+ tag_name: string;
5979
+ };
5980
+ cookie?: never;
5981
+ };
5982
+ requestBody?: never;
5983
+ responses: {
5984
+ /** @description No content returned on successful tag deletion */
5985
+ 204: {
5986
+ headers: {
5987
+ [name: string]: unknown;
5988
+ };
5989
+ content?: never;
5990
+ };
5991
+ /** @description Forbidden */
5992
+ 403: {
5993
+ headers: {
5994
+ [name: string]: unknown;
5995
+ };
5996
+ content: {
5997
+ "text/plain": string;
5998
+ };
5999
+ };
6000
+ /** @description Not Found */
6001
+ 404: {
6002
+ headers: {
6003
+ [name: string]: unknown;
6004
+ };
6005
+ content: {
6006
+ "text/plain": string;
6007
+ };
6008
+ };
6009
+ /** @description Unprocessable Entity */
6010
+ 422: {
6011
+ headers: {
6012
+ [name: string]: unknown;
6013
+ };
6014
+ content: {
6015
+ "text/plain": string;
6016
+ };
6017
+ };
6018
+ };
6019
+ };
6020
+ deletePrompt: {
6021
+ parameters: {
6022
+ query?: never;
6023
+ header?: never;
6024
+ path: {
6025
+ /** @description The identifier of the prompt, i.e. name or ID. */
6026
+ prompt_identifier: string;
6027
+ };
6028
+ cookie?: never;
6029
+ };
6030
+ requestBody?: never;
6031
+ responses: {
6032
+ /** @description Successful Response */
6033
+ 204: {
6034
+ headers: {
6035
+ [name: string]: unknown;
6036
+ };
6037
+ content?: never;
6038
+ };
6039
+ /** @description Forbidden */
6040
+ 403: {
6041
+ headers: {
6042
+ [name: string]: unknown;
6043
+ };
6044
+ content: {
6045
+ "text/plain": string;
6046
+ };
6047
+ };
6048
+ /** @description Not Found */
6049
+ 404: {
6050
+ headers: {
6051
+ [name: string]: unknown;
6052
+ };
6053
+ content: {
6054
+ "text/plain": string;
6055
+ };
6056
+ };
6057
+ /** @description Unprocessable Entity */
6058
+ 422: {
6059
+ headers: {
6060
+ [name: string]: unknown;
6061
+ };
6062
+ content: {
6063
+ "text/plain": string;
6064
+ };
6065
+ };
6066
+ };
6067
+ };
5875
6068
  getProjects: {
5876
6069
  parameters: {
5877
6070
  query?: {
@@ -6605,4 +6798,55 @@ export interface operations {
6605
6798
  };
6606
6799
  };
6607
6800
  };
6801
+ upsertOrDeleteSecrets: {
6802
+ parameters: {
6803
+ query?: never;
6804
+ header?: never;
6805
+ path?: never;
6806
+ cookie?: never;
6807
+ };
6808
+ requestBody: {
6809
+ content: {
6810
+ "application/json": components["schemas"]["UpsertOrDeleteSecretsRequest"];
6811
+ };
6812
+ };
6813
+ responses: {
6814
+ /** @description Successful Response */
6815
+ 200: {
6816
+ headers: {
6817
+ [name: string]: unknown;
6818
+ };
6819
+ content: {
6820
+ "application/json": components["schemas"]["ResponseBody_UpsertOrDeleteSecretsResult_"];
6821
+ };
6822
+ };
6823
+ /** @description Forbidden */
6824
+ 403: {
6825
+ headers: {
6826
+ [name: string]: unknown;
6827
+ };
6828
+ content: {
6829
+ "text/plain": string;
6830
+ };
6831
+ };
6832
+ /** @description Unprocessable Entity */
6833
+ 422: {
6834
+ headers: {
6835
+ [name: string]: unknown;
6836
+ };
6837
+ content: {
6838
+ "text/plain": string;
6839
+ };
6840
+ };
6841
+ /** @description Insufficient Storage */
6842
+ 507: {
6843
+ headers: {
6844
+ [name: string]: unknown;
6845
+ };
6846
+ content: {
6847
+ "text/plain": string;
6848
+ };
6849
+ };
6850
+ };
6851
+ };
6608
6852
  }