Exporting Traces and Spans

When working with Opik, it is important to be able to export traces and spans so that you can use them to fine-tune your models or run deeper analysis.

You can export the traces you have logged to the Opik platform using:

1. Using the Opik SDK: You can use the Opik.search_traces and Opik.search_spans methods to export traces and spans.
2. Using the Opik REST API: You can use the /traces and /spans endpoints to export traces and spans.
3. Using the UI: Once you have selected the traces or spans you want to export, you can click on the Export CSV button in the Actions dropdown.

tip

The recommended way to export traces is to use the Opik.search_traces and Opik.search_spans methods in the Opik SDK.

Using the Opik SDK

Exporting traces

The Opik.search_traces method allows you to both export all the traces in a project or search for specific traces and export them.

Exporting all traces

To export all traces, you will need to specify a max_results value that is higher than the total number of traces in your project:

import opik

client = opik.Opik()

traces = client.search_traces(project_name="Default project", max_results=1000000)

Search for specific traces

You can use the filter_string parameter to search for specific traces:

import opik

client = opik.Opik()

traces = client.search_traces(
  project_name="Default project",
  filter_string='input contains "Opik"'
)

# Convert to Dict if required
traces = [trace.dict() for trace in traces]

The filter_string parameter should follow the format <column> <operator> <value> with:

1. <column>: The column to filter on, these can be:
   • name
   • input
   • output
   • start_time
   • end_time
   • metadata
   • feedback_score
   • tags
   • usage.total_tokens
   • usage.prompt_tokens
   • usage.completion_tokens.
2. <operator>: The operator to use for the filter, this can be =, !=, >, >=, <, <=, contains, not_contains. Not that not all operators are supported for all columns.
3. <value>: The value to filter on. If you are filtering on a string, you will need to wrap it in double quotes.

Here are some additional examples of valid filter_string values:

import opik

client = opik.Opik(
    project_name="Default project"
)

# Search for traces where the input contains text
traces = client.search_traces(
  filter_string='input contains "Opik"'
)

# Search for traces that were logged after a specific date
traces = client.search_traces(filter_string='start_time >= "2024-01-01T00:00:00Z"')

# Search for traces that have a specific tag
traces = client.search_traces(filter_string='tags contains "production"')

# Search for traces based on the number of tokens used
traces = client.search_traces(filter_string='usage.total_tokens > 1000')

# Search for traces based on the model used
traces = client.search_traces(filter_string='metadata.model = "gpt-4o"')

Exporting spans

You can export spans using the Opik.search_spans method. This methods allows you to search for spans based on trace_id or based on a filter string.

Exporting spans based on trace_id

To export all the spans associated with a specific trace, you can use the trace_id parameter:

import opik

client = opik.Opik()

spans = client.search_spans(
  project_name="Default project",
  trace_id="067092dc-e639-73ff-8000-e1c40172450f"
)

Search for specific spans

You can use the filter_string parameter to search for specific spans:

import opik

client = opik.Opik()

spans = client.search_spans(
  project_name="Default project",
  filter_string='input contains "Opik"'
)

tip

The filter_string parameter should follow the same format as the filter_string parameter in the Opik.search_traces method as defined above.

Using the Opik REST API

To export traces using the Opik REST API, you can use the /traces endpoint and the /spans endpoint. These endpoints are paginated so you will need to make multiple requests to retrieve all the traces or spans you want.

To search for specific traces or spans, you can use the filter parameter. While this is a string parameter, it does not follow the same format as the filter_string parameter in the Opik SDK. Instead it is a list of json objects with the following format:

[
  {
    "field": "name",
    "type": "string",
    "operator": "=",
    "value": "Opik"
  }
]

warning

The filter parameter was designed to be used with the Opik UI and has therefore limited flexibility. If you need more flexibility, please raise an issue on GitHub so we can help.

Using the UI

To export traces as a CSV file from the UI, you can simply select the traces or spans you wish to export and click on Export CSV in the Actions dropdown:

tip

The UI only allows you to export up to 100 traces or spans at a time as it is linked to the page size of the traces table. If you need to export more traces or spans, we recommend using the Opik SDK.