Log media & attachments

Opik supports multimodal traces allowing you to track not just the text input and output of your LLM, but also images, videos and audio and any other media.

Logging Attachments

In the Python SDK, you can use the Attachment type to add files to your traces. Attachements can be images, videos, audio files or any other file that you might want to log to Opik.

Each attachment is made up of the following fields:

• data: The path to the file or the base64 encoded string of the file
• content_type: The content type of the file formatted as a MIME type

These attachements can then be logged to your traces and spans using The opik_context.update_current_span and opik_context.update_current_trace methods:

1
from opik import opik_context, track, Attachment
2
3
@track
4
def my_llm_agent(input):
5
    # LLM chain code
6
    # ...
7
8
    # Update the trace
9
    opik_context.update_current_trace(
10
        attachments=[
11
            Attachment(
12
                data="<path to the image>",
13
                content_type="image/png",
14
            )
15
        ]
16
    )
17
18
    return "World!"
19
20
print(my_llm_agent("Hello!"))

The attachements will be uploaded to the Opik platform and can be both previewed and dowloaded from the UI.

Managing Attachments Programmatically

You can also manage attachments programmatically using the AttachmentClient:

1
import opik
2
3
opik_client = opik.Opik()
4
attachment_client = opik_client.get_attachment_client()
5
6
# Get list of attachments
7
attachments_details = attachment_client.get_attachment_list(
8
    project_name="my-project",
9
    entity_id="some-trace-uuid-7",
10
    entity_type="trace"
11
)
12
13
# Download an attachment
14
attachment_data = attachment_client.download_attachment(
15
    project_name="my-project",
16
    entity_type="trace",
17
    entity_id="some-trace-uuid-7",
18
    file_name="report.pdf",
19
    mime_type="application/pdf"
20
)
21
22
# Upload a new attachment
23
attachment_client.upload_attachment(
24
    project_name="my-project",
25
    entity_type="trace", 
26
    entity_id="some-trace-uuid-7",
27
    file_path="/path/to/document.pdf"
28
)

Previewing base64 encoded images and image URLs

Opik automatically detects base64 encoded images and URLs logged to the platform, once an image is detected we will hide the string to make the content more readable and display the image in the UI. This is supported in the tracing view, datasets view and experiment view.

For example if you are using the OpenAI SDK, if you pass an image to the model as a URL, Opik will automatically detect it and display the image in the UI:

1
from opik.integrations.openai import track_openai
2
from openai import OpenAI
3
4
# Make sure to wrap the OpenAI client to enable Opik tracing
5
client = track_openai(OpenAI())
6
7
response = client.chat.completions.create(
8
  model="gpt-4o-mini",
9
  messages=[
10
    {
11
      "role": "user",
12
      "content": [
13
        {"type": "text", "text": "What's in this image?"},
14
        {
15
          "type": "image_url",
16
          "image_url": {
17
            "url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg",
18
          },
19
        },
20
      ],
21
    }
22
  ],
23
  max_tokens=300,
24
)
25
26
print(response.choices[0])

Embedded Attachments

When you embed base64-encoded media directly in your trace/span input, output, or metadata fields, Opik automatically optimizes storage and retrieval for performance.

How It Works

For base64-encoded content larger than 250KB, Opik automatically extracts and stores it separately. This happens transparently - you don’t need to change your code.

When you retrieve your traces or spans later, the attachments are automatically included by default. For faster queries when you don’t need the attachment data, use the strip_attachments=true parameter.

Size Limits

Opik Cloud supports embedded attachments up to 100MB per field. This limit applies to individual string values in your input, output, or metadata fields.

If you need to work with larger files:

1. Use the Attachment API - Upload files separately using AttachmentClient (recommended for files >50MB). See Managing Attachments Programmatically

2. Contact us - Get in touch if you need higher limits

3. Self-host Opik - Configure your own limits. See the Self-hosting Guide

Best Practices

• Embed smaller files directly - Opik handles them efficiently
• For files >50MB, use the Attachment API for better performance
• Use strip_attachments=true when querying if you don’t need the attachment data

Downloading attachments

You can download attachments in two ways:

1. From the UI: Hover over the attachments and click on the download icon
2. Programmatically: Use the AttachmentClient as shown in the examples above