> ## 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. # Create a judgment, or a new version of an existing name > Posting a name that exists creates version `n+1`; versions are immutable. The first version of a name is active on creation; a later version is inactive until activated, unless `activate: true`, which implies `force` and skips the shadow report (§6.5, §6.9). Thresholds are a setting of the judgment, not part of the version (§6.5). Thresholds given here replace the judgment's thresholds when this version becomes active, because they are written for its type; a version created without them keeps the current thresholds. After that, change them with `PATCH`. On a prefix path (`acme%2Fprod%2F*`) this creates a template that every namespace under the prefix inherits (§7.7). A namespace cannot create a judgment with the name of one it inherits (`conflict`). A composite judgment (a `bool` with `parts`, §6.5.1) is never active on creation, not even as the first version, and `activate: true` is `invalid_request` for one: it cannot answer until its combiner is fitted on your labels by the shadow job that activation starts. An entity judgment (entities, E1) has `context.related` (§6.5.2). Creating a version of one on a judgment whose policy will be `on_change` needs `confirm: true`. Without it, the response is `200` with the replay estimate of its monthly cost, and nothing is created (§6.9). A confirmed request whose estimate is more than the namespace's monthly budget is `budget_exceeded`. When the version joins on attributes with no reference index yet, `job_ids` names the `reference_index` job that builds each one, and `job_id` the first. A fourth reference index in a namespace is `invalid_request`, and `details.reference_indexes` names the current ones. A relation that reads a referenced document (entities, E3a) joins with `{theirs: "id", mine: "attributes."}`. It needs a reference index on the judged documents' `mine` attribute, built by a `reference_index` job like any other and counted toward the same 3. Its replay estimate cannot count fan-out, so it has `excludes: ["fanout"]` and `lower_bound: true`. A join with an attribute on both sides (shared keys, E3b) is `invalid_request`, and `warnings` names a relation that renders a referenced document's `updated_at`, which changes on every write to it. ## OpenAPI ````yaml /api-reference/openapi.yaml post /namespaces/{ns}/judgments 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. `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). paths: /namespaces/{ns}/judgments: parameters: - $ref: '#/components/parameters/NamespaceOrTemplate' post: tags: - Judgments summary: Create a judgment, or a new version of an existing name description: | Posting a name that exists creates version `n+1`; versions are immutable. The first version of a name is active on creation; a later version is inactive until activated, unless `activate: true`, which implies `force` and skips the shadow report (§6.5, §6.9). Thresholds are a setting of the judgment, not part of the version (§6.5). Thresholds given here replace the judgment's thresholds when this version becomes active, because they are written for its type; a version created without them keeps the current thresholds. After that, change them with `PATCH`. On a prefix path (`acme%2Fprod%2F*`) this creates a template that every namespace under the prefix inherits (§7.7). A namespace cannot create a judgment with the name of one it inherits (`conflict`). A composite judgment (a `bool` with `parts`, §6.5.1) is never active on creation, not even as the first version, and `activate: true` is `invalid_request` for one: it cannot answer until its combiner is fitted on your labels by the shadow job that activation starts. An entity judgment (entities, E1) has `context.related` (§6.5.2). Creating a version of one on a judgment whose policy will be `on_change` needs `confirm: true`. Without it, the response is `200` with the replay estimate of its monthly cost, and nothing is created (§6.9). A confirmed request whose estimate is more than the namespace's monthly budget is `budget_exceeded`. When the version joins on attributes with no reference index yet, `job_ids` names the `reference_index` job that builds each one, and `job_id` the first. A fourth reference index in a namespace is `invalid_request`, and `details.reference_indexes` names the current ones. A relation that reads a referenced document (entities, E3a) joins with `{theirs: "id", mine: "attributes."}`. It needs a reference index on the judged documents' `mine` attribute, built by a `reference_index` job like any other and counted toward the same 3. Its replay estimate cannot count fan-out, so it has `excludes: ["fanout"]` and `lower_bound: true`. A join with an attribute on both sides (shared keys, E3b) is `invalid_request`, and `warnings` names a relation that renders a referenced document's `updated_at`, which changes on every write to it. operationId: createJudgment parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateJudgmentRequest' responses: '200': description: >- An entity judgment that needs `confirm` was not confirmed. Nothing was created; this is its replay estimate. headers: X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' content: application/json: schema: $ref: '#/components/schemas/CreateJudgmentEstimate' '201': description: The new version. headers: X-RateLimit-Limit: $ref: '#/components/headers/RateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/RateLimitRemaining' content: application/json: schema: $ref: '#/components/schemas/CreateJudgmentResponse' '400': $ref: '#/components/responses/InvalidRequest' '401': $ref: '#/components/responses/Unauthorized' '402': $ref: '#/components/responses/BudgetExceeded' '403': $ref: '#/components/responses/Forbidden' '409': $ref: '#/components/responses/Conflict' '413': $ref: '#/components/responses/TooLarge' '422': $ref: '#/components/responses/EngineVersionUnavailable' '429': $ref: '#/components/responses/RateLimited' '500': $ref: '#/components/responses/Internal' '503': $ref: '#/components/responses/EngineUnavailable' components: parameters: NamespaceOrTemplate: name: ns in: path required: true description: | A namespace name, or a template prefix ending in `/*` (§7.7), with any `/` sent as `%2F`: `acme%2Fprod%2Ftenant_123` or `acme%2Fprod%2F*`. schema: $ref: '#/components/schemas/NamespaceOrTemplate' IdempotencyKey: name: Idempotency-Key in: header description: >- Returns the original response verbatim while the node still caches it. Correctness never depends on it. schema: type: string minLength: 1 schemas: 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 CreateJudgmentEstimate: type: object description: >- Entities, E1 (§6.9). An unconfirmed create of an entity judgment that runs `on_change`. Nothing was created. required: - replay properties: replay: $ref: '#/components/schemas/ReplayEstimate' CreateJudgmentResponse: type: object required: - name - version - active - warnings properties: name: $ref: '#/components/schemas/Name' version: $ref: '#/components/schemas/JudgmentVersionNumber' active: type: boolean warnings: type: array description: >- Non-fatal problems, such as an omitted context recipe, or (entities, E3a) a relation that renders a referenced document's `updated_at`, which changes on every write to it and so fans out every time. items: type: string job_id: type: string description: >- Entities, E1 (§6.5.2). The first of `job_ids`, kept for clients written before `job_ids`. Read `job_ids` to see every job. job_ids: type: array minItems: 1 description: >- Entities, E1 (§6.5.2). The `reference_index` jobs that build the indexes this version's relations need, one per attribute with no index yet, so two when it joins on two new attributes. Present exactly when `job_id` is. The version's answers are `unavailable` until every job is done. items: type: string 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 (§7.7). Up to 256 bytes. pattern: ^[A-Za-z0-9._:/-]+(/\*)?$ minLength: 1 maxLength: 256 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 ReplayEstimate: type: object description: | Entities, E1 (§6.9). What an entity judgment would cost a month, from the namespace's last 30 days of writes run through its touch, debounce and ceiling rules. Storage keeps each document's newest version, so the replay sees each related document's creation, its newest write and the deletes still recorded: exact for documents written once, the last edit only for documents edited many times, when the figures are a lower bound (`lower_bound`). It does not credit dedup, which only lowers the bill. required: - replayed_days - entities - judgments_per_month - judgment_units_per_month - cost_usd_per_month - bulk_pool_share - lower_bound properties: replayed_days: type: integer minimum: 0 maximum: 30 description: >- Days of writes replayed, fewer than 30 in a younger namespace. The monthly figures are scaled from them to 30 days. entities: type: integer format: int64 minimum: 0 description: Documents the judgment applies to now. judgments_per_month: type: integer format: int64 minimum: 0 description: Evaluations the replay counted, scaled to 30 days. judgment_units_per_month: type: integer format: int64 minimum: 0 description: >- Judgment units (§9), from the mean compiled context and question of a sample of up to 1,000 entities. cost_usd_per_month: type: number minimum: 0 description: >- The units at the graduated prices of the tiers your organization will be in, counting what it has already used this month (§9). A confirmed request is refused with `budget_exceeded` when this is more than the namespace's monthly budget. bulk_pool_share: type: - number - 'null' minimum: 0 description: >- The share of the background judging rate available to this judgment that these evaluations would use, by requests or tokens, whichever is larger. Above 1, the judgment cannot keep up with the writes. Null for an engine without an account rate limit. lower_bound: type: boolean description: >- True when a related document in the replayed window has a `revision` higher than the writes the replay saw, so it was edited more often than the replay counted, and whenever `excludes` is present. The figures are then a lower bound, shown as "at least". The namespace budget still caps real spend. excludes: type: array description: | Entities, E3a (§6.9). What the figures leave out, present only when something is. `fanout`: the judgment has a relation that reads a referenced document, and the replay cannot count its fan-out, because storage keeps only a referenced document's newest version. Each fan-out above `fanout.job_above` shows its own estimate before it runs. minItems: 1 uniqueItems: true items: type: string enum: - fanout 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 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`. 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 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: | 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. ErrorCode: type: string description: | HTTP status by code: `invalid_request` 400, `unauthorized` 401, `budget_exceeded` 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 - engine_unavailable - engine_version_unavailable - insufficient_labels - internal 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 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 keeps its answer, which is not marked `pending`; 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' 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). minProperties: 1 maxProperties: 4 propertyNames: $ref: '#/components/schemas/Name' additionalProperties: $ref: '#/components/schemas/Relation' 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 long before an outcome is observed the prediction it measures was made: an outcome is joined to the evaluation current at `observed_at` minus the horizon (§6.10). A whole number and a unit (`s`, `m`, `h` or `d`); `0s` for labelled examples. pattern: ^(0|[1-9][0-9]*)[smhd]$ default: 0s 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' 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' AttributeFilterValue: type: - string - number - boolean 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' 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)(\.[^.()]+)+$ 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 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' BudgetExceeded: description: >- `budget_exceeded`: the namespace is over its monthly compute budget, or the estimate does not fit it. 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' 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' TooLarge: description: >- `too_large`: the request body (on any route), a document, or the estimated query scan is over its limit. `details` carries the estimate for queries. It also answers a write that would take `default/quickstart` past its size cap (10,000 documents or 100 MB), with `details.max_documents` and `details.max_bytes`. content: application/json: schema: $ref: '#/components/schemas/Error' EngineVersionUnavailable: description: >- `engine_version_unavailable`: the engine version is not active in the registry. 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' EngineUnavailable: description: >- `engine_unavailable`: the model behind this call is unavailable or overloaded, or, on a request naming an engine (a definition or a `default_engine`), the engine registry has not loaded yet: the node started while it was unreachable. Retry after `Retry-After`. 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`. ````