aymara_ai.types.eval_update_params

Attributes

GroundTruth

Classes

EvalUpdateParams	dict() -> new empty dictionary
PromptCreate	dict() -> new empty dictionary
PromptUpdate	dict() -> new empty dictionary

Module Contents

class aymara_ai.types.eval_update_params.EvalUpdateParams

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)

workspace_uuid: str

ai_description: str | None

New description of the AI under evaluation.

ai_instructions: str | None

New instructions the AI should follow.

eval_instructions: str | None

New additional instructions for the eval.

ground_truth: GroundTruth | None

New ground truth data or reference file.

name: str | None

New name for the evaluation.

prompt_creates: Iterable[PromptCreate] | None

List of new prompts to add.

prompt_updates: Iterable[PromptUpdate] | None

List of prompt updates to apply.

aymara_ai.types.eval_update_params.GroundTruth: typing_extensions.TypeAlias

class aymara_ai.types.eval_update_params.PromptCreate

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)

content: typing_extensions.Required[str]

Content of the new prompt.

category: str | None

Category of the new prompt.

class aymara_ai.types.eval_update_params.PromptUpdate

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)

prompt_uuid: typing_extensions.Required[str]

UUID of the prompt to update or delete.

action: str

‘update’ or ‘delete’.

Type:

Action to perform

category: str | None

New category for the prompt (if updating).

content: str | None

New content for the prompt (if updating).