Skip to main content
DocumentationLibraryReference
On this page

Kater CLI Explore and try ideas explore definition

kater explore definition generate

Saves a shared model's Explore file, with its questions, and with --llm plans that an AI model makes.

Use it to make the file, or to plan the model’s questions. It needs write access to the file, beside the model.

Examples

Terminal window
# Save the Explore file of the ad_reporting model again, while it has this revision
kater explore definition generate --model semantic.ad_reporting \
  --scope connections/snowflake_prod_connection/modeling \
  --expected-revision 546c87e5d0d229965dc939b1d7b152aac6762c15e61884fd20b75ba2c7b1b37a
# Also plan up to two questions with an AI model, and add new questions
kater explore definition generate --model semantic.ad_reporting \
  --scope connections/snowflake_prod_connection/modeling \
  --expected-revision 546c87e5d0d229965dc939b1d7b152aac6762c15e61884fd20b75ba2c7b1b37a --llm
# Plan one question, by the id that kater explore use-case list gives
kater explore definition generate --model semantic.ad_reporting \
  --scope connections/snowflake_prod_connection/modeling \
  --expected-revision 546c87e5d0d229965dc939b1d7b152aac6762c15e61884fd20b75ba2c7b1b37a \
  --question 8011ea1a161a2829d33e04820aa3cca358c5e553ad475f2f6b1caeeace9213d1

Options

OptionDescription
--request-file <file>The whole request as JSON, from a file, in place of the other options. - reads stdin. It holds namespace and source, and can hold expected_revision, llm, questions and dry_run.
--model <model>The shared model, by its name or its typed address, such as semantic.ad_reporting. Give --scope with it: the connection’s modeling folder.
--llmAlso asks an AI model to plan up to two questions that have no plan yet, and to add new questions.
--question <id>Plans only this question, by the id that kater explore use-case list gives. It must have no plan yet. Give up to three. It asks an AI model, so it turns on --llm, and adds no new questions. You can give it more than one time.
--expected-revision <revision>The Explore file’s revision, from kater explore definition show. Give it when the file already exists. The save stops when the file changed since.

It also takes the global options --json, --kater-root, --scope and --help.

What it saves

  • Without --llm. The file holds the questions the model’s authors wrote. An existing file keeps its questions and plans.
  • With --llm or --question. An AI model also plans questions, and with --llm alone it adds new ones.
  • A model that must be built first. It saves nothing, and says why.
  • A hosted Kater. Planning needs your organisation’s AI provider and its API key.

In a request file, "dry_run": true checks the save and writes nothing. A dry run cannot plan questions.

See also