Search Modaic documentation

Find a Modaic guide or API reference

modaic alignments

create

Start alignment. See data requirements.

modaic alignments create acme/support-priority --branch main
Flag / argumentWhat it does
WORKSPACE/MODELRequired model path, such as acme/support-priority.
--branchBranch to align. Default: main.
--source-commit-shaStarting commit. Defaults to the commit returned by the model lookup.
--max-metric-callsEvaluation budget. Omit to size automatically.
--idempotency-keyRetry key for this exact request. Generated when omitted.
--reflection-modelModel used to propose instruction changes.
--reflection-minibatch-sizeExamples per reflection minibatch.
--seedRandom seed. Default: 0.
-h, --helpShow usage and options.

list

List recent alignments for a model.

modaic alignments list acme/support-priority --limit 10
Flag / argumentWhat it does
WORKSPACE/MODELRequired model path, such as acme/support-priority.
--limitMaximum number of jobs. Default: 20.
-h, --helpShow usage and options.

get

Read alignment status and results.

modaic alignments get ALIGNMENT_ID
Flag / argumentWhat it does
ALIGNMENT_IDRequired alignment job ID.
-h, --helpShow usage and options.

logs

Read available alignment output.

modaic alignments logs ALIGNMENT_ID
Flag / argumentWhat it does
ALIGNMENT_IDRequired alignment job ID.
-h, --helpShow usage and options.

cancel

Request cancellation.

modaic alignments cancel ALIGNMENT_ID
Flag / argumentWhat it does
ALIGNMENT_IDRequired alignment job ID.
-h, --helpShow usage and options.
Was this page helpful?