Fetch Evaluation Scenarios

GET 
/evaluations/:evaluation_id/evaluation_scenarios

Fetches evaluation scenarios for a given evaluation ID.

Arguments: evaluation_id (str): The ID of the evaluation for which to fetch scenarios.

Raises: HTTPException: If the evaluation is not found or access is denied.

Returns: List[EvaluationScenario]: A list of evaluation scenarios.

Request

Path Parameters

evaluation_id Evaluation Idrequired

Responses

200

Successful Response

application/json

Schema

Schema

• Array [

id Id (string)
evaluation_id Evaluation Id (string)required

inputs

object[]

required

Array [

name Name (string)required

type Type (string)required

value Value

]

outputs

object[]

required

Array [

result

object

required

type Type (string)required

value Value

error

object

message Message (string)required

stacktrace Stacktrace (string)

cost Cost (number)

latency Latency (number)

]

evaluation Evaluation (string)
correct_answer Correct Answer (string)
is_pinned Is Pinned (boolean)
note Note (string)

results

object[]

required

Array [

evaluator_config Evaluator Config (string)required

result

object

required

type Type (string)required

value Value

error

object

message Message (string)required

stacktrace Stacktrace (string)

]

• ]

Example (from schema)

[
  {
    "id": "string",
    "evaluation_id": "string",
    "inputs": [
      {
        "name": "string",
        "type": "string"
      }
    ],
    "outputs": [
      {
        "result": {
          "type": "string",
          "error": {
            "message": "string",
            "stacktrace": "string"
          }
        },
        "cost": 0,
        "latency": 0
      }
    ],
    "evaluation": "string",
    "correct_answer": "string",
    "is_pinned": true,
    "note": "string",
    "results": [
      {
        "evaluator_config": "string",
        "result": {
          "type": "string",
          "error": {
            "message": "string",
            "stacktrace": "string"
          }
        }
      }
    ]
  }
]

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...