get_reasoner()
relationalai.api
get_reasoner(type STRING, name STRING)A procedure that retrieves details for a specific RAI reasoner.
Requires the eng_user application role.
Parameters
Section titled “Parameters”| Name | Type | Description |
|---|---|---|
type | STRING | Reasoner type. Valid values: 'logic', 'prescriptive', 'predictive'. Case-insensitive. |
name | STRING | Reasoner name (case-sensitive). |
Returns
Section titled “Returns”A table with one row per matching reasoner. The table includes the following columns:
| Column | Type | Description |
|---|---|---|
NAME | STRING | Reasoner name. |
TYPE | STRING | Reasoner type. |
ID | STRING | Reasoner identifier. |
VERSION | STRING | Reasoner version. |
SIZE | STRING | Reasoner size (instance family). |
STATUS | STRING | Current reasoner status. See Reasoner statuses. |
CREATED_BY | STRING | Creator identifier. |
CREATED_ON | TIMESTAMP_LTZ | Creation time. |
UPDATED_ON | TIMESTAMP_LTZ | Last update time. |
AUTO_SUSPEND_MINS | INT | Auto-suspend inactivity window in minutes. |
SUSPENDS_AT | TIMESTAMP_LTZ or NULL | Scheduled suspend time (if applicable). |
SETTINGS | STRING | Serialized settings payload. |
RUNTIME | STRING | Runtime information. |
Reasoner statuses
Section titled “Reasoner statuses”| Status | Description |
|---|---|
READY | The reasoner is running and ready to use. |
PENDING | The reasoner is not ready yet. It might be starting, resuming, provisioning an endpoint, or finishing its configuration. Wait and check the status again. |
SUSPENDING | The reasoner is being suspended. Wait until the status changes to SUSPENDED. |
SUSPENDED | The reasoner is suspended. Call api.resume_reasoner_async() to resume it before use. |
UPGRADING | The reasoner is being upgraded. Wait and check the status again before using it. |
DELETING | The reasoner is being deleted. Wait until it no longer appears in api.reasoners. |
FAILED | The reasoner’s service failed. Delete it with api.delete_reasoner(), then recreate it with api.create_reasoner(). |
GONE | The reasoner’s service no longer exists, but its metadata remains. Delete the stale reasoner with api.delete_reasoner(), then recreate it with api.create_reasoner(). |
Example
Section titled “Example”Get details for a logic reasoner named my_reasoner:
CALL relationalai.api.get_reasoner('logic', 'my_reasoner');