api.md

Shared Types

from aymara_ai.types import (
    AgentInstructions,
    ContentType,
    FileReference,
    Status,
    Tool,
    ToolArray,
    ToolDict,
    ToolString,
    WorkflowInstructions,
)

Health

Methods:

• client.health.check() -> None

Evals

Types:

from aymara_ai.types import (
    Eval,
    EvalAnalysisRequest,
    EvalPrompt,
    EvalResponse,
    EvalUpdate,
    PromptExample,
    EvalAnalyzeResponse,
)

Methods:

• client.evals.create(**params) -> Eval
• client.evals.update(eval_uuid, **params) -> Eval
• client.evals.list(**params) -> SyncOffsetPage[Eval]
• client.evals.delete(eval_uuid, **params) -> None
• client.evals.analyze(**params) -> EvalAnalyzeResponse
• client.evals.get(eval_uuid, **params) -> Eval
• client.evals.list_prompts(eval_uuid, **params) -> SyncOffsetPage[EvalPrompt]

Runs

Types:

from aymara_ai.types.evals import (
    AnswerHistory,
    AnswerUpdateRequest,
    EvalRunExample,
    EvalRunRequest,
    EvalRunResult,
    ScoredResponse,
    RunGetResponseHistoryResponse,
)

Methods:

• client.evals.runs.create(**params) -> EvalRunResult
• client.evals.runs.list(**params) -> SyncOffsetPage[EvalRunResult]
• client.evals.runs.delete(eval_run_uuid, **params) -> None
• client.evals.runs.get(eval_run_uuid, **params) -> EvalRunResult
• client.evals.runs.get_response_history(response_uuid, *, eval_run_uuid, **params) -> RunGetResponseHistoryResponse
• client.evals.runs.list_responses(eval_run_uuid, **params) -> SyncOffsetPage[ScoredResponse]
• client.evals.runs.score_responses(**params) -> EvalRunResult
• client.evals.runs.update_response(response_uuid, *, eval_run_uuid, **params) -> ScoredResponse

EvalTypes

Types:

from aymara_ai.types import AIInstruction, EvalType

Methods:

• client.eval_types.list(**params) -> SyncOffsetPage[EvalType]
• client.eval_types.find_instructions(**params) -> SyncOffsetPage[AIInstruction]
• client.eval_types.get(eval_type_uuid) -> EvalType
• client.eval_types.list_instructions(eval_type_uuid, **params) -> SyncOffsetPage[AIInstruction]

Reports

Types:

from aymara_ai.types import EvalSuiteReport

Methods:

• client.reports.create(**params) -> EvalSuiteReport
• client.reports.list(**params) -> SyncOffsetPage[EvalSuiteReport]
• client.reports.delete(report_uuid, **params) -> None
• client.reports.get(report_uuid, **params) -> EvalSuiteReport

Files

Types:

from aymara_ai.types import FileDetail, FileFrames, FileStatus, FileUpload, FileCreateResponse

Methods:

• client.files.create(**params) -> FileCreateResponse
• client.files.list(**params) -> SyncOffsetPage[FileDetail]
• client.files.delete(file_uuid) -> None
• client.files.get(file_uuid) -> FileDetail
• client.files.get_frames(file_uuid) -> FileFrames
• client.files.get_status(file_uuid) -> FileStatus
• client.files.upload(**params) -> FileUpload