Introduces support for streaming text responses in the Activity Proto… #167
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tracyboehrer
requested changes
Jun 4, 2025
gurubhg
force-pushed
the
users/guhiriya/activity_schema_changes
branch
from
90f5b55 to
13b6e23
Compare
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for streaming text responses by introducing a new streaminfo entity and updating the Activity Protocol documentation accordingly.
- Defines the
streaminfoentity schema and streaming guidelines. - Adds
streaminfoto Appendix II’s non-IRI entity list and provides usage examples. - Updates version, changelog entry under Appendix I, and provides fallback instructions for unsupported channels.
Comments suppressed due to low confidence (3)
specs/activity/protocol-activity.md:1533
- The changelog bullet omits
streamId, which is a required property in the new entity schema. Please includestreamIdin this summary.
* Defined `streamType`, `streamSequence`, and optional `streamResult`
specs/activity/protocol-activity.md:1650
- The entity type is defined elsewhere as
streaminfo(all lowercase). Please unify the casing in this table row tostreaminfofor consistency.
| streamInfo | N/A | Streaming text metadata |
specs/activity/protocol-activity.md:1704
- Other entity property tables use
numberas the type for numeric fields. Consider changingintegertonumberto maintain consistency.
| `streamSequence` | integer | Yes | Incrementing sequence number for each chunk for non-final messages |
…col via a new streaminfo entity. - Definition of the `streaminfo` entity. - Guidelines for using streaminfo in typing and message Activities to send chunked text responses. - Addition of streaminfo to the list of supported non-IRI entity types in Appendix II. - Documentation update with examples and a changelog entry under Appendix I.
gurubhg
force-pushed
the
users/guhiriya/activity_schema_changes
branch
from
13b6e23 to
80c6bd9
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…col via a new streaminfo entity.
streaminfoentity.Related to #36
See also #27