Observability for [PROVIDER_NAME] with Opik - Opik

[Brief description of the provider and what it's used for. Example: "[PROVIDER_NAME] is a fast AI inference platform" or "[PROVIDER_NAME] provides state-of-the-art large language models"]

Account Setup

Comet provides a hosted version of the Opik platform, simply create an account and grab your API Key.

You can also run the Opik platform locally, see the installation guide for more information.

Getting Started

Installation

To start tracking your [PROVIDER_NAME] LLM calls, you can use our LiteLLM integration. You'll need to have both the opik and litellm packages installed. You can install them using pip:

bash

pip install opik litellm

Configuring Opik

Configure the Opik Python SDK for your deployment type. See the Python SDK Configuration guide for detailed instructions on:

CLI configuration: opik configure
Code configuration: opik.configure()
Self-hosted vs Cloud vs Enterprise setup
Configuration files and environment variables

<Info>

If you're unable to use our LiteLLM integration with [PROVIDER_NAME], please open an issue

</Info>

Configuring [PROVIDER_NAME]

In order to configure [PROVIDER_NAME], you will need to have your [PROVIDER_NAME] API Key. You can create and manage your [PROVIDER_NAME] API Keys on this page.

You can set it as an environment variable:

bash

export [PROVIDER_API_KEY_NAME]="YOUR_API_KEY"

Or set it programmatically:

python

import os
import getpass

if "[PROVIDER_API_KEY_NAME]" not in os.environ:
    os.environ["[PROVIDER_API_KEY_NAME]"] = getpass.getpass("Enter your [PROVIDER_NAME] API key: ")

# Set project name for organization
os.environ["OPIK_PROJECT_NAME"] = "[provider_name]-integration-demo"

Logging LLM calls

In order to log the LLM calls to Opik, you will need to create the OpikLogger callback. Once the OpikLogger callback is created and added to LiteLLM, you can make calls to LiteLLM as you normally would:

python

from litellm.integrations.opik.opik import OpikLogger
import litellm

opik_logger = OpikLogger()
litellm.callbacks = [opik_logger]

# Set project name for organization
os.environ["OPIK_PROJECT_NAME"] = "[provider_name]-integration-demo"

response = litellm.completion(
    model="[provider_model_name]",  # Replace with actual model name (e.g., "groq/llama3-8b-8192")
    messages=[
        {"role": "user", "content": "Why is tracking and evaluation of LLMs important?"}
    ]
)

<Frame> </Frame>

Logging LLM calls within a tracked function

If you are using LiteLLM within a function tracked with the @track decorator, you will need to pass the current_span_data as metadata to the litellm.completion call:

python

from opik import track, opik_context
import litellm

@track
def generate_story(prompt):
    response = litellm.completion(
        model="[provider_model_name]",  # Replace with actual model name
        messages=[{"role": "user", "content": prompt}],
        metadata={
            "opik": {
                "current_span_data": opik_context.get_current_span_data(),
            },
        },
    )
    return response.choices[0].message.content


@track
def generate_topic():
    prompt = "Generate a topic for a story about Opik."
    response = litellm.completion(
        model="[provider_model_name_2]",  # Can be same as above or different model
        messages=[{"role": "user", "content": prompt}],
        metadata={
            "opik": {
                "current_span_data": opik_context.get_current_span_data(),
            },
        },
    )
    return response.choices[0].message.content


@track
def generate_opik_story():
    topic = generate_topic()
    story = generate_story(topic)
    return story


generate_opik_story()

<Frame> </Frame>