feat: make showing outputs optional on the cli

Author: loukratz-bv

docs/Gallery/dataflow_pipelines.md

@@ -64,11 +64,24 @@ Example output:
 
 You'll notice that the output shows 1 message for `write_results` and 10 for the others. That is because it is reporting the number of messages _emitted_ from each step, and `write_results` is a sink that collects all messages.
 
-The final message of the output will be the result file where the data are written:
+By default, QType shows a summary of the results. The final message will show:
 
 ```
 2026-01-16 11:23:35,151 - INFO: ✅ Flow execution completed successfully
-2026-01-16 11:23:35,151 - INFO: Processed 1 em
+2026-01-16 11:23:35,151 - INFO: Processed 1 rows
+2026-01-16 11:23:35,152 - INFO: 
+Results summary: 1 rows, 1 columns: ['result_file']
+```
+
+To see the full output data, add the `--show-output` flag:
+
+```bash
+qtype run -i '{"output_path":"results.parquet"}' --progress --show-output examples/data_processing/dataflow_pipelines.qtype.yaml
+```
+
+This will display:
+
+```
 2026-01-16 11:23:35,152 - INFO: 
 Results:
 result_file: results.parquet

docs/Gallery/research_assistant.md

@@ -59,7 +59,7 @@ qtype validate examples/research_assistant/research_assistant.qtype.yaml
 
 # Run directly
 qtype run -i '{"topic":"Latest developments in retrieval augmented generation"}' \
-  examples/research_assistant/research_assistant.qtype.yaml
+  --show-output examples/research_assistant/research_assistant.qtype.yaml
 ```
 
 ### Example Output

docs/Reference/cli.md

@@ -38,6 +38,7 @@ qtype run [options] spec
 - **`-I INPUT_FILE, --input-file INPUT_FILE`** - Path to a file (e.g., CSV, JSON, Parquet) with input data for batch processing
 - **`-o OUTPUT, --output OUTPUT`** - Path to save output data. If input is a DataFrame, output will be saved as parquet. If single result, saved as JSON
 - **`--progress`** - Show progress bars during flow execution
+- **`--show-output`** - Display full output data in console (default: summary only)
 
 #### Examples
 

docs/Tutorials/01-first-qtype-application.md

@@ -180,7 +180,7 @@ Replace `sk-your-key-here` with your actual OpenAI API key.
 Run your application:
 
 ```bash
-qtype run -i '{"question":"What is 2+2?"}' 01_hello_world.qtype.yaml
+qtype run -i '{"question":"What is 2+2?"}' --show-output 01_hello_world.qtype.yaml
 ```
 
 **What you should see:**

docs/Tutorials/03-structured-data.md

@@ -316,7 +316,7 @@ Should pass ✅
 ### Run It!
 
 ```bash
-qtype run -i '{"review_text":"These headphones are amazing! Great sound quality and super comfortable. Battery lasts all day."}' 03_structured_data.qtype.yaml
+qtype run -i '{"review_text":"These headphones are amazing! Great sound quality and super comfortable. Battery lasts all day."}' --show-output 03_structured_data.qtype.yaml
 ```
 
 **Expected output:**

docs/Tutorials/04-tools-and-function-calling.md

@@ -305,7 +305,7 @@ Should pass ✅
 ### Run the Application
 
 ```bash
-qtype run -i '{"days_until_due": 3}' 04_tools_and_function_calling.qtype.yaml
+qtype run -i '{"days_until_due": 3}' --show-output 04_tools_and_function_calling.qtype.yaml
 ```
 
 **Expected output:**

qtype/commands/run.py

@@ -185,7 +185,7 @@ def run_flow(args: Any) -> None:
 
         # Display results
         if len(result_df) > 0:
-            logger.info(f"Processed {len(result_df)} em")
+            logger.info(f"Processed {len(result_df)} rows")
 
             # Remove 'row' and 'error' columns for display if all errors are None
             display_df = result_df.copy()
@@ -197,15 +197,37 @@ def run_flow(args: Any) -> None:
             if "row" in display_df.columns:
                 display_df = display_df.drop(columns=["row"])
 
-            if len(display_df) > 1:
-                logger.info(f"\nResults:\n{display_df[0:10].to_string()}\n...")
-            else:
-                # Print the first row with column_name: value one per line
-                fmt_str = []
-                for col, val in display_df.iloc[0].items():
-                    fmt_str.append(f"{col}: {val}")
-                fmt_str = "\n".join(fmt_str)
-                logger.info(f"\nResults:\n{fmt_str}")
+            # Show summary for console display
+            logger.info(
+                f"\nResults summary: {len(display_df)} rows, "
+                f"{len(display_df.columns)} columns: {list(display_df.columns)}"
+            )
+
+            # Optionally show full output
+            if args.show_output:
+                # Truncate long strings for display
+                max_col_width = 100
+                for col in display_df.columns:
+                    display_df[col] = display_df[col].apply(
+                        lambda x: (
+                            f"{str(x)[:max_col_width]}..."
+                            if isinstance(x, str)
+                            and len(str(x)) > max_col_width
+                            else x
+                        )
+                    )
+
+                if len(display_df) > 1:
+                    logger.info(
+                        f"\nResults:\n{display_df[0:10].to_string()}\n..."
+                    )
+                else:
+                    # Print the first row with column_name: value one per line
+                    fmt_str = []
+                    for col, val in display_df.iloc[0].items():
+                        fmt_str.append(f"{col}: {val}")
+                    fmt_str = "\n".join(fmt_str)
+                    logger.info(f"\nResults:\n{fmt_str}")
 
             # Save the output
             if args.output:
@@ -267,6 +289,11 @@ def parser(subparsers: argparse._SubParsersAction) -> None:
         action="store_true",
         help="Show progress bars during flow execution.",
     )
+    cmd_parser.add_argument(
+        "--show-output",
+        action="store_true",
+        help="Display full output data in console (default: summary only).",
+    )
 
     cmd_parser.add_argument(
         "spec", type=str, help="Path to the QType YAML spec file."