opik 1.8.84 → 1.8.86

package/dist/{Client-CEIekgCZ.d.cts → Client-BMjFLeAt.d.cts}

@@ -1,5 +1,41 @@
 import * as stream from 'stream';
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type GetWebhookExamplesRequestAlertType = "general" | "slack" | "pagerduty";
+declare const GetWebhookExamplesRequestAlertType: {
+    readonly General: "general";
+    readonly Slack: "slack";
+    readonly Pagerduty: "pagerduty";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+interface FindAlertsRequest {
+    page?: number;
+    size?: number;
+    sorting?: string;
+    filters?: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * @example
+ *     {}
+ */
+interface GetWebhookExamplesRequest {
+    alertType?: GetWebhookExamplesRequestAlertType;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1090,20 +1126,6 @@ interface SpanSearchStreamRequestPublic {
     truncate?: boolean;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * @example
- *     {}
- */
-interface FindAlertsRequest {
-    page?: number;
-    size?: number;
-    sorting?: string;
-    filters?: string;
-}
-
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1685,6 +1707,16 @@ interface AlertTriggerWrite {
     triggerConfigs?: AlertTriggerConfigWrite[];
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type AlertWriteAlertType = "general" | "slack" | "pagerduty";
+declare const AlertWriteAlertType: {
+    readonly General: "general";
+    readonly Slack: "slack";
+    readonly Pagerduty: "pagerduty";
+};
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1693,6 +1725,8 @@ interface AlertWrite {
     id?: string;
     name?: string;
     enabled?: boolean;
+    alertType?: AlertWriteAlertType;
+    metadata?: Record<string, string>;
     webhook: WebhookWrite;
     triggers?: AlertTriggerWrite[];
 }
@@ -1778,6 +1812,16 @@ interface AlertTriggerPublic {
     createdBy?: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type AlertPublicAlertType = "general" | "slack" | "pagerduty";
+declare const AlertPublicAlertType: {
+    readonly General: "general";
+    readonly Slack: "slack";
+    readonly Pagerduty: "pagerduty";
+};
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1786,6 +1830,8 @@ interface AlertPublic {
     id?: string;
     name?: string;
     enabled?: boolean;
+    alertType?: AlertPublicAlertType;
+    metadata?: Record<string, string>;
     webhook: WebhookPublic;
     triggers?: AlertTriggerPublic[];
     createdAt?: Date;
@@ -1812,41 +1858,8 @@ interface WebhookPublic {
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-type WebhookEventObjectEventType = "trace:errors" | "trace:feedback_score" | "trace_thread:feedback_score" | "prompt:created" | "prompt:committed" | "trace:guardrails_triggered" | "prompt:deleted";
-declare const WebhookEventObjectEventType: {
-    readonly TraceErrors: "trace:errors";
-    readonly TraceFeedbackScore: "trace:feedback_score";
-    readonly TraceThreadFeedbackScore: "trace_thread:feedback_score";
-    readonly PromptCreated: "prompt:created";
-    readonly PromptCommitted: "prompt:committed";
-    readonly TraceGuardrailsTriggered: "trace:guardrails_triggered";
-    readonly PromptDeleted: "prompt:deleted";
-};
-
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-interface WebhookEventObject {
-    id: string;
-    eventType: WebhookEventObjectEventType;
-    alertId: string;
-    workspaceId: string;
-    userName: string;
-    payload: Record<string, unknown>;
-    createdAt: Date;
-    maxRetries?: number;
-    url: string;
-    secret?: string;
-    headers?: Record<string, string>;
-}
-
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
 interface WebhookExamples {
-    responseExamples?: Record<string, WebhookEventObject>;
+    responseExamples?: Record<string, Record<string, unknown>>;
 }
 
 /**
@@ -1865,7 +1878,7 @@ declare const WebhookTestResultStatus: {
 interface WebhookTestResult {
     status?: WebhookTestResultStatus;
     statusCode?: number;
-    requestBody?: WebhookEventObject;
+    requestBody?: string;
     errorMessage?: string;
 }
 
@@ -4105,6 +4118,43 @@ interface ProviderApiKeyPublic {
     lastUpdatedBy?: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface ManualEvaluationResponse {
+    /** Number of entities queued for evaluation */
+    entitiesQueued?: number;
+    /** Number of rules that will be applied */
+    rulesApplied?: number;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Type of entity to evaluate (trace or thread)
+ */
+type ManualEvaluationRequestEntityType = "trace" | "thread";
+declare const ManualEvaluationRequestEntityType: {
+    readonly Trace: "trace";
+    readonly Thread: "thread";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface ManualEvaluationRequest {
+    /** Project ID */
+    projectId: string;
+    /** List of entity IDs (trace IDs or thread IDs) to evaluate */
+    entityIds: string[];
+    /** List of automation rule IDs to apply */
+    ruleIds: string[];
+    /** Type of entity to evaluate (trace or thread) */
+    entityType: ManualEvaluationRequestEntityType;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -5338,14 +5388,15 @@ declare class Alerts {
     updateAlert(id: string, request: AlertWrite, requestOptions?: Alerts.RequestOptions): HttpResponsePromise<void>;
     private __updateAlert;
     /**
-     * Get webhook payload examples for all alert event types
+     * Get webhook payload examples for all alert event types, optionally filtered by alert type
      *
+     * @param {OpikApi.GetWebhookExamplesRequest} request
      * @param {Alerts.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.alerts.getWebhookExamples()
      */
-    getWebhookExamples(requestOptions?: Alerts.RequestOptions): HttpResponsePromise<WebhookExamples>;
+    getWebhookExamples(request?: GetWebhookExamplesRequest, requestOptions?: Alerts.RequestOptions): HttpResponsePromise<WebhookExamples>;
     private __getWebhookExamples;
     /**
      * Test alert webhook
@@ -6684,6 +6735,84 @@ declare class LlmProviderKey {
     }>;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+declare namespace ManualEvaluation {
+    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>;
+    }
+}
+/**
+ * Manual evaluation resources for traces and threads
+ */
+declare class ManualEvaluation {
+    protected readonly _options: ManualEvaluation.Options;
+    constructor(_options?: ManualEvaluation.Options);
+    /**
+     * Manually trigger evaluation rules on selected threads. Bypasses sampling and enqueues all specified threads for evaluation.
+     *
+     * @param {OpikApi.ManualEvaluationRequest} request
+     * @param {ManualEvaluation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     * @throws {@link OpikApi.NotFoundError}
+     *
+     * @example
+     *     await client.manualEvaluation.evaluateThreads({
+     *         projectId: "550e8400-e29b-41d4-a716-446655440000",
+     *         entityIds: ["550e8400-e29b-41d4-a716-446655440000", "550e8400-e29b-41d4-a716-446655440001"],
+     *         ruleIds: ["660e8400-e29b-41d4-a716-446655440000"],
+     *         entityType: "trace"
+     *     })
+     */
+    evaluateThreads(request: ManualEvaluationRequest, requestOptions?: ManualEvaluation.RequestOptions): HttpResponsePromise<ManualEvaluationResponse>;
+    private __evaluateThreads;
+    /**
+     * Manually trigger evaluation rules on selected traces. Bypasses sampling and enqueues all specified traces for evaluation.
+     *
+     * @param {OpikApi.ManualEvaluationRequest} request
+     * @param {ManualEvaluation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     * @throws {@link OpikApi.NotFoundError}
+     *
+     * @example
+     *     await client.manualEvaluation.evaluateTraces({
+     *         projectId: "550e8400-e29b-41d4-a716-446655440000",
+     *         entityIds: ["550e8400-e29b-41d4-a716-446655440000", "550e8400-e29b-41d4-a716-446655440001"],
+     *         ruleIds: ["660e8400-e29b-41d4-a716-446655440000"],
+     *         entityType: "trace"
+     *     })
+     */
+    evaluateTraces(request: ManualEvaluationRequest, requestOptions?: ManualEvaluation.RequestOptions): HttpResponsePromise<ManualEvaluationResponse>;
+    private __evaluateTraces;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        Authorization: string | undefined;
+    }>;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -8339,6 +8468,7 @@ declare class OpikApiClient {
     protected _feedbackDefinitions: FeedbackDefinitions | undefined;
     protected _guardrails: Guardrails | undefined;
     protected _llmProviderKey: LlmProviderKey | undefined;
+    protected _manualEvaluation: ManualEvaluation | undefined;
     protected _openTelemetryIngestion: OpenTelemetryIngestion | undefined;
     protected _optimizations: Optimizations | undefined;
     protected _projects: Projects | undefined;
@@ -8362,6 +8492,7 @@ declare class OpikApiClient {
     get feedbackDefinitions(): FeedbackDefinitions;
     get guardrails(): Guardrails;
     get llmProviderKey(): LlmProviderKey;
+    get manualEvaluation(): ManualEvaluation;
     get openTelemetryIngestion(): OpenTelemetryIngestion;
     get optimizations(): Optimizations;
     get projects(): Projects;

package/dist/{Client-CEIekgCZ.d.ts → Client-BMjFLeAt.d.ts}

@@ -1,5 +1,41 @@
 import * as stream from 'stream';
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type GetWebhookExamplesRequestAlertType = "general" | "slack" | "pagerduty";
+declare const GetWebhookExamplesRequestAlertType: {
+    readonly General: "general";
+    readonly Slack: "slack";
+    readonly Pagerduty: "pagerduty";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * @example
+ *     {}
+ */
+interface FindAlertsRequest {
+    page?: number;
+    size?: number;
+    sorting?: string;
+    filters?: string;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * @example
+ *     {}
+ */
+interface GetWebhookExamplesRequest {
+    alertType?: GetWebhookExamplesRequestAlertType;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1090,20 +1126,6 @@ interface SpanSearchStreamRequestPublic {
     truncate?: boolean;
 }
 
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-/**
- * @example
- *     {}
- */
-interface FindAlertsRequest {
-    page?: number;
-    size?: number;
-    sorting?: string;
-    filters?: string;
-}
-
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1685,6 +1707,16 @@ interface AlertTriggerWrite {
     triggerConfigs?: AlertTriggerConfigWrite[];
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type AlertWriteAlertType = "general" | "slack" | "pagerduty";
+declare const AlertWriteAlertType: {
+    readonly General: "general";
+    readonly Slack: "slack";
+    readonly Pagerduty: "pagerduty";
+};
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1693,6 +1725,8 @@ interface AlertWrite {
     id?: string;
     name?: string;
     enabled?: boolean;
+    alertType?: AlertWriteAlertType;
+    metadata?: Record<string, string>;
     webhook: WebhookWrite;
     triggers?: AlertTriggerWrite[];
 }
@@ -1778,6 +1812,16 @@ interface AlertTriggerPublic {
     createdBy?: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type AlertPublicAlertType = "general" | "slack" | "pagerduty";
+declare const AlertPublicAlertType: {
+    readonly General: "general";
+    readonly Slack: "slack";
+    readonly Pagerduty: "pagerduty";
+};
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -1786,6 +1830,8 @@ interface AlertPublic {
     id?: string;
     name?: string;
     enabled?: boolean;
+    alertType?: AlertPublicAlertType;
+    metadata?: Record<string, string>;
     webhook: WebhookPublic;
     triggers?: AlertTriggerPublic[];
     createdAt?: Date;
@@ -1812,41 +1858,8 @@ interface WebhookPublic {
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-type WebhookEventObjectEventType = "trace:errors" | "trace:feedback_score" | "trace_thread:feedback_score" | "prompt:created" | "prompt:committed" | "trace:guardrails_triggered" | "prompt:deleted";
-declare const WebhookEventObjectEventType: {
-    readonly TraceErrors: "trace:errors";
-    readonly TraceFeedbackScore: "trace:feedback_score";
-    readonly TraceThreadFeedbackScore: "trace_thread:feedback_score";
-    readonly PromptCreated: "prompt:created";
-    readonly PromptCommitted: "prompt:committed";
-    readonly TraceGuardrailsTriggered: "trace:guardrails_triggered";
-    readonly PromptDeleted: "prompt:deleted";
-};
-
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-interface WebhookEventObject {
-    id: string;
-    eventType: WebhookEventObjectEventType;
-    alertId: string;
-    workspaceId: string;
-    userName: string;
-    payload: Record<string, unknown>;
-    createdAt: Date;
-    maxRetries?: number;
-    url: string;
-    secret?: string;
-    headers?: Record<string, string>;
-}
-
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
 interface WebhookExamples {
-    responseExamples?: Record<string, WebhookEventObject>;
+    responseExamples?: Record<string, Record<string, unknown>>;
 }
 
 /**
@@ -1865,7 +1878,7 @@ declare const WebhookTestResultStatus: {
 interface WebhookTestResult {
     status?: WebhookTestResultStatus;
     statusCode?: number;
-    requestBody?: WebhookEventObject;
+    requestBody?: string;
     errorMessage?: string;
 }
 
@@ -4105,6 +4118,43 @@ interface ProviderApiKeyPublic {
     lastUpdatedBy?: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+interface ManualEvaluationResponse {
+    /** Number of entities queued for evaluation */
+    entitiesQueued?: number;
+    /** Number of rules that will be applied */
+    rulesApplied?: number;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * Type of entity to evaluate (trace or thread)
+ */
+type ManualEvaluationRequestEntityType = "trace" | "thread";
+declare const ManualEvaluationRequestEntityType: {
+    readonly Trace: "trace";
+    readonly Thread: "thread";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface ManualEvaluationRequest {
+    /** Project ID */
+    projectId: string;
+    /** List of entity IDs (trace IDs or thread IDs) to evaluate */
+    entityIds: string[];
+    /** List of automation rule IDs to apply */
+    ruleIds: string[];
+    /** Type of entity to evaluate (trace or thread) */
+    entityType: ManualEvaluationRequestEntityType;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -5338,14 +5388,15 @@ declare class Alerts {
     updateAlert(id: string, request: AlertWrite, requestOptions?: Alerts.RequestOptions): HttpResponsePromise<void>;
     private __updateAlert;
     /**
-     * Get webhook payload examples for all alert event types
+     * Get webhook payload examples for all alert event types, optionally filtered by alert type
      *
+     * @param {OpikApi.GetWebhookExamplesRequest} request
      * @param {Alerts.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.alerts.getWebhookExamples()
      */
-    getWebhookExamples(requestOptions?: Alerts.RequestOptions): HttpResponsePromise<WebhookExamples>;
+    getWebhookExamples(request?: GetWebhookExamplesRequest, requestOptions?: Alerts.RequestOptions): HttpResponsePromise<WebhookExamples>;
     private __getWebhookExamples;
     /**
      * Test alert webhook
@@ -6684,6 +6735,84 @@ declare class LlmProviderKey {
     }>;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+declare namespace ManualEvaluation {
+    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>;
+    }
+}
+/**
+ * Manual evaluation resources for traces and threads
+ */
+declare class ManualEvaluation {
+    protected readonly _options: ManualEvaluation.Options;
+    constructor(_options?: ManualEvaluation.Options);
+    /**
+     * Manually trigger evaluation rules on selected threads. Bypasses sampling and enqueues all specified threads for evaluation.
+     *
+     * @param {OpikApi.ManualEvaluationRequest} request
+     * @param {ManualEvaluation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     * @throws {@link OpikApi.NotFoundError}
+     *
+     * @example
+     *     await client.manualEvaluation.evaluateThreads({
+     *         projectId: "550e8400-e29b-41d4-a716-446655440000",
+     *         entityIds: ["550e8400-e29b-41d4-a716-446655440000", "550e8400-e29b-41d4-a716-446655440001"],
+     *         ruleIds: ["660e8400-e29b-41d4-a716-446655440000"],
+     *         entityType: "trace"
+     *     })
+     */
+    evaluateThreads(request: ManualEvaluationRequest, requestOptions?: ManualEvaluation.RequestOptions): HttpResponsePromise<ManualEvaluationResponse>;
+    private __evaluateThreads;
+    /**
+     * Manually trigger evaluation rules on selected traces. Bypasses sampling and enqueues all specified traces for evaluation.
+     *
+     * @param {OpikApi.ManualEvaluationRequest} request
+     * @param {ManualEvaluation.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link OpikApi.BadRequestError}
+     * @throws {@link OpikApi.NotFoundError}
+     *
+     * @example
+     *     await client.manualEvaluation.evaluateTraces({
+     *         projectId: "550e8400-e29b-41d4-a716-446655440000",
+     *         entityIds: ["550e8400-e29b-41d4-a716-446655440000", "550e8400-e29b-41d4-a716-446655440001"],
+     *         ruleIds: ["660e8400-e29b-41d4-a716-446655440000"],
+     *         entityType: "trace"
+     *     })
+     */
+    evaluateTraces(request: ManualEvaluationRequest, requestOptions?: ManualEvaluation.RequestOptions): HttpResponsePromise<ManualEvaluationResponse>;
+    private __evaluateTraces;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        Authorization: string | undefined;
+    }>;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -8339,6 +8468,7 @@ declare class OpikApiClient {
     protected _feedbackDefinitions: FeedbackDefinitions | undefined;
     protected _guardrails: Guardrails | undefined;
     protected _llmProviderKey: LlmProviderKey | undefined;
+    protected _manualEvaluation: ManualEvaluation | undefined;
     protected _openTelemetryIngestion: OpenTelemetryIngestion | undefined;
     protected _optimizations: Optimizations | undefined;
     protected _projects: Projects | undefined;
@@ -8362,6 +8492,7 @@ declare class OpikApiClient {
     get feedbackDefinitions(): FeedbackDefinitions;
     get guardrails(): Guardrails;
     get llmProviderKey(): LlmProviderKey;
+    get manualEvaluation(): ManualEvaluation;
     get openTelemetryIngestion(): OpenTelemetryIngestion;
     get optimizations(): Optimizations;
     get projects(): Projects;