Log media & attachments

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 with a file path
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!"))

1
from opik import opik_context, track, Attachment
2
3
@track
4
def process_image(image_bytes: bytes):
5
    # Process the image
6
    # ...
7
8
    # Log the raw bytes as an attachment
9
    opik_context.update_current_trace(
10
        attachments=[
11
            Attachment(
12
                data=image_bytes,  # Raw bytes
13
                file_name="processed_image.png",  # Required for bytes
14
                content_type="image/png",
15
            )
16
        ]
17
    )
18
19
    return "Image processed!"
20
21
# Example: Reading a file into memory and logging it
22
with open("image.png", "rb") as f:
23
    image_data = f.read()
24
25
print(process_image(image_data))

1
import httpx
2
from opik import opik_context, track, Attachment
3
4
@track
5
def analyze_remote_image(image_url: str):
6
    # Fetch image from URL
7
    response = httpx.get(image_url)
8
    image_bytes = response.content
9
    content_type = response.headers.get("content-type", "image/jpeg")
10
11
    # Log the fetched image as an attachment
12
    opik_context.update_current_trace(
13
        attachments=[
14
            Attachment(
15
                data=image_bytes,
16
                file_name="remote_image.jpg",
17
                content_type=content_type,
18
            )
19
        ]
20
    )
21
22
    # Process the image...
23
    return "Image analyzed!"
24
25
# Analyze an image from a URL
26
result = analyze_remote_image("https://example.com/image.jpg")

1
from opik import opik_context, track, Attachment
2
import json
3
4
@track
5
def generate_report(data: dict):
6
    # Generate a JSON report
7
    report_bytes = json.dumps(data, indent=2).encode("utf-8")
8
9
    opik_context.update_current_trace(
10
        attachments=[
11
            Attachment(
12
                data=report_bytes,
13
                file_name="report.json",
14
                content_type="application/json",
15
            )
16
        ]
17
    )
18
19
    return "Report generated!"

1
import opik
2
from opik import Attachment
3
4
client = opik.Opik()
5
6
# Create a trace
7
trace = client.trace(
8
    name="my-trace",
9
    input={"query": "Process this data"},
10
    project_name="my-project",
11
)
12
13
# Log attachment with file path
14
span_with_file = client.span(
15
    trace_id=trace.id,
16
    name="file-attachment-span",
17
    attachments=[
18
        Attachment(
19
            data="/path/to/document.pdf",
20
            content_type="application/pdf",
21
        )
22
    ],
23
)
24
25
# Log attachment with raw bytes
26
binary_data = b"Hello, this is binary content!"
27
span_with_bytes = client.span(
28
    trace_id=trace.id,
29
    name="bytes-attachment-span",
30
    attachments=[
31
        Attachment(
32
            data=binary_data,
33
            file_name="data.bin",
34
            content_type="application/octet-stream",
35
        )
36
    ],
37
)
38
39
client.flush()

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
)

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])