@arizeai/phoenix-client 6.8.0 → 6.9.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 (170) hide show
  1. package/README.md +77 -0
  2. package/dist/esm/__generated__/api/v1.d.ts +313 -19
  3. package/dist/esm/__generated__/api/v1.d.ts.map +1 -1
  4. package/dist/esm/constants/serverRequirements.d.ts +2 -0
  5. package/dist/esm/constants/serverRequirements.d.ts.map +1 -1
  6. package/dist/esm/constants/serverRequirements.js +15 -0
  7. package/dist/esm/constants/serverRequirements.js.map +1 -1
  8. package/dist/esm/datasets/appendDatasetExamples.d.ts +9 -3
  9. package/dist/esm/datasets/appendDatasetExamples.d.ts.map +1 -1
  10. package/dist/esm/datasets/appendDatasetExamples.js +23 -3
  11. package/dist/esm/datasets/appendDatasetExamples.js.map +1 -1
  12. package/dist/esm/datasets/createDataset.d.ts +4 -1
  13. package/dist/esm/datasets/createDataset.d.ts.map +1 -1
  14. package/dist/esm/datasets/createDataset.js +38 -3
  15. package/dist/esm/datasets/createDataset.js.map +1 -1
  16. package/dist/esm/datasets/getDatasetExamples.d.ts.map +1 -1
  17. package/dist/esm/datasets/getDatasetExamples.js +3 -2
  18. package/dist/esm/datasets/getDatasetExamples.js.map +1 -1
  19. package/dist/esm/datasets/index.d.ts +0 -1
  20. package/dist/esm/datasets/index.d.ts.map +1 -1
  21. package/dist/esm/datasets/index.js +0 -1
  22. package/dist/esm/datasets/index.js.map +1 -1
  23. package/dist/esm/experiments/resumeEvaluation.d.ts.map +1 -1
  24. package/dist/esm/experiments/resumeEvaluation.js +2 -1
  25. package/dist/esm/experiments/resumeEvaluation.js.map +1 -1
  26. package/dist/esm/experiments/resumeExperiment.d.ts.map +1 -1
  27. package/dist/esm/experiments/resumeExperiment.js +3 -2
  28. package/dist/esm/experiments/resumeExperiment.js.map +1 -1
  29. package/dist/esm/experiments/runExperiment.js +1 -1
  30. package/dist/esm/experiments/runExperiment.js.map +1 -1
  31. package/dist/esm/sessions/addSessionNote.d.ts +45 -0
  32. package/dist/esm/sessions/addSessionNote.d.ts.map +1 -0
  33. package/dist/esm/sessions/addSessionNote.js +45 -0
  34. package/dist/esm/sessions/addSessionNote.js.map +1 -0
  35. package/dist/esm/sessions/index.d.ts +1 -0
  36. package/dist/esm/sessions/index.d.ts.map +1 -1
  37. package/dist/esm/sessions/index.js +1 -0
  38. package/dist/esm/sessions/index.js.map +1 -1
  39. package/dist/esm/spans/addSpanNote.d.ts +5 -3
  40. package/dist/esm/spans/addSpanNote.d.ts.map +1 -1
  41. package/dist/esm/spans/addSpanNote.js +7 -4
  42. package/dist/esm/spans/addSpanNote.js.map +1 -1
  43. package/dist/esm/traces/addTraceAnnotation.d.ts +43 -0
  44. package/dist/esm/traces/addTraceAnnotation.d.ts.map +1 -0
  45. package/dist/esm/traces/addTraceAnnotation.js +43 -0
  46. package/dist/esm/traces/addTraceAnnotation.js.map +1 -0
  47. package/dist/esm/traces/addTraceNote.d.ts +5 -2
  48. package/dist/esm/traces/addTraceNote.d.ts.map +1 -1
  49. package/dist/esm/traces/addTraceNote.js +7 -3
  50. package/dist/esm/traces/addTraceNote.js.map +1 -1
  51. package/dist/esm/traces/index.d.ts +3 -0
  52. package/dist/esm/traces/index.d.ts.map +1 -1
  53. package/dist/esm/traces/index.js +2 -0
  54. package/dist/esm/traces/index.js.map +1 -1
  55. package/dist/esm/traces/logTraceAnnotations.d.ts +53 -0
  56. package/dist/esm/traces/logTraceAnnotations.d.ts.map +1 -0
  57. package/dist/esm/traces/logTraceAnnotations.js +50 -0
  58. package/dist/esm/traces/logTraceAnnotations.js.map +1 -0
  59. package/dist/esm/traces/types.d.ts +24 -0
  60. package/dist/esm/traces/types.d.ts.map +1 -0
  61. package/dist/esm/traces/types.js +38 -0
  62. package/dist/esm/traces/types.js.map +1 -0
  63. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  64. package/dist/esm/types/datasets.d.ts +10 -1
  65. package/dist/esm/types/datasets.d.ts.map +1 -1
  66. package/dist/esm/utils/apiErrorUtils.d.ts +2 -0
  67. package/dist/esm/utils/apiErrorUtils.d.ts.map +1 -0
  68. package/dist/esm/utils/apiErrorUtils.js +19 -0
  69. package/dist/esm/utils/apiErrorUtils.js.map +1 -0
  70. package/dist/esm/utils/formatPromptMessages.d.ts.map +1 -1
  71. package/dist/esm/utils/getPromptBySelector.d.ts.map +1 -1
  72. package/dist/src/__generated__/api/v1.d.ts +313 -19
  73. package/dist/src/__generated__/api/v1.d.ts.map +1 -1
  74. package/dist/src/constants/serverRequirements.d.ts +2 -0
  75. package/dist/src/constants/serverRequirements.d.ts.map +1 -1
  76. package/dist/src/constants/serverRequirements.js +16 -1
  77. package/dist/src/constants/serverRequirements.js.map +1 -1
  78. package/dist/src/datasets/appendDatasetExamples.d.ts +9 -3
  79. package/dist/src/datasets/appendDatasetExamples.d.ts.map +1 -1
  80. package/dist/src/datasets/appendDatasetExamples.js +24 -5
  81. package/dist/src/datasets/appendDatasetExamples.js.map +1 -1
  82. package/dist/src/datasets/createDataset.d.ts +4 -1
  83. package/dist/src/datasets/createDataset.d.ts.map +1 -1
  84. package/dist/src/datasets/createDataset.js +42 -5
  85. package/dist/src/datasets/createDataset.js.map +1 -1
  86. package/dist/src/datasets/getDatasetExamples.d.ts.map +1 -1
  87. package/dist/src/datasets/getDatasetExamples.js +15 -1
  88. package/dist/src/datasets/getDatasetExamples.js.map +1 -1
  89. package/dist/src/datasets/index.d.ts +0 -1
  90. package/dist/src/datasets/index.d.ts.map +1 -1
  91. package/dist/src/datasets/index.js +0 -1
  92. package/dist/src/datasets/index.js.map +1 -1
  93. package/dist/src/experiments/resumeEvaluation.d.ts.map +1 -1
  94. package/dist/src/experiments/resumeEvaluation.js +2 -1
  95. package/dist/src/experiments/resumeEvaluation.js.map +1 -1
  96. package/dist/src/experiments/resumeExperiment.d.ts.map +1 -1
  97. package/dist/src/experiments/resumeExperiment.js +3 -2
  98. package/dist/src/experiments/resumeExperiment.js.map +1 -1
  99. package/dist/src/experiments/runExperiment.js +1 -1
  100. package/dist/src/experiments/runExperiment.js.map +1 -1
  101. package/dist/src/sessions/addSessionNote.d.ts +45 -0
  102. package/dist/src/sessions/addSessionNote.d.ts.map +1 -0
  103. package/dist/src/sessions/addSessionNote.js +48 -0
  104. package/dist/src/sessions/addSessionNote.js.map +1 -0
  105. package/dist/src/sessions/index.d.ts +1 -0
  106. package/dist/src/sessions/index.d.ts.map +1 -1
  107. package/dist/src/sessions/index.js +1 -0
  108. package/dist/src/sessions/index.js.map +1 -1
  109. package/dist/src/spans/addSpanNote.d.ts +5 -3
  110. package/dist/src/spans/addSpanNote.d.ts.map +1 -1
  111. package/dist/src/spans/addSpanNote.js +7 -4
  112. package/dist/src/spans/addSpanNote.js.map +1 -1
  113. package/dist/src/traces/addTraceAnnotation.d.ts +43 -0
  114. package/dist/src/traces/addTraceAnnotation.d.ts.map +1 -0
  115. package/dist/src/traces/addTraceAnnotation.js +47 -0
  116. package/dist/src/traces/addTraceAnnotation.js.map +1 -0
  117. package/dist/src/traces/addTraceNote.d.ts +5 -2
  118. package/dist/src/traces/addTraceNote.d.ts.map +1 -1
  119. package/dist/src/traces/addTraceNote.js +7 -3
  120. package/dist/src/traces/addTraceNote.js.map +1 -1
  121. package/dist/src/traces/index.d.ts +3 -0
  122. package/dist/src/traces/index.d.ts.map +1 -1
  123. package/dist/src/traces/index.js +2 -0
  124. package/dist/src/traces/index.js.map +1 -1
  125. package/dist/src/traces/logTraceAnnotations.d.ts +53 -0
  126. package/dist/src/traces/logTraceAnnotations.d.ts.map +1 -0
  127. package/dist/src/traces/logTraceAnnotations.js +53 -0
  128. package/dist/src/traces/logTraceAnnotations.js.map +1 -0
  129. package/dist/src/traces/types.d.ts +24 -0
  130. package/dist/src/traces/types.d.ts.map +1 -0
  131. package/dist/src/traces/types.js +42 -0
  132. package/dist/src/traces/types.js.map +1 -0
  133. package/dist/src/types/datasets.d.ts +10 -1
  134. package/dist/src/types/datasets.d.ts.map +1 -1
  135. package/dist/src/utils/apiErrorUtils.d.ts +2 -0
  136. package/dist/src/utils/apiErrorUtils.d.ts.map +1 -0
  137. package/dist/src/utils/apiErrorUtils.js +22 -0
  138. package/dist/src/utils/apiErrorUtils.js.map +1 -0
  139. package/dist/src/utils/formatPromptMessages.d.ts.map +1 -1
  140. package/dist/src/utils/getPromptBySelector.d.ts.map +1 -1
  141. package/dist/tsconfig.tsbuildinfo +1 -1
  142. package/package.json +3 -3
  143. package/src/__generated__/api/v1.ts +313 -19
  144. package/src/constants/serverRequirements.ts +17 -0
  145. package/src/datasets/appendDatasetExamples.ts +26 -5
  146. package/src/datasets/createDataset.ts +66 -18
  147. package/src/datasets/getDatasetExamples.ts +7 -4
  148. package/src/datasets/index.ts +0 -1
  149. package/src/experiments/resumeEvaluation.ts +2 -1
  150. package/src/experiments/resumeExperiment.ts +3 -2
  151. package/src/experiments/runExperiment.ts +1 -1
  152. package/src/sessions/addSessionNote.ts +74 -0
  153. package/src/sessions/index.ts +1 -0
  154. package/src/spans/addSpanNote.ts +7 -4
  155. package/src/traces/addTraceAnnotation.ts +65 -0
  156. package/src/traces/addTraceNote.ts +7 -3
  157. package/src/traces/index.ts +3 -0
  158. package/src/traces/logTraceAnnotations.ts +75 -0
  159. package/src/traces/types.ts +72 -0
  160. package/src/types/datasets.ts +10 -1
  161. package/src/utils/apiErrorUtils.ts +17 -0
  162. package/dist/esm/datasets/createOrGetDataset.d.ts +0 -18
  163. package/dist/esm/datasets/createOrGetDataset.d.ts.map +0 -1
  164. package/dist/esm/datasets/createOrGetDataset.js +0 -29
  165. package/dist/esm/datasets/createOrGetDataset.js.map +0 -1
  166. package/dist/src/datasets/createOrGetDataset.d.ts +0 -18
  167. package/dist/src/datasets/createOrGetDataset.d.ts.map +0 -1
  168. package/dist/src/datasets/createOrGetDataset.js +0 -32
  169. package/dist/src/datasets/createOrGetDataset.js.map +0 -1
  170. package/src/datasets/createOrGetDataset.ts +0 -40
@@ -1,18 +0,0 @@
1
- import type { CreateDatasetParams } from "./createDataset.js";
2
- export type CreateOrGetDatasetParams = CreateDatasetParams;
3
- export type CreateOrGetDatasetResponse = {
4
- datasetId: string;
5
- };
6
- /**
7
- * Given the parameters to create a dataset, this function will either
8
- * retrieve an existing dataset by name or create a new one with the provided parameters.
9
- *
10
- * This is useful in cases where you would like to re-run a pipeline like:
11
- * - ensure dataset exists
12
- * - create a task
13
- * - run experiment
14
- * - evaluate experiment
15
- * without having to create a new dataset each time.
16
- */
17
- export declare function createOrGetDataset({ name, description, examples, client: _client, }: CreateOrGetDatasetParams): Promise<CreateOrGetDatasetResponse>;
18
- //# sourceMappingURL=createOrGetDataset.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"createOrGetDataset.d.ts","sourceRoot":"","sources":["../../../src/datasets/createOrGetDataset.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAI3D,MAAM,MAAM,wBAAwB,GAAG,mBAAmB,CAAC;AAE3D,MAAM,MAAM,0BAA0B,GAAG;IACvC,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,IAAI,EACJ,WAAW,EACX,QAAQ,EACR,MAAM,EAAE,OAAO,GAChB,EAAE,wBAAwB,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAYhE"}
@@ -1,29 +0,0 @@
1
- import { createClient } from "../client.js";
2
- import { createDataset } from "./createDataset.js";
3
- import { getDatasetInfoByName } from "./getDatasetInfoByName.js";
4
- /**
5
- * Given the parameters to create a dataset, this function will either
6
- * retrieve an existing dataset by name or create a new one with the provided parameters.
7
- *
8
- * This is useful in cases where you would like to re-run a pipeline like:
9
- * - ensure dataset exists
10
- * - create a task
11
- * - run experiment
12
- * - evaluate experiment
13
- * without having to create a new dataset each time.
14
- */
15
- export async function createOrGetDataset({ name, description, examples, client: _client, }) {
16
- const client = _client || createClient();
17
- // start by fetching an existing dataset by name, catching any errors that occur
18
- try {
19
- const dataset = await getDatasetInfoByName({ datasetName: name, client });
20
- return {
21
- datasetId: dataset.id,
22
- };
23
- }
24
- catch {
25
- // If the dataset doesn't exist, create it, falling back to the error handling inside createDataset
26
- return await createDataset({ name, description, examples, client });
27
- }
28
- }
29
- //# sourceMappingURL=createOrGetDataset.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"createOrGetDataset.js","sourceRoot":"","sources":["../../../src/datasets/createOrGetDataset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAQ9D;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,kBAAkB,CAAC,EACvC,IAAI,EACJ,WAAW,EACX,QAAQ,EACR,MAAM,EAAE,OAAO,GACU;IACzB,MAAM,MAAM,GAAG,OAAO,IAAI,YAAY,EAAE,CAAC;IACzC,gFAAgF;IAChF,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,oBAAoB,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QAC1E,OAAO;YACL,SAAS,EAAE,OAAO,CAAC,EAAE;SACtB,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACP,mGAAmG;QACnG,OAAO,MAAM,aAAa,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;IACtE,CAAC;AACH,CAAC"}
@@ -1,18 +0,0 @@
1
- import type { CreateDatasetParams } from "./createDataset";
2
- export type CreateOrGetDatasetParams = CreateDatasetParams;
3
- export type CreateOrGetDatasetResponse = {
4
- datasetId: string;
5
- };
6
- /**
7
- * Given the parameters to create a dataset, this function will either
8
- * retrieve an existing dataset by name or create a new one with the provided parameters.
9
- *
10
- * This is useful in cases where you would like to re-run a pipeline like:
11
- * - ensure dataset exists
12
- * - create a task
13
- * - run experiment
14
- * - evaluate experiment
15
- * without having to create a new dataset each time.
16
- */
17
- export declare function createOrGetDataset({ name, description, examples, client: _client, }: CreateOrGetDatasetParams): Promise<CreateOrGetDatasetResponse>;
18
- //# sourceMappingURL=createOrGetDataset.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"createOrGetDataset.d.ts","sourceRoot":"","sources":["../../../src/datasets/createOrGetDataset.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAI3D,MAAM,MAAM,wBAAwB,GAAG,mBAAmB,CAAC;AAE3D,MAAM,MAAM,0BAA0B,GAAG;IACvC,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,IAAI,EACJ,WAAW,EACX,QAAQ,EACR,MAAM,EAAE,OAAO,GAChB,EAAE,wBAAwB,GAAG,OAAO,CAAC,0BAA0B,CAAC,CAYhE"}
@@ -1,32 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.createOrGetDataset = createOrGetDataset;
4
- const client_1 = require("../client");
5
- const createDataset_1 = require("./createDataset");
6
- const getDatasetInfoByName_1 = require("./getDatasetInfoByName");
7
- /**
8
- * Given the parameters to create a dataset, this function will either
9
- * retrieve an existing dataset by name or create a new one with the provided parameters.
10
- *
11
- * This is useful in cases where you would like to re-run a pipeline like:
12
- * - ensure dataset exists
13
- * - create a task
14
- * - run experiment
15
- * - evaluate experiment
16
- * without having to create a new dataset each time.
17
- */
18
- async function createOrGetDataset({ name, description, examples, client: _client, }) {
19
- const client = _client || (0, client_1.createClient)();
20
- // start by fetching an existing dataset by name, catching any errors that occur
21
- try {
22
- const dataset = await (0, getDatasetInfoByName_1.getDatasetInfoByName)({ datasetName: name, client });
23
- return {
24
- datasetId: dataset.id,
25
- };
26
- }
27
- catch (_a) {
28
- // If the dataset doesn't exist, create it, falling back to the error handling inside createDataset
29
- return await (0, createDataset_1.createDataset)({ name, description, examples, client });
30
- }
31
- }
32
- //# sourceMappingURL=createOrGetDataset.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"createOrGetDataset.js","sourceRoot":"","sources":["../../../src/datasets/createOrGetDataset.ts"],"names":[],"mappings":";;AAsBA,gDAiBC;AAvCD,sCAAyC;AAEzC,mDAAgD;AAChD,iEAA8D;AAQ9D;;;;;;;;;;GAUG;AACI,KAAK,UAAU,kBAAkB,CAAC,EACvC,IAAI,EACJ,WAAW,EACX,QAAQ,EACR,MAAM,EAAE,OAAO,GACU;IACzB,MAAM,MAAM,GAAG,OAAO,IAAI,IAAA,qBAAY,GAAE,CAAC;IACzC,gFAAgF;IAChF,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,IAAA,2CAAoB,EAAC,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QAC1E,OAAO;YACL,SAAS,EAAE,OAAO,CAAC,EAAE;SACtB,CAAC;IACJ,CAAC;IAAC,WAAM,CAAC;QACP,mGAAmG;QACnG,OAAO,MAAM,IAAA,6BAAa,EAAC,EAAE,IAAI,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;IACtE,CAAC;AACH,CAAC"}
@@ -1,40 +0,0 @@
1
- import { createClient } from "../client";
2
- import type { CreateDatasetParams } from "./createDataset";
3
- import { createDataset } from "./createDataset";
4
- import { getDatasetInfoByName } from "./getDatasetInfoByName";
5
-
6
- export type CreateOrGetDatasetParams = CreateDatasetParams;
7
-
8
- export type CreateOrGetDatasetResponse = {
9
- datasetId: string;
10
- };
11
-
12
- /**
13
- * Given the parameters to create a dataset, this function will either
14
- * retrieve an existing dataset by name or create a new one with the provided parameters.
15
- *
16
- * This is useful in cases where you would like to re-run a pipeline like:
17
- * - ensure dataset exists
18
- * - create a task
19
- * - run experiment
20
- * - evaluate experiment
21
- * without having to create a new dataset each time.
22
- */
23
- export async function createOrGetDataset({
24
- name,
25
- description,
26
- examples,
27
- client: _client,
28
- }: CreateOrGetDatasetParams): Promise<CreateOrGetDatasetResponse> {
29
- const client = _client || createClient();
30
- // start by fetching an existing dataset by name, catching any errors that occur
31
- try {
32
- const dataset = await getDatasetInfoByName({ datasetName: name, client });
33
- return {
34
- datasetId: dataset.id,
35
- };
36
- } catch {
37
- // If the dataset doesn't exist, create it, falling back to the error handling inside createDataset
38
- return await createDataset({ name, description, examples, client });
39
- }
40
- }