aymara_ai.types.eval_create_params#
Attributes#
Classes#
dict() -> new empty dictionary |
Module Contents#
- class aymara_ai.types.eval_create_params.EvalCreateParams[source]#
Bases:
typing_extensions.TypedDict
dict() -> new empty dictionary dict(mapping) -> new dictionary initialized from a mapping object’s
(key, value) pairs
- dict(iterable) -> new dictionary initialized as if via:
d = {} for k, v in iterable:
d[k] = v
- dict(**kwargs) -> new dictionary initialized with the name=value pairs
in the keyword argument list. For example: dict(one=1, two=2)
- ai_description: typing_extensions.Required[str]#
Description of the AI under evaluation.
- eval_type: typing_extensions.Required[str]#
Type of the eval (safety, accuracy, etc.)
- ai_instructions: str | None#
Instructions the AI should follow.
- created_at: typing_extensions.Annotated[str | datetime.datetime | None, PropertyInfo(format='iso8601')]#
Timestamp when the eval was created.
- eval_instructions: str | None#
Additional instructions for the eval, if any.
- eval_uuid: str | None#
Unique identifier for the evaluation.
- ground_truth: GroundTruth | None#
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: str | None#
“en”).
- Type:
Language code for the eval (default
- modality: aymara_ai.types.shared.content_type.ContentType#
Content type for AI interactions.
- name: str | None#
Name of the evaluation.
- num_prompts: int | None#
50).
- Type:
Number of prompts/questions in the eval (default
- prompt_examples: Iterable[aymara_ai.types.prompt_example_param.PromptExampleParam] | None#
List of example prompts for the eval.
- status: aymara_ai.types.shared.status.Status | None#
Resource status.
- updated_at: typing_extensions.Annotated[str | datetime.datetime | None, PropertyInfo(format='iso8601')]#
Timestamp when the eval was last updated.
- workspace_uuid: str | None#
UUID of the associated workspace, if any.
- aymara_ai.types.eval_create_params.GroundTruth: typing_extensions.TypeAlias#