# Evaluation Items ## Get a single evaluation item `client.EvaluationItems.Get(ctx, evaluationItemID, query) (*EvaluationItem, error)` **get** `/v5/evaluation-items/{evaluation_item_id}` Retrieve a single evaluation item by its ID within the caller's account. By default only non-archived items are returned; pass `include_archived=true` to also retrieve an item that has been archived. The response merges the item's cached task results into its `data` field and exposes a `task_errors` map keyed by task alias, so a task that failed on this item surfaces as an entry there rather than as a request error. Use this to inspect one item's input data and per-task results; to page through many items, use the list endpoint instead. The request fails if no item with the given ID exists in the caller's account. ### Parameters - `evaluationItemID string` - `query EvaluationItemGetParams` - `IncludeArchived param.Field[bool]` ### Returns - `type EvaluationItem struct{…}` - `ID string` The unique identifier of the entity. - `CreatedAt Time` The date and time when the entity was created in ISO format. - `CreatedBy Identity` The identity that created the entity. - `ID string` - `Type IdentityType` - `const IdentityTypeUser IdentityType = "user"` - `const IdentityTypeServiceAccount IdentityType = "service_account"` - `Object IdentityObject` - `const IdentityObjectIdentity IdentityObject = "identity"` - `Data map[string, any]` - `EvaluationID string` - `ArchivedAt Time` The date and time when the entity was archived in ISO format. - `DatasetItemID string` - `DatasetItemVersionNum int64` - `Files map[string, string]` - `Object EvaluationItemObject` - `const EvaluationItemObjectEvaluationItem EvaluationItemObject = "evaluation.item"` - `TaskErrors map[string, TaskError]` Map of task alias to error info. - `Message string` Error message - `Type string` Error type/category - `TaskResultStatuses map[string, string]` Per-alias task-result lifecycle status derived from `task_result_cache`. Present when at least one alias has a recorded status; `null` for legacy rows with an empty cache. Renderers use this to distinguish `prefilled` from `completed` on the wire (values themselves are already merged into `data` by `merge_task_result_cache_into_data`). - `const EvaluationItemTaskResultStatusCompleted EvaluationItemTaskResultStatus = "completed"` - `const EvaluationItemTaskResultStatusSkipped EvaluationItemTaskResultStatus = "skipped"` - `const EvaluationItemTaskResultStatusErrored EvaluationItemTaskResultStatus = "errored"` - `const EvaluationItemTaskResultStatusPending EvaluationItemTaskResultStatus = "pending"` - `const EvaluationItemTaskResultStatusPrefilled EvaluationItemTaskResultStatus = "prefilled"` ### Example ```go package main import ( "context" "fmt" "github.com/scaleapi/sgp-dev-go" "github.com/scaleapi/sgp-dev-go/option" ) func main() { client := sgpdev.NewClient( option.WithAPIKey("My API Key"), option.WithAccountID("My Account ID"), ) evaluationItem, err := client.EvaluationItems.Get( context.TODO(), "evaluation_item_id", sgpdev.EvaluationItemGetParams{ }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", evaluationItem.ID) } ``` #### Response ```json { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "created_by": { "id": "id", "type": "user", "object": "identity" }, "data": { "foo": "bar" }, "evaluation_id": "evaluation_id", "archived_at": "2019-12-27T18:11:19.117Z", "dataset_item_id": "dataset_item_id", "dataset_item_version_num": 0, "files": { "foo": "string" }, "object": "evaluation.item", "task_errors": { "foo": { "message": "message", "type": "type" } }, "task_result_statuses": { "foo": "completed" } } ``` ## List and filter evaluation items `client.EvaluationItems.List(ctx, query) (*CursorPage[EvaluationItem], error)` **get** `/v5/evaluation-items` Return a paginated list of evaluation items belonging to the caller's account. Pass `evaluation_id` to restrict the results to a single evaluation's items. The `completion_status` filter selects items by whether any of their tasks errored: `failed` returns only items that have task errors, `passed` returns only items with no task errors, and `all` (or omitting the parameter) returns every item. Archived items are excluded unless `include_archived=true`. Each returned item has its cached task results merged into `data` and its errors exposed in `task_errors`, identically to the single-item endpoint. ### Parameters - `query EvaluationItemListParams` - `CompletionStatus param.Field[EvaluationItemListParamsCompletionStatus]` Filter items by completion status. Pass 'failed' to return only items with errors, 'passed' for items without errors. Pass 'all' or omit to return all items. - `const EvaluationItemListParamsCompletionStatusFailed EvaluationItemListParamsCompletionStatus = "failed"` - `const EvaluationItemListParamsCompletionStatusPassed EvaluationItemListParamsCompletionStatus = "passed"` - `const EvaluationItemListParamsCompletionStatusAll EvaluationItemListParamsCompletionStatus = "all"` - `EndingBefore param.Field[string]` - `EvaluationID param.Field[string]` - `IncludeArchived param.Field[bool]` - `Limit param.Field[int64]` - `SortBy param.Field[string]` - `SortOrder param.Field[SortOrder]` - `StartingAfter param.Field[string]` ### Returns - `type EvaluationItem struct{…}` - `ID string` The unique identifier of the entity. - `CreatedAt Time` The date and time when the entity was created in ISO format. - `CreatedBy Identity` The identity that created the entity. - `ID string` - `Type IdentityType` - `const IdentityTypeUser IdentityType = "user"` - `const IdentityTypeServiceAccount IdentityType = "service_account"` - `Object IdentityObject` - `const IdentityObjectIdentity IdentityObject = "identity"` - `Data map[string, any]` - `EvaluationID string` - `ArchivedAt Time` The date and time when the entity was archived in ISO format. - `DatasetItemID string` - `DatasetItemVersionNum int64` - `Files map[string, string]` - `Object EvaluationItemObject` - `const EvaluationItemObjectEvaluationItem EvaluationItemObject = "evaluation.item"` - `TaskErrors map[string, TaskError]` Map of task alias to error info. - `Message string` Error message - `Type string` Error type/category - `TaskResultStatuses map[string, string]` Per-alias task-result lifecycle status derived from `task_result_cache`. Present when at least one alias has a recorded status; `null` for legacy rows with an empty cache. Renderers use this to distinguish `prefilled` from `completed` on the wire (values themselves are already merged into `data` by `merge_task_result_cache_into_data`). - `const EvaluationItemTaskResultStatusCompleted EvaluationItemTaskResultStatus = "completed"` - `const EvaluationItemTaskResultStatusSkipped EvaluationItemTaskResultStatus = "skipped"` - `const EvaluationItemTaskResultStatusErrored EvaluationItemTaskResultStatus = "errored"` - `const EvaluationItemTaskResultStatusPending EvaluationItemTaskResultStatus = "pending"` - `const EvaluationItemTaskResultStatusPrefilled EvaluationItemTaskResultStatus = "prefilled"` ### Example ```go package main import ( "context" "fmt" "github.com/scaleapi/sgp-dev-go" "github.com/scaleapi/sgp-dev-go/option" ) func main() { client := sgpdev.NewClient( option.WithAPIKey("My API Key"), option.WithAccountID("My Account ID"), ) page, err := client.EvaluationItems.List(context.TODO(), sgpdev.EvaluationItemListParams{ }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "has_more": true, "items": [ { "id": "id", "created_at": "2019-12-27T18:11:19.117Z", "created_by": { "id": "id", "type": "user", "object": "identity" }, "data": { "foo": "bar" }, "evaluation_id": "evaluation_id", "archived_at": "2019-12-27T18:11:19.117Z", "dataset_item_id": "dataset_item_id", "dataset_item_version_num": 0, "files": { "foo": "string" }, "object": "evaluation.item", "task_errors": { "foo": { "message": "message", "type": "type" } }, "task_result_statuses": { "foo": "completed" } } ], "total": 0, "limit": 0, "object": "list" } ``` ## Export evaluation items to a file `client.EvaluationItems.Export(ctx, body) (*EvaluationItemExport, error)` **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. ### Parameters - `body EvaluationItemExportParams` - `EvaluationID param.Field[string]` The ID of the evaluation to export items from. - `ExportFormat param.Field[ExportFormat]` The format of the exported evaluation items. `json` returns a single JSON array, while `jsonl` returns one JSON object per line. - `ExportMethod param.Field[ExportMethod]` The method for exporting evaluation items. `signed_url` returns a pre-signed URL, while `direct` returns the raw content. - `IncludeArchived param.Field[bool]` If true, include archived evaluation items in the export. ### Returns - `type EvaluationItemExport struct{…}` 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 string` The name of the exported file - `Content string` The raw file content as bytes, used when direct download is enabled - `SignedURL string` Pre-signed URL to download the file from object storage, if applicable ### Example ```go package main import ( "context" "fmt" "github.com/scaleapi/sgp-dev-go" "github.com/scaleapi/sgp-dev-go/option" ) func main() { client := sgpdev.NewClient( option.WithAPIKey("My API Key"), option.WithAccountID("My Account ID"), ) evaluationItemExport, err := client.EvaluationItems.Export(context.TODO(), sgpdev.EvaluationItemExportParams{ EvaluationID: "evaluation_id", }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", evaluationItemExport.Filename) } ``` #### Response ```json { "filename": "filename", "content": "content", "signed_url": "signed_url" } ``` ## Domain Types ### Component - `type Component struct{…}` - `Data ItemLocator` A pointer to the data in each evaluation item to be displayed within the component - `Label string` ### Container - `type Container struct{…}` - `Children []ContainerChildUnion` The children to be displayed within the container - `type Container struct{…}` - `type Component struct{…}` - `Data ItemLocator` A pointer to the data in each evaluation item to be displayed within the component - `Label string` - `Direction ContainerDirection` The axis that children are placed in the container. Based on CSS `flex-direction` (see: https://developer.mozilla.org/en-US/docs/Web/CSS/flex-direction) - `const ContainerDirectionRow ContainerDirection = "row"` - `const ContainerDirectionColumn ContainerDirection = "column"` ### Evaluation Item - `type EvaluationItem struct{…}` - `ID string` The unique identifier of the entity. - `CreatedAt Time` The date and time when the entity was created in ISO format. - `CreatedBy Identity` The identity that created the entity. - `ID string` - `Type IdentityType` - `const IdentityTypeUser IdentityType = "user"` - `const IdentityTypeServiceAccount IdentityType = "service_account"` - `Object IdentityObject` - `const IdentityObjectIdentity IdentityObject = "identity"` - `Data map[string, any]` - `EvaluationID string` - `ArchivedAt Time` The date and time when the entity was archived in ISO format. - `DatasetItemID string` - `DatasetItemVersionNum int64` - `Files map[string, string]` - `Object EvaluationItemObject` - `const EvaluationItemObjectEvaluationItem EvaluationItemObject = "evaluation.item"` - `TaskErrors map[string, TaskError]` Map of task alias to error info. - `Message string` Error message - `Type string` Error type/category - `TaskResultStatuses map[string, string]` Per-alias task-result lifecycle status derived from `task_result_cache`. Present when at least one alias has a recorded status; `null` for legacy rows with an empty cache. Renderers use this to distinguish `prefilled` from `completed` on the wire (values themselves are already merged into `data` by `merge_task_result_cache_into_data`). - `const EvaluationItemTaskResultStatusCompleted EvaluationItemTaskResultStatus = "completed"` - `const EvaluationItemTaskResultStatusSkipped EvaluationItemTaskResultStatus = "skipped"` - `const EvaluationItemTaskResultStatusErrored EvaluationItemTaskResultStatus = "errored"` - `const EvaluationItemTaskResultStatusPending EvaluationItemTaskResultStatus = "pending"` - `const EvaluationItemTaskResultStatusPrefilled EvaluationItemTaskResultStatus = "prefilled"` ### Evaluation Item Export - `type EvaluationItemExport struct{…}` 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 string` The name of the exported file - `Content string` The raw file content as bytes, used when direct download is enabled - `SignedURL string` Pre-signed URL to download the file from object storage, if applicable ### Export Format - `type ExportFormat string` - `const ExportFormatJson ExportFormat = "json"` - `const ExportFormatJSONL ExportFormat = "jsonl"` - `const ExportFormatCsv ExportFormat = "csv"` ### Export Method - `type ExportMethod string` - `const ExportMethodSignedURL ExportMethod = "signed_url"` - `const ExportMethodDirect ExportMethod = "direct"` ### Task Error - `type TaskError struct{…}` - `Message string` Error message - `Type string` Error type/category