opik 1.9.36 → 1.9.37

package/dist/index.d.ts

@@ -581,6 +581,7 @@ interface ExperimentWrite {
     type?: ExperimentWriteType;
     optimizationId?: string;
     status?: ExperimentWriteStatus;
+    experimentScores?: ExperimentScoreWrite[];
     promptVersion?: PromptVersionLinkWrite;
     promptVersions?: PromptVersionLinkWrite[];
 }
@@ -691,6 +692,7 @@ interface ExperimentUpdate {
     type?: ExperimentUpdateType;
     /** The status of the experiment */
     status?: ExperimentUpdateStatus;
+    experimentScores?: ExperimentScore[];
 }
 
 /**
@@ -792,11 +794,13 @@ interface ProviderApiKeyUpdate {
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-type OptimizationUpdateStatus = "running" | "completed" | "cancelled";
+type OptimizationUpdateStatus = "running" | "completed" | "cancelled" | "initialized" | "error";
 declare const OptimizationUpdateStatus: {
     readonly Running: "running";
     readonly Completed: "completed";
     readonly Cancelled: "cancelled";
+    readonly Initialized: "initialized";
+    readonly Error: "error";
 };
 
 /**
@@ -812,6 +816,23 @@ interface FindOptimizationsRequest {
     datasetId?: string;
     name?: string;
     datasetDeleted?: boolean;
+    filters?: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+interface FindStudioOptimizationsRequest {
+    page?: number;
+    size?: number;
+    datasetId?: string;
+    name?: string;
+    datasetDeleted?: boolean;
+    filters?: string;
 }
 
 /**
@@ -4151,6 +4172,14 @@ declare const ExperimentType: {
     readonly MiniBatch: "mini-batch";
 };
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface ExperimentScore {
+    name: string;
+    value: number;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -4160,6 +4189,14 @@ interface PercentageValues {
     p99?: number;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface ExperimentScoreWrite {
+    name: string;
+    value: number;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -4477,6 +4514,14 @@ interface ExperimentPagePublic {
     sortableBy?: string[];
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface ExperimentScorePublic {
+    name: string;
+    value: number;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -4521,6 +4566,7 @@ interface ExperimentPublic {
     createdBy?: string;
     lastUpdatedBy?: string;
     status?: ExperimentPublicStatus;
+    experimentScores?: ExperimentScorePublic[];
     promptVersion?: PromptVersionLinkPublic;
     promptVersions?: PromptVersionLinkPublic[];
 }
@@ -4582,6 +4628,7 @@ interface AggregationData {
     totalEstimatedCostAvg?: number;
     duration?: PercentageValues;
     feedbackScores?: FeedbackScoreAverage[];
+    experimentScores?: FeedbackScoreAverage[];
 }
 
 /**
@@ -4988,11 +5035,25 @@ interface ManualEvaluationRequest {
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-type OptimizationWriteStatus = "running" | "completed" | "cancelled";
+
+interface OptimizationStudioConfigWrite {
+    datasetName: string;
+    prompt: StudioPromptWrite;
+    llmModel: StudioLlmModelWrite;
+    evaluation: StudioEvaluationWrite;
+    optimizer: StudioOptimizerWrite;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type OptimizationWriteStatus = "running" | "completed" | "cancelled" | "initialized" | "error";
 declare const OptimizationWriteStatus: {
     readonly Running: "running";
     readonly Completed: "completed";
     readonly Cancelled: "cancelled";
+    readonly Initialized: "initialized";
+    readonly Error: "error";
 };
 
 /**
@@ -5006,9 +5067,61 @@ interface OptimizationWrite {
     objectiveName: string;
     status: OptimizationWriteStatus;
     metadata?: JsonListStringWrite;
+    studioConfig?: OptimizationStudioConfigWrite;
     lastUpdatedAt?: Date;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface StudioEvaluationWrite {
+    metrics: StudioMetricWrite[];
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface StudioLlmModelWrite {
+    model: string;
+    parameters?: JsonNodeWrite;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface StudioMessageWrite {
+    role: string;
+    content: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface StudioMetricWrite {
+    type: string;
+    parameters?: JsonNodeWrite;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface StudioOptimizerWrite {
+    type: string;
+    parameters?: JsonNodeWrite;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface StudioPromptWrite {
+    messages: StudioMessageWrite[];
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -5024,11 +5137,25 @@ interface OptimizationPagePublic {
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-type OptimizationPublicStatus = "running" | "completed" | "cancelled";
+
+interface OptimizationStudioConfigPublic {
+    datasetName: string;
+    prompt: StudioPromptPublic;
+    llmModel: StudioLlmModelPublic;
+    evaluation: StudioEvaluationPublic;
+    optimizer: StudioOptimizerPublic;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type OptimizationPublicStatus = "running" | "completed" | "cancelled" | "initialized" | "error";
 declare const OptimizationPublicStatus: {
     readonly Running: "running";
     readonly Completed: "completed";
     readonly Cancelled: "cancelled";
+    readonly Initialized: "initialized";
+    readonly Error: "error";
 };
 
 /**
@@ -5042,6 +5169,7 @@ interface OptimizationPublic {
     objectiveName: string;
     status: OptimizationPublicStatus;
     metadata?: JsonListStringPublic;
+    studioConfig?: OptimizationStudioConfigPublic;
     datasetId?: string;
     numTrials?: number;
     feedbackScores?: FeedbackScoreAveragePublic[];
@@ -5051,6 +5179,66 @@ interface OptimizationPublic {
     lastUpdatedBy?: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface StudioEvaluationPublic {
+    metrics: StudioMetricPublic[];
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface StudioLlmModelPublic {
+    model: string;
+    parameters?: JsonNodePublic;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface StudioMessagePublic {
+    role: string;
+    content: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface StudioMetricPublic {
+    type: string;
+    parameters?: JsonNodePublic;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface StudioOptimizerPublic {
+    type: string;
+    parameters?: JsonNodePublic;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface StudioPromptPublic {
+    messages: StudioMessagePublic[];
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface OptimizationStudioLog {
+    url?: string;
+    lastModified?: Date;
+    expiresAt?: Date;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -5110,6 +5298,7 @@ interface FeedbackScoreNames {
  */
 interface ScoreName {
     name?: string;
+    type?: string;
 }
 
 /**
@@ -5377,6 +5566,7 @@ interface ServiceTogglesConfig {
     welcomeWizardEnabled: boolean;
     csvUploadEnabled: boolean;
     exportEnabled: boolean;
+    dashboardsEnabled: boolean;
 }
 
 /**
@@ -6676,8 +6866,7 @@ declare class AutomationRuleEvaluators {
      *
      * @example
      *     await client.automationRuleEvaluators.createAutomationRuleEvaluator({
-     *         type: "llm_as_judge",
-     *         filters: [{}]
+     *         type: "llm_as_judge"
      *     })
      */
     createAutomationRuleEvaluator(request: AutomationRuleEvaluatorWrite, requestOptions?: AutomationRuleEvaluators.RequestOptions): HttpResponsePromise<void>;
@@ -7989,6 +8178,19 @@ declare namespace Optimizations {
 declare class Optimizations {
     protected readonly _options: Optimizations.Options;
     constructor(_options?: Optimizations.Options);
+    /**
+     * Cancel Studio optimizations by id
+     *
+     * @param {string} id
+     * @param {Optimizations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.NotImplementedError}
+     *
+     * @example
+     *     await client.optimizations.cancelStudioOptimizations("id")
+     */
+    cancelStudioOptimizations(id: string, requestOptions?: Optimizations.RequestOptions): HttpResponsePromise<void>;
+    private __cancelStudioOptimizations;
     /**
      * Find optimizations
      *
@@ -8045,6 +8247,19 @@ declare class Optimizations {
      */
     deleteOptimizationsById(request: DeleteIdsHolder, requestOptions?: Optimizations.RequestOptions): HttpResponsePromise<void>;
     private __deleteOptimizationsById;
+    /**
+     * Find Studio optimizations
+     *
+     * @param {OpikApi.FindStudioOptimizationsRequest} request
+     * @param {Optimizations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     *
+     * @example
+     *     await client.optimizations.findStudioOptimizations()
+     */
+    findStudioOptimizations(request?: FindStudioOptimizationsRequest, requestOptions?: Optimizations.RequestOptions): HttpResponsePromise<OptimizationPagePublic>;
+    private __findStudioOptimizations;
     /**
      * Get optimization by id
      *
@@ -8070,6 +8285,32 @@ declare class Optimizations {
      */
     updateOptimizationsById(id: string, request?: OptimizationUpdate, requestOptions?: Optimizations.RequestOptions): HttpResponsePromise<void>;
     private __updateOptimizationsById;
+    /**
+     * Get Studio optimization with config included
+     *
+     * @param {string} id
+     * @param {Optimizations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.NotFoundError}
+     *
+     * @example
+     *     await client.optimizations.getStudioOptimizationById("id")
+     */
+    getStudioOptimizationById(id: string, requestOptions?: Optimizations.RequestOptions): HttpResponsePromise<OptimizationPublic>;
+    private __getStudioOptimizationById;
+    /**
+     * Get presigned S3 URL for downloading optimization logs
+     *
+     * @param {string} id
+     * @param {Optimizations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.NotFoundError}
+     *
+     * @example
+     *     await client.optimizations.getStudioOptimizationLogs("id")
+     */
+    getStudioOptimizationLogs(id: string, requestOptions?: Optimizations.RequestOptions): HttpResponsePromise<OptimizationStudioLog>;
+    private __getStudioOptimizationLogs;
     protected _getCustomAuthorizationHeaders(): Promise<{
         Authorization: string | undefined;
     }>;