EvaluatorsResource

Evaluator API methods.

Functions

constructor__init__(client) -> None

Initialize the resource.

paramclientKitaruAPIClient

API client used to send requests.

Returns

None

funccreate(request, idempotency_key=None) -> EvaluatorResponse

Create an evaluator.

paramrequestEvaluatorCreateRequest

Evaluator create request.

paramidempotency_keystr | None

= None

Idempotency key overriding the transport's random default.

Returns

kitaru.api_models.v1.evaluator.EvaluatorResponse

Created evaluator.

funcget(evaluator_id) -> EvaluatorResponse

Get an evaluator by id.

paramevaluator_iduuid.UUID

Id of the evaluator.

Returns

kitaru.api_models.v1.evaluator.EvaluatorResponse

Stored evaluator.

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

List evaluators.

paramparamsEvaluatorListParams | None

= None

Evaluator list params.

Returns

kitaru.api_models.v1.base.Page

Page of evaluators.

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

Iterate over all evaluators.

paramparamsEvaluatorListParams | None

= None

Evaluator list params.

Returns

collections.abc.AsyncIterator

Async iterator over every evaluator.

funcupdate(evaluator_id, request) -> EvaluatorResponse

Update an evaluator.

paramevaluator_iduuid.UUID

Id of the evaluator.

paramrequestEvaluatorUpdateRequest

Evaluator update request, unset fields stay unchanged.

Returns

kitaru.api_models.v1.evaluator.EvaluatorResponse

Updated evaluator.

funcdelete(evaluator_id) -> None

Delete an evaluator, cascading its versions.

paramevaluator_iduuid.UUID

Id of the evaluator.

Returns

None

funccreate_version(evaluator_id, request, idempotency_key=None) -> EvaluatorVersionResponse

Create an evaluator version.

paramevaluator_iduuid.UUID

Id of the evaluator.

paramrequestEvaluatorVersionCreateRequest

Evaluator version create request.

paramidempotency_keystr | None

= None

Idempotency key overriding the transport's random default.

Returns

kitaru.api_models.v1.evaluator.EvaluatorVersionResponse

Created evaluator version.

funclist_versions(evaluator_id, params=None) -> Page[EvaluatorVersionResponse]

List an evaluator's versions.

paramevaluator_iduuid.UUID

Id of the evaluator.

paramparamsListParams | None

= None

List params.

Returns

kitaru.api_models.v1.base.Page

Page of evaluator versions.

funciter_versions(evaluator_id, params=None) -> AsyncIterator[EvaluatorVersionResponse]

Iterate over all of an evaluator's versions.

paramevaluator_iduuid.UUID

Id of the evaluator.

paramparamsListParams | None

= None

List params.

Returns

collections.abc.AsyncIterator

Async iterator over every evaluator version.

funcget_version(evaluator_id, version) -> EvaluatorVersionResponse

Get an evaluator version by version number.

paramevaluator_iduuid.UUID

Id of the evaluator.

paramversionint

Version number.

Returns

kitaru.api_models.v1.evaluator.EvaluatorVersionResponse

Stored evaluator version.

funcupdate_version(evaluator_id, version, request) -> EvaluatorVersionResponse

Update an evaluator version's display version.

paramevaluator_iduuid.UUID

Id of the evaluator.

paramversionint

Version number.

paramrequestEvaluatorVersionUpdateRequest

Evaluator version update request, unset fields stay unchanged.

Returns

kitaru.api_models.v1.evaluator.EvaluatorVersionResponse

Updated evaluator version.

FunctionsCopy Anchor Link

On this page

Functions