EvaluationsResource

Evaluation API methods.

Functions

constructor__init__(client) -> None

Initialize the resource.

paramclientKitaruAPIClient

API client used to send requests.

Returns

None

funccreate(request, idempotency_key=None) -> JobResponse

Score every input session with every evaluator.

paramrequestEvaluationBatchCreateRequest

Evaluation batch create request.

paramidempotency_keystr | None

= None

Idempotency key overriding the transport's random default.

Returns

kitaru.api_models.v1.job.JobResponse

Created job.

funcget(evaluation_id) -> EvaluationResponse

Get an evaluation by id.

paramevaluation_iduuid.UUID

Id of the evaluation.

Returns

kitaru.api_models.v1.evaluation.EvaluationResponse

Stored evaluation.

funclist(params=None) -> Page[EvaluationResponse]

List evaluations.

paramparamsEvaluationListParams | None

= None

Evaluation list params.

Returns

kitaru.api_models.v1.base.Page

Page of evaluations.

funciter(params=None) -> AsyncIterator[EvaluationResponse]

Iterate over all evaluations.

paramparamsEvaluationListParams | None

= None

Evaluation list params.

Returns

collections.abc.AsyncIterator

Async iterator over every evaluation.