# opik - Doramagic AI Context Pack

> Purpose: pre-work context for the user's host AI. This pack does not prove that the project has been installed, run, or validated.

## Project

- canonical_name: `comet-ml/opik`
- capability: Debug, evaluate, and monitor your LLM applications, RAG systems, and agentic workflows with comprehensive tracing, automated evaluations, and production-ready dashboards.
- expected_user_outcome: Debug, evaluate, and monitor your LLM applications, RAG systems, and agentic workflows with comprehensive tracing, automated evaluations, and production-ready dashboards.

## Operating Boundaries

- Do not claim that the project has been installed, run, called through an API, or used on local files unless separate evidence proves it.
- Project facts must come from repo evidence, Claim Graph, or explicit source references.
- When a capability is not verified, mark it as unverified instead of completing it as fact.
- publish_status: `publishable`
- blocking_gaps: none

---

## Doramagic Context Augmentation

The following sections strengthen the repository context for a host AI. Human Manual data is a reading route, and pitfall notes become operating constraints.

## Human Manual Outline

Usage rule: this is only a reading route and salience signal, not factual authority. Concrete claims must still return to repo evidence or Claim Graph.

Host AI hard rules:
- Do not treat page titles, section order, summaries, or importance values as factual project evidence.
- When explaining the Human Manual outline, state that it is only a reading route or salience signal.
- Capability, installation, compatibility, runtime state, and risk claims must cite repo evidence, source paths, or Claim Graph.

- **What is Opik? Platform Overview and Key Capabilities**: importance `high`
  - source_paths: README.md, CHANGELOG.md, apps/opik-backend/src/main/java/com/comet/opik/OpikApplication.java, apps/opik-documentation/documentation/fern/docs-v2/home.mdx
- **System Architecture and Repository Layout**: importance `high`
  - source_paths: apps/opik-backend/pom.xml, apps/opik-backend/src/main/java/com/comet/opik/OpikApplication.java, apps/opik-backend/src/main/java/com/comet/opik/infrastructure/ConfigurationModule.java, apps/opik-frontend/package.json, apps/opik-backend/Dockerfile
- **Tracing, Spans, and Framework Integrations**: importance `high`
  - source_paths: apps/opik-backend/src/main/java/com/comet/opik/api/Trace.java, apps/opik-backend/src/main/java/com/comet/opik/api/Span.java, apps/opik-backend/src/main/java/com/comet/opik/api/TraceBatch.java, apps/opik-backend/src/main/java/com/comet/opik/domain/TraceService.java, apps/opik-backend/src/main/java/com/comet/opik/domain/SpanService.java
- **Evaluation, Datasets, Experiments, and LLM-as-Judge**: importance `high`
  - source_paths: apps/opik-backend/src/main/java/com/comet/opik/api/Dataset.java, apps/opik-backend/src/main/java/com/comet/opik/api/Experiment.java, apps/opik-backend/src/main/java/com/comet/opik/api/FeedbackScore.java, apps/opik-backend/src/main/java/com/comet/opik/api/evaluators/AutomationRuleEvaluator.java, apps/opik-backend/src/main/java/com/comet/opik/domain/DatasetService.java
- **Agent and Prompt Optimization (Opik Optimizer)**: importance `medium`
  - source_paths: apps/opik-backend/src/main/java/com/comet/opik/api/Optimization.java, apps/opik-backend/src/main/java/com/comet/opik/domain/OptimizationService.java, apps/opik-backend/src/main/java/com/comet/opik/api/runner/LocalRunner.java, apps/opik-backend/src/main/java/com/comet/opik/domain/RunnerService.java, apps/opik-backend/src/main/java/com/comet/opik/api/resources/v1/priv/OptimizationsResource.java
- **Frontend Application (React/TypeScript)**: importance `high`
  - source_paths: apps/opik-frontend/src/v1/App.tsx, apps/opik-frontend/src/api/api.ts, apps/opik-frontend/src/v1/pages/HomePage/HomePage.tsx, apps/opik-frontend/src/v1/pages/TracesPage/TracesPage.tsx, apps/opik-frontend/src/v1/pages/ExperimentsPage/ExperimentsPage.tsx
- **Deployment, Self-Hosting, and Operations**: importance `high`
  - source_paths: Makefile, apps/opik-backend/Dockerfile, apps/opik-backend/entrypoint.sh, apps/opik-backend/run_db_migrations.sh, apps/opik-backend/data-migrations/1.0.3/README.md
- **Authentication, Authorization, and Workspaces**: importance `high`
  - source_paths: apps/opik-backend/src/main/java/com/comet/opik/api/resources/v1/priv/AuthenticationResource.java, apps/opik-backend/src/main/java/com/comet/opik/api/resources/v1/priv/WorkspacePermissionsResource.java, apps/opik-backend/src/main/java/com/comet/opik/api/resources/v1/priv/WorkspacesResource.java, apps/opik-backend/src/main/java/com/comet/opik/api/resources/v1/priv/ServiceTogglesResource.java, apps/opik-backend/src/main/java/com/comet/opik/infrastructure/auth/AuthModule.java

## Repo Inspection Evidence

- repo_clone_verified: true
- repo_inspection_verified: true
- repo_commit: `5b48bfd1c02c7c0654c6bb72dc84211c2991306c`
- inspected_files: `README.md`

Host AI hard rules:
- Without repo_clone_verified=true, do not claim that the source code has been read.
- Without repo_inspection_verified=true, do not write README, docs, or package-file conclusions as facts.
- Without quick_start_verified=true, do not claim that the Quick Start path has run successfully.

## Doramagic Pitfall Constraints

These rules come from Doramagic discovery, validation, or compilation findings. The host AI must treat them as operating constraints, not background notes.

### Constraint 1: Capability evidence risk requires verification

- Trigger: README/documentation is current enough for a first validation pass.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: capability.assumptions | https://github.com/comet-ml/opik
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 2: Maintenance risk requires verification

- Trigger: Project evidence flags a maintenance risk. Review the linked source before relying on this workflow.
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: evidence.maintainer_signals | https://github.com/comet-ml/opik
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 3: Security or permission risk requires verification

- Trigger: no_demo
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: downstream_validation.risk_items | https://github.com/comet-ml/opik
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 4: Security or permission risk requires verification

- Trigger: no_demo
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: risks.scoring_risks | https://github.com/comet-ml/opik
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 5: Maintenance risk requires verification

- Trigger: issue_or_pr_quality=unknown。
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: evidence.maintainer_signals | https://github.com/comet-ml/opik
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.

### Constraint 6: Maintenance risk requires verification

- Trigger: release_recency=unknown。
- Host AI rule: Reproduce the official install and quickstart path in an isolated environment.
- Why it matters: May increase setup, validation, or first-run risk for the user.
- Evidence: evidence.maintainer_signals | https://github.com/comet-ml/opik
- Hard boundary: Do not present this pitfall as solved, verified, or ignorable unless later evidence explicitly closes it.