Skip to content
These docs are for v1 of RelationalAI.
Click here to view the v2 docs
.
RelationalAI Docs
Search
Ctrl
K
Cancel
GitHub
Get Started
Build
Manage
API Reference
Release Notes
Python
v1.21
Overview
agent
Overview
cortex
Overview
APIResponseError
chat
Overview
ChatResponse
CortexAgentChat
cortex_agent_manager
Overview
CortexAgentManager
CortexAgentApi
CortexThreadApi
deployment_config
Overview
DeploymentConfig
DeploymentStatus
discover_imports
Overview
discover_imports
http_client
queries
Overview
CompositeQueries
DYNAMIC_QUERY_ID
DynamicQueries
Queries
QueryCatalog
tool
Overview
DefaultTool
MaturityLevel
Tool
ToolRegistry
verbalize
Overview
ModelVerbalizer
SourceCodeVerbalizer
Verbalizer
auth
Overview
handlers
Overview
base
Overview
DirectAccessAuthError
DirectAccessConfigError
DirectAccessEndpointStaleError
DirectAccessOAuthBrowserOpenError
DirectAccessOAuthError
DirectAccessOAuthInvalidClientError
DirectAccessOAuthStateMismatchError
DirectAccessOAuthTimeoutError
client
Overview
client
Overview
Client
client_sync
Overview
ClientSync
connect
connect_sync
errors
Overview
exceptions
Overview
AbortedTransactionError
ClientAuthError
ClientConflictError
ClientError
ClientInvalidRequestError
ClientNotFoundError
ClientNotReadyError
ClientServerError
ClientSqlCompilationError
ClientTimeoutError
ClientUnknownError
DuoSecurityFailed
SnowflakeAppMissingException
SnowflakeConnectionFailed
SnowflakeDatabaseException
SnowflakeRaiAppNotStarted
from_session
from_session_sync
config
Overview
config
Overview
Config
ConfigFromRAIConfigToml
create_config
RAIConfig
config_deployment_fields
Overview
DeploymentConfig
OutputsConfig
config_fields
Overview
CompilerConfig
DataConfig
DebugConfig
ExecutionConfig
JobsConfig
ModelConfig
OplogConfig
RetriesConfig
config_reasoners_fields
Overview
AWSEngineSize
AzureEngineSize
EngineSize
InternalEngineSize
LogicReasonerConfig
PrescriptiveReasonerConfig
ReasonerConfig
ReasonerLogicLqpConfig
ReasonersConfig
connections
Overview
base
Overview
BaseConnection
ConnectionConfig
duckdb
local
Overview
LocalConnection
snowflake
Overview
ExternalBrowserAuth
JWTAuth
OAuthAuth
OAuthAuthorizationCodeAuth
OAuthClientCredentialsAuth
ProgrammaticAccessTokenAuth
SnowflakeAuthenticator
SnowflakeConnection
SnowflakeConnectionBase
UsernamePasswordAuth
UsernamePasswordMFAAuth
errors
Overview
context
Overview
ConfigErrorContext
ConfigSourceType
exceptions
Overview
AttemptedSource
ConfigCloseError
ConfigError
ConfigFieldMissingError
ConfigFieldTypeError
ConfigFileNotFoundError
ConfigValidationError
semantics
Overview
alias
data
define
distinct
frontend
Overview
base
Overview
Aggregate
Alias
AsBool
Chain
Concept
Data
DerivedColumn
DerivedTable
Distinct
DSLBase
Expression
Field
FieldRef
FilterBy
Fragment
generates_rules
Group
Literal
LookupBy
Match
Model
New
Not
NumberConcept
Primitive
Property
Reading
Ref
Relationship
Statement
StatementAndSchema
Table
TableSchema
TupleVariable
Union
Value
Variable
core
Overview
Any
AnyEntity
AnyNumber
Bool
Boolean
Date
DateTime
Decimal
DefaultNumber
Error
Float
Hash
Int
Int64
Int128
Integer
Number
Numeric
ScaledNumber
String
not_
reasoners
Overview
graph
Overview
core
Overview
Graph
predictive
Overview
estimator
Overview
GNN
property_transformer
Overview
PropertyTransformer
prescriptive
Overview
all_different
implies
problem
Overview
Problem
special_ordered_set_type_1
special_ordered_set_type_2
require
select
std
Overview
aggregates
Overview
asc
avg
bottom
count
cumsum_asc
desc
limit
max
min
per
Per
product
rank
rank_asc
rank_desc
stddev_samp
string_join
sum
top
common
Overview
cast
hash
parse_uuid
range
raw_source
uuid_to_string
constraints
Overview
anyof
exclusive
oneof
unique
datetime
Overview
date
DatePart
datetime
DateTimePart
days
Frequency
hours
ISO
microseconds
milliseconds
minutes
months
nanoseconds
seconds
weeks
years
DateTimeValue
DateValue
decimals
Overview
decimal
is_decimal
parse
parse_decimal
precision
scale
size
floats
Overview
float
parse_float
FloatValue
integers
Overview
int64
int128
parse
parse_int64
parse_int128
IntegerValue
math
Overview
abs
acos
acosh
acot
asin
asinh
atan
atanh
cbrt
ceil
clip
cos
cosh
cot
degrees
erf
erfinv
exp
factorial
floor
floor_divide
haversine
isclose
isinf
isnan
log
log2
log10
maximum
minimum
modulo
natural_log
pow
radians
remainder
round
sign
sin
sinh
sqrt
tan
tanh
trunc_divide
numbers
Overview
digits_to_bits
integer
is_number
number
parse
parse_number
precision
scale
size
NumberValue
re
Overview
findall
fullmatch
match
RegexMatch
search
sub
strings
Overview
concat
contains
endswith
join
len
levenshtein
like
lower
regex_match
replace
split
split_part
startswith
string
strip
substring
upper
StringValue
union
where
services
Overview
jobs
Overview
client
Overview
JobsClient
client_sync
Overview
JobsClientSync
errors
Overview
JobCapabilityError
JobClientDisconnectedError
JobConfigurationError
JobError
JobInvalidRequestError
JobNotFoundError
JobNotReadyError
JobServerError
JobTimeoutError
JobUnknownError
reasoners
Overview
client
Overview
ReasonersClient
client_sync
Overview
ReasonersClientSync
errors
Overview
ReasonerAuthError
ReasonerConflictError
ReasonerError
ReasonerHttpError
ReasonerInvalidRequestError
ReasonerNotFoundError
ReasonerNotReadyError
ReasonerServerError
ReasonerTimeoutError
ReasonerUnknownError
ReasonerValidationException
CLI
v1.21
Overview
clean
Overview
cache
debugger
commands
completion
Overview
bash
fish
install
zsh
config
Overview
current
explain
profiles
Overview
con
use
connect
debugger
doctor
Overview
cache
Overview
check
report
init
jobs
Overview
cancel
create
events
get
list
wait
models
Overview
branch
deploy
init
list
merge
pull
switch
teardown
reasoners
Overview
alter
create
delete
get
list
resume
sizes
suspend
wait
version
whoami
SQL
Overview
api
Overview
alter_engine_auto_suspend_mins()
alter_engine_pool_node_limits()
alter_export_task_timeout()
alter_export_task_wh_size()
alter_reasoner_auto_suspend_mins()
alter_reasoner_pool_node_limits()
cancel_blob_gc()
cancel_job()
cancel_own_transaction()
cancel_transaction()
cleanup_stale_data_streams()
create_data_stream()
create_engine()
create_reasoner()
data_stream_batches
data_stream_errors
data_streams
delete_data_stream()
delete_engine()
delete_reasoner()
drop_result_table()
engines
get_data_stream()
get_engine()
get_job_events()
get_job_metadata()
get_job()
get_reasoner()
get_transaction_problems()
get_transaction()
jobs
object_reference()
reasoners
resume_data_stream()
resume_engine_async()
resume_engine()
resume_reasoner_async()
show_warm_engines()
suspend_data_stream()
suspend_engine()
suspend_reasoner()
transactions
update_libraries()
app
Overview
activate()
alter_cdc_engine_size()
alter_cdc_reasoner_size()
cdc_status()
cleanup_unused_data_stream_references()
deactivate()
disable_warm_engine()
disable_warm_reasoner()
drop_service()
enable_warm_engine()
enable_warm_reasoner()
get_release()
get_service()
reference_audit()
resume_cdc()
schedule_upgrade()
service_status()
set_warm_reasoners()
suspend_cdc()
unschedule_upgrade()
upgrade_reasoners_status
upgrade_reasoners()
upgrade_schedule_status()
upgrade_status
upgrade_status_details
upgrade()
consumption
Overview
engine_credit_hours
observability_preview
Overview
logic_reasoner__cpu_utilization
logic_reasoner__demand
logic_reasoner__memory_utilization
predictive_reasoner__active_jobs
predictive_reasoner__cpu_utilization
predictive_reasoner__gpu_memory_utilization
predictive_reasoner__gpu_utilization
predictive_reasoner__memory_utilization
prescriptive_reasoner__active_jobs
prescriptive_reasoner__cpu_utilization
prescriptive_reasoner__memory_utilization
GitHub
API
CLI
v1.21
connect
Copy page
Copy page
Open in ChatGPT
Open in Claude
Terminal window
rai
connect
Validate config and database connection.
Options
None.
See Also
commands
debugger
init
version
whoami
