@arizeai/phoenix-client 2.3.4 → 2.4.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 (124) hide show
  1. package/dist/esm/client.d.ts +3 -4
  2. package/dist/esm/client.d.ts.map +1 -1
  3. package/dist/esm/datasets/getDataset.d.ts +5 -2
  4. package/dist/esm/datasets/getDataset.d.ts.map +1 -1
  5. package/dist/esm/datasets/getDataset.js +5 -3
  6. package/dist/esm/datasets/getDataset.js.map +1 -1
  7. package/dist/esm/datasets/getDatasetExamples.d.ts +5 -2
  8. package/dist/esm/datasets/getDatasetExamples.d.ts.map +1 -1
  9. package/dist/esm/datasets/getDatasetExamples.js +9 -2
  10. package/dist/esm/datasets/getDatasetExamples.js.map +1 -1
  11. package/dist/esm/datasets/getDatasetInfo.d.ts +1 -0
  12. package/dist/esm/datasets/getDatasetInfo.d.ts.map +1 -1
  13. package/dist/esm/datasets/getDatasetInfo.js +1 -0
  14. package/dist/esm/datasets/getDatasetInfo.js.map +1 -1
  15. package/dist/esm/datasets/index.d.ts +0 -1
  16. package/dist/esm/datasets/index.d.ts.map +1 -1
  17. package/dist/esm/datasets/index.js +0 -1
  18. package/dist/esm/datasets/index.js.map +1 -1
  19. package/dist/esm/datasets/listDatasets.d.ts +1 -2
  20. package/dist/esm/datasets/listDatasets.d.ts.map +1 -1
  21. package/dist/esm/experiments/runExperiment.d.ts +4 -2
  22. package/dist/esm/experiments/runExperiment.d.ts.map +1 -1
  23. package/dist/esm/experiments/runExperiment.js +4 -2
  24. package/dist/esm/experiments/runExperiment.js.map +1 -1
  25. package/dist/esm/prompts/createPrompt.d.ts +9 -9
  26. package/dist/esm/prompts/createPrompt.d.ts.map +1 -1
  27. package/dist/esm/prompts/sdks/toSDK.d.ts +2 -3
  28. package/dist/esm/prompts/sdks/toSDK.d.ts.map +1 -1
  29. package/dist/esm/prompts/sdks/toSDK.js +1 -1
  30. package/dist/esm/prompts/sdks/toSDK.js.map +1 -1
  31. package/dist/esm/schemas/jsonLiteralSchema.d.ts +2 -3
  32. package/dist/esm/schemas/jsonLiteralSchema.d.ts.map +1 -1
  33. package/dist/esm/schemas/jsonLiteralSchema.js +6 -1
  34. package/dist/esm/schemas/jsonLiteralSchema.js.map +1 -1
  35. package/dist/esm/schemas/llm/converters.d.ts +9 -7
  36. package/dist/esm/schemas/llm/converters.d.ts.map +1 -1
  37. package/dist/esm/schemas/llm/converters.js +9 -7
  38. package/dist/esm/schemas/llm/converters.js.map +1 -1
  39. package/dist/esm/spans/addSpanAnnotation.d.ts +1 -2
  40. package/dist/esm/spans/addSpanAnnotation.d.ts.map +1 -1
  41. package/dist/esm/spans/getSpanAnnotations.d.ts +2 -3
  42. package/dist/esm/spans/getSpanAnnotations.d.ts.map +1 -1
  43. package/dist/esm/spans/getSpans.d.ts +2 -3
  44. package/dist/esm/spans/getSpans.d.ts.map +1 -1
  45. package/dist/esm/spans/logSpanAnnotations.d.ts +1 -2
  46. package/dist/esm/spans/logSpanAnnotations.d.ts.map +1 -1
  47. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  48. package/dist/esm/types/datasets.d.ts +22 -2
  49. package/dist/esm/types/datasets.d.ts.map +1 -1
  50. package/dist/esm/utils/urlUtils.d.ts +10 -7
  51. package/dist/esm/utils/urlUtils.d.ts.map +1 -1
  52. package/dist/esm/utils/urlUtils.js +10 -7
  53. package/dist/esm/utils/urlUtils.js.map +1 -1
  54. package/dist/src/client.d.ts +3 -4
  55. package/dist/src/client.d.ts.map +1 -1
  56. package/dist/src/datasets/getDataset.d.ts +5 -2
  57. package/dist/src/datasets/getDataset.d.ts.map +1 -1
  58. package/dist/src/datasets/getDataset.js +5 -3
  59. package/dist/src/datasets/getDataset.js.map +1 -1
  60. package/dist/src/datasets/getDatasetExamples.d.ts +5 -2
  61. package/dist/src/datasets/getDatasetExamples.d.ts.map +1 -1
  62. package/dist/src/datasets/getDatasetExamples.js +9 -2
  63. package/dist/src/datasets/getDatasetExamples.js.map +1 -1
  64. package/dist/src/datasets/getDatasetInfo.d.ts +1 -0
  65. package/dist/src/datasets/getDatasetInfo.d.ts.map +1 -1
  66. package/dist/src/datasets/getDatasetInfo.js +1 -0
  67. package/dist/src/datasets/getDatasetInfo.js.map +1 -1
  68. package/dist/src/datasets/index.d.ts +0 -1
  69. package/dist/src/datasets/index.d.ts.map +1 -1
  70. package/dist/src/datasets/index.js +0 -1
  71. package/dist/src/datasets/index.js.map +1 -1
  72. package/dist/src/datasets/listDatasets.d.ts +1 -2
  73. package/dist/src/datasets/listDatasets.d.ts.map +1 -1
  74. package/dist/src/experiments/runExperiment.d.ts +4 -2
  75. package/dist/src/experiments/runExperiment.d.ts.map +1 -1
  76. package/dist/src/experiments/runExperiment.js +4 -2
  77. package/dist/src/experiments/runExperiment.js.map +1 -1
  78. package/dist/src/prompts/createPrompt.d.ts +9 -9
  79. package/dist/src/prompts/createPrompt.d.ts.map +1 -1
  80. package/dist/src/prompts/sdks/toSDK.d.ts +2 -3
  81. package/dist/src/prompts/sdks/toSDK.d.ts.map +1 -1
  82. package/dist/src/prompts/sdks/toSDK.js +5 -5
  83. package/dist/src/prompts/sdks/toSDK.js.map +1 -1
  84. package/dist/src/schemas/jsonLiteralSchema.d.ts +2 -3
  85. package/dist/src/schemas/jsonLiteralSchema.d.ts.map +1 -1
  86. package/dist/src/schemas/jsonLiteralSchema.js +8 -3
  87. package/dist/src/schemas/jsonLiteralSchema.js.map +1 -1
  88. package/dist/src/schemas/llm/converters.d.ts +9 -7
  89. package/dist/src/schemas/llm/converters.d.ts.map +1 -1
  90. package/dist/src/schemas/llm/converters.js +9 -7
  91. package/dist/src/schemas/llm/converters.js.map +1 -1
  92. package/dist/src/spans/addSpanAnnotation.d.ts +1 -2
  93. package/dist/src/spans/addSpanAnnotation.d.ts.map +1 -1
  94. package/dist/src/spans/getSpanAnnotations.d.ts +2 -3
  95. package/dist/src/spans/getSpanAnnotations.d.ts.map +1 -1
  96. package/dist/src/spans/getSpans.d.ts +2 -3
  97. package/dist/src/spans/getSpans.d.ts.map +1 -1
  98. package/dist/src/spans/logSpanAnnotations.d.ts +1 -2
  99. package/dist/src/spans/logSpanAnnotations.d.ts.map +1 -1
  100. package/dist/src/types/datasets.d.ts +22 -2
  101. package/dist/src/types/datasets.d.ts.map +1 -1
  102. package/dist/src/utils/urlUtils.d.ts +10 -7
  103. package/dist/src/utils/urlUtils.d.ts.map +1 -1
  104. package/dist/src/utils/urlUtils.js +10 -7
  105. package/dist/src/utils/urlUtils.js.map +1 -1
  106. package/dist/tsconfig.tsbuildinfo +1 -1
  107. package/package.json +13 -7
  108. package/src/client.ts +3 -3
  109. package/src/datasets/getDataset.ts +6 -2
  110. package/src/datasets/getDatasetExamples.ts +14 -1
  111. package/src/datasets/getDatasetInfo.ts +2 -0
  112. package/src/datasets/index.ts +0 -1
  113. package/src/datasets/listDatasets.ts +1 -1
  114. package/src/experiments/runExperiment.ts +4 -2
  115. package/src/prompts/createPrompt.ts +9 -9
  116. package/src/prompts/sdks/toSDK.ts +5 -2
  117. package/src/schemas/jsonLiteralSchema.ts +7 -2
  118. package/src/schemas/llm/converters.ts +9 -7
  119. package/src/spans/addSpanAnnotation.ts +1 -1
  120. package/src/spans/getSpanAnnotations.ts +2 -2
  121. package/src/spans/getSpans.ts +2 -2
  122. package/src/spans/logSpanAnnotations.ts +1 -1
  123. package/src/types/datasets.ts +25 -2
  124. package/src/utils/urlUtils.ts +10 -7
package/dist/src/utils/urlUtils.js CHANGED
@@ -16,9 +16,10 @@ function getWebBaseUrl(baseUrl) {
16
16
  }
17
17
  /**
18
18
  * Get the URL to view a specific experiment in the Phoenix web UI
19
- * @param baseUrl The base URL of the Phoenix API
20
- * @param datasetId The ID of the dataset
21
- * @param experimentId The ID of the experiment
19
+ * @param params - The parameters for generating the experiment URL
20
+ * @param params.baseUrl - The base URL of the Phoenix API
21
+ * @param params.datasetId - The ID of the dataset
22
+ * @param params.experimentId - The ID of the experiment
22
23
  * @returns The URL to view the experiment
23
24
  */
24
25
  function getExperimentUrl({ baseUrl, datasetId, experimentId, }) {
@@ -26,8 +27,9 @@ function getExperimentUrl({ baseUrl, datasetId, experimentId, }) {
26
27
  }
27
28
  /**
28
29
  * Get the URL to view experiments for a dataset in the Phoenix web UI
29
- * @param baseUrl The base URL of the Phoenix API
30
- * @param datasetId The ID of the dataset
30
+ * @param params - The parameters for generating the dataset experiments URL
31
+ * @param params.baseUrl - The base URL of the Phoenix API
32
+ * @param params.datasetId - The ID of the dataset
31
33
  * @returns The URL to view dataset experiments
32
34
  */
33
35
  function getDatasetExperimentsUrl({ baseUrl, datasetId, }) {
@@ -35,8 +37,9 @@ function getDatasetExperimentsUrl({ baseUrl, datasetId, }) {
35
37
  }
36
38
  /**
37
39
  * Get the URL to view a dataset in the Phoenix web UI
38
- * @param baseUrl The base URL of the Phoenix API
39
- * @param datasetId The ID of the dataset
40
+ * @param params - The parameters for generating the dataset URL
41
+ * @param params.baseUrl - The base URL of the Phoenix API
42
+ * @param params.datasetId - The ID of the dataset
40
43
  * @returns The URL to view the dataset
41
44
  */
42
45
  function getDatasetUrl({ baseUrl, datasetId, }) {
package/dist/src/utils/urlUtils.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"urlUtils.js","sourceRoot":"","sources":["../../../src/utils/urlUtils.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAkBH,4CAUC;AAQD,4DAQC;AAQD,sCAQC;AA1DD;;;;GAIG;AACH,SAAS,aAAa,CAAC,OAAe;IACpC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;AACrC,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,gBAAgB,CAAC,EAC/B,OAAO,EACP,SAAS,EACT,YAAY,GAKb;IACC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,YAAY,SAAS,yBAAyB,YAAY,EAAE,CAAC;AAC/F,CAAC;AAED;;;;;GAKG;AACH,SAAgB,wBAAwB,CAAC,EACvC,OAAO,EACP,SAAS,GAIV;IACC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,YAAY,SAAS,cAAc,CAAC;AACtE,CAAC;AAED;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,EAC5B,OAAO,EACP,SAAS,GAIV;IACC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,YAAY,SAAS,WAAW,CAAC;AACnE,CAAC"}
1
+ {"version":3,"file":"urlUtils.js","sourceRoot":"","sources":["../../../src/utils/urlUtils.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAmBH,4CAUC;AASD,4DAQC;AASD,sCAQC;AA7DD;;;;GAIG;AACH,SAAS,aAAa,CAAC,OAAe;IACpC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;AACrC,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,gBAAgB,CAAC,EAC/B,OAAO,EACP,SAAS,EACT,YAAY,GAKb;IACC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,YAAY,SAAS,yBAAyB,YAAY,EAAE,CAAC;AAC/F,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,wBAAwB,CAAC,EACvC,OAAO,EACP,SAAS,GAIV;IACC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,YAAY,SAAS,cAAc,CAAC;AACtE,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,aAAa,CAAC,EAC5B,OAAO,EACP,SAAS,GAIV;IACC,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC,YAAY,SAAS,WAAW,CAAC;AACnE,CAAC"}