{"info":{"title":"ContextBase","version":"0.1.0"},"openapi":"3.1.0","paths":{"/api/v1/agent-graph/preset":{"summary":"The platform's default agent graph, served read-only.","description":"A starting point for a space's agent graph, so it is served to signed-in\ncallers only -- the same rule the pipeline presets follow. The graph editor\nthat reads it lives behind a space, so nothing needs it before a session\nexists.","get":{"tags":["Agent Graph"],"summary":"Return the default agent-graph preset.","description":"The response is a whole agent graph -- its nodes (each agent's id,\nprompt, named tools and how they are set) and the edges wiring them,\nnone for the single agent that searches and then answers from what it\nread. It is global metadata, the same for every caller and not\nscoped to a space, but readable only by an authenticated user: a client\nfetches it and stores it on a space with the agent-graph write endpoint,\nwhich validates it there like any other.","operationId":"getAgentGraphPreset","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentGraphConfig"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["gIkYdDdFnbrOrdEPoDqT"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/agent-graph/tools":{"summary":"Global metadata describing the tools an agent may be given.","description":"It is the vocabulary a graph of agents is written in, so it is served on\nthe terms the graph is written on: to a signed-in person, as the preset\nis. Storing a graph takes a bearer, so a key has nothing to use it for.","get":{"tags":["Agent Graph"],"summary":"Return each agent tool's settings schema and stage descriptor.","description":"Keyed by the name a graph names the tool by. Per tool, the JSON Schema\nof the settings an agent's node may give it under ``tool_settings``\n(with bounds and platform defaults), so an editor can render the\nsettings form without hardcoding any tool. It is global metadata, the\nsame for every caller and not scoped to a space, but readable only by\na signed-in caller.","operationId":"getAgentToolCatalog","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"additionalProperties":{"$ref":"#/components/schemas/CatalogTool"},"type":"object","examples":[{"dCVTsDkIKixkQJHREmKO":{"params_schema":{"hELToaCEsRLXadjfjpSq":"db"},"descriptor":{"stage":"VcWvyFoKgbWNywnjNejd","label_key":"gofSZjLAtoyKFyyCfJxj","icon":"lEHZrqRviSPxUmbuWLig"}}}]}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["xERLOpxPjkNWNAOdPUnb"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/auth/accept-invite":{"summary":"Public endpoint that activates an invited account and starts a session.","description":"Redeeming a valid token has the same effect as a fresh login for the\naccount it names: the response is the same JSON access token plus\nhttpOnly refresh cookie a normal login returns, so a client treats\naccepting an invite exactly like signing in for the first time.","post":{"tags":["Auth"],"summary":"Redeem the invite token, activate the account, and log it in.","description":"The token is validated and the account activated by the usecase first;\nthe account then authenticates with the password it was just given,\nexactly like a normal login, so the token-minting and cookie contract\nis identical to ``/auth/token``.\n\nThe two ways this is refused are told apart by their status. A token\nthat cannot be redeemed -- unknown, expired, or already spent -- is a\ncredential the server will not take, answered with ``403``; all of\nthose cases answer identically, so which one applied cannot be read\noff the response. A password the validators turn down is answered with\n``400`` and the reasons they gave, and leaves the invitation unspent,\nso a stronger one can be sent straight after.\n\nLike the login it mirrors, this is a browser flow: the invite link is\nopened in the configured frontend, so a request not carrying that\nexact ``Origin`` is refused with ``403`` ahead of either check.","operationId":"acceptInvite","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptInvitePayload"}}},"description":"Accept-invite request body: the presented token and chosen password.","required":true},"responses":{"200":{"description":"OK","headers":{"Cache-Control":{"schema":{"type":"string","examples":["WBTGQVPGSfNLsUKcGpVf"]},"description":"Credentials must not be stored in any cache.","required":true},"Set-Cookie: contextbase_refresh":{"schema":{"type":"string","examples":["contextbase_refresh=NMExhABhNZlGygUKlHRc"]},"required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessTokenResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}}}},"/api/v1/auth/api-keys/":{"summary":"The caller's API keys as a collection: mint one, or list them.","description":"Protected by the bearer auth only: keys are managed from an interactive\nsession, and an API key must not be able to mint more keys (that would let a\nleaked key escalate into an unbounded supply of credentials). Every\noperation is scoped to the authenticated caller.","get":{"tags":["API Keys"],"summary":"List a page of the caller's keys as safe summaries.","description":"Scoped to the authenticated user, so the listing only ever contains\nthat user's keys -- the ones that stopped working included, each saying\nwhether it still works, ran out or was revoked. That standing is decided\nthe way the authenticator decides it, so a key the listing calls live is\none the door lets through. The raw secret and its hash are never part of\na summary; the ``page`` and ``page_size`` parameters select the slice to\nreturn.","operationId":"listApiKeys","parameters":[{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_ApiKeySummary_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["igDAIqrOQQlMoGSnLtgs"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]},"post":{"tags":["API Keys"],"summary":"Mint a key owned by the caller and return its one-time secret.","description":"The owner is always the authenticated user, so a caller cannot mint a\nkey for anyone else; the body carries an optional label and optional\nper-space scopes. A scope the caller may not grant (a space they cannot\nreach, or a level above their own access there) is refused with a 403\nnaming the space, and no key is created. A level stronger than the key's\n``purpose`` allows -- an agent host's key stops at ``write`` -- is\nrefused with a 400 naming the space, whatever the caller holds. The raw\nsecret is in this response exactly once and is never recoverable later,\nand the response tells every cache not to keep it.","operationId":"createApiKey","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyCreatePayload"}}},"description":"Request body to mint a new API key.\n\nThe owner is never in the body -- a key always belongs to the authenticated\ncaller. An optional human label tells the owner's keys apart, and an\noptional list of per-space ``scopes`` gives the key least-privilege access\n(a key with no scopes reaches nothing until it is re-issued with some).\n\n``purpose`` says where the key is going to live, and that tightens the rules\nit is issued under: a key destined for somebody else's agent host must name\nat least one space to reach, because such a key is copied into a config file\nthe platform can never reach again.","required":true},"responses":{"201":{"description":"Created","headers":{"Cache-Control":{"schema":{"type":"string","examples":["DseZpmBseWtLJeraUXfW"]},"description":"Credentials must not be stored in any cache.","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MintedApiKey"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["vsNrPmFhrfACGUNgEykG"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/auth/api-keys/{id}":{"summary":"Revokes one of the caller's own API keys (bearer-protected).","delete":{"tags":["API Keys"],"summary":"Revoke the caller's key by id, or 404 if it is not theirs.","description":"Scoped to the authenticated user: a key that does not exist or belongs\nto someone else is reported as not-found rather than revoked, so a\ncaller can never disable another user's key.","operationId":"revokeApiKey","parameters":[{"description":"Path parameters that identify a single ``ApiKey``.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"null","examples":[null]}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["lmYrmJMtHIWwugzngavP"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/auth/logout":{"summary":"Protected endpoint that revokes the caller's tokens.","post":{"tags":["Auth"],"summary":"End the session the caller is signing out of.","description":"The access token that authenticated this request is always revoked.\nWhen the request also carries its refresh cookie, that token is decoded\nand revoked too, so a single sign-out drops the whole session; a\nrefresh token that no longer decodes is simply skipped. Both are\nrecorded against the already-authenticated user.\n\nSigning out is a browser flow like signing in: the request must carry\nthe configured frontend's exact ``Origin`` or it is refused with\n``403``.","operationId":"logout","responses":{"204":{"description":"No Content","headers":{"Set-Cookie: contextbase_refresh":{"schema":{"type":"string","examples":["contextbase_refresh=TdGAEwsZaXKHCQAZqOHZ"]},"required":true}},"content":{"application/json":{"schema":{"type":"null","examples":[null]}}}},"401":{"description":"Unauthorized","headers":{"Set-Cookie: contextbase_refresh":{"schema":{"type":"string","examples":["contextbase_refresh=gOXvWovorVlRXuwdkhLf"]}},"WWW-Authenticate":{"schema":{"type":"string","examples":["ovWWAFExgxhOYnawIbvo"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/auth/register":{"summary":"First-account registration in the installation wizard.","post":{"tags":["Auth"],"summary":"Create the first installation superadministrator.","operationId":"register","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrationPayload"}}},"description":"Request body to register a new user by email and password.\n\nThe email is the login identifier; the password is validated against\nDjango's configured password validators before the account is created.","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegisteredUserPayload"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}}}},"/api/v1/auth/token":{"summary":"Public login endpoint that starts a refresh-backed access session.","post":{"tags":["Auth"],"summary":"Authenticate and return access while storing refresh in a cookie.","description":"This is the browser sign-in flow, and only a browser can complete it:\nthe request must carry the exact ``Origin`` of the configured frontend\nand the refresh token comes back in a cookie a script cannot read, so\na call without that header is refused with ``403``. Machine callers --\ngenerated SDKs, scripts, CI jobs -- are not meant to sign in with a\npassword at all; they authenticate with an API key instead.","operationId":"login","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginPayload"}}},"description":"Login request body: the email login identifier and the password.","required":true},"responses":{"200":{"description":"OK","headers":{"Cache-Control":{"schema":{"type":"string","examples":["nHmEOjwKHYVCBLBVdnFY"]},"description":"Credentials must not be stored in any cache.","required":true},"Set-Cookie: contextbase_refresh":{"schema":{"type":"string","examples":["contextbase_refresh=MonqpSdnMntgJeRAkVAu"]},"required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessTokenResponse"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}}}},"/api/v1/auth/token/refresh":{"summary":"Public endpoint that rotates refresh and returns fresh access.","post":{"tags":["Auth"],"summary":"Rotate the refresh cookie and return a fresh access token.","description":"The token is taken from the httpOnly cookie the browser attaches on\nits own, never from the body, so this too is a browser flow: without\nthe configured frontend's exact ``Origin`` the request is refused with\n``403``.","operationId":"refreshToken","responses":{"200":{"description":"OK","headers":{"Cache-Control":{"schema":{"type":"string","examples":["PBvqoMBagqLODxoxsMtU"]},"description":"Credentials must not be stored in any cache.","required":true},"Set-Cookie: contextbase_refresh":{"schema":{"type":"string","examples":["contextbase_refresh=gfNWGQYJLkdDHSPlRAwE"]},"required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessTokenResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}}}},"/api/v1/embedding-models":{"summary":"The embedding models a caller can bind a space to: list, or register.","description":"Protected by the bearer auth only: a remote model carries the key its\nprovider is called with, so registering one is done from an interactive\nsession rather than by a space-scoped API key. Every operation is scoped\nto the authenticated caller.","get":{"tags":["Embedding Models"],"summary":"Return the embedding models a space may select.","description":"The response lists the models the installation shares and the caller's\nown registrations -- never another account's -- with the fields a\nclient needs to offer the choice: its public id, the model id the space\nstores, the vector dimensionality, how the embedder runs and whether\nthe caller may change it -- and, to fill in a form replacing it, its\nsettings and its connection. A connection's credentials are never\nincluded; a replacement leaves the key out to keep it.\n\nThe installation's embedding services are read first, so a model one\nof them serves is registered and listed without anybody registering\nit, and ``available`` is false for a model a service has lost -- the\nrow stays for the spaces bound to it, and a new space cannot take it.","operationId":"listEmbeddingModels","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SelectableEmbeddingModel"},"type":"array","examples":[[{"public_id":"AzTTYXIRWOSwXTeylijn","model_id":"KMyWGFpiymLcuouVzllM","dim":3806,"kind":"hKEYzgQLCFAipAIRvwrN","owned":true,"params":{"JKoFpdYFJfdKAsENKdnV":"cf11fc"},"connection":{"JggjngORCdPYDmnOrIDL":"34442a"},"available":false}]]}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["cpkiJDgEvsTNgUStUnRC"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]},"post":{"tags":["Embedding Models"],"summary":"Register an embedding model of the caller's own, once it works.","description":"The body names the kind of model, its name, the width of its vectors,\nits settings and -- for a remote model -- how to reach the\nOpenAI-compatible API it is served by. Nothing is stored until the\nproposal has passed: its settings have to fit its kind, and the model\nhas to answer as declared -- a local one has to be one this platform\ncan load, and a remote one has to embed a text at the declared width.\nA wrong address, a rejected key, an unknown model name, a rate limit or\na width other than the declared one is refused here, saying which.\n\nThe owner is always the authenticated caller. The response is the same\nsafe view the listing serves: the connection just accepted, and the key\nin it, never come back out of the platform.","operationId":"registerEmbeddingModel","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddingModelPayload"}}},"description":"An embedding model as a caller asks for it to be registered or replaced.\n\nThe whole row, every time -- with one exception for a replacement: a key\nleft out of the connection, or sent empty, keeps the one stored, and a key\nsent as ``null`` removes it. A client is never shown a key, so it could not\nsend the stored one back. ``params`` and ``connection`` are free-form here\nand read through their typed structs when the proposal is judged.","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectableEmbeddingModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["XQvUTAzMRmkbjwoNYLJF"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/embedding-models/catalog":{"summary":"What a model of each kind is registered with.","description":"Global metadata about the platform rather than about any one row, served\nto signed-in callers only: it is the registration form's vocabulary, and\nthat form is behind a sign-in.","get":{"tags":["Embedding Models"],"summary":"Return, per kind of model, the settings and connection it takes.","description":"The response maps each kind of embedding model -- ``local`` and\n``remote`` -- to the JSON Schema of the settings a model of that kind\nmay carry, the JSON Schema of its connection (none for a local model),\nand the model names it is limited to, each with the width of the vectors\nit returns (the ones this platform can load, for a local model; none for\na remote one, whose names are its provider's). Every field carries its\ntitle and what setting it means, a setting the kind cannot carry is left\nout, and a credential is marked to be entered as such and never echoed\n-- so a form is built from this with nothing written out again on the\nclient.","operationId":"getEmbeddingModelCatalog","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"additionalProperties":{"$ref":"#/components/schemas/CatalogEmbeddingKind"},"type":"object","examples":[{"EjnbzpnJLsnLllZPnNJk":{"params_schema":{"YNqzPVWwnCjDjHVjekZX":"3e3"},"connection_schema":{"sVlJasDbABTRlHeiKvfr":"00a6c"},"models":{"aGdqLDnPUhujthByHMuM":4480}}}]}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["PuGPhdhfAoYkLMDuSVxq"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/embedding-models/{id}":{"summary":"One of the caller's embedding models: replace it, or remove it.","description":"Protected by the bearer auth only, for the reason its collection is. A\nmodel belonging to another account is reported as not found, so ids\ncannot be enumerated by probing; a model the installation shares is in the\ncaller's listing and is refused as not theirs rather than hidden.","put":{"tags":["Embedding Models"],"summary":"Replace one of the caller's models, whole, and re-prove it.","description":"The body is the entire row, with one exception: the connection's\n``api_key`` left out or sent empty keeps the stored key -- a client is\nnever shown it, so it cannot send it back -- and sent as ``null``\nremoves it, for an API that asks for none. While spaces are bound to the\nmodel, only the settings that change how a vector is fetched and paid\nfor may change -- the spaces guide lists them -- since the spaces'\nstored vectors were made by the rest. The model is exercised again\nbefore the change is kept, and a row pointed somewhere that does not\nanswer is left as it was.","operationId":"reconfigureEmbeddingModel","parameters":[{"description":"Path parameters that identify one registered embedding model.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddingModelPayload"}}},"description":"An embedding model as a caller asks for it to be registered or replaced.\n\nThe whole row, every time -- with one exception for a replacement: a key\nleft out of the connection, or sent empty, keeps the one stored, and a key\nsent as ``null`` removes it. A client is never shown a key, so it could not\nsend the stored one back. ``params`` and ``connection`` are free-form here\nand read through their typed structs when the proposal is judged.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectableEmbeddingModel"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["IgniZQleYincFOfEoQTr"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]},"delete":{"tags":["Embedding Models"],"summary":"Remove one of the caller's models, unless a space is bound to it.","description":"The refusal names the spaces standing in the way rather than a\ndatabase constraint.","operationId":"deleteEmbeddingModel","parameters":[{"description":"Path parameters that identify one registered embedding model.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"null","examples":[null]}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["iidBPKXUULNDfMOFJArN"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/eval-datasets/":{"summary":"The caller's evaluation datasets as a collection: upload, or list.","description":"Datasets belong to a user account (reused across that user's spaces), so\nevery operation is scoped to the person the caller is, or the person a key\nacts for; who may reach these routes is set out where they are mounted.","get":{"tags":["Eval Datasets"],"summary":"List a page of the caller's datasets as summaries (no full payload).","description":"Scoped to the authenticated user, so the listing only ever contains\nthat user's datasets. Each carries the counts and the metric flags, not\nthe corpus and queries -- a caller fetches one dataset's detail for\nthose. The ``page`` and ``page_size`` parameters select the slice.","operationId":"listEvaluationDatasets","parameters":[{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_EvaluationDatasetSummary_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["pFIVnwjjzMiOnZZHIbuB"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]},"post":{"tags":["Eval Datasets"],"summary":"Upload a dataset owned by the caller, validated before it is stored.","description":"The body carries the dataset (a name, a corpus, and the queries posed\nagainst it). It is validated -- a non-empty corpus, unique corpus ids,\nand every relevance label present in the corpus -- and a dataset that\nbreaks a rule is rejected with a 400 naming the rule, so nothing is\nstored. The owner is always the authenticated caller; the response is a\nsummary carrying the derived counts and metric-applicability flags.\n\nA dataset arrives whole, in one body, so how large it may be is how\nlarge a body this deployment reads. A body past that is refused with a\n413 from the length the request declares, before any of it is read into\nmemory or decoded, and the refusal names both the limit and the size\nthat was sent -- so a caller is told what to cut the dataset to rather\nthan only that it was too big.","operationId":"createEvaluationDataset","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluationDatasetPayload"}}},"description":"The accepted shape of an evaluation dataset, before validation.\n\nMirrors the JSON a client supplies: a ``name``, a ``corpus`` of passages\nand the ``queries`` posed against them. Decoding into this struct rejects\nunknown keys and the field-level constraints (a non-empty name), but the\ncross-field rules (a non-empty corpus, unique corpus ids, every\n``relevant_ids`` entry present in the corpus) are checked by the validator,\nwhich also derives the counts and the metric-applicability flags.","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluationDatasetSummary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["PtfiJqWPTbipxaRLCkoi"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"413":{"description":"Content Too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/eval-datasets/{dataset_id}/compare":{"summary":"The metric diff between two runs that scored the caller's dataset.","description":"Scoped to the person the caller is or acts for, reaching the runs only\nthrough the dataset that person owns: a dataset that\nis missing or owned by someone else, and a run that scored a different\ndataset, are both reported as not-found, so runs cannot be compared across\naccounts and ids cannot be enumerated by probing. An API key compares two\nruns only where it may evaluate in the space of each, and is otherwise\nrefused as the access gate refuses it there.","get":{"tags":["Eval Datasets"],"summary":"Diff two of the dataset's runs by their ``run_a`` / ``run_b`` ids.","description":"Both runs must score the dataset in the path (which the caller must\nown) and both must be ``done``. The two ids must differ -- comparing a\nrun with itself is rejected. The response carries the identity of what\nwas compared and the per-metric deltas across both families, with a\nmetric missing on either run left ``None`` rather than read as zero.\nEach run's ``empty_count`` travels beside the deltas; where one run was\nscored before empty answers were counted and the other after,\n``empty_answer_rule_differs`` is true and the answer-quality deltas are\n``None``, because the two means are not the same measurement.","operationId":"compareEvaluationRuns","parameters":[{"description":"Path parameters that anchor a comparison on the caller's dataset.","name":"dataset_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Query parameters that name the two runs to compare.\n\n``run_a`` is the baseline and ``run_b`` is the run compared against it, so\nevery reported difference reads as the change from the first to the\nsecond. Where the two runs have to be found -- the dataset or the space the\npath names -- is the path's to say.","name":"run_a","in":"query","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Query parameters that name the two runs to compare.\n\n``run_a`` is the baseline and ``run_b`` is the run compared against it, so\nevery reported difference reads as the change from the first to the\nsecond. Where the two runs have to be found -- the dataset or the space the\npath names -- is the path's to say.","name":"run_b","in":"query","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluationRunComparison"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["lZLTqDRWrYrifxiaUgCk"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/eval-datasets/{id}":{"summary":"One of the caller's evaluation datasets: fetch it, or delete it.","description":"Scoped to the person the caller is or acts for: a dataset that is missing or\nowned by someone else is reported as not-found, so a caller can never read\nor delete another user's dataset and ids cannot be enumerated by probing.","get":{"tags":["Eval Datasets"],"summary":"Return one of the caller's datasets by id.","description":"A dataset the caller does not own is reported as not found, so its\nexistence is never revealed. The response says what the dataset is --\nits name, its counts and which metrics its labels support -- not what\nis in it: the corpus and the queries are read from their own paginated\ncollections, so a dataset of any size is answered for in constant time\nand constant memory.","operationId":"getEvaluationDataset","parameters":[{"description":"Path parameters that identify a single ``EvaluationDataset``.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluationDatasetSummary"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["McsXtlqWbGgDILWbjsOO"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]},"delete":{"tags":["Eval Datasets"],"summary":"Delete one of the caller's datasets by id, or 404 if not theirs.","description":"Scoped to the person the caller is or acts for: a dataset that does not\nexist or belongs to someone else is reported as not-found rather than\ndeleted. Its corpus, its queries and every run that scored it are\nremoved with it, which is why an API key is refused with a 403 unless\nit may evaluate in the space of every one of those runs.","operationId":"deleteEvaluationDataset","parameters":[{"description":"Path parameters that identify a single ``EvaluationDataset``.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"null","examples":[null]}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["dGprRrMMcRWQfEfccZFz"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/eval-datasets/{id}/corpus":{"summary":"The passages of one of the caller's evaluation datasets.","description":"A collection of its own rather than part of the dataset it belongs to,\nbecause its size is the dataset owner's choice: a corpus is read a page at\na time, by a caller who wants to look at it, and never assembled whole to\nanswer a question about the dataset. Scoped to the person the caller is or\nacts for, like every other route over a dataset.","get":{"tags":["Eval Datasets"],"summary":"List a page of the dataset's corpus passages, in upload order.","description":"A dataset the caller does not own is reported as not found, so its\nexistence is never revealed. Each passage carries the dataset-local id\na query's relevance labels point at and the text that gets indexed; the\n``page`` and ``page_size`` parameters select the slice to return.","operationId":"listDatasetCorpus","parameters":[{"description":"Path parameters that identify a single ``EvaluationDataset``.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_CorpusDocument_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["ONluselMeoCjJqtCuVvd"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/eval-datasets/{id}/queries":{"summary":"The questions one of the caller's evaluation datasets poses.","description":"Its own collection for the reason the corpus is: a dataset holds as many\nquestions as its owner uploaded, so they are read a page at a time rather\nthan returned alongside the dataset. Scoped to the person the caller is or\nacts for.","get":{"tags":["Eval Datasets"],"summary":"List a page of the dataset's queries, in upload order.","description":"A dataset the caller does not own is reported as not found, so its\nexistence is never revealed. Each query carries its question, the\ncorpus ids that should rank highest for it (empty when it carries no\nrelevance labels) and its reference answer when it has one; the\n``page`` and ``page_size`` parameters select the slice to return.","operationId":"listDatasetQueries","parameters":[{"description":"Path parameters that identify a single ``EvaluationDataset``.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_EvaluationQuery_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["psWbgfqImEShFTXinWWS"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/extraction/capabilities/":{"summary":"Discover options supported by the configured extraction service.","get":{"tags":["Extraction"],"summary":"Return installed OCR engines, defaults and runtime identities.","operationId":"getExtractionCapabilities","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExtractionCapabilities"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["rxbMcHhpgvJYzNXJDxXK"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/groups/":{"summary":"List and create installation access groups.","get":{"tags":["Groups"],"summary":"List the groups managed by the installation.","operationId":"listAccessGroups","parameters":[{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_AccessGroupPayload_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["HWxtAQViBfnyQKPlKZCm"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]},"post":{"tags":["Groups"],"summary":"Create an empty local group.","operationId":"createAccessGroup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupNamePayload"}}},"description":"The display name of a local group.","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessGroupPayload"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["vijIdBDitblmcAjAFZeu"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/groups/accounts":{"summary":"List active account identifiers for group administration.","get":{"tags":["Groups"],"summary":"List active account identifiers for group administration.","operationId":"listAccessGroupAccounts","parameters":[{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_GroupMemberPayload_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["yDceeQcAObSyLigDQOHZ"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/groups/audit":{"summary":"List recent recorded changes to group access.","get":{"tags":["Groups"],"summary":"List recent recorded changes to group access.","operationId":"listAccessGroupAuditEvents","parameters":[{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_GroupAuditEventPayload_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["XXldEGCLmhxKeWhIbvvh"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/groups/spaces":{"summary":"List space identifiers for group assignments.","get":{"tags":["Groups"],"summary":"List space identifiers for group assignments.","operationId":"listAccessGroupSpaces","parameters":[{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_GroupSpaceChoice_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["PCKKQzoWnojLesWnntDa"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/groups/{group_id}":{"summary":"Rename or delete a locally managed group.","delete":{"tags":["Groups"],"summary":"Delete a local group after its access has been withdrawn.","operationId":"deleteAccessGroup","parameters":[{"description":"A group addressed by its public identifier.","name":"group_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"null","examples":[null]}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["CWShkLuMjphzpApKbPGf"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]},"patch":{"tags":["Groups"],"summary":"Rename a group without affecting its assignments.","operationId":"renameAccessGroup","parameters":[{"description":"A group addressed by its public identifier.","name":"group_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupNamePayload"}}},"description":"The display name of a local group.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessGroupPayload"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["GcOigWQfwEMAuVZlXIAQ"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/groups/{group_id}/members":{"summary":"Read the roster of an installation group.","get":{"tags":["Groups"],"summary":"List the accounts in a group.","operationId":"listAccessGroupMembers","parameters":[{"description":"A group addressed by its public identifier.","name":"group_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_GroupMemberPayload_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["LQZDIClbiICmvoIuzIRj"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/groups/{group_id}/members/{user_id}":{"summary":"Change a user's membership in a local group.","put":{"tags":["Groups"],"summary":"Add an existing account to the group.","operationId":"addAccessGroupMember","parameters":[{"description":"A user in a group addressed by public identifiers.","name":"group_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"A user in a group addressed by public identifiers.","name":"user_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupMemberPayload"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["SWyEdTDeuADpnsXcXTap"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]},"delete":{"tags":["Groups"],"summary":"Remove an account from the group.","operationId":"removeAccessGroupMember","parameters":[{"description":"A user in a group addressed by public identifiers.","name":"group_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"A user in a group addressed by public identifiers.","name":"user_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"null","examples":[null]}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["LQrmeMSRjjASusmIENZr"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/groups/{group_id}/spaces":{"summary":"Read a group's assignments to spaces.","get":{"tags":["Groups"],"summary":"List roles this group holds in spaces.","operationId":"listAccessGroupSpaceRoles","parameters":[{"description":"A group addressed by its public identifier.","name":"group_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_GroupSpaceRolePayload_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["ECZdFPsuBbEbBfrWNbtd"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/groups/{group_id}/spaces/{space_id}":{"summary":"Change a group's role on one space.","put":{"tags":["Groups"],"summary":"Assign a role to the group on the addressed space.","operationId":"assignAccessGroupSpaceRole","parameters":[{"description":"A group's assignment on the addressed space.","name":"group_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"A group's assignment on the addressed space.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupRolePayload"}}},"description":"The role a group receives in a space.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupSpaceRolePayload"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["KVXvgCHmfLcAOQkCCrpA"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]},"delete":{"tags":["Groups"],"summary":"Remove the group's role on the addressed space.","operationId":"removeAccessGroupSpaceRole","parameters":[{"description":"A group's assignment on the addressed space.","name":"group_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"A group's assignment on the addressed space.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"null","examples":[null]}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["VCVVshEEvTvsrntKNmPN"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/installation/access":{"summary":"The caller's installation-level permissions.","get":{"tags":["Installation access"],"summary":"Read the caller's current installation permissions.","operationId":"getInstallationAccess","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstallationAccessPayload"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["DnBqCcYykDtPtBWQEjBA"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/installation/administrators/{user_id}":{"summary":"Membership of the protected installation administrators group.","put":{"tags":["Installation access"],"summary":"Add an account to the protected group.","operationId":"addInstallationAdministrator","parameters":[{"description":"An account addressed by its public id.","name":"user_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"null","examples":[null]}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["BlCXBeXbDOFHBsWONBNe"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]},"delete":{"tags":["Installation access"],"summary":"Remove an account from the protected group.","operationId":"removeInstallationAdministrator","parameters":[{"description":"An account addressed by its public id.","name":"user_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"null","examples":[null]}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["oBgwmkphDHUxyHvAVsOJ"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/installation/groups/{group_id}/create-space":{"summary":"Installation permission assigned to a group.","get":{"tags":["Installation access"],"summary":"Read whether a group may create spaces.","operationId":"getGroupCreateSpaceGrant","parameters":[{"description":"A group addressed by its public identifier.","name":"group_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSpaceGrantPayload"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["drgPBRjAEiHLGMgoRmaW"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]},"put":{"tags":["Installation access"],"summary":"Grant or revoke a group's permission to create spaces.","operationId":"setGroupCreateSpaceGrant","parameters":[{"description":"A group addressed by its public identifier.","name":"group_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSpaceGrantPayload"}}},"description":"Whether this group may create spaces.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSpaceGrantPayload"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["lYwylvvvgPCVSzyVEwKl"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/installation/settings":{"summary":"The settings this installation keeps, for the screens that lack them.","description":"A knowledge base owns nearly every number that moves what it produces or\nwhat it costs, and reaches all of them through its own configuration. The\nfew it does not own are the awkward ones: on a screen, a setting that must\nnot be per-base looks exactly like one somebody forgot to add. This lists\nthem so a client can say which it is, where the reader went looking.\n\nGlobal metadata, the same for every caller and scoped to no space, so it is\nserved to signed-in callers only -- the rule the pipeline catalog follows.","get":{"tags":["Installation"],"summary":"List the settings a knowledge base cannot override, and why.","description":"Each entry carries the value this installation runs at, the screen a\nreader would have looked for it on, and prose saying why it is settled\nhere and what to change instead. A client renders them beside the\nsettings that *are* editable, so the absence of a knob reads as a\ndecision rather than as an omission.","operationId":"listInstallationSettings","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/InstallationSetting"},"type":"array","examples":[[{"setting":"mFQMogROxHJxwLVoUJgY","label_key":"zhupmhivtCZSvQXXVhtb","surface":"FfmtLaVpLFgjOzgxSUHM","value":7781,"reason":"gesyDqxwjtdBTCNqvest"}]]}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["gfAkhMqZDUEkWyIKYdYj"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/mcp/authorizations":{"summary":"The agent hosts the caller has connected, as a collection.","description":"Protected by the bearer auth: this is the web application asking on behalf\nof a signed-in person, and an agent's own token must never be able to\nenumerate the connections of whoever granted it -- least of all the other\nones they granted somebody else.","get":{"tags":["MCP"],"summary":"List a page of the caller's connections, freshest first.","description":"Every entry answers the one question a person opens this screen with:\nwhich agent host is this, what of mine can it read, and is it still\nlive. So it carries both halves of the client's identity, the corpora\nthat were handed over with the level each was handed over at, the three\nmoments that bound the connection (granted, lapses, last used) and where\nit stands right now -- in force, lapsed on its own, or withdrawn.\n\nThe standing is stated rather than left to be worked out from the dates,\nbecause working it out means comparing them against a clock, and the\ncaller's clock is not the one an agent's calls are judged by.\n\nWithdrawn and lapsed connections are listed alongside live ones, named\nrather than dropped -- what was once opened up is part of the answer.\nThe ``page`` and ``page_size`` parameters select the slice to return.","operationId":"listMcpAuthorizations","parameters":[{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_McpAuthorizationSummary_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["aaegKKTfRfQgprBVMEuW"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/mcp/authorizations/{id}":{"summary":"Withdraws one of the caller's connected agent hosts.","delete":{"tags":["MCP"],"summary":"Take an agent host's access back, or 404 if it is not the caller's.","description":"The withdrawal destroys the tokens along with the record, so the agent\nstops working at this moment rather than whenever its current token\nhappened to expire. Scoped to the caller, so an id belonging to somebody\nelse is reported as not-found rather than revoked.","operationId":"revokeMcpAuthorization","parameters":[{"description":"Path parameters that identify one granted authorization.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"null","examples":[null]}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["lCOARlpOSLHOzBZGuJoh"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/mcp/consent-requests/{ticket}":{"summary":"One agent host's pending request for access: read it, or answer it.","description":"Protected by the bearer auth, because this is where the person is\nidentified. The authorization endpoint that produced the request could not\nidentify them -- the web application holds a bearer rather than a Django\nsession, so a browser arriving there is anonymous -- which is precisely why\nthe decision is made here and not there.\n\nThe pending request is also tied to the browser it was created for, by a\nsecret this endpoint reads from a cookie. Being signed in is not enough: the\nticket travels in a URL, and a signed-in person who follows somebody else's\nlink must not be able to approve somebody else's agent.","get":{"tags":["MCP"],"summary":"Describe who is asking for access, and what could be given.","description":"Reports both halves of the client's identity -- the name its manifest\nclaims and the addresses that cannot be claimed -- whether this person\nalready has a live connection to the same client, and the knowledge\nbases they could share, each with the ceiling their own membership puts\non it. A ticket that is unknown, expired, already answered or belongs to\nanother browser is reported the same way: not found.","operationId":"getMcpConsentRequest","parameters":[{"description":"Path parameters that identify one pending consent request.","name":"ticket","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentRequestView"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["klYWaAHmSGiVfQvksdJo"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]},"post":{"tags":["MCP"],"summary":"Grant the chosen access and return where the browser goes next.","description":"Two steps, and deliberately two: the usecase decides -- the request is\nstill answerable, the choice is well formed, and every chosen knowledge\nbase passes the same access gate every other caller passes through --\nand then a single transaction records the decision and mints the code.\nSplitting them is what lets the recording be atomic, since a transaction\ncannot span an await, and it keeps the protocol machinery (which needs\nthe live request) out of the domain.\n\nThe redirect is returned rather than performed: this is a call made by a\npage, so a redirect status would be followed by that page's own fetch\ninstead of by the window. It carries the authorization code, which is\nexchanged for access, so the answer tells every cache not to keep it.","operationId":"confirmMcpConsentRequest","parameters":[{"description":"Path parameters that identify one pending consent request.","name":"ticket","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentDecision"}}},"description":"The person's answer: which knowledge bases, and how far in each.\n\nAn empty list is refused rather than stored: an authorization reaching\nnothing would leave the agent connected and permanently unable to answer,\nwhich reads as a broken platform rather than as a decision.","required":true},"responses":{"200":{"description":"OK","headers":{"Cache-Control":{"schema":{"type":"string","examples":["PzffZbvRxcCFZJpNcBrA"]},"description":"Credentials must not be stored in any cache.","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentIssued"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["xzoXmbfiIPhKxGFvrPYE"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]},"delete":{"tags":["MCP"],"summary":"Refuse the request, and return where the browser goes next.","description":"Refusing is deleting the pending request, which is why it is spelled\nthat way: after this there is nothing left to read or to answer, and the\nticket is spent by the same lock and the same stamp a confirmation\nspends it with. What comes back is a body rather than the usual empty\nanswer, because a refusal has somewhere to be delivered.\n\nThat delivery is the whole reason this endpoint exists. The agent host\nopened the browser and is blocked on its callback; closing the page\nwould leave it unable to tell a refusal from a person still reading, so\nit would sit there until its own timeout. Sent its callback carrying the\nprotocol's refusal and its own round-trip value, it knows at once and\ncan say so.\n\nThe two steps are split as they are for the confirmation: the usecase\ndecides -- this browser, this still-answerable request -- and then a\nsingle transaction spends the ticket, since a transaction cannot span\nan await.","operationId":"denyMcpConsentRequest","parameters":[{"description":"Path parameters that identify one pending consent request.","name":"ticket","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConsentDenied"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["YEJuypzzYfVOqThVJLTF"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/meta":{"summary":"Which platform is answering, readable without authenticating.","get":{"tags":["Meta"],"summary":"Report the platform's release and the version of its API.","description":"A client checks this before anything else it does, to tell whether the\nserver it reached is the one it was built against, so it needs no\nauthentication. It says nothing about the installation beyond the two\nversions.","operationId":"getServerMeta","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerMeta"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}}}},"/api/v1/pipeline/catalog":{"summary":"Global metadata describing the pipeline's buildable nodes.","description":"The catalog describes what this installation can build, so it is served to\nauthenticated callers only -- a signed-in person or any live API key, the\nsame rule the pipeline presets follow. Nothing reads it before a caller has\na credential: it is the vocabulary a space's configuration is written in,\nand a client configuring a space by key needs it as much as the pipeline\neditor does. It names no space, so a key needs no grant to read it.","get":{"tags":["Pipeline"],"summary":"Return each pipeline stage's node types and parameter schema.","description":"The response groups the buildable nodes by stage and gives, per node,\nthe JSON Schema of its parameters (with bounds and platform defaults),\nso a visual editor can render the parameter forms without hardcoding any\nnode. It is global metadata, the same for every caller and not scoped to\na space, but readable only by an authenticated user.","operationId":"getPipelineCatalog","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"additionalProperties":{"additionalProperties":{"$ref":"#/components/schemas/CatalogNode"},"type":"object"},"type":"object","examples":[{"YotiGxwDNuMFtjHIBqMN":{"NogbkvxneWuAxonwysZs":{"params_schema":{"SbHWYNNSVcnujUrnqpTA":"125965"},"descriptor":{"stage":"UxAryAWscuCIygFxMQBn","label_key":"lJJMCdgLIadxUuvkiQhe","icon":"RmymXEvBzkuQARNWPbos"},"reranker_profiles":[{"id":"KrjMedSmHPHboqNGjJyF","label":"fObBoeyAufUwuszIyLIA","model":"OPSDiTwMdKuNKoIcjkro","revision":"TPCmMMrLmRKyJIhNDrXW","input_mode":"YbdvWjEbTkmYrScHQHwW","input_template":"rMQaXowoWguwGJkgGwNq","max_length":3411,"truncation":"ReGUgTSZguwyGFwZQIbs","padding":"ovqimEgihlSYNZrPtLXl","supported_input_modes":["vymVVhhEgvGyIaOzDRGD"],"supported_truncation":["ycNJViwppayszezDxwLN"],"supported_padding":["rLhnrTeCLxrUzYufKbRn"],"editable_fields":["cNKwvqAlFEXbHAIllgjD"],"max_supported_length":null,"license":"beXaqcwSUzJAEAVTRpNF","license_url":"TTerSvliOTCxRmTGZwIU","warning":"XwnFpVPLEfXfiQIBLjXx","description":"vXfCHNCspyMynNrVBCpf","max_query_length":null,"max_document_length":746,"internal_block_size":null}]}}}]}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["rXIfdYyodkXesSrpgWtc"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/pipeline/comparison-catalog":{"summary":"The settings a space compares its evaluation runs under.","description":"Served to authenticated callers only, as the node catalogue is, and for\nits reason: it is part of the vocabulary of a space's configuration.","get":{"tags":["Pipeline"],"summary":"Return the JSON Schema of a space's comparison settings.","description":"The schema carries each setting's title, description, bounds and\nplatform default, so an editor can render the form for them without\nknowing any of them. The values a space holds are read and written as\nthe ``comparison`` part of its pipeline configuration.","operationId":"getRunComparisonCatalog","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ComparisonCatalogEntry"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["eFiKgMFJjODIGeIyrnnU"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/pipeline/presets":{"summary":"The starting pipeline presets a caller can pick, served read-only.","description":"Served to authenticated callers only, as the node catalogue is, and for\nits reason: a preset is a configuration written in that vocabulary.","get":{"tags":["Pipeline"],"summary":"Return the ordered pipeline presets a Space can start from.","description":"Each item carries the preset's id, label and description, its kind\n(``pipeline`` or ``agent``), the computed ``needs_llm`` flag, and the\nfull pipeline config -- plus the graph of agents for an ``agent``\npreset -- so a client offers the menu and prefills its builder from the\none picked. It is global metadata, the same for every caller and not\nscoped to a space, but readable only by an authenticated user.","operationId":"listPipelinePresets","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PipelinePresetView"},"type":"array","examples":[[{"id":"BBAyCwvDUaDbduhWGLSk","label":"gTIpPWIsqMSUBWaujGtD","description":"LNMhWcuiyJjGQjUUGXkD","kind":"bZVqPEwGeNoINAEJHxmy","needs_llm":true,"pipeline":{"chunk":{"node":"pGuZezQbpIZLHmsXDJrv","params":{"cHDlEuaTmACRAHgCtXgw":"af1cae8a"}},"retrievers":[{"node":"fxwatoqhrQKZBUZPRxOh","params":{"mOMfrkgWJoGcvVovBboW":"97"}}],"fusion":{"node":"dMkHcyaWaYxYyNLhrcrT","params":{"MgoYESNcxWVhaixKhSuO":"4777fcc"}},"rerank":[{"node":"WPRpptdmZadosGnkCbkF","params":{"AwPCmLflgvGCDMnmtGTP":"88e"}}],"generate":null,"query_transform":[{"node":"jihskVULTfWkYVtjHnEW","params":{"lwOwuDXBdMdZioChDrNn":"00f6bd"}}],"embed_batch_size":3,"postgeneration":[{"id":"fb496560-26a2-4e1e-bc81-0f9fb0a35ec5","rubric_version_id":"b59f023e-5874-481a-9f6c-7febe9669d0e","criterion_key":"ac2","judge":{"model":"7d","api_base":"ldnhiaBxXcCrkTSrzvkA","temperature":null,"timeout_seconds":6.272986909069523},"node":"rubric","on_failure":"block","max_retries":1}],"dictionary_extraction":{"enabled":true,"model":"wWBRbADmMzSFcCutOBtB","api_base":null,"temperature":1.9345808765783579,"instruction":"soUQjkIojyoFLHpNECxA","max_input_chars":6,"max_output_tokens":4,"auto_publish":false,"max_calls_per_document":1,"overlap_ratio":0.24798766215356122},"query_branches":[{"id":"1","retrievers":[{"node":"dSNNgaQApCXTeBNCDxij","params":{"qlFKNdnKerNnrkBkRwTD":"f5992"}}],"fusion":{"node":"RQArWNNIVZPSpjZZVRXc","params":{"NmXTYwKiHPEfhUIRbRwM":"0ff5bf57"}},"query_transform":[{"node":"xUyMjtDaJSXeGOMUhDHi","params":{"jrQbXTepgqtKjpUqfOSz":"b2301a75"}}],"max_queries":8,"weight":2.0380794461527976}],"branch_fusion":{"node":"ZyNmJnVrzIARrMNLlxiG","params":{"AOmRAdGWsTQIRlpvqAVl":"b45bd335"}},"branch_concurrency":2,"comparison":{"significance_level":0.8410745891973693,"resamples":23175}},"agent_graph":null}]]}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["SDrhnAzZUEoSPYHWvFGh"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/query-log/mine":{"summary":"The caller's own questions, as every space's log keeps them.","delete":{"tags":["Analytics"],"summary":"Delete every question you asked from every space's query log.","description":"Nothing of any space's is asked: the rows are about you, and they go\nwhatever the spaces' owners may read. What the retention already\nfolded into daily sums holds no person and is not affected.","operationId":"forgetMyQueries","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForgottenQueries"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["FjhqifGKkGOySvFLRORe"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/rubric-versions/{id}":{"summary":"Resolve an owned immutable version by its public identity.","get":{"tags":["Rubrics"],"summary":"Read a pinned version belonging to the signed-in account.","operationId":"getRubricVersionById","parameters":[{"description":"Address one library entry.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RubricVersion"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["LnFmISTuWWmndMTEEWhX"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/rubrics/":{"summary":"The signed-in account's rubric library.","get":{"tags":["Rubrics"],"summary":"List owned rubric entries, including archived entries.","operationId":"listRubrics","parameters":[{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_RubricSummary_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["YJeSmSWUuVwGzlwBVIot"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]},"post":{"tags":["Rubrics"],"summary":"Create a named rubric before publishing criteria.","operationId":"createRubric","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RubricCreate"}}},"description":"Create a named entry before publishing its criteria.","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RubricSummary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["DXBEbYmnihkqNRxSSisv"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/rubrics/{id}":{"summary":"Read, rename, archive or restore an owned rubric.","get":{"tags":["Rubrics"],"summary":"Read one entry's metadata.","operationId":"getRubric","parameters":[{"description":"Address one library entry.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RubricSummary"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["TkQVbDapJLHdtPwJNqgL"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]},"patch":{"tags":["Rubrics"],"summary":"Change metadata while retaining published versions.","operationId":"updateRubric","parameters":[{"description":"Address one library entry.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RubricUpdate"}}},"description":"Rename or archive an entry without modifying published criteria.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RubricSummary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["OJzHtkaoFTRAZyRvMZpi"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/rubrics/{id}/versions":{"summary":"List or publish immutable versions of an owned rubric.","get":{"tags":["Rubrics"],"summary":"List published versions in publication order.","operationId":"listRubricVersions","parameters":[{"description":"Address one library entry.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_RubricVersion_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["sauwvSEMUMzMHHGvGGWO"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]},"post":{"tags":["Rubrics"],"summary":"Publish the next numbered version with ordered criteria.","operationId":"publishRubricVersion","parameters":[{"description":"Address one library entry.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RubricPublish"}}},"description":"Publish a new immutable ordered set of criteria.","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RubricVersion"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["aVPvJpyniAofEddxiKie"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/rubrics/{id}/versions/{version}":{"summary":"Read an owned rubric's numbered immutable version.","get":{"tags":["Rubrics"],"summary":"Read criterion content as it was published.","operationId":"getRubricVersion","parameters":[{"description":"Address a numbered version within its library entry.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Address a numbered version within its library entry.","name":"version","in":"path","schema":{"type":"integer","minimum":1},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RubricVersion"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["pBmrdKVIyCcpMZCsMuuz"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/setup/connect-llm":{"summary":"Guided setup over ordinary, authenticated knowledge-base operations.","post":{"tags":["Setup"],"summary":"Complete the requested setup action, retaining server-side work.","operationId":"connectOnboardingLlm","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardingLlmRequest"}}},"description":"Connect an already available model to an ordinary space.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceFullPayload"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["MQHZUDxWWooNwnyejmHg"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreflightReport"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreflightReport"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/setup/demo":{"summary":"Guided setup over ordinary, authenticated knowledge-base operations.","post":{"tags":["Setup"],"summary":"Complete the requested setup action, retaining server-side work.","operationId":"prepareOnboardingDemo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardingDemoRequest"}}},"description":"Choose the language of the first retained demo document.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardingProgress"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["OfjRGBkdwKWPxZHbRPLe"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreflightReport"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreflightReport"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/setup/diagnostics":{"summary":"Private observations of this installation.","get":{"tags":["Setup"],"summary":"Check services independently of corpus readiness.","operationId":"getOnboardingDiagnostics","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardingDiagnostics"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["qCGpgYQWTTqqoeAccvup"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/setup/own-space":{"summary":"Guided setup over ordinary, authenticated knowledge-base operations.","post":{"tags":["Setup"],"summary":"Complete the requested setup action, retaining server-side work.","operationId":"createOnboardingSpace","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardingSpaceRequest"}}},"description":"Create the person's ordinary space, optionally reusing owned settings.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceFullPayload"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["OxoDpnzBoBIqMGdabgxP"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreflightReport"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreflightReport"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/setup/progress":{"summary":"Private navigation and retained entities for the signed-in person.","get":{"tags":["Setup"],"summary":"Read the current account's setup checkpoint.","operationId":"getOnboardingProgress","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardingProgress"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["cowqAzfmdAPnShnHKOnT"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]},"patch":{"tags":["Setup"],"summary":"Save navigation preferences.","operationId":"updateOnboardingProgress","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardingProgressUpdate"}}},"description":"Change navigation preferences without assigning server entities.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnboardingProgress"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["oEkMqdYJqMJqHeBMqGDA"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/setup/space-creators":{"summary":"Choose who may create spaces during initial setup.","post":{"tags":["Setup"],"summary":"Apply the initial space-creation choice.","operationId":"configureInitialSpaceCreators","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitialSpaceCreatorsPayload"}}},"description":"The access choice made in the installation wizard.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstallationAccessPayload"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["IIxsfwGFPXatkjfaByOX"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/setup/status":{"summary":"First-run status for the setup wizard, readable before any login.","get":{"tags":["Setup"],"summary":"Report whether the installation still needs its first-run setup.","description":"A fresh install has no user accounts, so a web wizard reads this before\nanyone can log in and leads the operator to create the first account\ninstead of showing a login screen. The response carries only the boolean\nflag -- never a user count, an email or any other account detail -- and\nthe endpoint needs no authentication so it is reachable on a blank\ninstall.","operationId":"getSetupStatus","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetupStatus"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}}}},"/api/v1/spaces/":{"summary":"Top level endpoints for the ``RAGSpace`` model: create one, or list them.","description":"The collection root serves two operations on the authenticated caller's own\nspaces. Both take the subject from the request (the bearer or the API key),\nnever the body, so a caller cannot act on someone else's behalf: a create is\nalways owned by the caller, and the listing follows their current access.","get":{"tags":["Spaces"],"summary":"List a page of reachable spaces in the requested order.","description":"Direct and group roles determine the spaces a person can see. An API\nkey lists only the spaces its owner can still access and the key has\nbeen granted. The summary describes the caller's effective role and\nleaves the pipeline config for the detail endpoint.","operationId":"listSpaces","parameters":[{"description":"Pagination and order for the spaces the caller can reach.","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Pagination and order for the spaces the caller can reach.","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}},{"description":"Pagination and order for the spaces the caller can reach.","name":"sort","in":"query","schema":{"enum":["created_at","document_count","last_accessed_at","name","original_size_bytes"],"default":"created_at"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_SpaceSummaryPayload_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["bQPbZviCKKGBjUmEYALx"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]},"post":{"tags":["Spaces"],"summary":"Create a new RAG space owned by the caller, with its pipeline config.","description":"The owner is always the authenticated user (from the bearer or the API\nkey). The owner needs installation permission to create spaces. The\nbody carries the space name and, optionally, the retrieval pipeline to\nrun it through, which registered embedding model to bind and which\nregistered storage backend to keep its vectors in; an omitted pipeline\ngets the platform default, an omitted model binds the one this\ninstallation configures as its default -- a bad request naming the\nrefusal where it configures none -- and an omitted backend binds the\nplatform-default one. An installation running an embedding service and\nnaming no default binds the model the service serves, and answers a bad\ngateway naming the services when none of them offers one. A model\nreached through such a service that the service no longer hosts is a\nbad request naming the models it does serve, whatever ``force`` says,\nand nothing is created. The proposed config is preflighted next: a\nconfig blocked only on resources that did not answer is a conflict the\ncaller may retry with ``force`` in the body, and one blocked by a\nstructural or consistency problem is unprocessable whatever ``force``\nsays -- both answer with the report and create nothing. An\nembedding-model id that names no registered model is\na 404, and again nothing is created. So is a storage-backend id the\ncaller cannot reach -- one that names nothing, and one that names a row\nanother account registered, which answer identically: binding a space to\nsomebody else's backend would read and write their external instance\nunder their credential. A backend attached to storage the platform does\nnot own is refused once a space already stores there: every search of\nsuch storage reads the whole of it, so a second space would answer out\nof the first one's chunks. The created space is returned with the\ncaller's role on it. Creating a space seats the caller's account as its\nowner member, so a person is told ``owner``. A key that creates a space\nis also granted on it, in the same write -- the strongest level its\n``purpose`` allows, so it can go on to use the space it made -- and it\nis told the role and grant that reaches, which stop short of ``owner``.","operationId":"createSpace","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceCreatePayload"}}},"description":"Used to create ``RAGSpace`` models.\n\nThe owner is not part of the body: a space is always owned by the\nauthenticated caller, taken from the request, so the client cannot create a\nspace on someone else's behalf.","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceFullPayload"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["wyFfCJXHCvVByMwdETtf"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreflightReport"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreflightReport"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/validate":{"summary":"Validate a proposed new space's configuration before creating it.","description":"Open to any authenticated caller (there is no space to gate on yet), this\nruns every preflight check over a proposed create payload -- can the\npipeline build, is it consistent, are its embedder, backend and any LLM or\nreranker reachable -- and answers 200 with the report. Every problem with\nthe proposed config is a finding, never an HTTP error, so a client sees the\nverdict before committing to a create. A draft the create would turn away\nbefore any check runs is the exception, answered the way the create\nanswers it so the two endpoints agree: an embedding-model or\nstorage-backend id the caller cannot resolve is reported as not-found, and\na draft naming no embedding model where the installation configures no\ndefault one is refused as a bad request. Nothing is created.","post":{"tags":["Spaces"],"summary":"Return the preflight report for a proposed new space's config.","description":"The body is the same create payload the create endpoint takes (name,\noptional pipeline, optional embedding model, optional storage backend,\noptional LLM). The usecase builds the target from it -- the supplied or\ndefault pipeline, the chosen or default embedder, the chosen or default\nbackend -- runs every check and returns the report. There is no space\nto reindex, so the report carries no impact, and no space is created\n-- though reading the installation's embedding services on the way\nregisters a model one of them serves that the registry lacked, as any\nreading of them does. The\ndefault embedder of an installation running an embedding service is\nthe model the service serves, so a draft naming no model there is a\nbad gateway naming the services when none of them offers one, as the\ncreate would be.\n\nThe subject comes from the request and never from the body, for the\nsame reason it does on the create: a named storage backend is resolved\namong that caller's own registrations and the ones the installation\nshares, so a draft is never checked against somebody else's external\ninstance, and an id naming one answers not-found like any unknown id.","operationId":"validateSpaceDraft","parameters":[{"description":"Explicitly request loading and running local models during validation.","name":"model_smoke","in":"query","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceCreatePayload"}}},"description":"Used to create ``RAGSpace`` models.\n\nThe owner is not part of the body: a space is always owned by the\nauthenticated caller, taken from the request, so the client cannot create a\nspace on someone else's behalf.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreflightReport"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["cdxpmTkkVGJIbYblyRXa"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{id}":{"summary":"Endpoints reaching one ``RAGSpace`` model by its path.","description":"Reads one space (view, allowed to any member or a key scoped to it),\nupdates which LLM it answers through and how its traffic leaves the\ninstallation, and tears it down. Only an owner may change the space's own\nsettings, and only an owner or a key holding ``manage`` while its owner\nstill owns the space may tear it down; anyone else with standing gets a\n403 and a non-member a 404.","get":{"tags":["Spaces"],"summary":"Return a RAG space the caller is a member of, by id.","description":"A space the caller is not a member of is reported as not found, so its\nexistence is never revealed. Viewing only needs read access, which every\nmembership role grants, so a member is never forbidden from viewing -- a\n403 cannot arise here, only the 404 that masks a non-member.\n\nThe response carries the caller's own ``role`` on the space, so a client\nthat loads a space knows at once what it may do there instead of finding\nout by being refused. It is the caller's effective access: a request\nmade with an API key reports what that key may do, which is never more\nthan its scope allows and never full control.","operationId":"getSpace","parameters":[{"description":"Path parameters that identify a single ``RAGSpace``.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceFullPayload"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["MUlkiIuohfXKwXWlyIfS"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]},"delete":{"tags":["Spaces"],"summary":"Accept durable deletion of a space and its managed resources.","description":"A successful 204 response records deletion intent and makes the space\nunavailable to ordinary requests. Background workers remove its\ncaptured documents, managed indexes and retained originals. Physical\ncleanup can continue after the response and resumes from saved work\nwhen delivery or storage is temporarily unavailable.\n\nAn attached space requires an explicit ``appended_rows`` decision when\nit has appended rows. The caller chooses whether to retain those rows\nor remove them; rows the platform did not write remain untouched.\nOmitting the decision returns the count and proposed choice. Supplying\nit for managed storage is refused because there is no shared corpus\nrequiring that decision.\n\nCounting appended rows requires reachable attached storage, so a count\nthat cannot be established refuses acceptance instead of treating the\ncorpus as empty.\n\nOpen to the space's owner, and to an API key only where it holds\n``manage`` and its owner still owns the space (see ``ScopeLevel``).","operationId":"deleteSpace","parameters":[{"description":"Path parameters that identify a single ``RAGSpace``.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"The answer a teardown carries, where there was a question to answer.\n\nBeside the other things a request about one space says about itself, since\nthat is what it is: the path names the space and this says what to do with\nwhat the space leaves behind in storage it does not own.\n\nA closed set of two words rather than free text, so a misspelt answer is a\nmalformed request instead of an answer nothing recognises being read as a\ndefault. Unset is the request that has not answered yet, which is what an\nattached space's teardown is refused for and what a managed space's\nteardown is the only valid form of.","name":"appended_rows","in":"query","schema":{"anyOf":[{"enum":["keep","purge"]},{"type":"null"}],"default":null}}],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"null","examples":[null]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["hVeCkaonCTBBojyuUkbc"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"428":{"description":"Precondition Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppendedRowsQuestion"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]},"patch":{"tags":["Spaces"],"summary":"Replace or clear the space's model, outgoing route or OCR profile.","description":"Owners can change these settings. Omitted fields preserve their stored\nvalues, null clears them, and objects replace them. OCR preferences are\nvalidated against the configured extractor and apply to future\nextractions. Existing document text is retained. Model and route changes\nuse the pipeline preflight; blank secrets preserve stored credentials.","operationId":"updateSpace","parameters":[{"description":"Path parameters that identify a single ``RAGSpace``.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Query parameters for changing how a space answers.\n\nThe change is preflighted as a created space is, and this is that\npreflight's override: ``force`` applies past a block made only of\nresources that did not answer when checked, never past a configuration\nthat is wrong.","name":"force","in":"query","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceUpdatePayload"}}},"description":"Settings an owner may replace or clear without reindexing documents.\n\nAn omitted field preserves the stored setting; null clears it; an object\nreplaces it. Extraction preferences apply to future extraction requests.\nLLM keys and proxy passwords are write-only and blank values preserve the\nstored credential.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceFullPayload"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["ryAtQESxWsZDtGfJFPdv"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreflightReport"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreflightReport"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{id}/storage/confirm":{"summary":"Confirm that a space's documents may join the storage it reads.","description":"The answer to the refusal that stops the first upload into storage this\nplatform did not make. It is the one place a person's judgement enters the\nattachment: everything else about that storage is checked against its own\ncatalog, and none of those checks can tell the corpus its owner meant from\na staging copy of it under a similar name.\n\nBearer-only and behind the configure gate, like every other decision about\nwhere a whole space's corpus goes: a non-member sees the space as\nnot-found, a member without admin a forbidden, and an API key -- which\nnever holds configure access -- is not offered the endpoint at all.\n\nAnswers with the rows it read beside the confirmation it recorded, so the\nscreen that showed somebody four lines of somebody else's corpus and asked\nabout them renders the same component over the answer.","post":{"tags":["Spaces"],"summary":"Record the confirmation for the space, reporting what was read.","description":"No body: what is being said is \"yes, that is our corpus\", and the only\nthing it can be said about is the storage the space is already bound\nto. Confirming a space whose storage the platform provisioned is\nrefused -- there is nothing of anybody else's in it to have looked at.\n\nConfirming twice is not an error: the storage is read again and the\nspace re-stamped, which is what re-checking an inherited corpus means.\n\nStorage that will not answer refuses by name instead of showing an\nempty reading. What somebody is being asked to recognise here is their\nown corpus, and a corpus that could not be read looks exactly like one\nthat is empty -- so a confirmation could otherwise be given about\nnothing at all.","operationId":"confirmSpaceStorage","parameters":[{"description":"Path parameters that identify a single ``RAGSpace``.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachedStoragePreview"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["RMiwRAAAiZMosKTCosCU"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/spaces/{id}/storage/index":{"summary":"Ask for, and watch, the pass that indexes a space's attached corpus.","description":"A space attached to storage this platform did not write can be searched by\nsimilarity the moment it is attached, because the vectors in that storage\nare its owner's and already there. The retrieval methods that rank rows of\nthis platform's own -- the lexical index and the learned-sparse one -- hold\nnothing for a corpus this platform never loaded, so a hybrid pipeline over\nsuch a space would blend one leg that answers with two that cannot.\n\nThe pass closes that gap from this side only: the corpus is read through\nthe field mapping the space already addresses it by, and the rows are built\nand stored here. Nothing is written into the owner's storage.\n\nIt is asked for rather than started on attachment because it reads every\nrow of a corpus and runs a model over each of them, which is a cost only\nthe space's owner can decide to spend. Asking is therefore an admin (owner)\noperation, bearer-only, exactly like reconfiguring the pipeline; watching\nis the ordinary read every membership role grants.","get":{"tags":["Spaces"],"summary":"Report how deep the space's attachment reaches, and the last pass.","description":"Cheap enough to poll while a pass runs: it reads two indexed rows and\nthe space's own configuration and touches nothing outside this\ninstallation. What it does not do is compare the storage against what\nthe pass built from, which is a read of somebody else's whole table and\nis asked for separately.\n\nA space storing into storage the platform provisioned is refused here\nexactly as it is refused a pass. Every word of this answer describes an\nattachment, and such a space has none -- reporting it as an attachment\nnobody had indexed would be a different space's answer.\n\nA space the caller is not a member of is reported as not found, so its\nexistence is never revealed; every membership role grants read, so a\nmember is never forbidden here.","operationId":"getSpaceStorageIndex","parameters":[{"description":"Path parameters that identify a single ``RAGSpace``.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SideIndexState"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["iVxEwSWUeFOVCyjaboLu"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]},"post":{"tags":["Spaces"],"summary":"Record and enqueue a pass over the space's attached storage.","description":"No body: what would be read is the storage the space is already bound\nto, and what is built from it is settled by what a pass can build. The\nstorage is surveyed before anything is recorded, so a corpus that\ncannot be reached refuses the request rather than failing out of sight\nin a worker.\n\nRecording the pass is what asks for it: the ask is part of the write\nrather than the next thing this controller does, and it goes out on the\nrecord's commit, so no worker is ever brought to a pass it would not\nyet find. Nothing is published from here, and there is no window in\nwhich this controller holds a recorded pass it has not yet asked\nanybody to run.\n\nThe answer is the state the pass starts in, so the client that asked\nfor it renders the same view it will poll. A pass already running is a\nconflict rather than a second enqueue: the second would clear the\nfirst's rows and report progress against its writes.","operationId":"indexSpaceStorage","parameters":[{"description":"Path parameters that identify a single ``RAGSpace``.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SideIndexState"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["YVntfumLqJbKHpOSVKwE"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/spaces/{id}/storage/index/check":{"summary":"Ask whether the attached storage is still the one the space was read on.","description":"The owner of that storage may redeclare a property or add, remove and edit\nrows at any time, and this platform has no way to be told: their schema is\nread-only here, so there is no trigger to hang on it and no column of\ntheirs to keep a version in. What can be done is to ask it the same\nquestions it was asked before and compare the answers.\n\nTwo of them, and the schema comes first. Whether the storage is still\nshaped the way the space addresses it is the answer a registration took,\nand the only other place it is re-asked is a write -- so a space that\nsearches somebody else's corpus and never adds to it would otherwise go on\nfiltering through a property whose owner has since made it compare words\nwhere this platform means values, with nothing anywhere saying so. Whether\nits rows still amount to what the last pass read is the second, and it is\nonly worth asking of storage still shaped as described.\n\nIt costs a walk of the owner's whole table, so it is asked for rather than\nmade on every query, and it sits behind the configure gate for the same\nreason the pass does: what a reader does with the answer is decide whether\nto spend another pass.","post":{"tags":["Spaces"],"summary":"Read the storage, record what it answered, report the state.","description":"A write rather than a read because it records what it found: the answer\noutlives the request that asked for it, so a screen showing the space\nafterwards reports the comparison instead of making another one. It\ncreates nothing, though -- there is one comparison per space and this\noverwrites it -- so it answers with the state rather than reporting a\nnew resource.\n\nStorage that no longer bears out the mapping the space addresses it by\nis answered with that refusal instead, naming the field and what it has\nbecome. Nothing here can repair it -- the schema is its owner's -- and\nno comparison of the rows would mean anything until it is.","operationId":"checkSpaceStorageIndex","parameters":[{"description":"Path parameters that identify a single ``RAGSpace``.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SideIndexState"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["TOKNcQxJHwMSZaVOENsv"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/spaces/{id}/storage/index/give-up":{"summary":"Record that no worker is ever coming to this space's recorded pass.","description":"Recording a pass is what asks for one, and the ask goes out on the\nrecord's commit, so no pass is ever written down without being published.\nWhat that leaves is the broker itself: a message it accepts and then loses\n-- the queue restarted, purged, nobody left holding it -- and a record that\nthen sits saying a pass is under way with nothing coming to finish it. It\nrefuses every later pass and blocks a configuration naming a leg over that\nstorage, so a space in that state is stuck.\n\nThe state already says it: the pass reports that nobody has reached it. No\nclock can go further, because a pass hours deep in a queue reports exactly\nthe same thing, and condemning it would announce the death of work that has\nnot begun. So this is where an operator says the thing only an operator can\nknow -- that nothing is coming -- and it is acted on only while it is still\ntrue: a worker that reaches the pass in the meantime stamps the record, and\nthe closure then does nothing.\n\nBehind the configure gate, like asking for the pass: the decision is the\nsame one, about whether this space's corpus is going to be read.","post":{"tags":["Spaces"],"summary":"Close out a pass nobody reached, and report the state.","description":"No body: what is being given up on is the one pass the space records,\nand the only thing said about it is that it is not coming.\n\nA space whose pass a worker has reached is left exactly as it is, and\nso is one whose pass has already settled or which never asked for one.\nNone of those is a refusal: what the caller wanted -- that no pass be\nleft waiting on a worker that will not come -- is already true of them,\nand the state that comes back says which case it was.","operationId":"giveUpSpaceStorageIndexPass","parameters":[{"description":"Path parameters that identify a single ``RAGSpace``.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SideIndexState"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["PAFQiDLEYnJOuWvhiuZV"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/spaces/{space_id}/agent-graph":{"summary":"Set the graph of agents a space answers questions through.","description":"Configuring the agent graph changes how every query against the space is\nanswered -- routing it through the graph instead of the retrieval pipeline\n-- so it is an admin (owner) operation and bearer-only: a non-member sees\nthe space as not-found, a member without admin a forbidden, and a graph that\nbreaks a structural rule a bad-request. A valid graph is stored and echoed\nback.","put":{"tags":["Agent Graph"],"summary":"Validate the proposed agent graph and store it on the space.","description":"The body is the whole proposed graph of agents. The usecase authorizes\nthe caller to configure the space, validates the graph (its shape, that\nit is acyclic, converges on a single final node, names only known tools\nand sets each only in ways it can read, and offers keyword search only\nwhere the space's pipeline has a lexical leg) and stores it; a query\nagainst the space is thereafter routed through the graph. The space\nis the one the path names and the gate authorized, never anything read\nfrom the graph. The stored graph is echoed back.","operationId":"configureAgentGraph","parameters":[{"description":"Path parameter identifying the space a config operation targets.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentGraphConfig"}}},"description":"Framework-free description of a whole graph of agents.\n\nThe ``nodes`` are the agents and the ``edges`` are the directed links along\nwhich their outputs flow. ``edges`` defaults to empty: a single-node graph\nhas nothing to connect, and that lone agent is both the entry and the final\nanswer. A graph with more than one node lists the edges that wire them into\na directed acyclic graph entered at a source and converging on one sink.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentGraphConfig"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["ONYCIiOkxIkNxkdvwQWx"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/spaces/{space_id}/analytics":{"summary":"How a space was used over the last few days.","get":{"tags":["Analytics"],"summary":"Summarise the space's questions, spend and corpus over a period.","description":"The period is the last ``days`` days counting today, in UTC. Counts\nand sums cover all of it; latency percentiles, the cost of an answer\nand distinct askers cover the part the query log still holds, which\n``rows_since`` names. Only those who administer the space read this:\na non-member is told the space was not found, any other member is\nforbidden.","operationId":"getSpaceAnalytics","parameters":[{"description":"The space whose analytics are read.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"How many days back, counting today, the analytics are read over.","name":"days","in":"query","schema":{"type":"integer","maximum":366,"minimum":1,"default":30}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceAnalytics"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["HjGilaGZvtrhqJGqxTiV"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/spaces/{space_id}/analytics/datasets":{"summary":"Evaluation datasets collected out of the space's logged questions.","post":{"tags":["Analytics"],"summary":"Store chosen logged questions as an evaluation dataset of yours.","description":"The questions become its queries as they were asked, with no labels\nand no reference answers, and its corpus is the documents they\nreached. It needs the grant to read question texts: a reader of the\nanalytics without it is forbidden. An id naming no question of the\nspace is not found; a question whose text was not kept is a conflict;\nquestions that reached no document with text leave a dataset with no\ncorpus, which is refused as any such dataset is.","operationId":"collectLogDataset","parameters":[{"description":"The space whose analytics are read.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogDatasetPayload"}}},"description":"Collect an evaluation dataset out of chosen logged questions.","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluationDatasetSummary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["eOrRFOMCfAJPmqCypEzk"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/spaces/{space_id}/analytics/queries":{"summary":"The questions a space was asked, newest first.","get":{"tags":["Analytics"],"summary":"List a page of the space's logged questions, newest first.","description":"Filtered by outcome, mode, entrance and rating over the last ``days``\ndays. Every row is listed to whoever reads the analytics; the question\nitself is quoted only to a member holding the grant to read question\ntexts, and a page that quoted any is written down among the reads of\nthe space's texts.","operationId":"listLoggedQueries","parameters":[{"description":"The space whose analytics are read.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Which logged questions to list, newest first, a page at a time.","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Which logged questions to list, newest first, a page at a time.","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}},{"description":"Which logged questions to list, newest first, a page at a time.","name":"days","in":"query","schema":{"type":"integer","maximum":366,"minimum":1,"default":30}},{"description":"Which logged questions to list, newest first, a page at a time.","name":"outcome","in":"query","schema":{"anyOf":[{"$ref":"#/components/schemas/QueryOutcome"},{"type":"null"}],"default":null}},{"description":"Which logged questions to list, newest first, a page at a time.","name":"mode","in":"query","schema":{"anyOf":[{"$ref":"#/components/schemas/QueryMode"},{"type":"null"}],"default":null}},{"description":"Which logged questions to list, newest first, a page at a time.","name":"entrypoint","in":"query","schema":{"anyOf":[{"$ref":"#/components/schemas/QueryEntrypoint"},{"type":"null"}],"default":null}},{"description":"Which logged questions to list, newest first, a page at a time.","name":"rating","in":"query","schema":{"anyOf":[{"$ref":"#/components/schemas/FeedbackRating"},{"type":"null"}],"default":null}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_LoggedQuery_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["KzrLlmIUipekWdNOnshE"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/spaces/{space_id}/analytics/queries/export":{"summary":"The space's logged questions as a CSV file.","get":{"tags":["Analytics"],"summary":"Download the logged questions the filters pick, as CSV.","description":"One row per question, newest first, with the columns the list shows,\nup to the platform's ceiling on an export. The question is quoted as\nthe list quotes it, and an export that quoted any is written down\namong the reads of the space's texts. A cell that begins like a\nspreadsheet formula is led with an apostrophe so it opens as text.","operationId":"exportLoggedQueries","parameters":[{"description":"The space whose analytics are read.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Which logged questions to export: the list's filters, without pages.","name":"days","in":"query","schema":{"type":"integer","maximum":366,"minimum":1,"default":30}},{"description":"Which logged questions to export: the list's filters, without pages.","name":"outcome","in":"query","schema":{"anyOf":[{"$ref":"#/components/schemas/QueryOutcome"},{"type":"null"}],"default":null}},{"description":"Which logged questions to export: the list's filters, without pages.","name":"mode","in":"query","schema":{"anyOf":[{"$ref":"#/components/schemas/QueryMode"},{"type":"null"}],"default":null}},{"description":"Which logged questions to export: the list's filters, without pages.","name":"entrypoint","in":"query","schema":{"anyOf":[{"$ref":"#/components/schemas/QueryEntrypoint"},{"type":"null"}],"default":null}},{"description":"Which logged questions to export: the list's filters, without pages.","name":"rating","in":"query","schema":{"anyOf":[{"$ref":"#/components/schemas/FeedbackRating"},{"type":"null"}],"default":null}}],"responses":{"200":{"description":"OK","headers":{"Content-Disposition":{"schema":{"type":"string","examples":["oPpAAFfdUqZHtDKZTUZM"]},"required":true},"Content-Length":{"schema":{"type":"string","examples":["BjdCcZCEyvEfKSAMNInM"]},"required":true}},"content":{"*/*":{"schema":{"type":"string","format":"binary"}},"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["AlTnvIifLwLNZsgqYiMx"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RefusalBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RefusalBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RefusalBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/spaces/{space_id}/analytics/queries/{query_id}":{"summary":"One logged question, taken apart.","get":{"tags":["Analytics"],"summary":"Read one logged question: stages, model calls, passages, rating.","description":"Its passages are named by the documents they came from, as those are\ncalled now. A question the log no longer holds -- folded away by the\nretention -- is not found. The question itself is quoted as the list\nquotes it.","operationId":"getLoggedQuery","parameters":[{"description":"One logged question of a space.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"One logged question of a space.","name":"query_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoggedQueryDetail"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["pwQakFynbKklHXFrmnbp"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/spaces/{space_id}/analytics/settings":{"summary":"What the space's query log keeps: read it, or change it.","get":{"tags":["Analytics"],"summary":"Report whether the query log keeps the texts of questions.","operationId":"getAnalyticsSettings","parameters":[{"description":"The space whose analytics are read.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsSettings"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["jGvRfAcNlCKQvrVVuUVn"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]},"put":{"tags":["Analytics"],"summary":"Set whether the query log keeps the texts of questions.","description":"The switch applies from the next question on. Turning it off keeps no\nmore texts; those already kept leave with the retention, as every row\ndoes. Everything else the log records is recorded either way.","operationId":"updateAnalyticsSettings","parameters":[{"description":"The space whose analytics are read.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsSettings"}}},"description":"What the space's query log keeps, as its owners set it.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsSettings"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["xcDPKCbiXIxaCRlBAHER"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/spaces/{space_id}/analytics/text-accesses":{"summary":"Who read the texts of the space's questions, and when.","get":{"tags":["Analytics"],"summary":"List every read of the space's question texts, newest first.","description":"Each names who read them, how -- a list, one question, an export, a\ndataset collected -- and how many questions it quoted, never which.\nOpen to everyone who reads the analytics, the text grant or not.","operationId":"listQueryTextAccesses","parameters":[{"description":"The space whose analytics are read.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_TextAccess_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["VQdRzarQQTAGmYkBkSrN"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/spaces/{space_id}/analytics/text-readers/{user_id}":{"summary":"One member's grant to read the texts of the space's questions.","put":{"tags":["Analytics"],"summary":"Give a member the reading of question texts, or take it back.","description":"The member who created the space holds the grant from the start;\nanybody else holds it only once it is given here. It is given by one\nwho reads the analytics and holds it already -- anyone else who reads\nthe analytics is forbidden -- and it opens the texts only to a member\nwho reads the analytics as well.","operationId":"setQueryTextGrant","parameters":[{"description":"One member of a space, by the public id of their account.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"One member of a space, by the public id of their account.","name":"user_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryTextGrantPayload"}}},"description":"Grant or revoke access to retained question and execution content.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryTextGrant"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["YqIBtvoWshgDgDGNQlRc"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/spaces/{space_id}/chunk-map":{"summary":"Read a space's 2-D embedding map, with an optional search highlight.","get":{"tags":["Chunk Map"],"summary":"Return the map's status and, once ready, its projected points.","description":"Each point carries the public id of the canonical chunk it depicts,\nso a client can open that chunk's detail from the map. An optional\n``query`` runs the space's own retrieval -- the same read path the\nsearch endpoint runs -- and names the ranked points for highlighting;\na read path that names an LLM step (HyDE, the LLM-judge reranker) on\na space with no LLM configured is answered with a 409, exactly as a\nsearch is. A built map whose vectors the space's storage no longer\nhands back, and whose build kept no positions of its own, is answered\nwith a 409 too, saying the map needs building again. Only a member\nmay read the map: a non-member is told the space was not found, and\nevery membership role grants read, so a member is never forbidden\nhere.","operationId":"getChunkMap","parameters":[{"description":"Path parameter identifying the space whose embedding map is addressed.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Query parameters of the embedding-map read.\n\nBoth are optional: a bare read returns the point cloud alone, while a\n``query`` additionally runs the space's own retrieval (the same read path\nthe search endpoint runs) and reports which points that search ranked, so\na client can highlight the retrieved neighbourhood on the map.","name":"query","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},{"description":"Query parameters of the embedding-map read.\n\nBoth are optional: a bare read returns the point cloud alone, while a\n``query`` additionally runs the space's own retrieval (the same read path\nthe search endpoint runs) and reports which points that search ranked, so\na client can highlight the retrieved neighbourhood on the map.","name":"top_k","in":"query","schema":{"type":"integer","maximum":20,"minimum":1,"default":5}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChunkMapPayload"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["VjeivRNQrIRmvMRaNLip"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/chunk-map/build":{"summary":"Start building a space's embedding map in the background.","post":{"tags":["Chunk Map"],"summary":"Claim the build, which asks for it, and answer 202 with a cost.","description":"The usecase authorizes the caller (a non-member sees not-found, a\nviewer a forbidden) and claims the build with one conditional write.\nClaiming it is what asks for it -- by space id alone, and only when the\nclaim was won -- so a repeat request while a build runs answers\n``enqueued`` false with the same 202 instead of duplicating the work,\nand no arrangement of this controller can leave a claim standing with\nnothing coming to honour it. The ask goes out on the claim's commit, so\nthe worker it brings is certain to read the marker back. The map read\nreports ``building`` until the basis lands.","operationId":"buildChunkMap","parameters":[{"description":"Path parameter identifying the space whose embedding map is addressed.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChunkMapBuildResult"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["JFPwMWhsSNDRYDoAopBd"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/chunk-map/give-up":{"summary":"Record that no worker is coming to this space's claimed map build.","description":"Claiming a build is what asks for it, and the ask goes out on the claim's\ncommit, so no claim is ever written without being published. What that\nleaves is the broker itself: a message it accepts and then loses -- the\nqueue restarted, purged, nobody left holding it -- and a marker that then\nrefuses every later request with nothing coming to release it. A space in\nthat state can never have a map built again.\n\nThe read already says it: the map reports itself as building, and a build\nnobody has reached carries no sign of life. No clock can go further,\nbecause a build hours deep in a queue looks exactly the same, and taking\nits claim over would start a second build beside one that has not begun.\nSo this is where an operator says the thing only an operator can know --\nthat nothing is coming -- and it is acted on only while it is still true: a\nworker that reaches the build in the meantime stamps the claim, and the\nwrite then does nothing.\n\nBehind the same access asking for a build takes: reading and projecting the\ncorpus changes no configuration, so a member with write access or a\nwrite-scoped key may say a reading of it is not coming.","post":{"tags":["Chunk Map"],"summary":"Drop a claim nobody reached, and report how the map reads now.","description":"No body: what is being given up on is the one build the space records,\nand the only thing said about it is that it is not coming.\n\nA space with no claim, one whose build a worker is on, and one whose\nmap has already landed are all answered rather than refused -- none of\nthem is a build left waiting on a worker that will not come, which is\nthe whole of what the caller asked for. The answer says whether a claim\nwas dropped and how the map reads afterwards.","operationId":"giveUpChunkMapBuild","parameters":[{"description":"Path parameter identifying the space whose embedding map is addressed.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChunkMapGiveUpResult"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["IxXbCoXmoOnNltiFxlOG"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/chunks":{"summary":"A space's canonical chunks as a read-only collection.","description":"The chunk store is the durable record of how each document was cut;\nthis endpoint exposes it so an engineer can inspect the cut without\ngoing through retrieval. Nothing here writes -- chunks are produced by\nthe ingest pipeline and only read back through this surface.","get":{"tags":["Chunks"],"summary":"List a page of a space's chunks the caller may view, in cut order.","description":"Only a member of the space may list its chunks: a non-member is\ntold the space was not found, masking its existence exactly as the\ndocument endpoints do. Listing needs only read access, which every\nmembership role grants, so a member is never forbidden. The\noptional ``document_id`` parameter narrows the listing to one\ndocument's chunks; ``q`` runs a Postgres full-text search over the\nchunk text (matching word forms under the retrieval leg's language\nconfiguration, not literal substrings). Chunks come back in the\norder they were cut -- by document, then position -- and\nhierarchical parent segments appear alongside their children, since\nboth are part of the stored cut. The ``page`` and ``page_size``\nparameters select the slice to return.","operationId":"listChunks","parameters":[{"description":"Path parameters that identify the space whose chunks are listed.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Optional filters that narrow a space's chunk listing.\n\nEvery field is optional: an omitted one does not constrain the listing,\nso a request with none returns the space's whole cut, in the order it\nwas produced. Supplied fields intersect -- all must hold -- and each is\napplied in the database by the selector. The page and page size ride\nalong from :class:`PageParams`, so a large corpus is returned one page\nat a time.","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Optional filters that narrow a space's chunk listing.\n\nEvery field is optional: an omitted one does not constrain the listing,\nso a request with none returns the space's whole cut, in the order it\nwas produced. Supplied fields intersect -- all must hold -- and each is\napplied in the database by the selector. The page and page size ride\nalong from :class:`PageParams`, so a large corpus is returned one page\nat a time.","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}},{"description":"Optional filters that narrow a space's chunk listing.\n\nEvery field is optional: an omitted one does not constrain the listing,\nso a request with none returns the space's whole cut, in the order it\nwas produced. Supplied fields intersect -- all must hold -- and each is\napplied in the database by the selector. The page and page size ride\nalong from :class:`PageParams`, so a large corpus is returned one page\nat a time.","name":"document_id","in":"query","schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"default":null}},{"description":"Optional filters that narrow a space's chunk listing.\n\nEvery field is optional: an omitted one does not constrain the listing,\nso a request with none returns the space's whole cut, in the order it\nwas produced. Supplied fields intersect -- all must hold -- and each is\napplied in the database by the selector. The page and page size ride\nalong from :class:`PageParams`, so a large corpus is returned one page\nat a time.","name":"q","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_ChunkSummaryPayload_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["dWLVPLCBaAxSjgJzVmtS"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/chunks/sizes":{"summary":"How large a space's fragments came out, beside what they were cut to.","description":"A chunk budget is a number of tokens, and how much text it buys depends\non what counts them and on the script the corpus is written in, so the\nbudget alone does not say how large a fragment is. This reports what the\nstored cut measures, so the two can be read side by side.","get":{"tags":["Chunks"],"summary":"Measure the fragments of a space the caller may view, cut by cut.","description":"Only a member may read it: a non-member is told the space was not\nfound, masking its existence exactly as the chunk listing does, and\nevery membership role grants the read access this needs. The corpus\nis measured afresh on each request, so it describes the cut as it is\nstored now.","operationId":"getChunkSizes","parameters":[{"description":"Path parameters that identify the space whose chunks are listed.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChunkSizeReport"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["pjgqoQbHmqcuQKPvCkOf"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/chunks/{chunk_id}":{"summary":"A single canonical chunk within a space, read in full.","get":{"tags":["Chunks"],"summary":"Fetch a single chunk of a space the caller may view, by id.","description":"Only a member may view it: a non-member is told the space was not\nfound, masking its existence exactly as the listing does. Viewing\nneeds only read access, which every membership role grants, so a\nmember is never forbidden here. A chunk that does not exist in the\nspace -- missing, or cut from another space's document -- is\nreported as not-found. The detail carries the full text, the\nfree-form metadata map, the position, the source document and --\nfor a hierarchical child -- the broader parent segment an answer\nwould be grounded in.","operationId":"getChunk","parameters":[{"description":"Path parameters that identify one chunk within a space.\n\nBoth ids come from the single-chunk route under a space's chunks\ncollection: the space scopes access, and the chunk is only ever reached\nwithin it, so a chunk from another space is masked as not-found.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Path parameters that identify one chunk within a space.\n\nBoth ids come from the single-chunk route under a space's chunks\ncollection: the space scopes access, and the chunk is only ever reached\nwithin it, so a chunk from another space is masked as not-found.","name":"chunk_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChunkDetailPayload"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["JQrfuqFkYZKHEppAiiVD"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/config":{"summary":"Replace a space's retrieval pipeline config.","description":"Reconfiguring the pipeline reindexes the whole corpus and changes retrieval\nfor every member, so it is open to the space's owner and to a key only where\nit holds ``manage`` and its owner still owns the space (see ``ScopeLevel``):\na caller with no standing sees the space as not-found, and one with standing\nbut without that access a forbidden. The proposed config is preflighted\nbefore anything changes: a config blocked only on resources that did not\nanswer is a conflict the caller may retry with ``?force=true``, and one\nblocked by a structural or consistency problem is unprocessable whatever\n``force`` says -- both answer with the report. An accepted query-time-only\nchange is applied in place and returns 200, unless a change accepted\nearlier is still owed a rebuild: that rebuild would store its own target\nover it, so it is a conflict until the rebuild ends or is cancelled. A\nchange that needs a reindex is started in the background and returns 202\nAccepted, after which a client polls the status endpoint until it stops\nreporting a rebuild -- which it reports from the moment of that answer,\nbefore any worker has started.\n\nA space attached to storage this platform did not write has a third\noutcome. Its corpus is nobody's here to recut, but the rows this platform\nranks it by are, so a change that retunes a retrieval method built by a\npass over that storage stores the config in place and starts another pass:\n202 Accepted with ``indexes_attached_storage`` set, watched through the\nspace's storage-index state rather than the representation status. That\npass reads the storage before anything is stored, so storage that has\nstopped answering refuses the change here rather than leaving the space\nnaming settings no run is coming to rebuild its rows under; and it is\nrecorded after, so the run it brings builds under the settings that made it\nnecessary.","put":{"tags":["Space Config"],"summary":"Apply the proposed pipeline config, in place or in the background.","description":"The body is the whole proposed pipeline. The usecase authorizes the\ncaller to configure the space, preflights the config (refusing a blocked\none, ``force`` overriding only an all-unreachable block) and classifies\nthe change: a query-time-only change it applies here (store + evict),\nany reindex it leaves unpersisted for the background rebuild. The\nreindex path records the target on the space, which is what asks for\nthe rebuild -- by space id alone, on the target's commit, so the worker\nreads the target back rather than racing the write that recorded it --\nand answers 202; the in-place path answers 200.","operationId":"applySpaceConfig","parameters":[{"description":"Path parameter identifying the space a config operation targets.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Query parameters for applying a space's pipeline config.\n\nThe applied config is the request body itself (the pipeline), so its apply\nmodifier rides on the query string rather than polluting the stored config.\n``force`` overrides an all-unreachable preflight block -- the config is\nsound, only resources did not answer when checked -- and never a structural\nor consistency block, which no ``force`` can push past.","name":"force","in":"query","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineConfig"}}},"description":"Framework-free description of a space's whole retrieval pipeline.\n\nOne typed graph a space carries and the resolver builds its executors from:\nhow the document is chunked, how the query is transformed before retrieval,\nwhich retrievers query it, how their rankings are fused, any rerankers, and\nwhether an answer is generated. The engine still takes a ``ChunkingConfig``\nof its own, read off the chunk node, because how a document is cut is the\none part of a pipeline the storage primitive has to know about.\n\nRepresentations are deliberately absent: they are the derived indexes the\nretriever set implies (one per retriever kind), not something the pipeline\nlists. Naming a ``dense`` and a ``bm25`` retriever is what calls those two\nrepresentations into being.\n\nOrdered query transforms run before retrieval; when omitted, the original\nquestion reaches the retrievers unchanged. Optional postgeneration checks\nrun after synthesis and apply their publication or correction policies.\n\n``embed_batch_size`` and ``comparison`` belong to no position. The\nembedder is bound to the space rather than named by a node, so there is no\nnode to hang its batch size on, yet how many texts it is handed at a time\nis the single biggest lever on how long loading a corpus takes -- and it is\nthe space's lever, since only its owner knows what hardware their embedder\nends up on and how long their passages are. How the space's evaluation runs\nare compared is read by no stage at all; it is here because it is the\nspace's to choose and this is where the space's choices are kept.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineUpdateResult"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineUpdateResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["dDiknvXvvFPjkDAITlSX"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreflightReport"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreflightReport"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/config/cancel":{"summary":"Take back a configuration change a space has accepted and not reached.","description":"The way back from a change whose rebuild stopped, or that its owner no\nlonger wants: re-applying the earlier configuration would not do it, since\na change needing no reindex is refused while one is owed. Open to\nwhoever may reconfigure the space -- its owner, and a key holding\n``manage`` while its owner still owns the space (see ``ScopeLevel``). A\ncaller with no standing sees the space as not-found, one without that\naccess a forbidden.","post":{"tags":["Space Config"],"summary":"Drop the owed change, or rebuild the space back from it.","description":"Where no rebuild had moved the space yet, the change is dropped and the\nanswer is 200 with ``reverting`` false. Where one had already stored\nit, the space is rebuilt back to the configuration it ran before, the\nanswer is 202 with ``reverting`` true, and the status endpoint reports\nthat rebuild from this answer on. A space owing no change, or being\nrebuilt right now, is a conflict.","operationId":"cancelSpaceConfigChange","parameters":[{"description":"Path parameter identifying the space a config operation targets.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineChangeCancelResult"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineChangeCancelResult"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["pqILauwxVtDeQmYqeYXh"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/config/recheck":{"summary":"Re-check a live space's stored config against its resources.","description":"Same access as configuring it -- a re-check reruns the preflight over what\nthe space already runs, so a caller with no standing sees not-found and one\nwithout the access to configure a forbidden, exactly as an edit would.\nOtherwise it always answers 200 with the preflight report: the consistency\nof the stored config and whether the resources it names still answer are\nfindings in the report, never an HTTP error. Nothing is proposed, so the\nreport carries no reindex impact, and nothing of the space is written --\nthough reading the installation's embedding services on the way registers\na model one of them serves that the registry lacked, as any reading of\nthem does.","post":{"tags":["Space Config"],"summary":"Return the preflight report for the space's stored config.","description":"The usecase authorizes the caller to configure the space, then reruns\nevery preflight check over the config the space already stores -- its\nconsistency and whether the resources it names still answer. The report\nis returned as data whatever it says; nothing of the space is written.","operationId":"recheckSpaceConfig","parameters":[{"description":"Path parameter identifying the space a config operation targets.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreflightReport"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["XZLNRiZfyBsvqssrbigi"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/config/reindex":{"summary":"Rebuild a space's corpus on the configuration it already runs.","description":"The lever for the case where nothing about the pipeline is wrong but what\nwas derived from it no longer matches how the platform builds it. It recuts\nevery document and rewrites every derived index, so it takes the access\nreconfiguring the pipeline takes: a caller with no standing sees the space\nas not-found, and one without the access to configure a forbidden.\n\nA space searching storage the platform did not write has no corpus here to\ncut again -- its rows were cut by whoever loaded them, no source text of\ntheirs was retained, and the indexes this platform keeps beside them are\nbuilt by a pass of their own -- so it is refused by name before anything\nelse runs, naming that pass.\n\nThe stored config is preflighted first, so a corpus is not spent against a\nresource that cannot be reached: a block on resources alone is a conflict\nthe caller may retry with ``?force=true``, and a structural or consistency\nblock is unprocessable whatever ``force`` says -- both answer with the\nreport. Otherwise the work is queued off the request and the response is 202\nAccepted; a repeated call while a run is in flight does not duplicate the\nwork (both take the same per-space lock, and the later one steps aside).\nThe recut is recorded as owed work before the answer, so the config status\nendpoint reports it as a rebuild from this answer on. On a space whose\nrebuild onto an accepted change stopped for good, this is what starts that\nrebuild again: the run works toward the change the space still records\nrather than the configuration it stores.","post":{"tags":["Space Config"],"summary":"Authorize and preflight the reindex, which is what asks for it.","description":"There is no body: the config to reindex toward is the one the space\nalready stores. The usecase authorizes the caller to configure the\nspace, refuses a stored config the preflight blocks (``force``\noverriding only an all-unreachable block), and publishes the recut by\nspace id alone. Asking is part of the act rather than the next thing\nthis controller does, so there is no window in which a request was\ncleared and nobody asked for the work. The response is 202 Accepted.","operationId":"reindexSpace","parameters":[{"description":"Path parameter identifying the space a config operation targets.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Query parameters for reindexing a space on the config it already runs.\n\nA reindex proposes nothing, so its only knob is the same preflight override\nan apply takes: ``force`` starts the reindex even though a resource the\nstored config names did not answer when checked. It never pushes past a\nstructural or consistency block -- a corpus is not worth recutting against a\nconfig that is wrong.","name":"force","in":"query","schema":{"type":"boolean","default":false}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineReindexResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["GmFbrYNENeDPsyXsHPGv"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreflightReport"}}}},"422":{"description":"Unprocessable Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreflightReport"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/config/status":{"summary":"Report a space's reindex progress for polling.","description":"Inspecting a space's jobs is open to every member and to a key only where it\nholds ``manage`` and its owner still owns the space (see ``ScopeLevel``);\nany other key is forbidden, and a caller with no standing is told the space\nwas not found, masking its existence, exactly as the space-detail read does.\nThe response carries each derived index's build state and says apart\nwhether some index is stale, whether a rebuild is on its way, and whether\nthe last rebuild failed for good: a UI shows \"rebuilding...\" while\n``rebuilding`` is up, and offers a rebuild where an index is stale or a\nrebuild failed with nothing coming.","get":{"tags":["Space Config"],"summary":"Return the reindex progress of a space the caller may inspect.","description":"A space the caller has no standing on is reported as not found, so its\nexistence is never revealed. A member is never forbidden here; a key is,\nunless it holds ``manage`` and its owner still owns the space.","operationId":"getSpaceConfigStatus","parameters":[{"description":"Path parameter identifying the space a config operation targets.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineConfigStatus"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["LiengyjtZtohTzaTPjRd"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/config/validate":{"summary":"Validate a proposed pipeline config against an existing space.","description":"Same access as applying it -- validation is offered only for a space the\ncaller may configure, so a caller with no standing sees not-found and one\nwithout the access to configure a forbidden. Otherwise it always\nanswers 200 with the preflight report: every problem with the proposed\nconfig is a finding in the report, never an HTTP error, so a client reads\nthe verdict and the reindex the change would cost from one body without the\nrequest failing. Nothing is written.","post":{"tags":["Space Config"],"summary":"Return the preflight report for the proposed pipeline config.","description":"The body is the whole proposed pipeline. The usecase authorizes the\ncaller to configure the space, runs every preflight check against the\nlive space (so the dimension check sees the real stored table), and\nattaches the reindex the change would cost. The report is returned as\ndata whatever it says; nothing of the space is written, so it is safe\nto call repeatedly. Reading the installation's embedding services on\nthe way registers a model one of them serves that the registry lacked,\nas any reading of them does, which calling again does not repeat.","operationId":"validateSpaceConfig","parameters":[{"description":"Path parameter identifying the space a config operation targets.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Explicitly request loading and running local models during validation.","name":"model_smoke","in":"query","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineConfig"}}},"description":"Framework-free description of a space's whole retrieval pipeline.\n\nOne typed graph a space carries and the resolver builds its executors from:\nhow the document is chunked, how the query is transformed before retrieval,\nwhich retrievers query it, how their rankings are fused, any rerankers, and\nwhether an answer is generated. The engine still takes a ``ChunkingConfig``\nof its own, read off the chunk node, because how a document is cut is the\none part of a pipeline the storage primitive has to know about.\n\nRepresentations are deliberately absent: they are the derived indexes the\nretriever set implies (one per retriever kind), not something the pipeline\nlists. Naming a ``dense`` and a ``bm25`` retriever is what calls those two\nrepresentations into being.\n\nOrdered query transforms run before retrieval; when omitted, the original\nquestion reaches the retrievers unchanged. Optional postgeneration checks\nrun after synthesis and apply their publication or correction policies.\n\n``embed_batch_size`` and ``comparison`` belong to no position. The\nembedder is bound to the space rather than named by a node, so there is no\nnode to hang its batch size on, yet how many texts it is handed at a time\nis the single biggest lever on how long loading a corpus takes -- and it is\nthe space's lever, since only its owner knows what hardware their embedder\nends up on and how long their passages are. How the space's evaluation runs\nare compared is read by no stage at all; it is here because it is the\nspace's to choose and this is where the space's choices are kept.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreflightReport"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["mAejXydycUcDggtifrei"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/dictionary":{"summary":"Read and edit dictionary content through the Space access gate.","get":{"tags":["Dictionary"],"summary":"List a dictionary entry with existing Space permissions.","operationId":"listDictionaryEntries","parameters":[{"description":"Address a Space dictionary.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Filter editable entries, including explicitly requested tombstones.","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Filter editable entries, including explicitly requested tombstones.","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}},{"description":"Filter editable entries, including explicitly requested tombstones.","name":"status","in":"query","schema":{"anyOf":[{"enum":["conflict","proposed","published"]},{"type":"null"}],"default":null}},{"description":"Filter editable entries, including explicitly requested tombstones.","name":"deleted","in":"query","schema":{"type":"boolean","default":false}},{"description":"Filter editable entries, including explicitly requested tombstones.","name":"q","in":"query","schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_DictionaryEntry_"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["OqvtZhgfEWdCDXspBfUf"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]},"post":{"tags":["Dictionary"],"summary":"Create a dictionary entry with existing Space permissions.","operationId":"createDictionaryEntry","parameters":[{"description":"Address a Space dictionary.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DictionaryCreate"}}},"description":"Create a manual term group.","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DictionaryEntry"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["FavQPjOEixJiRwYPCQCL"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/dictionary/builds":{"summary":"Inspect or request extraction within the owning Space.","get":{"tags":["Dictionary"],"summary":"Read or request dictionary extraction with durable progress.","operationId":"listDictionaryBuilds","parameters":[{"description":"Address a Space dictionary.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_DictionaryBuild_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["grLKWvRIpETSAEbmPviC"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]},"post":{"tags":["Dictionary"],"summary":"Read or request dictionary extraction with durable progress.","operationId":"buildDictionary","parameters":[{"description":"Address a Space dictionary.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DictionaryBuild"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["nLYYwYlubXxAwRYGKxBb"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/dictionary/builds/{build_id}":{"summary":"Inspect or request extraction within the owning Space.","get":{"tags":["Dictionary"],"summary":"Read or request dictionary extraction with durable progress.","operationId":"getDictionaryBuild","parameters":[{"description":"Address one dictionary pass within its Space.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Address one dictionary pass within its Space.","name":"build_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DictionaryBuild"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["MglcddVpiDgDSElUxRTO"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/dictionary/builds/{build_id}/retry":{"summary":"Inspect or request extraction within the owning Space.","post":{"tags":["Dictionary"],"summary":"Read or request dictionary extraction with durable progress.","operationId":"retryDictionaryBuild","parameters":[{"description":"Address one dictionary pass within its Space.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Address one dictionary pass within its Space.","name":"build_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DictionaryBuild"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["DUEzWuAaFuoiSQDhwnft"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/dictionary/{entry_id}":{"summary":"Read and edit dictionary content through the Space access gate.","get":{"tags":["Dictionary"],"summary":"Get a dictionary entry with existing Space permissions.","operationId":"getDictionaryEntry","parameters":[{"description":"Address a term group within its Space.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Address a term group within its Space.","name":"entry_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DictionaryEntry"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["eDrlYcjPEVmfFPelQunT"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]},"put":{"tags":["Dictionary"],"summary":"Update a dictionary entry with existing Space permissions.","operationId":"updateDictionaryEntry","parameters":[{"description":"Address a term group within its Space.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Address a term group within its Space.","name":"entry_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DictionaryUpdate"}}},"description":"Replace editable content if the displayed entry has not changed.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DictionaryEntry"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["sySfOrAIjhhTpKRFgkCL"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]},"delete":{"tags":["Dictionary"],"summary":"Delete a dictionary entry with existing Space permissions.","operationId":"deleteDictionaryEntry","parameters":[{"description":"Address a term group within its Space.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Address a term group within its Space.","name":"entry_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Guard deletion or explicit restoration against concurrent edits.","name":"version","in":"query","schema":{"type":"integer","minimum":1},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DictionaryEntry"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["OWLquudqFxnOOUTysjkk"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/dictionary/{entry_id}/restore":{"summary":"Restore dictionary content within an authorized Space.","post":{"tags":["Dictionary"],"summary":"Restore a dictionary entry with existing Space permissions.","operationId":"restoreDictionaryEntry","parameters":[{"description":"Address a term group within its Space.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Address a term group within its Space.","name":"entry_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DictionaryVersion"}}},"description":"Guard deletion or explicit restoration against concurrent edits.","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DictionaryEntry"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["CXZkpBcSmOJxwnwBaRiz"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/document-operations/{operation_id}":{"summary":"Poll a retained document operation with current space read access.","get":{"tags":["Documents"],"summary":"Fetch safe progress even after the target document is removed.","operationId":"getDocumentOperation","parameters":[{"description":"A retained operation belongs to the requested space.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"A retained operation belongs to the requested space.","name":"operation_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentOperationStatus"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["UcEYqBpvfGKgamswLBba"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/documents":{"summary":"A space's documents as a collection: ingest one, or list them.","description":"The two operations need different access: ingesting writes a space, while\nlisting only reads it, so a read-only member may list documents but not add\none. Both take the space from the path and the caller from the request.","get":{"tags":["Documents"],"summary":"List a page of a space's documents the caller may view, newest first.","description":"Only a member of the space may list its documents: a non-member is told\nthe space was not found, masking its existence exactly as the query and\nsearch endpoints do. Listing only needs read access, which every\nmembership role grants, so a member is never forbidden -- the 403 that\nthe upload can raise never arises here. The optional ``content_type``,\n``status`` and ``name`` query parameters filter the listing in the\ndatabase (name is a case-insensitive contains); a combination nothing\nmatches returns an empty page. The ``page`` and ``page_size`` parameters\nselect the slice to return. Each document is returned by its public id,\nname, status, stored size and type, live chunk count and creation time.","operationId":"listDocuments","parameters":[{"description":"Path parameters that identify the space a document belongs to.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Optional filters that narrow a space's document listing.\n\nEvery field is optional: an omitted one does not constrain the listing, so\na request with none returns every document (newest first). Supplied fields\nintersect -- all must hold -- and each is applied in the database query by\nthe selector. A combination that nothing matches yields an empty listing.\nThe page and page size ride along from :class:`PageParams`, so a large\nspace is returned one page at a time rather than all at once.","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Optional filters that narrow a space's document listing.\n\nEvery field is optional: an omitted one does not constrain the listing, so\na request with none returns every document (newest first). Supplied fields\nintersect -- all must hold -- and each is applied in the database query by\nthe selector. A combination that nothing matches yields an empty listing.\nThe page and page size ride along from :class:`PageParams`, so a large\nspace is returned one page at a time rather than all at once.","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}},{"description":"Optional filters that narrow a space's document listing.\n\nEvery field is optional: an omitted one does not constrain the listing, so\na request with none returns every document (newest first). Supplied fields\nintersect -- all must hold -- and each is applied in the database query by\nthe selector. A combination that nothing matches yields an empty listing.\nThe page and page size ride along from :class:`PageParams`, so a large\nspace is returned one page at a time rather than all at once.","name":"content_type","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},{"description":"Optional filters that narrow a space's document listing.\n\nEvery field is optional: an omitted one does not constrain the listing, so\na request with none returns every document (newest first). Supplied fields\nintersect -- all must hold -- and each is applied in the database query by\nthe selector. A combination that nothing matches yields an empty listing.\nThe page and page size ride along from :class:`PageParams`, so a large\nspace is returned one page at a time rather than all at once.","name":"status","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},{"description":"Optional filters that narrow a space's document listing.\n\nEvery field is optional: an omitted one does not constrain the listing, so\na request with none returns every document (newest first). Supplied fields\nintersect -- all must hold -- and each is applied in the database query by\nthe selector. A combination that nothing matches yields an empty listing.\nThe page and page size ride along from :class:`PageParams`, so a large\nspace is returned one page at a time rather than all at once.","name":"name","in":"query","schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_DocumentSummaryPayload_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["kAePvIOmXZzdHJlOoneG"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]},"post":{"tags":["Documents"],"summary":"Upload a document file into a space and run the ingest pipeline.","description":"Only a member who may write the space (editor or owner) can ingest: a\nnon-member is told the space was not found, a read-only member gets a\n403. The original is stored verbatim and the pipeline runs inline, so\nthe response is ``201 Created`` with the new document's ``id`` and\n``status`` (``indexed`` once text was extracted and indexed, otherwise\n``uploaded``).\n\nAlongside the file the request may carry an optional display ``name``\nand an optional ``metadata`` part -- a JSON object describing what the\ndocument is (its department, the period it covers, its kind). Any field\nthe space has declared must be of the declared type, or the upload is\nrefused with a 400 naming the field; a field the space has not declared\nis stored as sent but cannot be searched by.\n\nA space attached to storage this platform did not make can refuse the\nupload for three reasons of its own. Storage described only well enough\nto be searched has no field this platform could find its own rows by,\nso loading documents into it is a 409. Storage that cannot hold\nsomething the space's own way of cutting produces -- a hierarchical\ncut's broader passage, on a store whose fields compare whole values --\nis a 409 as well, naming what could not be stored and why. And storage\nnobody has confirmed yet answers 428 carrying a few of its rows:\nsomebody has to look at them and say the corpus is the one they meant,\nwhich they do through the space's storage-confirmation endpoint, after\nwhich the same upload goes through.","operationId":"ingestDocument","parameters":[{"description":"Path parameters that identify the space a document belongs to.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary"}},"type":"object","required":["file"],"title":"DocumentUploadFiles","description":"File component of the multipart ingest request — one ``file`` part.","examples":[{"file":{"name":"c1","content_type":"ppcjnkcuaAatfiKdOJHB","size":4}}]}}},"description":"File component of the multipart ingest request — one ``file`` part.","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentFullPayload"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["bkmgoXatRlWIhdivNgUV"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"413":{"description":"Content Too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"428":{"description":"Precondition Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachedStoragePreview"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/documents/archive":{"summary":"Admit an archive or its files for ordinary document indexing.","post":{"tags":["Documents"],"summary":"Validate the complete archive and return each admission result.","operationId":"importArchive","parameters":[{"description":"Path parameters that identify the space a document belongs to.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"A retry preserves the command id and all upload options.","name":"command_id","in":"query","schema":{"type":"string","format":"uuid"},"required":true},{"description":"A retry preserves the command id and all upload options.","name":"mode","in":"query","schema":{"enum":["combined","separate"]},"required":true},{"description":"A retry preserves the command id and all upload options.","name":"use_llm","in":"query","schema":{"type":"boolean","default":false}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"type":"string","format":"binary"}},"type":"object","required":["file"],"title":"DocumentUploadFiles","description":"File component of the multipart ingest request — one ``file`` part.","examples":[{"file":{"name":"44","content_type":"jdzkJmjFXCYZNDteBjDw","size":3}}]}}},"description":"File component of the multipart ingest request — one ``file`` part.","required":true},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchiveImportResult"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["ikyokFoRelwlRzdkKqpk"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"413":{"description":"Content Too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/documents/{document_id}":{"summary":"A single document within a space: view it, describe it, or delete it.","description":"The three operations do not need the same access: viewing only reads the\nspace, so any member (or a read-scoped key) may fetch a document, while\nchanging what it says about itself and deleting it both write the space --\nthe one replaces its description, the other removes it, its chunks and its\nvectors -- so both need a member who may write (editor or owner, or a\nwrite-scoped key). A non-member is told the space was not found whichever\nit asked for, and a document from another space is masked as not-found just\nlike a wholly missing one.","get":{"tags":["Documents"],"summary":"Fetch a single document of a space the caller may view, by id.","description":"Only a member may view it: a non-member is told the space was not found,\nmasking its existence exactly as the list and query endpoints do.\nViewing needs only read access, which every membership role grants, so a\nmember is never forbidden here. A document that does not exist in the\nspace -- missing, or owned by another space -- is reported as not-found.","operationId":"getDocument","parameters":[{"description":"Path parameters that identify one document within a space.\n\nBoth ids come from the single-document route under a space's documents\ncollection: the space scopes access, and the document is only ever reached\nwithin it, so a document from another space is masked as not-found.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Path parameters that identify one document within a space.\n\nBoth ids come from the single-document route under a space's documents\ncollection: the space scopes access, and the document is only ever reached\nwithin it, so a document from another space is masked as not-found.","name":"document_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentFullPayload"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["PFQmVlgOZNGeBjCvhCPL"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]},"delete":{"tags":["Documents"],"summary":"Accept document removal and return its retained operation identity.","description":"Current write access is required. The document is hidden immediately;\nphysical deletion completes asynchronously and is reported by the\nretained space-scoped operation status endpoint.","operationId":"deleteDocument","parameters":[{"description":"Path parameters that identify one document within a space.\n\nBoth ids come from the single-document route under a space's documents\ncollection: the space scopes access, and the document is only ever reached\nwithin it, so a document from another space is masked as not-found.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Path parameters that identify one document within a space.\n\nBoth ids come from the single-document route under a space's documents\ncollection: the space scopes access, and the document is only ever reached\nwithin it, so a document from another space is masked as not-found.","name":"document_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"An omitted command creates a fresh scoped delete request.","name":"command_id","in":"query","schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"default":null}}],"responses":{"204":{"description":"No Content","headers":{"X-Document-Operation-Id":{"schema":{"type":"string","examples":["MXWazzCwWEwYAaGYHkRb"]},"description":"Retained deletion operation UUID","required":true}},"content":{"application/json":{"schema":{"type":"null","examples":[null]}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["ShRjhnAJAdXRtbvYXikY"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]},"patch":{"tags":["Documents"],"summary":"Replace what a document says about itself, leaving the file alone.","description":"Only a member who may write the space (editor or owner) can: a\nnon-member is told the space was not found, a read-only member gets a\n403. Nothing about the stored file, the text extracted from it or the\nchunks cut from that text depends on the description, so correcting a\ndepartment or a year applies at once and re-indexes nothing.\n\nThe ``metadata`` map replaces the stored one whole -- a field left out\nis dropped, and an empty map clears the description -- so a client\nstates what the document is rather than how it differs from what it\nwas. A field the space has declared must be of the declared type, or\nthe request is refused with a 400 naming the field; a field the space\nhas not declared is stored as sent but cannot be searched by. The\nupdated document is returned in full.","operationId":"updateDocumentMetadata","parameters":[{"description":"Path parameters that identify one document within a space.\n\nBoth ids come from the single-document route under a space's documents\ncollection: the space scopes access, and the document is only ever reached\nwithin it, so a document from another space is masked as not-found.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Path parameters that identify one document within a space.\n\nBoth ids come from the single-document route under a space's documents\ncollection: the space scopes access, and the document is only ever reached\nwithin it, so a document from another space is masked as not-found.","name":"document_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentMetadataPayload"}}},"description":"What a document is to say about itself from now on.\n\nA whole replacement rather than a field-by-field patch. The map is small\nand is edited as one thing, and \"the fields are exactly these\" is something\na client can state from what it is already showing, while \"change this one\nand leave the others\" obliges it to know what the others currently are --\nwhich is how two people editing one document quietly undo each other.\n\nSending an empty map is therefore meaningful: it says the document\ndescribes itself with nothing, and clears whatever it carried.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentFullPayload"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["XKFqLnEUodHTSgNsQScf"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/documents/{document_id}/activate":{"summary":"Write access is required before accepting or replaying intent.","post":{"tags":["Documents"],"summary":"Accept work and return safe progress for operation polling.","operationId":"activateDocument","parameters":[{"description":"Path parameters that identify one document within a space.\n\nBoth ids come from the single-document route under a space's documents\ncollection: the space scopes access, and the document is only ever reached\nwithin it, so a document from another space is masked as not-found.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Path parameters that identify one document within a space.\n\nBoth ids come from the single-document route under a space's documents\ncollection: the space scopes access, and the document is only ever reached\nwithin it, so a document from another space is masked as not-found.","name":"document_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentLifecycleRequest"}}},"description":"A retry reuses the same command UUID.","required":true},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentOperationStatus"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["XiNOBSwGdhERyWzvOVUI"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/documents/{document_id}/deactivate":{"summary":"Write access is required before accepting or replaying intent.","post":{"tags":["Documents"],"summary":"Accept work and return safe progress for operation polling.","operationId":"deactivateDocument","parameters":[{"description":"Path parameters that identify one document within a space.\n\nBoth ids come from the single-document route under a space's documents\ncollection: the space scopes access, and the document is only ever reached\nwithin it, so a document from another space is masked as not-found.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Path parameters that identify one document within a space.\n\nBoth ids come from the single-document route under a space's documents\ncollection: the space scopes access, and the document is only ever reached\nwithin it, so a document from another space is masked as not-found.","name":"document_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentLifecycleRequest"}}},"description":"A retry reuses the same command UUID.","required":true},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentOperationStatus"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["pOnHpgrqoqVDznpPrhuJ"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/documents/{document_id}/download":{"summary":"The stored original file of a single document within a space.","description":"Reading a document only reads the space, so any member (or a read-scoped\nkey) may download its original; a non-member is told the space was not\nfound, and a document from another space is masked as not-found just like a\nwholly missing one, so a caller with access to one space can never reach\nanother space's file by id.","get":{"tags":["Documents"],"summary":"Download a single document's stored original file, by id.","description":"Only a member may download it: a non-member is told the space was not\nfound, masking its existence exactly as the detail endpoint does.\nViewing needs only read access, which every membership role grants, so a\nmember is never forbidden here. A document that does not exist in the\nspace -- missing, or owned by another space -- is reported as not-found.\nThe original is returned verbatim as an attachment with its stored\nfilename and content type, not as a JSON body.","operationId":"downloadDocument","parameters":[{"description":"Path parameters that identify one document within a space.\n\nBoth ids come from the single-document route under a space's documents\ncollection: the space scopes access, and the document is only ever reached\nwithin it, so a document from another space is masked as not-found.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Path parameters that identify one document within a space.\n\nBoth ids come from the single-document route under a space's documents\ncollection: the space scopes access, and the document is only ever reached\nwithin it, so a document from another space is masked as not-found.","name":"document_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","headers":{"Content-Disposition":{"schema":{"type":"string","examples":["rgFJgOEZsUKaPWwuJuNO"]},"required":true},"Content-Length":{"schema":{"type":"string","examples":["DaPYyNWZYTeFWmHCZuFM"]},"required":true}},"content":{"*/*":{"schema":{"type":"string","format":"binary"}},"application/json":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["sTjnqKcdaEyYHguZGuER"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RefusalBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorModel"}},"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RefusalBody"}},"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/documents/{document_id}/original":{"summary":"Accept replayable create or replacement without waiting for indexing.","get":{"tags":["Documents"],"summary":"Read accepted revision and current intent before a replacement.","operationId":"getDocumentOriginalState","parameters":[{"description":"Path parameters that identify one document within a space.\n\nBoth ids come from the single-document route under a space's documents\ncollection: the space scopes access, and the document is only ever reached\nwithin it, so a document from another space is masked as not-found.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Path parameters that identify one document within a space.\n\nBoth ids come from the single-document route under a space's documents\ncollection: the space scopes access, and the document is only ever reached\nwithin it, so a document from another space is masked as not-found.","name":"document_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OriginalDocumentState"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["nonagIPfXyOceQfbIcvQ"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]},"post":{"tags":["Documents"],"summary":"Reserve identity and bytes; poll the operation for completion.","operationId":"applyDocumentOriginal","parameters":[{"description":"Path parameters that identify one document within a space.\n\nBoth ids come from the single-document route under a space's documents\ncollection: the space scopes access, and the document is only ever reached\nwithin it, so a document from another space is masked as not-found.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Path parameters that identify one document within a space.\n\nBoth ids come from the single-document route under a space's documents\ncollection: the space scopes access, and the document is only ever reached\nwithin it, so a document from another space is masked as not-found.","name":"document_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Public original commands cannot carry extension authority.","name":"command_id","in":"query","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Public original commands cannot carry extension authority.","name":"intent","in":"query","schema":{"enum":["create","replace"]},"required":true},{"description":"Public original commands cannot carry extension authority.","name":"use_llm","in":"query","schema":{"type":"boolean"},"required":true},{"description":"Public original commands cannot carry extension authority.","name":"expected_revision_id","in":"query","schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"default":null}},{"description":"Public original commands cannot carry extension authority.","name":"expected_intent_version","in":"query","schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"allOf":[{"$ref":"#/components/schemas/OriginalUploadForm"},{"properties":{"file":{"type":"string","format":"binary"}},"type":"object","required":["file"],"title":"DocumentUploadFiles","description":"File component of the multipart ingest request — one ``file`` part.","examples":[{"file":{"name":"ec","content_type":"ZXsFQPDiBdGNXQpxaIMC","size":5}}]}]}}},"description":"File component of the multipart ingest request — one ``file`` part. Optional multipart text parts accompanying original bytes.","required":true},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OriginalAcceptance"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["WaKzHvrUwnBLqYlMtnaz"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"413":{"description":"Content Too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/documents/{document_id}/reindex":{"summary":"Write access is required before accepting or replaying intent.","post":{"tags":["Documents"],"summary":"Accept work and return safe progress for operation polling.","operationId":"reindexDocument","parameters":[{"description":"Path parameters that identify one document within a space.\n\nBoth ids come from the single-document route under a space's documents\ncollection: the space scopes access, and the document is only ever reached\nwithin it, so a document from another space is masked as not-found.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Path parameters that identify one document within a space.\n\nBoth ids come from the single-document route under a space's documents\ncollection: the space scopes access, and the document is only ever reached\nwithin it, so a document from another space is masked as not-found.","name":"document_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentLifecycleRequest"}}},"description":"A retry reuses the same command UUID.","required":true},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentOperationStatus"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["tQjYWrrPrEJXNosdPRly"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/evaluations":{"summary":"A space's evaluation runs as a collection: request one, or list them.","get":{"tags":["Evaluations"],"summary":"List a page of the space's runs, newest first, as summaries.","description":"Scoped to a space the caller may evaluate in, so a non-member is told\nthe space was not found. What each run carries is enumerated once, on\nthe summary itself, rather than restated here where it would go stale\nthe next time a run learns to say something new. The ``page`` and\n``page_size`` parameters select the slice to return.\n\nReading the list is not free of effects. Every run of the space that\nsays it is being scored, but whose scoring attempt is not signalling\nthat it is alive, is closed out first -- on any page, not only the one\nasked for -- so it comes back ``failed`` with the reason\n``abandoned``, and the throwaway space it was being scored in is\ndropped. A run whose attempt is still signalling\nis left exactly as it is. The detail endpoint does the same for the one\nrun it is asked about.","operationId":"listEvaluationRuns","parameters":[{"description":"Path parameters that identify the space a run collection belongs to.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_EvaluationRunSummary_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["VIarcMqyzBdWXhcWtOmn"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]},"post":{"tags":["Evaluations"],"summary":"Open a pending run for the space and enqueue its scoring.","description":"The body names the dataset to score (the caller must own it) and\noptionally ``top_k``, the number of chunks each query retrieves. With\nnone given the deployment's default depth applies; a depth the cutoff\nnot be computed over is rejected rather than scored short. It may also\nname ``judge_model``, the model that scores the generated answers --\ntypically a stronger one than the space answers with; named none, the\njudge falls back to the space's own model.\n\nThe space's pipeline and the identity of its embedding model and\nvector backend are snapshotted into the run, which is created\n``pending``; a space still owed an accepted configuration change is\nrefused instead, since the pipeline snapshotted would be the one it is\nleaving, and the refusal says whether that rebuild is still coming or\nhas failed. Opening the run is what\nasks for it: the ask is part of the write rather than the next thing\nthis controller does, and it goes out on the row's commit, so no\nworker is ever brought to a run it would not yet find. The response is\n``202 Accepted`` with the run's id, status and the depth it will run\nat. A non-member sees the space as not-found; a\ndataset the caller does not own is likewise not-found.\n\nThe body may finally say what becomes of the space the run is scored in\nwith ``space_use``. By default the run fills a throwaway space and drops\nit; it may instead leave that space standing, so a later run can be\nscored in it rather than paying for the same corpus and the same\nknowledge graph again; or it may ask to be scored in this very space,\nwhich is refused unless that space holds the corpus of the dataset being\nscored, has no index still being rebuilt, and carries a knowledge graph\nanswering what the configuration asks of it.","operationId":"createEvaluationRun","parameters":[{"description":"Path parameters that identify the space a run collection belongs to.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluationRunRequest"}}},"description":"The body that requests a new run against a space.\n\nNames the dataset to score (by its public id; the caller must own it),\noptionally how many chunks each query retrieves, optionally how many\nqueries are scored at once, and optionally the model that scores the\ngenerated answers. ``top_k`` genuinely drives the scoring: the queries are\nretrieved at that depth and the metrics are computed over the documents\nthat ranking collapses to, so two runs asking for different depths report\ndifferent numbers.\n\nOmitting it takes the deployment's default retrieval depth, which sits\ncomfortably above the metric cutoff -- the cutoff counts documents while\nthis counts chunks, and a document cut into several chunks occupies several\nof them, so a ranking has to be several times deeper than the cutoff before\nit collapses to that many documents.\n\n``query_concurrency`` moves what a run costs in wall-clock time and nothing\nabout the numbers it reports: the same queries go through the same pipeline\nand each score is folded into the same average however the scheduling fell\nout. It is per run because the right value follows what the scored space\nanswers through -- a rate-limited provider wants few in flight, a local\nmodel behind a fast card wants many -- and that is a fact about this run,\nnot about the installation.\n\n``space_use`` says what becomes of the space the run is scored in, and it is\nasked for rather than worked out. Filling a space costs an ingest of the\nwhole corpus and, for a configuration reading a knowledge graph, a model\ncall per chunk of it -- while most comparisons vary something the build\nnever writes down, so most of that spending buys a second graph that differs\nfrom the first only in being drawn afresh. A run may therefore leave its\nspace standing, and a later run may be scored in that space instead. What\nthis never does is choose such a space by itself: there is no register of\nwhich spaces would serve which corpora, and inventing one would trade a\nsaved graph build for the chance of scoring a dataset's questions against\nsomebody else's corpus without saying so.\n\nThe rank cutoff the metrics are computed at is deliberately absent: two runs\nscored at different cutoffs cannot be compared, which is the one thing the\nevaluation service exists to do, so it stays the installation's.","required":true},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluationRunSummary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["QvouDelsejzzHwsMmAjS"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/evaluations/compare":{"summary":"Two of a space's runs compared by their means and question by question.","description":"Reached through the evaluation action of the access gate, which opens it to\nevery member and to a key only where it holds ``manage`` and its owner still\nowns the space (see ``ScopeLevel``). A space the caller has no standing on,\nand a run that belongs to another space, are both reported as not-found.","get":{"tags":["Evaluations"],"summary":"Compare the runs named ``run_a`` (the baseline) and ``run_b``.","description":"Both must be finished runs of this space that scored the same dataset,\nand they must be two runs rather than one. The response carries the\ndiff of the two runs' averages and, for each ranking metric over the\nquestions both runs ranked: how many questions improved, worsened or\nstayed the same, both means and their difference, a confidence\ninterval for each, the p-value of a paired sign-flip test and its\nverdict -- significant, not significant, or too few questions to\ntell. The significance level and the number of resamples are the\nspace's configuration, and they come back with the seed the\ncomparison drew from and the fewest questions a verdict needs at that\nlevel, so the same request answers the same way.\n\n``answer`` carries the same figures for faithfulness, relevancy and\ncorrectness, from each run's own judging of its answers, with the\njudge behind each side and how many paired questions each run left\nempty; where the answers could not be paired, ``pairing`` says why.","operationId":"compareSpaceEvaluationRuns","parameters":[{"description":"Path parameters that identify the space a run collection belongs to.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Query parameters that name the two runs to compare.\n\n``run_a`` is the baseline and ``run_b`` is the run compared against it, so\nevery reported difference reads as the change from the first to the\nsecond. Where the two runs have to be found -- the dataset or the space the\npath names -- is the path's to say.","name":"run_a","in":"query","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Query parameters that name the two runs to compare.\n\n``run_a`` is the baseline and ``run_b`` is the run compared against it, so\nevery reported difference reads as the change from the first to the\nsecond. Where the two runs have to be found -- the dataset or the space the\npath names -- is the path's to say.","name":"run_b","in":"query","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluationRunPairedComparison"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["RfbqlLDdIXrfPENPTtsN"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/evaluations/compare/queries":{"summary":"Two of a space's runs set side by side, one question at a time.","description":"Its own collection beneath the comparison, for the reason a run's own\nper-query records are: there are as many questions as the dataset holds,\nand none of them belongs inside the comparison's response. Gated exactly as\nthat comparison is.","get":{"tags":["Evaluations"],"summary":"List a page of the two runs' questions, in dataset order.","description":"The questions are those either run ranked when ``metric`` is a ranking\nmetric, and those either run answered when it is an answer metric.\nEach carries both runs' ranking metrics for it, both answers with the\nverdicts each run's own reading gave them and whether each was empty,\nhow much ``metric`` moved and which way, what each run reached, the\npassages one reached and the other did not, and the rank of the first\nrelevant passage in each. ``change`` keeps only the questions that\nmoved that way; on an answer metric no question moves where the\ncomparison could not pair the two runs' answers. The runs are held to\nthe same terms as the comparison of their means.","operationId":"listComparedEvaluationQueries","parameters":[{"description":"Path parameters that identify the space a run collection belongs to.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Which page of two runs' questions to set side by side, and which ones.\n\nThe two runs are named as for the comparison of their means. ``metric``\nsays which metric decides whether a question improved or worsened, and\nwhich questions are listed: those either run ranked for a ranking metric,\nthose either run answered for an answer metric. ``change``, when given,\nkeeps only the questions that moved that way on it -- so the questions\nthat got worse are one request away.","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Which page of two runs' questions to set side by side, and which ones.\n\nThe two runs are named as for the comparison of their means. ``metric``\nsays which metric decides whether a question improved or worsened, and\nwhich questions are listed: those either run ranked for a ranking metric,\nthose either run answered for an answer metric. ``change``, when given,\nkeeps only the questions that moved that way on it -- so the questions\nthat got worse are one request away.","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}},{"description":"Which page of two runs' questions to set side by side, and which ones.\n\nThe two runs are named as for the comparison of their means. ``metric``\nsays which metric decides whether a question improved or worsened, and\nwhich questions are listed: those either run ranked for a ranking metric,\nthose either run answered for an answer metric. ``change``, when given,\nkeeps only the questions that moved that way on it -- so the questions\nthat got worse are one request away.","name":"run_a","in":"query","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Which page of two runs' questions to set side by side, and which ones.\n\nThe two runs are named as for the comparison of their means. ``metric``\nsays which metric decides whether a question improved or worsened, and\nwhich questions are listed: those either run ranked for a ranking metric,\nthose either run answered for an answer metric. ``change``, when given,\nkeeps only the questions that moved that way on it -- so the questions\nthat got worse are one request away.","name":"run_b","in":"query","schema":{"type":"string","format":"uuid"},"required":true},{"description":"A metric of either family that a question can be said to have moved on.\n\nWhat a caller names to have two runs' questions listed by how they moved:\nthe ranking metrics and the answer metrics above, under the same names, and\nnothing besides.","name":"metric","in":"query","schema":{"default":"mrr","$ref":"#/components/schemas/QueryMetric"}},{"description":"Which page of two runs' questions to set side by side, and which ones.\n\nThe two runs are named as for the comparison of their means. ``metric``\nsays which metric decides whether a question improved or worsened, and\nwhich questions are listed: those either run ranked for a ranking metric,\nthose either run answered for an answer metric. ``change``, when given,\nkeeps only the questions that moved that way on it -- so the questions\nthat got worse are one request away.","name":"change","in":"query","schema":{"anyOf":[{"$ref":"#/components/schemas/QueryChange"},{"type":"null"}],"default":null}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_ComparedQuery_"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["aDvpRwOJKgZcdARSnGCy"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/evaluations/rubric-comparison":{"summary":"Compare two explicitly selected rubric readings.","get":{"tags":["Evaluations"],"summary":"Keep missing, changed-version and partial-context pairs explicit.","operationId":"compareEvaluationRubricAssessments","parameters":[{"description":"Path parameters that identify the space a run collection belongs to.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Choose the two exact assessments to compare.","name":"assessment_a","in":"query","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Choose the two exact assessments to compare.","name":"assessment_b","in":"query","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RubricComparison"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["IMXuXeDsgzvsdskcHpBv"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/evaluations/{run_id}":{"summary":"One evaluation run within a space: its status and results.","description":"Reached through the evaluation action of the access gate, which opens it to\nevery member and to a key only where it holds ``manage`` and its owner still\nowns the space (see ``ScopeLevel``). A run id that does not belong to the\nspace, and a space the caller has no standing on, are both reported as\nnot-found, so runs cannot be read across spaces and existence cannot be\nprobed.","get":{"tags":["Evaluations"],"summary":"Return one of the space's runs by id, as the summary describes it.","description":"A non-member sees the space as not-found; a run id outside the space is\nlikewise not-found. What a summary carries is enumerated once, on the\nsummary itself, rather than restated here where it would go stale the\nnext time a run learns to say something new.\n\nThis is the endpoint a client polls while a run is in flight, which is\nwhy the summary says how far the run has got as well as what it was\nasked for.","operationId":"getEvaluationRun","parameters":[{"description":"Path parameters that identify a single run within a space.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Path parameters that identify a single run within a space.","name":"run_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluationRunSummary"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["wdgyQwHsIVBrHuDchERb"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/evaluations/{run_id}/assessments":{"summary":"The readings a run's stored answers have had: ask for one, or list them.","description":"Its own collection beneath the run, because a run can be read again as many\ntimes as its owner cares to: the answer-quality number a run reports is one\njudge's, and putting a second judge to the same answers is what tells a\nresult from an opinion.\n\nReached through the evaluation action of the access gate, which opens it to\nevery member and to a key only where it holds ``manage`` and its owner still\nowns the space (see ``ScopeLevel``).","get":{"tags":["Evaluations"],"summary":"List a page of this run's readings, oldest first.","description":"The first of them is the grading the run made as it scored, and every\nlater one sits beside it under its own judge's name -- including two by\nthe same model, which are two rows told apart by when they were made.\n\nEach carries its own averages and two counts saying how far they\nstretch. ``partial_context_count`` is how many of its verdicts were\ntaken on a grounding shorter than the run's own judge read.\n``rejected_correctness_count`` is how many correctness verdicts it\nasked about and did not get: correctness is a score from one to five\nagainst a reference answer, and a reply that misses that range, or that\nno number comes out of at all, is left out of the average rather than\naveraged as a poor score. Both are ``null`` on a reading that has not\nfinished, on one that failed, and on any reading recorded before the\ncount existed.\n\nWhich is why ``reference_count`` inside the score counts the\ncorrectness verdicts that were taken, not the queries that carried a\nreference answer: a dataset of a hundred and sixteen references, three\nof whose replies missed the scale, reports a hundred and thirteen\nthere and three here.\n\nThe same holds for ``faithfulness_count`` and ``relevancy_count``:\neach says how many queries its own mean covers, and both fall short of\n``answered_count`` -- which is how many queries were scored at all -- by\nthe replies that were no verdict either way. Those are left out rather\nthan counted as a refusal, so a judge that said nothing about six of a\nhundred and sixteen answers reports a hundred and sixteen scored and a\nhundred and ten under each of those two counts. Both are ``null`` on a\nscore recorded before such a reply could be told from a verdict.\n\n``empty_count`` inside the score is how many of the ``answered_count``\nanswers had nothing in them; those are scored as failures without the\njudge. It is ``null`` on a score recorded before empty answers were\ntold apart.","operationId":"listEvaluationRunAssessments","parameters":[{"description":"Path parameters that identify a single run within a space.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Path parameters that identify a single run within a space.","name":"run_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_AnswerAssessmentSummary_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["mxGQOAhTeodfqYYFaPRj"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]},"post":{"tags":["Evaluations"],"summary":"Ask for this run's stored answers to be judged again.","description":"The body names the model to judge through, and that is all it names:\nnothing is retrieved and nothing is generated, since the questions, the\nanswers and the grounding are read back exactly as the run recorded\nthem. What it costs is one model call per stored answer.\n\nThe reading is recorded ``pending`` and asking for it is what brings a\nworker: the ask is part of the write rather than the next thing this\ncontroller does, and it goes out on the row's commit. The response is\n``202 Accepted`` with the reading's id and status; its averages appear\non it once it finishes, and are folded out of the verdicts it wrote.\n\nA non-member sees the space as not-found, and so does a run id outside\nthe space. A run still being scored is refused, and so is one that\nstopped -- what either recorded is a share of its dataset that nothing\nnames -- and the two are told apart, since one is waited for and the\nother scored again. A run that kept no answers at all is refused too,\nwhether because it scored only the ranking metrics or because it\npredates the record.","operationId":"assessEvaluationRunAnswers","parameters":[{"description":"Path parameters that identify a single run within a space.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Path parameters that identify a single run within a space.","name":"run_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnswerAssessmentRequest"}}},"description":"The body that asks for a run's stored answers to be read again.\n\nOne field, because one is all that changes. A reading answers nothing and\nretrieves nothing: it takes the questions, the answers and the grounding\nexactly as the run recorded them, so what it can differ in is the judge.\n\nThe model is required rather than falling back to the one the scored space\nanswers with. A reading that named none would be asking for whatever that\nspace's configuration says today -- which nothing freezes, and which may\nwell be the model that wrote the answers, so the reading would be the model\ngrading itself. Naming it is also the whole point: a run's own judge is\nalready on the record, and this exists to put a different one beside it.","required":true},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnswerAssessmentSummary"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["tiLioBONGooTNqaOoPuv"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/evaluations/{run_id}/queries":{"summary":"What one run produced for each query it put through.","description":"Its own collection beneath the run, for the reason a dataset's queries are\ntheir own collection beneath the dataset: there are as many of them as its\nowner uploaded, and none of them belongs inside a response about the run.\nReached through the evaluation action of the access gate, which opens it to\nevery member and to a key only where it holds ``manage`` and its owner still\nowns the space (see ``ScopeLevel``). Two of a space's runs are compared,\nquestion by question as well, beneath the space's evaluations behind the\nsame access; the comparison anchored on a dataset is gated differently, on\nthe caller owning the dataset both runs scored.","get":{"tags":["Evaluations"],"summary":"List a page of this run's per-query records, in dataset order.","description":"A non-member sees the space as not-found; a run id outside the space is\nlikewise not-found. Each record carries the question as it was put, what\nthe ranking found and what that was worth, the answer that was written\nand what it was grounded in, and every judge's reading of that answer.\nA half the run did not compute reads as absent rather than as an empty\nresult. The ``page`` and ``page_size`` parameters select the slice.","operationId":"listEvaluationRunQueries","parameters":[{"description":"Path parameters that identify a single run within a space.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Path parameters that identify a single run within a space.","name":"run_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_EvaluationQueryOutcomeSummary_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["dLBsIdGEashbTwOaveaQ"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/evaluations/{run_id}/rubric-assessments":{"summary":"Request and list immutable rubric readings beneath a run.","get":{"tags":["Evaluations"],"summary":"List pinned rubric readings and their explicit denominators.","operationId":"listEvaluationRunRubricAssessments","parameters":[{"description":"Path parameters that identify a single run within a space.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Path parameters that identify a single run within a space.","name":"run_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RubricAssessmentSummary"},"type":"array","examples":[[{"id":"e9b3f469-dae5-482f-b5e2-96c0c3c62286","run_id":"e3b45c8d-97e4-4ddf-b9bf-0ff2b73fd930","rubric":{"id":"5245ad50-9e7b-435c-bdee-5b5a62ebee37","rubric_id":"9aa572f4-7314-4c3e-b904-d29958ce46ee","version":6017,"criteria":[{"key":"15db529100beaf01981609b8cdc4d4f966c5dec1d8f1fb3238eb27be","instruction":"a5","required":true,"kind":"json_schema","regex":{"pattern":"88182d6919543a2c2560a6f5d1d76e7ac2dcf5c2a39911b0edbfd628615b9e2c29e98f867cafdf9df23749f01a5f3bd00455bcd56a3e032de67fca76312799e4ffad5cb4cb54f6e6701db61dd56f2e9ebe3fe28d1cb49cf3a8626ba3bc8a0536a4ca0f05d1268a9161fc3142db6f0f075c79045d7ab578fdcfbad1a3ce96fae993e357165cac5950e9e3746b200d98cd8f7d6859b7da8b94ac75757938957f6efca868dff390249f59bf55418d3ec91497d626d1c13150c468b492a41f535d48c41a44790e63d2aa4fee207d29a079c3bbac76e711713083baa027ee579ef9962e74319a80eeb9af0ccd9495a287cba4370370d0ec547e75e170c2f023e0723bf15333e76a23c2771b6d60fedd0a3e4da7fe8f4b03d8912150c038a13dded788ef3b8d62dae427fe606f53fc9b4bf30feea04818c50ccb323e2ede7f2bbd2e3ea7e7b6cfbb4a7ea6d387ef07745e816b70de104d001d83f0456ea8aa9392a02c81d394ff18dd4f22324f8eb92744565361e11aa356ddaf08994d873c589c25a6f55c365c61e78693fb62c0f33355735f79247f915b480f1f317084affaa0694041776f5690c53fb860ead86b6a1201f6a71d380ec135049c4b755aa5ef3f721c09567b8f0af15297a7ac8d3ad781b3299eac1896e62ca69301f1926402d335d5f0a69c03ea328837512cabdd2ec4f55b65b4c33e04b2b415a5674084c9ccf2326ffc668d256b123786541dd8b6bf4498916eb08266f5bf9bed59ada48e41357d71e7ca202787896974c9ad8e63257e06598e295f850b396cfa8ed0f318d57a1b1f93072227bac07ef00c586eddae63526fd51f1c70f2cea719f3fb744724658a31b1386ecec221419d02d7007c25c477213ff45d1b67770369bb6948b8478de7a489f8513aba89b812f246276d84c165289d3a561f84668bf42501d1adfe9a7f59dcf2b335518f17946e75fc26178f541e29b885d0735c6043c274e44e7f0b0d553886fdcc22ff89ac0c52cd5de53203580624d8fcbadc818f42807401c3497e7080eac690e0bba9b17d0426987633d490b7be3fdf43f1976e37d4c846b051bbef9e5cbff51357c8c7e9d31a8414ecc75012f057748ecf1d9b529c3256e63ca464181721faae31e9d23981eed259ab39b467a4af57f18c5f3aae5c46799a9fe43abb48a0cbbbac2745a5360e73fb75d6ac67d6684320b44f07bb98eaad41f84a01b1974757ba4afd1744ac6a00672f14c408ca864b7abfb8cfd02e055d47a8f6e5256e46e23ac21a99bf1ef0d9eb704b977e2c0fd7f14198f7a8e9bff51cc9adb29c83353cf83345c713b7a4c335a9d6e9683c0b7532ac1cb20c23785dfb31320dd9f503a7bbf3fdf07fadf08a74563afb76840232cc0fbbb938bcf8dfa3c676bf405e75b0827a33912d8ff97ed92593762fd87aef3722f8d5dadac46922a4b9714a06ba0b2245bcc5ac3d2405bc54c159f5175856828184796f980b351d37f0aba04858a860a4f2ce5de5e0e40ad7a99745c8bcc8056f27df65361ff93000395e8021470d7a33e727cab0f7831dc9a09baae197207ff83cfc4935ddb4236f1547f346c025853abba8365b0d9956d58e55252474a9512528c47eb1f08c32da1922f211eab9fabcbc7d669d25eefcb1b2a96a13024eb2f7d941d001297163c5b4ef44ce7180f61ec8231d86b11a929c9fb7f5f322741c650544e844dad54aad0d1ea7a466144d8e1776f0d6c7ea6b86d77d5e1ef012076d4ee57b3ccad39958650be88cd413da9d89f61d074b5c8ab3b5f4d5294c68abc481f23c405f331ba8b630b49713fa477cb198832a3d911a04a46a512ffc9c4f130fb9be41013737dd43ae985113d5357b924ea151465a5b6df10739895d9f105e72f31cf89e50d2eb83864f2f410941f22","flags":["ignore_case"],"mode":"fullmatch","expect_match":true},"json_schema":{"schema_json":"54db5600c0738b4d4ed53e37d82c3522bd4a9cfc2b5300532597bb8c703ae45fb02f473893b607b44617dc3a8104bb2f09a662aa2264104beea2dfefe46004e65623ac53ae5e3f4fed96e10b4cb9a618cbf4cd5f345828c81e9ea649747a38daaa8ab00bb51adb7c851fd21107f78dff0c7fb7ca3ca5ae798d192afcdcce4cc16ecf4a78ecac663ea3c7aa2d55de08af42c86253a8db504383cffca44d0b2aeb7e629dc293acc95483bf2628ba067c7e818bc4d18294e3ab97bb5212fcccd38392349c904bb99cd82736d57c58cbb0567f21dc2dafcd20bff83f221bd17708c233733966065282b9632af90a0d17db3846adda0c49d8ae73213abaf97c8c912aec950b8c58edb4a01535559306b5ee8188067dd7b5bd78c5bb9ad20d7d3fba3f1a52ad0aa4ae81d7872ef89758665f8086097d5ccced890f361a0dad5426b39fad7fb0b3b9118eef68183ad28982db5ab49f5e9c6fdda1defe8e168d6b5012d3c6079fe4cdb248a9508ec5bbdf226ad467098c206a25a439b7f87d3b1fbc0c4d8f8215ca65cd1f6c5356b70c2ae64c5359856620919401802f1dffe167fb8ee75848a91d18609b394a867b828760fad90e27b13d4df16e928d6fde11fea32f5846cd70be37bcb7251667d1388d10ee43cc7056cb98cf0382c2472be78980127d875739854c0687ffa6ce9edb17ecbee201b17d9bc98b5595730160afce0d2049a3b664003bbf97d9e14d3021443c62cc611f89d3038c3bf6c6622bc49275e2a3eaf23456b6afe0edca2bab71e1611c6a1bd5f3f3e2c4ec9a5bcb10551f4c869f78999f1b9a533327ede7ec34f70cfb836883925e713867d879fbb1faf80974923c207ca893f5b2b1e3ff11abd0aa942831a9e072b62d44763991535d80cd2f6b9e3b62198b67ff707653846ff237f1fe0eccd59ee2ef2a4541244e9ae11f3ef667f49dceb77d8183c3b725f420fe520a7a92fb01e303485a5b612860bcd04b19529de831ce8e37594d7d772f415dc40a8594221ab9e8bf913734190477b2b1a4d2a9f987924edec0753abb79f5ba62c3852eb1c5da0c9ccc7fcbb2f50dfa65aa502970ec2e7fd20400513bed74aa66d006d362c33478e88a16e1b6390c4c967486bd02fc47a4b8a510868b2adb65074525d471623370bf180990d718caf052f6bd86820c19028a97d44b3f1e648f398f5d6cce505a06913dc9e8b4800b11e83724cd03eedd94b475bb3175d99854e977e3742726456dbf55ea063ae027f5d80d77d083f80e7c896ed222591cac63e2f8fea81a385522211a1f2456b75736e550764096fddb754ae26817412002ecc1627d8449a563ad87bb131b85b4d56ef5f8d5b62d7b0afe1c0a98c23d47e6f0e0f0bd5da713efe8d0c75d956838ae62701962b6814be1ffe22da9c1f7f7308539d71b44dc1004d676a13e427b08d3144b85f60ffd0dd1cae7327b827658a1b6721142247894a32c9f6f216595c025e79cb17d7831e574e295efc219bd8d26fb5ece3ce9f0883b49f5741035a33ab42962fcbb23d495fe7035a4bcba2a10c0456d07cf19e84ffba73fd81c04a1084bf796cce36ac8a22c820fba819c0343b47b6414bc54c43a912a51c9b28d0dbc7c518373b07b3659d5311149758bcdf2455ed192196ad7b465d8b04c63bdc9b2ed148544a60dfe944023987b53aad3948cc67c85c7491a983640b54753a543f14d294985e84d12158f35f3a9963fd1581b51bd511ee1aaf1735a7bbd147304cf4ed9b2a0c039ba64370b65108b85a19627610303fe0bb12d90cbd3084a87f013e1cf1e22f1d47164a824ab7263e392d549c688cd4d06875676fb3ade66827538ff92491a95bd7cca2cb594e58d454a3aa2b7bd2470c8ec931787c0a381cd650b681561551708dcf6ac5c783a7ae4acf3b9d9b6b1d4d066f7bff4ba64a8cba51d6b62296f66fc165240b1a00e4444f24152b16ef295eddf85a80a351d4532fe31def680270192a6094b590afa73a7356753ec7040a1ea2aae9528996bf310059af1fe67d01db4e22880a2f98fba3faf206a207acfbe0b7b449b180b923e07dd04a785ac8409ad3f5b15a8ee5c36579a122ebcdf7330110bef5a94852eb235459f8fae896377c3d1fee8aea5e9c1560a4213596347d1d075f82088fbd8d311fb52bbbe78a765de0ad5ea0db077f896a435a13d9fb4a149141787b47e5a635a6178fc0502b1dfe8f0d435007e5f187f1a489869d8f23fdefa9bc503da21f381c54cd1a1feaf85076ab1baca9b028f15f06a1b3622ef97c6bf19914937bb623906e180f416f5cf205196aef1b2bb910b68ea903035d022299d11332761a733385b9bdfb86afda6b48172829b1ae66b2c6d8060911d939482acd5fe76de739f002ee9045331ed0d0a3933a6487bee2c3980ed3aeef6450a052482bd7195464ed1d6f58b1025c0cb1da082d4ea2e70f3f3e532de7d31424734abf5c0a9f878518852ac504f2417fb5eb6221eb7da2e5e5a758c7d01293d444c2b575e2b41a45595d145bd18e421ce63c5d4cc0aa710838a73fe311e318187b08ec655b0f8225c29b8e7b48b0fdb124aa6a528bd862733fbac8f3998bfdf0bb9166b683979d04df71e07960b8c2264665621fb03e8ac1f583dc8d0a04ed553f663012b4329cd13376e575f0d8936b9673552c1bae2752995615612e897974bd8c8ebfe6d3a7ab095c315e981e69472b8ecb82a04e4c1f5b7cac78a00d5ddc1cb16cee897893f07e2093e3994e376381f9b120b64c2d552c348c0b26e0bae9170d9998e30cde857723b4fd4db7cbaa9d69b981a6e88cd4db588c85a0818eba5e7913bedce21e717593d62772db90fedc1ad4d239ed38c4bfd07a565334663535e791bb0044e69e2dc09faa737ded0d6c7fce1820e3c006a2c7d84ff831b98766f77f1c34ff198b2ad764a6e59ed8baa38acd16fbb00adfd8d0004b629a64776c77dc0bbe6c70f2902b547cd7e933491675d6032a0fbe9f656ec9c0c2770638295e86e75c22e3e1e5aa75d5c6b8b3ae56cb0162414980686d274182eb05a502f97fb33c9422b3495c71e9b25d44228b94331f5d3c55773874e585a91bd8d4c12ba34e9c2a458d95e7fdd843576d46f6901d25cca936b6c9def2902ae77dc9c23ea546dcdb0b98b23d987e98bf1a5993386c30e8458511cde6505fe1ec614981c4cdfac72b51c60971a10784338db7637277aba773b50f7711b5405e2babbd3d4099117f82a3f0cd5cfa89922e7bf80c8962fae85f76a51257f0e25862cd3ca1a7a418418c1aa53a349302dda0e79c840adb478b6c19cbee23e7c0aeb74118d1bfd6d578bd12c35a12f171f63b6ccfb885f66c7c7a4e4b453192fe516815222be9f9f9e4b63b38cafafcc3a5603a6ec0201b25c423b0a2fc4b37a125df56077e6508963ab0686c443f294886780a558a8677ba154e8fe805614e39405f29a52eacdbf4dc9a3628ada6847ece1c715a2a3cffed7d116c24aa1837a74c25b6320649703c5cd03bdfa982764a19103e4cf714a6831de1057edd6d86e832e97d7df31a163404d17cadf2971faa90bd9ab506ddae25188454e503615108a6856ee44cb30cce0a549ae14a26634dfc05b6e8004df7c3c08f29e0e17a48215a0c3cc0d6377c6e2996d4968439367f0f72f88633049c4d1f679694a8583fcda893f4f0a45765bb490027c49c29e0b7c3cde236de67613e8955b0e53f401f479b58248810fd0b979b1be967e8016458bb7b2d91a0b3c967d4a430e3c25d29ea050a4dd126454c5ad45b239842dc57af4046e40ca5ddeb35f5544f541d272b3c1b37521d9adaac9e77038fb22e4a5e6663ffc32414e4e7d1126b9eba22bbb23cd5a0565b410320665fb0f37c62e96746f6584554023d6994709368ce17a02c6da359dbd7df3671e46304f1fe017ac7794516309c55d355d337999135c03bd67bcf1c625fb5598ca50d9a66d5bb9f06d13b3428fb23f9aacf678b42d2d10687eacd8dd017ce7117851d74810068323adbf24bf6454ddfa62ad41f47452d015e84e4961d4ad6a0d42a569dd51611a973517ce82b33242d83a854babb5f7686a59bd2fcb02b413978c5155896c77e78fc1a130c8847c3aaca49315bf9d63f7ed6f84d4b1a8eaf68c29ba1a6191a4b992dcfaa12905d31297711f3f2c3bc97cff7bd053dadb820d6914054342ed95b5478ea6bbf4d332214106a08bfe1337aac9a9843dbe4f32a0a322521ea6dadd0d5245103083130eb39c7cf6577514344e0b25a8d76c644c11096f2b1377c72d716e539e03430448f8b78707bb4355a156e549c75cf39adc1c63cacff0979326dac276ba4ef864f31d32f2401e5eb8ab54beb20d05df7e3f0b46e600fccd1d8945063349347dcf179272c1119b2ea39b5c1a9bea9de435f485aa184ead3931b3782434eb7c458138cd8af675291fa522e07c96faa313f7bcd7144e700341d6ba5ef0ca6301270e1a3a4193dca0f6581f5e96e2d6cc10b910c15868a25f534e06ce5dd70459f8d2860323f14c1a72b713e5516441ca27189e680472d195488975609bfdf0f9b39697bfd87eedc009aea2a0b5ecc1a4b6d11c3e6c62574892d692aea92ecd9f34c344a9f9937bfb78c6859907dbb07a7e1251a957641f63081a8c9c180e12270fd00a24605d3ad2755ff8ee6c567c55e29c79fea1c0bd85a9233607c3b6621b6b45929c66af7818554d5e41696b07f258cfca06f4ee80b07bb25e8be44040b6fba088a298aec45b928cef7b1fbb30c8faa0cfeb745845389dd4979a35a3a4666fa52e6c15479e7dce7989c080adb807dc66807fa06a33cb4ba84bfbda7b9ffbea6e02ac8dfaba1c99dc471b158f3b6385a2852314c2c6eca71e1f08cfbc609417aa6e4aef2c261917503d4eeace5c13f0af334a308773c95b524e6eea10912a61c125a2fab399ba672b8f562ed6a7d7a824a731cde3e152f1c6e46615d59e36c18771ba272064e91a4e772373809c6ae5bda5a4854001a0eeaf6ad745631d9cf7b28122d9dd17074e27ecc3c7686fd910dc586f1cb2bb003a79c7e4b955ed25665eaf8bb7c2068693b86537e9bacdd111cf95231ee0aadfedee852a309b219f88a13a381da09c8a68dd8ae9de33127caf8bf1e61f604d737721884fc10bab0990bd16dadd93d8401b43f3ca130b9a67f9f4057334f6bfe4593993a39259d90b57cfc5ce18a862ecc4729b6c927cc8fca37da2bd46b5d37ac9a3896eb941d70b97e858277b7260c0e6e8eefbb844a5337351c9e15a11d81746c9c0c3c5a89c15db4b881e98697df6111ac0c96f1cb3d3a55917878e01dbe022452345402ac1d4b061ad23b759ef3d1882551e4d8011a4f75fac51d92e56284b8a86de1d1f228195d047cfd194cc3e0bbce60ffe468916cf00c58c9c36d5f844e3ee8fd9832e31fa77aa35986e83af2f83fbf2e2c494be6efef3a9f3672802c324ac04f2e2a4a6e55ad049fd32b99c937c3bb2c666a0b762bc00f9d635bd7bcb98c1a15d67218ac0599e17e36f47e18a88b8ad2fdfd6b567166e24071b3f648e6ba2a1774a01dfb63a58e40fc1ef05aaa0f11b170c8b27d19f5c11d9ce220f633f53e56c423a2cf9861680b50ff7067e002bd4c99870fa938960cc2c2379193b40df20ea1437a6b3d46c0a3fc76abbc0694843d6846856546fc6b2c8396991e477fe0eecb01d0fb27e5d4a2fa0cea9cd773fbc14a88d757af81eadada1e942dfea0f7072c1dc2e066ce32502997b8b5f87457589a47a012bfcc47b8253e8f165d8ffde7dad96f80632dac17c2b6d72dd66fe817332b405353d30779eb9388ef7a82c00ed9f361aee0ea1d2b4352d3cc19978783aa9ade835abc7039074bb1133e283c5787a7a595ed69d23ec722b1a041e133d9a04b230f80865c88a3c4d7936f3d612390789f7c4981cb910246c4a27cfadaccb5774393d2f068bef09411ec1c4f520b769ba8fcfc29d98f9e9cca263b65c4d769c3adb8ce9662d6464030740fb213bb1fcbc8cc9688c75d1d27918caaf9e1d4763d13867d80fc8da7ada1dc863c45ae56354bd35d8cf5adcb3bf649b67e2bbdd2a6c472da15807be475a1f6792e1206c16cd6b3fea2fbd21e3caa3a1ab13505f6e5d73663fc1fb56af14e3965f0ec31f6e099ce378209bb6404aec9b2ba2a0e55adb5b377d29a06053b769d1c135376dc63353d0882166bbb8e757e7b3c03a394afcec57dc8d6011a2c228e7af63c6ddc3ea4497a565d0f36855e27ac9abc4ef9787189d076f6b1a77124a13089656774eff0553fafa969a82eb9e97e0a762202b64da85d7fbcbeb6e5bc5214125e9058a258fe52ebae4843ca3306aff1e29aa703b530820ea54d99e5059e317a2cd6faa74eb14e8f79d83ef84b3cae861ee3d2a595fa627c5aa6198f0961d0fbbc2f850388b1b8482548e832151cebd2d55103c2d913be8447edc444b41d95c3c1f0e3d3a00f59db721f757faf034c9796746c327bfbabee4e3a5fec25a87082ab67c845903706725491ff5a1b71599972e12f9b66d39284589e0309a0557507708496649d3214b2775ca620db96651fe076355452a0c1a4b4011624bfc546fcf8439483a38c9311837a815bc6b8997910b757955990629abdb4e33bfdf027326584a0815c0dad2a1467fb6c389b06cde77441de56f2bdce7e83087db626f7548ed9f0d9e89cd00cc1f5a7aeff158c6488b408e46cb4cc1bddb00bae9e2dea07e9a5da15458a0f0550f2c736bbcc34b7291c2bb010e8e6b0975ad13b1e32d7abc2226d54c6355d80ae0126f62455e39a4b87ff66c0c1715233246068762303e4b7a2b86b524fae71df4dc0ba5399bf46b365cc37b050ee2acc2d13c67875393f8ff74f81fda18647d559d8d1a6fc659c0bd3ae2dcf04cfef33d0a07c9e63e4caf66ae0511bd14bb9278fbe26a552152730ece7f4e53698ff23c4745eebc90b7b57f9654a4f1d2fc3cef717d8d3bd89f9cfbe0ebf8351373d2a2e7fa444134ecbfe7075e0791eee945cedb1bf4510f3b2236f1b94a3ff2b9d3936504e0f3f13cc625fc99cdd3aea7752686912471f92ea4f033824977fba2b00302f9a0cacf9771aabdc229041c786dd956e44c6a6f74b79fbbbdaa9468fae894f525b51784ed4437606234daca26e36328742adfb5d9aef0d7f33c4767601ea637dd64e70bd9f9e24b4e047c1d4b7d86cbd493a7d18226423079a6461f586336ff87ff85a0554e0ab00bcc826eea3e8f4c0b5e52dfb125eb4cb8e7951f1f291342588c08cc2a6ace73bd73183b6e5f005676207b14de8ad8e8d07aeaffa0fd4a93544bdec12fdc9fab48452d8baa6adda8169a269ac8cff9d83c8e13732af3a216e372884579f4e36ad66d8fc660e86be77a5789aa7524fc63159b5065f65e81c0e8c8965392066475a6802cc77a99d94d44496ac57a1c9d2aca52058dd23c2b847ed1534f83604c5d22e33c4a10b9b8137fd7e37986030af3bb391e12b1e80de8facad422134c7e3e92b2d6ec76bacb7a47d9bc81359a85b536ee44756f209a158f57ab8edc2f6b3395620dd0c0c8eb5937a98298ed7be64e0f2d3e6c701e231d6db27cf9fc722b84f3d72a23d7db5a135531660fece6ce7451c1a498dea40e2f18a567c942bbaeded1dbf65695796ab61a1eb87c8111f6e144162f48de9a45b9685dea5227bb618a387a779971f4aca40492826597b906cb7a507854848c19f3c873d4ca33d85839f56da670425fd080a32e0ad96b37283063609bc5ee7ef9eb1b12880063d1ee99b5895e46767f8a47cbde694b5056dcc0a18afdf1b2de8aa6a8c1b8c26b02b8547a52f6c7d8af6c490e6aa1afcbfe0053f21683f566b5c440285a7ec81aa2f4bb6a5faa168bb114bc0820e9cba8ec8b944a1d2b6c25476ee2d084632defc8ff8c3d340afbb36725bb7c22e715268d8d55c6bf9a60c04df5b47b516c953ffcba0914fb6b00e886d4678890514c50c44ba913e534897923d597","dialect":"2020-12"}}],"content_hash":"gTQdcbfXvUEmBmZxwaOO","rubric_name":"kJSqnSIZKdBQiwZlatdw"},"judge":{"model":"0bb","api_base":"HgzyUjDSnqVJlYFWoKuC","temperature":0.11588350932581237,"timeout_seconds":1.671936433325527},"status":"yQCkTYRkqOddnksSHYxd","aggregates":[{"criterion_key":"EkyhVcPkSSkINgPxRExk","total":6371,"passed":4480,"failed":1479,"unevaluable":381,"not_evaluated":5822,"partial_context":8510}],"failure_reason":"KrynxTsleSVSNNvoVlDo","created_at":"2009-02-14T14:34:58.859671","completed_at":null}]]}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["aHqWLCdfvXYcRWcVrxax"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]},"post":{"tags":["Evaluations"],"summary":"Pin a rubric and judge before enqueueing a stored-answer reading.","operationId":"assessEvaluationRunRubric","parameters":[{"description":"Path parameters that identify a single run within a space.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Path parameters that identify a single run within a space.","name":"run_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RubricAssessmentRequest"}}},"description":"Choose an immutable rubric and a judge when its criteria need one.","required":true},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RubricAssessmentSummary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["HJZPfPtShtStGIEIMyVi"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/evaluations/{run_id}/rubric-assessments/{assessment_id}/results":{"summary":"Per-example rubric results with publication and completeness status.","get":{"tags":["Evaluations"],"summary":"Read stored verdicts without exposing protected rejected prose.","operationId":"listEvaluationRubricResults","parameters":[{"description":"Address an assessment beneath its run and space.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Address an assessment beneath its run and space.","name":"run_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Address an assessment beneath its run and space.","name":"assessment_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RubricJudgementSummary"},"type":"array","examples":[[{"position":9634,"publication_outcome":"IzUKNOtEDQKkzlrkOTYc","partial_context":true,"results":[{"criterion_key":"LAIOQvYetxCvfTKaLCwO","verdict":"fail","explanation":"ucHvdGzVwLKiDeVWeuUm","technical_reason":null,"requested_model":null,"effective_model":null,"latency_ms":null,"usage":null,"kind":"llm","reason_code":null,"error_path":"GITwJjkfvSGpYgoUVaJc","error_keyword":null}],"not_evaluated_reason":null}]]}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["VIBeULxqnElWISiQSpiX"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/graph/rebuild":{"summary":"Bring a space's knowledge graph into line with its configuration.","description":"What the owner wants of this is a graph that answers what their space asks,\nand how much work that takes is not theirs to know: usually a fresh pass\nover the whole corpus, and where the difference is only in what an entity's\nvector holds, embedding the entities that are already stored. Which it will\nbe is settled by the build itself, against the record the graph on disk\nleft of how it was made.\n\nAsking is configuring the space, like reconfiguring the pipeline: open to\nits owner and to a key only where it holds ``manage`` and its owner still\nowns the space (see ``ScopeLevel``). A caller with no standing on the space\nsees it as not-found, and one with standing but without that access a\nforbidden. A space with no graph -- one that neither names the graph\nretriever nor has an index from an earlier build -- is a conflict, since\nthere is nothing to bring into line. Otherwise the work is enqueued off the\nrequest and the response is 202 Accepted, after which a client polls the\ngraph status until it is built again; the space's config status reports\nthe build as on its way from this answer on. The graph status is also\nwhere the difference between the two kinds of run shows afterwards: a run\nthat read the corpus leaves the time of that read equal to the build time,\nand one that did not leaves the older stamp standing.","post":{"tags":["Graph"],"summary":"Authorize and guard the rebuild, which is what asks for it.","description":"The usecase authorizes the caller to configure the space, rejects a\nspace with no graph, notes on the space that a build waits, and\npublishes the work by space id. How much work\nit turns out to be is settled by the run itself against the record the\nstored graph left: a pass over the whole corpus, or -- where the only\nthing the configuration asks differently is what an entity's vector\nholds -- embedding the entities already stored, reading no document and\nprompting no model. Asking is part of the act rather than the next\nthing this controller does, so there is no window in which a request\nwas cleared and nobody asked for the work. The response is 202\nAccepted; the run tracks the graph representation's lifecycle as it\ngoes.","operationId":"rebuildGraph","parameters":[{"description":"Path parameter identifying the space a config operation targets.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GraphRebuildResult"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["OVmAaxZwLYbgyzGHCbxk"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/graph/status":{"summary":"Report a space's knowledge-graph freshness.","description":"Inspecting a space's jobs is open to every member and to a key only where it\nholds ``manage`` and its owner still owns the space (see ``ScopeLevel``);\nany other key is forbidden, and a caller with no standing is told the space\nwas not found, masking its existence, exactly as the space-detail read does.\nThe response reports the graph as absent (the space never built one),\nbuilding, stale or built, and beside that word it carries what the stored\ngraph can say about the settings asked of it now -- which is what tells a\ncorpus that moved on under a graph from a configuration that moved away from\nit. What those fields promise, and where they promise nothing, is written on\nthe response they belong to rather than restated here.","get":{"tags":["Graph"],"summary":"Return the graph freshness of a space the caller may inspect.","description":"A space the caller has no standing on is reported as not found, so its\nexistence is never revealed. A member is never forbidden here; a key is,\nunless it holds ``manage`` and its owner still owns the space.","operationId":"getGraphStatus","parameters":[{"description":"Path parameter identifying the space a config operation targets.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GraphStatus"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["legfTntQCgZeIKqUsXlT"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/group-members":{"summary":"The group sources of users' access to one space.","get":{"tags":["Members"],"summary":"List group-derived memberships for an owner of the space.","operationId":"listSpaceGroupMembers","parameters":[{"description":"Path parameter identifying the space a member collection belongs to.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_SpaceGroupMemberPayload_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["jUgGxsSUPJQnYqqTnxHO"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/spaces/{space_id}/members":{"summary":"A space's members as a collection: list them, or add one.","description":"Membership is the control plane, so every operation is bearer-only (an API\nkey never reaches member management). Listing only needs read access, which\nevery member has; adding a member needs owner-level access, so a member who\nis not an owner is forbidden and a non-member is told the space was not\nfound.","get":{"tags":["Members"],"summary":"List a page of the members of a space the caller belongs to.","description":"Any member may see the roster, so a member is never forbidden here; a\nnon-member is told the space was not found, masking its existence. Each\nmember is returned by their user public id, email and role; the ``page``\nand ``page_size`` parameters select the slice to return.","operationId":"listMembers","parameters":[{"description":"Path parameter identifying the space a member collection belongs to.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"description":"Reusable list query params (``page`` / ``page_size``).","name":"page_size","in":"query","schema":{"type":"integer","maximum":100,"minimum":1,"default":20}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paginated_MemberPayload_"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["aWKimFUQuaCLlgYjeLXc"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]},"post":{"tags":["Members"],"summary":"Add a member to the space by email, granting the requested role.","description":"Only an owner may add members: a non-member sees a not-found, a\nnon-owner member a forbidden.\n\nWhat the email matches decides the rest. An email with no account is\ninvited: a pending account is created and the response carries its\none-time invite token, the only time it is ever readable. An email\nwhose invitation has not been accepted yet is invited again -- a fresh\ntoken is issued and returned, and the previous one stops working, which\nis how an invite link that was lost or that expired is replaced. An\nemail with an active account is added directly, and is a conflict if\nthat account already holds a membership (change their role instead).\n\nBecause the answer can carry an invite token, every successful answer\ntells caches not to keep it, whether or not this one carries a token.","operationId":"addMember","parameters":[{"description":"Path parameter identifying the space a member collection belongs to.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberAddPayload"}}},"description":"Request body to add an existing user to a space as a member.\n\nThe user is named by ``email`` (looked up among existing accounts) and given\n``role`` on the space. ``role`` is one of the membership roles, validated by\nthe enum, so an unknown role is rejected before the usecase runs.","required":true},"responses":{"201":{"description":"Created","headers":{"Cache-Control":{"schema":{"type":"string","examples":["lMtsoYBsccSURsmpSuCi"]},"description":"Credentials must not be stored in any cache.","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddedMemberPayload"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["DhpGxmOMlgEgShsSRtMJ"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/spaces/{space_id}/members/{user_id}":{"summary":"One member of a space: change their role, or remove them.","description":"Both operations administer membership, so they need owner-level access and\nare bearer-only. A non-member is told the space was not found, a non-owner\nmember is forbidden, a targeted user who is not a member is a not-found, and\na write that would leave the space with no owner is a conflict.","delete":{"tags":["Members"],"summary":"Remove the targeted member from the space.","description":"Removing the space's only owner is refused (a space must keep at least\none owner), surfaced as a conflict; the rule applies to an owner\nremoving themselves too. Otherwise the membership is deleted.","operationId":"removeMember","parameters":[{"description":"Path parameters identifying one member of one space.\n\nBoth ids are public ids (UUIDs from the route): the space the membership is\non, and the user whose membership is targeted -- the internal int PKs are\nnever part of a URL.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Path parameters identifying one member of one space.\n\nBoth ids are public ids (UUIDs from the route): the space the membership is\non, and the user whose membership is targeted -- the internal int PKs are\nnever part of a URL.","name":"user_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"null","examples":[null]}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["hXndZblLBNpbfhUUfOer"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]},"patch":{"tags":["Members"],"summary":"Change the targeted member's role on the space.","description":"Demoting the space's only owner is refused (a space must keep at least\none owner), surfaced as a conflict; the rule applies to an owner\ndemoting themselves too. The updated membership view is returned.","operationId":"updateMember","parameters":[{"description":"Path parameters identifying one member of one space.\n\nBoth ids are public ids (UUIDs from the route): the space the membership is\non, and the user whose membership is targeted -- the internal int PKs are\nnever part of a URL.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Path parameters identifying one member of one space.\n\nBoth ids are public ids (UUIDs from the route): the space the membership is\non, and the user whose membership is targeted -- the internal int PKs are\nnever part of a URL.","name":"user_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberRolePayload"}}},"description":"Request body to change a member's role on a space.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MemberPayload"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["DXIDdoCjMItEDiazisOS"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/spaces/{space_id}/metadata-schema":{"summary":"Declare which metadata fields a space's documents are selected on.","description":"The declaration is the contract the whole corpus is held to -- every\ndocument carrying a declared field must give it the declared type -- and the\nschema a client draws its filter builder from. Redrawing it is therefore\nconfiguring the space, like changing the pipeline: a caller with no standing\nsees the space as not-found, one without the access to configure a\nforbidden, and a declaration that could not serve as a contract a\nbad-request.\n\nIt answers 202 Accepted rather than 200, because storing the declaration\nis not all of adopting it. What a search selects on is written beside each\nvector, so a field declared here is on no existing chunk and one withdrawn\nhere is on all of them; bringing the corpus into line is a walk of the\nwhole of it and is queued off the request. A declaration that changes\nnothing about what is written beside a vector -- a reordering, a field the\nspace does not select on -- queues nothing.","put":{"tags":["Metadata Schema"],"summary":"Replace what a space declares about its documents' metadata.","description":"The body is the whole declaration: the fields listed are the fields the\nspace declares, and one left out is withdrawn. A declaration is\nreplaced rather than patched because a filter builder reads the fields\nas a set, and a merge would leave no way to withdraw a field at all.\n\nA declaration that could not serve as a contract -- the same name twice,\nmore fields than a space may declare -- is refused before anything is\nstored. Documents already in the space are left untouched: each was\nchecked against what was declared when it was written, and re-checking\nthe corpus here would refuse an edit because of something somebody\nuploaded a year ago. From here on, a document carrying a declared field\nmust give it the declared type; one carrying anything else is stored as\nsent and simply cannot be selected on. The stored declaration is echoed\nback.\n\nWhat the corpus already carries is brought into line afterwards, off\nthe request: every document's stamp is written again from what it says\nabout itself and what is now declared, so a field declared here becomes\nselectable and one withdrawn here stops answering filters. The work is\nqueued only when the declaration actually changed what a chunk carries.\nA second call while a walk is still running is not folded into it:\nboth take the space's rebuild claim, so the later walk waits its turn\nrather than standing down, and goes over the corpus a second time.\nStoring the declaration is what asks for the walk, and the ask goes out\non that write's commit, so nothing here can store a contract the corpus\nis never brought to.","operationId":"configureMetadataSchema","parameters":[{"description":"Path parameter identifying the space a config operation targets.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataSchema"}}},"description":"Everything a space declares about its documents' metadata.\n\nAn envelope around the list rather than a bare list: it is read as a whole\n(a filter builder draws every field from one place) and written as a whole\n(a declaration is replaced, never patched field by field), and a named\nobject leaves room for what a corpus may later say about its fields as a\nset rather than one at a time. A space that has declared nothing carries an\nempty one, which is what every space starts as.","required":true},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MetadataSchema"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["RacodahQZWkzQIGYBiuE"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/queries/{query_id}/feedback":{"summary":"A rating of one answer, by the person who asked for it.","put":{"tags":["Retrieval"],"summary":"Rate the answer to a question, up or down, with an optional note.","description":"The question is named by the ``query_id`` its answer came back with.\nIt is filed just after its answer goes out, so a rating sent at once\nmay arrive first; it then waits for the question, for as long as the\ninstallation allows, rather than being refused. Only the\nperson it was asked for may rate it -- through their session or\nthrough one of their keys; anyone else is told it was not found. A\nlater rating replaces an earlier one, and a reason is kept with a down\nrating only.","operationId":"rateQuery","parameters":[{"description":"One logged question of a space.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"One logged question of a space.","name":"query_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryFeedbackPayload"}}},"description":"A rating of one answer, by the person who asked for it.","required":true},"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"null","examples":[null]}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["uIaLZIrNKZdEGsovpJwh"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/query":{"summary":"Query endpoints for retrieving and generating answers from a space.","post":{"tags":["Retrieval"],"summary":"Retrieve the most relevant chunks and generate a grounded answer.","description":"Only a member of the space may query it: a non-member is told the space\nwas not found. Querying only needs read access, which every membership\nrole grants, so a member is never forbidden -- no 403 arises here.\nGenerating an answer needs a model, so a space that configured no LLM is\nanswered with a 409 (its retrieval still works through search).\n\nA request that narrows the search settles its filter before any of that\nruns: a filter breaking the bounds, or naming something the space was\nnever declared to be selectable by, is a 400, and one asked of a space\nwhose way of answering could not honour it -- a graph of agents, an\nanswer written over the whole knowledge graph -- is a 409 rather than a\nsearch quietly made around it.","operationId":"querySpace","parameters":[{"description":"Path parameters that identify the space a document belongs to.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRequestPayload"}}},"description":"A natural-language question asked against a space's documents.\n\nA filter is part of the request rather than something applied to what came\nback: it decides which documents are searched at all, so the depth asked\nfor is the depth returned out of the narrowed part of the corpus. Sifting a\nfinished ranking instead would answer a question of ten passages with\nhowever few of those ten happened to qualify.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryAnswerPayload"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["XORwtDWnALUSgUszUUEY"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/query/stream":{"summary":"Stream a space query's answer to the client token by token.","post":{"tags":["Retrieval"],"summary":"Retrieve the relevant chunks and stream a grounded answer.","description":"The stream carries a ``stage`` event as each read stage begins -- the\nstage's id, label key, icon and lifecycle phase -- and a ``token``\nevent for each fragment of prose as the model generates it, and closes\non exactly one ``done`` event carrying the finished answer and the\nchunks it was grounded in. A space answering through a graph of agents\nannounces its stages the same way and streams no fragments at all: a\nreply there is only classifiable once it is whole, so its answer\narrives in the ``done`` event alone. Should the answer fail after the\nstream has opened, an ``error`` event carrying the reason replaces the\n``done`` event and closes the stream.\n\nOnly a member of the space may stream it: a non-member is told the space\nwas not found. Streaming needs only read access, which every membership\nrole grants, so a member is never forbidden. Generating an answer needs\na model, so a space that configured no LLM is refused with a 409 before\nthe stream opens (its retrieval still works through search) -- the\nclient never opens an empty event stream. A filter that breaks the\nbounds or names something the space cannot be selected by is refused\nthe same way, with a 400, and one the space's way of answering could\nnot honour with a 409.","operationId":"querySpaceStream","parameters":[{"description":"Path parameters that identify the space a document belongs to.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRequestPayload"}}},"description":"A natural-language question asked against a space's documents.\n\nA filter is part of the request rather than something applied to what came\nback: it decides which documents are searched at all, so the depth asked\nfor is the depth returned out of the narrowed part of the corpus. Sifting a\nfinished ranking instead would answer a question of ten passages with\nhowever few of those ten happened to qualify.","required":true},"responses":{"200":{"description":"OK","headers":{"Cache-Control":{"schema":{"type":"string","examples":["HUcInQGktGDcxxAlZoFo"]},"required":true},"Connection":{"schema":{"type":"string","examples":["YztLnYaNRMMbtBhFffyV"]},"required":true},"X-Accel-Buffering":{"schema":{"type":"string","examples":["YlqNSkOABTbhrNuhINJm"]},"required":true}},"content":{"text/event-stream":{"schema":{"$ref":"#/components/schemas/SSEvent_QueryStreamEvent_"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}},"text/event-stream":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["zZDlruJRrsIWnZhlVGLm"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}},"text/event-stream":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}},"text/event-stream":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}},"text/event-stream":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}},"text/event-stream":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/rubric-versions/{version_id}":{"summary":"Read a rubric version explicitly shared with an authorized Space.","get":{"tags":["Rubrics"],"summary":"Read a version currently bound to a Space the caller can view.","description":"An archived or older version remains readable while bound. Unbound\nversions are reported missing, without granting access to their owner's\nlibrary. Historical query traces carry their own criterion snapshots.","operationId":"getSpaceRubricVersion","parameters":[{"description":"Address a version shared by an explicit Space configuration binding.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true},{"description":"Address a version shared by an explicit Space configuration binding.","name":"version_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RubricVersion"}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["wWLOzuHtRCZBenfMeYYG"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/spaces/{space_id}/search":{"summary":"Search endpoints returning a space's ranked chunks, without an answer.","post":{"tags":["Retrieval"],"summary":"Retrieve and rank the most relevant chunks, without generating.","description":"Only a member of the space may search it: a non-member is told the space\nwas not found. Searching only needs read access, which every membership\nrole grants, so a member is never forbidden -- no 403 arises here.\nPlain retrieval needs no LLM, but a read path that names an LLM step\n(HyDE, the LLM-judge reranker) does; a space that named one with no LLM\nconfigured is answered with a 409.\n\nA request that narrows the search settles its filter first: a filter\nbreaking the bounds, or naming something the space was never declared\nto be selectable by, is a 400, and one its retrieval legs could not\nhonour is a 409 rather than a search quietly made around it.","operationId":"searchSpace","parameters":[{"description":"Path parameters that identify the space a document belongs to.","name":"space_id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrievalRequestPayload"}}},"description":"Retrieve with an optional request-local reciprocal-rank constant.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveResultPayload"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["WlElQHKFpSttTFkaxkbn"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"502":{"description":"Bad Gateway","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]},{"apiKey":[]}]}},"/api/v1/vector-backends":{"summary":"The caller's storage backends as a collection: register one, or list.","description":"Protected by the bearer auth only: a backend carries the credential that\nreaches an external instance, so registering and reconfiguring one is done\nfrom an interactive session rather than by a space-scoped API key. Every\noperation is scoped to the authenticated caller.","get":{"tags":["Vector Backends"],"summary":"List the storage backends this caller may bind a space to.","description":"The caller's own registrations and the ones the installation seeded and\nshares with everybody -- never another account's. Each entry carries\nthe fields a client needs to offer the choice: its public id, which\nstorage technology serves it, whether the platform provisions storage\nper space or it points at an existing one, where that existing one is,\nwhether the caller may change the row, and the retrieval methods it can\nserve -- so a client can rule out a leg the chosen backend could never\nbuild rather than have the pipeline refused when it is saved. It never\ncarries a backend's connection: the location of an external instance\nand the key that reaches it stay inside the platform.","operationId":"listVectorBackends","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SelectableVectorBackend"},"type":"array","examples":[[{"id":"WoTpZLZtKRGKdVTbIduH","kind":"nyZIQaVOHPbwmXJsSpIn","mode":"oIhiyGpuVgEgXdmCFqOF","supported_retrievers":["EVblshdAmknSHBrDkNkB"],"missing_fields":["eYJgKJOYRnFfmbLFVbyj"],"lost_without_document":["IHJvxxgfcScFhsUerWHe"],"storage":"ogznNhgwwENenUDJmbKv","owned":true,"field_mapping":{"IcbnRsvTAyRGLJPeGFte":"prKaTbaDCdCJmMHcCALF"},"access_level":"XLbuuIPcPJXwEkwagIEz"}]]}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["fbUfbhCCQQetHBKpruKD"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]},"post":{"tags":["Vector Backends"],"summary":"Register a storage backend of the caller's own, once it works.","description":"The body names the storage technology, whether the platform provisions\nstorage per space or the row points at an existing table or collection,\nand how to reach the instance. Nothing is stored until the proposal has\npassed: this installation must have an engine for the technology, the\nmode and the storage name must say the same thing, the connection must\nbe one that technology accepts -- and the instance itself must answer,\nbe able to hold vectors, and, where the row points at an existing table\nor collection, actually hold one under the name given. A wrong address,\na rejected key, a Postgres with no vector extension or a name nothing\non the instance answers to is refused here, with a message saying which\nof those it was.\n\nThe owner is always the authenticated caller. The response is the same\nsafe view the listing serves: the connection just accepted never comes\nback out of the platform.","operationId":"registerVectorBackend","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorBackendPayload"}}},"description":"A storage backend as a caller asks for it to be registered or replaced.\n\nThe whole row, every time. Reconfiguring one is a replacement rather than a\npatch, and deliberately so: a patch would have to tell \"the field was not\nsent\" from \"the field was cleared\", and on a connection carrying a\ncredential that ambiguity ends with an operator believing they rotated a key\nthat is in fact still the old one. Sending the connection whole means the\nstored connection is always exactly the one the caller last read out of\ntheir own configuration.\n\n``connection`` is free-form here and read through the struct the chosen\n``kind`` declares, since what a key means is that storage technology's to\nsay. It never comes back out: no response this platform serves carries a\nbackend's connection.","required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectableVectorBackend"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["vHOaXffjvZnJnjRGQAiy"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/vector-backends/catalog":{"summary":"What each storage technology has to be told to be reached.","description":"Global metadata about the platform rather than about any one row, and served\nto signed-in callers only -- the same rule the pipeline catalogue follows.\nNothing reads it before a session exists: it is the registration form's\nvocabulary, and that form is behind a sign-in.","get":{"tags":["Vector Backends"],"summary":"Return each served technology's connection keys and their types.","description":"The response maps a storage technology to the JSON Schema of the\nconnection a backend of that technology is registered with: what\nregistering a backend of it means, which keys it admits, what each of\nthem holds, what each is called and what filling it in means, which of\nthem take one of a closed set of values, and which of them are\ncredentials to be entered as such and never echoed. A form is built\nfrom this rather than from a list written out again on the client, so a\nkey added to a technology is offered -- labelled, and with its\nguidance -- without a client change, and a technology added to the\nplatform is offered at all.","operationId":"getVectorBackendCatalog","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"additionalProperties":{"$ref":"#/components/schemas/CatalogConnection"},"type":"object","examples":[{"rHcdItppldGgzooREGAj":{"params_schema":{"pLaRuruguxLncDkyCmRD":"65"}}}]}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["YVTQTghbARQNBGFlRTfs"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}},"/api/v1/vector-backends/{id}":{"summary":"One of the caller's storage backends: replace it, or remove it.","description":"Protected by the bearer auth only, for the same reason its collection is: a\nrow carries the credential reaching an external instance. Scoped to the\nauthenticated caller -- a row belonging to another account is reported as\nnot found, so ids cannot be enumerated by probing, while a row the\ninstallation seeded is visible in the caller's own listing and is therefore\nrefused as not theirs rather than hidden.","put":{"tags":["Vector Backends"],"summary":"Replace one of the caller's backends, whole, and re-prove it.","description":"The body is the entire row, not the parts of it that changed. Accepting\na partial one would mean telling \"this field was not sent\" from \"this\nfield was cleared\", and on a connection holding a credential that is\nthe difference between a key the operator believes they rotated and the\none that is still there.\n\nBecause the connection may have changed, the instance is exercised\nagain before the change is kept: a row pointed somewhere unreachable is\nrefused and the stored row is left exactly as it was. A row belonging\nto another account answers 404; one the installation owns answers 403.","operationId":"reconfigureVectorBackend","parameters":[{"description":"Path parameters that identify a single registered storage backend.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VectorBackendPayload"}}},"description":"A storage backend as a caller asks for it to be registered or replaced.\n\nThe whole row, every time. Reconfiguring one is a replacement rather than a\npatch, and deliberately so: a patch would have to tell \"the field was not\nsent\" from \"the field was cleared\", and on a connection carrying a\ncredential that ambiguity ends with an operator believing they rotated a key\nthat is in fact still the old one. Sending the connection whole means the\nstored connection is always exactly the one the caller last read out of\ntheir own configuration.\n\n``connection`` is free-form here and read through the struct the chosen\n``kind`` declares, since what a key means is that storage technology's to\nsay. It never comes back out: no response this platform serves carries a\nbackend's connection.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SelectableVectorBackend"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["snPOsKaWsyuYWMJweDWw"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]},"delete":{"tags":["Vector Backends"],"summary":"Remove one of the caller's backends, unless a space still holds it.","description":"A backend still holding a space's vectors cannot go, and the refusal\nnames the spaces standing in the way rather than reporting a database\nconstraint -- so the answer says what to rebind or delete first. A row\nbelonging to another account answers 404; one the installation owns\nanswers 403.","operationId":"deleteVectorBackend","parameters":[{"description":"Path parameters that identify a single registered storage backend.","name":"id","in":"path","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"null","examples":[null]}}}},"400":{"description":"Raised when request components cannot be parsed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"401":{"description":"Raised when auth was not successful","headers":{"WWW-Authenticate":{"schema":{"type":"string","examples":["efxROAAUfIjPnFFwKpVX"]},"description":"Challenges that the client can use to authenticate this request","required":true}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"406":{"description":"Raised when provided `Accept` header cannot be satisfied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}},"503":{"description":"The request could not be served in time and may be retried.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefusalBody"}}}}},"security":[{"jwt":[]}]}}},"components":{"schemas":{"AcceptInvitePayload":{"properties":{"password":{"type":"string"},"token":{"type":"string"}},"type":"object","required":["password","token"],"title":"AcceptInvitePayload","description":"Accept-invite request body: the presented token and chosen password."},"AccessGroupPayload":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"kind":{"$ref":"#/components/schemas/GroupKind"}},"type":"object","required":["id","name","kind"],"title":"AccessGroupPayload","description":"An access group and the source of its members."},"AccessTokenResponse":{"properties":{"access_token":{"type":"string"}},"type":"object","required":["access_token"],"title":"AccessTokenResponse","description":"Access token returned to the client process after authentication."},"AddedMemberPayload":{"properties":{"id":{"type":"string"},"email":{"type":"string"},"role":{"$ref":"#/components/schemas/SpaceRole"},"invite_token":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},"type":"object","required":["id","email","role"],"title":"AddedMemberPayload","description":"The member just added, plus the invite link if one was issued.\n\nReturned only by the add-member request, which is the one moment an invite\ntoken exists in the clear -- it is hashed on the way into storage and can\nnever be read back, so this response is the single chance to pass it on\n(mirroring how a freshly minted API key shows its raw secret once).\n\n``invite_token`` carries that link whenever the request produced one: for an\nemail with no account at all (a pending account was created for it) and for\nan email whose invitation is still unaccepted (its token was re-issued,\nwhich is how a lost or expired link is recovered). Adding someone who\nalready has a working account issues nothing, so it stays unset."},"AgentEdgeSpec":{"properties":{"source":{"type":"string"},"target":{"type":"string"}},"type":"object","required":["source","target"],"title":"AgentEdgeSpec","description":"A directed edge feeding one agent's output into another's input.\n\n``source`` and ``target`` are node ids: the edge runs from the source agent\nto the target agent. (The fields are ``source``/``target`` rather than\n``from``/``to`` because ``from`` is a Python keyword.)"},"AgentGraphConfig":{"properties":{"nodes":{"items":{"$ref":"#/components/schemas/AgentNodeSpec"},"type":"array"},"edges":{"items":{"$ref":"#/components/schemas/AgentEdgeSpec"},"type":"array","default":[]},"coverage":{"anyOf":[{"$ref":"#/components/schemas/CoverageSettings"},{"type":"null"}],"default":null}},"type":"object","required":["nodes"],"title":"AgentGraphConfig","description":"Framework-free description of a whole graph of agents.\n\nThe ``nodes`` are the agents and the ``edges`` are the directed links along\nwhich their outputs flow. ``edges`` defaults to empty: a single-node graph\nhas nothing to connect, and that lone agent is both the entry and the final\nanswer. A graph with more than one node lists the edges that wire them into\na directed acyclic graph entered at a source and converging on one sink."},"AgentNodeSpec":{"properties":{"id":{"type":"string"},"prompt":{"type":"string"},"tools":{"items":{"type":"string"},"type":"array","default":[]},"max_tool_calls":{"anyOf":[{"type":"integer","maximum":20,"minimum":1},{"type":"null"}],"default":null},"tool_settings":{"additionalProperties":{"type":"object"},"type":"object","default":{}},"checks":{"type":"boolean","default":false}},"type":"object","required":["id","prompt"],"title":"AgentNodeSpec","description":"One agent in the graph: its id, its prompt, and the tools it may call.\n\nThe ``id`` is unique within the graph and is what edges reference. The\n``prompt`` is the agent's standing instruction. ``tools`` names the tools\nthis agent may call, looked up in the tool registry the validator checks\nagainst; it defaults to empty because a node with no tools is a valid\npure-reasoning agent -- a synthesis or validation step that works only over\nthe inputs its incoming edges feed it.\n\n``max_tool_calls`` is how many tool calls this agent may make before it has\nto answer from what they returned -- every call counts, whichever of its\ntools it goes to; left out, the platform's own budget applies.\n``tool_settings`` says how each of the agent's tools is offered to it, keyed\nby tool name; a tool left out of it is offered with its defaults, and\nsettings for a tool the agent does not name are refused. ``checks`` marks\nthe final agent as one that checks the answers it is handed rather than\nwriting one: short of asking for a revision, whatever it replies lets those\nanswers through unchanged. Only the final agent may be marked so, since\nonly its request for a revision is acted on, and it needs at least one\nagent feeding it."},"AgentStepTrace":{"properties":{"agent":{"type":"string"},"attempt":{"type":"integer"},"calls":{"items":{"$ref":"#/components/schemas/AgentToolCallTrace"},"type":"array"},"reply":{"type":"string"},"coverage":{"items":{"$ref":"#/components/schemas/CoverageTrace"},"type":"array","default":[]}},"type":"object","required":["agent","attempt","calls","reply"],"title":"AgentStepTrace","description":"One agent's run within one pass of the graph.\n\n``reply`` is the agent's own text as it came back from the model, before\nthe graph reads it: a checking agent's accept, a revision request, or an\nanswer with whatever the model wrote into it. The answer the caller gets\nis read off the final agent's reply and may differ from it; the reply is\nkept as written because the difference is sometimes the thing to see."},"AgentToolCallTrace":{"properties":{"tool":{"type":"string"},"arguments":{"type":"object"},"passage_count":{"type":"integer"},"refusal":{"anyOf":[{"type":"string"},{"type":"null"}]}},"type":"object","required":["tool","arguments","passage_count","refusal"],"title":"AgentToolCallTrace","description":"One tool call an agent made, with what it ran with and what came of it.\n\nA call that ran carries the arguments as the tool itself read them: the\nmodel's own, and for each it left out, what the tool used in its place --\nso a search reads with its query, its depth and its mode even where the\nmodel named only the query, and reads its mode as the space's own pipeline\nwhere the agent is offered no other. A call that did not run -- an argument\nthe schema forbids, a tool the agent does not have, a tool that turned the\ncall down -- carries the arguments as the model wrote them, since nothing\nread them, no passages, and the words the model was shown in their place."},"AgentTrace":{"properties":{"steps":{"items":{"$ref":"#/components/schemas/AgentStepTrace"},"type":"array"}},"type":"object","required":["steps"],"title":"AgentTrace","description":"Every agent run of one question, in the order they ran."},"AnalyticsSettings":{"properties":{"store_query_texts":{"type":"boolean"}},"type":"object","required":["store_query_texts"],"title":"AnalyticsSettings","description":"What the space's query log keeps, as its owners set it."},"AnswerAssessmentRequest":{"properties":{"judge_model":{"type":"string","maxLength":255,"minLength":1,"examples":["openai/gpt-4o","openai/gpt-4o-mini","anthropic/claude-3-5-sonnet","anthropic/claude-3-5-haiku","ollama/llama3","ollama/qwen2.5","openai/gigachat","openai/yandexgpt"]}},"additionalProperties":false,"type":"object","required":["judge_model"],"title":"AnswerAssessmentRequest","description":"The body that asks for a run's stored answers to be read again.\n\nOne field, because one is all that changes. A reading answers nothing and\nretrieves nothing: it takes the questions, the answers and the grounding\nexactly as the run recorded them, so what it can differ in is the judge.\n\nThe model is required rather than falling back to the one the scored space\nanswers with. A reading that named none would be asking for whatever that\nspace's configuration says today -- which nothing freezes, and which may\nwell be the model that wrote the answers, so the reading would be the model\ngrading itself. Naming it is also the whole point: a run's own judge is\nalready on the record, and this exists to put a different one beside it."},"AnswerAssessmentState":{"enum":["done","failed","pending","running"],"title":"AnswerAssessmentState","description":"Where one reading of a run's stored answers stands.\n\n``pending`` once asked for, ``running`` while a worker puts the answers\nthrough the judge, then ``done`` or ``failed``. Spelled like a run's states\nand kept apart from them for the reason the two status columns are sized\napart: they are separate lifecycles. The stored column keeps its own\nmatching vocabulary on the model, and a completeness test binds the two."},"AnswerAssessmentSummary":{"properties":{"id":{"type":"string"},"run_id":{"type":"string"},"judge_model":{"type":"string"},"status":{"$ref":"#/components/schemas/AnswerAssessmentState"},"failure_reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"score":{"anyOf":[{"$ref":"#/components/schemas/AnswerQualityScore"},{"type":"null"}]},"partial_context_count":{"anyOf":[{"type":"integer"},{"type":"null"}]},"rejected_correctness_count":{"anyOf":[{"type":"integer"},{"type":"null"}]},"created_at":{"type":"string"},"started_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"completed_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"type":"object","required":["id","run_id","judge_model","status","failure_reason","score","partial_context_count","rejected_correctness_count","created_at","started_at","completed_at"],"title":"AnswerAssessmentSummary","description":"A view of one reading: who judged, how it went, what it arrived at.\n\nThe run's own judging is a reading like any other and appears here as one,\nwhich is what makes the two comparable at all: both fold their averages out\nof the verdicts they themselves wrote, and neither is the special case the\nother is measured against."},"AnswerComparison":{"properties":{"pairing":{"$ref":"#/components/schemas/AnswerPairing"},"figures":{"anyOf":[{"$ref":"#/components/schemas/PairedAnswers"},{"type":"null"}]}},"type":"object","required":["pairing","figures"],"title":"AnswerComparison","description":"Whether two runs' answers could be compared, and what came of it."},"AnswerCost":{"properties":{"median_usd":{"anyOf":[{"type":"number"},{"type":"null"}]},"p95_usd":{"anyOf":[{"type":"number"},{"type":"null"}]},"priced":{"type":"integer"}},"type":"object","required":["median_usd","p95_usd","priced"],"title":"AnswerCost","description":"What one question cost, over the questions every call of was priced.\n\nA question with any unpriced call is left out rather than counted at\nwhat its priced part came to, which would understate it; ``priced`` says\nhow many were counted. Read from rows, so it covers the part of the period\nthe log holds."},"AnswerJudgement":{"properties":{"assessment_id":{"type":"string"},"judge_model":{"type":"string"},"faithfulness":{"anyOf":[{"type":"number"},{"type":"null"}]},"relevancy":{"anyOf":[{"type":"number"},{"type":"null"}]},"correctness":{"anyOf":[{"type":"number"},{"type":"null"}]},"judged_at":{"type":"string"}},"type":"object","required":["assessment_id","judge_model","faithfulness","relevancy","correctness","judged_at"],"title":"AnswerJudgement","description":"One verdict on one stored answer, as a reader gets it back.\n\nIt names its own judge because a stored answer may be read by more than one\nof them, and an answer-quality number that cannot be attributed to a model\nsays nothing: the judge moves those numbers as surely as the pipeline does.\n\nIt names the reading it was made in as well, because the model alone does\nnot tell two of them apart when the same model read the answers twice. That\nid is also what lines this verdict up with the averages of the reading it\nbelongs to, and with how much of what that reading judged had been cut down\n-- neither of which is a property of any single verdict."},"AnswerMetric":{"enum":["correctness","faithfulness","relevancy"],"title":"AnswerMetric","description":"An answer-quality metric a question carries a verdict of in a run.\n\nThe members are the verdicts a reading writes for every answer it judges,\nnamed as that verdict names them, so a member reads its value off the\nverdict by its own name."},"AnswerPairing":{"enum":["answers_not_stored","compared","not_scored","scored_before_empty_answer_rule"],"title":"AnswerPairing","description":"Whether two runs' answers were paired question by question, or why not.\n\n``compared``: they were. ``not_scored``: a run scored no answer quality.\n``answers_not_stored``: a run scored answer quality before runs kept their\nanswers. ``scored_before_empty_answer_rule``: a run was judged before\nempty answers were scored as failures. Why each of the last three leaves\nnothing to pair is set out in\n:mod:`server.apps.main.logic.query_comparison.answers`."},"AnswerQualityScore":{"properties":{"faithfulness":{"anyOf":[{"type":"number"},{"type":"null"}]},"relevancy":{"anyOf":[{"type":"number"},{"type":"null"}]},"correctness":{"anyOf":[{"type":"number"},{"type":"null"}]},"answered_count":{"type":"integer"},"reference_count":{"type":"integer"},"faithfulness_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null},"relevancy_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null},"empty_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null}},"type":"object","required":["faithfulness","relevancy","correctness","answered_count","reference_count"],"title":"AnswerQualityScore","description":"The answer-quality metrics averaged over a dataset's scored queries.\n\nEach metric is the mean of its per-query verdicts, or ``None`` when no query\ncontributed one. Faithfulness and relevancy are scored for every query that\nproduced an answer; correctness only for the queries that carry a\nreference answer, so a dataset with no reference answers reports\n``correctness`` as ``None`` while still reporting the other two. All three\nare taken only where a verdict came back at all, which is why each mean has\na count of its own beside it: a mean covering fewer queries than were asked\nabout is not comparable with one that covered them all, and without the\ncount the two look identical.\n\nThose counts are what lets a caller tell a genuine zero from an empty\naverage. For faithfulness and relevancy, scored for every query answered,\n``answered_count`` less the mean's own count is how many verdicts went\nmissing. Correctness has no such denominator here: the queries it was asked\nabout are the ones that carried a reference answer, which nothing in this\nshape says, so ``answered_count`` less ``reference_count`` counts the\nunreferenced queries along with the lost verdicts. How many of its verdicts\nwere asked for and not obtained is therefore the reading's own claim about\nits work, and sits beside this rather than in it.\n\nEmpty answers are in the means as failures scored without a judge, and\n``empty_count`` says how many there were."},"ApiKeyCreatePayload":{"properties":{"name":{"type":"string","maxLength":100,"default":""},"scopes":{"items":{"$ref":"#/components/schemas/ApiKeyScopeRequest"},"type":"array","default":[]},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"purpose":{"default":"generic","$ref":"#/components/schemas/ApiKeyPurpose"}},"type":"object","title":"ApiKeyCreatePayload","description":"Request body to mint a new API key.\n\nThe owner is never in the body -- a key always belongs to the authenticated\ncaller. An optional human label tells the owner's keys apart, and an\noptional list of per-space ``scopes`` gives the key least-privilege access\n(a key with no scopes reaches nothing until it is re-issued with some).\n\n``purpose`` says where the key is going to live, and that tightens the rules\nit is issued under: a key destined for somebody else's agent host must name\nat least one space to reach, because such a key is copied into a config file\nthe platform can never reach again."},"ApiKeyPurpose":{"enum":["generic","mcp"],"title":"ApiKeyPurpose","description":"What a key was minted for, which decides how strictly it is issued.\n\nA ``generic`` key is the server-to-server credential a backend of the\nowner's own holds: it may be minted unscoped and open-ended, because the\nprocess holding it is the owner's to trust. An ``mcp`` key is handed to an\nagent host somebody else runs -- it ends up in that host's config file, and\nso in git, backups and screenshots -- which is why minting one demands an\nexplicit knowledge base and level up front rather than defaulting to the\nowner's whole reach."},"ApiKeyScopeRequest":{"properties":{"space":{"type":"string","format":"uuid"},"level":{"default":"read","$ref":"#/components/schemas/ScopeLevel"}},"type":"object","required":["space"],"title":"ApiKeyScopeRequest","description":"One per-space grant in a key-creation request: a space and a level.\n\nThe space is named by its ``public_id`` (a UUID); ``level`` is one of the\nscope levels (``read`` / ``write`` / ``manage``), validated by the enum so\nan unknown level is rejected before the usecase runs. The creator must\nalready be allowed what the level opens on the space -- ``manage`` takes the\nspace's owner -- or the request is refused, and so is a level stronger than\nthe key's ``purpose`` allows.\n\nThe level defaults to ``read``: a grant whose level was not thought about is\nthe least one, so forgetting the field can never hand out more access than\nintended."},"ApiKeyScopeSummary":{"properties":{"space":{"type":"string"},"level":{"$ref":"#/components/schemas/ScopeLevel"}},"type":"object","required":["space","level"],"title":"ApiKeyScopeSummary","description":"A safe view of one granted scope: the space's public id and the level."},"ApiKeySummary":{"properties":{"id":{"type":"string"},"prefix":{"type":"string"},"name":{"type":"string"},"scopes":{"items":{"$ref":"#/components/schemas/ApiKeyScopeSummary"},"type":"array"},"created_at":{"type":"string"},"last_used_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"standing":{"$ref":"#/components/schemas/CredentialStanding"},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"purpose":{"$ref":"#/components/schemas/ApiKeyPurpose"}},"type":"object","required":["id","prefix","name","scopes","created_at","last_used_at","standing","expires_at","purpose"],"title":"ApiKeySummary","description":"A safe view of a key for listing -- never the secret or its hash.\n\nExposes the public id (the key's ``public_id`` UUID as a string), the\nlookup prefix, the label, the per-space scopes it carries, what it was\nminted for, when it was created, when it expires, when it was last used and\nwhere it stands. Enough to manage keys without ever revealing a credential."},"AppendedRowsQuestion":{"properties":{"storage":{"type":"string"},"rows":{"anyOf":[{"type":"integer"},{"type":"null"}]},"proposed":{"enum":["keep","purge"]}},"type":"object","required":["storage","rows","proposed"],"title":"AppendedRowsQuestion","description":"What tearing down an attached space would leave, and what to do with it.\n\nShaped so a screen puts it in front of somebody unchanged: a table name\nthey recognise, a count they can weigh, and an answer already selected\nthat they may change. Nothing here has to be decoded to be shown."},"ArchiveImportItem":{"properties":{"path":{"type":"string"},"status":{"enum":["accepted","failed","skipped"]},"document_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"operation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]}},"type":"object","required":["path","status","document_id","operation_id","reason"],"title":"ArchiveImportItem","description":"Admission state for the archive or one of its files."},"ArchiveImportResult":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ArchiveImportItem"},"type":"array"}},"type":"object","required":["items"],"title":"ArchiveImportResult","description":"File results in archive order."},"AttachedStoragePreview":{"properties":{"storage":{"type":"string"},"confirmed":{"type":"boolean"},"rows":{"anyOf":[{"items":{"$ref":"#/components/schemas/StoredRowPreview"},"type":"array"},{"type":"null"}]}},"type":"object","required":["storage","confirmed","rows"],"title":"AttachedStoragePreview","description":"What was read out of a space's attached storage, and whether it is owned.\n\nOne value serves both directions of the same conversation: the refusal\nthat stops the first write until somebody has looked, and the answer to\ntheir having looked and said yes. They carry the same rows for the same\nreason -- what is being confirmed is what was read -- and differ only in\n``confirmed``, so a screen renders one component either way."},"BranchExecution":{"properties":{"branch_id":{"type":"string"},"status":{"enum":["failed","skipped","success"]},"queries":{"items":{"type":"string"},"type":"array"},"hit_count":{"type":"integer","default":0},"error_type":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},"type":"object","required":["branch_id","status","queries"],"title":"BranchExecution","description":"Queries and outcome from one configured search branch."},"BudgetUnit":{"enum":["embedder_tokens","splitter_tokens"],"title":"BudgetUnit","description":"What a chunker counts when it fills a fragment to its budget.\n\nA budget is a number of tokens, and a token is whatever the counter that\nspends it says it is -- the same text costs a different number of them\nunder each, and a different number in each script under any one of them.\nSo a budget read without its unit says nothing about how much text it\nbuys, and a budget is carried here with the unit it is spent in."},"CatalogConnection":{"properties":{"params_schema":{"type":"object"}},"type":"object","required":["params_schema"],"title":"CatalogConnection","description":"One storage technology as the catalogue serves it.\n\nA struct of one field rather than the schema on its own, so that what the\ndocument says about a technology can grow without every client having to be\ntold the shape changed underneath it.\n\nThe field is spelled as the node catalogue spells its own, and deliberately:\nboth entries carry the schema of the struct a form is filled in through, one\npiece of client code interprets both, and that code narrows on the field's\nname. A second spelling of the same thing would buy a second copy of the\ninterpreter and nothing else."},"CatalogEmbeddingKind":{"properties":{"params_schema":{"type":"object"},"connection_schema":{"anyOf":[{"type":"object"},{"type":"null"}]},"models":{"additionalProperties":{"type":"integer"},"type":"object"}},"type":"object","required":["params_schema","connection_schema","models"],"title":"CatalogEmbeddingKind","description":"One kind of embedding model as the catalogue serves it."},"CatalogNode":{"properties":{"params_schema":{"type":"object"},"descriptor":{"$ref":"#/components/schemas/StageDescriptor"},"reranker_profiles":{"items":{"$ref":"#/components/schemas/RerankerProfileView"},"type":"array","default":[]}},"type":"object","required":["params_schema","descriptor"],"title":"CatalogNode","description":"One catalog node: its parameter schema and its stage descriptor.\n\nThe schema drives the editor's parameter form; the descriptor gives the\nstage's id, label key and icon, so the same identity a query's progress\nstream emits is available up front, per node, for the editor to render."},"CatalogTool":{"properties":{"params_schema":{"type":"object"},"descriptor":{"$ref":"#/components/schemas/StageDescriptor"}},"type":"object","required":["params_schema","descriptor"],"title":"CatalogTool","description":"One tool an agent may be given: its settings schema and stage.\n\nThe schema drives the form an editor shows for the tool's settings on an\nagent; the descriptor is the stage the tool's work is announced under while\na question runs, available up front so the editor can label it the same."},"ChunkDetailPayload":{"properties":{"id":{"type":"string"},"document_id":{"type":"string"},"document_name":{"type":"string"},"position":{"type":"integer"},"text":{"type":"string"},"metadata":{"type":"object"},"embedding_text":{"type":"string"},"parent":{"anyOf":[{"$ref":"#/components/schemas/ChunkParentPayload"},{"type":"null"}],"default":null},"locator":{"anyOf":[{"$ref":"#/components/schemas/SourceLocator"},{"type":"null"}],"default":null},"processing":{"anyOf":[{"$ref":"#/components/schemas/SourceProcessing"},{"type":"null"}],"default":null}},"type":"object","required":["id","document_id","document_name","position","text","metadata","embedding_text"],"title":"ChunkDetailPayload","description":"The full view of one canonical chunk.\n\nEverything the listing shows plus the chunk's free-form metadata map,\nthe text an embedder is handed for it and, for a hierarchical child, the\nparent segment it came from -- so an engineer can see what a vector\nsearch compares a question against, as well as the leaf it returns and\nthe wider passage an answer would be grounded in."},"ChunkMapBuildResult":{"properties":{"enqueued":{"type":"boolean"},"estimated_seconds":{"anyOf":[{"type":"number"},{"type":"null"}]},"document_count":{"type":"integer"}},"type":"object","required":["enqueued","estimated_seconds","document_count"],"title":"ChunkMapBuildResult","description":"The outcome of asking for a space's embedding map to be built.\n\n``enqueued`` is false when a build was already in flight -- the running\none covers the request, so no duplicate is queued. The estimate reuses the\nspace's running mean per-document index time (the same source the config\npreview costs a reindex from): a map build reads or re-embeds the corpus\nat most once, so that mean times the document count bounds it from above.\n``None`` when the space has indexed nothing yet -- no samples to estimate\nfrom is reported honestly rather than as a misleading zero."},"ChunkMapGiveUpResult":{"properties":{"released":{"type":"boolean"},"status":{"$ref":"#/components/schemas/ChunkMapStatus"}},"type":"object","required":["released","status"],"title":"ChunkMapGiveUpResult","description":"What became of a claim somebody said no worker was coming to.\n\n``released`` is whether this call dropped one: false when nothing was\nclaimed, when a worker had reached the build after all, or when the map had\nalready landed -- none of which is a failure, since what the caller wanted\nis true of all three. ``status`` is how the map reads afterwards, so the\nclient renders the same view the map read would give it without asking for\nthe points as well."},"ChunkMapPayload":{"properties":{"status":{"$ref":"#/components/schemas/ChunkMapStatus"},"points":{"items":{"$ref":"#/components/schemas/ChunkMapPoint"},"type":"array","default":[]},"matched_chunk_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"default":null}},"type":"object","required":["status"],"title":"ChunkMapPayload","description":"The embedding map of a space, or how far along its build is.\n\n``status`` is ``absent`` (no map -- a client offers to build one),\n``building`` (a build is in flight -- a client polls) or ``ready``. The\npoints are populated only when ready; ``matched_chunk_ids`` only when\nready *and* a query was asked, naming the points the space's own retrieval\nranked for that query."},"ChunkMapPoint":{"properties":{"chunk_id":{"type":"string"},"document_id":{"type":"string"},"x":{"type":"number"},"y":{"type":"number"}},"type":"object","required":["chunk_id","document_id","x","y"],"title":"ChunkMapPoint","description":"One chunk's position on the 2-D embedding map."},"ChunkMapStatus":{"enum":["absent","building","ready"],"title":"ChunkMapStatus","description":"Where a space's embedding map stands, as a client polling it reads it.\n\nThe one vocabulary of map states: what a read reports, what the column's\nmarkers store, and the names the rest of the code compares against."},"ChunkParentPayload":{"properties":{"id":{"type":"string"},"text":{"type":"string"},"locator":{"anyOf":[{"$ref":"#/components/schemas/SourceLocator"},{"type":"null"}],"default":null},"processing":{"anyOf":[{"$ref":"#/components/schemas/SourceProcessing"},{"type":"null"}],"default":null}},"type":"object","required":["id","text"],"title":"ChunkParentPayload","description":"The broader parent segment a hierarchical child chunk was cut from."},"ChunkSizeReport":{"properties":{"cuts":{"items":{"$ref":"#/components/schemas/CutSizes"},"type":"array"}},"type":"object","required":["cuts"],"title":"ChunkSizeReport","description":"What the fragments of a space's corpus came to, cut by cut.\n\nLargest cut first, and empty for a space holding no fragment this\nplatform cut."},"ChunkSummaryPayload":{"properties":{"id":{"type":"string"},"document_id":{"type":"string"},"document_name":{"type":"string"},"position":{"type":"integer"},"text":{"type":"string"}},"type":"object","required":["id","document_id","document_name","position","text"],"title":"ChunkSummaryPayload","description":"A listing view of one canonical chunk of a space's corpus.\n\nCarries what an engineer needs to see how the corpus was cut at a\nglance: the chunk's public id, the document it was cut from (id and\nname, so a mixed listing stays readable), its position within that\ndocument, and its text. The free-form metadata and the parent link stay\non the detail view."},"ComparedAnswer":{"properties":{"answer":{"type":"string"},"empty":{"type":"boolean"},"faithfulness":{"anyOf":[{"type":"number"},{"type":"null"}]},"relevancy":{"anyOf":[{"type":"number"},{"type":"null"}]},"correctness":{"anyOf":[{"type":"number"},{"type":"null"}]}},"type":"object","required":["answer","empty","faithfulness","relevancy","correctness"],"title":"ComparedAnswer","description":"One run's answer to a question, and its own reading's verdict on it."},"ComparedQuery":{"properties":{"position":{"type":"integer"},"question":{"type":"string"},"ranking_a":{"anyOf":[{"$ref":"#/components/schemas/RetrievalScore"},{"type":"null"}]},"ranking_b":{"anyOf":[{"$ref":"#/components/schemas/RetrievalScore"},{"type":"null"}]},"delta":{"anyOf":[{"type":"number"},{"type":"null"}]},"change":{"anyOf":[{"$ref":"#/components/schemas/QueryChange"},{"type":"null"}]},"first_relevant_rank_a":{"anyOf":[{"type":"integer"},{"type":"null"}]},"first_relevant_rank_b":{"anyOf":[{"type":"integer"},{"type":"null"}]},"retrieved_a":{"anyOf":[{"items":{"$ref":"#/components/schemas/RetrievedPassage"},"type":"array"},{"type":"null"}]},"retrieved_b":{"anyOf":[{"items":{"$ref":"#/components/schemas/RetrievedPassage"},"type":"array"},{"type":"null"}]},"dropped":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"added":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"answer_a":{"anyOf":[{"$ref":"#/components/schemas/ComparedAnswer"},{"type":"null"}]},"answer_b":{"anyOf":[{"$ref":"#/components/schemas/ComparedAnswer"},{"type":"null"}]}},"type":"object","required":["position","question","ranking_a","ranking_b","delta","change","first_relevant_rank_a","first_relevant_rank_b","retrieved_a","retrieved_b","dropped","added","answer_a","answer_b"],"title":"ComparedQuery","description":"One question as two runs ranked and answered it, side by side.\n\nEach run's ranking is ``None`` where that run did not rank the question. The\npassages one run reached and the other did not are listed by corpus id in\nthe order the run holding them ranked them, and are ``None`` unless both\nruns ranked the question.\n\nEach run's answer is there beside its ranking, with the verdict that run's\nown reading gave it, and is ``None`` where that reading did not judge the\nquestion.\n\nWhere the first relevant passage ranked is read off the question's own\nreciprocal rank, which is exactly one over that rank: it is ``None`` when\nno relevant passage came within the cutoff, and otherwise the passage at\nthat rank in the run's list is the relevant one."},"ComparisonCatalogEntry":{"properties":{"params_schema":{"type":"object"}},"type":"object","required":["params_schema"],"title":"ComparisonCatalogEntry","description":"The comparison settings as the catalogue serves them.\n\nA struct of one field rather than the schema on its own, and the field\nspelled as the node catalogue spells its own, so the client code that\nrenders a node's settings form renders this one unchanged."},"ConfidenceInterval":{"properties":{"low":{"type":"number"},"high":{"type":"number"}},"type":"object","required":["low","high"],"title":"ConfidenceInterval","description":"The range a mean or a difference could have landed in by chance."},"ConnectedKnowledgeBase":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"access":{"$ref":"#/components/schemas/ScopeLevel"}},"type":"object","required":["id","name","access"],"title":"ConnectedKnowledgeBase","description":"One knowledge base an agent host was handed, and how far it was let in.\n\n``access`` is the level the grant row carries -- what the person agreed to\n-- and not what the agent could do this second. The two can differ, because\nthe effective level is capped afresh on every request by the owner's own\nmembership, and a list of past decisions is the wrong place to report a\nceiling that moves: a number that changes without anybody deciding anything\nis a number its reader cannot explain. What may actually be done here is\nanswered where it matters, on the call that tries it."},"ConsentDecision":{"properties":{"knowledge_bases":{"items":{"$ref":"#/components/schemas/ConsentSpaceChoice"},"type":"array"}},"type":"object","required":["knowledge_bases"],"title":"ConsentDecision","description":"The person's answer: which knowledge bases, and how far in each.\n\nAn empty list is refused rather than stored: an authorization reaching\nnothing would leave the agent connected and permanently unable to answer,\nwhich reads as a broken platform rather than as a decision."},"ConsentDenied":{"properties":{"redirect_uri":{"type":"string"}},"type":"object","required":["redirect_uri"],"title":"ConsentDenied","description":"Where the browser goes when a person says no.\n\nA refusal has an address of its own, and sending the person to it is the\nwhole point: the agent host opened this browser and is now blocked on its\ncallback, so until something arrives there it cannot tell \"declined\" from\n\"still deciding\" and simply waits out its own timeout. Delivered, the\nrefusal turns that silence into a sentence the person reads immediately.\n\nReturned rather than performed for the same reason the issued callback is:\nthis is an ordinary API call made by a page, and a redirect status on it\nwould be followed by that page's own fetch instead of by the window."},"ConsentIssued":{"properties":{"redirect_uri":{"type":"string"}},"type":"object","required":["redirect_uri"],"title":"ConsentIssued","description":"Where the browser goes next, once consent has been recorded.\n\nThe redirect is performed by the browser rather than answered as one here:\nthe confirmation is an ordinary API call made by a page, and a redirect\nstatus on it would be followed by the page's own fetch instead of by the\nwindow."},"ConsentRequestView":{"properties":{"id":{"type":"string"},"client_name":{"type":"string"},"client_host":{"anyOf":[{"type":"string"},{"type":"null"}]},"callback_host":{"type":"string"},"requested_access":{"$ref":"#/components/schemas/ScopeLevel"},"expires_at":{"type":"string"},"already_connected":{"type":"boolean"},"knowledge_bases":{"items":{"$ref":"#/components/schemas/ConsentSpaceOption"},"type":"array"}},"type":"object","required":["id","client_name","client_host","callback_host","requested_access","expires_at","already_connected","knowledge_bases"],"title":"ConsentRequestView","description":"What the web application shows a person before they decide.\n\nBoth halves of the client's identity are here on purpose. The name comes\nfrom a manifest, and a manifest can be copied verbatim, so a well-known\nname is no evidence at all; the hosts are what cannot be borrowed. The\ncallback host in particular is the one thing that distinguishes a genuine\nlocal agent from somebody who presented its manifest and pointed the code at\ntheir own machine."},"ConsentSpaceChoice":{"properties":{"space":{"type":"string","format":"uuid"},"level":{"default":"read","$ref":"#/components/schemas/ScopeLevel"}},"type":"object","required":["space"],"title":"ConsentSpaceChoice","description":"One knowledge base the person is handing over, and at which level.\n\nThe level defaults to ``read``: a choice nobody thought about is the\nsmallest one, so a client omitting the field can never come away with more\nthan it would have been shown."},"ConsentSpaceOption":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"access":{"$ref":"#/components/schemas/ScopeLevel"}},"type":"object","required":["id","name","access"],"title":"ConsentSpaceOption","description":"One knowledge base a person may hand to the agent, and how far.\n\n``access`` is the most they could grant here -- their own reach, capped\nbelow full control, because no agent ever administers a space. A screen\noffering more than this would be offering something the confirmation would\nthen refuse."},"CorpusDocument":{"properties":{"id":{"type":"string","minLength":1},"text":{"type":"string","minLength":1}},"additionalProperties":false,"type":"object","required":["id","text"],"title":"CorpusDocument","description":"One document in an evaluation dataset's corpus.\n\nThe corpus is the set of passages a retrieval pipeline is scored against:\neach carries a dataset-local ``id`` a query's ``relevant_ids`` can point at,\nand the ``text`` that gets ingested and retrieved."},"CorpusSummary":{"properties":{"documents":{"type":"integer"},"indexed":{"type":"integer"},"chunks":{"type":"integer"},"added":{"items":{"$ref":"#/components/schemas/DayDocuments"},"type":"array"}},"type":"object","required":["documents","indexed","chunks","added"],"title":"CorpusSummary","description":"How big the space's corpus is now, and how it grew over the period.\n\nDocuments added are read off when each was created; the platform keeps no\nrecord of documents deleted, so how the corpus shrank is not served."},"CorrectionGuidance":{"properties":{"criterion":{"type":"string"},"explanation":{"type":"string"}},"type":"object","required":["criterion","explanation"],"title":"CorrectionGuidance","description":"Revision instructions kept separate from the original question."},"CoveragePart":{"properties":{"question":{"type":"string","minLength":1},"source_ids":{"items":{"type":"string"},"type":"array"},"gap":{"type":"string"}},"additionalProperties":false,"type":"object","required":["question","source_ids","gap"],"title":"CoveragePart","description":"One question part, its supporting retrieved IDs, and an evidence gap."},"CoverageSettings":{"properties":{"instruction":{"type":"string","minLength":1,"default":"Split the question into its requested parts. For each part, identify retrieved passages that directly support an answer. Mark missing or contradictory evidence as a gap. Do not infer facts from memory."},"model":{"anyOf":[{"type":"string","minLength":1,"examples":["openai/gpt-4o","openai/gpt-4o-mini","anthropic/claude-3-5-sonnet","anthropic/claude-3-5-haiku","ollama/llama3","ollama/qwen2.5","openai/gigachat","openai/yandexgpt"]},{"type":"null"}],"default":null},"api_base":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"default":null},"temperature":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"default":null},"max_retries":{"type":"integer","minimum":0,"default":1},"max_tool_calls":{"type":"integer","minimum":1,"default":8},"max_tokens":{"type":"integer","minimum":1,"default":1024},"input_characters":{"type":"integer","minimum":1,"default":24000}},"additionalProperties":false,"type":"object","title":"CoverageSettings","description":"Check evidence before answering, within a shared search budget."},"CoverageTrace":{"properties":{"parts":{"items":{"$ref":"#/components/schemas/CoveragePart"},"type":"array"},"followup_query":{"type":"string"},"model":{"type":"string"},"budget_exhausted":{"type":"boolean"}},"type":"object","required":["parts","followup_query","model","budget_exhausted"],"title":"CoverageTrace","description":"A validated coverage decision and the budget at that decision."},"CreateSpaceGrantPayload":{"properties":{"enabled":{"type":"boolean"}},"type":"object","required":["enabled"],"title":"CreateSpaceGrantPayload","description":"Whether this group may create spaces."},"CredentialStanding":{"enum":["active","expired","revoked"],"title":"CredentialStanding","description":"A credential either works, has run out, or was taken back.\n\nThree words rather than a pair of flags. The states are exclusive and the\nreader has to be told which one applies, whereas two booleans can be\ncombined into a reading (\"revoked and expired\") that means nothing to the\nperson looking at the screen -- and leaves each reader to invent their own\nprecedence between them."},"CriterionResult":{"properties":{"criterion_key":{"type":"string"},"verdict":{"enum":["fail","pass","unevaluable"]},"explanation":{"type":"string"},"technical_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"requested_model":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"effective_model":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"latency_ms":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null},"usage":{"anyOf":[{"$ref":"#/components/schemas/RubricUsage"},{"type":"null"}],"default":null},"kind":{"enum":["json_schema","llm","regex"],"default":"llm"},"reason_code":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"error_path":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"error_keyword":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},"type":"object","required":["criterion_key","verdict","explanation"],"title":"CriterionResult","description":"A semantic verdict or a technical inability to judge one criterion."},"CutSizes":{"properties":{"chunker":{"anyOf":[{"type":"string"},{"type":"null"}]},"budget":{"anyOf":[{"type":"integer"},{"type":"null"}]},"budget_unit":{"anyOf":[{"$ref":"#/components/schemas/BudgetUnit"},{"type":"null"}]},"fragments":{"type":"integer"},"characters":{"$ref":"#/components/schemas/SizeSpread"},"tokens_counted":{"type":"integer"},"tokens":{"anyOf":[{"$ref":"#/components/schemas/SizeSpread"},{"type":"null"}]}},"type":"object","required":["chunker","budget","budget_unit","fragments","characters","tokens_counted","tokens"],"title":"CutSizes","description":"What the fragments of one cut of a space's corpus came to.\n\nA corpus is cut document by document, and every document records the\nsettings it was cut under, so fragments are measured one recorded cut at\na time: the budget a group is shown beside is the one its fragments were\nreally cut to, not whatever the configuration asks for now. A corpus\nrecut under one setting has one of these.\n\nOnly fragments a search can return are measured -- the wider segments a\nhierarchical cut keeps above them are not -- so these are the sizes of\nwhat a search hands back. Their size is given in characters, which is\nwhat a budget actually buys, and in the tokens the budget was spent in,\nwhere the cut counted them."},"DayCost":{"properties":{"day":{"type":"string","format":"date"},"cost_usd":{"type":"number"}},"type":"object","required":["day","cost_usd"],"title":"DayCost","description":"What one day's priced calls cost together, in US dollars."},"DayDocuments":{"properties":{"day":{"type":"string","format":"date"},"documents":{"type":"integer"}},"type":"object","required":["day","documents"],"title":"DayDocuments","description":"How many documents were added to the space on one day."},"DayQueries":{"properties":{"day":{"type":"string","format":"date"},"mode":{"$ref":"#/components/schemas/QueryMode"},"entrypoint":{"$ref":"#/components/schemas/QueryEntrypoint"},"queries":{"type":"integer"}},"type":"object","required":["day","mode","entrypoint","queries"],"title":"DayQueries","description":"How many questions one day saw, asked one way by one entrance."},"DictionaryBuild":{"properties":{"id":{"type":"string","format":"uuid"},"total":{"type":"integer"},"queued":{"type":"integer"},"running":{"type":"integer"},"succeeded":{"type":"integer"},"failed":{"type":"integer"},"stale":{"type":"integer"},"created_at":{"type":"string"},"updated_at":{"type":"string"},"items":{"items":{"$ref":"#/components/schemas/DictionaryWork"},"type":"array"}},"type":"object","required":["id","total","queued","running","succeeded","failed","stale","created_at","updated_at","items"],"title":"DictionaryBuild","description":"Progress of a requested or ingest-triggered dictionary pass."},"DictionaryCreate":{"properties":{"canonical":{"type":"string","maxLength":500,"minLength":1},"aliases":{"items":{"type":"string","maxLength":500,"minLength":1},"type":"array","maxItems":50},"description":{"type":"string","maxLength":8000,"default":""},"status":{"enum":["conflict","proposed","published"],"default":"published"}},"additionalProperties":false,"type":"object","required":["canonical","aliases"],"title":"DictionaryCreate","description":"Create a manual term group."},"DictionaryEntry":{"properties":{"id":{"type":"string","format":"uuid"},"canonical":{"type":"string"},"aliases":{"items":{"type":"string"},"type":"array"},"description":{"type":"string"},"status":{"enum":["conflict","proposed","published"]},"ownership":{"enum":["automatic","manual"]},"version":{"type":"integer"},"has_evidence":{"type":"boolean"},"deleted":{"type":"boolean"},"evidence":{"items":{"$ref":"#/components/schemas/DictionaryEvidence"},"type":"array"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"type":"object","required":["id","canonical","aliases","description","status","ownership","version","has_evidence","deleted","evidence","created_at","updated_at"],"title":"DictionaryEntry","description":"Editable term group with optimistic version and source ownership."},"DictionaryEvidence":{"properties":{"id":{"type":"string","format":"uuid"},"document_id":{"type":"string","format":"uuid"},"revision_id":{"type":"string","format":"uuid"},"document_name":{"type":"string"},"quote":{"type":"string"},"start":{"type":"integer"},"end":{"type":"integer"}},"type":"object","required":["id","document_id","revision_id","document_name","quote","start","end"],"title":"DictionaryEvidence","description":"Verbatim support in an immutable accepted document revision."},"DictionaryExtractionConfig":{"properties":{"enabled":{"type":"boolean","default":false},"model":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"api_base":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"temperature":{"anyOf":[{"type":"number","maximum":2,"minimum":0},{"type":"null"}],"default":null},"instruction":{"type":"string","default":"Extract names for the same entity, abbreviations, expansions and renamed entities. Return JSON with an entries array. Each entry has canonical, aliases, description and quote. Copy quote verbatim from the text. Do not infer equivalence without explicit evidence."},"max_input_chars":{"type":"integer","minimum":1,"default":16000},"max_output_tokens":{"type":"integer","minimum":1,"default":2048},"auto_publish":{"type":"boolean","default":true},"max_calls_per_document":{"type":"integer","minimum":1,"default":128},"overlap_ratio":{"type":"number","maximum":0.5,"minimum":0,"default":0.1}},"additionalProperties":false,"type":"object","title":"DictionaryExtractionConfig","description":"Optional extraction with a per-call Unicode character input limit.\n\nThe output budget is passed to the model as tokens. Changing settings does\nnot enqueue existing documents; a dictionary build does that explicitly."},"DictionarySkip":{"properties":{"entry_id":{"type":"string","format":"uuid"},"reason":{"type":"string"}},"type":"object","required":["entry_id","reason"],"title":"DictionarySkip","description":"An explicit match which did not contribute a formulation."},"DictionaryTransformExecution":{"properties":{"dictionary_version":{"type":"integer"},"mode":{"type":"string"},"input_query":{"type":"string"},"queries":{"items":{"type":"string"},"type":"array"},"entry_ids":{"items":{"type":"string","format":"uuid"},"type":"array"},"skipped":{"items":{"$ref":"#/components/schemas/DictionarySkip"},"type":"array"},"status":{"type":"string"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},"type":"object","required":["dictionary_version","mode","input_query","queries","entry_ids","skipped","status"],"title":"DictionaryTransformExecution","description":"Snapshot identity and actual wordings, without provider error text."},"DictionaryUpdate":{"properties":{"version":{"type":"integer","minimum":1},"canonical":{"type":"string","maxLength":500,"minLength":1},"aliases":{"items":{"type":"string","maxLength":500,"minLength":1},"type":"array","maxItems":50},"description":{"type":"string","maxLength":8000,"default":""},"status":{"enum":["conflict","proposed","published"],"default":"published"}},"additionalProperties":false,"type":"object","required":["version","canonical","aliases"],"title":"DictionaryUpdate","description":"Replace editable content if the displayed entry has not changed."},"DictionaryVersion":{"properties":{"version":{"type":"integer","minimum":1}},"additionalProperties":false,"type":"object","required":["version"],"title":"DictionaryVersion","description":"Guard deletion or explicit restoration against concurrent edits."},"DictionaryWork":{"properties":{"id":{"type":"string","format":"uuid"},"document_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"revision_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"status":{"type":"string"},"error":{"type":"string"},"attempt":{"type":"integer"},"model_calls":{"type":"integer"},"input_chars":{"type":"integer"},"output_chars":{"type":"integer"},"usage":{"items":{"$ref":"#/components/schemas/ModelUsage"},"type":"array"},"usage_complete":{"type":"boolean"}},"type":"object","required":["id","document_id","revision_id","status","error","attempt","model_calls","input_chars","output_chars","usage","usage_complete"],"title":"DictionaryWork","description":"One captured revision's extraction outcome."},"DocumentFullPayload":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/DocumentIngestStatus"},"is_active":{"type":"boolean"},"space":{"type":"string"},"size":{"anyOf":[{"type":"integer"},{"type":"null"}]},"content_type":{"type":"string"},"created_at":{"type":"string"},"metadata":{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"type":"object","default":{}},"extracted_char_count":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Server-owned count of canonical extracted Unicode codepoints, including whitespace before chunking. Null means unknown extraction provenance; zero confirms empty extraction, independently of indexing status.","default":null,"readOnly":true}},"type":"object","required":["id","name","status","is_active","space","size","content_type","created_at"],"title":"DocumentFullPayload","description":"Used to represent existing ``Document`` models."},"DocumentGroup":{"properties":{"id":{"type":"string","format":"uuid"},"representative_id":{"type":"string"},"members":{"items":{"$ref":"#/components/schemas/DocumentGroupMember"},"type":"array"}},"type":"object","required":["id","representative_id","members"],"title":"DocumentGroup","description":"A Space-scoped view over compatible accepted copies."},"DocumentGroupMember":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/DocumentIngestStatus"},"is_active":{"type":"boolean"},"origin":{"$ref":"#/components/schemas/DocumentOrigin"}},"type":"object","required":["id","name","status","is_active","origin"],"title":"DocumentGroupMember","description":"One independent copy; actions address this document UUID."},"DocumentIngestStatus":{"enum":["indexed","uploaded"],"title":"DocumentIngestStatus","description":"Where a document stands in the ingest pipeline, as a client reads it.\n\n``uploaded`` -- the original is stored and its indexing has not finished;\n``indexed`` -- its chunks are written and retrievable. The stored column\nkeeps its own matching vocabulary on the model, and a completeness test\nbinds the two."},"DocumentLifecycleRequest":{"properties":{"command_id":{"type":"string","format":"uuid"}},"type":"object","required":["command_id"],"title":"DocumentLifecycleRequest","description":"A retry reuses the same command UUID."},"DocumentMetadataPayload":{"properties":{"metadata":{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"type":"object"}},"type":"object","required":["metadata"],"title":"DocumentMetadataPayload","description":"What a document is to say about itself from now on.\n\nA whole replacement rather than a field-by-field patch. The map is small\nand is edited as one thing, and \"the fields are exactly these\" is something\na client can state from what it is already showing, while \"change this one\nand leave the others\" obliges it to know what the others currently are --\nwhich is how two people editing one document quietly undo each other.\n\nSending an empty map is therefore meaningful: it says the document\ndescribes itself with nothing, and clears whatever it carried."},"DocumentOperationStatus":{"properties":{"id":{"type":"string","format":"uuid"},"document_id":{"type":"string","format":"uuid"},"kind":{"$ref":"#/components/schemas/OperationKind"},"state":{"$ref":"#/components/schemas/OperationState"},"intent_version":{"type":"integer"},"candidate_revision_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"started_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"completed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"error_code":{"type":"string"}},"type":"object","required":["id","document_id","kind","state","intent_version","candidate_revision_id","started_at","completed_at","error_code"],"title":"DocumentOperationStatus","description":"Internal error codes collapse to ``operation_failed`` or an empty code.\n\nError messages and execution credentials are excluded from this projection."},"DocumentOrigin":{"properties":{"kind":{"enum":["manual","source"],"default":"manual"},"source_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"default":null},"source_name":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},"type":"object","title":"DocumentOrigin","description":"Display attribution without an external address or storage identity."},"DocumentRef":{"properties":{"document_id":{"type":"string"},"name":{"type":"string"}},"type":"object","required":["document_id","name"],"title":"DocumentRef","description":"A document named, with nothing about its use."},"DocumentSummaryPayload":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"$ref":"#/components/schemas/DocumentIngestStatus"},"is_active":{"type":"boolean"},"size":{"anyOf":[{"type":"integer"},{"type":"null"}]},"content_type":{"type":"string"},"chunk_count":{"type":"integer"},"created_at":{"type":"string"},"metadata":{"additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"type":"object","default":{}},"extracted_char_count":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Server-owned count of canonical extracted Unicode codepoints, including whitespace before chunking. Null means unknown extraction provenance; zero confirms empty extraction, independently of indexing status.","default":null,"readOnly":true},"group":{"anyOf":[{"$ref":"#/components/schemas/DocumentGroup"},{"type":"null"}],"default":null}},"type":"object","required":["id","name","status","is_active","size","content_type","chunk_count","created_at"],"title":"DocumentSummaryPayload","description":"A listing view of a document within a space.\n\nCarries what a member needs to see a space's documents at a glance -- the\ndocument's public id, name, ingest status, size, type, live chunk count and\nwhen it was created -- without the owning space's id (the listing is already\nscoped to one space) or the document's extracted text."},"DocumentUse":{"properties":{"document_id":{"type":"string"},"name":{"type":"string"},"retrieved":{"type":"integer"},"sent":{"type":"integer"}},"type":"object","required":["document_id","name","retrieved","sent"],"title":"DocumentUse","description":"How often one document came back to the period's questions."},"EffectiveRerankerParams":{"properties":{"model":{"type":"string"},"profile":{"type":"string"},"revision":{"anyOf":[{"type":"string"},{"type":"null"}]},"input_mode":{"type":"string"},"input_template":{"anyOf":[{"type":"string"},{"type":"null"}]},"max_length":{"anyOf":[{"type":"integer"},{"type":"null"}]},"truncation":{"type":"string"},"padding":{"type":"string"},"batch_size":{"anyOf":[{"type":"integer"},{"type":"null"}]},"max_query_length":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null},"max_document_length":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null},"internal_block_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null}},"type":"object","required":["model","profile","revision","input_mode","input_template","max_length","truncation","padding","batch_size"],"title":"EffectiveRerankerParams","description":"Resolved model processing, separate from the stored overrides."},"EmbeddingModelPayload":{"properties":{"kind":{"enum":["local","remote"]},"model_id":{"type":"string","maxLength":128,"minLength":1},"dim":{"type":"integer","minimum":1},"params":{"type":"object","default":{}},"connection":{"type":"object","default":{}}},"additionalProperties":false,"type":"object","required":["kind","model_id","dim"],"title":"EmbeddingModelPayload","description":"An embedding model as a caller asks for it to be registered or replaced.\n\nThe whole row, every time -- with one exception for a replacement: a key\nleft out of the connection, or sent empty, keeps the one stored, and a key\nsent as ``null`` removes it. A client is never shown a key, so it could not\nsend the stored one back. ``params`` and ``connection`` are free-form here\nand read through their typed structs when the proposal is judged."},"EngineCapabilities":{"properties":{"engine":{"enum":["paddle","paddle_vl","tesseract","unlimited_ocr_2","vision_llm","xiaomi"]},"available":{"type":"boolean"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"profile_revision":{"type":"string"},"default_config":{"$ref":"#/components/schemas/ExtractionConfig"},"tesseract":{"anyOf":[{"$ref":"#/components/schemas/TesseractCapabilities"},{"type":"null"}],"default":null}},"type":"object","required":["engine","available","reason","profile_revision","default_config"],"title":"EngineCapabilities","description":"One runtime bundle and its current availability."},"EquivalentPassageGroup":{"properties":{"id":{"type":"string","format":"uuid"},"representative_id":{"type":"string"},"members":{"items":{"$ref":"#/components/schemas/EquivalentPassageMember"},"type":"array"}},"type":"object","required":["id","representative_id","members"],"title":"EquivalentPassageGroup","description":"Compatible passages keep a real representative and per-copy addresses."},"EquivalentPassageMember":{"properties":{"id":{"type":"string"},"document_id":{"type":"string","format":"uuid"},"document_name":{"type":"string"},"origin":{"$ref":"#/components/schemas/DocumentOrigin"},"locator":{"anyOf":[{"$ref":"#/components/schemas/SourceLocator"},{"type":"null"}],"default":null},"processing":{"anyOf":[{"$ref":"#/components/schemas/SourceProcessing"},{"type":"null"}],"default":null},"bibliography":{"anyOf":[{"$ref":"#/components/schemas/SourceBibliography"},{"type":"null"}],"default":null},"parent_locator":{"anyOf":[{"$ref":"#/components/schemas/SourceLocator"},{"type":"null"}],"default":null},"parent_processing":{"anyOf":[{"$ref":"#/components/schemas/SourceProcessing"},{"type":"null"}],"default":null},"parent_bibliography":{"anyOf":[{"$ref":"#/components/schemas/SourceBibliography"},{"type":"null"}],"default":null}},"type":"object","required":["id","document_id","document_name","origin"],"title":"EquivalentPassageMember","description":"One canonical copy of the same admitted grounding passage."},"ErrorDetail":{"properties":{"loc":{"items":{"anyOf":[{"type":"integer"},{"type":"string"}]},"type":"array"},"msg":{"type":"string"},"type":{"type":"string"}},"type":"object","required":["msg"],"title":"ErrorDetail","description":"Base schema for error details description."},"ErrorModel":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ErrorDetail"},"type":"array"}},"type":"object","required":["detail"],"title":"ErrorModel","description":"Default error response schema.\n\nCan be customized.\nSee :ref:`customizing-error-messages` for more details."},"EvaluationDatasetPayload":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1},"corpus":{"items":{"$ref":"#/components/schemas/CorpusDocument"},"type":"array"},"queries":{"items":{"$ref":"#/components/schemas/EvaluationQuery"},"type":"array"}},"additionalProperties":false,"type":"object","required":["name","corpus","queries"],"title":"EvaluationDatasetPayload","description":"The accepted shape of an evaluation dataset, before validation.\n\nMirrors the JSON a client supplies: a ``name``, a ``corpus`` of passages\nand the ``queries`` posed against them. Decoding into this struct rejects\nunknown keys and the field-level constraints (a non-empty name), but the\ncross-field rules (a non-empty corpus, unique corpus ids, every\n``relevant_ids`` entry present in the corpus) are checked by the validator,\nwhich also derives the counts and the metric-applicability flags."},"EvaluationDatasetSummary":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"corpus_size":{"type":"integer"},"query_count":{"type":"integer"},"has_relevant_ids":{"type":"boolean"},"has_golden_answers":{"type":"boolean"},"created_at":{"type":"string"}},"type":"object","required":["id","name","corpus_size","query_count","has_relevant_ids","has_golden_answers","created_at"],"title":"EvaluationDatasetSummary","description":"The view of a stored dataset: what it is, not what is in it.\n\nA dataset's corpus and queries are as many as its owner uploaded, so they\nare never part of a dataset's own representation -- neither in a listing\nnor when one dataset is fetched by id. What both carry is the derived facts\n(the counts and the metric-applicability flags) alongside the public id,\nname and creation time, which is what a client needs to choose a dataset\nand to know which metrics a run on it can compute. The corpus and the\nqueries are read as their own paginated collections, a page at a time."},"EvaluationMetrics":{"properties":{"retrieval":{"anyOf":[{"$ref":"#/components/schemas/RetrievalScore"},{"type":"null"}]},"answer_quality":{"anyOf":[{"$ref":"#/components/schemas/AnswerQualityScore"},{"type":"null"}]},"skipped":{"items":{"$ref":"#/components/schemas/SkippedMetric"},"type":"array","default":[]}},"type":"object","required":["retrieval","answer_quality"],"title":"EvaluationMetrics","description":"The whole result of one evaluation run: the families it computed.\n\nReplaces the bare retrieval score a run used to store with a typed envelope\nthat carries whichever metric families ran -- ``retrieval`` for the ranking\nmetrics, ``answer_quality`` for the judge metrics -- each ``None`` when its\nfamily did not run, alongside ``skipped``, the record of the families that\nwere not computed and why. A run that scored only retrieval (the historical\nbehaviour) carries the retrieval score, a ``None`` answer-quality score, and\na single skipped answer-quality entry naming the reason."},"EvaluationQuery":{"properties":{"question":{"type":"string","minLength":1},"relevant_ids":{"items":{"type":"string"},"type":"array","default":[]},"golden_answer":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},"additionalProperties":false,"type":"object","required":["question"],"title":"EvaluationQuery","description":"One query an evaluation dataset poses against its corpus.\n\nA query always carries the ``question`` asked. The two optional fields are\nwhat make a metric applicable: ``relevant_ids`` (the corpus ids that should\nrank highest) enable the ranking metrics, and ``golden_answer`` (a reference\nanswer) enables answer-quality scoring. A dataset may carry either, both, or\nneither across its queries."},"EvaluationQueryOutcomeSummary":{"properties":{"position":{"type":"integer"},"question":{"type":"string"},"golden_answer":{"anyOf":[{"type":"string"},{"type":"null"}]},"retrieved":{"anyOf":[{"items":{"$ref":"#/components/schemas/RetrievedPassage"},"type":"array"},{"type":"null"}]},"ranking":{"anyOf":[{"$ref":"#/components/schemas/RetrievalScore"},{"type":"null"}]},"judged_context":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"context_seen":{"anyOf":[{"type":"integer"},{"type":"null"}]},"answer":{"type":"string"},"judgements":{"items":{"$ref":"#/components/schemas/AnswerJudgement"},"type":"array"},"retrieved_hits":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}]},"untraced_hits":{"anyOf":[{"type":"integer"},{"type":"null"}]},"agent_trace":{"anyOf":[{"$ref":"#/components/schemas/AgentTrace"},{"type":"null"}]},"publication_outcome":{"type":"string","default":"answered"},"postgeneration_trace":{"anyOf":[{"$ref":"#/components/schemas/PostGenerationTrace"},{"type":"null"}],"default":null},"reranker_trace":{"items":{"$ref":"#/components/schemas/RerankerExecution"},"type":"array","default":[]}},"type":"object","required":["position","question","golden_answer","retrieved","ranking","judged_context","context_seen","answer","judgements","retrieved_hits","untraced_hits","agent_trace"],"title":"EvaluationQueryOutcomeSummary","description":"One query's whole record within a run, as it is read back.\n\nCarries both halves and the judgements over the answer. A half the run did\nnot compute reads as absent rather than as empty: a query that retrieved\nnothing and a query whose ranking was never scored are different facts, and\nso are an answer of no words and no answer at all. Each half has one field\nthat says whether it was measured -- ``retrieved`` for the ranking,\n``judged_context`` for the answering -- and the rest of that half is read\nunder it."},"EvaluationRunComparison":{"properties":{"dataset_id":{"type":"string"},"run_a_id":{"type":"string"},"run_b_id":{"type":"string"},"metrics":{"items":{"$ref":"#/components/schemas/MetricDelta"},"type":"array"},"empty_count_a":{"anyOf":[{"type":"integer"},{"type":"null"}]},"empty_count_b":{"anyOf":[{"type":"integer"},{"type":"null"}]},"empty_answer_rule_differs":{"type":"boolean"}},"type":"object","required":["dataset_id","run_a_id","run_b_id","metrics","empty_count_a","empty_count_b","empty_answer_rule_differs"],"title":"EvaluationRunComparison","description":"The metric diff between two finished runs of one dataset.\n\nCarries the identity of what was compared -- the dataset both runs scored\nand the two run ids, with ``run_a`` the baseline and ``run_b`` the one\ncompared against it -- and the per-metric deltas across both families, in a\nstable order (the ranking metrics, then the answer-quality metrics). A\nmetric missing on one or both runs is still listed, with that side ``None``\nand its delta ``None``.\n\nEach run's count of empty answers travels beside the deltas, because a\ndifference in answer quality between two runs that differ in how often\nthey said nothing is partly that difference, and a reader should see it.\nWhere one run was scored before empty answers were told apart and the\nother after, ``empty_answer_rule_differs`` is true and the answer-quality\ndeltas are left ``None``: the two sides are the same metric name over\ndifferent definitions, and a number between them would read as a change\nthat neither configuration made. Both runs' values stay listed."},"EvaluationRunFailure":{"enum":["abandoned","configuration_changed","embedder_unreachable","error","judge_unreachable","timed_out"],"title":"EvaluationRunFailure","description":"Why a failed run stopped without producing metrics.\n\nA run that only says it failed leaves its reader with nothing to do about\nit, and each case below is something a reader would do differently about:\n\n``timed_out`` -- the scoring was still going when the worker's time limit\ncut it off. Nothing about it was wrong except its size: the same dataset,\nscored the same way on the same machine, will end here again, so what has\nto move is the time limit, the ceiling the run scores at, or the dataset.\n\n``abandoned`` -- the run did not start in time or was interrupted before\nit could finish. Its owner should retry manually. This also covers a stale\nattempt and scoring that exhausted its transient retries.\n\n``embedder_unreachable`` -- the remote embedding model gave no answer at\nall: the address did not resolve, or nothing accepted the connection, or\nnothing came back, for as long as whatever asked was prepared to wait --\npast its connection's retries, and while the corpus is being filled, for\nminutes more on top. Nothing about the run or its configuration is at\nfault, and neither is the provider's opinion of the request, so the\nreader's move is to check the network or the provider and start the run\nagain. Where it stopped the corpus fill, the fill is set aside for the\nowner's next run over the same dataset and configuration to carry on from\n-- unless a fill of that configuration already waits, and then that one is\ncarried on and this one dropped. Where it stopped anything else -- the\nqueries, a run scored in place -- there was no fill to carry on.\n\n``judge_unreachable`` -- the model judging the answers gave no verdict for\nas long as it was waited on: its provider kept asking to be called back\nlater, kept timing out, or would not take the connection, past its own\nretries and through minutes of waiting on top. Nothing about the run or\nits configuration is at fault, so the reader's move is to check the judge's\nprovider -- its rate limits, its quota, whether it is up -- and start the\nrun again, or name a different judge.\n\n``error`` -- anything else that fell over while scoring: a source space\ndeleted underneath the run, a provider refusing, a defect. What actually\nhappened is in the worker's log with its traceback.\n\nA closed set rather than the failure's own words, because the words are the\nwrong thing to hand out: an exception message carries whatever the library\nthat raised it put there -- a host, a path, a fragment of a key -- to a\nreader who is only entitled to know their run stopped. So the wire carries\nwhich of the set it was, and the detail stays in the log."},"EvaluationRunPairedComparison":{"properties":{"means":{"$ref":"#/components/schemas/EvaluationRunComparison"},"settings":{"$ref":"#/components/schemas/RunComparisonSettings"},"seed":{"type":"integer"},"minimum_pairs":{"type":"integer"},"paired_queries":{"type":"integer"},"unpaired_queries":{"type":"integer"},"ranking":{"items":{"$ref":"#/components/schemas/PairedMetric"},"type":"array"},"answer":{"$ref":"#/components/schemas/AnswerComparison"}},"type":"object","required":["means","settings","seed","minimum_pairs","paired_queries","unpaired_queries","ranking","answer"],"title":"EvaluationRunPairedComparison","description":"Two runs of one dataset compared by their means and question by question.\n\n``means`` is the comparison of the two runs' stored averages, across both\nfamilies of metric, exactly as it is served for any two runs of a dataset.\nWhat follows it is taken from the runs' per-query records: for each ranking\nmetric and, where the answers can be paired, for each answer metric, how\nmany questions moved each way, how large the difference could be and\nwhether it could be chance.\n\nThe settings the comparison was made under travel with it, along with the\nseed it drew from, so the same figures can be asked for again and come\nback the same."},"EvaluationRunProgress":{"properties":{"stage":{"$ref":"#/components/schemas/EvaluationRunStage"},"done":{"type":"integer"},"total":{"anyOf":[{"type":"integer"},{"type":"null"}]},"remaining_seconds":{"anyOf":[{"type":"number"},{"type":"null"}]}},"type":"object","required":["stage","done","total","remaining_seconds"],"title":"EvaluationRunProgress","description":"What a run is working on, how far it has got, and how long is left.\n\nWhether anybody is still working on a run is answered elsewhere, by the\nstamp its attempt keeps refreshing. What that leaves unanswered is how much\nof the work is behind it: an owner two hours into a run can otherwise see\nonly that it is going, and cannot tell one about to finish from one that\nhas barely started. Four readings settle that -- which stretch of work is\nunder way, what has been done of it, what there is to do, and how much\nlonger the rest would take at the rate this stretch has been going -- and\nthey travel as one value because each of them misleads without the others:\na count with no denominator cannot be read as a share, a share with no rate\ncannot be read as a wait, and neither can be read at all without knowing\nwhat is being counted.\n\nThat last is why the stage is here. A run does not spend its life doing one\nkind of work: it writes the dataset's passages into the space its questions\nwill be asked against, it may then build a knowledge graph over them, and\nonly after that does it ask anything. Those go in different units, and the\nfirst of them has been measured at the overwhelming majority of a long\nrun's wall clock -- the figures, and the configuration they were taken\nunder, are on the stage vocabulary rather than repeated here. Reporting\nthem all under one name would be incomparable numbers pretending to be one\nseries; naming the stretch lets the unit change honestly as the run goes.\n\nThe denominator is absent wherever the stretch under way cannot say how\nmuch work it holds: a run nothing has claimed is not doing anything to\ncount, and a graph build counts chunks of a corpus, which is a number\nsettled inside the build itself. A run waiting its turn is not always the\nfirst of those -- an attempt interrupted part way hands its run back still\ncarrying the stage and the figure it was working towards, and both are\ndeliberately left standing, since a run whose deliveries then run out is\nclosed out where it lies and this is what its owner reads.\n\n**What this still does not measure, said plainly.** The graph build is\nreported as a stage and counted not at all. Its unit is a chunk of the\ncorpus rather than a passage of it, how many chunks a corpus comes to is\nsettled inside the build, and the build prompts the model once per\nchunk -- so it is both the stretch that would most repay a numerator and\nthe one this cannot give. A run in that stage reports the stage, a count of\nnought and no denominator, which says \"under way, and how far cannot be\nsaid\". That is a different statement from a run nothing has claimed, and\nthe two are told apart by the stage beside these figures rather than by\nguessing at the absence."},"EvaluationRunRequest":{"properties":{"dataset_id":{"type":"string","format":"uuid"},"top_k":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"default":null},"query_concurrency":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"default":null},"judge_model":{"anyOf":[{"type":"string","maxLength":255,"minLength":1,"examples":["openai/gpt-4o","openai/gpt-4o-mini","anthropic/claude-3-5-sonnet","anthropic/claude-3-5-haiku","ollama/llama3","ollama/qwen2.5","openai/gigachat","openai/yandexgpt"]},{"type":"null"}],"default":null},"space_use":{"default":"throwaway","$ref":"#/components/schemas/EvaluationSpaceUse"},"rubric":{"anyOf":[{"$ref":"#/components/schemas/RubricAssessmentRequest"},{"type":"null"}],"default":null},"selected_metrics":{"anyOf":[{"items":{"enum":["answer_quality","retrieval"]},"type":"array"},{"type":"null"}],"default":null}},"additionalProperties":false,"type":"object","required":["dataset_id"],"title":"EvaluationRunRequest","description":"The body that requests a new run against a space.\n\nNames the dataset to score (by its public id; the caller must own it),\noptionally how many chunks each query retrieves, optionally how many\nqueries are scored at once, and optionally the model that scores the\ngenerated answers. ``top_k`` genuinely drives the scoring: the queries are\nretrieved at that depth and the metrics are computed over the documents\nthat ranking collapses to, so two runs asking for different depths report\ndifferent numbers.\n\nOmitting it takes the deployment's default retrieval depth, which sits\ncomfortably above the metric cutoff -- the cutoff counts documents while\nthis counts chunks, and a document cut into several chunks occupies several\nof them, so a ranking has to be several times deeper than the cutoff before\nit collapses to that many documents.\n\n``query_concurrency`` moves what a run costs in wall-clock time and nothing\nabout the numbers it reports: the same queries go through the same pipeline\nand each score is folded into the same average however the scheduling fell\nout. It is per run because the right value follows what the scored space\nanswers through -- a rate-limited provider wants few in flight, a local\nmodel behind a fast card wants many -- and that is a fact about this run,\nnot about the installation.\n\n``space_use`` says what becomes of the space the run is scored in, and it is\nasked for rather than worked out. Filling a space costs an ingest of the\nwhole corpus and, for a configuration reading a knowledge graph, a model\ncall per chunk of it -- while most comparisons vary something the build\nnever writes down, so most of that spending buys a second graph that differs\nfrom the first only in being drawn afresh. A run may therefore leave its\nspace standing, and a later run may be scored in that space instead. What\nthis never does is choose such a space by itself: there is no register of\nwhich spaces would serve which corpora, and inventing one would trade a\nsaved graph build for the chance of scoring a dataset's questions against\nsomebody else's corpus without saying so.\n\nThe rank cutoff the metrics are computed at is deliberately absent: two runs\nscored at different cutoffs cannot be compared, which is the one thing the\nevaluation service exists to do, so it stays the installation's."},"EvaluationRunStage":{"enum":["corpus","graph","queries","queued"],"title":"EvaluationRunStage","description":"What an evaluation run is doing, and so what its counters count.\n\nA run's progress is a numerator and a denominator, and for most of a run's\nlife they are not counting queries: filling the space the queries will be\nasked against ingests every passage of the dataset, and a configuration\nthat reads a knowledge graph then prompts the model once per chunk of it.\nMeasured on a run over fifty thousand passages whose configuration read no\ngraph at all, so that the fill was the whole of it: a hundred and nineteen\nminutes of a hundred and twenty-six went on the fill, and the same fill on\na corpus of two hundred and fifty took fifty-seven seconds of a hundred and\nsixty. The share grows with the corpus, and both figures are before any\ngraph is drawn rather than with one. Naming the stage is what\nlets the unit change honestly as the run goes, rather than work of several\nkinds being reported under one name -- or, as it was, not reported at all\nuntil the questions began.\n\n``queued`` -- nothing is being counted. A run nothing has claimed carries\nit, and so does one a worker has just taken up and not yet begun filling\nfor.\n\n``corpus`` -- the dataset's passages are being written into the space the\nrun is scored in, one unit per passage. A run scored in a space that\nalready holds the corpus never enters this stage, because there is nothing\nto fill.\n\n``graph`` -- the knowledge graph the configuration reads is being built\nover that corpus. It counts nothing: its unit is a chunk of the corpus\nrather than a passage, and how many chunks a corpus comes to is settled\ninside the build. So a run here reports a stage and no figures, which says\n\"this is running and cannot say how far\" rather than leaving the passage\ncount standing at its total while an hour goes by.\n\n``queries`` -- the dataset's queries are being put through the pipeline,\none unit per query taken up by a scoring pass. A run computing both metric\nfamilies walks its dataset twice, so it reports every query twice and the\ndenominator counts them the same way.\n\nA run that has landed keeps whichever stage it was last in, which is what\nsays where a failed run stopped."},"EvaluationRunState":{"enum":["done","failed","pending","running"],"title":"EvaluationRunState","description":"Where an evaluation run stands, as a client polling it reads it.\n\n``pending`` once requested, ``running`` while it is scored, then ``done``\n(its metrics are there) or ``failed`` (it stopped without them, and says\nwhy). The stored column keeps its own matching vocabulary on the model,\nand a completeness test binds the two."},"EvaluationRunSummary":{"properties":{"id":{"type":"string"},"dataset_id":{"type":"string"},"status":{"$ref":"#/components/schemas/EvaluationRunState"},"failure_reason":{"anyOf":[{"$ref":"#/components/schemas/EvaluationRunFailure"},{"type":"null"}]},"top_k":{"type":"integer"},"query_concurrency":{"anyOf":[{"type":"integer"},{"type":"null"}]},"judge_model":{"anyOf":[{"type":"string"},{"type":"null"}]},"effective_judge_model":{"anyOf":[{"type":"string"},{"type":"null"}]},"platform_build":{"anyOf":[{"type":"string"},{"type":"null"}]},"created_at":{"type":"string"},"started_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"completed_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"metrics":{"anyOf":[{"$ref":"#/components/schemas/EvaluationMetrics"},{"type":"null"}]},"latest_reading":{"anyOf":[{"$ref":"#/components/schemas/AnswerAssessmentSummary"},{"type":"null"}]},"config_snapshot":{"type":"object"},"space_use":{"$ref":"#/components/schemas/EvaluationSpaceUse"},"progress":{"$ref":"#/components/schemas/EvaluationRunProgress"}},"type":"object","required":["id","dataset_id","status","failure_reason","top_k","query_concurrency","judge_model","effective_judge_model","platform_build","created_at","started_at","completed_at","metrics","latest_reading","config_snapshot","space_use","progress"],"title":"EvaluationRunSummary","description":"A view of one run: its identity, lifecycle and results.\n\nCarries the run's public id, the dataset it scores (by public id), its\nstatus and the timestamps that bound its execution, plus the computed\n``metrics`` once it finishes (an empty mapping until then, and for a run\nthat failed). A run that failed carries the reason it stopped for as well,\nsince a bare ``failed`` tells its reader nothing they can act on.\n\nIt also carries the conditions those numbers were produced under -- the\nretrieval depth, the ceiling it was scored under, the frozen configuration\nand the judge -- for the reason the configuration is frozen at all: a\nmeasurement whose conditions cannot be read back afterwards is neither\nreproducible nor honestly comparable with another run's. The judge appears\ntwice, as what the run named and as what actually judged it, because a run\nthat named nothing still had a judge and would otherwise be unable to say\nwhich.\n\nIt carries how far the run has got as well, which is what a client watching\none polls this view for. The status separates a run that has started from\none that has not, and a run still going from one that has landed; what it\ncannot say is what a run that is still going is doing or how much of the\nwork is behind it, so an owner two hours into one cannot tell it is nearly\nfinished from it having barely begun.\n\nIts answers may have been read again by another judge since, and the\nnewest such reading travels beside the metrics rather than in their place:\nthe metrics stay what the run's own scoring produced, and the later\nreading is shown as what it is -- another judge's opinion of the same\nanswers, under that judge's name."},"EvaluationSpaceUse":{"enum":["in_place","kept","throwaway"],"title":"EvaluationSpaceUse","description":"What a run does about the space it is scored in.\n\nFilling a space costs an ingest of the dataset's whole corpus and, for a\nconfiguration that reads a knowledge graph, a model call per chunk of it\non top -- by a distance the most expensive thing an evaluation does. Yet a\ncomparison of configurations, which is what evaluation exists for, usually\nvaries something the build never writes down. So most of that spending buys\na second corpus and a second graph that serve the same purpose as the first\nand are identical to it in nothing else: extracting a graph from a corpus\ntwice does not yield the same graph twice, and two runs meant to differ by\none readable setting end up differing by that setting and by a freshly drawn\ngraph as well.\n\n``throwaway`` is what a run has always done: fill a space of its own, score\nin it, drop it on the way out.\n\n``kept`` fills the same space and leaves it standing. What is left is not a\nthrowaway space with a reprieve -- it is an ordinary space of its owner's,\nin their listing, deleted like any other, and no longer carrying a name the\nreclaim of abandoned scoring spaces asks for.\n\n``in_place`` scores in the space the run was opened against, exactly as that\nspace stands. Nothing is filled and no graph is built, so the numbers\ndescribe the corpus and the graph already there -- which is the point, and\nalso why such a run is refused unless that corpus is the one being scored\nagainst and that graph answers what the configuration asks of it.\n\nAsked for rather than worked out. Nothing here keeps a register of which\nspaces would serve which datasets, and guessing at one would buy a saved\ngraph build at the price of silently scoring somebody's questions against\nthe wrong corpus."},"ExtractionCapabilities":{"properties":{"default_config":{"$ref":"#/components/schemas/ExtractionConfig"},"engines":{"items":{"$ref":"#/components/schemas/EngineCapabilities"},"type":"array"},"profile_revision":{"type":"string"}},"type":"object","required":["default_config","engines","profile_revision"],"title":"ExtractionCapabilities","description":"The extractor's defaults and installed OCR runtime bundles."},"ExtractionConfig":{"properties":{"engine":{"anyOf":[{"enum":["paddle","paddle_vl","tesseract","unlimited_ocr_2","vision_llm","xiaomi"]},{"type":"null"}],"default":null},"tesseract":{"anyOf":[{"$ref":"#/components/schemas/TesseractConfig"},{"type":"null"}],"default":null},"profile_revision":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},"additionalProperties":false,"type":"object","title":"ExtractionConfig","description":"Resolved extractor controls plus the accepted runtime bundle identity."},"FeedbackRating":{"enum":["down","up"],"title":"FeedbackRating","description":"What the person who asked thought of the answer."},"FeedbackReason":{"enum":["inaccurate","incomplete","irrelevant","other","outdated"],"title":"FeedbackReason","description":"Why an answer was rated down, from a short list a screen can offer.\n\nKept short on purpose: a reason that nobody picks tells an owner nothing,\nand free text is what the comment beside it is for."},"FeedbackSummary":{"properties":{"rated_up":{"type":"integer"},"rated_down":{"type":"integer"},"queries":{"type":"integer"},"down_reasons":{"additionalProperties":{"type":"integer"},"type":"object"}},"type":"object","required":["rated_up","rated_down","queries","down_reasons"],"title":"FeedbackSummary","description":"How askers rated what they got, over the period.\n\nThe share rated up means little without how many rated at all, so both\ncounts are served beside the questions they are a share of."},"Finding":{"properties":{"check":{"type":"string"},"kind":{"$ref":"#/components/schemas/FindingKind"},"severity":{"$ref":"#/components/schemas/FindingSeverity"},"resource":{"type":"string"},"message":{"type":"string"},"hint":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"statement":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},"additionalProperties":false,"type":"object","required":["check","kind","severity","resource","message"],"title":"Finding","description":"One problem a preflight check found with a Space configuration.\n\n``check`` is the slug of the check that produced it, ``kind`` places it as\nstructural / consistency / probe, and ``severity`` decides whether it\nblocks. ``resource`` names what the problem is about in terms an operator\nreads (the LLM, the embedder, the backend, the reranker), ``message``\nstates the problem, ``hint`` optionally suggests the fix, and ``statement``\ncarries the fix itself where the fix is something this platform will not\ndo. A finding blocks applying exactly when its severity is an error."},"FindingKind":{"enum":["consistency","probe","structural"],"title":"FindingKind","description":"What kind of problem a finding reports, which decides its overridability.\n\nA *structural* problem stops the config building; a *consistency* problem\nbuilds but is internally wrong; a *probe* problem is a resource that did not\nanswer when checked. Only probe problems reflect the outside world at one\nmoment, so only they may be overridden with ``force`` -- the other two are\nthe config's own fault."},"FindingSeverity":{"enum":["error","warning"],"title":"FindingSeverity","description":"How severe a finding is, which decides whether it blocks applying.\n\nAn ``ERROR`` blocks the config from being applied; a ``WARNING`` is\nsurfaced but never blocks, so a config with only warnings is clear to apply."},"ForeignCorpusDivergence":{"properties":{"checked_at":{"type":"string"},"diverged":{"type":"boolean"},"rows":{"type":"integer"},"rows_when_built":{"type":"integer"}},"type":"object","required":["checked_at","diverged","rows","rows_when_built"],"title":"ForeignCorpusDivergence","description":"Whether the corpus is still the one the side index was built from.\n\nRecorded when somebody asks, rather than watched: the owner's schema is\nthis platform's to read and nothing else, so there is no trigger to hang\non it and no column of theirs to keep a version in. What can be done is to\nask the storage the same question the pass asked it and compare the two\nanswers, which settles \"is this what we built from\" without claiming to\nknow what changed or when."},"ForgottenQueries":{"properties":{"deleted":{"type":"integer"}},"type":"object","required":["deleted"],"title":"ForgottenQueries","description":"How many of the caller's logged questions were deleted."},"GraphRebuildResult":{"properties":{"enqueued":{"type":"boolean"}},"type":"object","required":["enqueued"],"title":"GraphRebuildResult","description":"The outcome of asking for a space's knowledge graph to be rebuilt.\n\nThe rebuild runs off the request as a background build (reading the whole\ncorpus is heavy), so the endpoint answers ``202 Accepted`` with\n``enqueued`` true once the build is queued; a client then polls the status\nread until the graph is built again."},"GraphState":{"enum":["absent","building","built","stale"],"title":"GraphState","description":"A space's knowledge-graph freshness, as reported by a status read.\n\n``ABSENT`` -- the space has no graph index at all: its pipeline never named\nthe graph retriever, so nothing was ever built. ``BUILDING`` -- a build is\nin flight. ``STALE`` -- what is stored will not do and has to be rebuilt.\n``BUILT`` -- the graph is current and queryable. The three built states\nmirror the representation's status values; ``ABSENT`` is the extra case\nwhere no representation exists.\n\nWhich of them a space's graph is reported under is not read off its row\nalone, and the reasons a graph can be stale are not listed here: both are\nsettled where a stored graph's fitness is worked out, which is the one\nplace that holds the row and the account the build left together. Some of\nthose reasons are on the row and some are worked out at the moment of\nreading, and which is which is settled there too."},"GraphStatus":{"properties":{"state":{"$ref":"#/components/schemas/GraphState"},"outdated_settings":{"items":{"type":"string"},"type":"array"},"predating_settings":{"items":{"type":"string"},"type":"array"},"build_settings_known":{"type":"boolean"},"built_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"extracted_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"skipped_fragments":{"type":"integer"},"discarded_records":{"type":"integer"},"dropped_sources":{"anyOf":[{"type":"integer"},{"type":"null"}]},"empty_fragments":{"anyOf":[{"type":"integer"},{"type":"null"}]},"unrecognised_lines":{"anyOf":[{"type":"integer"},{"type":"null"}]},"reply_lines":{"anyOf":[{"type":"integer"},{"type":"null"}]},"extracted_fragments":{"anyOf":[{"type":"integer"},{"type":"null"}]},"unextracted_fragments":{"anyOf":[{"type":"integer"},{"type":"null"}]},"extracted_entities":{"type":"integer"},"resolved_entities":{"type":"integer"},"script_comparable_entities":{"anyOf":[{"type":"integer"},{"type":"null"}]},"mixed_script_entities":{"anyOf":[{"type":"integer"},{"type":"null"}]},"base_communities":{"type":"integer"},"relations_from_undeclared":{"anyOf":[{"type":"integer"},{"type":"null"}]},"relations":{"anyOf":[{"type":"integer"},{"type":"null"}]},"ambiguous_relations":{"anyOf":[{"type":"integer"},{"type":"null"}]},"reshaped_relations":{"anyOf":[{"type":"integer"},{"type":"null"}]},"relations_without_sources":{"type":"integer"},"summaries_written":{"anyOf":[{"type":"integer"},{"type":"null"}]},"mean_community_size":{"type":"number"},"looks_unresolved":{"type":"boolean"}},"type":"object","required":["state","outdated_settings","predating_settings","build_settings_known","built_at","extracted_at","skipped_fragments","discarded_records","dropped_sources","empty_fragments","unrecognised_lines","reply_lines","extracted_fragments","unextracted_fragments","extracted_entities","resolved_entities","script_comparable_entities","mixed_script_entities","base_communities","relations_from_undeclared","relations","ambiguous_relations","reshaped_relations","relations_without_sources","summaries_written","mean_community_size","looks_unresolved"],"title":"GraphStatus","description":"A space's knowledge-graph freshness for a status read.\n\n``state`` is a :class:`GraphState`. ``built_at`` records\nwhen the graph last became current, or ``null`` when it has none -- absent,\nor an index that has never finished a first build.\n\n``extracted_at`` records when the corpus behind the graph was last read.\nBringing a graph into line does not always mean reading the corpus again:\nwhere the only thing a configuration has moved is what goes into an\nentity's vector, the stored entities are embedded again and every word of\nthe graph stays as the last full build left it. Such a run moves\n``built_at`` to now and leaves this stamp where it was, so the two standing\napart is what says the last run did not read the corpus -- and the stamp\nitself answers the question that fact raises, which is how old the\nextraction is. A full build leaves the two equal. ``null`` on a graph no\nbuild has finished and on one finished before the stamp existed.\n\n``outdated_settings``, ``predating_settings`` and ``build_settings_known``\nsay *why* a graph is out of date, which the state alone cannot: a graph goes\nstale because its corpus moved on under it or because the settings it was\nbuilt under are no longer the settings its space asks for, and the two want\ndifferent sentences and different actions. Reading the two lists apart is\nwhat lets a client tell an owner which of their settings a rebuild would\nreach and which of them the graph simply predates.\n\nThe flag is what makes an empty pair readable, and it is needed because an\nempty pair means opposite things in two situations nothing else here tells\napart. Either the stored graph said what it was built under and holds\neverything asked of it -- so a graph reported out of date with nothing\nnamed is out of date for what is on its row, its corpus having moved on\nunder it -- or nothing could be read about the graph at all, and then the\nlists are empty because there was nothing to put in them rather than\nbecause there is nothing wrong. Which graphs are of the second kind is not\nlisted here: it is settled, with its reasons, where a stored graph's\naccount is taken. This is the one place that says what the three fields\npromise together; the readings elsewhere name this one rather than\nrestating it.\n\n``skipped_fragments`` says how much of the corpus the graph was built\nwithout. A chunk whose extraction call fails is dropped rather than sinking\na build that has already spent hours prompting, and reporting the number is\nwhat lets the owner of the space tell a graph built over the whole corpus\nfrom one built over most of it: entities stated only in the lost chunks are\nsimply not in the graph, and a rebuild is what recovers them.\n\n``discarded_records`` is the finer version of the same gap: entities and\nrelations the model did return and the graph was not given. Two things are\ncounted here. A record can arrive short of a record -- an entity with no\nname, an edge naming only one of its ends -- and a record that is whole can\nname something longer than a name or a label may be, the model answering\nwith prose where a name belongs. A few of either are the ordinary noise of\nan untrusted reply; a number that grows with the corpus says the model is\nanswering in a shape the graph cannot take, which is worth knowing before\nreading anything into how sparse the graph looks.\n\n``empty_fragments`` counts the fragments the model was prompted for and\nanswered for that left no entity and no relation behind -- the shortfall\nthe two counts above cannot show, since such a fragment was extracted and\nnothing in it failed. It is ``null``, rather than zero, on a graph no build\nhas finished and on one finished before the number existed: zero there\nwould say every fragment yielded something, which is the one thing it must\nnot be taken for.\n\n``unrecognised_lines`` and ``reply_lines`` are counts of lines of the\nmodel's replies rather than of fragments, so they belong to none of the\nshares of the corpus below: how many lines the extraction read no record\nin, and how many lines it was given. They are one reading, not two: the\nfirst against the second is what tells a large ``empty_fragments`` over a\nthin corpus from the same number over a model writing its records in a\nshape the extraction cannot read, and only the second of those is a prompt\nor a model to change. Either alone says neither. Both are ``null``, rather\nthan zero, on a graph no build has finished and on one finished before the\nnumbers existed: zero would say every line came back readable, and that no\nline was written at all.\n\n``extracted_fragments`` and ``unextracted_fragments`` say how the build\ndivided the corpus: how many fragments were put to the model and answered,\nand how many were never put to it at all. With ``skipped_fragments`` they\naccount for every fragment the build read. Reading them apart is the point\nof them: a build told to read part of its corpus and a build whose model\nstopped answering for part of it both leave a graph smaller than the corpus,\nand one is a saving while the other is a failure. They are ``null``, rather\nthan zero, on a graph no build has finished and on one finished before the\nnumbers existed -- zero there would read as \"put nothing to the model\",\nwhich is the one thing it must not be confused with.\n\nThe unextracted fragments were offered to the attachment, which linked each\nto whichever entities its words name. Some may have matched none, so the\nnumber says what the build declined to pay for rather than what the\nattachment achieved.\n\n``extracted_entities`` and ``resolved_entities`` describe the graph that was\nbuilt rather than what is missing from it: how many distinct names the\nextraction produced across the corpus, and how many entities those names\nresolved to. The corpus writes one thing many ways, so the second number\nbeing far below the first is the pass working; the two being nearly equal\nsays the graph has a node per spelling, which is a graph that looks full and\nlinks nothing. Reading them alongside the state is how an owner tells a thin\ngraph from a fragmented one before drawing conclusions from an answer.\n\n``summaries_written`` says how many communities the build wrote prose about.\nIt is not the same number as ``base_communities`` whenever a space has its\nsummaries written at the moment a question asks for one: the build then\nclusters exactly as it always did and writes nothing, and without this such\na graph is indistinguishable from one that spent a model call on every\ncommunity. Nor is it that number when a space does write them, since the two\ncount different sets -- this one every level of the clustering, that one the\nbase partition of the entities -- so a build that wrote a coarse level shows\nmore summaries than communities. Both names say which set they count for\nexactly that reason: read as a share of one another they are nonsense, and a\npair called ``communities`` and ``written_summaries`` invites the division.\nIt is ``null``, rather than zero, on a\ngraph no build has finished and on one finished before the number existed --\nzero there would read as \"wrote none\", which is the one thing it must not be\nconfused with.\n\n``dropped_sources`` counts the links back to the corpus the build could not\nwrite: a chunk an entity was extracted from that was gone by the time the\ngraph was stored -- a document removed or re-uploaded while the build ran --\nleaves that part of the graph with nothing to point at. It is the only place\nsuch a shortfall shows, since nothing about the entity itself is missing;\nwhat the graph loses is the ability to hand back the passage an answer rests\non, so a leg asked to send source fragments sends fewer of them. It counts\nonly what *this* build could not write, so it is not a running total of\neverything a graph is missing -- a stored graph goes on losing links after\nthe build that wrote them. ``null`` where no build recorded it, since zero\nsays every link was written.\n\n``script_comparable_entities`` and ``mixed_script_entities`` are about the\nwriting in the graph rather than its shape, and they are a pair that means\nnothing apart. The first counts the entities that state a writing system in\ntheir description and in the passages they were extracted from alike -- an\nentity nothing described carries no prose, and a description that is a bare\nfigure names no writing, so much of a graph cannot be judged this way at\nall. The second counts those of them described in a *different* writing\nsystem from their passages. The build asks its model to write in the\nlanguage of the passage, and this is the only number that says whether it\ndid: a Russian passage described in Latin is a record translated, its prose\nout of reach of the word pass that reads descriptions and, where a space\nembeds its entities' descriptions with their names, a language the corpus is\nnot in inside the vector the entity is found by. Read as a share of the\nfirst, the second says how much of the graph answers in a language its\ncorpus is not written in, which is the quality of every answer drawn from\nit; read against the resolved entities instead, a graph of bare endpoints\nwould report almost all of its extraction as agreeing without a record\nhaving been looked at. Both are ``null`` where no build recorded them, and\neach for its own reason rather than one shared one: zero on the first says\nnothing in the graph could be judged on its writing at all, while zero on\nthe second says everything that could be judged agreed. Those are opposite\nreadings, and each is an answer a build really gives, so neither may stand\nin for a number nobody recorded. They are ``null`` too on a graph whose\nbuild counted them by setting each record's name against its description,\nwhich is how they were once taken: that answers another question under the\nsame two names, and a rebuild counts them the way described here.\n\n``relations_from_undeclared`` says how many of the graph's edges leave a\nname the extraction never stated as an entity of its own. Nothing else here\nmoves when one of them appears: the line parsed, the record was kept, the\nedge was stored, and the row at the end of it is written exactly like a row\nfor an entity the model named and then said nothing about. Two things put\nan edge in this count -- a model naming something in\npassing that it never described, and a model writing the kind of the link\nwhere the first endpoint belongs, which slides the whole record along one\nfield -- and a stored graph cannot tell them apart, which is why the number\nis reported rather than acted on. Read against ``relations`` beside it, it\nis a share, and a large one says the model is writing its edges in a shape\nthe extraction asked it not to -- which is why the edge count is reported at\nall. It is ``null``, rather than zero, on a graph no build has finished and\non one finished before the number existed: zero there would say every edge\nruns from an entity the model described.\n\n``relations`` is that count: how many edges the stored graph holds. It is\n``null`` on a graph that never recorded it for the same reason, since zero\nedges is a real thing for a graph to have and is the worst of the three\nthings it could be taken for.\n\n``reshaped_relations`` is the third of that group: how many of the edges\nthe names in a reply moved off the reading their line's width alone would\nhave given. It is how hard that inference worked over the corpus, and it is\nthe only handle there is on it -- the inference repairs a line that named\nthe kind of the link where the first endpoint belongs and it turns around a\nplain line whose description happens to be exactly a declared name, and the\ntwo are the same string, so **this number adds the repairs and the mistakes\ntogether and nothing can divide them**. Large, and the inference is doing a\ngreat deal, so what it gets wrong is doing a great deal too; small, and both\nare small. ``null`` where no build recorded it, since zero says the names\nmoved nothing at all.\n\n``ambiguous_relations`` is the fourth of that group and is not a shortfall\neither:\na relation written on one line can be read at either of two widths, and\nwhere the reply declared names that fit both readings the width of the line\nis what settles which edge was meant. This says how many of the edges were\nsettled that way -- they are all in the graph, and what the number says is\nhow much of it rests on a choice the reply did not make. No line is counted\nby this and by the one above it: a line the names moved is a line they did\nnot leave open. ``null`` where no build recorded it, since zero says the\nreply settled every one of them.\n\n``relations_without_sources`` breaks the habit of everything around it: it\nis counted from the stored edges at the moment the status is asked rather\nthan read off what a build wrote down. That is the only way it could be\nright. A build can count the links it wrote and nothing more, while a\nstored graph goes on losing them afterwards -- recutting a document\nreplaces its chunks whole and removing one takes its chunks away, and the\nlinks into those chunks go with them. So this number grows under a graph\nnobody touched. It is never ``null``: a graph with no edges at all has none\nmissing a passage, and that is an answer rather than a gap.\n\n**It does not say by itself that a graph has fallen behind its corpus, and\nan owner reading it as though it did will be wrong some of the time.** An\nedge stands here for any of three reasons, and a stored graph cannot tell\nthem apart: the corpus moved under it, which is the one this number is\nwatched for; the build itself could not write the link, because the chunk\nwas gone by the time the graph was stored, which is what ``dropped_sources``\ncounts for that build alone; or the graph is old enough to predate the\nedges' links being recorded at all, in which case every edge is here and\nnone of them ever had a passage. The three are separable only by reading\nthis beside ``dropped_sources`` and ``built_at``: a number far larger than\nthe sources that build dropped, on a graph built since the links existed,\nis the corpus having moved.\n\n**It does not fall when the entities are reattached, and that is the price\nof reattaching them rather than a sign it failed.** After a recut the\nentities are pointed at the new cut again out of the words a passage and a\nname share, with no model called, so the graph stays reachable; no reading\nof shared words says two names are linked, so nothing puts an edge's links\nback short of reading the corpus again. A large number here on a reachable\ngraph is exactly the expected state between a recut and the next build.\nRead against ``relations`` beside it, it is the share of the graph's edges\nthat can no longer hand back the passage stating them -- bearing in mind\nthat the two are counted at different moments and by different means, and\nthat this one describes the graph a question would actually be answered\nfrom.\n\n``base_communities``, ``mean_community_size`` and ``looks_unresolved`` carry\nthe shape those entities came out in, and the build's own verdict on it. A\ncommunity is meant to gather a neighbourhood of linked entities, so a graph\nwith about as many communities as entities is one whose entities link to\nnothing -- which is the state a fragmented graph ends in, rather than\nsomething a reader is left to infer from the two counts above. The verdict\nis withheld where the ratio would mean nothing: on a graph with too few\nentities to judge, and on one built before the community count was recorded,\nwhich reports no communities and no mean either, never having measured them.\n\nEvery number here except ``relations_without_sources`` describes the build\nbehind the reported state, so nothing is alleged while a first build is\nstill running -- each\nreads as zero, or as null where a zero would itself be a claim, and the\nverdict reads as false -- and each stays with a stale graph, which is still\nthe graph being searched. The one counted off the rows behaves differently\non purpose: it describes whatever graph is on disk while the build runs,\nwhich is the previous one until the swap, and nothing about it is a claim\nthe build has yet to substantiate."},"GroupAuditAction":{"enum":["administrator_added","administrator_removed","created","deleted","installation_permission_granted","installation_permission_revoked","member_added","member_removed","renamed","space_role_assigned","space_role_removed"],"title":"GroupAuditAction","description":"The writes that change an installation group's access."},"GroupAuditEventPayload":{"properties":{"id":{"type":"string"},"actor_id":{"type":"string"},"group_id":{"type":"string"},"action":{"$ref":"#/components/schemas/GroupAuditAction"},"target_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"detail":{"type":"string"},"created_at":{"type":"string"}},"type":"object","required":["id","actor_id","group_id","action","target_id","detail","created_at"],"title":"GroupAuditEventPayload","description":"An attributable, recorded change to group access."},"GroupKind":{"enum":["administrators","everyone","external","local"],"title":"GroupKind","description":"How a group gets its members."},"GroupMemberPayload":{"properties":{"id":{"type":"string"},"email":{"type":"string"}},"type":"object","required":["id","email"],"title":"GroupMemberPayload","description":"An account in a group's roster."},"GroupNamePayload":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1}},"type":"object","required":["name"],"title":"GroupNamePayload","description":"The display name of a local group."},"GroupRolePayload":{"properties":{"role":{"$ref":"#/components/schemas/SpaceRole"}},"type":"object","required":["role"],"title":"GroupRolePayload","description":"The role a group receives in a space."},"GroupSpaceChoice":{"properties":{"id":{"type":"string"},"name":{"type":"string"}},"type":"object","required":["id","name"],"title":"GroupSpaceChoice","description":"Space metadata needed to choose a group assignment."},"GroupSpaceRolePayload":{"properties":{"space_id":{"type":"string"},"space_name":{"type":"string"},"role":{"$ref":"#/components/schemas/SpaceRole"}},"type":"object","required":["space_id","space_name","role"],"title":"GroupSpaceRolePayload","description":"A group's assignment on one space."},"IndexBuildState":{"enum":["building","built","stale"],"title":"IndexBuildState","description":"Whether one derived index can answer, as a status poll reports it.\n\n``building`` -- a rebuild is in flight. ``built`` -- current and\nqueryable. ``stale`` -- it needs a rebuild before it can answer for the\ncorpus. The words a graph's freshness is read in, less the one for a space\nthat has no graph at all: a row is an index that exists. The stored column\nkeeps its own matching vocabulary on the model, and a completeness test\nbinds the two."},"InitialSpaceCreators":{"enum":["creators","everyone","skip"],"title":"InitialSpaceCreators","description":"Which users receive the first space-creation grant."},"InitialSpaceCreatorsPayload":{"properties":{"target":{"$ref":"#/components/schemas/InitialSpaceCreators"}},"type":"object","required":["target"],"title":"InitialSpaceCreatorsPayload","description":"The access choice made in the installation wizard."},"InstallationAccessPayload":{"properties":{"can_create_space":{"type":"boolean"},"can_manage_groups":{"type":"boolean"},"is_superadmin":{"type":"boolean"}},"type":"object","required":["can_create_space","can_manage_groups","is_superadmin"],"title":"InstallationAccessPayload","description":"The authenticated user's current installation permissions."},"InstallationSetting":{"properties":{"setting":{"type":"string"},"label_key":{"type":"string"},"surface":{"type":"string"},"value":{"type":"integer"},"reason":{"type":"string"}},"type":"object","required":["setting","label_key","surface","value","reason"],"title":"InstallationSetting","description":"One number this installation settles for every knowledge base.\n\n``setting`` is the stable id, ``label_key`` names the translatable label to\nshow it under, and ``surface`` says where the explanation belongs -- the\nscreen someone would have looked for the knob on. ``value`` is what this\ninstallation actually runs at, which is half the answer on its own: a reader\nwho can see the number can at least tell whether it is the one they wanted.\n``reason`` is the other half, and says both why the setting is not theirs\nand what to reach for instead, so the explanation ends somewhere useful\nrather than in a refusal."},"JsonSchemaRule":{"properties":{"schema_json":{"type":"string","maxLength":32768,"minLength":1},"dialect":{"enum":["2020-12"],"default":"2020-12"}},"additionalProperties":false,"type":"object","required":["schema_json"],"title":"JsonSchemaRule","description":"A JSON object or boolean schema; external references are unsupported."},"LatencySummary":{"properties":{"p50_ms":{"anyOf":[{"type":"number"},{"type":"null"}]},"p95_ms":{"anyOf":[{"type":"number"},{"type":"null"}]},"stages":{"items":{"$ref":"#/components/schemas/StageLatency"},"type":"array"}},"type":"object","required":["p50_ms","p95_ms","stages"],"title":"LatencySummary","description":"How long questions took, over the part of the period the log holds.\n\nEvery figure is ``None`` where no question was logged in that part."},"LogDatasetPayload":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1},"query_ids":{"items":{"type":"string","format":"uuid"},"type":"array","maxItems":500,"minItems":1}},"type":"object","required":["name","query_ids"],"title":"LogDatasetPayload","description":"Collect an evaluation dataset out of chosen logged questions."},"LoggedModelCall":{"properties":{"model":{"type":"string"},"operation":{"$ref":"#/components/schemas/ModelOperation"},"input_tokens":{"type":"integer"},"output_tokens":{"type":"integer"},"cost_usd":{"anyOf":[{"type":"number"},{"type":"null"}]},"estimated":{"type":"boolean"},"stage":{"anyOf":[{"type":"string"},{"type":"null"}]}},"type":"object","required":["model","operation","input_tokens","output_tokens","cost_usd","estimated","stage"],"title":"LoggedModelCall","description":"One model call a logged question made."},"LoggedQuery":{"properties":{"id":{"type":"string"},"asked_at":{"type":"string"},"entrypoint":{"$ref":"#/components/schemas/QueryEntrypoint"},"mode":{"$ref":"#/components/schemas/QueryMode"},"streamed":{"type":"boolean"},"outcome":{"$ref":"#/components/schemas/QueryOutcome"},"failure":{"anyOf":[{"$ref":"#/components/schemas/QueryFailure"},{"type":"null"}]},"latency_ms":{"type":"number"},"cost_usd":{"anyOf":[{"type":"number"},{"type":"null"}]},"source_count":{"type":"integer"},"rating":{"anyOf":[{"$ref":"#/components/schemas/FeedbackRating"},{"type":"null"}]},"text_stored":{"type":"boolean"},"query":{"anyOf":[{"type":"string"},{"type":"null"}]}},"type":"object","required":["id","asked_at","entrypoint","mode","streamed","outcome","failure","latency_ms","cost_usd","source_count","rating","text_stored","query"],"title":"LoggedQuery","description":"One logged question, as the list shows it.\n\n``query`` is the question as it was asked where the space kept it and the\ncaller holds the grant to read question texts; ``None`` otherwise, and\n``text_stored`` says which of the two it is."},"LoggedQueryDetail":{"properties":{"query":{"$ref":"#/components/schemas/LoggedQuery"},"stages":{"additionalProperties":{"type":"number"},"type":"object"},"calls":{"items":{"$ref":"#/components/schemas/LoggedModelCall"},"type":"array"},"sources":{"items":{"$ref":"#/components/schemas/LoggedSource"},"type":"array"},"agent_tool_calls":{"anyOf":[{"type":"integer"},{"type":"null"}]},"config_version":{"type":"string"},"feedback_reason":{"anyOf":[{"$ref":"#/components/schemas/FeedbackReason"},{"type":"null"}]},"feedback_comment":{"type":"string"},"postgeneration_trace":{"anyOf":[{"$ref":"#/components/schemas/PostGenerationTrace"},{"type":"null"}],"default":null},"branch_trace":{"items":{"$ref":"#/components/schemas/BranchExecution"},"type":"array","default":[]},"dictionary_trace":{"items":{"$ref":"#/components/schemas/DictionaryTransformExecution"},"type":"array","default":[]},"evidence_coverage":{"items":{"$ref":"#/components/schemas/CoverageTrace"},"type":"array","default":[]},"reranker_trace":{"items":{"$ref":"#/components/schemas/RerankerExecution"},"type":"array","default":[]}},"type":"object","required":["query","stages","calls","sources","agent_tool_calls","config_version","feedback_reason","feedback_comment"],"title":"LoggedQueryDetail","description":"One logged question taken apart: stages, calls, passages, rating."},"LoggedSource":{"properties":{"chunk":{"type":"string"},"document_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"document_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"rank":{"type":"integer"},"score":{"anyOf":[{"type":"number"},{"type":"null"}]},"sent_to_model":{"type":"boolean"}},"type":"object","required":["chunk","document_id","document_name","rank","score","sent_to_model"],"title":"LoggedSource","description":"One passage a logged question reached, with its document named."},"LoginPayload":{"properties":{"email":{"type":"string"},"password":{"type":"string"}},"type":"object","required":["email","password"],"title":"LoginPayload","description":"Login request body: the email login identifier and the password."},"McpAuthorizationSummary":{"properties":{"id":{"type":"string"},"client_name":{"type":"string"},"client_host":{"anyOf":[{"type":"string"},{"type":"null"}]},"knowledge_bases":{"items":{"$ref":"#/components/schemas/ConnectedKnowledgeBase"},"type":"array"},"granted_at":{"type":"string"},"expires_at":{"type":"string"},"last_used_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"standing":{"$ref":"#/components/schemas/CredentialStanding"}},"type":"object","required":["id","client_name","client_host","knowledge_bases","granted_at","expires_at","last_used_at","standing"],"title":"McpAuthorizationSummary","description":"One connected agent host, as the person who connected it sees it.\n\nBuilt for a single question -- who did I open my knowledge up to, and should\nI take it back -- so everything a person needs to answer that is here and\nnothing else is. Both halves of the client's identity, because a manifest's\nname can be copied verbatim and only its host cannot; what was handed over;\nand the three moments that say whether the connection is worth keeping: when\nit was granted, when it lapses on its own, and when the agent last used it.\n\nWithdrawn and lapsed connections are listed alongside live ones. A person\nasking what they have opened up is owed the whole history -- a connection\nthat has quietly stopped working still says which agent host once held a\ncorpus -- so the fact is reported as the connection's standing rather than\nby leaving rows out."},"MemberAddPayload":{"properties":{"email":{"type":"string"},"role":{"$ref":"#/components/schemas/SpaceRole"}},"type":"object","required":["email","role"],"title":"MemberAddPayload","description":"Request body to add an existing user to a space as a member.\n\nThe user is named by ``email`` (looked up among existing accounts) and given\n``role`` on the space. ``role`` is one of the membership roles, validated by\nthe enum, so an unknown role is rejected before the usecase runs."},"MemberPayload":{"properties":{"id":{"type":"string"},"email":{"type":"string"},"role":{"$ref":"#/components/schemas/SpaceRole"},"reads_query_texts":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null}},"type":"object","required":["id","email","role"],"title":"MemberPayload","description":"A safe view of one membership row: who the member is and their role.\n\nIdentifies the member by the user's ``public_id`` (a UUID string), never the\ninternal int PK, and carries their login email and the role they hold on the\nspace. This is what the roster and the role-change response return, and it\ndeliberately has nowhere to put a secret: a listing renders many of these,\nand a field that must stay empty by discipline eventually does not."},"MemberRolePayload":{"properties":{"role":{"$ref":"#/components/schemas/SpaceRole"}},"type":"object","required":["role"],"title":"MemberRolePayload","description":"Request body to change a member's role on a space."},"MetadataCondition":{"properties":{"field":{"type":"string","maxLength":64,"minLength":1,"examples":["department","year"]},"operator":{"$ref":"#/components/schemas/MetadataFilterOperator"},"value":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"number"},{"type":"string"},{"items":{"anyOf":[{"type":"integer"},{"type":"number"},{"type":"string"}]},"type":"array"}]}},"additionalProperties":false,"type":"object","required":["field","operator","value"],"title":"MetadataCondition","description":"One test a document has to pass to be searched at all.\n\nThe field is named as its space declared it -- without the namespace the\nindex writes it under, which is the store's business and not a caller's."},"MetadataFieldSpec":{"properties":{"name":{"type":"string","maxLength":64,"minLength":1,"pattern":"^\\w[\\w-]*\\Z","examples":["department","year","in_force"]},"field_type":{"$ref":"#/components/schemas/MetadataFieldType"},"indexed":{"type":"boolean","default":true}},"additionalProperties":false,"type":"object","required":["name","field_type"],"title":"MetadataFieldSpec","description":"One field a space declares about the documents in it.\n\nThe name is the key documents carry it under, the type is what every\ndocument must give for it, and ``indexed`` says whether selecting on it is\nmeant to be cheap. A declared field that is not indexed is still a\ncontract -- its type is still enforced, and a filter builder still shows it\n-- so the flag says how the corpus pays for the field, not whether the\nfield exists."},"MetadataFieldType":{"enum":["boolean","number","string","string_list"],"title":"MetadataFieldType","description":"The type a declared metadata field holds, named for a person.\n\nThese are the types a filter can be built over, which is why the set is\nthis short: a string and a list of strings compare by equality and\nmembership, a number by ordering, a flag by being set. A date has no type\nof its own yet -- until dates are compared as dates rather than as text,\ncalling one a date would promise an ordering nothing implements -- so a\ncorpus that dates its documents describes them with a number (a year) or a\nstring (an ISO date) and reads exactly what it stored."},"MetadataFilter":{"properties":{"join":{"default":"all","$ref":"#/components/schemas/MetadataFilterJoin"},"conditions":{"items":{"$ref":"#/components/schemas/MetadataCondition"},"type":"array","default":[]},"groups":{"items":{"$ref":"#/components/schemas/MetadataFilter"},"type":"array","default":[]}},"additionalProperties":false,"type":"object","title":"MetadataFilter","description":"A group of conditions, and the groups nested under it.\n\nOne shape for the whole tree rather than a tagged union of \"condition\" and\n\"group\": every node joins its own conditions and its own sub-groups the\nsame way, so a client builds a filter by nesting one thing, and a store\ntranslates one thing. A leaf is simply a group whose ``groups`` is empty.\n\nThe join applies to conditions and sub-groups together -- a group saying\n\"any\" is satisfied by any one of its conditions or any one of its\nsub-groups -- which is what lets \"this department, and either of these two\nyears\" be written with one level of nesting."},"MetadataFilterJoin":{"enum":["all","any"],"title":"MetadataFilterJoin","description":"How the members of a filter group are combined.\n\n``all`` narrows -- every member has to hold -- and ``any`` widens: one is\nenough. A group states which it is rather than leaving it to the order the\nmembers were written in, since a tree of conditions with an implied\nprecedence is a tree nobody reads the same way twice."},"MetadataFilterOperator":{"enum":["contains","eq","one_of"],"title":"MetadataFilterOperator","description":"How a condition compares a field to the value it names.\n\nThree, and each answers one question. ``eq``: the field is exactly this\nvalue. ``one_of``: the field is any of these values. ``contains``: the\nfield is a list and this value is in it. Which of them a field admits\nfollows from the type its space declared for it, so a filter can never ask\na flag whether it is one of a list of tags."},"MetadataSchema":{"properties":{"fields":{"items":{"$ref":"#/components/schemas/MetadataFieldSpec"},"type":"array","default":[]}},"additionalProperties":false,"type":"object","title":"MetadataSchema","description":"Everything a space declares about its documents' metadata.\n\nAn envelope around the list rather than a bare list: it is read as a whole\n(a filter builder draws every field from one place) and written as a whole\n(a declaration is replaced, never patched field by field), and a named\nobject leaves room for what a corpus may later say about its fields as a\nset rather than one at a time. A space that has declared nothing carries an\nempty one, which is what every space starts as."},"MetricDelta":{"properties":{"metric":{"type":"string"},"run_a":{"anyOf":[{"type":"number"},{"type":"null"}]},"run_b":{"anyOf":[{"type":"number"},{"type":"null"}]},"delta":{"anyOf":[{"type":"number"},{"type":"null"}]}},"type":"object","required":["metric","run_a","run_b","delta"],"title":"MetricDelta","description":"One metric's value on each run and the change from the first to second.\n\n``run_a`` and ``run_b`` are the metric's value on the first and second run,\neach ``None`` when that run did not produce it (its family was skipped, or\nthe metric had no verdict to average). ``delta`` is ``run_b - run_a`` only\nwhen both sides carry a value; it stays ``None`` when either side is\nmissing, so an absent delta means \"not comparable\" rather than \"no change\"."},"MintedApiKey":{"properties":{"raw_key":{"type":"string"},"id":{"type":"string"},"prefix":{"type":"string"},"name":{"type":"string"},"scopes":{"items":{"$ref":"#/components/schemas/ApiKeyScopeSummary"},"type":"array"},"created_at":{"type":"string"},"expires_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"purpose":{"$ref":"#/components/schemas/ApiKeyPurpose"}},"type":"object","required":["raw_key","id","prefix","name","scopes","created_at","expires_at","purpose"],"title":"MintedApiKey","description":"The one-time create response: the raw key plus a safe summary.\n\n``raw_key`` is the full ``<prefix>.<secret>`` value, shown exactly once at\ncreation and never recoverable afterwards (only its hash is stored). The\nsummary mirrors what the listing endpoint returns for the same key,\nincluding the per-space scopes it was granted."},"ModelOperation":{"enum":["chat","embed"],"title":"ModelOperation","description":"What kind of call a question made to a model.\n\n``chat`` is a completion, in any manner of address; ``embed`` is an\nembedding of the question for a remote embedder. How each is priced is\nsaid where calls are priced."},"ModelSpend":{"properties":{"model":{"type":"string"},"operation":{"$ref":"#/components/schemas/ModelOperation"},"calls":{"type":"integer"},"input_tokens":{"type":"integer"},"output_tokens":{"type":"integer"},"cost_usd":{"type":"number"},"unpriced_calls":{"type":"integer"}},"type":"object","required":["model","operation","calls","input_tokens","output_tokens","cost_usd","unpriced_calls"],"title":"ModelSpend","description":"What one model was asked, and what that cost, over the period."},"ModelUsage":{"properties":{"model":{"type":"string"},"operation":{"$ref":"#/components/schemas/ModelOperation"},"input_tokens":{"type":"integer"},"output_tokens":{"type":"integer"},"cost_usd":{"anyOf":[{"type":"number"},{"type":"null"}]},"estimated":{"type":"boolean","default":false},"stage":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},"type":"object","required":["model","operation","input_tokens","output_tokens","cost_usd"],"title":"ModelUsage","description":"One call a question made to a model, and what it cost.\n\n``cost_usd`` is what the call comes to, or ``None`` where no price is\nknown for it -- a model served locally, a name the price table does not\ncarry, an embedding connection that states no price. Such a call is\n*unpriced*, whatever kind of call it was, and that is the one meaning the\nword has everywhere the log counts unpriced calls. How each kind is\npriced is said where calls are priced. ``estimated`` marks a call whose\ntoken counts the provider did not report and the platform counted itself."},"NodeSpec":{"properties":{"node":{"type":"string"},"params":{"type":"object","default":{}}},"type":"object","required":["node"],"title":"NodeSpec","description":"One node in a space's retrieval pipeline.\n\nA pipeline is a small graph of typed nodes -- the chunker, each retriever,\nthe fusion step, any rerankers, and an optional generator. Every position\nis described by the same shape: a ``node`` name naming which implementation\nto build (``fixed``, ``dense``, ``rrf``, ``llm``, ...) and a free-form\n``params`` map of its settings. Keeping one uniform shape across all\npositions (rather than a bespoke struct per position) lets the validator\nand, later, the executor treat the pipeline as a homogeneous list of nodes\nand look each name up in one registry."},"OnboardingCheck":{"properties":{"name":{"type":"string"},"status":{"enum":["ready","unavailable","unknown"]},"detail":{"type":"string"}},"type":"object","required":["name","status","detail"],"title":"OnboardingCheck","description":"One observed service check, distinct from corpus readiness."},"OnboardingDemoRequest":{"properties":{"language":{"enum":["en","ru"]}},"type":"object","required":["language"],"title":"OnboardingDemoRequest","description":"Choose the language of the first retained demo document."},"OnboardingDiagnostics":{"properties":{"checks":{"items":{"$ref":"#/components/schemas/OnboardingCheck"},"type":"array"},"resources":{"items":{"$ref":"#/components/schemas/OnboardingResource"},"type":"array"}},"type":"object","required":["checks","resources"],"title":"OnboardingDiagnostics","description":"Private service observations."},"OnboardingLlmRequest":{"properties":{"space_id":{"type":"string","format":"uuid"},"llm_config":{"$ref":"#/components/schemas/SpaceLLMConfig"}},"type":"object","required":["space_id","llm_config"],"title":"OnboardingLlmRequest","description":"Connect an already available model to an ordinary space."},"OnboardingProgress":{"properties":{"step":{"enum":["checks","complete","demo","model","own-documents"]},"completed":{"type":"boolean"},"language":{"enum":["en","ru"]},"llm_skipped":{"type":"boolean"},"demo_space_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"demo_document_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"own_space_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"questions":{"items":{"type":"string"},"type":"array"}},"type":"object","required":["step","completed","language","llm_skipped","demo_space_id","demo_document_id","own_space_id","questions"],"title":"OnboardingProgress","description":"The signed-in person's retained setup work, without credentials."},"OnboardingProgressUpdate":{"properties":{"step":{"enum":["checks","complete","demo","model","own-documents"]},"language":{"enum":["en","ru"]},"llm_skipped":{"type":"boolean"}},"additionalProperties":false,"type":"object","title":"OnboardingProgressUpdate","description":"Change navigation preferences without assigning server entities."},"OnboardingResource":{"properties":{"source":{"enum":["container","external_model_server","host","runtime"]},"status":{"enum":["available","unavailable","unknown"]},"detail":{"type":"string"},"cpu_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null},"memory_bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null},"accelerator":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},"type":"object","required":["source","status","detail"],"title":"OnboardingResource","description":"Resources observed at a named execution boundary."},"OnboardingSpaceRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1},"source_space_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"default":null}},"type":"object","required":["name"],"title":"OnboardingSpaceRequest","description":"Create the person's ordinary space, optionally reusing owned settings."},"OperationKind":{"enum":["activate","deactivate","delete","reindex"],"title":"OperationKind","description":"Document intents recorded by the lifecycle coordinator."},"OperationState":{"enum":["awaiting_original","cancelled","failed","publishing","queued","running","succeeded"],"title":"OperationState","description":"Durable progress, separate from the document's ingest status."},"OriginalAcceptance":{"properties":{"document_id":{"type":"string","format":"uuid"},"operation_id":{"type":"string","format":"uuid"},"state":{"$ref":"#/components/schemas/OperationState"}},"type":"object","required":["document_id","operation_id","state"],"title":"OriginalAcceptance","description":"Safe durable command facts, independent of upload or broker ACK."},"OriginalDocumentState":{"properties":{"document_id":{"type":"string","format":"uuid"},"accepted_revision_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]},"accepted_source_digest":{"anyOf":[{"type":"string"},{"type":"null"}]},"requested_active":{"type":"boolean"},"is_active":{"type":"boolean"},"intent_version":{"type":"integer"},"operation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}]}},"type":"object","required":["document_id","accepted_revision_id","accepted_source_digest","requested_active","is_active","intent_version","operation_id"],"title":"OriginalDocumentState","description":"Concurrency and accepted-source facts without storage coordinates."},"OriginalUploadForm":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"metadata":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},"type":"object","title":"OriginalUploadForm","description":"Optional multipart text parts accompanying original bytes."},"OutboundRoute":{"properties":{"url":{"anyOf":[{"type":"string","pattern":"^(?:http|https|socks5|socks5h)://(?:\\[[0-9A-Fa-f:.]+\\]|[A-Za-z0-9](?:[A-Za-z0-9._~-]*[A-Za-z0-9])?)(?::[0-9]{1,5})?\\Z","examples":["http://proxy.internal:3128","socks5h://10.0.0.5:1080"]},{"type":"null"}],"default":null},"username":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"default":null},"password":{"type":"string","format":"password","default":"","writeOnly":true}},"additionalProperties":false,"type":"object","title":"OutboundRoute","description":"A proxy an outgoing HTTP client reaches the outside world through.\n\nA route with no ``url`` names no proxy, which is the ordinary case: the\nclient dials the service directly. When a ``url`` is set, every request the\nclient makes is carried by that proxy instead.\n\n``username`` and ``password`` authenticate to the proxy itself -- they are\nnothing to do with the service on the far side, whose own credentials stay\nwhere they were. Many proxies want none, so both are optional. The password\nis a secret on the same write-only terms as a provider key: it is blanked\nbefore the configuration is ever returned to a client, and an update that\nleaves it blank keeps the stored one."},"OutcomeCount":{"properties":{"outcome":{"$ref":"#/components/schemas/QueryOutcome"},"failure":{"anyOf":[{"$ref":"#/components/schemas/QueryFailure"},{"type":"null"}]},"queries":{"type":"integer"}},"type":"object","required":["outcome","failure","queries"],"title":"OutcomeCount","description":"How many questions ended one way, and why where they failed."},"Page_AccessGroupPayload_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/AccessGroupPayload"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[AccessGroupPayload]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_AnswerAssessmentSummary_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/AnswerAssessmentSummary"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[AnswerAssessmentSummary]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_ApiKeySummary_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/ApiKeySummary"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[ApiKeySummary]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_ChunkSummaryPayload_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/ChunkSummaryPayload"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[ChunkSummaryPayload]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_ComparedQuery_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/ComparedQuery"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[ComparedQuery]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_CorpusDocument_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/CorpusDocument"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[CorpusDocument]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_DictionaryBuild_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/DictionaryBuild"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[DictionaryBuild]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_DictionaryEntry_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/DictionaryEntry"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[DictionaryEntry]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_DocumentSummaryPayload_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/DocumentSummaryPayload"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[DocumentSummaryPayload]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_EvaluationDatasetSummary_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/EvaluationDatasetSummary"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[EvaluationDatasetSummary]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_EvaluationQueryOutcomeSummary_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/EvaluationQueryOutcomeSummary"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[EvaluationQueryOutcomeSummary]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_EvaluationQuery_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/EvaluationQuery"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[EvaluationQuery]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_EvaluationRunSummary_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/EvaluationRunSummary"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[EvaluationRunSummary]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_GroupAuditEventPayload_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/GroupAuditEventPayload"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[GroupAuditEventPayload]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_GroupMemberPayload_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/GroupMemberPayload"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[GroupMemberPayload]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_GroupSpaceChoice_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/GroupSpaceChoice"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[GroupSpaceChoice]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_GroupSpaceRolePayload_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/GroupSpaceRolePayload"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[GroupSpaceRolePayload]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_LoggedQuery_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/LoggedQuery"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[LoggedQuery]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_McpAuthorizationSummary_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/McpAuthorizationSummary"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[McpAuthorizationSummary]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_MemberPayload_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/MemberPayload"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[MemberPayload]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_RubricSummary_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/RubricSummary"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[RubricSummary]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_RubricVersion_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/RubricVersion"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[RubricVersion]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_SpaceGroupMemberPayload_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/SpaceGroupMemberPayload"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[SpaceGroupMemberPayload]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_SpaceSummaryPayload_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/SpaceSummaryPayload"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[SpaceSummaryPayload]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Page_TextAccess_":{"properties":{"number":{"type":"integer"},"object_list":{"items":{"$ref":"#/components/schemas/TextAccess"},"type":"array"}},"type":"object","required":["number","object_list"],"title":"Page[TextAccess]","description":"Default page model for serialization.\n\nCan be used when using pagination with ``django-modern-rest``.\n\nAttributes:\n    number: Page number. For example: ``5`` page out of ``10`` total pages.\n    object_list: Generic sequence of objects on this page."},"Paginated_AccessGroupPayload_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_AccessGroupPayload_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[AccessGroupPayload]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_AnswerAssessmentSummary_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_AnswerAssessmentSummary_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[AnswerAssessmentSummary]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_ApiKeySummary_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_ApiKeySummary_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[ApiKeySummary]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_ChunkSummaryPayload_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_ChunkSummaryPayload_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[ChunkSummaryPayload]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_ComparedQuery_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_ComparedQuery_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[ComparedQuery]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_CorpusDocument_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_CorpusDocument_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[CorpusDocument]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_DictionaryBuild_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_DictionaryBuild_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[DictionaryBuild]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_DictionaryEntry_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_DictionaryEntry_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[DictionaryEntry]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_DocumentSummaryPayload_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_DocumentSummaryPayload_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[DocumentSummaryPayload]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_EvaluationDatasetSummary_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_EvaluationDatasetSummary_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[EvaluationDatasetSummary]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_EvaluationQueryOutcomeSummary_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_EvaluationQueryOutcomeSummary_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[EvaluationQueryOutcomeSummary]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_EvaluationQuery_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_EvaluationQuery_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[EvaluationQuery]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_EvaluationRunSummary_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_EvaluationRunSummary_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[EvaluationRunSummary]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_GroupAuditEventPayload_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_GroupAuditEventPayload_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[GroupAuditEventPayload]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_GroupMemberPayload_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_GroupMemberPayload_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[GroupMemberPayload]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_GroupSpaceChoice_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_GroupSpaceChoice_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[GroupSpaceChoice]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_GroupSpaceRolePayload_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_GroupSpaceRolePayload_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[GroupSpaceRolePayload]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_LoggedQuery_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_LoggedQuery_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[LoggedQuery]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_McpAuthorizationSummary_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_McpAuthorizationSummary_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[McpAuthorizationSummary]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_MemberPayload_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_MemberPayload_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[MemberPayload]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_RubricSummary_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_RubricSummary_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[RubricSummary]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_RubricVersion_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_RubricVersion_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[RubricVersion]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_SpaceGroupMemberPayload_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_SpaceGroupMemberPayload_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[SpaceGroupMemberPayload]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_SpaceSummaryPayload_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_SpaceSummaryPayload_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[SpaceSummaryPayload]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"Paginated_TextAccess_":{"properties":{"count":{"type":"integer"},"num_pages":{"type":"integer"},"per_page":{"type":"integer"},"page":{"$ref":"#/components/schemas/Page_TextAccess_"}},"type":"object","required":["count","num_pages","per_page","page"],"title":"Paginated[TextAccess]","description":"Helper type to serialize the default ``Paginator`` object.\n\nDjango already ships a pagination system, we don't want to replicate it.\nSo, we only provide metadata.\nSee :class:`django.core.paginator.Paginator` for the exact API.\n\nAttributes:\n    count: Total count of all objects that we are paginating.\n    num_pages: Total number of pages that we got after pagination.\n    per_page: Number of objects per one page.\n    page: :class:`Page` object that contains paginated objects on this page."},"PairedAnswerMetric":{"properties":{"metric":{"$ref":"#/components/schemas/AnswerMetric"},"paired_queries":{"type":"integer"},"estimate":{"anyOf":[{"$ref":"#/components/schemas/PairedEstimate"},{"type":"null"}]},"improved":{"type":"integer"},"worsened":{"type":"integer"},"unchanged":{"type":"integer"}},"type":"object","required":["metric","paired_queries","estimate","improved","worsened","unchanged"],"title":"PairedAnswerMetric","description":"One answer metric over the questions both runs have a verdict on.\n\nThe same account of a trade as a ranking metric gives, over the questions\nwhose answers both runs' readings gave this metric a verdict. That set is\nthe metric's own: a question with no reference answer has no correctness\nand still has a faithfulness, and a judge's reply that was no verdict\nleaves that one metric without one."},"PairedAnswers":{"properties":{"judge_model_a":{"type":"string"},"judge_model_b":{"type":"string"},"paired_queries":{"type":"integer"},"unpaired_queries":{"type":"integer"},"empty_a":{"type":"integer"},"empty_b":{"type":"integer"},"metrics":{"items":{"$ref":"#/components/schemas/PairedAnswerMetric"},"type":"array"}},"type":"object","required":["judge_model_a","judge_model_b","paired_queries","unpaired_queries","empty_a","empty_b","metrics"],"title":"PairedAnswers","description":"Two runs' answers compared question by question, metric by metric.\n\nWhose verdicts are paired, and how an empty answer enters them, is set out\nin :mod:`server.apps.main.logic.query_comparison.answers`."},"PairedEstimate":{"properties":{"mean_a":{"type":"number"},"mean_b":{"type":"number"},"delta":{"type":"number"},"interval_a":{"$ref":"#/components/schemas/ConfidenceInterval"},"interval_b":{"$ref":"#/components/schemas/ConfidenceInterval"},"delta_interval":{"$ref":"#/components/schemas/ConfidenceInterval"},"p_value":{"anyOf":[{"type":"number"},{"type":"null"}]},"verdict":{"$ref":"#/components/schemas/SignificanceVerdict"}},"type":"object","required":["mean_a","mean_b","delta","interval_a","interval_b","delta_interval","p_value","verdict"],"title":"PairedEstimate","description":"One metric's means over the paired questions, bounds and verdict.\n\nThe intervals say how large each mean and the difference could plausibly\nbe; the verdict says whether the difference could be chance at all, and is\nread off the p-value rather than off whether the interval leaves zero out.\nWith few questions the two can disagree, and where they do the verdict is\nthe one to believe: an interval redrawn from a handful of questions can be\nfar narrower than what the handful supports."},"PairedMetric":{"properties":{"metric":{"$ref":"#/components/schemas/RankingMetric"},"estimate":{"$ref":"#/components/schemas/PairedEstimate"},"improved":{"type":"integer"},"worsened":{"type":"integer"},"unchanged":{"type":"integer"}},"type":"object","required":["metric","estimate","improved","worsened","unchanged"],"title":"PairedMetric","description":"One ranking metric over the questions both runs ranked.\n\nRead together the fields are the one-line account of a trade: so many\nquestions better, so many worse, the mean moved by this much, and whether\nthat movement is larger than chance would give."},"PipelineChangeCancelResult":{"properties":{"reverting":{"type":"boolean"}},"type":"object","required":["reverting"],"title":"PipelineChangeCancelResult","description":"The outcome of cancelling a configuration change a space still owes.\n\nWhere no rebuild had moved the space yet, the change is dropped and the\nspace runs what it stored all along: ``reverting`` false, answered 200.\nWhere a rebuild had already stored the change -- and possibly recut part of\nthe corpus under it -- the space is rebuilt back to the configuration the\nchange moved it from: ``reverting`` true, answered 202, and watched through\nthe status view like any rebuild."},"PipelineChangeSummary":{"properties":{"chunk_changed":{"type":"boolean"},"added_retrievers":{"items":{"type":"string"},"type":"array"},"removed_retrievers":{"items":{"type":"string"},"type":"array"}},"type":"object","required":["chunk_changed","added_retrievers","removed_retrievers"],"title":"PipelineChangeSummary","description":"A machine-usable summary of what a proposed config changes.\n\nNames the parts of the pipeline a move would touch, so a client can describe\nthe change without re-deriving it: whether the chunker changed (which\ninvalidates every chunk), and which retriever kinds the proposal adds or\ndrops relative to the current config."},"PipelineConfig":{"properties":{"chunk":{"$ref":"#/components/schemas/NodeSpec"},"retrievers":{"items":{"$ref":"#/components/schemas/NodeSpec"},"type":"array"},"fusion":{"$ref":"#/components/schemas/NodeSpec"},"rerank":{"items":{"$ref":"#/components/schemas/NodeSpec"},"type":"array"},"generate":{"anyOf":[{"$ref":"#/components/schemas/NodeSpec"},{"type":"null"}]},"query_transform":{"items":{"$ref":"#/components/schemas/NodeSpec"},"type":"array","default":[]},"embed_batch_size":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"default":null},"postgeneration":{"items":{"$ref":"#/components/schemas/PostGenerationCheck"},"type":"array","default":[]},"dictionary_extraction":{"$ref":"#/components/schemas/DictionaryExtractionConfig"},"query_branches":{"anyOf":[{"items":{"$ref":"#/components/schemas/QueryBranchConfig"},"type":"array"},{"type":"null"}],"default":null},"branch_fusion":{"$ref":"#/components/schemas/NodeSpec"},"branch_concurrency":{"type":"integer","minimum":1,"default":2},"comparison":{"$ref":"#/components/schemas/RunComparisonSettings"}},"type":"object","required":["chunk","retrievers","fusion","rerank","generate"],"title":"PipelineConfig","description":"Framework-free description of a space's whole retrieval pipeline.\n\nOne typed graph a space carries and the resolver builds its executors from:\nhow the document is chunked, how the query is transformed before retrieval,\nwhich retrievers query it, how their rankings are fused, any rerankers, and\nwhether an answer is generated. The engine still takes a ``ChunkingConfig``\nof its own, read off the chunk node, because how a document is cut is the\none part of a pipeline the storage primitive has to know about.\n\nRepresentations are deliberately absent: they are the derived indexes the\nretriever set implies (one per retriever kind), not something the pipeline\nlists. Naming a ``dense`` and a ``bm25`` retriever is what calls those two\nrepresentations into being.\n\nOrdered query transforms run before retrieval; when omitted, the original\nquestion reaches the retrievers unchanged. Optional postgeneration checks\nrun after synthesis and apply their publication or correction policies.\n\n``embed_batch_size`` and ``comparison`` belong to no position. The\nembedder is bound to the space rather than named by a node, so there is no\nnode to hang its batch size on, yet how many texts it is handed at a time\nis the single biggest lever on how long loading a corpus takes -- and it is\nthe space's lever, since only its owner knows what hardware their embedder\nends up on and how long their passages are. How the space's evaluation runs\nare compared is read by no stage at all; it is here because it is the\nspace's to choose and this is where the space's choices are kept."},"PipelineConfigPreview":{"properties":{"scope":{"type":"string"},"requires_reindex":{"type":"boolean"},"changes":{"$ref":"#/components/schemas/PipelineChangeSummary"},"estimated_seconds":{"anyOf":[{"type":"number"},{"type":"null"}]},"document_count":{"anyOf":[{"type":"integer"},{"type":"null"}]},"estimated_embedding_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null},"estimated_embedding_cost":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null},"applies_to_new_documents_only":{"type":"boolean","default":false},"indexes_attached_storage":{"type":"boolean","default":false}},"type":"object","required":["scope","requires_reindex","changes","estimated_seconds","document_count"],"title":"PipelineConfigPreview","description":"The non-mutating cost of applying a proposed pipeline config.\n\nReports the reindex a move would require without performing it: the\nclassified ``scope`` (``none`` / ``index`` / ``representations`` /\n``full``), whether a reindex is needed at all, a summary of what changes,\nand a wall-clock time estimate. The estimate is ``0`` for a query-time-only\nchange; for a rebuild of the vector index alone it is ``null``, since that\nrebuild recuts no document and nothing measured says how long it takes;\nfor a recut or a reconciliation it is the running mean per-document index\ntime times the documents that would be reindexed, and ``null`` when the\nspace has indexed nothing yet (no samples to estimate from) -- honest\nrather than a misleading zero. A change\nthat recuts the corpus also embeds it again, and what that would send the\nembedding model, and cost where its price is known, is estimated beside it."},"PipelineConfigStatus":{"properties":{"rebuilding":{"type":"boolean"},"stale":{"type":"boolean"},"config_change_pending":{"type":"boolean"},"rebuild_failed":{"type":"boolean"},"rebuild_failure":{"anyOf":[{"$ref":"#/components/schemas/RebuildFailure"},{"type":"null"}]},"representations":{"items":{"$ref":"#/components/schemas/RepresentationState"},"type":"array"},"rebuild_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"default":null},"processed_documents":{"type":"integer","default":0},"total_documents":{"type":"integer","default":0},"failed_documents":{"type":"integer","default":0}},"type":"object","required":["rebuilding","stale","config_change_pending","rebuild_failed","rebuild_failure","representations"],"title":"PipelineConfigStatus","description":"A cheap view of a space's reindex progress.\n\nKeeps apart whether some index will not do (``stale``) and whether work is\non its way to it (``rebuilding``), because neither follows from the other:\na document uploaded after the graph was built leaves the graph stale with\nnothing coming, and a change accepted a moment ago has work coming over\nindexes that still read built. A rebuild that stopped for good is a third\nanswer and is reported as one. A client polling for a rebuild to finish\npolls ``rebuilding``; one deciding whether to offer a rebuild reads\n``stale`` and ``rebuild_failed``. What raises each flag is decided in one\nplace, where the view is built from the space's rows and records."},"PipelinePresetView":{"properties":{"id":{"type":"string"},"label":{"type":"string"},"description":{"type":"string"},"kind":{"type":"string"},"needs_llm":{"type":"boolean"},"pipeline":{"$ref":"#/components/schemas/PipelineConfig"},"agent_graph":{"anyOf":[{"$ref":"#/components/schemas/AgentGraphConfig"},{"type":"null"}],"default":null}},"type":"object","required":["id","label","description","kind","needs_llm","pipeline"],"title":"PipelinePresetView","description":"The served shape of a preset, carrying the computed ``needs_llm`` flag.\n\nMirrors :class:`PipelinePreset` and adds ``needs_llm`` -- derived from the\npipeline, never stored -- so a client knows upfront whether picking the\npreset will require the Space to hold an LLM. Built from a preset by\n:func:`~server.apps.main.logic.pipeline_presets.preset_view`."},"PipelineReindexResult":{"properties":{"enqueued":{"type":"boolean"}},"type":"object","required":["enqueued"],"title":"PipelineReindexResult","description":"The outcome of asking for a space to be reindexed on its stored config.\n\nNothing about the pipeline changes, so there is no scope to classify and no\nin-place path: the work is always a full recut of the corpus, which runs off\nthe request. The endpoint answers ``202 Accepted`` with ``enqueued`` true\nonce it is queued, after which a client polls the status view until it\nstops reporting a rebuild -- which it reports from this answer on."},"PipelineUpdateResult":{"properties":{"scope":{"type":"string"},"reindexing":{"type":"boolean"},"applies_to_new_documents_only":{"type":"boolean","default":false},"indexes_attached_storage":{"type":"boolean","default":false}},"type":"object","required":["scope","reindexing"],"title":"PipelineUpdateResult","description":"The outcome of applying a proposed pipeline config.\n\nA query-time-only change is applied in place and reported with\n``reindexing`` false (the response is a normal 200); a change that needs a\nreindex is started in the background and reported with ``reindexing`` true\n(the response is 202 Accepted), after which a client polls the status view\nuntil it stops reporting a rebuild -- which it reports from this answer on,\nbefore any worker has taken the rebuild up.\n\nA space attached to storage this platform did not write has a third\noutcome: its config is stored in place and a pass over that storage is\nstarted, which is reported with ``indexes_attached_storage`` true and is\nalso a 202. A client watches that one through the space's storage-index\nstate, since it rebuilds rows the representation status says nothing about."},"PostGenerationAttempt":{"properties":{"id":{"type":"string","format":"uuid"},"ordinal":{"type":"integer"},"original_question":{"type":"string"},"retrieval_query":{"type":"string"},"sources":{"items":{"type":"object"},"type":"array"},"actual_grounding":{"$ref":"#/components/schemas/PreparedGrounding"},"answer":{"type":"string"},"check_results":{"items":{"$ref":"#/components/schemas/PostGenerationResult"},"type":"array"},"accepted":{"type":"boolean","default":false},"generation_complete":{"type":"boolean","default":false},"triggered_by":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"default":null},"correction_action":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"guidance":{"anyOf":[{"$ref":"#/components/schemas/CorrectionGuidance"},{"type":"null"}],"default":null}},"type":"object","required":["id","ordinal","original_question","retrieval_query","sources","actual_grounding","answer"],"title":"PostGenerationAttempt","description":"One generated candidate and the checks actually performed on it."},"PostGenerationCheck":{"properties":{"id":{"type":"string","format":"uuid"},"rubric_version_id":{"type":"string","format":"uuid"},"criterion_key":{"type":"string","minLength":1},"judge":{"anyOf":[{"$ref":"#/components/schemas/RubricJudgeConfig"},{"type":"null"}],"default":null},"node":{"enum":["rubric"],"default":"rubric"},"on_failure":{"enum":["block","observe","regenerate","retrieve_regenerate"],"default":"observe"},"max_retries":{"type":"integer","minimum":0,"default":0}},"additionalProperties":false,"type":"object","required":["id","rubric_version_id","criterion_key"],"title":"PostGenerationCheck","description":"A pinned criterion, policy and whole-query retry budget."},"PostGenerationModelCall":{"properties":{"model":{"type":"string"},"operation":{"type":"string"},"input_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null},"output_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null},"cost_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null}},"type":"object","required":["model","operation"],"title":"PostGenerationModelCall","description":"A provider-reported call; missing usage is explicitly unknown."},"PostGenerationResult":{"properties":{"node_id":{"type":"string","format":"uuid"},"attempt_id":{"type":"string","format":"uuid"},"result":{"$ref":"#/components/schemas/CriterionResult"}},"type":"object","required":["node_id","attempt_id","result"],"title":"PostGenerationResult","description":"The node and attempt that produced a criterion result."},"PostGenerationTrace":{"properties":{"rubric_versions":{"items":{"$ref":"#/components/schemas/RubricVersion"},"type":"array"},"checks":{"items":{"$ref":"#/components/schemas/PostGenerationCheck"},"type":"array"},"attempts":{"items":{"$ref":"#/components/schemas/PostGenerationAttempt"},"type":"array"},"retry_counts_by_node":{"additionalProperties":{"type":"integer"},"type":"object"},"outcome":{"enum":["accepted","blocked","cancelled","error"]},"technical_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"model_calls":{"items":{"$ref":"#/components/schemas/PostGenerationModelCall"},"type":"array"},"schema_version":{"type":"integer","default":1},"text_retained":{"type":"boolean","default":true}},"type":"object","required":["rubric_versions","checks","attempts","retry_counts_by_node","outcome"],"title":"PostGenerationTrace","description":"Private attempt history governed by the query-text grant."},"PreflightReport":{"properties":{"findings":{"items":{"$ref":"#/components/schemas/Finding"},"type":"array"},"status":{"$ref":"#/components/schemas/ReportStatus"},"impact":{"anyOf":[{"$ref":"#/components/schemas/PipelineConfigPreview"},{"type":"null"}],"default":null},"reranker_previews":{"items":{"$ref":"#/components/schemas/RerankerPreview"},"type":"array","default":[]}},"additionalProperties":false,"type":"object","required":["findings","status"],"title":"PreflightReport","description":"The result of running every preflight check over one Space config.\n\nHolds the ordered findings, the ``status`` verdict the apply-gate reads,\nand the reindex ``impact`` a config change would cost. ``status`` is derived\nfrom the findings and travels in the serialised body, so every client reads\nthe verdict directly instead of re-deriving it from the findings. Build a\nreport only through :meth:`from_findings`, the one constructor that keeps\n``status`` consistent with the findings it summarises.\n\n``impact`` carries the reindex cost when the run was for an edit of an\nexisting Space (its scope, document count and time estimate); it is unset\nfor a create-time validation and a re-check, and it never changes the\nverdict."},"PreparedGrounding":{"properties":{"contexts":{"items":{"type":"string"},"type":"array"},"provenance":{"items":{"type":"string"},"type":"array"},"kind":{"enum":["graph_global","retrieval"],"default":"retrieval"}},"type":"object","required":["contexts"],"title":"PreparedGrounding","description":"The exact context prepared for synthesis, with source provenance."},"QueryAnswerPayload":{"properties":{"answer":{"type":"string"},"sources":{"items":{"$ref":"#/components/schemas/QuerySource"},"type":"array"},"query_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"outcome":{"enum":["accepted","blocked"],"default":"accepted"},"postgeneration":{"anyOf":[{"$ref":"#/components/schemas/PostGenerationTrace"},{"type":"null"}],"default":null},"branch_trace":{"items":{"$ref":"#/components/schemas/BranchExecution"},"type":"array","default":[]},"dictionary_trace":{"items":{"$ref":"#/components/schemas/DictionaryTransformExecution"},"type":"array","default":[]},"evidence_coverage":{"items":{"$ref":"#/components/schemas/CoverageTrace"},"type":"array","default":[]},"reranker_trace":{"items":{"$ref":"#/components/schemas/RerankerExecution"},"type":"array","default":[]}},"type":"object","required":["answer","sources"],"title":"QueryAnswerPayload","description":"The generated answer together with the chunks it was grounded in."},"QueryBranchConfig":{"properties":{"id":{"type":"string","minLength":1},"retrievers":{"items":{"$ref":"#/components/schemas/NodeSpec"},"type":"array"},"fusion":{"$ref":"#/components/schemas/NodeSpec"},"query_transform":{"items":{"$ref":"#/components/schemas/NodeSpec"},"type":"array","default":[]},"max_queries":{"type":"integer","minimum":1,"default":1},"weight":{"type":"number","minimum":0,"default":1}},"type":"object","required":["id","retrievers","fusion"],"title":"QueryBranchConfig","description":"A search path starting from the original question.\n\nRetriever weights belong to ``fusion``; ``weight`` controls this path's\ncontribution after its formulations and retrievers have been combined."},"QueryChange":{"enum":["improved","unchanged","worsened"],"title":"QueryChange","description":"Which way one question moved on one metric from one run to the other.\n\nA question counts as unchanged only when its two values are equal: every\nrun computes a query's score by the same formula, so two rankings that put\nthe relevant passages in the same places at one cutoff give the same\nnumber, and there is no rounding noise to forgive."},"QueryEntrypoint":{"enum":["api","mcp","ui"],"title":"QueryEntrypoint","description":"Which entrance a question came in through.\n\n``ui`` is a person signed in with their own token -- the web application,\nor anything else that holds a person's session. ``api`` is a request that\npresented an API key over the HTTP API; the SDKs are among those, and are\ncounted there because nothing they send today tells them apart from any\nother script holding a key. ``mcp`` is a tool call an agent host made over\nthe MCP surface, whichever credential it presented there."},"QueryFailure":{"enum":["cancelled","conflict","internal","model_failed","model_rate_limited","model_refused","model_stream_cut","model_timeout","model_unreachable","rejected","unavailable","upstream"],"title":"QueryFailure","description":"Why a question that ended in ``error`` ended there.\n\nMost values name a family of failure rather than a particular one,\nbecause the families are what an owner can act on, and they are the\nfamilies the platform already sorts its refusals into, so no second\ntaxonomy has to be kept in step with the first. The ``model_`` values are\nthe exception: a model provider's own failure reaches the edge unnamed by\nany family, and what an owner does about it turns on which it was -- wait\nout a rate limit, raise a timeout, fix a key, report an outage, look at\nthe connection a stream was dropped on. How a failure is filed is decided\nin one function, ``filed_failure`` in the analytics usecases; what each\nfamily holds is said at ``failure_of`` beside it, and what each ``model_``\nvalue holds at ``provider_failure_of``, where a model call's failure is\nread."},"QueryFeedbackPayload":{"properties":{"rating":{"$ref":"#/components/schemas/FeedbackRating"},"reason":{"anyOf":[{"$ref":"#/components/schemas/FeedbackReason"},{"type":"null"}],"default":null},"comment":{"type":"string","maxLength":2000,"default":""}},"type":"object","required":["rating"],"title":"QueryFeedbackPayload","description":"A rating of one answer, by the person who asked for it."},"QueryMetric":{"enum":["correctness","faithfulness","mrr","ndcg","recall","relevancy"],"title":"QueryMetric","description":"A metric of either family that a question can be said to have moved on.\n\nWhat a caller names to have two runs' questions listed by how they moved:\nthe ranking metrics and the answer metrics above, under the same names, and\nnothing besides."},"QueryMode":{"enum":["agent","answer","search"],"title":"QueryMode","description":"How the question was answered.\n\n``search`` returned ranked passages and wrote nothing; ``answer`` ran the\nspace's pipeline through to a generated answer; ``agent`` answered through\nthe space's graph of agents. Whether the answer travelled as a stream is\nkept beside the mode rather than as a mode of its own, because a streamed\nanswer and a buffered one do the same work."},"QueryOutcome":{"enum":["blocked","error","no_answer","no_context","ok","partial","refused"],"title":"QueryOutcome","description":"How the question ended, as far as the platform can tell structurally.\n\n``ok`` is an answer (or a ranking) over at least one passage. ``no_context``\nis a question that reached nothing: no passage came back, whether a filter\nnarrowed the corpus to nothing or no leg found anything. ``no_answer`` and\n``partial`` are answers whose model said, in the mark it closes an answer\nwith, that what it was handed established none of the answer, or only part\nof it. ``refused`` is a generated answer that came back empty although\npassages were handed to the model. ``error`` is a question that ended in a\nfailure, with the failure's family beside it. What counts as each of the\nanswered ones is decided where the outcome is read (``outcome_of`` in the\nanalytics usecases)."},"QueryRequestPayload":{"properties":{"query":{"type":"string","minLength":1},"top_k":{"type":"integer","maximum":20,"minimum":1,"default":5},"metadata_filter":{"anyOf":[{"$ref":"#/components/schemas/MetadataFilter"},{"type":"null"}],"default":null}},"type":"object","required":["query"],"title":"QueryRequestPayload","description":"A natural-language question asked against a space's documents.\n\nA filter is part of the request rather than something applied to what came\nback: it decides which documents are searched at all, so the depth asked\nfor is the depth returned out of the narrowed part of the corpus. Sifting a\nfinished ranking instead would answer a question of ten passages with\nhowever few of those ten happened to qualify."},"QuerySource":{"properties":{"id":{"type":"string"},"text":{"type":"string"},"parent_text":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"graph_context":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"score":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null},"locator":{"anyOf":[{"$ref":"#/components/schemas/SourceLocator"},{"type":"null"}],"default":null},"processing":{"anyOf":[{"$ref":"#/components/schemas/SourceProcessing"},{"type":"null"}],"default":null},"parent_locator":{"anyOf":[{"$ref":"#/components/schemas/SourceLocator"},{"type":"null"}],"default":null},"parent_processing":{"anyOf":[{"$ref":"#/components/schemas/SourceProcessing"},{"type":"null"}],"default":null},"document_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"default":null},"bibliography":{"anyOf":[{"$ref":"#/components/schemas/SourceBibliography"},{"type":"null"}],"default":null},"parent_bibliography":{"anyOf":[{"$ref":"#/components/schemas/SourceBibliography"},{"type":"null"}],"default":null},"group":{"anyOf":[{"$ref":"#/components/schemas/EquivalentPassageGroup"},{"type":"null"}],"default":null}},"type":"object","required":["id","text"],"title":"QuerySource","description":"A retrieved chunk that grounded the generated answer.\n\nA chunk the knowledge-graph leg found carries ``graph_context`` beside its\ntext: what the graph says about that passage. It is kept apart from\n``parent_text`` because the two are different things -- a wider cut of the\nsame document against prose a model wrote about the corpus -- and a source\nmay carry either, both or neither."},"QueryStreamEvent":{"properties":{"delta":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"answer":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"sources":{"anyOf":[{"items":{"$ref":"#/components/schemas/QuerySource"},"type":"array"},{"type":"null"}],"default":null},"query_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"branch_trace":{"items":{"$ref":"#/components/schemas/BranchExecution"},"type":"array","default":[]},"dictionary_trace":{"items":{"$ref":"#/components/schemas/DictionaryTransformExecution"},"type":"array","default":[]},"evidence_coverage":{"items":{"$ref":"#/components/schemas/CoverageTrace"},"type":"array","default":[]},"reranker_trace":{"items":{"$ref":"#/components/schemas/RerankerExecution"},"type":"array","default":[]},"outcome":{"anyOf":[{"enum":["accepted","blocked"]},{"type":"null"}],"default":null},"postgeneration":{"anyOf":[{"$ref":"#/components/schemas/PostGenerationTrace"},{"type":"null"}],"default":null},"node_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"default":null},"attempt_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"default":null},"verdict":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"action":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"detail":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"names":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"default":null},"stage":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"label_key":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"phase":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},"type":"object","title":"QueryStreamEvent","description":"One event's payload in a token-by-token streamed answer.\n\nA streamed answer sends a few kinds of event over one connection, each a\nthin projection of this one shape (unset fields are omitted from the wire):\na ``stage`` event announces the pipeline stage about to run, carrying its\n``stage`` id, ``label_key``, ``icon`` and ``phase``; a ``token`` event\ncarries only its ``delta`` (the next fragment of prose); the single terminal\n``done`` event carries the finished ``answer``, the ``sources`` it was\ngrounded in (the same shape a buffered answer returns) and the ``query_id``\nthe query log filed it under; an ``error`` event\ncarries its ``detail`` and always a ``reason`` a client can match on --\nthe refusal's own name where it has one, as a status-code response would\ncarry it, and otherwise the name the query log files the failure under,\nsuch as ``model_unreachable`` or ``model_stream_cut`` -- and the\nrefusal's ``names`` where it has them. Which kind an event is comes from\nits SSE event name, so each payload stays minimal."},"QueryTextGrant":{"properties":{"user_id":{"type":"string"},"reads_query_texts":{"type":"boolean"}},"type":"object","required":["user_id","reads_query_texts"],"title":"QueryTextGrant","description":"Whether a member may read retained question and execution content."},"QueryTextGrantPayload":{"properties":{"reads_query_texts":{"type":"boolean"}},"type":"object","required":["reads_query_texts"],"title":"QueryTextGrantPayload","description":"Grant or revoke access to retained question and execution content."},"RankingMetric":{"enum":["mrr","ndcg","recall"],"title":"RankingMetric","description":"A ranking metric a query carries a value of in each run.\n\nThe members are the per-query scores a run records for every query it\nranked, named as that record names them, so a member reads its value off\nthe record by its own name."},"RebuildFailure":{"enum":["abandoned","corpus_changed","embedder_unreachable","error","timed_out"],"title":"RebuildFailure","description":"Why the last rebuild of a space stopped without reaching its target.\n\nThe causes ask different actions of the owner. Exception text is not\nhanded out, since a library's message can\ncarry a host, a path or a fragment of a key. What happened is in the\nworker's log.\n\n``timed_out`` -- the rebuild was still going when the worker's time limit\ncut it off; run again untouched it ends there again. ``abandoned`` -- it\nkept being interrupted by something outside it until its attempts ran out;\nnothing about it was wrong, and starting it again is the right move.\n``embedder_unreachable`` -- the space's remote embedder never answered.\n``error`` -- anything else, a defect or a provider refusing.\n``corpus_changed`` -- the frozen input changed outside the rebuild;\nrequest a fresh rebuild to include the current corpus."},"RefusalBody":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/RefusalDetail"},"type":"array"},"reason":{"type":"string","default":""},"names":{"items":{"type":"string"},"type":"array","default":[]}},"type":"object","required":["detail"],"title":"RefusalBody","description":"The body every client-facing domain error is delivered as.\n\nIt is the error body this API has always served -- a list of detail lines --\nwith room for two further things a refusal may have to say. Both are left\nout of the encoding when the refusal has nothing to put in them, so a\nrefusal that is nothing but its sentence goes out on the wire exactly as it\nalways did, and the addition is visible only where it adds something.\n\n``reason`` is what a client narrows on. A status alone does not identify a\nrefusal -- several conflicts share 409 and several bad requests share 400 --\nso without it the only thing distinguishing one refusal from another is the\nserver's own prose, which a client can either repeat verbatim or throw away.\nRepeating it means an English sentence in an interface that is not in\nEnglish; throwing it away means losing the one part that says what to do\nnext. A name the client can match on is what lets it write its own sentence\ninstead of choosing between those two.\n\n``names`` is what that sentence is about: the spaces still holding a storage\nbackend, the roles a storage names no field for. They are carried apart from\nthe message because a client composing its own sentence needs them as values\nrather than as a substring of somebody else's prose -- and the message keeps\nnaming them too, so a caller that only reads the sentence is no worse off\nthan before."},"RefusalDetail":{"properties":{"msg":{"type":"string"},"type":{"type":"string","default":""},"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","default":[]}},"type":"object","required":["msg"],"title":"RefusalDetail","description":"One line of a refusal: the sentence, its machine family, its place.\n\nThe three the framework's own detail line has always carried, and on the\nsame terms -- the sentence always, the other two where there is one to give.\nThis body is declared for every refusal an endpoint can answer with, and the\nrefusals a request never reaches the endpoint for are among them: a body\nthat failed to parse is reported field by field, and each of those lines\nsays where in the payload the offending value sat. A detail line without\nroom for that would describe those responses wrongly on every route that\nparses a body."},"RegexRule":{"properties":{"pattern":{"type":"string","maxLength":4096},"flags":{"items":{"enum":["dotall","ignore_case","multiline"]},"type":"array"},"mode":{"enum":["fullmatch","search"],"default":"search"},"expect_match":{"type":"boolean","default":true}},"additionalProperties":false,"type":"object","required":["pattern"],"title":"RegexRule","description":"A Unicode pattern with explicit match scope and expected polarity."},"RegisteredUserPayload":{"properties":{"id":{"type":"string"},"email":{"type":"string"}},"type":"object","required":["id","email"],"title":"RegisteredUserPayload","description":"Minimal response describing a freshly registered user.\n\nExposes the user's public id (its ``public_id`` UUID as a string) and the\nstored email -- never the internal int PK and never the password."},"RegistrationPayload":{"properties":{"email":{"type":"string","maxLength":254,"minLength":3},"password":{"type":"string","maxLength":128,"minLength":1}},"type":"object","required":["email","password"],"title":"RegistrationPayload","description":"Request body to register a new user by email and password.\n\nThe email is the login identifier; the password is validated against\nDjango's configured password validators before the account is created."},"ReportStatus":{"enum":["blocked","blocked_by_probe_only","ok"],"title":"ReportStatus","description":"The verdict a whole preflight report carries.\n\n``OK`` -- nothing blocks, the config is clear to apply. ``BLOCKED`` -- at\nleast one blocking problem is structural or consistency, so the config is\nthe wrong config and ``force`` cannot help. ``BLOCKED_BY_PROBE_ONLY`` --\nthere are blocking problems but every one is a probe, so the config itself\nis sound and an operator may push past the unreachable resources with\n``force``."},"RepresentationState":{"properties":{"kind":{"type":"string"},"status":{"$ref":"#/components/schemas/IndexBuildState"},"built_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"type":"object","required":["kind","status","built_at"],"title":"RepresentationState","description":"One derived index's build state for a status poll.\n\nA representation is the searchable index a single retriever queries; its\n``status`` is ``stale`` (needs a rebuild), ``building`` (a rebuild is in\nflight) or ``built`` (current and queryable), and ``built_at`` records when\nit last became current (``null`` before its first build)."},"RerankerExecution":{"properties":{"node":{"type":"string"},"candidate_ids":{"items":{"type":"string"},"type":"array"},"members":{"items":{"$ref":"#/components/schemas/RerankerMemberExecution"},"type":"array"},"status":{"type":"string"},"normalization":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"fusion":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"failure_policy":{"type":"string","default":"fail_closed"},"instruction":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},"type":"object","required":["node","candidate_ids","members","status"],"title":"RerankerExecution","description":"Execution evidence rather than a prediction from configuration."},"RerankerMemberExecution":{"properties":{"model":{"type":"string"},"profile":{"type":"string"},"requested_revision":{"anyOf":[{"type":"string"},{"type":"null"}]},"resolved_revision":{"anyOf":[{"type":"string"},{"type":"null"}]},"effective_params":{"$ref":"#/components/schemas/EffectiveRerankerParams"},"weight":{"type":"number"},"share":{"type":"number"},"status":{"type":"string"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"raw_scores":{"anyOf":[{"items":{"type":"number"},"type":"array"},{"type":"null"}],"default":null}},"type":"object","required":["model","profile","requested_revision","resolved_revision","effective_params","weight","share","status"],"title":"RerankerMemberExecution","description":"One model's resolved processing, contribution and execution status."},"RerankerPreview":{"properties":{"node":{"type":"string"},"node_index":{"type":"integer"},"member_index":{"anyOf":[{"type":"integer"},{"type":"null"}]},"requested":{"type":"object"},"effective":{"$ref":"#/components/schemas/EffectiveRerankerParams"},"input_mode":{"type":"string"},"inputs":{"items":{"items":{"type":"string"},"type":"array"},"type":"array"}},"type":"object","required":["node","node_index","member_index","requested","effective","input_mode","inputs"],"title":"RerankerPreview","description":"Synthetic logical inputs without loading model weights."},"RerankerProfileView":{"properties":{"id":{"type":"string"},"label":{"type":"string"},"model":{"type":"string"},"revision":{"anyOf":[{"type":"string"},{"type":"null"}]},"input_mode":{"type":"string"},"input_template":{"anyOf":[{"type":"string"},{"type":"null"}]},"max_length":{"anyOf":[{"type":"integer"},{"type":"null"}]},"truncation":{"type":"string"},"padding":{"type":"string"},"supported_input_modes":{"items":{"type":"string"},"type":"array"},"supported_truncation":{"items":{"type":"string"},"type":"array"},"supported_padding":{"items":{"type":"string"},"type":"array"},"editable_fields":{"items":{"type":"string"},"type":"array"},"max_supported_length":{"anyOf":[{"type":"integer"},{"type":"null"}]},"license":{"type":"string"},"license_url":{"type":"string"},"warning":{"anyOf":[{"type":"string"},{"type":"null"}]},"description":{"type":"string"},"max_query_length":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null},"max_document_length":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null},"internal_block_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null}},"type":"object","required":["id","label","model","revision","input_mode","input_template","max_length","truncation","padding","supported_input_modes","supported_truncation","supported_padding","editable_fields","max_supported_length","license","license_url","warning","description"],"title":"RerankerProfileView","description":"Processing defaults and compatibility choices for a local scorer."},"RetrievalReceipt":{"properties":{"base_pipeline_fingerprint":{"type":"string"},"effective_pipeline_fingerprint":{"type":"string"},"rrf_k":{"anyOf":[{"type":"integer"},{"type":"null"}]},"override_applied":{"type":"boolean"}},"type":"object","required":["base_pipeline_fingerprint","effective_pipeline_fingerprint","rrf_k","override_applied"],"title":"RetrievalReceipt","description":"The masked pipeline identities actually used by this retrieval."},"RetrievalRequestPayload":{"properties":{"query":{"type":"string","minLength":1},"top_k":{"type":"integer","maximum":20,"minimum":1,"default":5},"metadata_filter":{"anyOf":[{"$ref":"#/components/schemas/MetadataFilter"},{"type":"null"}],"default":null},"rrf_k":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"default":null}},"additionalProperties":false,"type":"object","required":["query"],"title":"RetrievalRequestPayload","description":"Retrieve with an optional request-local reciprocal-rank constant."},"RetrievalScore":{"properties":{"mrr":{"type":"number"},"recall":{"type":"number"},"ndcg":{"type":"number"},"cutoff":{"type":"integer"},"query_count":{"type":"integer"}},"type":"object","required":["mrr","recall","ndcg","cutoff","query_count"],"title":"RetrievalScore","description":"One query's MRR / Recall / nDCG at a cutoff, plus the dataset average.\n\nThe same shape carries a single query's scores and the averaged scores\nacross a dataset's labelled queries, so a caller reads ``mrr`` / ``recall``\n/ ``ndcg`` the same way whether it holds a per-query result or the\naggregate. ``cutoff`` is the rank cutoff (the ``k`` of @k) the three were\ncomputed at; ``query_count`` is one for a single query and the number of\nlabelled queries for an aggregate."},"RetrieveResultPayload":{"properties":{"sources":{"items":{"$ref":"#/components/schemas/QuerySource"},"type":"array"},"query_id":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"branch_trace":{"items":{"$ref":"#/components/schemas/BranchExecution"},"type":"array","default":[]},"dictionary_trace":{"items":{"$ref":"#/components/schemas/DictionaryTransformExecution"},"type":"array","default":[]},"evidence_coverage":{"items":{"$ref":"#/components/schemas/CoverageTrace"},"type":"array","default":[]},"reranker_trace":{"items":{"$ref":"#/components/schemas/RerankerExecution"},"type":"array","default":[]},"retrieval_receipt":{"anyOf":[{"$ref":"#/components/schemas/RetrievalReceipt"},{"type":"null"}],"default":null}},"type":"object","required":["sources"],"title":"RetrieveResultPayload","description":"The chunks a retrieve-only search ranked, without any generated answer.\n\nThe surface retrieval quality is measured on (MRR@10 / Recall / nDCG) and a\nproduct feature in its own right: the read path runs (retriever, fusion,\nrerank, context) but stops before the LLM, so the ranked chunks come back\nuntouched by generation. Each source carries its relevance score, so a\ncaller can threshold or re-rank the ranking."},"RetrievedPassage":{"properties":{"id":{"type":"string"},"score":{"anyOf":[{"type":"number"},{"type":"null"}]}},"type":"object","required":["id","score"],"title":"RetrievedPassage","description":"One corpus passage a query reached, and how strongly.\n\nThe passage is named by its dataset-local corpus id rather than by the id\nof the chunk that actually matched, and the text is not here at all. Both\nfollow from where the text lives: the dataset's corpus holds it once and\noutlives every run scored against it, while the chunks a run retrieved\nbelong to a scoring space that is usually dropped when the run ends. A\nsecond copy of the passage would also start to drift from the first the\nmoment the space behind it was reindexed."},"RubricAggregate":{"properties":{"criterion_key":{"type":"string"},"total":{"type":"integer"},"passed":{"type":"integer"},"failed":{"type":"integer"},"unevaluable":{"type":"integer"},"not_evaluated":{"type":"integer"},"partial_context":{"type":"integer"}},"type":"object","required":["criterion_key","total","passed","failed","unevaluable","not_evaluated","partial_context"],"title":"RubricAggregate","description":"Counts distinguish absent observations from failed criteria."},"RubricAssessmentRequest":{"properties":{"rubric_version_id":{"type":"string","format":"uuid"},"judge":{"anyOf":[{"$ref":"#/components/schemas/RubricJudgeConfig"},{"type":"null"}],"default":null}},"additionalProperties":false,"type":"object","required":["rubric_version_id"],"title":"RubricAssessmentRequest","description":"Choose an immutable rubric and a judge when its criteria need one."},"RubricAssessmentSummary":{"properties":{"id":{"type":"string","format":"uuid"},"run_id":{"type":"string","format":"uuid"},"rubric":{"$ref":"#/components/schemas/RubricVersion"},"judge":{"anyOf":[{"$ref":"#/components/schemas/RubricJudgeConfig"},{"type":"null"}]},"status":{"type":"string"},"aggregates":{"items":{"$ref":"#/components/schemas/RubricAggregate"},"type":"array"},"failure_reason":{"type":"string"},"created_at":{"type":"string"},"completed_at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"type":"object","required":["id","run_id","rubric","judge","status","aggregates","failure_reason","created_at","completed_at"],"title":"RubricAssessmentSummary","description":"Lifecycle and pinned inputs of one assessment."},"RubricComparison":{"properties":{"assessment_a":{"type":"string","format":"uuid"},"assessment_b":{"type":"string","format":"uuid"},"comparable":{"type":"boolean"},"reasons":{"items":{"type":"string"},"type":"array"},"transitions":{"items":{"$ref":"#/components/schemas/RubricTransition"},"type":"array"}},"type":"object","required":["assessment_a","assessment_b","comparable","reasons","transitions"],"title":"RubricComparison","description":"Comparison eligibility and explicitly paired examples."},"RubricCreate":{"properties":{"name":{"type":"string","maxLength":200,"minLength":1}},"additionalProperties":false,"type":"object","required":["name"],"title":"RubricCreate","description":"Create a named entry before publishing its criteria."},"RubricCriterion":{"properties":{"key":{"type":"string","maxLength":100,"minLength":1},"instruction":{"type":"string","minLength":1},"required":{"type":"boolean","default":true},"kind":{"enum":["json_schema","llm","regex"],"default":"llm"},"regex":{"anyOf":[{"$ref":"#/components/schemas/RegexRule"},{"type":"null"}],"default":null},"json_schema":{"anyOf":[{"$ref":"#/components/schemas/JsonSchemaRule"},{"type":"null"}],"default":null}},"additionalProperties":false,"type":"object","required":["key","instruction"],"title":"RubricCriterion","description":"A named answer criterion evaluated by its selected rule kind."},"RubricJudgeConfig":{"properties":{"model":{"type":"string","minLength":1,"description":"Explicit model for this criterion judge."},"api_base":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Optional judge provider endpoint override.","default":null},"temperature":{"anyOf":[{"type":"number","maximum":2,"minimum":0,"description":"Judge sampling temperature."},{"type":"null"}],"default":null},"timeout_seconds":{"type":"number","exclusiveMinimum":0,"description":"Seconds per judge call, including provider retries.","default":60}},"additionalProperties":false,"type":"object","required":["model"],"title":"RubricJudgeConfig","description":"An explicit judge model and the time budget for one call in seconds."},"RubricJudgementSummary":{"properties":{"position":{"type":"integer"},"publication_outcome":{"type":"string"},"partial_context":{"type":"boolean"},"results":{"items":{"$ref":"#/components/schemas/CriterionResult"},"type":"array"},"not_evaluated_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},"type":"object","required":["position","publication_outcome","partial_context","results"],"title":"RubricJudgementSummary","description":"One example with publication outcome independent of rubric verdicts."},"RubricPublish":{"properties":{"criteria":{"items":{"$ref":"#/components/schemas/RubricCriterion"},"type":"array","minItems":1}},"additionalProperties":false,"type":"object","required":["criteria"],"title":"RubricPublish","description":"Publish a new immutable ordered set of criteria."},"RubricSummary":{"properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"archived":{"type":"boolean"},"latest_version":{"type":"integer"},"created_at":{"type":"string"}},"type":"object","required":["id","name","archived","latest_version","created_at"],"title":"RubricSummary","description":"An owned library entry and its latest published version number."},"RubricTransition":{"properties":{"position":{"type":"integer"},"criterion_key":{"type":"string"},"before":{"anyOf":[{"type":"string"},{"type":"null"}]},"after":{"anyOf":[{"type":"string"},{"type":"null"}]},"comparable":{"type":"boolean"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}]},"before_result":{"anyOf":[{"$ref":"#/components/schemas/CriterionResult"},{"type":"null"}],"default":null},"after_result":{"anyOf":[{"$ref":"#/components/schemas/CriterionResult"},{"type":"null"}],"default":null}},"type":"object","required":["position","criterion_key","before","after","comparable","reason"],"title":"RubricTransition","description":"Paired observations; an absent side remains absent."},"RubricUpdate":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":200,"minLength":1},{"type":"null"}],"default":null},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null}},"additionalProperties":false,"type":"object","title":"RubricUpdate","description":"Rename or archive an entry without modifying published criteria."},"RubricUsage":{"properties":{"input_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null},"output_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null},"cost_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"default":null}},"type":"object","title":"RubricUsage","description":"Provider-reported token counts and known cost in US dollars."},"RubricVersion":{"properties":{"id":{"type":"string","format":"uuid"},"rubric_id":{"type":"string","format":"uuid"},"version":{"type":"integer"},"criteria":{"items":{"$ref":"#/components/schemas/RubricCriterion"},"type":"array"},"content_hash":{"type":"string"},"rubric_name":{"type":"string","default":""}},"type":"object","required":["id","rubric_id","version","criteria","content_hash"],"title":"RubricVersion","description":"Published criteria in their evaluation order."},"RunComparisonSettings":{"properties":{"significance_level":{"type":"number","exclusiveMaximum":1,"minimum":0.001,"title":"Significance level","description":"How much risk of calling a chance difference real a comparison accepts. A difference between two runs counts as real only when chance would produce one at least as large no more often than this.","default":0.05},"resamples":{"type":"integer","maximum":50000,"minimum":1000,"title":"Resamples","description":"How many times a comparison redraws the questions to see how far the averages could move by chance, and on many questions how many chance outcomes it tries. More gives steadier figures and takes longer.","default":10000}},"additionalProperties":false,"type":"object","title":"RunComparisonSettings","description":"How sure a comparison must be, and how much work it spends on that.\n\nRead by the comparison of two of the space's runs, and by nothing that\nbuilds, indexes or answers: changing it changes no stored row and no\nanswer, only the verdict a comparison reaches over rows already stored."},"SSEvent_QueryStreamEvent_":{"properties":{"data":{"$ref":"#/components/schemas/QueryStreamEvent"},"event":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"id":{"anyOf":[{"type":"integer"},{"type":"string"},{"type":"null"}],"default":null},"retry":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},"type":"object","required":["data"],"title":"SSEvent[QueryStreamEvent]","description":"Server sent event payload."},"ScopeLevel":{"enum":["manage","read","write"],"title":"ScopeLevel","description":"The access a credential's grant gives it on one space.\n\n``read`` reads (view, query, search), ``write`` also writes documents, and\n``manage`` also configures the space: validates, replaces and rechecks its\npipeline, reindexes it, rebuilds its graph, declares its metadata, reads the\nstate of those jobs, and runs and reads its evaluations -- and it may delete\nthe space. No level reaches full control, so a credential never decides who\nelse may reach a space, nor changes the space's own settings.\n\nEvery level is also capped by the role its owner holds on the space,\nrecomputed on each request: a key granted ``manage`` whose owner is an\neditor there reaches no further than writing, and is refused the rest. The\nword ``manage`` names this level and not :attr:`SpaceAction.manage`, which\nis membership administration the level stops short of.\n\nThese are the stored ``level`` values on an ``ApiKeyScope`` row. What a\nkey may be given is narrowed further by its purpose, as declared with the\npurposes. An agent host's grants are written in the same words, and what it\nmay be given is narrowed where its consent is taken rather than here."},"SelectableEmbeddingModel":{"properties":{"public_id":{"type":"string"},"model_id":{"type":"string"},"dim":{"type":"integer"},"kind":{"type":"string"},"owned":{"type":"boolean","default":false},"params":{"type":"object","default":{}},"connection":{"type":"object","default":{}},"available":{"type":"boolean","default":true}},"type":"object","required":["public_id","model_id","dim","kind"],"title":"SelectableEmbeddingModel","description":"A registered embedding model as a client is shown it.\n\nWhat a client needs to offer the embedder choice when creating a space --\nthe public id it binds the space with, the model id the space stores, the\nvector dimensionality, how the embedder runs, whether it can be bound right\nnow -- and what it needs to fill in a form replacing the model: its\nsettings and its connection. A connection's credentials are never among\nwhat is shown; a replacement leaves the key out to keep it."},"SelectableVectorBackend":{"properties":{"id":{"type":"string"},"kind":{"type":"string"},"mode":{"type":"string"},"supported_retrievers":{"items":{"type":"string"},"type":"array"},"missing_fields":{"items":{"type":"string"},"type":"array"},"lost_without_document":{"items":{"type":"string"},"type":"array"},"storage":{"type":"string","default":""},"owned":{"type":"boolean","default":false},"field_mapping":{"additionalProperties":{"type":"string"},"type":"object","default":{}},"access_level":{"type":"string","default":"append"}},"type":"object","required":["id","kind","mode","supported_retrievers","missing_fields","lost_without_document"],"title":"SelectableVectorBackend","description":"A registered storage backend a space may bind, as a client sees it.\n\nWhat a client needs in order to offer the choice of where a new space's\nvectors will live: the id to send back, and enough about the backend to\ndescribe it. Deliberately not the whole registry row -- a backend's\n``connection`` carries the credential that reaches an external instance, so\nit never leaves the selector.\n\nIt is also what comes back from registering or reconfiguring a row, since\nthat is the same view of the same thing: everything about a backend a\ncaller may be shown, and nothing they may not."},"ServerMeta":{"properties":{"server_version":{"type":"string"},"api_version":{"type":"string"}},"type":"object","required":["server_version","api_version"],"title":"ServerMeta","description":"Which platform a client is talking to, readable before any login.\n\n``server_version`` is the platform's release, the same value the served\nschema carries as its own version, so a client generated from one schema\ncan tell whether the server it reaches is the one it was generated\nagainst. ``api_version`` is the version segment of every route it calls."},"SetupStatus":{"properties":{"needs_setup":{"type":"boolean"}},"type":"object","required":["needs_setup"],"title":"SetupStatus","description":"Whether the installation still needs its first-run setup.\n\nA fresh install has no user accounts yet; the web setup wizard reads this to\nlead the operator to create the first account instead of showing a login\nscreen. Only the boolean flag is exposed -- never a user count, an email or\nany other detail about the accounts."},"SideIndexPassStatus":{"enum":["built","failed","never_run","running"],"title":"SideIndexPassStatus","description":"What the last pass over an attached corpus reached, as a client reads it.\n\nThe one vocabulary of pass states: the stored column's choices and the\nnames the rest of the code compares against are both spelled from it. The\ncolumn holds every state but ``never_run``, which is the state of a space\nwith no record at all, and a completeness test binds the two."},"SideIndexState":{"properties":{"depth":{"type":"string"},"status":{"$ref":"#/components/schemas/SideIndexPassStatus"},"legs":{"items":{"type":"string"},"type":"array"},"rows_indexed":{"type":"integer"},"rows_total":{"anyOf":[{"type":"integer"},{"type":"null"}]},"rows_skipped":{"type":"integer"},"last_pass_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"detail":{"type":"string"},"rows_already_indexed":{"type":"integer","default":0},"divergence":{"anyOf":[{"$ref":"#/components/schemas/ForeignCorpusDivergence"},{"type":"null"}],"default":null},"settings_moved":{"type":"boolean","default":false},"worker_seen_at":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},"type":"object","required":["depth","status","legs","rows_indexed","rows_total","rows_skipped","last_pass_at","detail"],"title":"SideIndexState","description":"How far a space's attachment reaches, and what the last pass left.\n\nOne value for the whole answer, because the parts are only meaningful\ntogether: a depth without the pass behind it reads as a property of the\nstorage, and a pass without the depth reads as a job nobody can place.\n\n``depth`` is the difference a screen has to be able to name. A shallow\nattachment searches somebody else's corpus by similarity and by nothing\nelse; an indexed one blends every leg over it. Told here rather than left\nto be worked out from a lexical leg answering nothing, which is what it\nlooked like before."},"SignificanceVerdict":{"enum":["insufficient_data","not_significant","significant"],"title":"SignificanceVerdict","description":"What a comparison concludes about one metric's difference.\n\n``insufficient_data`` is a verdict of its own rather than a\n``not_significant``: with too few questions paired, no difference however\nlarge could be told from chance, and reporting that as \"not significant\"\nwould read as a finding about the runs when it is one about the sample."},"SizeSpread":{"properties":{"median":{"type":"number"},"mean":{"type":"number"}},"type":"object","required":["median","mean"],"title":"SizeSpread","description":"Where the sizes of a set of fragments sit: their median and mean."},"SkippedMetric":{"properties":{"family":{"type":"string"},"reason":{"type":"string"}},"type":"object","required":["family","reason"],"title":"SkippedMetric","description":"One metric family that was not computed, with the reason it was skipped.\n\nA run records why a family it might have computed did not run -- the\npipeline had no generator so no answer could be judged, the dataset carried\nno relevance labels, no judge model was configured -- so a reader of a\nfinished run can tell an honestly-skipped family from a zero score. The\nreason is a short human-readable phrase, not an error code."},"SourceBibliography":{"properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"author":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"year":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},"type":"object","title":"SourceBibliography","description":"Canonical contextual title and optional document-owner metadata.\n\nAuthor, year and URL are owner-authored, not extractor-verified or model\nclaims. A URL is a display reference, never a derived original-file URL.\nSyntax validation cannot prove public access or absence of owner secrets;\nauthenticated routes are recognised on configured origins, not aliases."},"SourceLocator":{"properties":{"document_id":{"type":"string","format":"uuid"},"document_name":{"type":"string"},"section_path":{"items":{"type":"string"},"type":"array"},"start":{"type":"integer"},"end":{"type":"integer"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"page_number":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null}},"type":"object","required":["document_id","document_name","section_path","start","end"],"title":"SourceLocator","description":"A verified half-open Unicode range in the retained document text."},"SourceProcessing":{"properties":{"strategy":{"anyOf":[{"enum":["fixed","structural"]},{"type":"null"}],"default":null},"unit_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"fallback_diagnostics":{"items":{"type":"string"},"type":"array"},"partial_unit":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":null}},"type":"object","title":"SourceProcessing","description":"Processing-owned diagnostics, available without a verified address."},"SpaceAnalytics":{"properties":{"since":{"type":"string","format":"date"},"rows_since":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}]},"queries":{"type":"integer"},"askers":{"type":"integer"},"daily":{"items":{"$ref":"#/components/schemas/DayQueries"},"type":"array"},"outcomes":{"items":{"$ref":"#/components/schemas/OutcomeCount"},"type":"array"},"latency":{"$ref":"#/components/schemas/LatencySummary"},"spend":{"items":{"$ref":"#/components/schemas/ModelSpend"},"type":"array"},"daily_cost":{"items":{"$ref":"#/components/schemas/DayCost"},"type":"array"},"answer_cost":{"$ref":"#/components/schemas/AnswerCost"},"feedback":{"$ref":"#/components/schemas/FeedbackSummary"},"corpus":{"$ref":"#/components/schemas/CorpusSummary"},"top_documents":{"items":{"$ref":"#/components/schemas/DocumentUse"},"type":"array"},"unused_documents":{"$ref":"#/components/schemas/UnusedDocuments"}},"type":"object","required":["since","rows_since","queries","askers","daily","outcomes","latency","spend","daily_cost","answer_cost","feedback","corpus","top_documents","unused_documents"],"title":"SpaceAnalytics","description":"How a space was used over a period."},"SpaceCreatePayload":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1},"config":{"anyOf":[{"$ref":"#/components/schemas/PipelineConfig"},{"type":"null"}],"default":null},"extraction_config":{"anyOf":[{"$ref":"#/components/schemas/SpaceExtractionConfig"},{"type":"null"}],"default":null},"embedding_model_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"default":null},"vector_backend_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"default":null},"llm_config":{"anyOf":[{"$ref":"#/components/schemas/SpaceLLMConfig"},{"type":"null"}],"default":null},"outbound_config":{"anyOf":[{"$ref":"#/components/schemas/SpaceOutboundConfig"},{"type":"null"}],"default":null},"force":{"type":"boolean","default":false}},"type":"object","required":["name"],"title":"SpaceCreatePayload","description":"Used to create ``RAGSpace`` models.\n\nThe owner is not part of the body: a space is always owned by the\nauthenticated caller, taken from the request, so the client cannot create a\nspace on someone else's behalf."},"SpaceEmbedder":{"properties":{"id":{"type":"string"},"model_id":{"type":"string"},"dim":{"type":"integer"}},"type":"object","required":["id","model_id","dim"],"title":"SpaceEmbedder","description":"The embedding model a space's chunks and queries are embedded with.\n\nNamed by the catalogue row's public id -- the same id a space is created\nwith -- and by what that row says the model is, so a caller reading a space\nlearns what it embeds with without a second request. A space created\nnaming no model is bound to the platform default, and this is where that\nis visible."},"SpaceExtractionConfig":{"properties":{"engine":{"anyOf":[{"enum":["paddle","paddle_vl","tesseract","unlimited_ocr_2","vision_llm","xiaomi"]},{"type":"null"}],"default":null},"tesseract":{"anyOf":[{"$ref":"#/components/schemas/TesseractConfig"},{"type":"null"}],"default":null}},"additionalProperties":false,"type":"object","title":"SpaceExtractionConfig","description":"Preferences applied to future original extractions in a space."},"SpaceFullPayload":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"config":{"$ref":"#/components/schemas/PipelineConfig"},"created_at":{"type":"string"},"owner":{"type":"string"},"role":{"$ref":"#/components/schemas/SpaceRole"},"grant":{"anyOf":[{"$ref":"#/components/schemas/ScopeLevel"},{"type":"null"}]},"storage_mode":{"enum":["attached","managed"]},"storage_reachability":{"$ref":"#/components/schemas/StorageReachability"},"embedder":{"$ref":"#/components/schemas/SpaceEmbedder"},"extraction_config":{"anyOf":[{"$ref":"#/components/schemas/SpaceExtractionConfig"},{"type":"null"}],"default":null},"agent_graph":{"anyOf":[{"$ref":"#/components/schemas/AgentGraphConfig"},{"type":"null"}],"default":null},"llm_config":{"anyOf":[{"$ref":"#/components/schemas/SpaceLLMConfig"},{"type":"null"}],"default":null},"outbound_config":{"anyOf":[{"$ref":"#/components/schemas/SpaceOutboundConfig"},{"type":"null"}],"default":null},"metadata_schema":{"$ref":"#/components/schemas/MetadataSchema"},"last_accessed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"default":null}},"type":"object","required":["id","name","config","created_at","owner","role","grant","storage_mode","storage_reachability","embedder"],"title":"SpaceFullPayload","description":"Used to represent existing ``RAGSpace`` models."},"SpaceGroupMemberPayload":{"properties":{"group_id":{"type":"string"},"group_name":{"type":"string"},"role":{"$ref":"#/components/schemas/SpaceRole"},"user_id":{"type":"string"},"email":{"type":"string"}},"type":"object","required":["group_id","group_name","role","user_id","email"],"title":"SpaceGroupMemberPayload","description":"One group providing a user access to a space."},"SpaceLLMConfig":{"properties":{"model":{"anyOf":[{"type":"string","minLength":1,"examples":["openai/gpt-4o","openai/gpt-4o-mini","anthropic/claude-3-5-sonnet","anthropic/claude-3-5-haiku","ollama/llama3","ollama/qwen2.5","openai/gigachat","openai/yandexgpt"]},{"type":"null"}],"default":null},"api_base":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"default":null},"api_key":{"type":"string","format":"password","default":"","writeOnly":true},"temperature":{"anyOf":[{"type":"number","minimum":0},{"type":"null"}],"default":null},"retries":{"type":"integer","minimum":0,"default":2},"params":{"additionalProperties":true,"type":"object","default":{}}},"additionalProperties":false,"type":"object","title":"SpaceLLMConfig","description":"Which LLM a Space answers through, and how it is reached.\n\nEvery field but ``retries`` is optional. A config with no ``model`` names no\nmodel, so any LLM step the Space asks for (generation, HyDE, the LLM-judge\nreranker, the whole-graph generator, the agent path) is a configuration\nerror rather than silently falling back to a platform model -- there is no\nplatform model any more. ``retries`` always has a value, defaulting in the\nstruct to the platform-safe number of attempts.\n\nThe provider is encoded in the ``model`` string's prefix (``openai/``,\n``anthropic/``, ``ollama/`` ...). ``api_key``, when set, is passed to the\nprovider verbatim; left blank, LiteLLM reads the provider's key from the\nenvironment itself, so a config for a provider whose key is already in the\nenvironment needs no key here. The key is a secret: it is blanked before the\nconfig is ever returned to a client and an update that leaves it blank keeps\nthe stored one. ``api_base`` points at an OpenAI-compatible / self-hosted /\nproxy endpoint (GigaChat and YandexGPT are reached this way).\n\n``params`` is everything else the provider accepts, sent with the Space's\ncalls. A pipeline step may replace one of them for its own calls -- how\nlong a reply may run, and nothing else -- which is argued at\n:func:`step_llm_config`. It is not a secret and is handed back to a client\nas stored, so it is the one field here that must never hold a credential;\nthat, and the five settings above having exactly one home each, is what\n:func:`validate_llm_config` holds it to."},"SpaceOutboundConfig":{"properties":{"proxy":{"anyOf":[{"$ref":"#/components/schemas/OutboundRoute"},{"type":"null"}],"default":null}},"additionalProperties":false,"type":"object","title":"SpaceOutboundConfig","description":"The outgoing routes a Space's own clients take out of the installation.\n\nOne route today, taken by every client the Space drives -- the language\nmodel first, and the other outgoing clients as each is threaded through it.\nIt is a group rather than a bare route so a Space that later needs to reach\none service differently from the rest gains a field here instead of a new\ncolumn and a second shape for clients to learn."},"SpaceRole":{"enum":["editor","owner","viewer"],"title":"SpaceRole","description":"How a member relates to a space; each role grants one capability.\n\nA ``viewer`` may only read, an ``editor`` may also write, an ``owner`` has\nfull control (it manages membership too). The space creator is an ``owner``.\nThese are the stored ``role`` values on a membership row."},"SpaceSummaryPayload":{"properties":{"id":{"type":"string"},"name":{"type":"string"},"role":{"$ref":"#/components/schemas/SpaceRole"},"grant":{"anyOf":[{"$ref":"#/components/schemas/ScopeLevel"},{"type":"null"}]},"created_at":{"type":"string"},"owner":{"type":"string"},"storage_reachability":{"$ref":"#/components/schemas/StorageReachability"},"last_accessed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"default":null},"document_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null},"original_size_bytes":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null}},"type":"object","required":["id","name","role","grant","created_at","owner","storage_reachability"],"title":"SpaceSummaryPayload","description":"A listing view of a space the caller is a member of.\n\nLighter than :class:`SpaceFullPayload`: it carries what a member needs to\npick a space from a list -- its name, when it was created, who owns it --\nplus the ``role`` the listing caller holds on it. The pipeline config is\nleft to the detail endpoint, so a listing never decodes every space's nodes."},"SpaceUpdatePayload":{"properties":{"extraction_config":{"anyOf":[{"$ref":"#/components/schemas/SpaceExtractionConfig"},{"type":"null"}]},"llm_config":{"anyOf":[{"$ref":"#/components/schemas/SpaceLLMConfig"},{"type":"null"}]},"outbound_config":{"anyOf":[{"$ref":"#/components/schemas/SpaceOutboundConfig"},{"type":"null"}]}},"additionalProperties":false,"type":"object","title":"SpaceUpdatePayload","description":"Settings an owner may replace or clear without reindexing documents.\n\nAn omitted field preserves the stored setting; null clears it; an object\nreplaces it. Extraction preferences apply to future extraction requests.\nLLM keys and proxy passwords are write-only and blank values preserve the\nstored credential."},"StageDescriptor":{"properties":{"stage":{"type":"string"},"label_key":{"type":"string"},"icon":{"type":"string"}},"type":"object","required":["stage","label_key","icon"],"title":"StageDescriptor","description":"The UI-facing identity of one pipeline stage.\n\n``stage`` is the stable id shared by every node that fills the stage (so a\nclient groups them), ``label_key`` names the translatable label to show, and\n``icon`` names the glyph beside it. A node declares one so it can appear in\nquery progress and in the editor's node list; nodes at the same stage share\nthe ``stage`` id, though a node may still carry a more specific label."},"StageLatency":{"properties":{"stage":{"type":"string"},"p50_ms":{"type":"number"},"p95_ms":{"type":"number"},"queries":{"type":"integer"}},"type":"object","required":["stage","p50_ms","p95_ms","queries"],"title":"StageLatency","description":"How long one stage took, over the questions that passed through it."},"StorageReachability":{"properties":{"state":{"enum":["reachable","unknown","unreachable"]},"applies":{"type":"boolean","title":"Says anything","description":"Whether this mark says anything about this space. True for a space whose vectors stand apart from the installation -- in storage somebody else owns, or on an instance this deployment does not run -- which can go quiet on its own and be reported. False where it cannot: such a mark can turn green and can never turn red, so it is reassurance about nothing and the state beside it is not worth showing."},"changed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"detail":{"type":"string","default":""}},"type":"object","required":["state","applies"],"title":"StorageReachability","description":"Whether a space's storage is answering, readable without asking it.\n\nThe point of it is the reading: a client learns that a space's corpus has\nstopped answering before it makes a request of that space, rather than by\nmaking one and being refused. Nothing here reaches any storage -- these are\ncolumns of the space and of the backend row it is bound to, the state among\nthem written by whatever last touched the storage on a path slow enough to\nafford it.\n\nWhich is why the moment is *when the state changed* and not when it was\nlast confirmed. Writing down every touch would put a database write behind\nevery failed request, so only a change is recorded; the price of that is\nthat this cannot say how long ago somebody looked, only how long the\ncurrent answer has stood.\n\nIt also says whether it is worth reading at all, because for some spaces it\nis not and a client cannot work that out for itself. Which spaces those are\nturns on where their storage stands, and a space's connection is in no\npayload this platform serves -- deliberately, since it carries the\ncredential that reaches the instance. So the answer is stated here rather\nthan left to be guessed from the ownership a space does report."},"StoredRowPreview":{"properties":{"identity":{"type":"string"},"text":{"type":"string"},"chunk":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"document":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null}},"type":"object","required":["identity","text"],"title":"StoredRowPreview","description":"One row of attached storage, read through the mapping that describes it.\n\nThe four roles a person can recognise a corpus by. The vector is left out\nbecause a thousand floating-point numbers tell nobody anything, and the\ndescription is left out because it is the storage's own JSON and would\nmake the reading a thing to be decoded rather than looked at."},"TesseractCapabilities":{"properties":{"languages":{"items":{"type":"string"},"type":"array"},"model_sets":{"items":{"type":"string"},"type":"array"},"page_segmentations":{"items":{"enum":["auto","single_block","sparse"]},"type":"array"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"binary_sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"default":null},"oem":{"type":"integer","default":1},"model_revisions":{"additionalProperties":{"additionalProperties":{"type":"string"},"type":"object"},"type":"object","default":{}}},"type":"object","required":["languages","model_sets","page_segmentations"],"title":"TesseractCapabilities","description":"Installed language bundles and supported segmentation modes."},"TesseractConfig":{"properties":{"languages":{"anyOf":[{"items":{"type":"string","minLength":1,"pattern":"^[a-zA-Z0-9_]+$"},"type":"array","minItems":1},{"type":"null"}],"default":null},"model_set":{"anyOf":[{"enum":["best","fast"]},{"type":"null"}],"default":null},"page_segmentation":{"anyOf":[{"enum":["auto","single_block","sparse"]},{"type":"null"}],"default":null}},"additionalProperties":false,"type":"object","title":"TesseractConfig","description":"Supported LSTM controls; executable paths remain deployment settings."},"TextAccess":{"properties":{"at":{"type":"string"},"user_id":{"anyOf":[{"type":"string"},{"type":"null"}]},"kind":{"$ref":"#/components/schemas/TextAccessKind"},"query_count":{"type":"integer"}},"type":"object","required":["at","user_id","kind","query_count"],"title":"TextAccess","description":"One read of the space's question texts."},"TextAccessKind":{"enum":["collected","exported","listed","opened"],"title":"TextAccessKind","description":"What somebody did when they read the texts of a space's questions.\n\nEvery read of stored question texts is itself written down under one of\nthese, so an owner can see who looked at what people asked, and how."},"UnusedDocuments":{"properties":{"count":{"type":"integer"},"documents":{"items":{"$ref":"#/components/schemas/DocumentRef"},"type":"array"}},"type":"object","required":["count","documents"],"title":"UnusedDocuments","description":"The documents no question of the period reached."},"VectorBackendPayload":{"properties":{"kind":{"type":"string"},"mode":{"enum":["attached","managed"]},"connection":{"type":"object","default":{}},"storage":{"type":"string","default":""},"field_mapping":{"additionalProperties":{"type":"string"},"type":"object","default":{}}},"additionalProperties":false,"type":"object","required":["kind","mode"],"title":"VectorBackendPayload","description":"A storage backend as a caller asks for it to be registered or replaced.\n\nThe whole row, every time. Reconfiguring one is a replacement rather than a\npatch, and deliberately so: a patch would have to tell \"the field was not\nsent\" from \"the field was cleared\", and on a connection carrying a\ncredential that ambiguity ends with an operator believing they rotated a key\nthat is in fact still the old one. Sending the connection whole means the\nstored connection is always exactly the one the caller last read out of\ntheir own configuration.\n\n``connection`` is free-form here and read through the struct the chosen\n``kind`` declares, since what a key means is that storage technology's to\nsay. It never comes back out: no response this platform serves carries a\nbackend's connection."}},"securitySchemes":{"apiKey":{"type":"apiKey","description":"Server-to-server API key in the header","name":"X-API-Key","in":"header"},"jwt":{"type":"http","description":"JWT token auth","scheme":"Bearer","bearerFormat":"JWT"}}}}