5a558eb09e
TypeScript SDK Compatibility V1.x E2E Tests / Select Node version matrix (push) Has been cancelled
TypeScript SDK Compatibility V1.x E2E Tests / TypeScript SDK Compatibility V1.x E2E Tests Node ${{matrix.node_version}} (push) Has been cancelled
TypeScript SDK E2E Tests / TypeScript SDK E2E Tests Node ${{matrix.node_version}} (push) Has been cancelled
Opik Optimizer - E2E Tests / build-opik (push) Has been cancelled
TypeScript SDK Compatibility V1.x E2E Tests / build-opik (push) Has been cancelled
Python SDK E2E Tests / Select Python version matrix (push) Has been cancelled
Python SDK E2E Tests / Python SDK E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Python SDK E2E Tests / build-opik (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / Select Python version matrix (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / Python SDK Compatibility V1.x E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Python SDK Compatibility V1.x E2E Tests / build-opik (push) Has been cancelled
TypeScript SDK E2E Tests / Select Node version matrix (push) Has been cancelled
TypeScript SDK E2E Tests / build-opik (push) Has been cancelled
Opik Optimizer - E2E Tests / Opik Optimizer E2E Tests Python ${{matrix.python_version}} (push) Has been cancelled
Opik Optimizer - E2E Tests / Opik Optimizer Integration Smoke Tests (push) Has been cancelled
🐙 Code Quality / detect (push) Has been cancelled
🐙 Code Quality / lint (${{ matrix.leg.name }}) (push) Has been cancelled
🐙 Code Quality / summary (push) Has been cancelled
TypeScript SDK Library Integration Tests / Check Secrets (push) Has been cancelled
TypeScript SDK Library Integration Tests / opik-vercel (Vercel AI SDK / eve) (push) Has been cancelled
SDK Library Integration Tests Runner / Check Secrets (push) Has been cancelled
SDK Library Integration Tests Runner / Missed OpenAI API Key Warning (push) Has been cancelled
SDK Library Integration Tests Runner / Build (push) Has been cancelled
SDK Library Integration Tests Runner / openai_tests (push) Has been cancelled
SDK Library Integration Tests Runner / langchain_tests (push) Has been cancelled
SDK Library Integration Tests Runner / langchain_legacy_tests (push) Has been cancelled
SDK Library Integration Tests Runner / llama_index_tests (push) Has been cancelled
SDK Library Integration Tests Runner / anthropic_tests (push) Has been cancelled
SDK Library Integration Tests Runner / mistral_tests (push) Has been cancelled
SDK Library Integration Tests Runner / groq_tests (push) Has been cancelled
SDK Library Integration Tests Runner / aisuite_tests (push) Has been cancelled
SDK Library Integration Tests Runner / haystack_tests (push) Has been cancelled
SDK Library Integration Tests Runner / dspy_tests (push) Has been cancelled
SDK Library Integration Tests Runner / crewai_v0_tests (push) Has been cancelled
SDK Library Integration Tests Runner / crewai_v1_tests (push) Has been cancelled
SDK Library Integration Tests Runner / genai_tests (push) Has been cancelled
SDK Library Integration Tests Runner / adk_tests (push) Has been cancelled
SDK Library Integration Tests Runner / adk_legacy_1_3_0_tests (push) Has been cancelled
SDK Library Integration Tests Runner / evaluation_metrics_tests (push) Has been cancelled
SDK Library Integration Tests Runner / bedrock_tests (push) Has been cancelled
SDK Library Integration Tests Runner / litellm_tests (push) Has been cancelled
SDK Library Integration Tests Runner / harbor_tests (push) Has been cancelled
SDK Library Integration Tests Runner / Slack Notification (push) Has been cancelled
Lint Opik Helm Chart / render-equality (push) Has been cancelled
Opik Optimizer - Unit Tests / Opik Optimizer Unit Tests Python ${{matrix.python_version}} (push) Has been cancelled
Python BE E2E Tests / Python BE E2E (push) Has been cancelled
Python Backend Tests / run-python-backend-tests (push) Has been cancelled
Python SDK Unit Tests / Python SDK Unit Tests ${{matrix.python_version}} (push) Has been cancelled
Release Drafter / update_release_draft (push) Has been cancelled
SDK E2E Libraries Integration Tests / Check Secrets (push) Has been cancelled
SDK E2E Libraries Integration Tests / Missed OpenAI API Key Warning (push) Has been cancelled
SDK E2E Libraries Integration Tests / build-opik (push) Has been cancelled
SDK E2E Libraries Integration Tests / E2E Lib Integration Python ${{matrix.python_version}} (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-gemini) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-langchain) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-openai) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-otel) (push) Has been cancelled
TypeScript SDK Integration Build & Publish / build-and-publish (opik-vercel) (push) Has been cancelled
TypeScript SDK Build & Publish / build-and-publish (push) Has been cancelled
TypeScript SDK Unit Tests / Test on Node ${{ matrix.node-version }} (push) Has been cancelled
Backend Tests / discover-tests (push) Has been cancelled
Backend Tests / ${{ matrix.name }} (push) Has been cancelled
Build and Publish SDK / build-and-publish (push) Has been cancelled
Build Opik Docker Images / set-version (push) Has been cancelled
Build Opik Docker Images / build-backend (push) Has been cancelled
Build Opik Docker Images / build-sandbox-executor-python (push) Has been cancelled
Build Opik Docker Images / build-python-backend (push) Has been cancelled
Build Opik Docker Images / build-frontend (push) Has been cancelled
Build Opik Docker Images / create-git-tag (push) Has been cancelled
ClickHouse Migration Cluster Check / validate-clickhouse-migrations (push) Has been cancelled
Docs - Publish / run (push) Has been cancelled
E2E Tests - Post Merge (v2) / 🧪 E2E v2 Tests (${{ github.event.inputs.tier || 't1' }}) (push) Has been cancelled
E2E Tests - Post Merge (v2) / 📢 Slack Notification (push) Has been cancelled
Frontend Unit Tests / Test on Node 20 (push) Has been cancelled
Guardrails E2E Tests / Select Python version matrix (push) Has been cancelled
Guardrails E2E Tests / Guardrails E2E Tests ${{matrix.python_version}} (push) Has been cancelled
Guardrails E2E Tests / 📢 Slack Notification (push) Has been cancelled
Guardrails Backend Unit Tests / Guardrails Backend Unit Tests (push) Has been cancelled
Guardrails Backend Unit Tests / 📢 Slack Notification (push) Has been cancelled
Lint Opik Helm Chart / lint-helm-chart (Helm v3.21.0) (push) Has been cancelled
Lint Opik Helm Chart / lint-helm-chart (Helm v4.2.0) (push) Has been cancelled
Lint Opik Helm Chart / unittest-helm-chart (push) Has been cancelled
164 lines
5.9 KiB
Plaintext
164 lines
5.9 KiB
Plaintext
---
|
|
description: Learn how to integrate Helicone with Opik to log and monitor your LLM traffic using the standard Helicone integration setup.
|
|
headline: Helicone | Opik Documentation
|
|
og:description: Learn to integrate Helicone with Opik using the OpenAI SDK wrapper to log all LLM calls for comprehensive observability.
|
|
og:site_name: Opik Documentation
|
|
og:title: Integrate Helicone with Opik for LLM Observability
|
|
title: Observability for Helicone with Opik
|
|
canonical-url: https://www.comet.com/docs/opik/integrations/helicone
|
|
---
|
|
|
|
[Helicone](https://www.helicone.ai/) is an open-source LLM observability platform that provides monitoring, logging, and analytics for LLM applications. It acts as a proxy layer between your application and LLM providers, offering features like request logging, caching, rate limiting, and cost tracking.
|
|
|
|
## Gateway Overview
|
|
|
|
Helicone provides a comprehensive observability layer for LLM applications with features including:
|
|
|
|
- **Unified API**: OpenAI-compatible API with access to 100+ models through Helicone's model registry
|
|
- **Intelligent Routing**: Automatic failures and fallbacks across providers to ensure reliability
|
|
- **No Rate Limits**: Skip provider tier restrictions with zero markup on credits
|
|
- **Request Logging**: Automatic logging of all LLM requests and responses
|
|
- **Caching**: Reduce costs and improve latency with semantic caching
|
|
- **Cost Tracking**: Monitor spending across different models and providers with unified observability
|
|
- **Multi-Provider Support**: Works with OpenAI, Anthropic, Azure OpenAI, and more
|
|
|
|
## Account Setup
|
|
|
|
[Comet](https://www.comet.com/site?from=llm&utm_source=opik&utm_medium=colab&utm_content=helicone&utm_campaign=opik) provides a hosted version of the Opik platform. [Simply create an account](https://www.comet.com/signup?from=llm&utm_source=opik&utm_medium=colab&utm_content=helicone&utm_campaign=opik) and grab your API Key.
|
|
|
|
> You can also run the Opik platform locally, see the [installation guide](https://www.comet.com/docs/opik/self-host/overview/?from=llm&utm_source=opik&utm_medium=colab&utm_content=helicone&utm_campaign=opik) for more information.
|
|
|
|
## Getting Started
|
|
|
|
### Installation
|
|
|
|
First, ensure you have both `opik` and `openai` packages installed:
|
|
|
|
```bash
|
|
pip install opik openai
|
|
```
|
|
|
|
### Configuring Opik
|
|
|
|
Configure the Opik Python SDK for your deployment type. See the [Python SDK Configuration guide](/v1/tracing/sdk_configuration) for detailed instructions on:
|
|
|
|
- **CLI configuration**: `opik configure`
|
|
- **Code configuration**: `opik.configure()`
|
|
- **Self-hosted vs Cloud vs Enterprise** setup
|
|
- **Configuration files** and environment variables
|
|
|
|
### Configuring Helicone
|
|
|
|
You'll need a Helicone API key. You can get one by signing up at [Helicone](https://www.helicone.ai/).
|
|
|
|
Set your API key as an environment variable:
|
|
|
|
```bash
|
|
export HELICONE_API_KEY="YOUR_HELICONE_API_KEY"
|
|
```
|
|
|
|
Or set it programmatically:
|
|
|
|
```python
|
|
import os
|
|
import getpass
|
|
|
|
if "HELICONE_API_KEY" not in os.environ:
|
|
os.environ["HELICONE_API_KEY"] = getpass.getpass("Enter your Helicone API key: ")
|
|
|
|
```
|
|
|
|
## Logging LLM Calls
|
|
|
|
Since Helicone provides an OpenAI-compatible proxy, we can use the [Opik OpenAI SDK wrapper](/v1/integrations/openai) to automatically log Helicone calls as generations in Opik.
|
|
|
|
### Simple LLM Call
|
|
|
|
```python
|
|
import os
|
|
from opik.integrations.openai import track_openai
|
|
from openai import OpenAI
|
|
|
|
# Create an OpenAI client with Helicone's base URL
|
|
client = OpenAI(
|
|
api_key=os.environ["HELICONE_API_KEY"],
|
|
base_url="https://ai-gateway.helicone.ai"
|
|
)
|
|
|
|
# Wrap the client with Opik tracking
|
|
client = track_openai(client, project_name="helicone-integration-demo")
|
|
|
|
# Make a chat completion request
|
|
response = client.chat.completions.create(
|
|
model="gpt-3.5-turbo",
|
|
messages=[
|
|
{"role": "system", "content": "You are a knowledgeable AI assistant."},
|
|
{"role": "user", "content": "What is the largest city in France?"}
|
|
]
|
|
)
|
|
|
|
# Print the assistant's reply
|
|
print(response.choices[0].message.content)
|
|
```
|
|
|
|
## Advanced Usage
|
|
|
|
### Using with the `@track` decorator
|
|
|
|
If you have multiple steps in your LLM pipeline, you can use the `@track` decorator to log the traces for each step. If Helicone is called within one of these steps, the LLM call will be associated with that corresponding step:
|
|
|
|
```python
|
|
import os
|
|
from opik import track
|
|
from opik.integrations.openai import track_openai
|
|
from openai import OpenAI
|
|
|
|
# Create and wrap the OpenAI client with Helicone's base URL
|
|
client = OpenAI(
|
|
api_key=os.environ["HELICONE_API_KEY"],
|
|
base_url="https://ai-gateway.helicone.ai"
|
|
)
|
|
client = track_openai(client)
|
|
|
|
@track
|
|
def generate_response(prompt: str):
|
|
response = client.chat.completions.create(
|
|
model="gpt-3.5-turbo",
|
|
messages=[
|
|
{"role": "system", "content": "You are a knowledgeable AI assistant."},
|
|
{"role": "user", "content": prompt}
|
|
]
|
|
)
|
|
return response.choices[0].message.content
|
|
|
|
@track
|
|
def refine_response(initial_response: str):
|
|
response = client.chat.completions.create(
|
|
model="gpt-4",
|
|
messages=[
|
|
{"role": "system", "content": "You enhance and polish text responses."},
|
|
{"role": "user", "content": f"Please improve this response: {initial_response}"}
|
|
]
|
|
)
|
|
return response.choices[0].message.content
|
|
|
|
@track(project_name="helicone-integration-demo")
|
|
def generate_and_refine(prompt: str):
|
|
# First LLM call: Generate initial response
|
|
initial = generate_response(prompt)
|
|
|
|
# Second LLM call: Refine the response
|
|
refined = refine_response(initial)
|
|
|
|
return refined
|
|
|
|
# Example usage
|
|
result = generate_and_refine("Explain quantum computing in simple terms.")
|
|
```
|
|
|
|
The trace will show nested LLM calls with hierarchical spans.
|
|
|
|
## Further Improvements
|
|
|
|
If you have suggestions for improving the Helicone integration, please let us know by opening an issue on [GitHub](https://github.com/comet-ml/opik/issues).
|