opik 0.0.1

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

@@ -0,0 +1,138 @@
+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/tracer/Span.ts

@@ -0,0 +1,34 @@
+import { OpikClient } from "@/client/Client";
+import type { Span as ISpan, SpanUpdate } from "@/rest_api/api";
+
+export interface SavedSpan extends ISpan {
+  id: string;
+}
+
+export class Span {
+  constructor(
+    private data: SavedSpan,
+    private opik: OpikClient
+  ) {}
+
+  public end = async () => {
+    await this.update({ endTime: new Date() });
+  };
+
+  public update = async (
+    updates: Omit<
+      SpanUpdate,
+      "traceId" | "parentSpanId" | "projectId" | "projectName"
+    >
+  ) => {
+    await this.opik.apiClient.spans
+      .updateSpan(this.data.id, {
+        projectName: this.data.projectName ?? this.opik.config.projectName,
+        traceId: this.data.traceId,
+        ...updates,
+      })
+      .asRaw();
+
+    this.data = { ...this.data, ...updates };
+  };
+}

package/src/opik/tracer/Trace.ts

@@ -0,0 +1,61 @@
+import { OpikClient } from "@/client/Client";
+import type {
+  Span as ISpan,
+  Trace as ITrace,
+  TraceUpdate,
+} from "@/rest_api/api";
+import { v7 as uuid } from "uuid";
+import { SavedSpan, Span } from "./Span";
+
+export interface SavedTrace extends ITrace {
+  id: string;
+}
+
+interface SpanData extends Omit<ISpan, "startTime" | "traceId"> {
+  startTime?: Date;
+}
+
+export class Trace {
+  private spans: Span[] = [];
+
+  constructor(
+    private data: SavedTrace,
+    private opik: OpikClient
+  ) {}
+
+  public end = async () => {
+    await this.update({ endTime: new Date() });
+  };
+
+  public span = async (spanData: SpanData) => {
+    const projectName = spanData.projectName ?? this.opik.config.projectName;
+    const spanWithId: SavedSpan = {
+      id: uuid(),
+      startTime: new Date(),
+      ...spanData,
+      projectName,
+      traceId: this.data.id,
+    };
+
+    await this.opik.loadProject(projectName);
+    await this.opik.apiClient.spans
+      .createSpans({ spans: [spanWithId] })
+      .asRaw();
+
+    const span = new Span(spanWithId, this.opik);
+    this.spans.push(span);
+    return span;
+  };
+
+  public update = async (
+    updates: Omit<TraceUpdate, "projectId" | "projectName">
+  ) => {
+    await this.opik.apiClient.traces
+      .updateTrace(this.data.id, {
+        projectName: this.data.projectName ?? this.opik.config.projectName,
+        ...updates,
+      })
+      .asRaw();
+    this.data = { ...this.data, ...updates };
+  };
+}

package/tests/client.test.ts

@@ -0,0 +1,25 @@
+import { Opik } from "@opik";
+
+describe("OpikApiClient", () => {
+  let client: Opik;
+
+  beforeAll(() => {
+    client = new Opik({
+      projectName: "opik-sdk-typescript",
+    });
+  });
+
+  it("should log a trace and a span", async () => {
+    const someTrace = await client.trace({
+      name: "test",
+    });
+
+    const someSpan = await someTrace.span({
+      name: "test span",
+      type: "llm",
+    });
+
+    await someSpan.end();
+    await someTrace.end();
+  });
+});

package/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "target": "ES2019",
+    "module": "ESNext",
+    "lib": ["ESNext", "DOM"],
+    "declaration": true,
+    "declarationMap": true,
+    "sourceMap": true,
+    "outDir": "dist",
+    "strict": true,
+    "moduleResolution": "Node",
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "types": ["vitest/globals"],
+    "paths": {
+      "@opik": ["./src/opik/index.ts"],
+      "@/*": ["./src/opik/*"],
+      "@tests/*": ["./tests/*"]
+    }
+  },
+  "include": ["src", "tests"],
+  "exclude": ["node_modules"]
+}

package/tsup.config.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from "tsup";
+
+export default defineConfig([
+  {
+    noExternal: ["url-join"],
+    entry: ["src/opik/index.ts"],
+    format: ["cjs", "esm"],
+    outDir: "dist",
+    dts: true,
+  },
+]);

package/vitest.config.ts

@@ -0,0 +1,13 @@
+import { ViteUserConfig } from "vitest/config";
+import tsconfigPaths from "vite-tsconfig-paths";
+
+const config = {
+  plugins: [tsconfigPaths()],
+  test: {
+    globals: true,
+    environment: "node",
+    include: ["tests/**/*.test.ts"],
+  },
+} satisfies ViteUserConfig;
+
+export default config;