opik 0.0.1 → 0.0.2

package/src/opik/rest_api/api/types/TraceCountResponse.ts

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-import * as OpikApi from "../index";
-
-export interface TraceCountResponse {
-    workspacesTracesCount?: OpikApi.WorkspaceTraceCount[];
-}

package/src/opik/rest_api/api/types/TracePagePublic.ts

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-import * as OpikApi from "../index";
-
-export interface TracePagePublic {
-    page?: number;
-    size?: number;
-    total?: number;
-    content?: OpikApi.TracePublic[];
-}

package/src/opik/rest_api/api/types/TracePublic.ts

@@ -1,25 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-import * as OpikApi from "../index";
-
-export interface TracePublic {
-    id?: string;
-    projectId?: string;
-    name: string;
-    startTime: Date;
-    endTime?: Date;
-    input?: OpikApi.JsonNodePublic;
-    output?: OpikApi.JsonNodePublic;
-    metadata?: OpikApi.JsonNodePublic;
-    tags?: string[];
-    errorInfo?: OpikApi.ErrorInfoPublic;
-    usage?: Record<string, number>;
-    createdAt?: Date;
-    lastUpdatedAt?: Date;
-    createdBy?: string;
-    lastUpdatedBy?: string;
-    feedbackScores?: OpikApi.FeedbackScorePublic[];
-    totalEstimatedCost?: number;
-}

package/src/opik/rest_api/api/types/TraceWrite.ts

@@ -1,19 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-import * as OpikApi from "../index";
-
-export interface TraceWrite {
-    id?: string;
-    /** If null, the default project is used */
-    projectName?: string;
-    name: string;
-    startTime: Date;
-    endTime?: Date;
-    input?: OpikApi.JsonNodeWrite;
-    output?: OpikApi.JsonNodeWrite;
-    metadata?: OpikApi.JsonNodeWrite;
-    tags?: string[];
-    errorInfo?: OpikApi.ErrorInfoWrite;
-}

package/src/opik/rest_api/api/types/Usage.ts

@@ -1,12 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-import * as OpikApi from "../index";
-
-export interface Usage {
-    totalTokens?: number;
-    promptTokens?: number;
-    completionTokens?: number;
-    completionTokensDetails?: OpikApi.CompletionTokensDetails;
-}

package/src/opik/rest_api/api/types/WorkspaceTraceCount.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-export interface WorkspaceTraceCount {
-    workspace?: string;
-    traceCount?: number;
-}

package/src/opik/rest_api/api/types/index.ts

@@ -1,138 +0,0 @@
-export * from "./BiInformation";
-export * from "./BiInformationResponse";
-export * from "./TraceCountResponse";
-export * from "./WorkspaceTraceCount";
-export * from "./ErrorMessage";
-export * from "./AuthDetailsHolder";
-export * from "./AssistantMessageRole";
-export * from "./AssistantMessage";
-export * from "./ChatCompletionChoice";
-export * from "./ChatCompletionResponse";
-export * from "./CompletionTokensDetails";
-export * from "./DeltaRole";
-export * from "./Delta";
-export * from "./FunctionCall";
-export * from "./ToolCall";
-export * from "./Usage";
-export * from "./Function";
-export * from "./JsonObjectSchema";
-export * from "./JsonSchema";
-export * from "./JsonSchemaElement";
-export * from "./Message";
-export * from "./ResponseFormatType";
-export * from "./ResponseFormat";
-export * from "./StreamOptions";
-export * from "./Tool";
-export * from "./Dataset";
-export * from "./DatasetItemSource";
-export * from "./DatasetItem";
-export * from "./DatasetItemBatch";
-export * from "./ExperimentItem";
-export * from "./FeedbackScoreSource";
-export * from "./FeedbackScore";
-export * from "./JsonNode";
-export * from "./DatasetItemWriteSource";
-export * from "./DatasetItemWrite";
-export * from "./JsonNodeWrite";
-export * from "./BatchDelete";
-export * from "./ColumnCompareTypesItem";
-export * from "./ColumnCompare";
-export * from "./DatasetItemPageCompare";
-export * from "./DatasetItemCompareSource";
-export * from "./DatasetItemCompare";
-export * from "./ExperimentItemCompare";
-export * from "./FeedbackScoreCompareSource";
-export * from "./FeedbackScoreCompare";
-export * from "./JsonNodeCompare";
-export * from "./DatasetPagePublic";
-export * from "./DatasetPublic";
-export * from "./DatasetItemPublicSource";
-export * from "./DatasetItemPublic";
-export * from "./ExperimentItemPublic";
-export * from "./JsonNodePublic";
-export * from "./ColumnPublicTypesItem";
-export * from "./ColumnPublic";
-export * from "./DatasetItemPagePublic";
-export * from "./ColumnTypesItem";
-export * from "./Column";
-export * from "./PageColumns";
-export * from "./ChunkedOutputJsonNodeType";
-export * from "./ChunkedOutputJsonNode";
-export * from "./Experiment";
-export * from "./FeedbackScoreAverage";
-export * from "./PromptVersionLink";
-export * from "./PromptVersionLinkWrite";
-export * from "./ExperimentPagePublic";
-export * from "./ExperimentPublic";
-export * from "./FeedbackScoreAveragePublic";
-export * from "./PromptVersionLinkPublic";
-export * from "./ErrorMessagePublic";
-export * from "./CategoricalFeedbackDefinition";
-export * from "./CategoricalFeedbackDetail";
-export * from "./Feedback";
-export * from "./NumericalFeedbackDefinition";
-export * from "./NumericalFeedbackDetail";
-export * from "./CategoricalFeedbackDefinitionCreate";
-export * from "./CategoricalFeedbackDetailCreate";
-export * from "./FeedbackCreate";
-export * from "./NumericalFeedbackDefinitionCreate";
-export * from "./NumericalFeedbackDetailCreate";
-export * from "./CategoricalFeedbackDefinitionPublic";
-export * from "./CategoricalFeedbackDetailPublic";
-export * from "./FeedbackDefinitionPagePublic";
-export * from "./FeedbackObjectPublic";
-export * from "./NumericalFeedbackDefinitionPublic";
-export * from "./NumericalFeedbackDetailPublic";
-export * from "./FeedbackPublic";
-export * from "./CategoricalFeedbackDefinitionUpdate";
-export * from "./CategoricalFeedbackDetailUpdate";
-export * from "./FeedbackUpdate";
-export * from "./NumericalFeedbackDefinitionUpdate";
-export * from "./NumericalFeedbackDetailUpdate";
-export * from "./ProjectPagePublic";
-export * from "./ProviderApiKeyPublic";
-export * from "./ProviderApiKey";
-export * from "./Project";
-export * from "./ProjectPublic";
-export * from "./DataPointNumberPublic";
-export * from "./ProjectMetricResponsePublicMetricType";
-export * from "./ProjectMetricResponsePublicInterval";
-export * from "./ProjectMetricResponsePublic";
-export * from "./ResultsNumberPublic";
-export * from "./Prompt";
-export * from "./PromptVersion";
-export * from "./PromptVersionDetail";
-export * from "./ErrorMessageDetail";
-export * from "./PromptDetail";
-export * from "./PromptVersionPagePublic";
-export * from "./PromptVersionPublic";
-export * from "./PromptPagePublic";
-export * from "./PromptPublic";
-export * from "./ErrorInfo";
-export * from "./SpanType";
-export * from "./Span";
-export * from "./ErrorInfoWrite";
-export * from "./SpanWriteType";
-export * from "./SpanWrite";
-export * from "./SpanBatch";
-export * from "./DeleteFeedbackScore";
-export * from "./ErrorInfoPublic";
-export * from "./FeedbackScorePublicSource";
-export * from "./FeedbackScorePublic";
-export * from "./SpanPublicType";
-export * from "./SpanPublic";
-export * from "./SpanPagePublic";
-export * from "./AvgValueStatPublic";
-export * from "./CountValueStatPublic";
-export * from "./PercentageValueStatPublic";
-export * from "./PercentageValuesPublic";
-export * from "./ProjectStatItemObjectPublic";
-export * from "./ProjectStatsPublic";
-export * from "./FeedbackScoreBatch";
-export * from "./FeedbackScoreBatchItemSource";
-export * from "./FeedbackScoreBatchItem";
-export * from "./Trace";
-export * from "./TraceWrite";
-export * from "./TraceBatch";
-export * from "./TracePublic";
-export * from "./TracePagePublic";

package/src/opik/rest_api/core/api-promise/APIPromise.ts

@@ -1,54 +0,0 @@
-import { APIResponse } from "../fetcher/APIResponse";
-
-/**
- * APIPromise wraps a Promise that resolves with an APIResponse.
- * It provides convenient methods for handling both successful responses and errors.
- *
- * By default, when awaited, it will return just the response body data.
- * Use the `asRaw()` method to get access to both the response data and headers.
- *
- * @example
- * // Get just the response data
- * const data = await apiPromise;
- *
- * // Get response with headers
- * const { data, headers } = await apiPromise.asRaw();
- *
- * @template T The type of the successful response body
- */
-export class APIPromise<T> extends Promise<T> {
-    constructor(
-        private readonly responsePromise: Promise<APIResponse<T, unknown>>,
-        executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void
-    ) {
-        super(executor);
-    }
-
-    public async asRaw(): Promise<{
-        data: T;
-        headers?: Record<string, any>;
-    }> {
-        const response = await this.responsePromise;
-        if (!response.ok) {
-            throw response.error;
-        }
-        return {
-            data: response.body,
-            headers: response.headers,
-        };
-    }
-
-    public static from<T>(responsePromise: Promise<APIResponse<T, unknown>>): APIPromise<T> {
-        return new APIPromise(responsePromise, (resolve, reject) => {
-            responsePromise
-                .then((response) => {
-                    if (response.ok) {
-                        resolve(response.body);
-                    } else {
-                        reject(response.error);
-                    }
-                })
-                .catch(reject);
-        });
-    }
-}

package/src/opik/rest_api/core/api-promise/index.ts

@@ -1 +0,0 @@
-export { APIPromise } from "./APIPromise";

package/src/opik/rest_api/core/fetcher/APIResponse.ts

@@ -1,12 +0,0 @@
-export type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
-
-export interface SuccessfulResponse<T> {
-    ok: true;
-    body: T;
-    headers?: Record<string, any>;
-}
-
-export interface FailedResponse<T> {
-    ok: false;
-    error: T;
-}

package/src/opik/rest_api/core/fetcher/Fetcher.ts

@@ -1,143 +0,0 @@
-import { APIResponse } from "./APIResponse";
-import { createRequestUrl } from "./createRequestUrl";
-import { getFetchFn } from "./getFetchFn";
-import { getRequestBody } from "./getRequestBody";
-import { getResponseBody } from "./getResponseBody";
-import { makeRequest } from "./makeRequest";
-import { requestWithRetries } from "./requestWithRetries";
-
-export type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
-
-export declare namespace Fetcher {
-    export interface Args {
-        url: string;
-        method: string;
-        contentType?: string;
-        headers?: Record<string, string | undefined>;
-        queryParameters?: Record<string, string | string[] | object | object[]>;
-        body?: unknown;
-        timeoutMs?: number;
-        maxRetries?: number;
-        withCredentials?: boolean;
-        abortSignal?: AbortSignal;
-        requestType?: "json" | "file" | "bytes";
-        responseType?: "json" | "blob" | "sse" | "streaming" | "text" | "arrayBuffer";
-        duplex?: "half";
-    }
-
-    export type Error = FailedStatusCodeError | NonJsonError | TimeoutError | UnknownError;
-
-    export interface FailedStatusCodeError {
-        reason: "status-code";
-        statusCode: number;
-        body: unknown;
-    }
-
-    export interface NonJsonError {
-        reason: "non-json";
-        statusCode: number;
-        rawBody: string;
-    }
-
-    export interface TimeoutError {
-        reason: "timeout";
-    }
-
-    export interface UnknownError {
-        reason: "unknown";
-        errorMessage: string;
-    }
-}
-
-export async function fetcherImpl<R = unknown>(args: Fetcher.Args): Promise<APIResponse<R, Fetcher.Error>> {
-    const headers: Record<string, string> = {};
-    if (args.body !== undefined && args.contentType != null) {
-        headers["Content-Type"] = args.contentType;
-    }
-
-    if (args.headers != null) {
-        for (const [key, value] of Object.entries(args.headers)) {
-            if (value != null) {
-                headers[key] = value;
-            }
-        }
-    }
-
-    const url = createRequestUrl(args.url, args.queryParameters);
-    let requestBody: BodyInit | undefined = await getRequestBody({
-        body: args.body,
-        type: args.requestType === "json" ? "json" : "other",
-    });
-    const fetchFn = await getFetchFn();
-
-    try {
-        const response = await requestWithRetries(
-            async () =>
-                makeRequest(
-                    fetchFn,
-                    url,
-                    args.method,
-                    headers,
-                    requestBody,
-                    args.timeoutMs,
-                    args.abortSignal,
-                    args.withCredentials,
-                    args.duplex
-                ),
-            args.maxRetries
-        );
-        let responseBody = await getResponseBody(response, args.responseType);
-
-        if (response.status >= 200 && response.status < 400) {
-            return {
-                ok: true,
-                body: responseBody as R,
-                headers: response.headers,
-            };
-        } else {
-            return {
-                ok: false,
-                error: {
-                    reason: "status-code",
-                    statusCode: response.status,
-                    body: responseBody,
-                },
-            };
-        }
-    } catch (error) {
-        if (args.abortSignal != null && args.abortSignal.aborted) {
-            return {
-                ok: false,
-                error: {
-                    reason: "unknown",
-                    errorMessage: "The user aborted a request",
-                },
-            };
-        } else if (error instanceof Error && error.name === "AbortError") {
-            return {
-                ok: false,
-                error: {
-                    reason: "timeout",
-                },
-            };
-        } else if (error instanceof Error) {
-            return {
-                ok: false,
-                error: {
-                    reason: "unknown",
-                    errorMessage: error.message,
-                },
-            };
-        }
-
-        return {
-            ok: false,
-            error: {
-                reason: "unknown",
-                errorMessage: JSON.stringify(error),
-            },
-        };
-    }
-}
-
-export const fetcher: FetchFunction = fetcherImpl;

package/src/opik/rest_api/core/fetcher/Supplier.ts

@@ -1,11 +0,0 @@
-export type Supplier<T> = T | Promise<T> | (() => T | Promise<T>);
-
-export const Supplier = {
-    get: async <T>(supplier: Supplier<T>): Promise<T> => {
-        if (typeof supplier === "function") {
-            return (supplier as () => T)();
-        } else {
-            return supplier;
-        }
-    },
-};

package/src/opik/rest_api/core/fetcher/createRequestUrl.ts

@@ -1,10 +0,0 @@
-import qs from "qs";
-
-export function createRequestUrl(
-    baseUrl: string,
-    queryParameters?: Record<string, string | string[] | object | object[]>
-): string {
-    return Object.keys(queryParameters ?? {}).length > 0
-        ? `${baseUrl}?${qs.stringify(queryParameters, { arrayFormat: "repeat" })}`
-        : baseUrl;
-}

package/src/opik/rest_api/core/fetcher/getFetchFn.ts

@@ -1,25 +0,0 @@
-import { RUNTIME } from "../runtime";
-
-/**
- * Returns a fetch function based on the runtime
- */
-export async function getFetchFn(): Promise<any> {
-    // In Node.js 18+ environments, use native fetch
-    if (RUNTIME.type === "node" && RUNTIME.parsedVersion != null && RUNTIME.parsedVersion >= 18) {
-        return fetch;
-    }
-
-    // In Node.js 18 or lower environments, the SDK always uses`node-fetch`.
-    if (RUNTIME.type === "node") {
-        return (await import("node-fetch")).default as any;
-    }
-
-    // Otherwise the SDK uses global fetch if available,
-    // and falls back to node-fetch.
-    if (typeof fetch == "function") {
-        return fetch;
-    }
-
-    // Defaults to node `node-fetch` if global fetch isn't available
-    return (await import("node-fetch")).default as any;
-}

package/src/opik/rest_api/core/fetcher/getHeader.ts

@@ -1,8 +0,0 @@
-export function getHeader(headers: Record<string, any>, header: string): string | undefined {
-    for (const [headerKey, headerValue] of Object.entries(headers)) {
-        if (headerKey.toLowerCase() === header.toLowerCase()) {
-            return headerValue;
-        }
-    }
-    return undefined;
-}

package/src/opik/rest_api/core/fetcher/getRequestBody.ts

@@ -1,14 +0,0 @@
-export declare namespace GetRequestBody {
-    interface Args {
-        body: unknown;
-        type: "json" | "file" | "bytes" | "other";
-    }
-}
-
-export async function getRequestBody({ body, type }: GetRequestBody.Args): Promise<BodyInit | undefined> {
-    if (type.includes("json")) {
-        return JSON.stringify(body);
-    } else {
-        return body as BodyInit;
-    }
-}

package/src/opik/rest_api/core/fetcher/getResponseBody.ts

@@ -1,34 +0,0 @@
-import { chooseStreamWrapper } from "./stream-wrappers/chooseStreamWrapper";
-
-export async function getResponseBody(response: Response, responseType?: string): Promise<unknown> {
-    if (response.body != null && responseType === "blob") {
-        return await response.blob();
-    } else if (response.body != null && responseType === "arrayBuffer") {
-        return await response.arrayBuffer();
-    } else if (response.body != null && responseType === "sse") {
-        return response.body;
-    } else if (response.body != null && responseType === "streaming") {
-        return chooseStreamWrapper(response.body);
-    } else if (response.body != null && responseType === "text") {
-        return await response.text();
-    } else {
-        const text = await response.text();
-        if (text.length > 0) {
-            try {
-                let responseBody = JSON.parse(text);
-                return responseBody;
-            } catch (err) {
-                return {
-                    ok: false,
-                    error: {
-                        reason: "non-json",
-                        statusCode: response.status,
-                        rawBody: text,
-                    },
-                };
-            }
-        } else {
-            return undefined;
-        }
-    }
-}

package/src/opik/rest_api/core/fetcher/index.ts

@@ -1,5 +0,0 @@
-export type { APIResponse } from "./APIResponse";
-export { fetcher } from "./Fetcher";
-export type { Fetcher, FetchFunction } from "./Fetcher";
-export { getHeader } from "./getHeader";
-export { Supplier } from "./Supplier";

package/src/opik/rest_api/core/fetcher/makeRequest.ts

@@ -1,44 +0,0 @@
-import { anySignal, getTimeoutSignal } from "./signals";
-
-export const makeRequest = async (
-    fetchFn: (url: string, init: RequestInit) => Promise<Response>,
-    url: string,
-    method: string,
-    headers: Record<string, string>,
-    requestBody: BodyInit | undefined,
-    timeoutMs?: number,
-    abortSignal?: AbortSignal,
-    withCredentials?: boolean,
-    duplex?: "half"
-): Promise<Response> => {
-    const signals: AbortSignal[] = [];
-
-    // Add timeout signal
-    let timeoutAbortId: NodeJS.Timeout | undefined = undefined;
-    if (timeoutMs != null) {
-        const { signal, abortId } = getTimeoutSignal(timeoutMs);
-        timeoutAbortId = abortId;
-        signals.push(signal);
-    }
-
-    // Add arbitrary signal
-    if (abortSignal != null) {
-        signals.push(abortSignal);
-    }
-    let newSignals = anySignal(signals);
-    const response = await fetchFn(url, {
-        method: method,
-        headers,
-        body: requestBody,
-        signal: newSignals,
-        credentials: withCredentials ? "include" : undefined,
-        // @ts-ignore
-        duplex,
-    });
-
-    if (timeoutAbortId != null) {
-        clearTimeout(timeoutAbortId);
-    }
-
-    return response;
-};

package/src/opik/rest_api/core/fetcher/requestWithRetries.ts

@@ -1,33 +0,0 @@
-const INITIAL_RETRY_DELAY = 1000; // in milliseconds
-const MAX_RETRY_DELAY = 60000; // in milliseconds
-const DEFAULT_MAX_RETRIES = 2;
-const JITTER_FACTOR = 0.2; // 20% random jitter
-
-function addJitter(delay: number): number {
-    // Generate a random value between -JITTER_FACTOR and +JITTER_FACTOR
-    const jitterMultiplier = 1 + (Math.random() * 2 - 1) * JITTER_FACTOR;
-    return delay * jitterMultiplier;
-}
-
-export async function requestWithRetries(
-    requestFn: () => Promise<Response>,
-    maxRetries: number = DEFAULT_MAX_RETRIES
-): Promise<Response> {
-    let response: Response = await requestFn();
-
-    for (let i = 0; i < maxRetries; ++i) {
-        if ([408, 409, 429].includes(response.status) || response.status >= 500) {
-            // Calculate base delay using exponential backoff (in milliseconds)
-            const baseDelay = Math.min(INITIAL_RETRY_DELAY * Math.pow(2, i), MAX_RETRY_DELAY);
-
-            // Add jitter to the delay
-            const delayWithJitter = addJitter(baseDelay);
-
-            await new Promise((resolve) => setTimeout(resolve, delayWithJitter));
-            response = await requestFn();
-        } else {
-            break;
-        }
-    }
-    return response!;
-}