opik 1.7.13 → 1.7.15

package/dist/{Client-B_2JOueU.d.cts → Client-CiXa7NK8.d.cts}

@@ -156,6 +156,7 @@ interface FindDatasetsRequest {
     page?: number;
     size?: number;
     withExperimentsOnly?: boolean;
+    withOptimizationsOnly?: boolean;
     promptId?: string;
     name?: string;
     sorting?: string;
@@ -306,6 +307,118 @@ interface DatasetItemStreamRequest {
     steamLimit?: number;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type ExperimentWriteType = "regular" | "trial" | "mini-batch";
+declare const ExperimentWriteType: {
+    readonly Regular: "regular";
+    readonly Trial: "trial";
+    readonly MiniBatch: "mini-batch";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+interface FindExperimentsRequest {
+    page?: number;
+    size?: number;
+    datasetId?: string;
+    optimizationId?: string;
+    types?: string;
+    name?: string;
+    datasetDeleted?: boolean;
+    promptId?: string;
+    sorting?: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * @example
+ *     {
+ *         datasetName: "dataset_name"
+ *     }
+ */
+interface ExperimentWrite {
+    id?: string;
+    datasetName: string;
+    name?: string;
+    metadata?: JsonNodeWrite;
+    type?: ExperimentWriteType;
+    optimizationId?: string;
+    promptVersion?: PromptVersionLinkWrite;
+    promptVersions?: PromptVersionLinkWrite[];
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * @example
+ *     {
+ *         experimentItems: [{
+ *                 experimentId: "experiment_id",
+ *                 datasetItemId: "dataset_item_id",
+ *                 traceId: "trace_id"
+ *             }]
+ *     }
+ */
+interface ExperimentItemsBatch {
+    experimentItems: ExperimentItem[];
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {
+ *         ids: ["ids"]
+ *     }
+ */
+interface ExperimentItemsDelete {
+    ids: string[];
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+interface FindFeedbackScoreNamesRequest {
+    experimentIds?: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface ExperimentItemStreamRequest {
+    experimentName: string;
+    limit?: number;
+    lastRetrievedId?: string;
+    /** Truncate image included in either input, output or metadata */
+    truncate?: boolean;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface ExperimentStreamRequestPublic {
+    name: string;
+    limit?: number;
+    lastRetrievedId?: string;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -372,6 +485,75 @@ interface ProviderApiKeyUpdate {
     name?: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type OptimizationWriteStatus = "running" | "completed" | "cancelled";
+declare const OptimizationWriteStatus: {
+    readonly Running: "running";
+    readonly Completed: "completed";
+    readonly Cancelled: "cancelled";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type OptimizationUpdateStatus = "running" | "completed" | "cancelled";
+declare const OptimizationUpdateStatus: {
+    readonly Running: "running";
+    readonly Completed: "completed";
+    readonly Cancelled: "cancelled";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+interface FindOptimizationsRequest {
+    page?: number;
+    size?: number;
+    datasetId?: string;
+    name?: string;
+    datasetDeleted?: boolean;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * @example
+ *     {
+ *         datasetName: "dataset_name",
+ *         objectiveName: "objective_name",
+ *         status: "running"
+ *     }
+ */
+interface OptimizationWrite {
+    id?: string;
+    name?: string;
+    datasetName: string;
+    objectiveName: string;
+    status: OptimizationWriteStatus;
+    metadata?: JsonNodeWrite;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * @example
+ *     {}
+ */
+interface OptimizationUpdate {
+    name?: string;
+    status?: OptimizationUpdateStatus;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -854,117 +1036,6 @@ interface ChatCompletionRequest {
     functionCall?: FunctionCall;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * @example
- *     {}
- */
-interface FindExperimentsRequest {
-    page?: number;
-    size?: number;
-    datasetId?: string;
-    name?: string;
-    datasetDeleted?: boolean;
-    promptId?: string;
-    sorting?: string;
-}
-
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-/**
- * @example
- *     {
- *         datasetName: "dataset_name"
- *     }
- */
-interface ExperimentWrite {
-    id?: string;
-    datasetName: string;
-    name?: string;
-    metadata?: JsonNodeWrite;
-    promptVersion?: PromptVersionLinkWrite;
-    promptVersions?: PromptVersionLinkWrite[];
-}
-
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-/**
- * @example
- *     {
- *         experimentItems: [{
- *                 experimentId: "experiment_id",
- *                 datasetItemId: "dataset_item_id",
- *                 traceId: "trace_id"
- *             }]
- *     }
- */
-interface ExperimentItemsBatch {
-    experimentItems: ExperimentItem[];
-}
-
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * @example
- *     {
- *         ids: ["ids"]
- *     }
- */
-interface ExperimentItemsDelete {
-    ids: string[];
-}
-
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * @example
- *     {
- *         ids: ["ids"]
- *     }
- */
-interface ExperimentsDelete {
-    ids: string[];
-}
-
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * @example
- *     {}
- */
-interface FindFeedbackScoreNamesRequest {
-    experimentIds?: string;
-}
-
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-interface ExperimentItemStreamRequest {
-    experimentName: string;
-    limit?: number;
-    lastRetrievedId?: string;
-    /** Truncate image included in either input, output or metadata */
-    truncate?: boolean;
-}
-
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-interface ExperimentStreamRequestPublic {
-    name: string;
-    limit?: number;
-    lastRetrievedId?: string;
-}
-
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -986,8 +1057,8 @@ interface ExperimentStreamRequestPublic {
  *             }]
  *     }
  */
-interface GuardrailBatch {
-    guardrails: Guardrail[];
+interface GuardrailBatchWrite {
+    guardrails: GuardrailWrite[];
 }
 
 /**
@@ -1005,6 +1076,7 @@ interface GetTracesByProjectRequest {
     filters?: string;
     truncate?: boolean;
     sorting?: string;
+    exclude?: string;
 }
 
 /**
@@ -1015,7 +1087,6 @@ interface GetTracesByProjectRequest {
  * @example
  *     {
  *         traces: [{
- *                 name: "name",
  *                 startTime: "2024-01-15T09:30:00Z"
  *             }]
  *     }
@@ -1037,6 +1108,7 @@ interface TraceUpdate {
     projectName?: string;
     /** If null and project_name not specified, Default Project is assumed */
     projectId?: string;
+    name?: string;
     endTime?: Date;
     input?: JsonNode;
     output?: JsonNode;
@@ -2145,8 +2217,11 @@ interface DatasetPublic {
     lastUpdatedBy?: string;
     experimentCount?: number;
     datasetItemsCount?: number;
+    optimizationCount?: number;
     mostRecentExperimentAt?: Date;
     lastCreatedExperimentAt?: Date;
+    mostRecentOptimizationAt?: Date;
+    lastCreatedOptimizationAt?: Date;
 }
 
 /**
@@ -2290,6 +2365,13 @@ interface PromptVersionLinkWrite {
     id: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface DeleteIdsHolder {
+    ids: string[];
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -2314,6 +2396,16 @@ interface ExperimentPagePublic {
     sortableBy?: string[];
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type ExperimentPublicType = "regular" | "trial" | "mini-batch";
+declare const ExperimentPublicType: {
+    readonly Regular: "regular";
+    readonly Trial: "trial";
+    readonly MiniBatch: "mini-batch";
+};
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -2324,6 +2416,8 @@ interface ExperimentPublic {
     datasetId?: string;
     name?: string;
     metadata?: JsonNodePublic;
+    type?: ExperimentPublicType;
+    optimizationId?: string;
     feedbackScores?: FeedbackScoreAveragePublic[];
     comments?: CommentPublic[];
     traceCount?: number;
@@ -2564,8 +2658,8 @@ interface NumericalFeedbackDetailUpdate {
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-type GuardrailName = "TOPIC" | "PII";
-declare const GuardrailName: {
+type GuardrailWriteName = "TOPIC" | "PII";
+declare const GuardrailWriteName: {
     readonly Topic: "TOPIC";
     readonly Pii: "PII";
 };
@@ -2573,8 +2667,8 @@ declare const GuardrailName: {
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-type GuardrailResult = "passed" | "failed";
-declare const GuardrailResult: {
+type GuardrailWriteResult = "passed" | "failed";
+declare const GuardrailWriteResult: {
     readonly Passed: "passed";
     readonly Failed: "failed";
 };
@@ -2583,14 +2677,13 @@ declare const GuardrailResult: {
  * This file was auto-generated by Fern from our API Definition.
  */
 
-interface Guardrail {
-    id?: string;
+interface GuardrailWrite {
     entityId: string;
     secondaryId: string;
     /** If null, the default project is used */
     projectName?: string;
-    name: GuardrailName;
-    result: GuardrailResult;
+    name: GuardrailWriteName;
+    result: GuardrailWriteResult;
     config: JsonNode;
     details: JsonNode;
 }
@@ -2632,6 +2725,48 @@ interface ProviderApiKeyPublic {
     lastUpdatedBy?: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface OptimizationPagePublic {
+    page?: number;
+    size?: number;
+    total?: number;
+    content?: OptimizationPublic[];
+    sortableBy?: string[];
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type OptimizationPublicStatus = "running" | "completed" | "cancelled";
+declare const OptimizationPublicStatus: {
+    readonly Running: "running";
+    readonly Completed: "completed";
+    readonly Cancelled: "cancelled";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface OptimizationPublic {
+    id?: string;
+    name?: string;
+    datasetName: string;
+    objectiveName: string;
+    status: OptimizationPublicStatus;
+    metadata?: JsonNodePublic;
+    datasetId?: string;
+    numTrials?: number;
+    feedbackScores?: FeedbackScoreAveragePublic[];
+    createdAt?: Date;
+    createdBy?: string;
+    lastUpdatedAt?: Date;
+    lastUpdatedBy?: string;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -3283,7 +3418,7 @@ interface Trace$1 {
     /** If null, the default project is used */
     projectName?: string;
     projectId?: string;
-    name: string;
+    name?: string;
     startTime: Date;
     endTime?: Date;
     input?: JsonNode;
@@ -3314,7 +3449,7 @@ interface TraceWrite {
     id?: string;
     /** If null, the default project is used */
     projectName?: string;
-    name: string;
+    name?: string;
     startTime: Date;
     endTime?: Date;
     input?: JsonNodeWrite;
@@ -3322,6 +3457,7 @@ interface TraceWrite {
     metadata?: JsonNodeWrite;
     tags?: string[];
     errorInfo?: ErrorInfoWrite;
+    lastUpdatedAt?: Date;
     threadId?: string;
 }
 
@@ -3368,7 +3504,7 @@ interface GuardrailsValidationPublic {
 interface TracePublic {
     id?: string;
     projectId?: string;
-    name: string;
+    name?: string;
     startTime: Date;
     endTime?: Date;
     input?: JsonNodePublic;
@@ -4236,7 +4372,7 @@ declare class Experiments {
     /**
      * Delete experiments by id
      *
-     * @param {OpikApi.ExperimentsDelete} request
+     * @param {OpikApi.DeleteIdsHolder} request
      * @param {Experiments.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -4244,7 +4380,7 @@ declare class Experiments {
      *         ids: ["ids"]
      *     })
      */
-    deleteExperimentsById(request: ExperimentsDelete, requestOptions?: Experiments.RequestOptions): Promise<void>;
+    deleteExperimentsById(request: DeleteIdsHolder, requestOptions?: Experiments.RequestOptions): Promise<void>;
     /**
      * Find Feedback Score names
      *
@@ -4441,7 +4577,7 @@ declare class Guardrails {
     /**
      * Batch guardrails for traces
      *
-     * @param {OpikApi.GuardrailBatch} request
+     * @param {OpikApi.GuardrailBatchWrite} request
      * @param {Guardrails.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -4460,7 +4596,7 @@ declare class Guardrails {
      *             }]
      *     })
      */
-    createGuardrails(request: GuardrailBatch, requestOptions?: Guardrails.RequestOptions): Promise<void>;
+    createGuardrails(request: GuardrailBatchWrite, requestOptions?: Guardrails.RequestOptions): Promise<void>;
     protected _getCustomAuthorizationHeaders(): Promise<{
         Authorization: string | undefined;
     }>;
@@ -4619,6 +4755,107 @@ declare class OpenTelemetryIngestion {
     }>;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+declare namespace Optimizations {
+    interface Options {
+        environment?: Supplier<OpikApiEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: Supplier<string>;
+        /** Override the Authorization header */
+        apiKey?: Supplier<string | undefined>;
+        /** Override the Comet-Workspace header */
+        workspaceName?: Supplier<string | undefined>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Override the Authorization header */
+        apiKey?: string | undefined;
+        /** Override the Comet-Workspace header */
+        workspaceName?: string | undefined;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+/**
+ * Optimization resources
+ */
+declare class Optimizations {
+    protected readonly _options: Optimizations.Options;
+    constructor(_options?: Optimizations.Options);
+    /**
+     * Find optimizations
+     *
+     * @param {OpikApi.FindOptimizationsRequest} request
+     * @param {Optimizations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     *
+     * @example
+     *     await client.optimizations.findOptimizations()
+     */
+    findOptimizations(request?: FindOptimizationsRequest, requestOptions?: Optimizations.RequestOptions): Promise<OptimizationPagePublic>;
+    /**
+     * Create optimization
+     *
+     * @param {OpikApi.OptimizationWrite} request
+     * @param {Optimizations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.optimizations.createOptimization({
+     *         datasetName: "dataset_name",
+     *         objectiveName: "objective_name",
+     *         status: "running"
+     *     })
+     */
+    createOptimization(request: OptimizationWrite, requestOptions?: Optimizations.RequestOptions): Promise<void>;
+    /**
+     * Delete optimizations by id
+     *
+     * @param {OpikApi.DeleteIdsHolder} request
+     * @param {Optimizations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.optimizations.deleteOptimizationsById({
+     *         ids: ["ids"]
+     *     })
+     */
+    deleteOptimizationsById(request: DeleteIdsHolder, requestOptions?: Optimizations.RequestOptions): Promise<void>;
+    /**
+     * Get optimization by id
+     *
+     * @param {string} id
+     * @param {Optimizations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.NotFoundError}
+     *
+     * @example
+     *     await client.optimizations.getOptimizationById("id")
+     */
+    getOptimizationById(id: string, requestOptions?: Optimizations.RequestOptions): Promise<OptimizationPublic>;
+    /**
+     * Update optimization by id
+     *
+     * @param {string} id
+     * @param {OpikApi.OptimizationUpdate} request
+     * @param {Optimizations.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.optimizations.updateOptimizationsById("id")
+     */
+    updateOptimizationsById(id: string, request?: OptimizationUpdate, requestOptions?: Optimizations.RequestOptions): Promise<void>;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        Authorization: string | undefined;
+    }>;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -5334,7 +5571,6 @@ declare class Traces {
      *
      * @example
      *     await client.traces.createTrace({
-     *         name: "name",
      *         startTime: "2024-01-15T09:30:00Z"
      *     })
      */
@@ -5348,7 +5584,6 @@ declare class Traces {
      * @example
      *     await client.traces.createTraces({
      *         traces: [{
-     *                 name: "name",
      *                 startTime: "2024-01-15T09:30:00Z"
      *             }]
      *     })
@@ -5666,6 +5901,7 @@ declare class OpikApiClient {
     protected _guardrails: Guardrails | undefined;
     protected _llmProviderKey: LlmProviderKey | undefined;
     protected _openTelemetryIngestion: OpenTelemetryIngestion | undefined;
+    protected _optimizations: Optimizations | undefined;
     protected _projects: Projects | undefined;
     protected _prompts: Prompts | undefined;
     protected _serviceToggles: ServiceToggles | undefined;
@@ -5684,6 +5920,7 @@ declare class OpikApiClient {
     get guardrails(): Guardrails;
     get llmProviderKey(): LlmProviderKey;
     get openTelemetryIngestion(): OpenTelemetryIngestion;
+    get optimizations(): Optimizations;
     get projects(): Projects;
     get prompts(): Prompts;
     get serviceToggles(): ServiceToggles;