Skip to main content

Is Date (is_date)

Contents​

Metric description​

Is date checks whether the output represents a valid date or datetime, with options for time-of-day, timezone, allowed string formats, and whether only native date or datetime objects are accepted.

How to interpret the score​

  • 100: the value satisfies the configured rules.
  • 0: not a valid date or datetime under those rules.

API usage​

Prerequisites

After the environment variables are configured, the next step is to create a JSON payload for the custom-runs request. For a field-by-field description of the payload (top-level keys, evaluations, and each row in data), see Custom run request body.

Shortname: is_date

Default threshold: 100

Structural metrics run without an LLM (deterministic checks). Your run may still include model_slug where the API expects it; scoring does not depend on it for this category.

Inputs (each object in data)

  • output (str or serialized date/datetime, required): Value to validate (see metric_args for typing rules).

metric_args

  • require_datetime (boolean optional): Require a datetime (with time), not only a date. Default: false.

  • require_timezone (boolean optional): Require a timezone-aware datetime. Default: false.

  • allowed_formats (string[] optional): Allowed strftime-style format strings (e.g. ["%Y-%m-%d"]).

  • strict_type (boolean optional): If true, only native date or datetime objects are accepted (not strings). Default: true.

Eval metadata​

Structural metrics do not populate eval_metadata; the field is omitted or ull on the result object.

Example

import json
import os

import requests
from dotenv import load_dotenv

load_dotenv(override=True)

_API_KEY = os.getenv("AEGIS_API_KEY")
_BASE_URL = os.getenv("AEGIS_API_BASE_URL")
_CUSTOM_RUN_URL = f"{_BASE_URL}/runs/custom"


def post_custom_run(payload: dict) -> requests.Response:
    """POST JSON payload to Aegis custom runs; returns the raw response."""
    headers = {
        "Content-Type": "application/json",
        "Authorization": f"Bearer {_API_KEY}",
    }
    return requests.post(
        _CUSTOM_RUN_URL,
        headers=headers,
        data=json.dumps(payload),
    )


if __name__ == "__main__":
    data = [
        {"output": "2024-01-15"}
    ]

    payload = {
        "threshold": 100,
        "model_slug": "o4-mini",
        "is_blocking": True,
        "data_collection_id": None,
        "evaluations": [
            {
                "metrics": [
                    {
                        "metric": "is_date",
                        "metric_args": {"require_datetime": False, "strict_type": False},
                    },
                ],
                "threshold": 100,
                "model_slug": "o4-mini",
                "data": data,
            }
        ],
    }

    response = post_custom_run(payload)
    response.raise_for_status()
    print(json.dumps(response.json(), indent=2))