Skip to content

Commit 8d331bb

Browse files
author
yushan
committed
docs(core): fix EventType Javadoc for ALL and AGENT_RESULT
The Javadoc claimed ALL excluded AGENT_RESULT, but StreamOptions.shouldStream() includes it. Align comments with actual behavior (closes #1439).
1 parent 0f6a1db commit 8d331bb

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

agentscope-core/src/main/java/io/agentscope/core/agent/EventType.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,8 @@ public enum EventType {
6262
* Final result event - The agent's complete response.
6363
*
6464
* <p>This is the message returned by {@link Agent#call(io.agentscope.core.message.Msg)}.
65-
* By default, this event is NOT included in the stream to avoid duplication since it's the return value.
65+
* This event is included when streaming with {@link #ALL}, but can be excluded by
66+
* specifying only the desired event types in {@link StreamOptions}.
6667
*
6768
* <p>Characteristics:
6869
* <ul>
@@ -86,7 +87,7 @@ public enum EventType {
8687
SUMMARY,
8788

8889
/**
89-
* Special value to stream all event types (except {@link #AGENT_RESULT}).
90+
* Special value to stream all event types (including {@link #AGENT_RESULT}).
9091
*
9192
* <p>Use this in {@link StreamOptions} to receive all events without filtering.
9293
*/

0 commit comments

Comments
 (0)