Skip to content
sgp
API Reference
Evaluation Items

Export evaluation items to a file

evaluation_items.export(EvaluationItemExportParams**kwargs) -> EvaluationItemExport
POST/v5/evaluation-items/export

Export all evaluation items for a single evaluation as a downloadable file.

The evaluation is specified by evaluation_id in the request body. export_format selects CSV, JSON, or JSONL; for CSV the per-item data and files fields are flattened into individual columns and metric-like result columns are expanded. export_method controls delivery: direct returns the file contents inline in the response, while signed_url uploads the file to object storage and returns a pre-signed download URL. Requesting signed_url in an environment where object storage is not configured fails with a 501, so use direct there instead. Set include_archived=true to include archived items in the export. This endpoint reads items only and does not modify the evaluation.

ParametersExpand Collapse
evaluation_id: str

The ID of the evaluation to export items from.

export_format: Optional[ExportFormat]

The format of the exported evaluation items. json returns a single JSON array, while jsonl returns one JSON object per line.

One of the following:
"json"
"jsonl"
"csv"
export_method: Optional[ExportMethod]

The method for exporting evaluation items. signed_url returns a pre-signed URL, while direct returns the raw content.

One of the following:
"signed_url"
"direct"
include_archived: Optional[bool]

If true, include archived evaluation items in the export.

ReturnsExpand Collapse
class EvaluationItemExport: …

Response model for exporting evaluation items. This class represents the response when users export evaluation items. It contains either a signed URL to download the exported data from object storage, or the actual content bytes when direct download is used (in environments where object storage is not configured).

filename: str

The name of the exported file

content: Optional[str]

The raw file content as bytes, used when direct download is enabled

signed_url: Optional[str]

Pre-signed URL to download the file from object storage, if applicable

Export evaluation items to a file

import os
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
evaluation_item_export = client.evaluation_items.export(
    evaluation_id="evaluation_id",
)
print(evaluation_item_export.filename)
{
  "filename": "filename",
  "content": "content",
  "signed_url": "signed_url"
}
Returns Examples
{
  "filename": "filename",
  "content": "content",
  "signed_url": "signed_url"
}