> ## Documentation Index > Fetch the complete documentation index at: https://docs.vainona.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get the cheaper context recipe the outcomes support > The last recipe-tuning run of the active version (§6.10). Once a version's calibration is fitted, and then at most every 30 days, a run tries smaller recipes: one field or relation dropped, or one `last_n` or `window` halved. Each is priced in units per answer first, and only those at least 20% cheaper are judged again, on the fit's labelled answers, from the stored contexts made smaller. A variant qualifies when neither its held-out log loss nor its accuracy is worse beyond noise. `suggestion` is the cheapest that qualifies, with the exact `definition` to post as a new version; nothing is applied for you. On every plan. Below Team the numbers are shown, and `recipe`, `removed` and `definition` are null with `plan_required` beside them (§9). ## OpenAPI ````yaml /api-reference/openapi.yaml get /namespaces/{ns}/judgments/{name}/recipe-suggestion openapi: 3.1.0 info: title: Vainona API version: '1' license: name: Proprietary identifier: LicenseRef-Proprietary description: | The `/v1` contract from main spec §6. It is locked: changes within `/v1` are additive only, and anything breaking is `/v2`. - **Base URL.** `https://api.vainona.ai/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 (v1.5).** 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 (§7.7). - **Thresholds are settings (v1.5).** 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 (§6.5). - **Entity judgments (entities, E1).** A judgment can read the documents that point at the judged one, through `context.related`, and apply only to documents matching `applies_to` (§6.5.2). Its answers carry a `watermark`, and creating one that runs `on_change` returns a replay estimate of its monthly cost until you confirm (§6.9). - **Referenced documents (entities, E3a).** 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. A large fan-out is a `fanout` job that waits for confirm (§6.5.2, §6.9). - **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 (§6.4). `Idempotency-Key` is accepted on every mutating route and, while the node still caches the original response, returns it verbatim. - **Errors.** Every error is the `Error` envelope; the HTTP status follows the code (see each response). - **Rate limits.** Every response carries `X-RateLimit-Limit` and `X-RateLimit-Remaining`; 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. - **Usage.** Every response that bills carries `usage`. Judging is billed in engine-neutral judgment units: one judgment answered, per started 1,000 tokens of its compiled context and its question together, at least 1 (§9). No response ever carries an engine's price. servers: - url: https://api.vainona.ai/v1 security: - apiKey: [] tags: - name: Namespaces description: Namespaces, their settings and cache warming (§6.2, §6.11). - name: Documents description: Writes, point reads and queries (§6.3 to §6.8). - name: Judgments description: >- Judgment definitions, versions, settings, activation, backfill and template detach (§6.5, §6.9, §7.7). - 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 (§6.10). See [calibration](/concepts/calibration). - name: Jobs description: >- Backfill, shadow, periodic, deletion, reference index and fan-out jobs (§6.2, §6.9, §7.10.5). - name: Engines description: The engine registry (§6.5, §7.4.5). - name: Organization description: | Settings of the whole organization: prefixes marked non-production, which the tenant fee and template calibration pools leave out (§9). paths: /namespaces/{ns}/judgments/{name}/recipe-suggestion: parameters: - $ref: '#/components/parameters/Namespace' - $ref: '#/components/parameters/JudgmentName' get: tags: - Outcomes and calibration summary: Get the cheaper context recipe the outcomes support description: | The last recipe-tuning run of the active version (§6.10). Once a version's calibration is fitted, and then at most every 30 days, a run tries smaller recipes: one field or relation dropped, or one `last_n` or `window` halved. Each is priced in units per answer first, and only those at least 20% cheaper are judged again, on the fit's labelled answers, from the stored contexts made smaller. A variant qualifies when neither its held-out log loss nor its accuracy is worse beyond noise. `suggestion` is the cheapest that qualifies, with the exact `definition` to post as a new version; nothing is applied for you. On every plan. Below Team the numbers are shown, and `recipe`, `removed` and `definition` are null with `plan_required` beside them (§9). operationId: getRecipeSuggestion responses: '200': description: The suggestion, or why there is none; `status` says which. headers: X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' content: application/json: schema: $ref: '#/components/schemas/RecipeSuggestion' '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' '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' headers: RateLimitLimit: description: Requests allowed per second for this key. schema: type: integer minimum: 0 RateLimitRemaining: description: Requests left in the current window. schema: type: integer minimum: 0 RetryAfter: description: Seconds to wait before retrying. schema: type: integer minimum: 0 schemas: RecipeSuggestion: type: object description: | The cheaper context recipe a version's outcomes support, from its last recipe-tuning run (§6.10), or why there is none. required: - version - status - reason - message - headline - suggestion - computed_at - next_run_after - plan_required properties: version: $ref: '#/components/schemas/JudgmentVersionNumber' status: type: string enum: - not_run - running - ready - none description: | - `not_run`: no run yet; `reason` says why. - `running`: a run is testing smaller recipes. - `ready`: `suggestion` holds a cheaper recipe. - `none`: the last run found none; `reason` says why. reason: description: | Why there is no suggestion. Not run: `awaiting_run` (the next calibration run starts it), `too_few_outcomes` (no calibration fit yet), `no_recipe`, `composite`, `inherited` (the template has the suggestion). None: `nothing_to_save` (every answer already costs one unit), `no_smaller_recipe`, `no_cheaper_recipe` (nothing at least 20% cheaper), `accuracy_would_drop`, `too_few_outcomes`, `cost_cap` (the run stopped at this month's limit) or `superseded` (the engine's model changed during the run). Null while running and when ready. oneOf: - type: string enum: - awaiting_run - too_few_outcomes - no_recipe - composite - inherited - nothing_to_save - no_smaller_recipe - no_cheaper_recipe - accuracy_would_drop - cost_cap - superseded - type: 'null' message: type: string description: What `status` and `reason` mean, in a sentence. headline: type: - string - 'null' description: >- One sentence when ready, such as "A context recipe 42% cheaper per answer, with accuracy unchanged within noise on 312 labelled answers." suggestion: oneOf: - $ref: '#/components/schemas/RecipeSuggestionDetail' - type: 'null' computed_at: description: When the last run ended. Null before one has. oneOf: - $ref: '#/components/schemas/Timestamp' - type: 'null' next_run_after: description: >- The earliest the nightly calibration starts the next run, 30 days after the last started. Null before one has. oneOf: - $ref: '#/components/schemas/Timestamp' - type: 'null' plan_required: description: Set below Team, where the recipe itself is withheld (§9). oneOf: - $ref: '#/components/schemas/RecipePlanRequired' - type: 'null' NamespaceName: type: string description: >- Up to 256 bytes. `/` separates levels of the hierarchy, as in `acme/prod/tenant_123`. 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 RecipeSuggestionDetail: type: object description: | One smaller recipe, measured against the current one on the same labelled answers and engine epoch. Apply it by posting `definition` as a new version and activating it through its shadow report. required: - recipe - removed - definition - unit_reduction - cost_per_answer_before - cost_per_answer_after - held_out - labels - engine_version - computed_at properties: recipe: description: The whole new context recipe. Null below Team. oneOf: - $ref: '#/components/schemas/ContextRecipe' - type: 'null' removed: description: >- What changed, in words, such as "the field state.internal_notes". Null below Team. oneOf: - type: array items: type: string - type: 'null' definition: description: >- The exact body to `POST /namespaces/{ns}/judgments`, the active version's definition with only `context` changed. It gives no `thresholds`, so the judgment's current thresholds carry over when the new version is activated. Null below Team. oneOf: - $ref: '#/components/schemas/CreateJudgmentRequest' - type: 'null' unit_reduction: type: number minimum: 0.2 maximum: 1 description: The share of judgment units per answer it saves, at least 0.2. cost_per_answer_before: type: number minimum: 0 description: >- Mean judgment units per answer with the current recipe, on the labelled answers. cost_per_answer_after: type: number minimum: 0 description: The same with this recipe. held_out: $ref: '#/components/schemas/RecipeHeldOut' labels: type: integer format: int64 minimum: 100 description: The labelled answers both recipes were scored on. engine_version: type: string description: >- The engine epoch both were judged in, that of the version's calibration fit. computed_at: $ref: '#/components/schemas/Timestamp' Timestamp: type: string format: date-time description: RFC 3339, UTC. RecipePlanRequired: type: object description: Why the recipe itself is withheld, as `plan_required` says it (§9). required: - message - capability - required_plan - plan properties: message: type: string capability: type: string enum: - recipe_tuning required_plan: type: string enum: - team - scale plan: type: string enum: - developer - team - scale 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`. ContextRecipe: type: object description: | What the engine sees. Omitting it sends the whole `state`, subject to the engine limit; allowed but not recommended. 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: | Entities, E1 (§6.5.2). Up to 4 relations, by name: documents in the same namespace that point at the judged one or, from E3a, 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' CreateJudgmentRequest: type: object description: A definition plus its initial freshness settings. allOf: - $ref: '#/components/schemas/JudgmentDefinition' properties: freshness: $ref: '#/components/schemas/FreshnessSettings' activate: type: boolean description: >- Activate this version on creation. In v1 this implies `force`. Refused for a composite judgment, which activation fits on your labels first (§6.5.1). confirm: type: boolean default: false description: | Entities, E1 (§6.9). Required to create a version with `context.related` on a judgment whose policy will be `on_change`. Without it, the response is the replay estimate of the monthly cost, and nothing is created. Ignored for other judgments. unevaluatedProperties: false RecipeHeldOut: type: object description: | Both recipes scored the way a calibration fit is judged: calibrated in the same 5 folds, each outcome read with a fit made without it. required: - log_loss_before - log_loss_after - accuracy_before - accuracy_after - interval properties: log_loss_before: type: number minimum: 0 log_loss_after: type: number minimum: 0 accuracy_before: type: number minimum: 0 maximum: 1 accuracy_after: type: number minimum: 0 maximum: 1 interval: type: array minItems: 2 maxItems: 2 items: type: number description: >- The 95% interval of the change in log loss, after minus before; above 0 is worse. 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, `rate_limited` 429, `internal` 500, `engine_unavailable` 503. enum: - invalid_request - unauthorized - forbidden - not_found - conflict - too_large - rate_limited - budget_exceeded - plan_required - engine_unavailable - engine_version_unavailable - insufficient_labels - internal 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]$ Relation: type: object description: | Entities, E1 (§6.5.2). 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. Entities, E3a: 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`. 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`; one that reads the referenced document takes neither. if: properties: join: type: object properties: mine: const: id then: anyOf: - required: - last_n - required: - window else: not: anyOf: - required: - last_n - required: - window properties: match: $ref: '#/components/schemas/AttributeFilter' 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. 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. From entities E3a, an entry may be a `BandedField`, which renders a number as its band. minItems: 1 items: oneOf: - $ref: '#/components/schemas/RelationField' - $ref: '#/components/schemas/BandedField' aggregate: $ref: '#/components/schemas/Aggregate' 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` (§6.5). 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' 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 (§7.3.12); a shorter one is `invalid_request`. max_wait_ms: type: - integer - 'null' minimum: 1 description: | Entities, E1 (§7.3.9). 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 AttributeFilter: type: object description: | Entities, E1 (§6.5). 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' RelationJoin: description: | How a related document is matched to the judged one: one side is `id`, the other an attribute holding an id. A join with an attribute on both sides, documents sharing a key, is E3b and `invalid_request`. oneOf: - $ref: '#/components/schemas/ReferringJoin' - $ref: '#/components/schemas/ReferencedJoin' RelationField: type: string description: A path in a related document, `id`, `created_at` or `updated_at`. pattern: ^((state|attributes)(\.[^.]+)+|id|created_at|updated_at)$ BandedField: type: object description: | Entities, E3a (§6.5.2). A number rendered as its band rather than its value, in any relation. A number renders as the label whose position is how many cut points are at or below it: with `bands: [0.3, 0.7]`, 0.29 is `labels[0]`, 0.3 is `labels[1]` and 0.7 or more `labels[2]`. A value that is not a number renders unchanged, and a missing one is left out. Only a move to another band changes the context, so a move inside one neither fans out nor costs an evaluation. `bands` must be strictly increasing and `labels` must have exactly one more entry; the server refuses anything else with `invalid_request`. additionalProperties: false required: - path - bands - labels properties: path: type: string description: A `state` or `attributes` path. pattern: ^(state|attributes)(\.[^.]+)+$ bands: type: array description: Cut points, strictly increasing. minItems: 1 maxItems: 9 items: type: number labels: type: array description: One label per band, lowest first, so one more than `bands`. minItems: 2 maxItems: 10 items: type: string minLength: 1 maxLength: 64 Aggregate: type: object description: | Numbers over the relation's documents, after `match`, `window` and `last_n`, rendered as keys of its `related.` entry, such as `count` and `sum(state.amount)`. At most 8 paths in total. `sum`, `min` and `max` skip values that are not numbers; `sum` of nothing is 0, and `min` and `max` of nothing are null. `latest` is the value in the newest document that has one, of any JSON type. additionalProperties: false minProperties: 1 properties: count: const: true description: How many documents the relation selected. sum: $ref: '#/components/schemas/AggregatePaths' min: $ref: '#/components/schemas/AggregatePaths' max: $ref: '#/components/schemas/AggregatePaths' latest: $ref: '#/components/schemas/AggregatePaths' BoolJudgmentDefinition: type: object description: | The answer has `p`. With `parts` it is a composite judgment (§6.5.1): 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 (§9). With `features`, one part is enough. minItems: 1 maxItems: 8 items: $ref: '#/components/schemas/JudgmentPart' features: type: array description: | Entities, E1 (§6.5.1). 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. The combiner takes sign(x) × ln(1 + |x|) of each value and standardises it with the parts' log-odds; a missing value counts as the feature's mean. Features add no questions, so they add no judgment units. 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: type: array description: Option values must be distinct. minItems: 2 maxItems: 254 items: $ref: '#/components/schemas/ChoiceOption' 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 FreshnessPolicy: type: string description: | `on_read` (default) computes on first read, then caches until the document changes. `on_change` is required for any judgment used in a query filter or rank. `periodic` recomputes every `interval`. `manual` is backfill only. enum: - on_read - on_change - periodic - manual FanoutSettings: type: object description: | Entities, E3a (§6.5.2). For a judgment with a relation that reads a referenced document: which judged documents a change to it 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 with such a relation. In a `PATCH`, the keys you send replace those keys and the others keep their values. 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. 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. job_above: type: - integer - 'null' format: int64 minimum: 0 description: >- A fan-out that would re-judge more than this many judged documents is a visible `fanout` job with an estimate (§6.9). `0` makes every fan-out a job. Defaults to the namespace's `fanout.job_above`, 10,000 unless it sets one. `null` in a request clears the judgment's own value, so it follows the namespace's again; `GET` never returns `null`. confirm_jobs: type: - boolean - 'null' description: >- A `fanout` job waits in `awaiting_confirm` until `POST /jobs/{id}/confirm`. `false` starts it at once, unless its estimate does not fit what is left of the namespace's budget. Defaults to the namespace's `fanout.confirm_jobs`, `true` unless it sets one. `null` in a request clears the judgment's own value, so it follows the namespace's again; `GET` never returns `null`. auto_daily_limit: type: - integer - 'null' format: int64 minimum: 0 default: 100000 description: >- The most judged documents fan-outs of this judgment re-judge automatically in any 24 hours. Once a fan-out would pass it, it becomes a `fanout` job that waits for confirm, however small, as one above `job_above` does. `null` means no limit. AttributeFilterValue: type: - string - number - boolean ReferringJoin: type: object description: | Entities, E1 (§6.5.2). The documents that point at the judged one: a related document belongs to the judged document whose `id` equals its `theirs` attribute. additionalProperties: false required: - theirs - mine properties: theirs: type: string description: >- The related document's attribute that holds the judged document's id, such as `attributes.parent_id`. pattern: ^attributes\.[A-Za-z0-9_-]+$ mine: const: id ReferencedJoin: type: object description: | Entities, E3a (§6.5.2). The one document the judged document points at, its referenced document: the document whose `id` equals the judged document's `mine` attribute. A change to what the relation renders of it re-judges the judged documents that point at it and are inside `freshness.fanout.scope`. additionalProperties: false required: - theirs - mine properties: theirs: const: id mine: type: string description: >- The judged document's attribute that holds the referenced document's id, such as `attributes.group_id`. pattern: ^attributes\.[A-Za-z0-9_-]+$ AggregatePaths: type: array minItems: 1 maxItems: 8 uniqueItems: true items: type: string description: A `state` or `attributes` path. Keys in it cannot contain `(` or `)`. pattern: ^(state|attributes)(\.[^.()]+)+$ 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: | Entities, E1 (§6.5). 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. Probability: type: number minimum: 0 maximum: 1 description: | Answers store probabilities as 32-bit floats 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 (§7.1.6). JudgmentPart: type: object description: One part of a composite judgment (§6.5.1). 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: | Entities, E1 (§6.5.1). 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 ChoiceThreshold: type: object additionalProperties: false required: - value - gte properties: value: type: string minLength: 1 gte: $ref: '#/components/schemas/Probability' ScoreLevel: type: object additionalProperties: false required: - value - label properties: value: type: integer label: type: string minLength: 1 description: type: string FanoutScope: type: object description: | Entities, E3a (§6.5.2). 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' EngineRef: type: object description: An exact engine version. No aliases. required: - name - version properties: name: type: string enum: - jev - laya version: type: string minLength: 1 Horizon: type: string description: | How far ahead the judgment predicts (§6.10): an answer says the event happens within the horizon after it was made, and an outcome labels the prediction window its `observed_at` falls in. A whole number and a unit (`s`, `m`, `h` or `d`); `0s` for labelled examples, which join the answer current at `observed_at`. pattern: ^(0|[1-9][0-9]*)[smhd]$ default: 0s responses: InvalidRequest: description: '`invalid_request`: the request is malformed or breaks a rule of §6.' content: application/json: schema: $ref: '#/components/schemas/Error' Unauthorized: description: '`unauthorized`: the key is missing, unknown or revoked.' content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: '`forbidden`: the key''s role or namespace prefix does not allow this.' content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: '`not_found`: the namespace, document, judgment or job does not exist.' content: application/json: schema: $ref: '#/components/schemas/Error' Conflict: description: >- `conflict`: the namespace is being deleted, an object a read needs was compacted away and the read (or the query, without its cursor) must restart (§7.5.11), or the judgment is inherited from a template and this namespace cannot create, activate or delete it (§7.7). content: application/json: schema: $ref: '#/components/schemas/Error' RateLimited: description: >- `rate_limited`: slow down. `Retry-After` says for how long, except when a daily allowance is used up: then `details.resets_at` says when it renews, and there is no `Retry-After`. headers: X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/Error' Internal: description: >- `internal`: something failed on our side. Nothing partial is returned, and a request never commits part of itself. Most `internal` errors committed nothing. A write can instead fail with a message saying it may have been committed, when we could not tell whether its batch landed (§7.2.10): it then committed all of it or none of it. Retrying a write is safe either way, because writes are idempotent. The message is generic and carries a request id, also in `details.request_id`, which support uses to find the cause. content: application/json: schema: $ref: '#/components/schemas/Error' securitySchemes: apiKey: type: http scheme: bearer description: | An organization API key. Keys carry a role (`read_write` or `read_only`) and may be restricted to a namespace prefix such as `acme/*`, or to one namespace such as `acme/prod/tenant_1`. A prefix matches on a `/` boundary: `acme/prod/tenant_1*` covers `acme/prod/tenant_1` and everything under `acme/prod/tenant_1/`, never `acme/prod/tenant_12`. ````