Skip to content

honeyhive._generated.models.MetricVersionContentRequest

MetricVersionContentRequest

Bases: BaseModel

MetricVersionContentRequest model
    Metric definition snapshot accepted by POST /v1/metrics/{metric_id}/versions.

Six fields are optional and fall back to server-side defaults when omitted: - description → "" - return_type → "float" - enabled_in_prod → true for HUMAN metrics, false otherwise - needs_ground_truth → false - sampling_percentage → 10 - filters → { "filterArray": [] }

Source code in src/honeyhive/_generated/models/MetricVersionContentRequest.py 
10
11
12
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
class MetricVersionContentRequest(BaseModel):
    """
        MetricVersionContentRequest model
            Metric definition snapshot accepted by POST /v1/metrics/{metric_id}/versions.
    Six fields are optional and fall back to server-side defaults when omitted:
    - `description` → `""`
    - `return_type` → `"float"`
    - `enabled_in_prod` → `true` for HUMAN metrics, `false` otherwise
    - `needs_ground_truth` → `false`
    - `sampling_percentage` → `10`
    - `filters` → `{ "filterArray": [] }`
    """

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

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

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

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

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

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

    enabled_in_prod: Optional[bool] = Field(
        validation_alias="enabled_in_prod", default=None
    )

    needs_ground_truth: Optional[bool] = Field(
        validation_alias="needs_ground_truth", default=None
    )

    sampling_percentage: Optional[float] = Field(
        validation_alias="sampling_percentage", default=None
    )

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

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

    scale: Optional[int] = Field(validation_alias="scale", default=None)

    threshold: Optional[Dict[str, Any]] = Field(
        validation_alias="threshold", default=None
    )

    categories: Optional[List[Any]] = Field(validation_alias="categories", default=None)

    child_metrics: Optional[List[Any]] = Field(
        validation_alias="child_metrics", default=None
    )

    filters: Optional[MetricVersionContentRequestFilters] = Field(
        validation_alias="filters", default=None
    )

name class-attribute instance-attribute 

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

type class-attribute instance-attribute 

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

criteria class-attribute instance-attribute 

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

description class-attribute instance-attribute 

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

return_type class-attribute instance-attribute 

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

enabled_in_prod class-attribute instance-attribute 

enabled_in_prod: Optional[bool] = Field(
    validation_alias="enabled_in_prod", default=None
)

needs_ground_truth class-attribute instance-attribute 

needs_ground_truth: Optional[bool] = Field(
    validation_alias="needs_ground_truth", default=None
)

sampling_percentage class-attribute instance-attribute 

sampling_percentage: Optional[float] = Field(
    validation_alias="sampling_percentage", default=None
)

model_provider class-attribute instance-attribute 

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

model_name class-attribute instance-attribute 

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

scale class-attribute instance-attribute 

scale: Optional[int] = Field(
    validation_alias="scale", default=None
)

threshold class-attribute instance-attribute 

threshold: Optional[Dict[str, Any]] = Field(
    validation_alias="threshold", default=None
)

categories class-attribute instance-attribute 

categories: Optional[List[Any]] = Field(
    validation_alias="categories", default=None
)

child_metrics class-attribute instance-attribute 

child_metrics: Optional[List[Any]] = Field(
    validation_alias="child_metrics", default=None
)

filters class-attribute instance-attribute 

filters: Optional[MetricVersionContentRequestFilters] = (
    Field(validation_alias="filters", default=None)
)