opik 1.7.5 → 1.7.7

package/dist/{Client-BFXzOx36.d.cts → Client-BCz02VOm.d.cts}

@@ -941,6 +941,31 @@ interface ExperimentStreamRequestPublic {
     lastRetrievedId?: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * @example
+ *     {
+ *         guardrails: [{
+ *                 entityId: "entity_id",
+ *                 secondaryId: "secondary_id",
+ *                 name: "TOPIC",
+ *                 result: "passed",
+ *                 config: {
+ *                     "key": "value"
+ *                 },
+ *                 details: {
+ *                     "key": "value"
+ *                 }
+ *             }]
+ *     }
+ */
+interface GuardrailBatch {
+    guardrails: GuardrailBatchItem[];
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -2474,6 +2499,40 @@ interface NumericalFeedbackDetailUpdate {
     min: number;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type GuardrailBatchItemName = "TOPIC" | "PII";
+declare const GuardrailBatchItemName: {
+    readonly Topic: "TOPIC";
+    readonly Pii: "PII";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type GuardrailBatchItemResult = "passed" | "failed";
+declare const GuardrailBatchItemResult: {
+    readonly Passed: "passed";
+    readonly Failed: "failed";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface GuardrailBatchItem {
+    id?: string;
+    entityId: string;
+    secondaryId: string;
+    /** If null, the default project is used */
+    projectName?: string;
+    name: GuardrailBatchItemName;
+    result: GuardrailBatchItemResult;
+    config: JsonNode;
+    details: JsonNode;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -3132,6 +3191,42 @@ interface SpanFilterPublic {
     value?: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type CheckName = "TOPIC" | "PII";
+declare const CheckName: {
+    readonly Topic: "TOPIC";
+    readonly Pii: "PII";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type CheckResult = "passed" | "failed";
+declare const CheckResult: {
+    readonly Passed: "passed";
+    readonly Failed: "failed";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface Check$1 {
+    name?: CheckName;
+    result?: CheckResult;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface GuardrailsValidation {
+    spanId?: string;
+    checks?: Check$1[];
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -3156,6 +3251,7 @@ interface Trace$1 {
     lastUpdatedBy?: string;
     feedbackScores?: FeedbackScore[];
     comments?: Comment[];
+    guardrailsValidations?: GuardrailsValidation[];
     totalEstimatedCost?: number;
     spanCount?: number;
     /** Duration in milliseconds as a decimal number to support sub-millisecond precision */
@@ -3182,6 +3278,42 @@ interface TraceWrite {
     threadId?: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type CheckPublicName = "TOPIC" | "PII";
+declare const CheckPublicName: {
+    readonly Topic: "TOPIC";
+    readonly Pii: "PII";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type CheckPublicResult = "passed" | "failed";
+declare const CheckPublicResult: {
+    readonly Passed: "passed";
+    readonly Failed: "failed";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface CheckPublic {
+    name?: CheckPublicName;
+    result?: CheckPublicResult;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface GuardrailsValidationPublic {
+    spanId?: string;
+    checks?: CheckPublic[];
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -3204,6 +3336,7 @@ interface TracePublic {
     lastUpdatedBy?: string;
     feedbackScores?: FeedbackScorePublic[];
     comments?: CommentPublic[];
+    guardrailsValidations?: GuardrailsValidationPublic[];
     totalEstimatedCost?: number;
     spanCount?: number;
     /** Duration in milliseconds as a decimal number to support sub-millisecond precision */
@@ -4223,6 +4356,69 @@ declare class FeedbackDefinitions {
     }>;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+declare namespace Guardrails {
+    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>;
+    }
+}
+/**
+ * Guardrails related resources
+ */
+declare class Guardrails {
+    protected readonly _options: Guardrails.Options;
+    constructor(_options?: Guardrails.Options);
+    /**
+     * Batch guardrails for traces
+     *
+     * @param {OpikApi.GuardrailBatch} request
+     * @param {Guardrails.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.guardrails.addGuardrailsBatch({
+     *         guardrails: [{
+     *                 entityId: "entity_id",
+     *                 secondaryId: "secondary_id",
+     *                 name: "TOPIC",
+     *                 result: "passed",
+     *                 config: {
+     *                     "key": "value"
+     *                 },
+     *                 details: {
+     *                     "key": "value"
+     *                 }
+     *             }]
+     *     })
+     */
+    addGuardrailsBatch(request: GuardrailBatch, requestOptions?: Guardrails.RequestOptions): Promise<void>;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        Authorization: string | undefined;
+    }>;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -5420,6 +5616,7 @@ declare class OpikApiClient {
     protected _datasets: Datasets | undefined;
     protected _experiments: Experiments | undefined;
     protected _feedbackDefinitions: FeedbackDefinitions | undefined;
+    protected _guardrails: Guardrails | undefined;
     protected _llmProviderKey: LlmProviderKey | undefined;
     protected _openTelemetryIngestion: OpenTelemetryIngestion | undefined;
     protected _projects: Projects | undefined;
@@ -5437,6 +5634,7 @@ declare class OpikApiClient {
     get datasets(): Datasets;
     get experiments(): Experiments;
     get feedbackDefinitions(): FeedbackDefinitions;
+    get guardrails(): Guardrails;
     get llmProviderKey(): LlmProviderKey;
     get openTelemetryIngestion(): OpenTelemetryIngestion;
     get projects(): Projects;

package/dist/{Client-BFXzOx36.d.ts → Client-BCz02VOm.d.ts}

@@ -941,6 +941,31 @@ interface ExperimentStreamRequestPublic {
     lastRetrievedId?: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+/**
+ * @example
+ *     {
+ *         guardrails: [{
+ *                 entityId: "entity_id",
+ *                 secondaryId: "secondary_id",
+ *                 name: "TOPIC",
+ *                 result: "passed",
+ *                 config: {
+ *                     "key": "value"
+ *                 },
+ *                 details: {
+ *                     "key": "value"
+ *                 }
+ *             }]
+ *     }
+ */
+interface GuardrailBatch {
+    guardrails: GuardrailBatchItem[];
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -2474,6 +2499,40 @@ interface NumericalFeedbackDetailUpdate {
     min: number;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type GuardrailBatchItemName = "TOPIC" | "PII";
+declare const GuardrailBatchItemName: {
+    readonly Topic: "TOPIC";
+    readonly Pii: "PII";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type GuardrailBatchItemResult = "passed" | "failed";
+declare const GuardrailBatchItemResult: {
+    readonly Passed: "passed";
+    readonly Failed: "failed";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface GuardrailBatchItem {
+    id?: string;
+    entityId: string;
+    secondaryId: string;
+    /** If null, the default project is used */
+    projectName?: string;
+    name: GuardrailBatchItemName;
+    result: GuardrailBatchItemResult;
+    config: JsonNode;
+    details: JsonNode;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -3132,6 +3191,42 @@ interface SpanFilterPublic {
     value?: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type CheckName = "TOPIC" | "PII";
+declare const CheckName: {
+    readonly Topic: "TOPIC";
+    readonly Pii: "PII";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type CheckResult = "passed" | "failed";
+declare const CheckResult: {
+    readonly Passed: "passed";
+    readonly Failed: "failed";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface Check$1 {
+    name?: CheckName;
+    result?: CheckResult;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface GuardrailsValidation {
+    spanId?: string;
+    checks?: Check$1[];
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -3156,6 +3251,7 @@ interface Trace$1 {
     lastUpdatedBy?: string;
     feedbackScores?: FeedbackScore[];
     comments?: Comment[];
+    guardrailsValidations?: GuardrailsValidation[];
     totalEstimatedCost?: number;
     spanCount?: number;
     /** Duration in milliseconds as a decimal number to support sub-millisecond precision */
@@ -3182,6 +3278,42 @@ interface TraceWrite {
     threadId?: string;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type CheckPublicName = "TOPIC" | "PII";
+declare const CheckPublicName: {
+    readonly Topic: "TOPIC";
+    readonly Pii: "PII";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+type CheckPublicResult = "passed" | "failed";
+declare const CheckPublicResult: {
+    readonly Passed: "passed";
+    readonly Failed: "failed";
+};
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface CheckPublic {
+    name?: CheckPublicName;
+    result?: CheckPublicResult;
+}
+
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+interface GuardrailsValidationPublic {
+    spanId?: string;
+    checks?: CheckPublic[];
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -3204,6 +3336,7 @@ interface TracePublic {
     lastUpdatedBy?: string;
     feedbackScores?: FeedbackScorePublic[];
     comments?: CommentPublic[];
+    guardrailsValidations?: GuardrailsValidationPublic[];
     totalEstimatedCost?: number;
     spanCount?: number;
     /** Duration in milliseconds as a decimal number to support sub-millisecond precision */
@@ -4223,6 +4356,69 @@ declare class FeedbackDefinitions {
     }>;
 }
 
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+
+declare namespace Guardrails {
+    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>;
+    }
+}
+/**
+ * Guardrails related resources
+ */
+declare class Guardrails {
+    protected readonly _options: Guardrails.Options;
+    constructor(_options?: Guardrails.Options);
+    /**
+     * Batch guardrails for traces
+     *
+     * @param {OpikApi.GuardrailBatch} request
+     * @param {Guardrails.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.guardrails.addGuardrailsBatch({
+     *         guardrails: [{
+     *                 entityId: "entity_id",
+     *                 secondaryId: "secondary_id",
+     *                 name: "TOPIC",
+     *                 result: "passed",
+     *                 config: {
+     *                     "key": "value"
+     *                 },
+     *                 details: {
+     *                     "key": "value"
+     *                 }
+     *             }]
+     *     })
+     */
+    addGuardrailsBatch(request: GuardrailBatch, requestOptions?: Guardrails.RequestOptions): Promise<void>;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        Authorization: string | undefined;
+    }>;
+}
+
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
@@ -5420,6 +5616,7 @@ declare class OpikApiClient {
     protected _datasets: Datasets | undefined;
     protected _experiments: Experiments | undefined;
     protected _feedbackDefinitions: FeedbackDefinitions | undefined;
+    protected _guardrails: Guardrails | undefined;
     protected _llmProviderKey: LlmProviderKey | undefined;
     protected _openTelemetryIngestion: OpenTelemetryIngestion | undefined;
     protected _projects: Projects | undefined;
@@ -5437,6 +5634,7 @@ declare class OpikApiClient {
     get datasets(): Datasets;
     get experiments(): Experiments;
     get feedbackDefinitions(): FeedbackDefinitions;
+    get guardrails(): Guardrails;
     get llmProviderKey(): LlmProviderKey;
     get openTelemetryIngestion(): OpenTelemetryIngestion;
     get projects(): Projects;