Skip to content

honeyhive._generated.models.GetExperimentRunResultResponse

GetExperimentRunResultResponse

Bases: BaseModel

GetExperimentRunResultResponse model Evaluation summary for an experiment run: pass/fail results, metric aggregations, per-datapoint results, event details, and the experiment run object.

Source code in src/honeyhive/_generated/models/GetExperimentRunResultResponse.py
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
class GetExperimentRunResultResponse(BaseModel):
    """
    GetExperimentRunResultResponse model
        Evaluation summary for an experiment run: pass/fail results, metric aggregations, per-datapoint results, event details, and the experiment run object.
    """

    model_config = {
        "populate_by_name": True,
        "validate_assignment": True,
        "extra": "allow",
        "protected_namespaces": (),
    }

    status: str = Field(validation_alias="status")

    success: bool = Field(validation_alias="success")

    error: Optional[str] = Field(validation_alias="error", default=None)

    passed: List[str] = Field(validation_alias="passed")

    failed: List[str] = Field(validation_alias="failed")

    metrics: MetricsAggregation = Field(validation_alias="metrics")

    datapoints: List[DatapointResult] = Field(validation_alias="datapoints")

    event_details: List[EventDetail] = Field(validation_alias="event_details")

    run_object: ExperimentRunObject = Field(validation_alias="run_object")

status class-attribute instance-attribute

status: str = Field(validation_alias='status')

success class-attribute instance-attribute

success: bool = Field(validation_alias='success')

error class-attribute instance-attribute

error: Optional[str] = Field(
    validation_alias="error", default=None
)

passed class-attribute instance-attribute

passed: List[str] = Field(validation_alias='passed')

failed class-attribute instance-attribute

failed: List[str] = Field(validation_alias='failed')

metrics class-attribute instance-attribute

metrics: MetricsAggregation = Field(
    validation_alias="metrics"
)

datapoints class-attribute instance-attribute

datapoints: List[DatapointResult] = Field(
    validation_alias="datapoints"
)

event_details class-attribute instance-attribute

event_details: List[EventDetail] = Field(
    validation_alias="event_details"
)

run_object class-attribute instance-attribute

run_object: ExperimentRunObject = Field(
    validation_alias="run_object"
)