Evaluator methods: create, get, list

Reference for Evaluator, one group of Evaluator methods.

Evaluator.create

Creates an Evaluator. Verb page.

TypeScript

interface EvaluatorVerbs {
  create(input: EvaluatorCreateInput, options?: SB.CallOptions): SB.Call<Evaluator>
}

Emits Evaluator.created.

Inputs

Input	Type	Required	Description
`kind`	`string`	required	One of `code`, `generative`, `agentic`, or `human`.
`cascade`	`string[]`		Kinds tried in order when one declines, such as code, then a Human.
`instructions`	`text`		For a generative or agentic Function, what it does and how.
`model`	`string`		For a generative or agentic Function, the model it runs on.
`tools`	list of Verb		For an agentic Function, the Verbs it may call; Permissions and Limits apply to each.
`maxSteps`	`integer`		For an agentic Function, the most steps one Action may take.
`budget`	`money`		The most one Action may spend; the Mandate’s Limits apply as well.
`role`	Role		For a human Function, the Role its Tasks go to.
`form`	`json`		For a human Function, the form; generated from the Verb’s inputs and outputs when absent.
`sla`	`string`		For a human Function, how long a Task may wait, as an ISO 8601 duration.
`escalateTo`	Role		For a human Function, the Role a Task moves to when the service level passes.
`rubric`	`text`	required	What it grades against. An agent never varies its own Evaluators. Never randomized.
`integration`	Integration		The Integration whose outside run returns the verdict, such as a CI job; empty when the platform runs it.
`required`	`boolean`		True when `Change.merge` refuses until this Evaluator passes on the Change’s head. Never randomized.

Returns

Output	Type	Required	Description
`evaluator`	Evaluator	required	The Evaluator.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const evaluator = await $.Evaluator.create({ kind: 'code', rubric: 'Example rubric' })

Returns one Evaluator by id. Verb page.

TypeScript

interface EvaluatorVerbs {
  get(input: EvaluatorGetInput, options?: SB.CallOptions): SB.Call<Evaluator>
}

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Evaluator.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`evaluator`	Evaluator	required	The Evaluator.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const evaluator = await $.Evaluator.get({ id: 'evaluator_cYmeRK4Drs' })

Returns Evaluators, newest first, one page at a time. Verb page.

TypeScript

interface EvaluatorVerbs {
  list(input?: EvaluatorListInput, options?: SB.CallOptions): SB.ListCall<Evaluator>
}

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`evaluators`	list of Evaluator	required	One page of Evaluators.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

TypeScript

import { $ } from 'startup-builder'

const evaluators = await $.Evaluator.list({ limit: 20 })