\n\nThe Opik TypeScript SDK allows you to integrate your TypeScript and JavaScript applications with the Opik platform, enabling comprehensive tracing, evaluation, and monitoring of your LLM systems. Opik helps you build, evaluate, and optimize LLM systems that run better, faster, and cheaper.\n\nOpik is an open-source LLM evaluation platform by [Comet](https://www.comet.com?from=llm&utm_source=opik&utm_medium=github&utm_content=ts_sdk_readme&utm_campaign=opik). For more information about the broader Opik ecosystem, visit our main [GitHub repository](https://github.com/comet-ml/opik), [Website](https://www.comet.com/site/products/opik/), or [Documentation](https://www.comet.com/docs/opik/).\n\n## Installation\n\nYou can install the `opik` package using your favorite package manager.\n\n```bash\nnpm install opik\n```\n\n## Opik Configuration\n\nYou can configure the Opik client using environment variables.\n\n`.env` file:\n\n```bash\nOPIK_API_KEY=\"your-api-key\"\nOPIK_URL_OVERRIDE=\"https://www.comet.com/opik/api\"\nOPIK_PROJECT_NAME=\"your-project-name\"\nOPIK_WORKSPACE=\"your-workspace-name\"\n```\n\nOr you can pass the configuration to the Opik client constructor.\n\n```typescript\nimport { Opik } from \"opik\";\n\nconst client = new Opik({\n apiKey: \"\",\n apiUrl: \"https://www.comet.com/opik/api\",\n projectName: \"\",\n workspaceName: \"\",\n});\n```\n\n## Usage\n\n```typescript\nimport { Opik } from \"opik\";\n\n// Create a new Opik client with your configuration\nconst client = new Opik();\n\n// Log 10 traces\nfor (let i = 0; i < 10; i++) {\n const someTrace = client.trace({\n name: `Trace ${i}`,\n input: {\n prompt: `Hello, world! ${i}`,\n },\n output: {\n response: `Hello, world! ${i}`,\n },\n });\n\n // For each trace, log 10 spans\n for (let j = 0; j < 10; j++) {\n const someSpan = someTrace.span({\n name: `Span ${i}-${j}`,\n type: \"llm\",\n input: {\n prompt: `Hello, world! ${i}:${j}`,\n },\n output: {\n response: `Hello, world! ${i}:${j}`,\n },\n });\n\n // Some LLM work\n await new Promise((resolve) => setTimeout(resolve, 100));\n\n // Mark the span as ended\n someSpan.end();\n }\n\n // Mark the trace as ended\n someTrace.end();\n}\n\n// Flush the client to send all traces and spans\nawait client.flush();\n```\n\n## Integrations\n\nOpik provides seamless integrations with popular AI frameworks and tools. Check out our integration packages:\n\n- **Vercel AI** - [`opik-vercel`](https://www.npmjs.com/package/opik-vercel)\n- **OpenAI** - [`opik-openai`](https://www.npmjs.com/package/opik-openai)\n- **LangChain** - [`opik-langchain`](https://www.npmjs.com/package/opik-langchain)\n- **Google Gemini** - [`opik-gemini`](https://www.npmjs.com/package/opik-gemini)\n\n## Contributing\n\nContributions are welcome! If you have any suggestions or improvements, please feel free to open an [issue](https://github.com/comet-ml/opik/issues) or submit a [pull request](https://github.com/comet-ml/opik/pulls).\n\n## License\n\nThis project is licensed under the [Apache License 2.0](https://github.com/comet-ml/opik/blob/main/LICENSE).\n","readmeFilename":"README.md"}
![\"Comet](\"https://raw.githubusercontent.com/comet-ml/opik/refs/heads/main/apps/opik-documentation/documentation/static/img/opik-logo.svg\")
\n ![\"NPM](\"https://img.shields.io/npm/v/opik.svg\")
\n ![\"NPM](\"https://img.shields.io/npm/dt/opik.svg\")
\n ![\"License\"](\"https://img.shields.io/github/license/comet-ml/opik\")