opik 1.8.58 → 1.8.59

package/dist/{Client-D5RnI3e4.d.cts → Client-C4lSOKUJ.d.cts}

@@ -336,6 +336,39 @@ declare const ExperimentWriteType: {
     readonly MiniBatch: "mini-batch";
 };
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type ExperimentWriteStatus = "running" | "completed" | "cancelled";
+declare const ExperimentWriteStatus: {
+    readonly Running: "running";
+    readonly Completed: "completed";
+    readonly Cancelled: "cancelled";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type ExperimentUpdateType = "regular" | "trial" | "mini-batch";
+declare const ExperimentUpdateType: {
+    readonly Regular: "regular";
+    readonly Trial: "trial";
+    readonly MiniBatch: "mini-batch";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The status of the experiment
+ */
+type ExperimentUpdateStatus = "running" | "completed" | "cancelled";
+declare const ExperimentUpdateStatus: {
+    readonly Running: "running";
+    readonly Completed: "completed";
+    readonly Cancelled: "cancelled";
+};
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -373,6 +406,7 @@ interface ExperimentWrite {
     metadata?: JsonListStringWrite;
     type?: ExperimentWriteType;
     optimizationId?: string;
+    status?: ExperimentWriteStatus;
     promptVersion?: PromptVersionLinkWrite;
     promptVersions?: PromptVersionLinkWrite[];
 }
@@ -469,6 +503,22 @@ interface FindExperimentGroupsAggregationsRequest {
     filters?: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * @example
+ *     {}
+ */
+interface ExperimentUpdate {
+    name?: string;
+    metadata?: JsonNode;
+    type?: ExperimentUpdateType;
+    /** The status of the experiment */
+    status?: ExperimentUpdateStatus;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1014,6 +1064,28 @@ interface SpanSearchStreamRequestPublic {
     truncate?: boolean;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * @example
+ *     {
+ *         name: "name",
+ *         webhook: {
+ *             url: "url",
+ *             secretToken: "secret_token"
+ *         }
+ *     }
+ */
+interface AlertWrite {
+    id?: string;
+    name: string;
+    enabled?: boolean;
+    webhook: WebhookWrite;
+    triggers?: AlertTriggerWrite[];
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1514,6 +1586,149 @@ interface WorkspaceTraceCount {
     traceCount?: number;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type AlertTriggerConfigWriteType = "scope:project" | "threshold:feedback_score";
+declare const AlertTriggerConfigWriteType: {
+    readonly ScopeProject: "scope:project";
+    readonly ThresholdFeedbackScore: "threshold:feedback_score";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface AlertTriggerConfigWrite {
+    id?: string;
+    type: AlertTriggerConfigWriteType;
+    configValue?: Record<string, string>;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type AlertTriggerWriteEventType = "trace:errors" | "trace:feedback_score" | "trace_thread:feedback_score" | "prompt:created" | "prompt:committed" | "span:guardrails_triggered" | "prompt:deleted";
+declare const AlertTriggerWriteEventType: {
+    readonly TraceErrors: "trace:errors";
+    readonly TraceFeedbackScore: "trace:feedback_score";
+    readonly TraceThreadFeedbackScore: "trace_thread:feedback_score";
+    readonly PromptCreated: "prompt:created";
+    readonly PromptCommitted: "prompt:committed";
+    readonly SpanGuardrailsTriggered: "span:guardrails_triggered";
+    readonly PromptDeleted: "prompt:deleted";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface AlertTriggerWrite {
+    id?: string;
+    eventType: AlertTriggerWriteEventType;
+    triggerConfigs?: AlertTriggerConfigWrite[];
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface WebhookWrite {
+    id?: string;
+    name?: string;
+    url: string;
+    secretToken: string;
+    headers?: Record<string, string>;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface BatchDelete {
+    ids: string[];
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type AlertTriggerConfigPublicType = "scope:project" | "threshold:feedback_score";
+declare const AlertTriggerConfigPublicType: {
+    readonly ScopeProject: "scope:project";
+    readonly ThresholdFeedbackScore: "threshold:feedback_score";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface AlertTriggerConfigPublic {
+    id?: string;
+    alertTriggerId?: string;
+    type: AlertTriggerConfigPublicType;
+    configValue?: Record<string, string>;
+    createdAt?: Date;
+    createdBy?: string;
+    lastUpdatedAt?: Date;
+    lastUpdatedBy?: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type AlertTriggerPublicEventType = "trace:errors" | "trace:feedback_score" | "trace_thread:feedback_score" | "prompt:created" | "prompt:committed" | "span:guardrails_triggered" | "prompt:deleted";
+declare const AlertTriggerPublicEventType: {
+    readonly TraceErrors: "trace:errors";
+    readonly TraceFeedbackScore: "trace:feedback_score";
+    readonly TraceThreadFeedbackScore: "trace_thread:feedback_score";
+    readonly PromptCreated: "prompt:created";
+    readonly PromptCommitted: "prompt:committed";
+    readonly SpanGuardrailsTriggered: "span:guardrails_triggered";
+    readonly PromptDeleted: "prompt:deleted";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface AlertTriggerPublic {
+    id?: string;
+    alertId?: string;
+    eventType: AlertTriggerPublicEventType;
+    triggerConfigs?: AlertTriggerConfigPublic[];
+    createdAt?: Date;
+    createdBy?: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface AlertPublic {
+    id?: string;
+    name: string;
+    enabled?: boolean;
+    webhook: WebhookPublic;
+    triggers?: AlertTriggerPublic[];
+    createdAt?: Date;
+    createdBy?: string;
+    lastUpdatedAt?: Date;
+    lastUpdatedBy?: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface WebhookPublic {
+    id?: string;
+    name?: string;
+    url: string;
+    secretToken: string;
+    headers?: Record<string, string>;
+    createdAt?: Date;
+    createdBy?: string;
+    lastUpdatedAt?: Date;
+    lastUpdatedBy?: string;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1556,13 +1771,6 @@ interface AnnotationQueueWrite {
     feedbackDefinitionNames?: string[];
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-interface BatchDelete {
-    ids: string[];
-}
-
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1737,6 +1945,7 @@ interface LlmAsJudgeMessage {
 interface LlmAsJudgeModelParameters {
     name: string;
     temperature: number;
+    seed?: number;
 }
 
 /**
@@ -1881,6 +2090,7 @@ interface LlmAsJudgeMessageWrite {
 interface LlmAsJudgeModelParametersWrite {
     name: string;
     temperature: number;
+    seed?: number;
 }
 
 /**
@@ -2042,6 +2252,7 @@ interface LlmAsJudgeMessagePublic {
 interface LlmAsJudgeModelParametersPublic {
     name: string;
     temperature: number;
+    seed?: number;
 }
 
 /**
@@ -3219,6 +3430,16 @@ declare const ExperimentPublicType: {
     readonly MiniBatch: "mini-batch";
 };
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type ExperimentPublicStatus = "running" | "completed" | "cancelled";
+declare const ExperimentPublicStatus: {
+    readonly Running: "running";
+    readonly Completed: "completed";
+    readonly Cancelled: "cancelled";
+};
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -3242,6 +3463,7 @@ interface ExperimentPublic {
     lastUpdatedAt?: Date;
     createdBy?: string;
     lastUpdatedBy?: string;
+    status?: ExperimentPublicStatus;
     promptVersion?: PromptVersionLinkPublic;
     promptVersions?: PromptVersionLinkPublic[];
 }
@@ -3313,6 +3535,11 @@ interface GroupContentWithAggregations {
     aggregations?: AggregationData;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type JsonNode = Record<string, unknown>;
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -3513,11 +3740,6 @@ interface NumericalFeedbackDetailUpdate {
     min: number;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-type JsonNode = Record<string, unknown>;
-
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -4786,6 +5008,95 @@ declare class SystemUsage {
     }>;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+declare namespace Alerts {
+    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>;
+    }
+}
+/**
+ * Alert resources
+ */
+declare class Alerts {
+    protected readonly _options: Alerts.Options;
+    constructor(_options?: Alerts.Options);
+    /**
+     * Create alert
+     *
+     * @param {OpikApi.AlertWrite} request
+     * @param {Alerts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     * @throws {@link OpikApi.ConflictError}
+     * @throws {@link OpikApi.UnprocessableEntityError}
+     *
+     * @example
+     *     await client.alerts.createAlert({
+     *         name: "name",
+     *         webhook: {
+     *             url: "url",
+     *             secretToken: "secret_token"
+     *         }
+     *     })
+     */
+    createAlert(request: AlertWrite, requestOptions?: Alerts.RequestOptions): HttpResponsePromise<void>;
+    private __createAlert;
+    /**
+     * Delete multiple alerts by their IDs
+     *
+     * @param {OpikApi.BatchDelete} request
+     * @param {Alerts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     *
+     * @example
+     *     await client.alerts.deleteAlertBatch({
+     *         ids: ["ids"]
+     *     })
+     */
+    deleteAlertBatch(request: BatchDelete, requestOptions?: Alerts.RequestOptions): HttpResponsePromise<void>;
+    private __deleteAlertBatch;
+    /**
+     * Get Alert by id
+     *
+     * @param {string} id
+     * @param {Alerts.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.NotFoundError}
+     *
+     * @example
+     *     await client.alerts.getAlertById("id")
+     */
+    getAlertById(id: string, requestOptions?: Alerts.RequestOptions): HttpResponsePromise<AlertPublic>;
+    private __getAlertById;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        Authorization: string | undefined;
+    }>;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -5755,6 +6066,21 @@ declare class Experiments {
      */
     getExperimentById(id: string, requestOptions?: Experiments.RequestOptions): HttpResponsePromise<ExperimentPublic>;
     private __getExperimentById;
+    /**
+     * Update experiment by id
+     *
+     * @param {string} id
+     * @param {OpikApi.ExperimentUpdate} request
+     * @param {Experiments.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     * @throws {@link OpikApi.NotFoundError}
+     *
+     * @example
+     *     await client.experiments.updateExperiment("id")
+     */
+    updateExperiment(id: string, request?: ExperimentUpdate, requestOptions?: Experiments.RequestOptions): HttpResponsePromise<void>;
+    private __updateExperiment;
     /**
      * Get experiment item by id
      *
@@ -7653,6 +7979,7 @@ declare namespace OpikApiClient {
 declare class OpikApiClient {
     protected readonly _options: OpikApiClient.Options;
     protected _systemUsage: SystemUsage | undefined;
+    protected _alerts: Alerts | undefined;
     protected _annotationQueues: AnnotationQueues | undefined;
     protected _attachments: Attachments | undefined;
     protected _check: Check | undefined;
@@ -7674,6 +8001,7 @@ declare class OpikApiClient {
     protected _redirect: Redirect | undefined;
     constructor(_options?: OpikApiClient.Options);
     get systemUsage(): SystemUsage;
+    get alerts(): Alerts;
     get annotationQueues(): AnnotationQueues;
     get attachments(): Attachments;
     get check(): Check;