Skip to content

client.corrector_groups

View as Markdown

client.corrector_groups — the correctorGroups operations.

On AsyncKindgi every method is the same, awaited.

list(
*,
limit: int | None = None,
cursor: str | None = None,
scope_kind: Literal['tenant', 'project', 'agent'] | None = None,
project_id: str | UUID | None = None,
agent_id: str | UUID | None = None,
timeout: float | None = None,
) -> CorrectorGroupCollectionPage
Signature

List corrector groups. GET /v1/corrector-groups

Live groups, newest first, cursor-paginated. ?scopeKind=tenant|project|agent (with projectId / agentId) narrows to one scope.

create(
body: CreateCorrectorGroupBody | Mapping[str, Any] | None = None,
/,
*,
idempotency_key: str | None = None,
timeout: float | None = None,
**fields: Any,
) -> CorrectorGroup
Signature

Create a corrector group. POST /v1/corrector-groups

A named kind of person who corrects with a weight, scoped to the tenant, a project, or an agent in a project. Names are unique among the live groups of a scope. Needs admin on the tenant (tenant scope) or the project.

get(
corrector_group_id: str | UUID,
/,
*,
timeout: float | None = None,
) -> CorrectorGroup
Signature

Fetch a corrector group. GET /v1/corrector-groups/{correctorGroupId}

Also returns a retired group (unregisteredAt set): corrections keep naming theirs.

update(
corrector_group_id: str | UUID,
body: UpdateCorrectorGroupBody | Mapping[str, Any] | None = None,
/,
*,
idempotency_key: str | None = None,
timeout: float | None = None,
**fields: Any,
) -> CorrectorGroup
Signature

Change a corrector group's weight or description. PATCH /v1/corrector-groups/{correctorGroupId}

unregister(
corrector_group_id: str | UUID,
/,
*,
idempotency_key: str | None = None,
timeout: float | None = None,
) -> UnregisterCorrectorGroupResult
Signature

Retire a corrector group. POST /v1/corrector-groups/{correctorGroupId}/unregister

No new corrections may name it; existing corrections keep it.