joeyutong opened a new issue, #793:
URL: https://github.com/apache/flink-agents/issues/793

   ### Search before asking
   
   - [x] I searched in the 
[issues](https://github.com/apache/flink-agents/issues) and found nothing 
similar.
   
   ### Description
   
   There are two documentation/API-contract follow-ups around the Workflow 
Agent page.
   
   1. The `Send Event` snippet shows one action sending both a 
`ChatRequestEvent` and an `OutputEvent`.
   
      This is valid API usage, but it can be misleading as a workflow example. 
In the runtime, an `OutputEvent` is emitted downstream immediately, while the 
`ChatRequestEvent` continues through the chat-model path. If a 
`ChatResponseEvent` handler also emits an output, one input may produce both an 
immediate output and a later model-based output.
   
      Suggested fix: split the snippet into separate examples for "trigger 
another action" and "emit downstream output", or explicitly state that sending 
an `OutputEvent` in the same action is only for immediate downstream output and 
is not the normal chat request/response workflow pattern.
   
   2. The typed event reconstruction contract should be explicit about base 
`Event` metadata such as `id` and `sourceTimestamp`.
   
      `fromEvent` / `from_event` helpers reconstruct typed events from a base 
`Event`. If metadata such as `id` or `sourceTimestamp` is dropped in any typed 
reconstruction path, event logs, listeners, correlation, deduplication, and 
downstream timestamp propagation become harder to reason about.
   
      Suggested fix: audit typed event reconstruction implementations and 
either preserve base metadata consistently or document the intended contract 
and limitations.
   
   ### Are you willing to submit a PR?
   
   - [ ] I'm willing to submit a PR!
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to