AI commands - Omni CLI

AI-powered query generation, job management, and documentation search. See the AI API documentation for more information.

AI evals, model suggestions, and routines have their own command groups: omni ai-eval, omni ai-model-suggestions, and omni ai-routines.

omni ai <command>

Command	Description
`generate-query`	Generate and optionally execute a query from natural language
`pick-topic`	Pick the best topic for a prompt
`search-omni-docs`	Search Omni documentation
`job-submit`	Submit an AI job
`job-status`	Get AI job status
`job-cancel`	Cancel an AI job
`job-result`	Get AI job result
`job-visualization`	Render AI job visualization
`job-feedback-submit`	Rate a finished AI job’s response, successful or failed
`branding`	Get AI helper branding
`conversations-list`	List AI conversations
`conversation-detail`	Get AI conversation with messages
`credit-controls-get`	Get AI credit controls
`credit-controls-update`	Update AI credit controls
`credit-controls-users-list`	List individual users’ AI credit limits
`credit-controls-users-update`	Set individual users’ AI credit limits
`credit-controls-entity-groups-list`	List individual entity groups’ AI credit limits
`credit-controls-entity-groups-update`	Set individual entity groups’ AI credit limits
`credit-usage-users-read`	Read individual users’ AI credit usage
`credit-usage-entity-groups-read`	Read individual entity groups’ AI credit usage

job-feedback-submit records the same thumbs up or thumbs down, and optional comment, that a user can give in the Omni chat UI or Slack. The job must have finished. Feedback is append-only and no command reads it back.

# Answer a question about your data
omni ai generate-query --body '{"modelId":"MODEL_ID","prompt":"how many active users","executeQuery":true}'

# Search the Omni docs
omni ai search-omni-docs --body '{"query":"how do I..."}'

# View help for job-status command, including arguments and flag details
omni ai job-status --help

Every command in this group also accepts the global flags, including --token, --profile, --format, and --compact.

Getting started

Command groups

Reference

AI commands - Omni CLI