[Demo] Add TUI agent chat command by tacman · Pull Request #2158 · symfony/ai

tacman · 2026-06-12T00:32:08Z

Q	A
Bug fix?	no
New feature?	yes
Docs?	no
Issues	-
License	MIT

Adds a terminal UI chat command to the demo application so the configured agents can be explored directly from the console.

The command provides an agent picker, streaming chat output, a verbose debug pane for tool calls and token usage, and returns to the picker after leaving a chat session. The demo dependencies are also updated to Symfony 8.1 packages so it can use the new TUI component.

No separate documentation was added because this is a demo-only interactive command and is discoverable via bin/console list app.

Validation:

composer validate --no-check-publish
php -l demo/src/Tui/Command/ChatTuiCommand.php
git diff --check origin/main..HEAD
php bin/console lint:yaml config --parse-tags
vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php --dry-run --diff demo/src/Tui/Command/ChatTuiCommand.php
cd demo && vendor/bin/phpstan
cd demo && vendor/bin/phpunit
cd demo && php bin/console list app --format=txt

tacman · 2026-06-12T00:35:11Z

I kept forgetting which agent did what, so I wrote the tui version of chat to give a lot more details to help select the agent.

The TUI component rocks.

The chat is similar to https://github.com/GromNaN/symfony-tui-games in that it prompts you for a chat agent and returns to it when you're done, like the games menu does.

OskarStark · 2026-06-12T05:19:16Z

Nice one 😊

GromNaN

Very nice.

Since it's requiring symfony/tui, you can assume symfony/console 8.1 is used and use the fancy features like invokable commands with validation.

…face `CachePlatform` could only build a cache key for `string`, `array` and `MessageBag` inputs and threw on anything else, so it could not decorate platform tasks whose top-level input is a content object — audio transcription (`Audio`), OCR (`DocumentUrl`/`Document`) and single-image vision (`ImageUrl`/`Image`). Add an opt-in `CacheableInputInterface` exposing a stable, cache-key-safe `getCacheKey()`, honored by `CachePlatform` before its `default` throw. `DocumentUrl` and `ImageUrl` key on the URL, `File` (and its `Audio`, `Image`, `Video` and `Document` subclasses) on a hash of its bytes. This is additive: inputs not implementing the interface behave as before, and third-party inputs can opt in without touching the bridge. See symfony#2159

Add a dedicated `Ocr` model with its own `ModelClient` and `ResultConverter` for Mistral's `mistral-ocr-latest` model, which uses the `/v1/ocr` endpoint rather than chat completions. The result is a typed `OcrResult` (pages, layout images with bounding boxes, per-page annotations and usage info) returned via `ObjectResult`/`asObject()`, not a text blob. Document URL, binary PDF and image inputs are supported by widening the existing `Document`, `DocumentUrl` and `ImageUrl` contract normalizers to also accept the `Ocr` model. Catalog entries (`mistral-ocr-latest`, `mistral-ocr-2505`) and a generator rule keep OCR models out of the chat model class. Fix symfony#2072

Add a chat feature that accepts a document URL, extracts its text with Mistral OCR (`mistral-ocr-latest` via the new `ai.platform.mistral` platform) and answers questions about the document. The OCR result is cached per document URL in `OcrExtractor` so the billed OCR endpoint is only ever called once per document.

chr-hertel · 2026-06-12T19:47:14Z

+            $names = array_map(static fn (object $c): string => strtolower(str_replace('_', '-', $c->name)), $capabilities);
+
+            return implode(', ', $names);
+        } catch (\Throwable) {


which exception are you expecting here?

ModelNotFound -- I'm fixing the code to reflect that.

chr-hertel · 2026-06-12T19:49:12Z

+
+        $metadata = $result->getMetadata();
+        $usage = $metadata->get('token_usage');
+        if (!$usage instanceof TokenUsage) {


we should test for the interface instead

yep! Fixing now.

tacman · 2026-06-12T20:20:37Z

Thanks for the review — those were dev shortcuts, now fixed:

catch (\Throwable) → catch (ModelNotFoundException) (the expected case: the agent's configured model isn't in its platform's catalog), so anything else fails loud.
method_exists($result, 'getMetadata') → a typed ResultInterface $result param (it extends MetadataAwareInterface); and the method_exists($agent, 'getModel') checks → $agent instanceof Agent.

More broadly, the whole unwrapAgent() + reflection in here is a deliberate stopgap. AgentInterface exposes only call()/getName(), and TraceableAgent doesn't forward getModel(), so to show the model/capabilities the demo has to peel decorators and read private properties — not something the official demo should ship long-term.

Would you be open to AgentInterface::getModel(): ?Model (nullable for multi-agent setups with no single model), with the decorators delegating? That would let consumers drop the unwrapping and reflection entirely. Happy to open a small focused PR for it — until then the unwrap stays as a temporary workaround.

Add Capability::description() for a human-readable summary of each capability, and Capability::inputContentType() mapping an input capability to the Message\Content class it accepts (e.g. INPUT_PDF -> DocumentUrl). Used by the demo's capability explorer TUI.

Add app:capabilities (browse models by platform/capability, backed by the new Capability::description()) and app:tools (browse agent tools). Harden ChatTuiCommand: drop method_exists() guards in favour of instanceof/type checks and catch ModelNotFoundException specifically. Pull in symfony/models-dev for a richer model catalog to explore.

Add a curated sample-document picker (with an "I'll provide my own URL" option), open the chat with an agent-generated summary instead of the raw OCR dump, surface fetch/OCR failures to the user, and show a loading state while reading. Sample list and summary prompt move to parameters in services.yaml.

# Conflicts: # src/platform/CHANGELOG.md

# Conflicts: # demo/composer.json # src/platform/CHANGELOG.md # src/platform/src/Bridge/Mistral/CHANGELOG.md

Add replace (all 90 symfony/ai-* sub-packages + symfony/mcp-bundle), autoload (per-component PSR-4, which transitively covers every nested bridge), and extra.branch-alias dev-tac => 0.10.x-dev so consumers can `composer require symfony/ai:dev-tac` from this fork and get every AI component (incl. Mistral OCR, cache key, Capability self-description) resolved transitively. Fork-only convenience commit.

Since replace makes composer ignore the replaced sub-packages' own requires, the umbrella must declare their third-party runtime deps itself. Aggregate the deps of the 7 core components plus the bridges the demo/release use (oskarstark/enum-helper, psr/log, symfony/* core, mcp/sdk, etc.) so `composer require symfony/ai:dev-tac` is self- sufficient. Fork-only convenience commit.

Add a VCS repository for tacman/ai and require symfony/ai:dev-tac (the umbrella), so the demo resolves every AI component from the fork — incl. Mistral OCR, the cache key interface, and Capability self-description — instead of dev-linking local src or pulling vanilla 0.10 from Packagist. Flex registers the ux-typed TypedBundle the demo already uses.

A handwritten 1863 NARA document (multi-page PDF) — a strong OCR demo.

Track composer.lock (the demo is an app) and add a bin/deploy that builds a throwaway git repo from this monorepo subdir and pushes it to Dokku, setting API* config from .env.local. Adds survos/deployment-bundle (dev).

chr-hertel · 2026-06-19T23:05:23Z

looks like this branch got mixed up with the #2161

document_annotation is a document-wide field on the OCR response root, not a per-page field. Move it from Page to OcrResult and read it from $data instead of each page.

chr-hertel

Needs a rebase on main - merged #2161 and the git history is somehow twisted.

tacman added 3 commits June 11, 2026 17:33

Add TUI agent menu flow

b5e8388

Improve TUI agent feedback

5bcd803

Update demo to Symfony 8.1

5f692ec

tacman marked this pull request as ready for review June 12, 2026 00:48

tacman requested review from OskarStark and chr-hertel as code owners June 12, 2026 00:48

carsonbot added Demo Issues & PRs about the demo application Feature New feature Status: Needs Review labels Jun 12, 2026

tacman mentioned this pull request Jun 12, 2026

okay to update ai-demo to symfony 8.1? #2156

Open

GromNaN reviewed Jun 12, 2026

View reviewed changes

tacman added 4 commits June 12, 2026 07:36

Merge branch 'mistral-ocr' into tac

1182426

chr-hertel reviewed Jun 12, 2026

View reviewed changes

tacman mentioned this pull request Jun 12, 2026

[Agent] Expose the model on AgentInterface — what should getModel() return? #2164

Open

tacman added 9 commits June 16, 2026 07:01

Merge branch 'platform-cacheable-input' into tac

b1ee4ac

# Conflicts: # src/platform/CHANGELOG.md

Merge remote-tracking branch 'upstream/main' into tac

54c4aa3

# Conflicts: # demo/composer.json # src/platform/CHANGELOG.md # src/platform/src/Bridge/Mistral/CHANGELOG.md

[Demo] Add the Emancipation Proclamation (NARA) to the document samples

55b2618

A handwritten 1863 NARA document (multi-page PDF) — a strong OCR demo.

tacman added 2 commits June 19, 2026 12:25

update libraries

053e282

[Platform] Move Mistral OCR document_annotation to document level

f968fde

document_annotation is a document-wide field on the OCR response root, not a per-page field. Move it from Page to OcrResult and read it from $data instead of each page.

chr-hertel mentioned this pull request Jun 21, 2026

[Platform][Mistral] Add OCR support via the /v1/ocr endpoint #2161

Merged

chr-hertel requested changes Jun 21, 2026

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Jun 21, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

[Demo] Add TUI agent chat command#2158

[Demo] Add TUI agent chat command#2158
tacman wants to merge 19 commits into
symfony:mainfrom
tacman:tac

tacman commented Jun 12, 2026

Uh oh!

tacman commented Jun 12, 2026 •

edited

Loading

Uh oh!

OskarStark commented Jun 12, 2026

Uh oh!

GromNaN left a comment

Uh oh!

chr-hertel Jun 12, 2026

Uh oh!

tacman Jun 12, 2026

Uh oh!

chr-hertel Jun 12, 2026

Uh oh!

tacman Jun 12, 2026

Uh oh!

tacman commented Jun 12, 2026

Uh oh!

chr-hertel commented Jun 19, 2026

Uh oh!

chr-hertel left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Uh oh!

Conversation

tacman commented Jun 12, 2026

Uh oh!

tacman commented Jun 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

OskarStark commented Jun 12, 2026

Uh oh!

GromNaN left a comment

Choose a reason for hiding this comment

Uh oh!

chr-hertel Jun 12, 2026

Choose a reason for hiding this comment

Uh oh!

tacman Jun 12, 2026

Choose a reason for hiding this comment

Uh oh!

chr-hertel Jun 12, 2026

Choose a reason for hiding this comment

Uh oh!

tacman Jun 12, 2026

Choose a reason for hiding this comment

Uh oh!

tacman commented Jun 12, 2026

Uh oh!

chr-hertel commented Jun 19, 2026

Uh oh!

chr-hertel left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

tacman commented Jun 12, 2026 •

edited

Loading