Source code for aymara_ai.types.eval_create_params

# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

from __future__ import annotations

from typing import Union, Iterable, Optional
from datetime import datetime
from typing_extensions import Required, Annotated, TypeAlias, TypedDict

from .._utils import PropertyInfo
from .shared.status import Status
from .shared.content_type import ContentType
from .prompt_example_param import PromptExampleParam
from .shared_params.file_reference import FileReference

__all__ = ["EvalCreateParams", "GroundTruth"]




class EvalCreateParams(TypedDict, total=False):
    ai_description: Required[str]
    """Description of the AI under evaluation."""

    eval_type: Required[str]
    """Type of the eval (safety, accuracy, etc.)"""

    ai_instructions: Optional[str]
    """Instructions the AI should follow."""

    created_at: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
    """Timestamp when the eval was created."""

    eval_instructions: Optional[str]
    """Additional instructions for the eval, if any."""

    eval_uuid: Optional[str]
    """Unique identifier for the evaluation."""

    ground_truth: Optional[GroundTruth]
    """Ground truth data or reference file, if any."""

    is_jailbreak: bool
    """Indicates if the eval is a jailbreak test."""

    is_sandbox: bool
    """Indicates if the eval results are sandboxed."""

    language: Optional[str]
    """Language code for the eval (default: "en")."""

    modality: ContentType
    """Content type for AI interactions."""

    name: Optional[str]
    """Name of the evaluation."""

    num_prompts: Optional[int]
    """Number of prompts/questions in the eval (default: 50)."""

    prompt_examples: Optional[Iterable[PromptExampleParam]]
    """List of example prompts for the eval."""

    status: Optional[Status]
    """Resource status."""

    updated_at: Annotated[Union[str, datetime, None], PropertyInfo(format="iso8601")]
    """Timestamp when the eval was last updated."""

    workspace_uuid: Optional[str]
    """UUID of the associated workspace, if any."""



GroundTruth: TypeAlias = Union[str, FileReference]