Fetch List Evaluations
GET/evaluations
Fetches a list of evaluations, optionally filtered by an app ID.
Args: app_id (Optional[str]): An optional app ID to filter the evaluations.
Returns: List[Evaluation]: A list of evaluations.
Request
Query Parameters
app_id App Idrequired
Responses
- 200
- 422
Successful Response
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
- EvaluatorConfig
]
]
id Id (string)required
app_id App Id (string)required
user_id User Id (string)required
user_username User Username (string)required
variant_ids string[]required
variant_names string[]required
variant_revision_ids string[]required
revisions string[]required
testset_id Testset Id (string)
testset_name Testset Name (string)
status
object
required
type Type (string)required
value Value
error
object
message Message (string)required
stacktrace Stacktrace (string)
aggregated_results
object[]
required
evaluator_config
object
required
anyOf
id Id (string)required
name Name (string)required
evaluator_key Evaluator Key (string)required
settings_values object
created_at date-timerequired
updated_at date-timerequired
result
object
required
type Type (string)required
value Value
error
object
message Message (string)required
stacktrace Stacktrace (string)
average_cost
object
type Type (string)required
value Value
error
object
message Message (string)required
stacktrace Stacktrace (string)
total_cost
object
type Type (string)required
value Value
error
object
message Message (string)required
stacktrace Stacktrace (string)
average_latency
object
type Type (string)required
value Value
error
object
message Message (string)required
stacktrace Stacktrace (string)
created_at date-timerequired
updated_at date-timerequired
[
{
"id": "string",
"app_id": "string",
"user_id": "string",
"user_username": "string",
"variant_ids": [
"string"
],
"variant_names": [
"string"
],
"variant_revision_ids": [
"string"
],
"revisions": [
"string"
],
"testset_id": "string",
"testset_name": "string",
"status": {
"type": "string",
"error": {
"message": "string",
"stacktrace": "string"
}
},
"aggregated_results": [
{
"evaluator_config": {},
"result": {
"type": "string",
"error": {
"message": "string",
"stacktrace": "string"
}
}
}
],
"average_cost": {
"type": "string",
"error": {
"message": "string",
"stacktrace": "string"
}
},
"total_cost": {
"type": "string",
"error": {
"message": "string",
"stacktrace": "string"
}
},
"average_latency": {
"type": "string",
"error": {
"message": "string",
"stacktrace": "string"
}
},
"created_at": "2024-08-19T07:55:04.164Z",
"updated_at": "2024-08-19T07:55:04.164Z"
}
]
Validation Error
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
- MOD1
- MOD2
]
]
detail
object[]
loc
object[]
required
anyOf
string
integer
msg Message (string)required
type Error Type (string)required
{
"detail": [
{
"loc": [
"string",
0
],
"msg": "string",
"type": "string"
}
]
}
Loading...