@arizeai/phoenix-client 2.3.5 → 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 (44) hide show
  1. package/dist/esm/datasets/getDataset.d.ts +5 -2
  2. package/dist/esm/datasets/getDataset.d.ts.map +1 -1
  3. package/dist/esm/datasets/getDataset.js +5 -3
  4. package/dist/esm/datasets/getDataset.js.map +1 -1
  5. package/dist/esm/datasets/getDatasetExamples.d.ts +5 -2
  6. package/dist/esm/datasets/getDatasetExamples.d.ts.map +1 -1
  7. package/dist/esm/datasets/getDatasetExamples.js +9 -2
  8. package/dist/esm/datasets/getDatasetExamples.js.map +1 -1
  9. package/dist/esm/datasets/getDatasetInfo.d.ts +1 -0
  10. package/dist/esm/datasets/getDatasetInfo.d.ts.map +1 -1
  11. package/dist/esm/datasets/getDatasetInfo.js +1 -0
  12. package/dist/esm/datasets/getDatasetInfo.js.map +1 -1
  13. package/dist/esm/datasets/index.d.ts +0 -1
  14. package/dist/esm/datasets/index.d.ts.map +1 -1
  15. package/dist/esm/datasets/index.js +0 -1
  16. package/dist/esm/datasets/index.js.map +1 -1
  17. package/dist/esm/tsconfig.esm.tsbuildinfo +1 -1
  18. package/dist/esm/types/datasets.d.ts +22 -2
  19. package/dist/esm/types/datasets.d.ts.map +1 -1
  20. package/dist/src/datasets/getDataset.d.ts +5 -2
  21. package/dist/src/datasets/getDataset.d.ts.map +1 -1
  22. package/dist/src/datasets/getDataset.js +5 -3
  23. package/dist/src/datasets/getDataset.js.map +1 -1
  24. package/dist/src/datasets/getDatasetExamples.d.ts +5 -2
  25. package/dist/src/datasets/getDatasetExamples.d.ts.map +1 -1
  26. package/dist/src/datasets/getDatasetExamples.js +9 -2
  27. package/dist/src/datasets/getDatasetExamples.js.map +1 -1
  28. package/dist/src/datasets/getDatasetInfo.d.ts +1 -0
  29. package/dist/src/datasets/getDatasetInfo.d.ts.map +1 -1
  30. package/dist/src/datasets/getDatasetInfo.js +1 -0
  31. package/dist/src/datasets/getDatasetInfo.js.map +1 -1
  32. package/dist/src/datasets/index.d.ts +0 -1
  33. package/dist/src/datasets/index.d.ts.map +1 -1
  34. package/dist/src/datasets/index.js +0 -1
  35. package/dist/src/datasets/index.js.map +1 -1
  36. package/dist/src/types/datasets.d.ts +22 -2
  37. package/dist/src/types/datasets.d.ts.map +1 -1
  38. package/dist/tsconfig.tsbuildinfo +1 -1
  39. package/package.json +1 -1
  40. package/src/datasets/getDataset.ts +6 -2
  41. package/src/datasets/getDatasetExamples.ts +14 -1
  42. package/src/datasets/getDatasetInfo.ts +2 -0
  43. package/src/datasets/index.ts +0 -1
  44. package/src/types/datasets.ts +25 -2
@@ -1,13 +1,19 @@
1
1
  import { Node } from "./core.js";
2
2
  /**
3
- * A dataset can be identified by its datasetId
4
- * TODO: add support for datasetVersionId via discriminated union
3
+ * A dataset can be identified by its datasetId, datasetName, or datasetVersionId
5
4
  */
6
5
  export type DatasetSelector = {
7
6
  datasetId: string;
8
7
  } | {
9
8
  datasetName: string;
10
9
  };
10
+ /**
11
+ * Parameters for selecting a specific version of a dataset
12
+ */
13
+ export interface DatasetVersionSelector {
14
+ dataset: DatasetSelector;
15
+ versionId?: string;
16
+ }
11
17
  /**
12
18
  * Overview information about a dataset
13
19
  */
@@ -16,6 +22,14 @@ export interface DatasetInfo extends Node {
16
22
  description?: string | null;
17
23
  metadata?: Record<string, unknown>;
18
24
  }
25
+ /**
26
+ * Information about a dataset version
27
+ */
28
+ export interface DatasetVersionInfo extends Node {
29
+ description?: string | null;
30
+ metadata?: Record<string, unknown>;
31
+ createdAt: Date;
32
+ }
19
33
  /**
20
34
  * A dataset's examples
21
35
  */
@@ -45,4 +59,10 @@ export interface ExampleWithId extends Example, Node {
45
59
  */
46
60
  export interface Dataset extends DatasetInfo, DatasetExamples, Node {
47
61
  }
62
+ /**
63
+ * A dataset with its version information
64
+ */
65
+ export interface DatasetWithVersion extends Dataset {
66
+ versionInfo: DatasetVersionInfo;
67
+ }
48
68
  //# sourceMappingURL=datasets.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"datasets.d.ts","sourceRoot":"","sources":["../../../src/types/datasets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC;AAE9E;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,IAAI;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACvC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,OAAO,EAAE,IAAI;IAClD,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,OAAQ,SAAQ,WAAW,EAAE,eAAe,EAAE,IAAI;CAAG"}
1
+ {"version":3,"file":"datasets.d.ts","sourceRoot":"","sources":["../../../src/types/datasets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC;AAE9E;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,eAAe,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,IAAI;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,IAAI;IAC9C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACvC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,OAAO,EAAE,IAAI;IAClD,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,OAAQ,SAAQ,WAAW,EAAE,eAAe,EAAE,IAAI;CAAG;AAEtE;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,OAAO;IACjD,WAAW,EAAE,kBAAkB,CAAC;CACjC"}
@@ -2,9 +2,12 @@ import { ClientFn } from "../types/core";
2
2
  import { DatasetSelector, Dataset } from "../types/datasets";
3
3
  export type GetDatasetParams = ClientFn & {
4
4
  dataset: DatasetSelector;
5
+ versionId?: string;
5
6
  };
6
7
  /**
7
- * Get dataset info and the examples from the latest version of the dataset
8
+ * Get dataset info and examples from the dataset
9
+ * @param dataset - Dataset selector (ID or name)
10
+ * @param versionId - Optional specific version ID (if omitted, returns data from the latest version)
8
11
  */
9
- export declare function getDataset({ client: _client, dataset, }: GetDatasetParams): Promise<Dataset>;
12
+ export declare function getDataset({ client: _client, dataset, versionId, }: GetDatasetParams): Promise<Dataset>;
10
13
  //# sourceMappingURL=getDataset.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"getDataset.d.ts","sourceRoot":"","sources":["../../../src/datasets/getDataset.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAI7D,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG;IACxC,OAAO,EAAE,eAAe,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,wBAAsB,UAAU,CAAC,EAC/B,MAAM,EAAE,OAAO,EACf,OAAO,GACR,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAUrC"}
1
+ {"version":3,"file":"getDataset.d.ts","sourceRoot":"","sources":["../../../src/datasets/getDataset.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAI7D,MAAM,MAAM,gBAAgB,GAAG,QAAQ,GAAG;IACxC,OAAO,EAAE,eAAe,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,wBAAsB,UAAU,CAAC,EAC/B,MAAM,EAAE,OAAO,EACf,OAAO,EACP,SAAS,GACV,EAAE,gBAAgB,GAAG,OAAO,CAAC,OAAO,CAAC,CAUrC"}
@@ -5,13 +5,15 @@ const client_1 = require("../client");
5
5
  const getDatasetExamples_1 = require("./getDatasetExamples");
6
6
  const getDatasetInfo_1 = require("./getDatasetInfo");
7
7
  /**
8
- * Get dataset info and the examples from the latest version of the dataset
8
+ * Get dataset info and examples from the dataset
9
+ * @param dataset - Dataset selector (ID or name)
10
+ * @param versionId - Optional specific version ID (if omitted, returns data from the latest version)
9
11
  */
10
- async function getDataset({ client: _client, dataset, }) {
12
+ async function getDataset({ client: _client, dataset, versionId, }) {
11
13
  const client = _client || (0, client_1.createClient)();
12
14
  const [datasetInfo, datasetExamples] = await Promise.all([
13
15
  (0, getDatasetInfo_1.getDatasetInfo)({ client, dataset }),
14
- (0, getDatasetExamples_1.getDatasetExamples)({ client, dataset }),
16
+ (0, getDatasetExamples_1.getDatasetExamples)({ client, dataset, versionId }),
15
17
  ]);
16
18
  return Object.assign(Object.assign({}, datasetInfo), datasetExamples);
17
19
  }
@@ -1 +1 @@
1
- {"version":3,"file":"getDataset.js","sourceRoot":"","sources":["../../../src/datasets/getDataset.ts"],"names":[],"mappings":";;AAaA,gCAaC;AA1BD,sCAAyC;AAGzC,6DAA0D;AAC1D,qDAAkD;AAMlD;;GAEG;AACI,KAAK,UAAU,UAAU,CAAC,EAC/B,MAAM,EAAE,OAAO,EACf,OAAO,GACU;IACjB,MAAM,MAAM,GAAG,OAAO,IAAI,IAAA,qBAAY,GAAE,CAAC;IACzC,MAAM,CAAC,WAAW,EAAE,eAAe,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACvD,IAAA,+BAAc,EAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;QACnC,IAAA,uCAAkB,EAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;KACxC,CAAC,CAAC;IACH,uCACK,WAAW,GACX,eAAe,EAClB;AACJ,CAAC"}
1
+ {"version":3,"file":"getDataset.js","sourceRoot":"","sources":["../../../src/datasets/getDataset.ts"],"names":[],"mappings":";;AAgBA,gCAcC;AA9BD,sCAAyC;AAGzC,6DAA0D;AAC1D,qDAAkD;AAOlD;;;;GAIG;AACI,KAAK,UAAU,UAAU,CAAC,EAC/B,MAAM,EAAE,OAAO,EACf,OAAO,EACP,SAAS,GACQ;IACjB,MAAM,MAAM,GAAG,OAAO,IAAI,IAAA,qBAAY,GAAE,CAAC;IACzC,MAAM,CAAC,WAAW,EAAE,eAAe,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QACvD,IAAA,+BAAc,EAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;QACnC,IAAA,uCAAkB,EAAC,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;KACnD,CAAC,CAAC;IACH,uCACK,WAAW,GACX,eAAe,EAClB;AACJ,CAAC"}
@@ -2,9 +2,12 @@ import { ClientFn } from "../types/core";
2
2
  import { DatasetSelector, DatasetExamples } from "../types/datasets";
3
3
  export type GetDatasetExamplesParams = ClientFn & {
4
4
  dataset: DatasetSelector;
5
+ versionId?: string;
5
6
  };
6
7
  /**
7
- * Get the latest examples from a dataset
8
+ * Get examples from a dataset
9
+ * @param dataset - Dataset selector (ID, name, or version ID)
10
+ * @param versionId - Optional specific version ID (ignored if dataset selector is datasetVersionId)
8
11
  */
9
- export declare function getDatasetExamples({ client: _client, dataset, }: GetDatasetExamplesParams): Promise<DatasetExamples>;
12
+ export declare function getDatasetExamples({ client: _client, dataset, versionId, }: GetDatasetExamplesParams): Promise<DatasetExamples>;
10
13
  //# sourceMappingURL=getDatasetExamples.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"getDatasetExamples.d.ts","sourceRoot":"","sources":["../../../src/datasets/getDatasetExamples.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAGrE,MAAM,MAAM,wBAAwB,GAAG,QAAQ,GAAG;IAChD,OAAO,EAAE,eAAe,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,MAAM,EAAE,OAAO,EACf,OAAO,GACR,EAAE,wBAAwB,GAAG,OAAO,CAAC,eAAe,CAAC,CA4BrD"}
1
+ {"version":3,"file":"getDatasetExamples.d.ts","sourceRoot":"","sources":["../../../src/datasets/getDatasetExamples.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAGrE,MAAM,MAAM,wBAAwB,GAAG,QAAQ,GAAG;IAChD,OAAO,EAAE,eAAe,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;GAIG;AACH,wBAAsB,kBAAkB,CAAC,EACvC,MAAM,EAAE,OAAO,EACf,OAAO,EACP,SAAS,GACV,EAAE,wBAAwB,GAAG,OAAO,CAAC,eAAe,CAAC,CAqCrD"}
@@ -8,9 +8,11 @@ const tiny_invariant_1 = __importDefault(require("tiny-invariant"));
8
8
  const client_1 = require("../client");
9
9
  const getDatasetInfoByName_1 = require("./getDatasetInfoByName");
10
10
  /**
11
- * Get the latest examples from a dataset
11
+ * Get examples from a dataset
12
+ * @param dataset - Dataset selector (ID, name, or version ID)
13
+ * @param versionId - Optional specific version ID (ignored if dataset selector is datasetVersionId)
12
14
  */
13
- async function getDatasetExamples({ client: _client, dataset, }) {
15
+ async function getDatasetExamples({ client: _client, dataset, versionId, }) {
14
16
  var _a;
15
17
  const client = _client || (0, client_1.createClient)();
16
18
  let datasetId;
@@ -29,6 +31,11 @@ async function getDatasetExamples({ client: _client, dataset, }) {
29
31
  path: {
30
32
  id: datasetId,
31
33
  },
34
+ query: versionId
35
+ ? {
36
+ version_id: versionId,
37
+ }
38
+ : undefined,
32
39
  },
33
40
  });
34
41
  (0, tiny_invariant_1.default)((_a = response.data) === null || _a === void 0 ? void 0 : _a.data, "Failed to get dataset examples");
@@ -1 +1 @@
1
- {"version":3,"file":"getDatasetExamples.js","sourceRoot":"","sources":["../../../src/datasets/getDatasetExamples.ts"],"names":[],"mappings":";;;;;AAaA,gDA+BC;AA5CD,oEAAuC;AACvC,sCAAyC;AAGzC,iEAA8D;AAM9D;;GAEG;AACI,KAAK,UAAU,kBAAkB,CAAC,EACvC,MAAM,EAAE,OAAO,EACf,OAAO,GACkB;;IACzB,MAAM,MAAM,GAAG,OAAO,IAAI,IAAA,qBAAY,GAAE,CAAC;IACzC,IAAI,SAAiB,CAAC;IACtB,IAAI,aAAa,IAAI,OAAO,EAAE,CAAC;QAC7B,MAAM,WAAW,GAAG,MAAM,IAAA,2CAAoB,EAAC;YAC7C,MAAM;YACN,WAAW,EAAE,OAAO,CAAC,WAAW;SACjC,CAAC,CAAC;QACH,SAAS,GAAG,WAAW,CAAC,EAAE,CAAC;IAC7B,CAAC;SAAM,CAAC;QACN,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IAChC,CAAC;IACD,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,4BAA4B,EAAE;QAC9D,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,EAAE,EAAE,SAAS;aACd;SACF;KACF,CAAC,CAAC;IACH,IAAA,wBAAS,EAAC,MAAA,QAAQ,CAAC,IAAI,0CAAE,IAAI,EAAE,gCAAgC,CAAC,CAAC;IACjE,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;IACxC,OAAO;QACL,SAAS,EAAE,YAAY,CAAC,UAAU;QAClC,QAAQ,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,iCAC5C,OAAO,KACV,SAAS,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IACvC,CAAC;KACJ,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"getDatasetExamples.js","sourceRoot":"","sources":["../../../src/datasets/getDatasetExamples.ts"],"names":[],"mappings":";;;;;AAgBA,gDAyCC;AAzDD,oEAAuC;AACvC,sCAAyC;AAGzC,iEAA8D;AAO9D;;;;GAIG;AACI,KAAK,UAAU,kBAAkB,CAAC,EACvC,MAAM,EAAE,OAAO,EACf,OAAO,EACP,SAAS,GACgB;;IACzB,MAAM,MAAM,GAAG,OAAO,IAAI,IAAA,qBAAY,GAAE,CAAC;IAEzC,IAAI,SAAiB,CAAC;IAEtB,IAAI,aAAa,IAAI,OAAO,EAAE,CAAC;QAC7B,MAAM,WAAW,GAAG,MAAM,IAAA,2CAAoB,EAAC;YAC7C,MAAM;YACN,WAAW,EAAE,OAAO,CAAC,WAAW;SACjC,CAAC,CAAC;QACH,SAAS,GAAG,WAAW,CAAC,EAAE,CAAC;IAC7B,CAAC;SAAM,CAAC;QACN,SAAS,GAAG,OAAO,CAAC,SAAS,CAAC;IAChC,CAAC;IAED,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,4BAA4B,EAAE;QAC9D,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,EAAE,EAAE,SAAS;aACd;YACD,KAAK,EAAE,SAAS;gBACd,CAAC,CAAC;oBACE,UAAU,EAAE,SAAS;iBACtB;gBACH,CAAC,CAAC,SAAS;SACd;KACF,CAAC,CAAC;IAEH,IAAA,wBAAS,EAAC,MAAA,QAAQ,CAAC,IAAI,0CAAE,IAAI,EAAE,gCAAgC,CAAC,CAAC;IACjE,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;IACxC,OAAO;QACL,SAAS,EAAE,YAAY,CAAC,UAAU;QAClC,QAAQ,EAAE,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,iCAC5C,OAAO,KACV,SAAS,EAAE,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IACvC,CAAC;KACJ,CAAC;AACJ,CAAC"}
@@ -6,6 +6,7 @@ export type GetDatasetInfoParams = ClientFn & {
6
6
  /**
7
7
  * Get an overview of the information in a dataset
8
8
  * Note: this does not include the examples contained in the dataset
9
+ * Dataset info is not version-specific, only examples are versioned
9
10
  */
10
11
  export declare function getDatasetInfo({ client: _client, dataset, }: GetDatasetInfoParams): Promise<DatasetInfo>;
11
12
  //# sourceMappingURL=getDatasetInfo.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"getDatasetInfo.d.ts","sourceRoot":"","sources":["../../../src/datasets/getDatasetInfo.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAGjE,MAAM,MAAM,oBAAoB,GAAG,QAAQ,GAAG;IAC5C,OAAO,EAAE,eAAe,CAAC;CAC1B,CAAC;AAEF;;;GAGG;AACH,wBAAsB,cAAc,CAAC,EACnC,MAAM,EAAE,OAAO,EACf,OAAO,GACR,EAAE,oBAAoB,GAAG,OAAO,CAAC,WAAW,CAAC,CAwB7C"}
1
+ {"version":3,"file":"getDatasetInfo.d.ts","sourceRoot":"","sources":["../../../src/datasets/getDatasetInfo.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAGjE,MAAM,MAAM,oBAAoB,GAAG,QAAQ,GAAG;IAC5C,OAAO,EAAE,eAAe,CAAC;CAC1B,CAAC;AAEF;;;;GAIG;AACH,wBAAsB,cAAc,CAAC,EACnC,MAAM,EAAE,OAAO,EACf,OAAO,GACR,EAAE,oBAAoB,GAAG,OAAO,CAAC,WAAW,CAAC,CAyB7C"}
@@ -10,6 +10,7 @@ const getDatasetInfoByName_1 = require("./getDatasetInfoByName");
10
10
  /**
11
11
  * Get an overview of the information in a dataset
12
12
  * Note: this does not include the examples contained in the dataset
13
+ * Dataset info is not version-specific, only examples are versioned
13
14
  */
14
15
  async function getDatasetInfo({ client: _client, dataset, }) {
15
16
  var _a;
@@ -1 +1 @@
1
- {"version":3,"file":"getDatasetInfo.js","sourceRoot":"","sources":["../../../src/datasets/getDatasetInfo.ts"],"names":[],"mappings":";;;;;AAcA,wCA2BC;AAzCD,oEAAuC;AACvC,sCAAyC;AAGzC,iEAA8D;AAM9D;;;GAGG;AACI,KAAK,UAAU,cAAc,CAAC,EACnC,MAAM,EAAE,OAAO,EACf,OAAO,GACc;;IACrB,MAAM,MAAM,GAAG,OAAO,IAAI,IAAA,qBAAY,GAAE,CAAC;IACzC,IAAI,aAAa,IAAI,OAAO,EAAE,CAAC;QAC7B,OAAO,MAAM,IAAA,2CAAoB,EAAC;YAChC,MAAM;YACN,WAAW,EAAE,OAAO,CAAC,WAAW;SACjC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,mBAAmB,EAAE;QAC5D,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,EAAE,EAAE,OAAO,CAAC,SAAS;aACtB;SACF;KACF,CAAC,CAAC;IACH,IAAA,wBAAS,EAAC,MAAA,eAAe,CAAC,IAAI,0CAAE,IAAI,EAAE,4BAA4B,CAAC,CAAC;IACpE,MAAM,WAAW,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC;IAC9C,OAAO;QACL,EAAE,EAAE,WAAW,CAAC,EAAE;QAClB,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,WAAW,EAAE,WAAW,CAAC,WAAW,IAAI,SAAS;QACjD,QAAQ,EAAE,WAAW,CAAC,QAAQ;KAC/B,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"getDatasetInfo.js","sourceRoot":"","sources":["../../../src/datasets/getDatasetInfo.ts"],"names":[],"mappings":";;;;;AAeA,wCA4BC;AA3CD,oEAAuC;AACvC,sCAAyC;AAGzC,iEAA8D;AAM9D;;;;GAIG;AACI,KAAK,UAAU,cAAc,CAAC,EACnC,MAAM,EAAE,OAAO,EACf,OAAO,GACc;;IACrB,MAAM,MAAM,GAAG,OAAO,IAAI,IAAA,qBAAY,GAAE,CAAC;IAEzC,IAAI,aAAa,IAAI,OAAO,EAAE,CAAC;QAC7B,OAAO,MAAM,IAAA,2CAAoB,EAAC;YAChC,MAAM;YACN,WAAW,EAAE,OAAO,CAAC,WAAW;SACjC,CAAC,CAAC;IACL,CAAC;IAED,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,mBAAmB,EAAE;QAC5D,MAAM,EAAE;YACN,IAAI,EAAE;gBACJ,EAAE,EAAE,OAAO,CAAC,SAAS;aACtB;SACF;KACF,CAAC,CAAC;IACH,IAAA,wBAAS,EAAC,MAAA,eAAe,CAAC,IAAI,0CAAE,IAAI,EAAE,4BAA4B,CAAC,CAAC;IACpE,MAAM,WAAW,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC;IAC9C,OAAO;QACL,EAAE,EAAE,WAAW,CAAC,EAAE;QAClB,IAAI,EAAE,WAAW,CAAC,IAAI;QACtB,WAAW,EAAE,WAAW,CAAC,WAAW,IAAI,SAAS;QACjD,QAAQ,EAAE,WAAW,CAAC,QAAQ;KAC/B,CAAC;AACJ,CAAC"}
@@ -2,6 +2,5 @@ export * from "./createDataset";
2
2
  export * from "./getDataset";
3
3
  export * from "./getDatasetExamples";
4
4
  export * from "./appendDatasetExamples";
5
- export * from "./getDatasetExamples";
6
5
  export * from "./getDatasetInfo";
7
6
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/datasets/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/datasets/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kBAAkB,CAAC"}
@@ -18,6 +18,5 @@ __exportStar(require("./createDataset"), exports);
18
18
  __exportStar(require("./getDataset"), exports);
19
19
  __exportStar(require("./getDatasetExamples"), exports);
20
20
  __exportStar(require("./appendDatasetExamples"), exports);
21
- __exportStar(require("./getDatasetExamples"), exports);
22
21
  __exportStar(require("./getDatasetInfo"), exports);
23
22
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/datasets/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,+CAA6B;AAC7B,uDAAqC;AACrC,0DAAwC;AACxC,uDAAqC;AACrC,mDAAiC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/datasets/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,+CAA6B;AAC7B,uDAAqC;AACrC,0DAAwC;AACxC,mDAAiC"}
@@ -1,13 +1,19 @@
1
1
  import { Node } from "./core";
2
2
  /**
3
- * A dataset can be identified by its datasetId
4
- * TODO: add support for datasetVersionId via discriminated union
3
+ * A dataset can be identified by its datasetId, datasetName, or datasetVersionId
5
4
  */
6
5
  export type DatasetSelector = {
7
6
  datasetId: string;
8
7
  } | {
9
8
  datasetName: string;
10
9
  };
10
+ /**
11
+ * Parameters for selecting a specific version of a dataset
12
+ */
13
+ export interface DatasetVersionSelector {
14
+ dataset: DatasetSelector;
15
+ versionId?: string;
16
+ }
11
17
  /**
12
18
  * Overview information about a dataset
13
19
  */
@@ -16,6 +22,14 @@ export interface DatasetInfo extends Node {
16
22
  description?: string | null;
17
23
  metadata?: Record<string, unknown>;
18
24
  }
25
+ /**
26
+ * Information about a dataset version
27
+ */
28
+ export interface DatasetVersionInfo extends Node {
29
+ description?: string | null;
30
+ metadata?: Record<string, unknown>;
31
+ createdAt: Date;
32
+ }
19
33
  /**
20
34
  * A dataset's examples
21
35
  */
@@ -45,4 +59,10 @@ export interface ExampleWithId extends Example, Node {
45
59
  */
46
60
  export interface Dataset extends DatasetInfo, DatasetExamples, Node {
47
61
  }
62
+ /**
63
+ * A dataset with its version information
64
+ */
65
+ export interface DatasetWithVersion extends Dataset {
66
+ versionInfo: DatasetVersionInfo;
67
+ }
48
68
  //# sourceMappingURL=datasets.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"datasets.d.ts","sourceRoot":"","sources":["../../../src/types/datasets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC;AAE9E;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,IAAI;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACvC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,OAAO,EAAE,IAAI;IAClD,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,OAAQ,SAAQ,WAAW,EAAE,eAAe,EAAE,IAAI;CAAG"}
1
+ {"version":3,"file":"datasets.d.ts","sourceRoot":"","sources":["../../../src/types/datasets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAAE,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC;AAE9E;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,eAAe,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,IAAI;IACvC,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,IAAI;IAC9C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IACvC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,aAAc,SAAQ,OAAO,EAAE,IAAI;IAClD,SAAS,EAAE,IAAI,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,OAAQ,SAAQ,WAAW,EAAE,eAAe,EAAE,IAAI;CAAG;AAEtE;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,OAAO;IACjD,WAAW,EAAE,kBAAkB,CAAC;CACjC"}