Documentation | Evaluation Items

Evaluation Items

EvaluationItemsResource

Methods

client.evaluation_items.retrieve(, ) ->

EvaluationItem

get/v5/evaluation-items/{evaluation_item_id}

Get Evaluation Item

client.evaluation_items.list() -> SyncCursorPage[

EvaluationItem

]

get/v5/evaluation-items

List Evaluation Items

client.evaluation_items.export() ->

EvaluationItemExportResponse

post/v5/evaluation-items/export

Export Evaluation Items

Parameters

evaluation_id: str

The ID of the evaluation to export items from.

export_format: Optional[Literal["json", "jsonl", "csv"]]

(default: "csv")

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

"json"

"jsonl"

"csv"

export_method: Optional[Literal["signed_url", "direct"]]

(default: "direct")

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

"signed_url"

"direct"

include_archived: Optional[

bool

]

If true, include archived evaluation items in the export.

Returns

class EvaluationItemExportResponse:

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[object]

(format: binary)

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

Request example

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
)
response = client.evaluation_items.export(
    evaluation_id="evaluation_id",
)
print(response.filename)

200Example

{
  "filename": "filename",
  "signed_url": "signed_url"
}

Domain types

class Component: ...

class Container: ...

class EvaluationItem: ...