opik 1.9.69 → 1.9.71
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.
- package/dist/index.cjs +18 -18
- package/dist/index.d.cts +94 -113
- package/dist/index.d.ts +94 -113
- package/dist/index.js +15 -15
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -184,6 +184,23 @@ declare const DatasetUpdateVisibility: {
|
|
|
184
184
|
readonly Public: "public";
|
|
185
185
|
};
|
|
186
186
|
|
|
187
|
+
/**
|
|
188
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
189
|
+
*/
|
|
190
|
+
|
|
191
|
+
/**
|
|
192
|
+
* @example
|
|
193
|
+
* {
|
|
194
|
+
* body: {
|
|
195
|
+
* "key": "value"
|
|
196
|
+
* }
|
|
197
|
+
* }
|
|
198
|
+
*/
|
|
199
|
+
interface ApplyDatasetItemChangesRequest {
|
|
200
|
+
override?: boolean;
|
|
201
|
+
body: DatasetItemChangesPublic;
|
|
202
|
+
}
|
|
203
|
+
|
|
187
204
|
/**
|
|
188
205
|
* This file was auto-generated by Fern from our API Definition.
|
|
189
206
|
*/
|
|
@@ -198,6 +215,8 @@ interface DatasetItemBatchUpdate {
|
|
|
198
215
|
/** List of dataset item IDs to update (max 1000). Mutually exclusive with 'filters'. */
|
|
199
216
|
ids?: string[];
|
|
200
217
|
filters?: DatasetItemFilter[];
|
|
218
|
+
/** Dataset ID. Required when using 'filters', optional when using 'ids'. */
|
|
219
|
+
datasetId?: string;
|
|
201
220
|
update: DatasetItemUpdate;
|
|
202
221
|
/** If true, merge tags with existing tags instead of replacing them. Default: false. When using 'filters', this is automatically set to true. */
|
|
203
222
|
mergeTags?: boolean;
|
|
@@ -488,22 +507,6 @@ interface ListDatasetVersionsRequest {
|
|
|
488
507
|
size?: number;
|
|
489
508
|
}
|
|
490
509
|
|
|
491
|
-
/**
|
|
492
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
493
|
-
*/
|
|
494
|
-
/**
|
|
495
|
-
* @example
|
|
496
|
-
* {}
|
|
497
|
-
*/
|
|
498
|
-
interface DatasetVersionCreatePublic {
|
|
499
|
-
/** Optional list of tags for this version */
|
|
500
|
-
tags?: string[];
|
|
501
|
-
/** Optional description of changes in this version */
|
|
502
|
-
changeDescription?: string;
|
|
503
|
-
/** Optional user-defined metadata */
|
|
504
|
-
metadata?: Record<string, string>;
|
|
505
|
-
}
|
|
506
|
-
|
|
507
510
|
/**
|
|
508
511
|
* This file was auto-generated by Fern from our API Definition.
|
|
509
512
|
*/
|
|
@@ -852,22 +855,6 @@ interface FindOptimizationsRequest {
|
|
|
852
855
|
filters?: string;
|
|
853
856
|
}
|
|
854
857
|
|
|
855
|
-
/**
|
|
856
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
857
|
-
*/
|
|
858
|
-
/**
|
|
859
|
-
* @example
|
|
860
|
-
* {}
|
|
861
|
-
*/
|
|
862
|
-
interface FindStudioOptimizationsRequest {
|
|
863
|
-
page?: number;
|
|
864
|
-
size?: number;
|
|
865
|
-
datasetId?: string;
|
|
866
|
-
name?: string;
|
|
867
|
-
datasetDeleted?: boolean;
|
|
868
|
-
filters?: string;
|
|
869
|
-
}
|
|
870
|
-
|
|
871
858
|
/**
|
|
872
859
|
* This file was auto-generated by Fern from our API Definition.
|
|
873
860
|
*/
|
|
@@ -3670,6 +3657,39 @@ interface DashboardPagePublic {
|
|
|
3670
3657
|
sortableBy?: string[];
|
|
3671
3658
|
}
|
|
3672
3659
|
|
|
3660
|
+
/**
|
|
3661
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3662
|
+
*/
|
|
3663
|
+
interface DatasetVersionPublic {
|
|
3664
|
+
id?: string;
|
|
3665
|
+
datasetId?: string;
|
|
3666
|
+
versionHash?: string;
|
|
3667
|
+
tags?: string[];
|
|
3668
|
+
/** Indicates whether this is the latest version of the dataset */
|
|
3669
|
+
isLatest?: boolean;
|
|
3670
|
+
/** Sequential version name formatted as 'v1', 'v2', etc. */
|
|
3671
|
+
versionName?: string;
|
|
3672
|
+
/** Total number of items in this version */
|
|
3673
|
+
itemsTotal?: number;
|
|
3674
|
+
/** Number of items added since last version */
|
|
3675
|
+
itemsAdded?: number;
|
|
3676
|
+
/** Number of items modified since last version */
|
|
3677
|
+
itemsModified?: number;
|
|
3678
|
+
/** Number of items deleted since last version */
|
|
3679
|
+
itemsDeleted?: number;
|
|
3680
|
+
changeDescription?: string;
|
|
3681
|
+
metadata?: Record<string, string>;
|
|
3682
|
+
createdAt?: Date;
|
|
3683
|
+
createdBy?: string;
|
|
3684
|
+
lastUpdatedAt?: Date;
|
|
3685
|
+
lastUpdatedBy?: string;
|
|
3686
|
+
}
|
|
3687
|
+
|
|
3688
|
+
/**
|
|
3689
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3690
|
+
*/
|
|
3691
|
+
type DatasetItemChangesPublic = Record<string, unknown>;
|
|
3692
|
+
|
|
3673
3693
|
/**
|
|
3674
3694
|
* This file was auto-generated by Fern from our API Definition.
|
|
3675
3695
|
*/
|
|
@@ -3968,7 +3988,6 @@ interface DatasetItemPageCompare {
|
|
|
3968
3988
|
total?: number;
|
|
3969
3989
|
columns?: ColumnCompare[];
|
|
3970
3990
|
sortableBy?: string[];
|
|
3971
|
-
hasDraft?: boolean;
|
|
3972
3991
|
}
|
|
3973
3992
|
|
|
3974
3993
|
/**
|
|
@@ -4113,6 +4132,8 @@ interface DatasetVersionSummaryPublic {
|
|
|
4113
4132
|
id?: string;
|
|
4114
4133
|
/** Hash of the version content */
|
|
4115
4134
|
versionHash?: string;
|
|
4135
|
+
/** Sequential version name formatted as 'v1', 'v2', etc. */
|
|
4136
|
+
versionName?: string;
|
|
4116
4137
|
/** Description of changes in this version */
|
|
4117
4138
|
changeDescription?: string;
|
|
4118
4139
|
/** Tags associated with this version */
|
|
@@ -4315,7 +4336,6 @@ interface DatasetItemPagePublic {
|
|
|
4315
4336
|
total?: number;
|
|
4316
4337
|
columns?: ColumnPublic[];
|
|
4317
4338
|
sortableBy?: string[];
|
|
4318
|
-
hasDraft?: boolean;
|
|
4319
4339
|
}
|
|
4320
4340
|
|
|
4321
4341
|
/**
|
|
@@ -4382,32 +4402,6 @@ interface DatasetVersionPagePublic {
|
|
|
4382
4402
|
total?: number;
|
|
4383
4403
|
}
|
|
4384
4404
|
|
|
4385
|
-
/**
|
|
4386
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
4387
|
-
*/
|
|
4388
|
-
interface DatasetVersionPublic {
|
|
4389
|
-
id?: string;
|
|
4390
|
-
datasetId?: string;
|
|
4391
|
-
versionHash?: string;
|
|
4392
|
-
tags?: string[];
|
|
4393
|
-
/** Indicates whether this is the latest version of the dataset */
|
|
4394
|
-
isLatest?: boolean;
|
|
4395
|
-
/** Total number of items in this version */
|
|
4396
|
-
itemsTotal?: number;
|
|
4397
|
-
/** Number of items added since last version */
|
|
4398
|
-
itemsAdded?: number;
|
|
4399
|
-
/** Number of items modified since last version */
|
|
4400
|
-
itemsModified?: number;
|
|
4401
|
-
/** Number of items deleted since last version */
|
|
4402
|
-
itemsDeleted?: number;
|
|
4403
|
-
changeDescription?: string;
|
|
4404
|
-
metadata?: Record<string, string>;
|
|
4405
|
-
createdAt?: Date;
|
|
4406
|
-
createdBy?: string;
|
|
4407
|
-
lastUpdatedAt?: Date;
|
|
4408
|
-
lastUpdatedBy?: string;
|
|
4409
|
-
}
|
|
4410
|
-
|
|
4411
4405
|
/**
|
|
4412
4406
|
* This file was auto-generated by Fern from our API Definition.
|
|
4413
4407
|
*/
|
|
@@ -4796,6 +4790,7 @@ interface ExperimentPublic {
|
|
|
4796
4790
|
id?: string;
|
|
4797
4791
|
datasetName: string;
|
|
4798
4792
|
datasetId?: string;
|
|
4793
|
+
projectId?: string;
|
|
4799
4794
|
name?: string;
|
|
4800
4795
|
metadata?: JsonListStringPublic;
|
|
4801
4796
|
type?: ExperimentPublicType;
|
|
@@ -7469,6 +7464,33 @@ declare namespace Datasets {
|
|
|
7469
7464
|
declare class Datasets {
|
|
7470
7465
|
protected readonly _options: Datasets.Options;
|
|
7471
7466
|
constructor(_options?: Datasets.Options);
|
|
7467
|
+
/**
|
|
7468
|
+
* Apply delta changes (add, edit, delete) to a dataset version with conflict detection.
|
|
7469
|
+
*
|
|
7470
|
+
* This endpoint:
|
|
7471
|
+
* - Creates a new version with the applied changes
|
|
7472
|
+
* - Validates that baseVersion matches the latest version (unless override=true)
|
|
7473
|
+
* - Returns 409 Conflict if baseVersion is stale and override is not set
|
|
7474
|
+
*
|
|
7475
|
+
* Use `override=true` query parameter to force version creation even with stale baseVersion.
|
|
7476
|
+
*
|
|
7477
|
+
* @param {string} id
|
|
7478
|
+
* @param {OpikApi.ApplyDatasetItemChangesRequest} request
|
|
7479
|
+
* @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
|
|
7480
|
+
*
|
|
7481
|
+
* @throws {@link OpikApi.BadRequestError}
|
|
7482
|
+
* @throws {@link OpikApi.NotFoundError}
|
|
7483
|
+
* @throws {@link OpikApi.ConflictError}
|
|
7484
|
+
*
|
|
7485
|
+
* @example
|
|
7486
|
+
* await client.datasets.applyDatasetItemChanges("id", {
|
|
7487
|
+
* body: {
|
|
7488
|
+
* "key": "value"
|
|
7489
|
+
* }
|
|
7490
|
+
* })
|
|
7491
|
+
*/
|
|
7492
|
+
applyDatasetItemChanges(id: string, request: ApplyDatasetItemChangesRequest, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<DatasetVersionPublic>;
|
|
7493
|
+
private __applyDatasetItemChanges;
|
|
7472
7494
|
/**
|
|
7473
7495
|
* Update multiple dataset items
|
|
7474
7496
|
*
|
|
@@ -7801,49 +7823,34 @@ declare class Datasets {
|
|
|
7801
7823
|
createVersionTag(versionHash: string, id: string, request: DatasetVersionTag, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<void>;
|
|
7802
7824
|
private __createVersionTag;
|
|
7803
7825
|
/**
|
|
7804
|
-
*
|
|
7826
|
+
* Remove a tag from a dataset version. The version itself is not deleted, only the tag reference.
|
|
7805
7827
|
*
|
|
7828
|
+
* @param {string} versionHash
|
|
7829
|
+
* @param {string} tag
|
|
7806
7830
|
* @param {string} id
|
|
7807
|
-
* @param {OpikApi.ListDatasetVersionsRequest} request
|
|
7808
7831
|
* @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
|
|
7809
7832
|
*
|
|
7810
|
-
* @throws {@link OpikApi.BadRequestError}
|
|
7811
|
-
*
|
|
7812
7833
|
* @example
|
|
7813
|
-
* await client.datasets.
|
|
7834
|
+
* await client.datasets.deleteVersionTag("versionHash", "tag", "id")
|
|
7814
7835
|
*/
|
|
7815
|
-
|
|
7816
|
-
private
|
|
7836
|
+
deleteVersionTag(versionHash: string, tag: string, id: string, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<void>;
|
|
7837
|
+
private __deleteVersionTag;
|
|
7817
7838
|
/**
|
|
7818
|
-
*
|
|
7839
|
+
* Get paginated list of versions for a dataset, ordered by creation time (newest first)
|
|
7819
7840
|
*
|
|
7820
7841
|
* @param {string} id
|
|
7821
|
-
* @param {OpikApi.
|
|
7842
|
+
* @param {OpikApi.ListDatasetVersionsRequest} request
|
|
7822
7843
|
* @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
|
|
7823
7844
|
*
|
|
7824
7845
|
* @throws {@link OpikApi.BadRequestError}
|
|
7825
|
-
* @throws {@link OpikApi.ConflictError}
|
|
7826
7846
|
*
|
|
7827
7847
|
* @example
|
|
7828
|
-
* await client.datasets.
|
|
7829
|
-
*/
|
|
7830
|
-
createDatasetVersion(id: string, request?: DatasetVersionCreatePublic, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<void>;
|
|
7831
|
-
private __createDatasetVersion;
|
|
7832
|
-
/**
|
|
7833
|
-
* Remove a tag from a dataset version. The version itself is not deleted, only the tag reference.
|
|
7834
|
-
*
|
|
7835
|
-
* @param {string} versionHash
|
|
7836
|
-
* @param {string} tag
|
|
7837
|
-
* @param {string} id
|
|
7838
|
-
* @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
|
|
7839
|
-
*
|
|
7840
|
-
* @example
|
|
7841
|
-
* await client.datasets.deleteVersionTag("versionHash", "tag", "id")
|
|
7848
|
+
* await client.datasets.listDatasetVersions("id")
|
|
7842
7849
|
*/
|
|
7843
|
-
|
|
7844
|
-
private
|
|
7850
|
+
listDatasetVersions(id: string, request?: ListDatasetVersionsRequest, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<DatasetVersionPagePublic>;
|
|
7851
|
+
private __listDatasetVersions;
|
|
7845
7852
|
/**
|
|
7846
|
-
* Restores the dataset to a previous version state
|
|
7853
|
+
* Restores the dataset to a previous version state by creating a new version with items copied from the specified version. If the version is already the latest, returns it as-is (no-op).
|
|
7847
7854
|
*
|
|
7848
7855
|
* @param {string} id
|
|
7849
7856
|
* @param {OpikApi.DatasetVersionRestorePublic} request
|
|
@@ -8651,19 +8658,6 @@ declare class Optimizations {
|
|
|
8651
8658
|
*/
|
|
8652
8659
|
deleteOptimizationsById(request: DeleteIdsHolder, requestOptions?: Optimizations.RequestOptions): HttpResponsePromise<void>;
|
|
8653
8660
|
private __deleteOptimizationsById;
|
|
8654
|
-
/**
|
|
8655
|
-
* Find Studio optimizations
|
|
8656
|
-
*
|
|
8657
|
-
* @param {OpikApi.FindStudioOptimizationsRequest} request
|
|
8658
|
-
* @param {Optimizations.RequestOptions} requestOptions - Request-specific configuration.
|
|
8659
|
-
*
|
|
8660
|
-
* @throws {@link OpikApi.BadRequestError}
|
|
8661
|
-
*
|
|
8662
|
-
* @example
|
|
8663
|
-
* await client.optimizations.findStudioOptimizations()
|
|
8664
|
-
*/
|
|
8665
|
-
findStudioOptimizations(request?: FindStudioOptimizationsRequest, requestOptions?: Optimizations.RequestOptions): HttpResponsePromise<OptimizationPagePublic>;
|
|
8666
|
-
private __findStudioOptimizations;
|
|
8667
8661
|
/**
|
|
8668
8662
|
* Get optimization by id
|
|
8669
8663
|
*
|
|
@@ -8689,19 +8683,6 @@ declare class Optimizations {
|
|
|
8689
8683
|
*/
|
|
8690
8684
|
updateOptimizationsById(id: string, request?: OptimizationUpdate, requestOptions?: Optimizations.RequestOptions): HttpResponsePromise<void>;
|
|
8691
8685
|
private __updateOptimizationsById;
|
|
8692
|
-
/**
|
|
8693
|
-
* Get Studio optimization with config included
|
|
8694
|
-
*
|
|
8695
|
-
* @param {string} id
|
|
8696
|
-
* @param {Optimizations.RequestOptions} requestOptions - Request-specific configuration.
|
|
8697
|
-
*
|
|
8698
|
-
* @throws {@link OpikApi.NotFoundError}
|
|
8699
|
-
*
|
|
8700
|
-
* @example
|
|
8701
|
-
* await client.optimizations.getStudioOptimizationById("id")
|
|
8702
|
-
*/
|
|
8703
|
-
getStudioOptimizationById(id: string, requestOptions?: Optimizations.RequestOptions): HttpResponsePromise<OptimizationPublic>;
|
|
8704
|
-
private __getStudioOptimizationById;
|
|
8705
8686
|
/**
|
|
8706
8687
|
* Get presigned S3 URL for downloading optimization logs
|
|
8707
8688
|
*
|
package/dist/index.d.ts
CHANGED
|
@@ -184,6 +184,23 @@ declare const DatasetUpdateVisibility: {
|
|
|
184
184
|
readonly Public: "public";
|
|
185
185
|
};
|
|
186
186
|
|
|
187
|
+
/**
|
|
188
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
189
|
+
*/
|
|
190
|
+
|
|
191
|
+
/**
|
|
192
|
+
* @example
|
|
193
|
+
* {
|
|
194
|
+
* body: {
|
|
195
|
+
* "key": "value"
|
|
196
|
+
* }
|
|
197
|
+
* }
|
|
198
|
+
*/
|
|
199
|
+
interface ApplyDatasetItemChangesRequest {
|
|
200
|
+
override?: boolean;
|
|
201
|
+
body: DatasetItemChangesPublic;
|
|
202
|
+
}
|
|
203
|
+
|
|
187
204
|
/**
|
|
188
205
|
* This file was auto-generated by Fern from our API Definition.
|
|
189
206
|
*/
|
|
@@ -198,6 +215,8 @@ interface DatasetItemBatchUpdate {
|
|
|
198
215
|
/** List of dataset item IDs to update (max 1000). Mutually exclusive with 'filters'. */
|
|
199
216
|
ids?: string[];
|
|
200
217
|
filters?: DatasetItemFilter[];
|
|
218
|
+
/** Dataset ID. Required when using 'filters', optional when using 'ids'. */
|
|
219
|
+
datasetId?: string;
|
|
201
220
|
update: DatasetItemUpdate;
|
|
202
221
|
/** If true, merge tags with existing tags instead of replacing them. Default: false. When using 'filters', this is automatically set to true. */
|
|
203
222
|
mergeTags?: boolean;
|
|
@@ -488,22 +507,6 @@ interface ListDatasetVersionsRequest {
|
|
|
488
507
|
size?: number;
|
|
489
508
|
}
|
|
490
509
|
|
|
491
|
-
/**
|
|
492
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
493
|
-
*/
|
|
494
|
-
/**
|
|
495
|
-
* @example
|
|
496
|
-
* {}
|
|
497
|
-
*/
|
|
498
|
-
interface DatasetVersionCreatePublic {
|
|
499
|
-
/** Optional list of tags for this version */
|
|
500
|
-
tags?: string[];
|
|
501
|
-
/** Optional description of changes in this version */
|
|
502
|
-
changeDescription?: string;
|
|
503
|
-
/** Optional user-defined metadata */
|
|
504
|
-
metadata?: Record<string, string>;
|
|
505
|
-
}
|
|
506
|
-
|
|
507
510
|
/**
|
|
508
511
|
* This file was auto-generated by Fern from our API Definition.
|
|
509
512
|
*/
|
|
@@ -852,22 +855,6 @@ interface FindOptimizationsRequest {
|
|
|
852
855
|
filters?: string;
|
|
853
856
|
}
|
|
854
857
|
|
|
855
|
-
/**
|
|
856
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
857
|
-
*/
|
|
858
|
-
/**
|
|
859
|
-
* @example
|
|
860
|
-
* {}
|
|
861
|
-
*/
|
|
862
|
-
interface FindStudioOptimizationsRequest {
|
|
863
|
-
page?: number;
|
|
864
|
-
size?: number;
|
|
865
|
-
datasetId?: string;
|
|
866
|
-
name?: string;
|
|
867
|
-
datasetDeleted?: boolean;
|
|
868
|
-
filters?: string;
|
|
869
|
-
}
|
|
870
|
-
|
|
871
858
|
/**
|
|
872
859
|
* This file was auto-generated by Fern from our API Definition.
|
|
873
860
|
*/
|
|
@@ -3670,6 +3657,39 @@ interface DashboardPagePublic {
|
|
|
3670
3657
|
sortableBy?: string[];
|
|
3671
3658
|
}
|
|
3672
3659
|
|
|
3660
|
+
/**
|
|
3661
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3662
|
+
*/
|
|
3663
|
+
interface DatasetVersionPublic {
|
|
3664
|
+
id?: string;
|
|
3665
|
+
datasetId?: string;
|
|
3666
|
+
versionHash?: string;
|
|
3667
|
+
tags?: string[];
|
|
3668
|
+
/** Indicates whether this is the latest version of the dataset */
|
|
3669
|
+
isLatest?: boolean;
|
|
3670
|
+
/** Sequential version name formatted as 'v1', 'v2', etc. */
|
|
3671
|
+
versionName?: string;
|
|
3672
|
+
/** Total number of items in this version */
|
|
3673
|
+
itemsTotal?: number;
|
|
3674
|
+
/** Number of items added since last version */
|
|
3675
|
+
itemsAdded?: number;
|
|
3676
|
+
/** Number of items modified since last version */
|
|
3677
|
+
itemsModified?: number;
|
|
3678
|
+
/** Number of items deleted since last version */
|
|
3679
|
+
itemsDeleted?: number;
|
|
3680
|
+
changeDescription?: string;
|
|
3681
|
+
metadata?: Record<string, string>;
|
|
3682
|
+
createdAt?: Date;
|
|
3683
|
+
createdBy?: string;
|
|
3684
|
+
lastUpdatedAt?: Date;
|
|
3685
|
+
lastUpdatedBy?: string;
|
|
3686
|
+
}
|
|
3687
|
+
|
|
3688
|
+
/**
|
|
3689
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3690
|
+
*/
|
|
3691
|
+
type DatasetItemChangesPublic = Record<string, unknown>;
|
|
3692
|
+
|
|
3673
3693
|
/**
|
|
3674
3694
|
* This file was auto-generated by Fern from our API Definition.
|
|
3675
3695
|
*/
|
|
@@ -3968,7 +3988,6 @@ interface DatasetItemPageCompare {
|
|
|
3968
3988
|
total?: number;
|
|
3969
3989
|
columns?: ColumnCompare[];
|
|
3970
3990
|
sortableBy?: string[];
|
|
3971
|
-
hasDraft?: boolean;
|
|
3972
3991
|
}
|
|
3973
3992
|
|
|
3974
3993
|
/**
|
|
@@ -4113,6 +4132,8 @@ interface DatasetVersionSummaryPublic {
|
|
|
4113
4132
|
id?: string;
|
|
4114
4133
|
/** Hash of the version content */
|
|
4115
4134
|
versionHash?: string;
|
|
4135
|
+
/** Sequential version name formatted as 'v1', 'v2', etc. */
|
|
4136
|
+
versionName?: string;
|
|
4116
4137
|
/** Description of changes in this version */
|
|
4117
4138
|
changeDescription?: string;
|
|
4118
4139
|
/** Tags associated with this version */
|
|
@@ -4315,7 +4336,6 @@ interface DatasetItemPagePublic {
|
|
|
4315
4336
|
total?: number;
|
|
4316
4337
|
columns?: ColumnPublic[];
|
|
4317
4338
|
sortableBy?: string[];
|
|
4318
|
-
hasDraft?: boolean;
|
|
4319
4339
|
}
|
|
4320
4340
|
|
|
4321
4341
|
/**
|
|
@@ -4382,32 +4402,6 @@ interface DatasetVersionPagePublic {
|
|
|
4382
4402
|
total?: number;
|
|
4383
4403
|
}
|
|
4384
4404
|
|
|
4385
|
-
/**
|
|
4386
|
-
* This file was auto-generated by Fern from our API Definition.
|
|
4387
|
-
*/
|
|
4388
|
-
interface DatasetVersionPublic {
|
|
4389
|
-
id?: string;
|
|
4390
|
-
datasetId?: string;
|
|
4391
|
-
versionHash?: string;
|
|
4392
|
-
tags?: string[];
|
|
4393
|
-
/** Indicates whether this is the latest version of the dataset */
|
|
4394
|
-
isLatest?: boolean;
|
|
4395
|
-
/** Total number of items in this version */
|
|
4396
|
-
itemsTotal?: number;
|
|
4397
|
-
/** Number of items added since last version */
|
|
4398
|
-
itemsAdded?: number;
|
|
4399
|
-
/** Number of items modified since last version */
|
|
4400
|
-
itemsModified?: number;
|
|
4401
|
-
/** Number of items deleted since last version */
|
|
4402
|
-
itemsDeleted?: number;
|
|
4403
|
-
changeDescription?: string;
|
|
4404
|
-
metadata?: Record<string, string>;
|
|
4405
|
-
createdAt?: Date;
|
|
4406
|
-
createdBy?: string;
|
|
4407
|
-
lastUpdatedAt?: Date;
|
|
4408
|
-
lastUpdatedBy?: string;
|
|
4409
|
-
}
|
|
4410
|
-
|
|
4411
4405
|
/**
|
|
4412
4406
|
* This file was auto-generated by Fern from our API Definition.
|
|
4413
4407
|
*/
|
|
@@ -4796,6 +4790,7 @@ interface ExperimentPublic {
|
|
|
4796
4790
|
id?: string;
|
|
4797
4791
|
datasetName: string;
|
|
4798
4792
|
datasetId?: string;
|
|
4793
|
+
projectId?: string;
|
|
4799
4794
|
name?: string;
|
|
4800
4795
|
metadata?: JsonListStringPublic;
|
|
4801
4796
|
type?: ExperimentPublicType;
|
|
@@ -7469,6 +7464,33 @@ declare namespace Datasets {
|
|
|
7469
7464
|
declare class Datasets {
|
|
7470
7465
|
protected readonly _options: Datasets.Options;
|
|
7471
7466
|
constructor(_options?: Datasets.Options);
|
|
7467
|
+
/**
|
|
7468
|
+
* Apply delta changes (add, edit, delete) to a dataset version with conflict detection.
|
|
7469
|
+
*
|
|
7470
|
+
* This endpoint:
|
|
7471
|
+
* - Creates a new version with the applied changes
|
|
7472
|
+
* - Validates that baseVersion matches the latest version (unless override=true)
|
|
7473
|
+
* - Returns 409 Conflict if baseVersion is stale and override is not set
|
|
7474
|
+
*
|
|
7475
|
+
* Use `override=true` query parameter to force version creation even with stale baseVersion.
|
|
7476
|
+
*
|
|
7477
|
+
* @param {string} id
|
|
7478
|
+
* @param {OpikApi.ApplyDatasetItemChangesRequest} request
|
|
7479
|
+
* @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
|
|
7480
|
+
*
|
|
7481
|
+
* @throws {@link OpikApi.BadRequestError}
|
|
7482
|
+
* @throws {@link OpikApi.NotFoundError}
|
|
7483
|
+
* @throws {@link OpikApi.ConflictError}
|
|
7484
|
+
*
|
|
7485
|
+
* @example
|
|
7486
|
+
* await client.datasets.applyDatasetItemChanges("id", {
|
|
7487
|
+
* body: {
|
|
7488
|
+
* "key": "value"
|
|
7489
|
+
* }
|
|
7490
|
+
* })
|
|
7491
|
+
*/
|
|
7492
|
+
applyDatasetItemChanges(id: string, request: ApplyDatasetItemChangesRequest, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<DatasetVersionPublic>;
|
|
7493
|
+
private __applyDatasetItemChanges;
|
|
7472
7494
|
/**
|
|
7473
7495
|
* Update multiple dataset items
|
|
7474
7496
|
*
|
|
@@ -7801,49 +7823,34 @@ declare class Datasets {
|
|
|
7801
7823
|
createVersionTag(versionHash: string, id: string, request: DatasetVersionTag, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<void>;
|
|
7802
7824
|
private __createVersionTag;
|
|
7803
7825
|
/**
|
|
7804
|
-
*
|
|
7826
|
+
* Remove a tag from a dataset version. The version itself is not deleted, only the tag reference.
|
|
7805
7827
|
*
|
|
7828
|
+
* @param {string} versionHash
|
|
7829
|
+
* @param {string} tag
|
|
7806
7830
|
* @param {string} id
|
|
7807
|
-
* @param {OpikApi.ListDatasetVersionsRequest} request
|
|
7808
7831
|
* @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
|
|
7809
7832
|
*
|
|
7810
|
-
* @throws {@link OpikApi.BadRequestError}
|
|
7811
|
-
*
|
|
7812
7833
|
* @example
|
|
7813
|
-
* await client.datasets.
|
|
7834
|
+
* await client.datasets.deleteVersionTag("versionHash", "tag", "id")
|
|
7814
7835
|
*/
|
|
7815
|
-
|
|
7816
|
-
private
|
|
7836
|
+
deleteVersionTag(versionHash: string, tag: string, id: string, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<void>;
|
|
7837
|
+
private __deleteVersionTag;
|
|
7817
7838
|
/**
|
|
7818
|
-
*
|
|
7839
|
+
* Get paginated list of versions for a dataset, ordered by creation time (newest first)
|
|
7819
7840
|
*
|
|
7820
7841
|
* @param {string} id
|
|
7821
|
-
* @param {OpikApi.
|
|
7842
|
+
* @param {OpikApi.ListDatasetVersionsRequest} request
|
|
7822
7843
|
* @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
|
|
7823
7844
|
*
|
|
7824
7845
|
* @throws {@link OpikApi.BadRequestError}
|
|
7825
|
-
* @throws {@link OpikApi.ConflictError}
|
|
7826
7846
|
*
|
|
7827
7847
|
* @example
|
|
7828
|
-
* await client.datasets.
|
|
7829
|
-
*/
|
|
7830
|
-
createDatasetVersion(id: string, request?: DatasetVersionCreatePublic, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<void>;
|
|
7831
|
-
private __createDatasetVersion;
|
|
7832
|
-
/**
|
|
7833
|
-
* Remove a tag from a dataset version. The version itself is not deleted, only the tag reference.
|
|
7834
|
-
*
|
|
7835
|
-
* @param {string} versionHash
|
|
7836
|
-
* @param {string} tag
|
|
7837
|
-
* @param {string} id
|
|
7838
|
-
* @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
|
|
7839
|
-
*
|
|
7840
|
-
* @example
|
|
7841
|
-
* await client.datasets.deleteVersionTag("versionHash", "tag", "id")
|
|
7848
|
+
* await client.datasets.listDatasetVersions("id")
|
|
7842
7849
|
*/
|
|
7843
|
-
|
|
7844
|
-
private
|
|
7850
|
+
listDatasetVersions(id: string, request?: ListDatasetVersionsRequest, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<DatasetVersionPagePublic>;
|
|
7851
|
+
private __listDatasetVersions;
|
|
7845
7852
|
/**
|
|
7846
|
-
* Restores the dataset to a previous version state
|
|
7853
|
+
* Restores the dataset to a previous version state by creating a new version with items copied from the specified version. If the version is already the latest, returns it as-is (no-op).
|
|
7847
7854
|
*
|
|
7848
7855
|
* @param {string} id
|
|
7849
7856
|
* @param {OpikApi.DatasetVersionRestorePublic} request
|
|
@@ -8651,19 +8658,6 @@ declare class Optimizations {
|
|
|
8651
8658
|
*/
|
|
8652
8659
|
deleteOptimizationsById(request: DeleteIdsHolder, requestOptions?: Optimizations.RequestOptions): HttpResponsePromise<void>;
|
|
8653
8660
|
private __deleteOptimizationsById;
|
|
8654
|
-
/**
|
|
8655
|
-
* Find Studio optimizations
|
|
8656
|
-
*
|
|
8657
|
-
* @param {OpikApi.FindStudioOptimizationsRequest} request
|
|
8658
|
-
* @param {Optimizations.RequestOptions} requestOptions - Request-specific configuration.
|
|
8659
|
-
*
|
|
8660
|
-
* @throws {@link OpikApi.BadRequestError}
|
|
8661
|
-
*
|
|
8662
|
-
* @example
|
|
8663
|
-
* await client.optimizations.findStudioOptimizations()
|
|
8664
|
-
*/
|
|
8665
|
-
findStudioOptimizations(request?: FindStudioOptimizationsRequest, requestOptions?: Optimizations.RequestOptions): HttpResponsePromise<OptimizationPagePublic>;
|
|
8666
|
-
private __findStudioOptimizations;
|
|
8667
8661
|
/**
|
|
8668
8662
|
* Get optimization by id
|
|
8669
8663
|
*
|
|
@@ -8689,19 +8683,6 @@ declare class Optimizations {
|
|
|
8689
8683
|
*/
|
|
8690
8684
|
updateOptimizationsById(id: string, request?: OptimizationUpdate, requestOptions?: Optimizations.RequestOptions): HttpResponsePromise<void>;
|
|
8691
8685
|
private __updateOptimizationsById;
|
|
8692
|
-
/**
|
|
8693
|
-
* Get Studio optimization with config included
|
|
8694
|
-
*
|
|
8695
|
-
* @param {string} id
|
|
8696
|
-
* @param {Optimizations.RequestOptions} requestOptions - Request-specific configuration.
|
|
8697
|
-
*
|
|
8698
|
-
* @throws {@link OpikApi.NotFoundError}
|
|
8699
|
-
*
|
|
8700
|
-
* @example
|
|
8701
|
-
* await client.optimizations.getStudioOptimizationById("id")
|
|
8702
|
-
*/
|
|
8703
|
-
getStudioOptimizationById(id: string, requestOptions?: Optimizations.RequestOptions): HttpResponsePromise<OptimizationPublic>;
|
|
8704
|
-
private __getStudioOptimizationById;
|
|
8705
8686
|
/**
|
|
8706
8687
|
* Get presigned S3 URL for downloading optimization logs
|
|
8707
8688
|
*
|