opik 1.9.37 → 1.9.39

package/dist/index.d.cts

@@ -500,6 +500,20 @@ interface DatasetVersionCreatePublic {
     metadata?: Record<string, string>;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         versionRef: "version_ref"
+ *     }
+ */
+interface DatasetVersionRestorePublic {
+    /** Version hash or tag to restore from */
+    versionRef: string;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1000,6 +1014,30 @@ declare const PromptWriteType: {
     readonly Jinja2: "jinja2";
 };
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Template structure type: 'text' or 'chat'. Immutable after creation.
+ */
+type PromptWriteTemplateStructure = "text" | "chat";
+declare const PromptWriteTemplateStructure: {
+    readonly Text: "text";
+    readonly Chat: "chat";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Template structure for the prompt: 'text' or 'chat'. Note: This field is only used when creating a new prompt. If a prompt with the given name already exists, this field is ignored and the existing prompt's template structure is used. Template structure is immutable after prompt creation.
+ */
+type CreatePromptVersionDetailTemplateStructure = "text" | "chat";
+declare const CreatePromptVersionDetailTemplateStructure: {
+    readonly Text: "text";
+    readonly Chat: "chat";
+};
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1033,6 +1071,8 @@ interface PromptWrite {
     metadata?: JsonNodeWrite;
     changeDescription?: string;
     type?: PromptWriteType;
+    /** Template structure type: 'text' or 'chat'. Immutable after creation. */
+    templateStructure?: PromptWriteTemplateStructure;
     tags?: string[];
 }
 
@@ -1052,6 +1092,8 @@ interface PromptWrite {
 interface CreatePromptVersionDetail {
     name: string;
     version: PromptVersionDetail;
+    /** Template structure for the prompt: 'text' or 'chat'. Note: This field is only used when creating a new prompt. If a prompt with the given name already exists, this field is ignored and the existing prompt's template structure is used. Template structure is immutable after prompt creation. */
+    templateStructure?: CreatePromptVersionDetailTemplateStructure;
 }
 
 /**
@@ -1415,6 +1457,7 @@ interface FindDashboardsRequest {
     page?: number;
     size?: number;
     name?: string;
+    sorting?: string;
 }
 
 /**
@@ -3447,6 +3490,7 @@ interface DashboardPagePublic {
     page?: number;
     size?: number;
     total?: number;
+    sortableBy?: string[];
 }
 
 /**
@@ -3744,6 +3788,7 @@ interface DatasetItemPageCompare {
     total?: number;
     columns?: ColumnCompare[];
     sortableBy?: string[];
+    hasDraft?: boolean;
 }
 
 /**
@@ -4072,6 +4117,7 @@ interface DatasetItemPagePublic {
     total?: number;
     columns?: ColumnPublic[];
     sortableBy?: string[];
+    hasDraft?: boolean;
 }
 
 /**
@@ -5452,6 +5498,15 @@ declare const PromptVersionDetailType: {
     readonly Jinja2: "jinja2";
 };
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type PromptVersionDetailTemplateStructure = "text" | "chat";
+declare const PromptVersionDetailTemplateStructure: {
+    readonly Text: "text";
+    readonly Chat: "chat";
+};
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -5467,10 +5522,23 @@ interface PromptVersionDetail {
     type?: PromptVersionDetailType;
     changeDescription?: string;
     variables?: string[];
+    templateStructure?: PromptVersionDetailTemplateStructure;
     createdAt?: Date;
     createdBy?: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Template structure type: 'text' or 'chat'. Immutable after creation.
+ */
+type PromptDetailTemplateStructure = "text" | "chat";
+declare const PromptDetailTemplateStructure: {
+    readonly Text: "text";
+    readonly Chat: "chat";
+};
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -5479,6 +5547,8 @@ interface PromptDetail {
     id?: string;
     name: string;
     description?: string;
+    /** Template structure type: 'text' or 'chat'. Immutable after creation. */
+    templateStructure?: PromptDetailTemplateStructure;
     tags?: string[];
     createdAt?: Date;
     createdBy?: string;
@@ -5508,6 +5578,15 @@ declare const PromptVersionPublicType: {
     readonly Jinja2: "jinja2";
 };
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type PromptVersionPublicTemplateStructure = "text" | "chat";
+declare const PromptVersionPublicTemplateStructure: {
+    readonly Text: "text";
+    readonly Chat: "chat";
+};
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -5522,6 +5601,7 @@ interface PromptVersionPublic {
     metadata?: JsonNodePublic;
     type?: PromptVersionPublicType;
     changeDescription?: string;
+    templateStructure?: PromptVersionPublicTemplateStructure;
     createdAt?: Date;
     createdBy?: string;
 }
@@ -5541,10 +5621,25 @@ interface PromptPagePublic {
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * Template structure type: 'text' or 'chat'. Immutable after creation.
+ */
+type PromptPublicTemplateStructure = "text" | "chat";
+declare const PromptPublicTemplateStructure: {
+    readonly Text: "text";
+    readonly Chat: "chat";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
 interface PromptPublic {
     id?: string;
     name: string;
     description?: string;
+    /** Template structure type: 'text' or 'chat'. Immutable after creation. */
+    templateStructure?: PromptPublicTemplateStructure;
     tags?: string[];
     createdAt?: Date;
     createdBy?: string;
@@ -5566,7 +5661,9 @@ interface ServiceTogglesConfig {
     welcomeWizardEnabled: boolean;
     csvUploadEnabled: boolean;
     exportEnabled: boolean;
+    optimizationStudioEnabled: boolean;
     dashboardsEnabled: boolean;
+    datasetVersioningEnabled: boolean;
 }
 
 /**
@@ -7081,6 +7178,19 @@ declare class Dashboards {
      */
     updateDashboard(dashboardId: string, request?: DashboardUpdatePublic, requestOptions?: Dashboards.RequestOptions): HttpResponsePromise<DashboardPublic>;
     private __updateDashboard;
+    /**
+     * Delete dashboards batch
+     *
+     * @param {OpikApi.BatchDelete} request
+     * @param {Dashboards.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.dashboards.deleteDashboardsBatch({
+     *         ids: ["ids"]
+     *     })
+     */
+    deleteDashboardsBatch(request: BatchDelete, requestOptions?: Dashboards.RequestOptions): HttpResponsePromise<void>;
+    private __deleteDashboardsBatch;
     protected _getCustomAuthorizationHeaders(): Promise<{
         Authorization: string | undefined;
     }>;
@@ -7490,6 +7600,22 @@ declare class Datasets {
      */
     deleteVersionTag(versionHash: string, tag: string, id: string, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<void>;
     private __deleteVersionTag;
+    /**
+     * Restores the dataset to a previous version state. All draft items are replaced with items from the specified version. If the version is not the latest, a new version snapshot is created. If the version is the latest, only draft items are replaced (revert functionality).
+     *
+     * @param {string} id
+     * @param {OpikApi.DatasetVersionRestorePublic} request
+     * @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.NotFoundError}
+     *
+     * @example
+     *     await client.datasets.restoreDatasetVersion("id", {
+     *         versionRef: "version_ref"
+     *     })
+     */
+    restoreDatasetVersion(id: string, request: DatasetVersionRestorePublic, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<DatasetVersionPublic>;
+    private __restoreDatasetVersion;
     protected _getCustomAuthorizationHeaders(): Promise<{
         Authorization: string | undefined;
     }>;

package/dist/index.d.ts

@@ -500,6 +500,20 @@ interface DatasetVersionCreatePublic {
     metadata?: Record<string, string>;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         versionRef: "version_ref"
+ *     }
+ */
+interface DatasetVersionRestorePublic {
+    /** Version hash or tag to restore from */
+    versionRef: string;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1000,6 +1014,30 @@ declare const PromptWriteType: {
     readonly Jinja2: "jinja2";
 };
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Template structure type: 'text' or 'chat'. Immutable after creation.
+ */
+type PromptWriteTemplateStructure = "text" | "chat";
+declare const PromptWriteTemplateStructure: {
+    readonly Text: "text";
+    readonly Chat: "chat";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Template structure for the prompt: 'text' or 'chat'. Note: This field is only used when creating a new prompt. If a prompt with the given name already exists, this field is ignored and the existing prompt's template structure is used. Template structure is immutable after prompt creation.
+ */
+type CreatePromptVersionDetailTemplateStructure = "text" | "chat";
+declare const CreatePromptVersionDetailTemplateStructure: {
+    readonly Text: "text";
+    readonly Chat: "chat";
+};
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1033,6 +1071,8 @@ interface PromptWrite {
     metadata?: JsonNodeWrite;
     changeDescription?: string;
     type?: PromptWriteType;
+    /** Template structure type: 'text' or 'chat'. Immutable after creation. */
+    templateStructure?: PromptWriteTemplateStructure;
     tags?: string[];
 }
 
@@ -1052,6 +1092,8 @@ interface PromptWrite {
 interface CreatePromptVersionDetail {
     name: string;
     version: PromptVersionDetail;
+    /** Template structure for the prompt: 'text' or 'chat'. Note: This field is only used when creating a new prompt. If a prompt with the given name already exists, this field is ignored and the existing prompt's template structure is used. Template structure is immutable after prompt creation. */
+    templateStructure?: CreatePromptVersionDetailTemplateStructure;
 }
 
 /**
@@ -1415,6 +1457,7 @@ interface FindDashboardsRequest {
     page?: number;
     size?: number;
     name?: string;
+    sorting?: string;
 }
 
 /**
@@ -3447,6 +3490,7 @@ interface DashboardPagePublic {
     page?: number;
     size?: number;
     total?: number;
+    sortableBy?: string[];
 }
 
 /**
@@ -3744,6 +3788,7 @@ interface DatasetItemPageCompare {
     total?: number;
     columns?: ColumnCompare[];
     sortableBy?: string[];
+    hasDraft?: boolean;
 }
 
 /**
@@ -4072,6 +4117,7 @@ interface DatasetItemPagePublic {
     total?: number;
     columns?: ColumnPublic[];
     sortableBy?: string[];
+    hasDraft?: boolean;
 }
 
 /**
@@ -5452,6 +5498,15 @@ declare const PromptVersionDetailType: {
     readonly Jinja2: "jinja2";
 };
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type PromptVersionDetailTemplateStructure = "text" | "chat";
+declare const PromptVersionDetailTemplateStructure: {
+    readonly Text: "text";
+    readonly Chat: "chat";
+};
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -5467,10 +5522,23 @@ interface PromptVersionDetail {
     type?: PromptVersionDetailType;
     changeDescription?: string;
     variables?: string[];
+    templateStructure?: PromptVersionDetailTemplateStructure;
     createdAt?: Date;
     createdBy?: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Template structure type: 'text' or 'chat'. Immutable after creation.
+ */
+type PromptDetailTemplateStructure = "text" | "chat";
+declare const PromptDetailTemplateStructure: {
+    readonly Text: "text";
+    readonly Chat: "chat";
+};
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -5479,6 +5547,8 @@ interface PromptDetail {
     id?: string;
     name: string;
     description?: string;
+    /** Template structure type: 'text' or 'chat'. Immutable after creation. */
+    templateStructure?: PromptDetailTemplateStructure;
     tags?: string[];
     createdAt?: Date;
     createdBy?: string;
@@ -5508,6 +5578,15 @@ declare const PromptVersionPublicType: {
     readonly Jinja2: "jinja2";
 };
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type PromptVersionPublicTemplateStructure = "text" | "chat";
+declare const PromptVersionPublicTemplateStructure: {
+    readonly Text: "text";
+    readonly Chat: "chat";
+};
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -5522,6 +5601,7 @@ interface PromptVersionPublic {
     metadata?: JsonNodePublic;
     type?: PromptVersionPublicType;
     changeDescription?: string;
+    templateStructure?: PromptVersionPublicTemplateStructure;
     createdAt?: Date;
     createdBy?: string;
 }
@@ -5541,10 +5621,25 @@ interface PromptPagePublic {
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
+/**
+ * Template structure type: 'text' or 'chat'. Immutable after creation.
+ */
+type PromptPublicTemplateStructure = "text" | "chat";
+declare const PromptPublicTemplateStructure: {
+    readonly Text: "text";
+    readonly Chat: "chat";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
 interface PromptPublic {
     id?: string;
     name: string;
     description?: string;
+    /** Template structure type: 'text' or 'chat'. Immutable after creation. */
+    templateStructure?: PromptPublicTemplateStructure;
     tags?: string[];
     createdAt?: Date;
     createdBy?: string;
@@ -5566,7 +5661,9 @@ interface ServiceTogglesConfig {
     welcomeWizardEnabled: boolean;
     csvUploadEnabled: boolean;
     exportEnabled: boolean;
+    optimizationStudioEnabled: boolean;
     dashboardsEnabled: boolean;
+    datasetVersioningEnabled: boolean;
 }
 
 /**
@@ -7081,6 +7178,19 @@ declare class Dashboards {
      */
     updateDashboard(dashboardId: string, request?: DashboardUpdatePublic, requestOptions?: Dashboards.RequestOptions): HttpResponsePromise<DashboardPublic>;
     private __updateDashboard;
+    /**
+     * Delete dashboards batch
+     *
+     * @param {OpikApi.BatchDelete} request
+     * @param {Dashboards.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.dashboards.deleteDashboardsBatch({
+     *         ids: ["ids"]
+     *     })
+     */
+    deleteDashboardsBatch(request: BatchDelete, requestOptions?: Dashboards.RequestOptions): HttpResponsePromise<void>;
+    private __deleteDashboardsBatch;
     protected _getCustomAuthorizationHeaders(): Promise<{
         Authorization: string | undefined;
     }>;
@@ -7490,6 +7600,22 @@ declare class Datasets {
      */
     deleteVersionTag(versionHash: string, tag: string, id: string, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<void>;
     private __deleteVersionTag;
+    /**
+     * Restores the dataset to a previous version state. All draft items are replaced with items from the specified version. If the version is not the latest, a new version snapshot is created. If the version is the latest, only draft items are replaced (revert functionality).
+     *
+     * @param {string} id
+     * @param {OpikApi.DatasetVersionRestorePublic} request
+     * @param {Datasets.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.NotFoundError}
+     *
+     * @example
+     *     await client.datasets.restoreDatasetVersion("id", {
+     *         versionRef: "version_ref"
+     *     })
+     */
+    restoreDatasetVersion(id: string, request: DatasetVersionRestorePublic, requestOptions?: Datasets.RequestOptions): HttpResponsePromise<DatasetVersionPublic>;
+    private __restoreDatasetVersion;
     protected _getCustomAuthorizationHeaders(): Promise<{
         Authorization: string | undefined;
     }>;