> ## Documentation Index > Fetch the complete documentation index at: https://docs.brussle.com/llms.txt > Use this file to discover all available pages before exploring further. # Detach an inherited judgment from its template > Turns a judgment the namespace inherits from a template into an ordinary judgment of the namespace, a copy of the current version. The copy keeps the template's version numbers, up to and including the active version, which stays active, so existing answers still name a version the judgment has. Its thresholds and freshness settings are the ones the namespace had, override or inherited. It no longer follows the template. Answers and evaluations stay where they are. Detaching a judgment the namespace already owns changes nothing and returns it, so a retry is safe. Takes no body. ## OpenAPI ````yaml /api-reference/openapi.yaml post /namespaces/{ns}/judgments/{name}/detach openapi: 3.1.0 info: title: Brussle API version: '1' license: name: Proprietary identifier: LicenseRef-Proprietary description: | The `/v1` contract. It is locked: changes within `/v1` are additive only, and anything breaking is `/v2`. - **Base URL.** `https://api.brussle.com/v1`. - **Evolution.** Response objects may gain fields and enums may gain values. Clients must ignore what they do not know. Request objects reject unknown fields. - **Path segments.** Namespace names (`{ns}`) and document ids (`{id}`) may contain `/`. Send it percent-encoded as `%2F`, so that `acme/prod/tenant_123` is `acme%2Fprod%2Ftenant_123`. - **Templates.** The judgment routes also take a namespace prefix ending in `/*`, such as `acme%2Fprod%2F*`. A judgment created there is a template: every namespace under the prefix inherits it, including ones created later. The most specific matching prefix wins. - **Thresholds are settings.** Named thresholds belong to the judgment, not to a version. They are evaluated at read time against the raw fields, so a change applies at once to every answer, with no recompute and no new version. - **Entity judgments.** A judgment can read the documents that point at the judged one, through `context.related`, and apply only to documents matching `applies_to`. Its answers carry a `watermark`, and creating one that runs `on_change` returns a replay estimate of its monthly cost until you confirm. - **Referenced documents.** A relation can also read the one document the judged document points at, through `join: {theirs: "id", mine: "attributes."}`. A change to what the relation renders of that document re-judges the judged documents that point at it and are inside `freshness.fanout.scope`: a fan-out. - **Relations.** A relation can read plain judgments' answers (banded or cut, never summed), or be a blocking relation over the documents that share a key, which a `choice` can choose among with `options.from`. A recipe can read the document as the judgment last saw it (`context.previous`). A judgment that can fan out confirms its rolling limits once, at create; past them, work is deferred, reads `stale` with an event, and catches up on its own. Nothing waits for a confirm at runtime. Groups keep aggregates per key value for reporting. - **Idempotency.** Every write operation is idempotent by construction: a retried append adds nothing while its values are still in the array, and a retried upsert or patch sets the same content again. Every request that changes something also takes an `Idempotency-Key`, so that creates, activations, backfills, draws and the rest can be retried safely too: a retry with the key gets the first response back, verbatim and marked `Idempotent-Replayed: true`, instead of running again (see the parameter). - **Errors.** Every error is the `Error` envelope; the HTTP status follows the code (see each response). - **Rate limits.** Every response to a request whose key was accepted carries `X-RateLimit-Limit` and `X-RateLimit-Remaining`, which count the key's requests a second; a request refused before its key is checked (`unauthorized`, or a route that does not exist) carries neither. A `rate_limited` response adds `Retry-After`, except a daily allowance that is used up, which says when it renews in `details.resets_at` instead. Every `503` carries `Retry-After` too. Reads of one namespace also have a concurrency limit: past 32 gets and queries in flight at once, one more is `rate_limited` with `Retry-After` and `details.concurrent_reads`, whatever the rate-limit headers show. - **Usage.** Every response that bills carries `usage`. Judging is billed per judgment, engine-neutral, by size class: one judgment answered counts by the tokens of its compiled context and its question together, 1 if standard (up to 2,000 tokens), 4 if large (up to 8,000) and 16 if extra-large (up to 32,000, the engine maximum). No response ever carries an engine's price. servers: - url: https://api.brussle.com/v1 security: - apiKey: [] tags: - name: Namespaces description: Namespaces, their settings and cache warming. - name: Documents description: Writes, point reads and queries. - name: Judgments description: >- Judgment definitions, versions, settings, activation, backfill and template detach. - name: Outcomes and calibration description: | Post what actually happened to judged documents, and read how well answers match it: the calibration report, calibrated answers and threshold recommendations. See [calibration](/concepts/calibration). - name: Groups description: > Groups keep aggregates per value of a key attribute, a group-by you declare for reporting; a template's tenant summary publishes each tenant's groups, banded, as a document the platform can judge. - name: Jobs description: >- Backfill, shadow, periodic, deletion, reference index, evaluation export, resync, group build, discovery and simulation jobs. - name: Engines description: The engine registry. - name: Organization description: | Settings of the whole organization: prefixes marked non-production, which the tenant fee and template calibration pools leave out. - name: Subscriptions description: | Saved queries that send an event when a document starts or stops matching: the query's filter grammar, on a namespace or a template prefix, with the fields each event carries. - name: Webhooks description: | Webhook endpoints, the events feed, the delivery log, redelivery and recovery. Every event type and its body is under `webhooks`. Events are delivered at least once, signed as Standard Webhooks, and kept for 30 days. Webhooks are on every plan, and deliveries are not billed; plans set how many endpoints an organization has. paths: /namespaces/{ns}/judgments/{name}/detach: parameters: - $ref: '#/components/parameters/Namespace' - $ref: '#/components/parameters/JudgmentName' post: tags: - Judgments summary: Detach an inherited judgment from its template description: > Turns a judgment the namespace inherits from a template into an ordinary judgment of the namespace, a copy of the current version. The copy keeps the template's version numbers, up to and including the active version, which stays active, so existing answers still name a version the judgment has. Its thresholds and freshness settings are the ones the namespace had, override or inherited. It no longer follows the template. Answers and evaluations stay where they are. Detaching a judgment the namespace already owns changes nothing and returns it, so a retry is safe. Takes no body. operationId: detachJudgment parameters: - $ref: '#/components/parameters/IdempotencyKey' responses: '200': description: The judgment, now the namespace's own. headers: X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' content: application/json: schema: $ref: '#/components/schemas/Judgment' '400': $ref: '#/components/responses/InvalidRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '409': $ref: '#/components/responses/Conflict' '413': $ref: '#/components/responses/TooLarge' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/Internal' components: parameters: Namespace: name: ns in: path required: true description: The namespace name, with any `/` sent as `%2F`. schema: $ref: '#/components/schemas/NamespaceName' JudgmentName: name: name in: path required: true schema: $ref: '#/components/schemas/Name' IdempotencyKey: name: Idempotency-Key in: header description: | One key per logical request, reused only on its retries. A key belongs to one request: within your organization, the same method, path, query and body. For 24 hours after a successful response, a request with the key and the same body gets that response back verbatim, with `Idempotent-Replayed: true`, and runs nothing. Only a successful response is kept, so the retry of a request that failed runs again. While the first request runs or its response is kept, the key with a different request is `idempotency_key_reused` (422). A request sent while one with its key is still running is `rate_limited` with `Retry-After: 1`, without running: retry it to get the first one's response. In the rare case the key can't be checked, the request runs as if it had none. schema: type: string minLength: 1 maxLength: 255 headers: RateLimitLimit: description: >- Requests allowed per second for this key. Only on responses to a request whose key was accepted. schema: type: integer minimum: 0 RateLimitRemaining: description: >- Requests left in the current one-second window for this key. It does not count the per-namespace limit on reads in flight. schema: type: integer minimum: 0 RetryAfter: description: Seconds to wait before retrying. schema: type: integer minimum: 0 schemas: Judgment: type: object required: - name - active_version - freshness - thresholds - outcomes - versions properties: name: $ref: '#/components/schemas/Name' active_version: description: Null once the judgment is deactivated. oneOf: - $ref: '#/components/schemas/JudgmentVersionNumber' - type: 'null' freshness: $ref: '#/components/schemas/FreshnessSettings' thresholds: $ref: '#/components/schemas/ThresholdSettings' outcomes: $ref: '#/components/schemas/OutcomeSettings' template: $ref: '#/components/schemas/NamespaceOrTemplate' description: >- Present when the judgment is inherited, the template prefix it comes from, such as `acme/prod/*`. overrides: type: array description: >- Present when the judgment is inherited. The settings this namespace overrides; the others follow the template. uniqueItems: true items: type: string enum: - thresholds - freshness fanout_sources: $ref: '#/components/schemas/FanoutSources' fanout_window: $ref: '#/components/schemas/FanoutWindow' escape_alert: $ref: '#/components/schemas/EscapeAlert' warnings: type: array description: >- Conditions to act on, such as `taxonomy_drift`. Absent when there are none. items: $ref: '#/components/schemas/JudgmentWarning' readers: type: array description: >- The judgments whose relations read this one's answers. While there are any, deleting or deactivating it, a policy other than `on_change`, or a version that is not plain or narrows `applies_to` below a reader's `match` is `conflict` naming them. Absent when there are none. items: $ref: '#/components/schemas/Name' versions: type: array description: >- Every version, oldest first. Versions are kept until the namespace is deleted. items: $ref: '#/components/schemas/JudgmentVersion' stats: $ref: '#/components/schemas/JudgmentStats' NamespaceName: type: string description: >- Up to 256 bytes. `/` separates levels of the hierarchy, as in `acme/prod/tenant_123`. Never exactly `.` or `..`, which a URL path can't carry. pattern: ^(?!\.\.?$)[A-Za-z0-9._:/-]+$ minLength: 1 maxLength: 256 Name: type: string description: >- A judgment, attribute or threshold name. Names are path segments in field references, so they never contain `.`. pattern: ^[A-Za-z0-9_-]+$ minLength: 1 maxLength: 128 JudgmentVersionNumber: type: integer format: int32 minimum: 1 FreshnessSettings: type: object description: Settings, not part of the definition. Changing them creates no version. additionalProperties: false properties: policy: $ref: '#/components/schemas/FreshnessPolicy' debounce_ms: type: integer minimum: 0 default: 0 description: >- A document changed more recently than this is not judged until it settles. interval: $ref: '#/components/schemas/Duration' description: >- Recompute interval for `periodic`, such as `1h` or `1d`. At least `1h`, because each run re-judges the whole namespace; a shorter one is `invalid_request`. max_wait_ms: type: - integer - 'null' minimum: 1 description: | The debounce ceiling: a document that keeps changing is still judged once this long has passed since its oldest unjudged change. At least `debounce_ms`; `null` means no ceiling. Defaults to 12 × `debounce_ms` for an entity judgment with a `debounce_ms` above 0, and to no ceiling otherwise: with no debounce a document is judged at once. `GET` returns the value in effect. fanout: $ref: '#/components/schemas/FanoutSettings' if: required: - policy properties: policy: const: periodic then: required: - interval ThresholdSettings: type: object description: | The judgment's named thresholds, a setting rather than part of a version. Each is a number for a bool judgment (true when `p` is at least it) or a score judgment (true when `score` is at least it), and `{value, gte}` for a choice judgment (true when `dist[value]` is at least `gte`). They are evaluated at read time against the raw fields, never the `calibrated` ones. A threshold that does not fit the judgment's type is `invalid_request`. propertyNames: $ref: '#/components/schemas/Name' additionalProperties: oneOf: - type: number - $ref: '#/components/schemas/ChoiceThreshold' OutcomeSettings: type: object description: | How the judgment's outcomes are read and derived, a setting rather than part of a version. See [calibration](/concepts/calibration). additionalProperties: false properties: rules: type: array maxItems: 4 items: $ref: '#/components/schemas/OutcomeRule' description: | Derive outcomes from the judged document's own writes, so labels arrive without posting them. Each rule is checked on every write to a document from when it is set; earlier writes are never replayed. Derived outcomes are stored with the write, join like posted ones, and a posted outcome beats a derived one in the same prediction window. With a `0s` horizon, a derived outcome labels the answer to the document as it was just before the write that revealed it. Omitted when there are none. Not accepted on a template's prefix path. Setting rules needs the Team plan or above (`plan_required`); clearing them never does. Outcomes derived while the plan does not include rules are kept but left out of calibration (`rule_outcomes_paused` in the report). implicit_negatives: type: boolean default: false description: | For a `bool` judgment with a non-zero `horizon` only. When true, a prediction window that has closed with no outcome counts as a `false` outcome, so you only need to post what happened. A window still open counts nothing yet, one whose document was deleted before it closed is left out unless an outcome labels it, and one opened at or after a `true` for the document is left out; the report counts them in `censored_predictions`. Leave it off when a missing outcome does not mean "no", for example when you only record some of what happens. On a namespace that inherits the judgment, set it on the template's prefix path: its calibration is shared. NamespaceOrTemplate: type: string description: | A namespace name, or a template prefix: a namespace path ending in `/*`, such as `acme/prod/*`, which every namespace under `acme/prod/` inherits judgments from. Up to 256 bytes. Never exactly `.` or `..`, which a URL path can't carry. pattern: ^(?!\.\.?$)[A-Za-z0-9._:/-]+(/\*)?$ minLength: 1 maxLength: 256 FanoutSources: type: object description: > Where each value in `freshness.fanout` comes from, key for key. Present exactly when `freshness.fanout` is. A `where` removed with `null` is the default, no filter; any other `null` the judgment set, such as `created_within: null`, is the judgment's. required: - scope - debounce_ms - max_wait_ms properties: scope: type: object required: - created_within - where properties: created_within: $ref: '#/components/schemas/FanoutSource' where: $ref: '#/components/schemas/FanoutSource' debounce_ms: $ref: '#/components/schemas/FanoutSource' max_wait_ms: $ref: '#/components/schemas/FanoutSource' rolling_limit: $ref: '#/components/schemas/FanoutSource' block_cap: $ref: '#/components/schemas/FanoutSource' FanoutWindow: type: object description: | Response only. How much of `freshness.fanout.rolling_limit` the judgment's fan-outs have used: the re-judgments counted in the rolling 30-day window. Present exactly when `freshness.fanout` is. A fan-out that would take `used` past the limit is deferred. required: - used - rolls_at properties: used: type: integer format: int64 minimum: 0 description: >- Judged documents re-judged by the judgment's fan-outs in the last 30 days. rolls_at: description: >- When the window next rolls past a day that counts, freeing its re-judgments; null when nothing counts. oneOf: - $ref: '#/components/schemas/Timestamp' - type: 'null' EscapeAlert: description: | A setting of a fixed-option `choice`: when the share of its answers over the last 7 days that are `none_of_the_above` rises above this, the judgment gains the `taxonomy_drift` warning and the events feed one `judgment.taxonomy_drift`. Null (the default) turns it off. Nothing changes on its own: run `discover` when you want proposals. oneOf: - type: number exclusiveMinimum: 0 maximum: 1 - type: 'null' JudgmentWarning: type: object description: >- The `taxonomy_drift` warning. The escape share over the last 7 days (`escape_share`) is above `escape_alert`; it clears when the share falls back. required: - code - message properties: code: type: string enum: - taxonomy_drift message: type: string escape_share: type: number minimum: 0 maximum: 1 since: $ref: '#/components/schemas/Timestamp' description: When the share rose above the alert. JudgmentVersion: type: object required: - version - created_at - definition properties: version: $ref: '#/components/schemas/JudgmentVersionNumber' created_at: $ref: '#/components/schemas/Timestamp' definition: $ref: '#/components/schemas/JudgmentDefinition' JudgmentStats: type: object description: > Today's evaluations of the judgment in this namespace, UTC. The dashboard's per-judgment numbers. Before the day's first evaluation only `day`, `evaluations` (0) and `spend_usd` (0) are present. required: - day - evaluations - spend_usd properties: day: type: string format: date description: Today, UTC, as `yyyy-mm-dd`. evaluations: type: integer format: int64 minimum: 0 description: Evaluations recorded today, successful or not. tokens_per_document: type: - number - 'null' minimum: 0 description: Mean compiled context tokens per evaluation. truncation_rate: type: - number - 'null' minimum: 0 maximum: 1 description: The share of evaluations whose context was truncated to fit. error_rate: type: - number - 'null' minimum: 0 maximum: 1 description: The share of evaluations that failed. freshness_lag_p90_ms: type: - number - 'null' minimum: 0 description: >- Freshness lag p90, from a write to its answer's commit, in milliseconds. spend_usd: type: number minimum: 0 description: Judging billed today, in US dollars, at your judgment prices. Error: type: object required: - error properties: error: type: object required: - code - message properties: code: $ref: '#/components/schemas/ErrorCode' message: type: string details: type: object description: >- Code-specific detail, such as the scan estimate on a refused query. Every `internal` error has `request_id`. properties: reason: type: string description: > Why, where one code has more than one cause. On `forbidden`, `payment_overdue`: a payment has been unpaid for 14 days, so the organization's keys are read-only until it is paid; reads still work, and paying restores writes within a few minutes. A key that is read-only itself is `forbidden` without a `reason`. On the events feed's `invalid_request`, `cursor_expired`. suggested_context: description: >- On a create without a context recipe, the recipe suggested from the namespace's documents, or null when there are none. oneOf: - $ref: '#/components/schemas/SuggestedContext' - type: 'null' FreshnessPolicy: type: string description: | `on_read` (default) computes on first read, then caches until the document changes; it cannot be used in a query filter or rank. `on_change` recomputes whenever a document changes, the policy for a judgment filtered or ranked on. `periodic` recomputes every `interval`. `manual` is backfill only. A query can filter and rank on `on_change`, `periodic` and `manual` answers, as stored. enum: - on_read - on_change - periodic - manual Duration: type: string description: A whole number and a unit (`s`, `m`, `h` or `d`), such as `7d` or `1h`. pattern: ^[1-9][0-9]*[smhd]$ FanoutSettings: type: object description: > For a judgment with a relation that reads a referenced document, or a blocking relation: which judged documents a change re-judges, and when. Only a change to what the relation renders counts. Every key is optional in a request, and `GET` returns every value in effect for a judgment that can fan out. In a `PATCH`, the keys you send replace those keys and the others keep their values. No fan-out waits for a confirm. You confirm the rolling limit once, when you create the judgment; a fan-out that would pass it, or a block past `block_cap`, is deferred, its answers read `stale` (`limit_reached`) with a `judgment.limit_reached` event, and it runs once the window has room or a `PATCH` raises the limit. additionalProperties: false minProperties: 1 properties: scope: $ref: '#/components/schemas/FanoutScope' debounce_ms: type: integer minimum: 0 default: 600000 description: >- A referenced document that changed more recently than this is not fanned out until it settles, so a burst of changes to it costs one fan-out. Counts changes to what the relation renders, per referenced document (per block). The judgment's own `debounce_ms` still governs the judged documents' own writes. max_wait_ms: type: - integer - 'null' minimum: 1 description: >- The ceiling. A referenced document that keeps changing still fans out once this long has passed since its oldest change not yet fanned out. At least `debounce_ms`; `null` means no ceiling. Defaults to 6 × `debounce_ms`, one hour at the default debounce. rolling_limit: type: - integer - 'null' format: int64 minimum: 0 default: 300000 description: >- The most judged documents this judgment's referenced and block changes re-judge in any 30 days, confirmed when you create the judgment. A fan-out that would take the window past it is deferred until the window has room. `null` removes the limit, so every change re-judges every in-scope document, with no deferral, and the namespace budget alone bounds it. block_cap: type: integer format: int64 minimum: 1 default: 1000 description: >- For a blocking relation. The most judged documents one key value's block may hold. At create, a key value over it is `invalid_request`; a block that grows past it later is deferred, its answers `stale` (`limit_reached`) with a `judgment.limit_reached` event naming the key value, until the cap is raised. ChoiceThreshold: type: object additionalProperties: false required: - value - gte properties: value: type: string minLength: 1 gte: $ref: '#/components/schemas/Probability' OutcomeRule: type: object description: > One outcome rule: when a write changes the value at `when.path` to the target, the write is an outcome with `value`, or the value at `from` after the write. A write that leaves the value where it was, a retry included, derives nothing, and a delete never does. A write that creates the document compares with nothing. Checked against the judgment's type when set: a `bool` takes `value` `true` or `false`, a `choice` an option and a `score` a level. A `from` value that does not fit (or a missing `from` path) is kept but adds no sample; the report counts it in `unmatched_outcomes.does_not_fit`. `on` instead of `when` fires when the value at the path goes from absent or null to present, such as a payment's `state.settles` recorded when it is matched. A rule is checked on a write when the document matched the judgment's `applies_to` before it, so the write that takes a matched document out of `applies_to` still produces its outcome. additionalProperties: false anyOf: - required: - when - required: - 'on' not: description: A rule has `when` or `on`, not both. required: - when - 'on' oneOf: - required: - value - required: - from properties: when: $ref: '#/components/schemas/OutcomeRuleCondition' 'on': $ref: '#/components/schemas/DocumentPath' description: Fires when this path goes from absent or null to present. value: description: The outcome, a constant matching the judgment type. type: - boolean - string - integer from: $ref: '#/components/schemas/DocumentPath' description: >- For `choice` and `score` judgments, the path whose value after the write is the outcome, such as a ticket's final `state.team`. A number with no fraction reads as a level. FanoutSource: type: string description: | Where a fan-out value in effect comes from: `judgment` when the judgment set it (on an inherited judgment, its template or this namespace's override), and `default` for the built-in default. enum: - judgment - default Timestamp: type: string format: date-time description: RFC 3339, UTC. JudgmentDefinition: type: object description: | A judgment definition, discriminated on `type`. `thresholds` are the named thresholds given with this version. They are not part of the version: the judgment's current thresholds are its `thresholds` setting, evaluated at read time and returned as booleans under `answers.{name}.thresholds`. oneOf: - $ref: '#/components/schemas/BoolJudgmentDefinition' - $ref: '#/components/schemas/ChoiceJudgmentDefinition' - $ref: '#/components/schemas/ScoreJudgmentDefinition' discriminator: propertyName: type mapping: bool: $ref: '#/components/schemas/BoolJudgmentDefinition' choice: $ref: '#/components/schemas/ChoiceJudgmentDefinition' score: $ref: '#/components/schemas/ScoreJudgmentDefinition' ErrorCode: type: string description: | HTTP status by code: `invalid_request` 400, `unauthorized` 401, `budget_exceeded` 402, `plan_required` 402, `forbidden` 403, `not_found` 404, `conflict` 409, `too_large` 413, `engine_version_unavailable` 422, `insufficient_labels` 422, `idempotency_key_reused` 422, `rate_limited` 429, `internal` 500, `engine_unavailable` 503, `unavailable` 503. enum: - invalid_request - unauthorized - forbidden - not_found - conflict - too_large - rate_limited - budget_exceeded - plan_required - engine_unavailable - engine_version_unavailable - unavailable - insufficient_labels - idempotency_key_reused - internal SuggestedContext: type: object description: | The recipe suggested for a create without `context`, in the refusal's `details.suggested_context`. From a sample of the documents the definition applies to: it keeps short text, numbers, booleans and small attributes, and leaves out ids, timestamps, links, binary-looking and very long values, and rarely present fields; `excluded` says why for each. `max_tokens` is set to keep the context in the standard size class, at most 2,000. The same documents always give the same recipe. required: - recipe - cost_per_answer - whole_state_cost_per_answer - sampled_documents - excluded properties: recipe: $ref: '#/components/schemas/ContextRecipe' cost_per_answer: type: - number - 'null' minimum: 0 description: >- Mean judgments per answer, counted by size class, over the sample with this recipe and the definition's question. The suggested `max_tokens` is at most 2,000, the standard ceiling, less the question's tokens, so a context that fills it stays standard with its question. whole_state_cost_per_answer: type: - number - 'null' minimum: 0 description: The same with the whole `state`. sampled_documents: type: integer minimum: 1 excluded: type: array description: >- Each path left out, and why, so you can put back what the question needs. items: type: object required: - path - reason properties: path: type: string reason: type: string enum: - id - timestamp - url - binary - long - rare - too_many FanoutScope: type: object description: | The re-judge scope: which judged documents a change to a referenced document at log position c re-judges. At the fan-out's snapshot, a judged document is in scope when it points at the referenced document, matches `applies_to` and `where`, and was created no more than `created_within` before the write at c. A judged document outside the scope is not re-judged: its answer reads `stale` with `stale_reason` `referenced_changed` until the document is judged again, and its `watermark` says which version of the referenced document it read. additionalProperties: false minProperties: 1 properties: created_within: description: >- Only judged documents created no more than this long before the change. `null` means all of them. Defaults to `30d`. oneOf: - $ref: '#/components/schemas/Duration' - type: 'null' where: description: >- Narrows the scope to judged documents whose attributes match, such as `{"attributes.status": "open"}`. `null` removes it. None by default. oneOf: - $ref: '#/components/schemas/AttributeFilter' - type: 'null' Probability: type: number minimum: 0 maximum: 1 description: > Answers keep probabilities to about seven significant digits and return them as the shortest decimal that stands for the stored value, so an engine's 0.01 reads 0.01. Thresholds, query filters and threshold recommendations compare that decimal. OutcomeRuleCondition: type: object description: | The value at `path` becomes `becomes`, or one of `in`, in this write. It fires only when the value was not already the target (for `in`, not already in the list); numbers compare by value. additionalProperties: false required: - path oneOf: - required: - becomes - required: - in properties: path: $ref: '#/components/schemas/DocumentPath' becomes: type: - string - number - boolean in: type: array minItems: 1 maxItems: 16 items: type: - string - number - boolean DocumentPath: type: string description: >- One attribute, `attributes.`, or a key path inside state, `state.[....]`. pattern: ^(attributes\.[A-Za-z0-9_-]+|state(\.[^.]+)+)$ examples: - attributes.status - state.team BoolJudgmentDefinition: type: object description: | The answer has `p`. With `parts` it is a composite judgment: the engine is asked each part instead of `question`, and `p` combines the parts' answers with weights fitted on the judgment's outcomes. required: - type allOf: - $ref: '#/components/schemas/JudgmentDefinitionCommon' dependentRequired: features: - parts not: description: A single part needs features. required: - parts properties: parts: type: array maxItems: 1 not: required: - features properties: type: const: bool thresholds: type: object description: Each threshold is true when `p` is at least the value. propertyNames: $ref: '#/components/schemas/Name' additionalProperties: $ref: '#/components/schemas/Probability' parts: type: array description: | Composite judgments only: 2 to 8 narrow yes/no questions with names unique within the judgment. They share the judgment's context recipe and engine, so they go in one engine request with its other questions, and each counts toward the 32 questions per request. `question` then documents what the combination means and is not sent to the engine. Parts are part of the version. They cannot reference other judgments. Each part is billed as a judgment. With `features`, one part is enough. minItems: 1 maxItems: 8 items: $ref: '#/components/schemas/JudgmentPart' features: type: array description: | Composite judgments only: aggregates over related documents that the combiner takes as numeric inputs beside the parts. Each names an aggregate the recipe's `related` declares. Features are scaled automatically beside the parts; a missing value counts as typical. Features add no questions, so they are never billed. minItems: 1 maxItems: 8 uniqueItems: true items: $ref: '#/components/schemas/FeatureRef' ChoiceJudgmentDefinition: type: object description: | The answer has `value`, `dist` and `escape_p`. The API appends `none_of_the_above` as a final option on every choice judgment. required: - type - options allOf: - $ref: '#/components/schemas/JudgmentDefinitionCommon' properties: type: const: choice options: description: >- The options, whose values must be distinct; or `{from, label}`, one option per document a blocking relation of the recipe selects. oneOf: - type: array minItems: 2 maxItems: 254 items: $ref: '#/components/schemas/ChoiceOption' - $ref: '#/components/schemas/OptionsFrom' thresholds: type: object description: Each threshold is true when `dist[value]` is at least `gte`. propertyNames: $ref: '#/components/schemas/Name' additionalProperties: $ref: '#/components/schemas/ChoiceThreshold' ScoreJudgmentDefinition: type: object description: >- The answer has `score`, the probability-weighted mean of level values, and `dist`. required: - type - levels allOf: - $ref: '#/components/schemas/JudgmentDefinitionCommon' properties: type: const: score levels: type: array description: Ordered; level values must be distinct. minItems: 2 maxItems: 10 items: $ref: '#/components/schemas/ScoreLevel' thresholds: type: object description: Each threshold is true when `score` is at least the value. propertyNames: $ref: '#/components/schemas/Name' additionalProperties: type: number ContextRecipe: type: object description: | What the engine sees. A create without it is refused with a suggested recipe, unless `use_context` asks for the suggestion or the whole `state`; a version with no recipe sends the whole `state`, subject to the engine limit. additionalProperties: false properties: fields: type: array description: Paths included verbatim, in order. items: type: string pattern: ^(state|attributes)(\.[^.]+)+$ last_n: type: object description: Per array path, keep the last n elements. additionalProperties: type: integer minimum: 1 window: type: object description: >- Per array path whose elements have a timestamp field `at`, keep elements within the window. additionalProperties: $ref: '#/components/schemas/Duration' max_tokens: type: integer minimum: 1 description: Hard cap; the compiler truncates from the end of the last field. related: type: object description: > Up to 4 relations, by name: documents in the same namespace that point at the judged one, or the one document it points at. Each renders as a `related.` entry after `fields`, and a write that changes what it renders makes the judged document's answer `pending` until it is judged again (for a referenced document, only inside the re-judge scope; outside it, the answer is `stale` with `stale_reason` `referenced_changed`). minProperties: 1 maxProperties: 4 propertyNames: $ref: '#/components/schemas/Name' additionalProperties: $ref: '#/components/schemas/Relation' previous: $ref: '#/components/schemas/PreviousRecipe' AttributeFilter: type: object description: > Which documents something applies to, by their attributes. Each key is an attribute path; a value is equality, and a list of values is `In`, as in query filters. Keys combine with `And`. minProperties: 1 maxProperties: 8 propertyNames: type: string pattern: ^attributes\.[A-Za-z0-9_-]+$ additionalProperties: oneOf: - $ref: '#/components/schemas/AttributeFilterValue' - type: array minItems: 1 items: $ref: '#/components/schemas/AttributeFilterValue' JudgmentDefinitionCommon: type: object required: - name - question properties: name: $ref: '#/components/schemas/Name' question: type: string minLength: 1 criteria: type: string context: $ref: '#/components/schemas/ContextRecipe' engine: $ref: '#/components/schemas/EngineRef' description: >- Must be `active` in the registry. May be omitted only when the namespace has a `default_engine`. horizon: $ref: '#/components/schemas/Horizon' description: | How far before `observed_at` an outcome's prediction was made, such as `30d` for "churned within 30 days". Part of the definition, so changing it creates a version. Defaults to `0s`, which joins labelled examples to current answers. applies_to: $ref: '#/components/schemas/AttributeFilter' description: > The judgment judges, answers and bills only documents whose attributes match. A document that does not match has no answer for it: `answers` omits it. Part of the definition, so changing it creates a version. JudgmentPart: type: object description: One part of a composite judgment. additionalProperties: false required: - name - question properties: name: $ref: '#/components/schemas/Name' question: type: string minLength: 1 description: A narrow yes/no question about the document. FeatureRef: type: string description: | An aggregate the recipe declares, as `.count` or `.()`, such as `tickets.count` or `invoices.sum(state.amount)`. pattern: >- ^[A-Za-z0-9_-]+\.(count|(sum|min|max|latest)\((state|attributes)(\.[^.()]+)+\))$ ChoiceOption: type: object additionalProperties: false required: - value properties: value: type: string minLength: 1 not: const: none_of_the_above description: type: string OptionsFrom: type: object description: | Choose among a blocking relation's documents in one call: one option per selected candidate, in the relation's order, `value` its `id` and each candidate described by its `label` fields, then `none_of_the_above`. `from` names a blocking relation of the recipe with `last_n` at most the `options.from` candidate limit (see Limits). A judged document with no candidates is answered `none_of_the_above` with `escape_p` 1 and no engine call. `dist` is a shortlist, not a ranking: past the first few candidates the probabilities tie at zero. The judgment is not plain, so no relation can read it, and its `horizon` must be `0s`. additionalProperties: false required: - from - label properties: from: $ref: '#/components/schemas/Name' description: A blocking relation in the recipe's `related`. label: type: array description: The candidate's paths that describe it to the engine, in order. minItems: 1 maxItems: 8 items: $ref: '#/components/schemas/RelationField' ScoreLevel: type: object additionalProperties: false required: - value - label properties: value: type: integer label: type: string minLength: 1 description: type: string Relation: type: object description: | Documents that point at the judged document. They are ordered newest `created_at` first: `window` keeps those created within the window, then `last_n` keeps the newest n. At least one of `last_n` and `window` is required, and at least one of `fields` and `aggregate`. A relation reads at most the newest 1,000 documents. With `join: {theirs: "id", mine: "attributes."}` the relation reads the one document the judged document points at, its referenced document, and takes neither `last_n` nor `window`. With `join: {theirs: "attributes.", mine: "attributes."}` it is a blocking relation over the documents that share the judged document's key value. It needs `window`, takes `last_n` up to 254 (up to the `options.from` candidate limit when a `choice` chooses among it with `options.from`), and a change to its block re-judges the block's judged documents. `fields`, `aggregate` and `match` may read plain judgments' answers (`answers..`), banded or cut. additionalProperties: false required: - match - join allOf: - description: A relation renders fields or aggregates. if: not: required: - fields then: required: - aggregate - description: >- A relation over the documents that point at the judged one is bounded by `last_n` or `window`. if: properties: join: type: object properties: mine: const: id then: anyOf: - required: - last_n - required: - window - description: >- A relation that reads the referenced document takes neither `last_n` nor `window`. if: properties: join: type: object properties: theirs: const: id then: not: anyOf: - required: - last_n - required: - window - description: A blocking relation needs `window`, and reads at most 254 documents. if: properties: join: $ref: '#/components/schemas/BlockingJoin' then: required: - window properties: last_n: type: integer maximum: 254 properties: match: $ref: '#/components/schemas/RelationMatch' description: Which documents the relation reads. join: $ref: '#/components/schemas/RelationJoin' last_n: type: integer minimum: 1 maximum: 1000 description: >- Keep the newest n. Not on a relation that reads a referenced document; at most 254 on a blocking relation, and at most the `options.from` candidate limit (see Limits) when `options.from` chooses among it. window: $ref: '#/components/schemas/Duration' description: >- Keep documents created within this long before the later of the judged document's newest write and its newest related creation, at the answer's watermark. An edit to an old related document never moves the window. Not on a relation that reads a referenced document. fields: type: array description: >- Paths to include from each document, rendered under `records`, newest first. An entry may be a `BandedField`, which renders a number as its band. An entry may also be a plain judgment's `answers..value` and `answers..thresholds.` as they are, and its `.p`, `.score` and `.dist.