Documentation | Evaluations › delete

API Reference

Evaluation Items

Create Evaluation

Archive Evaluation

List Evaluations

Update Evaluation

Evaluations

EvaluationsResource

Methods

client.evaluations.create() ->

post/v5/evaluations

Create Evaluation

client.evaluations.delete() ->

EvaluationDeleteResponse

delete/v5/evaluations/{evaluation_id}

Archive Evaluation

Parameters

evaluation_id: str

Returns

class EvaluationDeleteResponse:

id: str

deleted:

object: Optional[Optional[Literal["evaluation"]]]

(default: "evaluation")

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
)
evaluation = client.evaluations.delete(
    "evaluation_id",
)
print(evaluation.id)

200Example

{
  "id": "id",
  "deleted": true,
  "object": "evaluation"
}

client.evaluations.list() -> SyncCursorPage[

]

get/v5/evaluations

List Evaluations

client.evaluations.retrieve(, ) ->

get/v5/evaluations/{evaluation_id}

Get Evaluation

client.evaluations.update(, ) ->

patch/v5/evaluations/{evaluation_id}

Update Evaluation

Domain types

class Evaluation: ...

EvaluationTask =

ItemLocator = str

ItemLocatorTemplate = str