opik 1.9.31 → 1.9.32

package/dist/index.d.cts

@@ -458,6 +458,47 @@ interface DatasetItemStreamRequest {
     steamLimit?: number;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         tag: "tag"
+ *     }
+ */
+interface DatasetVersionTag {
+    tag: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+interface ListDatasetVersionsRequest {
+    page?: number;
+    size?: number;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+interface DatasetVersionCreatePublic {
+    /** Optional tag for this version */
+    tag?: string;
+    /** Optional description of changes in this version */
+    changeDescription?: string;
+    /** Optional user-defined metadata */
+    metadata?: Record<string, string>;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -3557,6 +3598,17 @@ declare const DatasetPublicVisibility: {
     readonly Public: "public";
 };
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type DatasetPublicStatus = "unknown" | "processing" | "completed" | "failed";
+declare const DatasetPublicStatus: {
+    readonly Unknown: "unknown";
+    readonly Processing: "processing";
+    readonly Completed: "completed";
+    readonly Failed: "failed";
+};
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -3578,6 +3630,7 @@ interface DatasetPublic {
     lastCreatedExperimentAt?: Date;
     mostRecentOptimizationAt?: Date;
     lastCreatedOptimizationAt?: Date;
+    status?: DatasetPublicStatus;
 }
 
 /**
@@ -3765,6 +3818,41 @@ interface PageColumns {
     columns?: Column[];
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface DatasetVersionPagePublic {
+    content?: DatasetVersionPublic[];
+    page?: number;
+    size?: number;
+    total?: number;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface DatasetVersionPublic {
+    id?: string;
+    datasetId?: string;
+    versionHash?: string;
+    tags?: string[];
+    /** Total number of items in this version */
+    itemsTotal?: number;
+    /** Number of items added since last version */
+    itemsAdded?: number;
+    /** Number of items modified since last version */
+    itemsModified?: number;
+    /** Number of items deleted since last version */
+    itemsDeleted?: number;
+    changeDescription?: string;
+    metadata?: Record<string, string>;
+    createdAt?: Date;
+    createdBy?: string;
+    lastUpdatedAt?: Date;
+    lastUpdatedBy?: string;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -6928,6 +7016,67 @@ declare class Datasets {
      */
     streamDatasetItems(request: DatasetItemStreamRequest, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<stream.Readable>;
     private __streamDatasetItems;
+    /**
+     * Add a tag to a specific dataset version for easy reference (e.g., 'baseline', 'v1.0', 'production')
+     *
+     * @param {string} versionHash
+     * @param {string} id
+     * @param {OpikApi.DatasetVersionTag} request
+     * @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     * @throws {@link OpikApi.NotFoundError}
+     * @throws {@link OpikApi.ConflictError}
+     *
+     * @example
+     *     await client.datasets.createVersionTag("versionHash", "id", {
+     *         tag: "tag"
+     *     })
+     */
+    createVersionTag(versionHash: string, id: string, request: DatasetVersionTag, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<void>;
+    private __createVersionTag;
+    /**
+     * Get paginated list of versions for a dataset, ordered by creation time (newest first)
+     *
+     * @param {string} id
+     * @param {OpikApi.ListDatasetVersionsRequest} request
+     * @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     *
+     * @example
+     *     await client.datasets.listDatasetVersions("id")
+     */
+    listDatasetVersions(id: string, request?: ListDatasetVersionsRequest, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<DatasetVersionPagePublic>;
+    private __listDatasetVersions;
+    /**
+     * Create a new immutable version of the dataset by snapshotting the current state
+     *
+     * @param {string} id
+     * @param {OpikApi.DatasetVersionCreatePublic} request
+     * @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     * @throws {@link OpikApi.ConflictError}
+     *
+     * @example
+     *     await client.datasets.createDatasetVersion("id")
+     */
+    createDatasetVersion(id: string, request?: DatasetVersionCreatePublic, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<void>;
+    private __createDatasetVersion;
+    /**
+     * Remove a tag from a dataset version. The version itself is not deleted, only the tag reference.
+     *
+     * @param {string} versionHash
+     * @param {string} tag
+     * @param {string} id
+     * @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.datasets.deleteVersionTag("versionHash", "tag", "id")
+     */
+    deleteVersionTag(versionHash: string, tag: string, id: string, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<void>;
+    private __deleteVersionTag;
     protected _getCustomAuthorizationHeaders(): Promise<{
         Authorization: string | undefined;
     }>;

package/dist/index.d.ts

@@ -458,6 +458,47 @@ interface DatasetItemStreamRequest {
     steamLimit?: number;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         tag: "tag"
+ *     }
+ */
+interface DatasetVersionTag {
+    tag: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+interface ListDatasetVersionsRequest {
+    page?: number;
+    size?: number;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+interface DatasetVersionCreatePublic {
+    /** Optional tag for this version */
+    tag?: string;
+    /** Optional description of changes in this version */
+    changeDescription?: string;
+    /** Optional user-defined metadata */
+    metadata?: Record<string, string>;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -3557,6 +3598,17 @@ declare const DatasetPublicVisibility: {
     readonly Public: "public";
 };
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type DatasetPublicStatus = "unknown" | "processing" | "completed" | "failed";
+declare const DatasetPublicStatus: {
+    readonly Unknown: "unknown";
+    readonly Processing: "processing";
+    readonly Completed: "completed";
+    readonly Failed: "failed";
+};
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -3578,6 +3630,7 @@ interface DatasetPublic {
     lastCreatedExperimentAt?: Date;
     mostRecentOptimizationAt?: Date;
     lastCreatedOptimizationAt?: Date;
+    status?: DatasetPublicStatus;
 }
 
 /**
@@ -3765,6 +3818,41 @@ interface PageColumns {
     columns?: Column[];
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface DatasetVersionPagePublic {
+    content?: DatasetVersionPublic[];
+    page?: number;
+    size?: number;
+    total?: number;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface DatasetVersionPublic {
+    id?: string;
+    datasetId?: string;
+    versionHash?: string;
+    tags?: string[];
+    /** Total number of items in this version */
+    itemsTotal?: number;
+    /** Number of items added since last version */
+    itemsAdded?: number;
+    /** Number of items modified since last version */
+    itemsModified?: number;
+    /** Number of items deleted since last version */
+    itemsDeleted?: number;
+    changeDescription?: string;
+    metadata?: Record<string, string>;
+    createdAt?: Date;
+    createdBy?: string;
+    lastUpdatedAt?: Date;
+    lastUpdatedBy?: string;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -6928,6 +7016,67 @@ declare class Datasets {
      */
     streamDatasetItems(request: DatasetItemStreamRequest, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<stream.Readable>;
     private __streamDatasetItems;
+    /**
+     * Add a tag to a specific dataset version for easy reference (e.g., 'baseline', 'v1.0', 'production')
+     *
+     * @param {string} versionHash
+     * @param {string} id
+     * @param {OpikApi.DatasetVersionTag} request
+     * @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     * @throws {@link OpikApi.NotFoundError}
+     * @throws {@link OpikApi.ConflictError}
+     *
+     * @example
+     *     await client.datasets.createVersionTag("versionHash", "id", {
+     *         tag: "tag"
+     *     })
+     */
+    createVersionTag(versionHash: string, id: string, request: DatasetVersionTag, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<void>;
+    private __createVersionTag;
+    /**
+     * Get paginated list of versions for a dataset, ordered by creation time (newest first)
+     *
+     * @param {string} id
+     * @param {OpikApi.ListDatasetVersionsRequest} request
+     * @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     *
+     * @example
+     *     await client.datasets.listDatasetVersions("id")
+     */
+    listDatasetVersions(id: string, request?: ListDatasetVersionsRequest, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<DatasetVersionPagePublic>;
+    private __listDatasetVersions;
+    /**
+     * Create a new immutable version of the dataset by snapshotting the current state
+     *
+     * @param {string} id
+     * @param {OpikApi.DatasetVersionCreatePublic} request
+     * @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     * @throws {@link OpikApi.ConflictError}
+     *
+     * @example
+     *     await client.datasets.createDatasetVersion("id")
+     */
+    createDatasetVersion(id: string, request?: DatasetVersionCreatePublic, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<void>;
+    private __createDatasetVersion;
+    /**
+     * Remove a tag from a dataset version. The version itself is not deleted, only the tag reference.
+     *
+     * @param {string} versionHash
+     * @param {string} tag
+     * @param {string} id
+     * @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.datasets.deleteVersionTag("versionHash", "tag", "id")
+     */
+    deleteVersionTag(versionHash: string, tag: string, id: string, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<void>;
+    private __deleteVersionTag;
     protected _getCustomAuthorizationHeaders(): Promise<{
         Authorization: string | undefined;
     }>;