Skip to content

jobs:create

Terminal window
rai jobs:create [OPTIONS]

Create a job.

--payload-json accepts a JSON object and is applied last, so it can override values composed from convenience flags such as --database, --raw-code, --inputs-json, and --headers-json.

The composed payload always includes convenience keys such as:

  • raw_code
  • inputs
  • optionally headers and timeout_mins

For Logic, it also adds transaction-style keys such as:

  • dbname
  • query
  • v1_inputs

Logic:

rai jobs:create --type Logic --name TEST --database my_db --raw-code 'def output = 1'

Logic with explicit payload:

rai jobs:create --type Logic --name TEST --payload-json '{"dbname":"my_db","query":"def output = 1"}'

Prescriptive with explicit payload:

rai jobs:create --type Prescriptive --name TEST --payload-json '{"raw_code":"solve {}","inputs":{"x":1}}'

OptionTypeDescription
--typetextJob type (Logic/Prescriptive/Predictive).
--reasoner-name, --nametextReasoner name to run on (optional).
--databasetextDatabase (required for Logic when composing a payload).
--raw-codetextRaw code for payload construction.
--raw-code-filefile
--inputs-jsontextInputs JSON object (default: ).
--headers-jsontextHeaders JSON object (optional).
--languagetextDefault: rel.
--payload-jsontextJSON object to override/extend the composed payload; must decode to a dict. Default: {}.
--timeout-minsinteger
--timeout-sfloatTimeout in seconds while waiting until the job reaches a terminal state. Default: 900.0.
--poll-interval-sfloatPolling interval in seconds while waiting until the job reaches a terminal state. Default: 0.5.
--bypass-indexBooleanDefault: False.
--gi-setup-skippedBooleanDefault: False.
--readonly, --readwriteBooleanDefault: True.
--waitBooleanWait until the job reaches a terminal state before returning. Default: False.