opik 0.0.1 → 0.0.2

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "opik",
   "description": "TypeScript SDK for Opik",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "author": {
     "name": "Comet",
     "email": "support@comet.com",
@@ -19,6 +19,17 @@
     "typescript",
     "typescript-sdk"
   ],
+  "files": [
+    "dist/**/*"
+  ],
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
   "main": "dist/index.cjs",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",

package/examples/manual-trace.js

@@ -1,16 +0,0 @@
-import { Opik } from "opik";
-
-const client = new Opik();
-const someTrace = await client.trace({
-  name: "test123",
-  startTime: new Date(),
-});
-
-const someSpan = await someTrace.span({
-  name: "test123 span",
-  type: "llm",
-  startTime: new Date(),
-});
-
-await someSpan.end();
-await someTrace.end();

package/src/opik/client/Client.ts

@@ -1,65 +0,0 @@
-import { loadConfig, OpikConfig } from "@/config/Config";
-import { OpikApiClient } from "@/rest_api";
-import type { Trace as ITrace, ProjectPublic } from "@/rest_api/api";
-import { SavedTrace, Trace } from "@/tracer/Trace";
-import { v7 as uuid } from "uuid";
-
-interface TraceData extends Omit<ITrace, "startTime"> {
-  startTime?: Date;
-}
-
-export class OpikClient {
-  public apiClient: OpikApiClient;
-  public config: OpikConfig;
-  private existingProjects: Map<string, ProjectPublic> = new Map();
-
-  constructor(explicitConfig?: Partial<OpikConfig>) {
-    this.config = loadConfig(explicitConfig);
-
-    this.apiClient = new OpikApiClient({
-      apiKey: this.config.apiKey,
-      environment: this.config.host,
-      workspaceName: this.config.workspaceName,
-    });
-  }
-  public loadProject = async (projectName: string): Promise<ProjectPublic> => {
-    if (this.existingProjects.has(projectName)) {
-      return this.existingProjects.get(projectName)!;
-    }
-
-    const { data: projectsPage } = await this.apiClient.projects
-      .findProjects({ name: projectName })
-      .asRaw();
-
-    const project = projectsPage.content?.find((p) => p.name === projectName);
-
-    if (project) {
-      this.existingProjects.set(projectName, project);
-    } else {
-      await this.apiClient.projects
-        .createProject({
-          name: projectName,
-        })
-        .asRaw();
-
-      return this.loadProject(projectName);
-    }
-
-    return project;
-  };
-
-  public trace = async (trace: TraceData) => {
-    const projectName = trace.projectName ?? this.config.projectName;
-    const traceWithId: SavedTrace = {
-      id: uuid(),
-      startTime: new Date(),
-      ...trace,
-      projectName,
-    };
-
-    await this.loadProject(projectName);
-    await this.apiClient.traces.createTrace(traceWithId).asRaw();
-
-    return new Trace(traceWithId, this);
-  };
-}

package/src/opik/config/Config.ts

@@ -1,35 +0,0 @@
-export interface OpikConfig {
-  apiKey: string;
-  host?: string;
-  projectName: string;
-  useBatching?: boolean;
-  workspaceName: string;
-}
-
-const DEFAULT_CONFIG: OpikConfig = {
-  apiKey: "",
-  host: "http://localhost:5173/api",
-  projectName: "Default project",
-  useBatching: false,
-  workspaceName: "default",
-};
-
-function loadFromEnv(): Partial<OpikConfig> {
-  return {
-    apiKey: process.env.OPIK_API_KEY,
-    host: process.env.OPIK_HOST,
-    projectName: process.env.OPIK_PROJECT_NAME,
-    useBatching: process.env.OPIK_USE_BATCHING === "true",
-    workspaceName: process.env.OPIK_WORKSPACE,
-  };
-}
-
-export function loadConfig(explicit?: Partial<OpikConfig>): OpikConfig {
-  const envConfig = loadFromEnv();
-
-  return {
-    ...DEFAULT_CONFIG,
-    ...envConfig,
-    ...explicit,
-  };
-}

package/src/opik/index.ts

@@ -1,2 +0,0 @@
-export { OpikClient as Opik } from "@/client/Client";
-export { OpikConfig } from "@/config/Config";

package/src/opik/rest_api/Client.ts

@@ -1,247 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-import * as environments from "./environments";
-import * as core from "./core";
-import urlJoin from "url-join";
-import * as errors from "./errors/index";
-import { SystemUsage } from "./api/resources/systemUsage/client/Client";
-import { Check } from "./api/resources/check/client/Client";
-import { ChatCompletions } from "./api/resources/chatCompletions/client/Client";
-import { Datasets } from "./api/resources/datasets/client/Client";
-import { Experiments } from "./api/resources/experiments/client/Client";
-import { FeedbackDefinitions } from "./api/resources/feedbackDefinitions/client/Client";
-import { LlmProviderKey } from "./api/resources/llmProviderKey/client/Client";
-import { Projects } from "./api/resources/projects/client/Client";
-import { Prompts } from "./api/resources/prompts/client/Client";
-import { Spans } from "./api/resources/spans/client/Client";
-import { Traces } from "./api/resources/traces/client/Client";
-
-export declare namespace OpikApiClient {
-    interface Options {
-        environment?: core.Supplier<environments.OpikApiEnvironment | string>;
-        /** Override the Authorization header */
-        apiKey?: core.Supplier<string | undefined>;
-        /** Override the Comet-Workspace header */
-        workspaceName?: core.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>;
-    }
-}
-
-export class OpikApiClient {
-    constructor(protected readonly _options: OpikApiClient.Options = {}) {}
-
-    /**
-     * @param {OpikApiClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.isAlive()
-     */
-    public isAlive(requestOptions?: OpikApiClient.RequestOptions): core.APIPromise<unknown> {
-        return core.APIPromise.from(
-            (async () => {
-                const _response = await core.fetcher({
-                    url: urlJoin(
-                        (await core.Supplier.get(this._options.environment)) ?? environments.OpikApiEnvironment.Default,
-                        "is-alive/ping"
-                    ),
-                    method: "GET",
-                    headers: {
-                        "Comet-Workspace":
-                            (await core.Supplier.get(this._options.workspaceName)) != null
-                                ? await core.Supplier.get(this._options.workspaceName)
-                                : undefined,
-                        "X-Fern-Language": "JavaScript",
-                        "X-Fern-Runtime": core.RUNTIME.type,
-                        "X-Fern-Runtime-Version": core.RUNTIME.version,
-                        ...(await this._getCustomAuthorizationHeaders()),
-                        ...requestOptions?.headers,
-                    },
-                    contentType: "application/json",
-                    requestType: "json",
-                    timeoutMs:
-                        requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                    maxRetries: requestOptions?.maxRetries,
-                    withCredentials: true,
-                    abortSignal: requestOptions?.abortSignal,
-                });
-                if (_response.ok) {
-                    return {
-                        ok: _response.ok,
-                        body: _response.body,
-                        headers: _response.headers,
-                    };
-                }
-                if (_response.error.reason === "status-code") {
-                    throw new errors.OpikApiError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.body,
-                    });
-                }
-                switch (_response.error.reason) {
-                    case "non-json":
-                        throw new errors.OpikApiError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.rawBody,
-                        });
-                    case "timeout":
-                        throw new errors.OpikApiTimeoutError("Timeout exceeded when calling GET /is-alive/ping.");
-                    case "unknown":
-                        throw new errors.OpikApiError({
-                            message: _response.error.errorMessage,
-                        });
-                }
-            })()
-        );
-    }
-
-    /**
-     * @param {OpikApiClient.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.version()
-     */
-    public version(requestOptions?: OpikApiClient.RequestOptions): core.APIPromise<unknown> {
-        return core.APIPromise.from(
-            (async () => {
-                const _response = await core.fetcher({
-                    url: urlJoin(
-                        (await core.Supplier.get(this._options.environment)) ?? environments.OpikApiEnvironment.Default,
-                        "is-alive/ver"
-                    ),
-                    method: "GET",
-                    headers: {
-                        "Comet-Workspace":
-                            (await core.Supplier.get(this._options.workspaceName)) != null
-                                ? await core.Supplier.get(this._options.workspaceName)
-                                : undefined,
-                        "X-Fern-Language": "JavaScript",
-                        "X-Fern-Runtime": core.RUNTIME.type,
-                        "X-Fern-Runtime-Version": core.RUNTIME.version,
-                        ...(await this._getCustomAuthorizationHeaders()),
-                        ...requestOptions?.headers,
-                    },
-                    contentType: "application/json",
-                    requestType: "json",
-                    timeoutMs:
-                        requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                    maxRetries: requestOptions?.maxRetries,
-                    withCredentials: true,
-                    abortSignal: requestOptions?.abortSignal,
-                });
-                if (_response.ok) {
-                    return {
-                        ok: _response.ok,
-                        body: _response.body,
-                        headers: _response.headers,
-                    };
-                }
-                if (_response.error.reason === "status-code") {
-                    throw new errors.OpikApiError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.body,
-                    });
-                }
-                switch (_response.error.reason) {
-                    case "non-json":
-                        throw new errors.OpikApiError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.rawBody,
-                        });
-                    case "timeout":
-                        throw new errors.OpikApiTimeoutError("Timeout exceeded when calling GET /is-alive/ver.");
-                    case "unknown":
-                        throw new errors.OpikApiError({
-                            message: _response.error.errorMessage,
-                        });
-                }
-            })()
-        );
-    }
-
-    protected _systemUsage: SystemUsage | undefined;
-
-    public get systemUsage(): SystemUsage {
-        return (this._systemUsage ??= new SystemUsage(this._options));
-    }
-
-    protected _check: Check | undefined;
-
-    public get check(): Check {
-        return (this._check ??= new Check(this._options));
-    }
-
-    protected _chatCompletions: ChatCompletions | undefined;
-
-    public get chatCompletions(): ChatCompletions {
-        return (this._chatCompletions ??= new ChatCompletions(this._options));
-    }
-
-    protected _datasets: Datasets | undefined;
-
-    public get datasets(): Datasets {
-        return (this._datasets ??= new Datasets(this._options));
-    }
-
-    protected _experiments: Experiments | undefined;
-
-    public get experiments(): Experiments {
-        return (this._experiments ??= new Experiments(this._options));
-    }
-
-    protected _feedbackDefinitions: FeedbackDefinitions | undefined;
-
-    public get feedbackDefinitions(): FeedbackDefinitions {
-        return (this._feedbackDefinitions ??= new FeedbackDefinitions(this._options));
-    }
-
-    protected _llmProviderKey: LlmProviderKey | undefined;
-
-    public get llmProviderKey(): LlmProviderKey {
-        return (this._llmProviderKey ??= new LlmProviderKey(this._options));
-    }
-
-    protected _projects: Projects | undefined;
-
-    public get projects(): Projects {
-        return (this._projects ??= new Projects(this._options));
-    }
-
-    protected _prompts: Prompts | undefined;
-
-    public get prompts(): Prompts {
-        return (this._prompts ??= new Prompts(this._options));
-    }
-
-    protected _spans: Spans | undefined;
-
-    public get spans(): Spans {
-        return (this._spans ??= new Spans(this._options));
-    }
-
-    protected _traces: Traces | undefined;
-
-    public get traces(): Traces {
-        return (this._traces ??= new Traces(this._options));
-    }
-
-    protected async _getCustomAuthorizationHeaders() {
-        const apiKeyValue = await core.Supplier.get(this._options.apiKey);
-        return { Authorization: apiKeyValue };
-    }
-}

package/src/opik/rest_api/api/errors/BadRequestError.ts

@@ -1,16 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-import * as errors from "../../errors/index";
-
-export class BadRequestError extends errors.OpikApiError {
-    constructor(body?: unknown) {
-        super({
-            message: "BadRequestError",
-            statusCode: 400,
-            body: body,
-        });
-        Object.setPrototypeOf(this, BadRequestError.prototype);
-    }
-}

package/src/opik/rest_api/api/errors/ConflictError.ts

@@ -1,16 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-import * as errors from "../../errors/index";
-
-export class ConflictError extends errors.OpikApiError {
-    constructor(body?: unknown) {
-        super({
-            message: "ConflictError",
-            statusCode: 409,
-            body: body,
-        });
-        Object.setPrototypeOf(this, ConflictError.prototype);
-    }
-}

package/src/opik/rest_api/api/errors/ForbiddenError.ts

@@ -1,17 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-import * as errors from "../../errors/index";
-import * as OpikApi from "../index";
-
-export class ForbiddenError extends errors.OpikApiError {
-    constructor(body: OpikApi.ErrorMessage) {
-        super({
-            message: "ForbiddenError",
-            statusCode: 403,
-            body: body,
-        });
-        Object.setPrototypeOf(this, ForbiddenError.prototype);
-    }
-}

package/src/opik/rest_api/api/errors/NotFoundError.ts

@@ -1,16 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-import * as errors from "../../errors/index";
-
-export class NotFoundError extends errors.OpikApiError {
-    constructor(body?: unknown) {
-        super({
-            message: "NotFoundError",
-            statusCode: 404,
-            body: body,
-        });
-        Object.setPrototypeOf(this, NotFoundError.prototype);
-    }
-}

package/src/opik/rest_api/api/errors/NotImplementedError.ts

@@ -1,16 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-import * as errors from "../../errors/index";
-
-export class NotImplementedError extends errors.OpikApiError {
-    constructor(body?: unknown) {
-        super({
-            message: "NotImplementedError",
-            statusCode: 501,
-            body: body,
-        });
-        Object.setPrototypeOf(this, NotImplementedError.prototype);
-    }
-}

package/src/opik/rest_api/api/errors/UnauthorizedError.ts

@@ -1,17 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-import * as errors from "../../errors/index";
-import * as OpikApi from "../index";
-
-export class UnauthorizedError extends errors.OpikApiError {
-    constructor(body: OpikApi.ErrorMessage) {
-        super({
-            message: "UnauthorizedError",
-            statusCode: 401,
-            body: body,
-        });
-        Object.setPrototypeOf(this, UnauthorizedError.prototype);
-    }
-}

package/src/opik/rest_api/api/errors/UnprocessableEntityError.ts

@@ -1,16 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-import * as errors from "../../errors/index";
-
-export class UnprocessableEntityError extends errors.OpikApiError {
-    constructor(body?: unknown) {
-        super({
-            message: "UnprocessableEntityError",
-            statusCode: 422,
-            body: body,
-        });
-        Object.setPrototypeOf(this, UnprocessableEntityError.prototype);
-    }
-}

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

@@ -1,7 +0,0 @@
-export * from "./UnauthorizedError";
-export * from "./ForbiddenError";
-export * from "./NotFoundError";
-export * from "./BadRequestError";
-export * from "./UnprocessableEntityError";
-export * from "./ConflictError";
-export * from "./NotImplementedError";

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

@@ -1,3 +0,0 @@
-export * from "./resources";
-export * from "./types";
-export * from "./errors";

package/src/opik/rest_api/api/resources/chatCompletions/client/Client.ts

@@ -1,125 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-
-import * as environments from "../../../../environments";
-import * as core from "../../../../core";
-import * as OpikApi from "../../../index";
-import * as serializers from "../../../../serialization/index";
-import urlJoin from "url-join";
-import * as errors from "../../../../errors/index";
-
-export declare namespace ChatCompletions {
-    interface Options {
-        environment?: core.Supplier<environments.OpikApiEnvironment | string>;
-        /** Override the Authorization header */
-        apiKey?: core.Supplier<string | undefined>;
-        /** Override the Comet-Workspace header */
-        workspaceName?: core.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>;
-    }
-}
-
-/**
- * Chat Completions related resources
- */
-export class ChatCompletions {
-    constructor(protected readonly _options: ChatCompletions.Options = {}) {}
-
-    /**
-     * Create chat completions
-     *
-     * @param {OpikApi.ChatCompletionRequest} request
-     * @param {ChatCompletions.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.chatCompletions.createChatCompletions()
-     */
-    public createChatCompletions(
-        request: OpikApi.ChatCompletionRequest = {},
-        requestOptions?: ChatCompletions.RequestOptions
-    ): core.APIPromise<OpikApi.ChatCompletionResponse> {
-        return core.APIPromise.from(
-            (async () => {
-                const _response = await core.fetcher({
-                    url: urlJoin(
-                        (await core.Supplier.get(this._options.environment)) ?? environments.OpikApiEnvironment.Default,
-                        "v1/private/chat/completions"
-                    ),
-                    method: "POST",
-                    headers: {
-                        "Comet-Workspace":
-                            (await core.Supplier.get(this._options.workspaceName)) != null
-                                ? await core.Supplier.get(this._options.workspaceName)
-                                : undefined,
-                        "X-Fern-Language": "JavaScript",
-                        "X-Fern-Runtime": core.RUNTIME.type,
-                        "X-Fern-Runtime-Version": core.RUNTIME.version,
-                        ...(await this._getCustomAuthorizationHeaders()),
-                        ...requestOptions?.headers,
-                    },
-                    contentType: "application/json",
-                    requestType: "json",
-                    body: serializers.ChatCompletionRequest.jsonOrThrow(request, { unrecognizedObjectKeys: "strip" }),
-                    timeoutMs:
-                        requestOptions?.timeoutInSeconds != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
-                    maxRetries: requestOptions?.maxRetries,
-                    withCredentials: true,
-                    abortSignal: requestOptions?.abortSignal,
-                });
-                if (_response.ok) {
-                    return {
-                        ok: _response.ok,
-                        body: serializers.ChatCompletionResponse.parseOrThrow(_response.body, {
-                            unrecognizedObjectKeys: "passthrough",
-                            allowUnrecognizedUnionMembers: true,
-                            allowUnrecognizedEnumValues: true,
-                            breadcrumbsPrefix: ["response"],
-                        }),
-                        headers: _response.headers,
-                    };
-                }
-                if (_response.error.reason === "status-code") {
-                    throw new errors.OpikApiError({
-                        statusCode: _response.error.statusCode,
-                        body: _response.error.body,
-                    });
-                }
-                switch (_response.error.reason) {
-                    case "non-json":
-                        throw new errors.OpikApiError({
-                            statusCode: _response.error.statusCode,
-                            body: _response.error.rawBody,
-                        });
-                    case "timeout":
-                        throw new errors.OpikApiTimeoutError(
-                            "Timeout exceeded when calling POST /v1/private/chat/completions."
-                        );
-                    case "unknown":
-                        throw new errors.OpikApiError({
-                            message: _response.error.errorMessage,
-                        });
-                }
-            })()
-        );
-    }
-
-    protected async _getCustomAuthorizationHeaders() {
-        const apiKeyValue = await core.Supplier.get(this._options.apiKey);
-        return { Authorization: apiKeyValue };
-    }
-}

package/src/opik/rest_api/api/resources/chatCompletions/client/index.ts

@@ -1 +0,0 @@
-export * from "./requests";