Search Modaic documentation

Find a Modaic guide or API reference

modaic examples

create

Upload examples from a file.

modaic examples create acme/support-priority --file examples.jsonl
Flag / argumentWhat it does
WORKSPACE/MODELRequired model path, such as acme/support-priority.
--fileRequired JSONL, JSON array, or object with an examples array.
-h, --helpShow usage and options.

Example JSONL row:

{"state":"Checkout is unavailable","annotation":{"ground_truth":{"urgent":true}}}

list

List a page of examples.

modaic examples list acme/support-priority --page 1 --page-size 20
Flag / argumentWhat it does
WORKSPACE/MODELRequired model path, such as acme/support-priority.
--pagePage number. Default: 1.
--page-sizeExamples per page. Default: 30.
-h, --helpShow usage and options.

summary

Read example and annotation counts.

modaic examples summary acme/support-priority
Flag / argumentWhat it does
WORKSPACE/MODELRequired model path, such as acme/support-priority.
-h, --helpShow usage and options.

get

Read one example.

modaic examples get acme/support-priority EXAMPLE_ID
Flag / argumentWhat it does
WORKSPACE/MODELRequired model path, such as acme/support-priority.
EXAMPLE_IDRequired example ID.
-h, --helpShow usage and options.

annotate

Add or update an example label.

modaic examples annotate acme/support-priority EXAMPLE_ID --file annotation.json
Flag / argumentWhat it does
WORKSPACE/MODELRequired model path, such as acme/support-priority.
EXAMPLE_IDRequired example ID.
--fileRequired JSON file with ground_truth and/or ground_reasoning.
-h, --helpShow usage and options.

Example annotation.json:

{"ground_truth":{"urgent":true},"ground_reasoning":"Checkout is blocked."}

decisions

Read decisions for an example.

modaic examples decisions acme/support-priority EXAMPLE_ID
Flag / argumentWhat it does
WORKSPACE/MODELRequired model path, such as acme/support-priority.
EXAMPLE_IDRequired example ID.
-h, --helpShow usage and options.
Was this page helpful?