Skip to content

rai-setup: document the SQL-procedure reasoner surface, align engine sizes with platform docs - #41

Merged
cafzal merged 1 commit into
mainfrom
setup-engine-management
May 6, 2026
Merged

rai-setup: document the SQL-procedure reasoner surface, align engine sizes with platform docs#41
cafzal merged 1 commit into
mainfrom
setup-engine-management

Conversation

@cafzal

@cafzal cafzal commented May 4, 2026

Copy link
Copy Markdown
Collaborator

Why

The CLI and Python clients (rai reasoners:*, Resources, connect_sync()) are thin wrappers over RELATIONALAI.API.* stored procedures, but rai-setup documents only the wrappers — not the procedures themselves. That leaves a gap for notebook / SQL-only workflows, and for the case where the CLI version trails the backend on a new flag.

Reasoner-agnostic — applies to logic and prescriptive engines. Predictive-specific sizing/routing (GPU sizes, ML-pool routing) and the EXPERIMENTAL.* procedure ban (which only matters with a specific GNN-service example) ship with the predictive skills in #21.

Changes

plugins/rai/skills/rai-setup/references/engine-management.md — new section "SQL stored procedures (canonical fallback)":

  • Procedure / view table aligned with docs.relational.ai/manage/compute-resources: CREATE_REASONER / CREATE_REASONER_ASYNC, GET_REASONER, SUSPEND_REASONER, RESUME_REASONER_ASYNC, DELETE_REASONER, ALTER_REASONER_AUTO_SUSPEND_MINS, ALTER_REASONER_POOL_NODE_LIMITS, GET_JOB, CANCEL_JOB, plus the api.REASONERS and api.JOBS views.
  • Async + poll example showing CREATE_REASONER_ASYNC → loop on GET_REASONER until STATUS=READY.

plugins/rai/skills/rai-setup/references/reasoners.md:

  • Engine sizes table is now reasoner-aware (Logic + Prescriptive columns, AWS + Azure columns), reflecting the platform-doc note that HIGHMEM_X64_L (AWS) and HIGHMEM_X64_SL (Azure) are Logic-only — Prescriptive does not currently accept the largest tier on either cloud.
  • Note on the standard RELATIONAL_AI_<INSTANCE_FAMILY> compute-pool naming visible in GET_REASONER's RUNTIME field.
  • Cross-link to the official compute-resources management page.

Test plan

  • All cross-referenced procedures match the public docs at docs.relational.ai/manage/compute-resources — surface aligned, no SDK-internal procs leaked.
  • CLI commands referenced (rai reasoners:create/delete/suspend/resume/list/get/alter) match the documented CLI surface.
  • Engine-sizes table reflects the doc-noted Logic-vs-Prescriptive size compatibility (HIGHMEM_X64_L AWS-Logic-only, HIGHMEM_X64_SL Azure-Logic-only).
  • No predictive-specific content (no GPU_NV_S, no _ML pool naming, no EXPERIMENTAL.* callout, no EXPERIMENTS schema discussion) — those land with PR Predictive skills: two-skill workflow (modeling + training) #21 in the predictive skills.

Related

  • Predictive skills: two-skill workflow (modeling + training) #21 — predictive skills. Has a parallel section in rai-predictive-modeling § Engine sizing covering CPU vs GPU heuristics, the GNN-specific allow-list gap, and the _ML-suffixed compute-pool routing for predictive workloads. The EXPERIMENTAL.* procedure ban (with the CREATE_GNN_SERVICE example) lives there in rai-health § Predictive train jobs stuck QUEUED.

@cafzal
cafzal force-pushed the setup-engine-management branch from 4600d94 to 1ce99cb Compare May 4, 2026 21:50
@cafzal cafzal changed the title rai-setup: document the SQL-procedure reasoner surface + reasoner-type-aware engine sizes rai-setup: document the SQL-procedure reasoner surface, align engine sizes with platform docs May 4, 2026
…sizes with platform docs

The CLI and Python clients are thin wrappers over RELATIONALAI.API.*
stored procedures. Surfacing the procedures directly closes a real
gap: notebook/SQL-only workflows that don't run the CLI, and the case
where the CLI version trails the backend on a new flag or size.

Reasoner-agnostic — applies to logic + prescriptive equally. Predictive
sizing/routing specifics ship with the predictive skills (PR #21).

- references/engine-management.md: new "SQL stored procedures (canonical
  fallback)" section. Procedure table covers CREATE_REASONER /
  CREATE_REASONER_ASYNC, GET_REASONER, SUSPEND_REASONER,
  RESUME_REASONER_ASYNC, DELETE_REASONER,
  ALTER_REASONER_AUTO_SUSPEND_MINS, ALTER_REASONER_POOL_NODE_LIMITS,
  GET_JOB, CANCEL_JOB, plus the api.REASONERS and api.JOBS views.
  Aligned with the surface documented at
  docs.relational.ai/manage/compute-resources. Async + poll example.
  Generic "do not call RELATIONALAI.EXPERIMENTAL.*" callout (no
  reasoner-specific examples — those live with the relevant reasoner
  skills).
- references/reasoners.md: Engine sizes table is now reasoner-aware
  (Logic + Prescriptive columns, AWS + Azure columns), reflecting the
  doc note that HIGHMEM_X64_L (AWS) and HIGHMEM_X64_SL (Azure) are
  Logic-only — Prescriptive does not currently accept the largest tier
  on either cloud. Adds a runtime note about the standard
  RELATIONAL_AI_<INSTANCE_FAMILY> compute-pool naming visible in
  GET_REASONER's RUNTIME field, with a link to the platform doc.
@cafzal
cafzal force-pushed the setup-engine-management branch from 1ce99cb to a1e4303 Compare May 4, 2026 22:00
@manish-code125

Copy link
Copy Markdown
Contributor

This looks good.

@cafzal
cafzal merged commit 45acdf6 into main May 6, 2026
@cafzal
cafzal deleted the setup-engine-management branch May 6, 2026 15:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants