docs: add SSE Event Names section to AI connections - #177
Open
kritinv wants to merge 1 commit into
Open
Conversation
Document how to set SSE event names for SSE Streaming connections, covering the optional actual output event, the accumulate frames toggle, and the retrieval context / tools called / state events that are read from the final frame of a named event. Co-authored-by: Cursor <cursoragent@cursor.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Adds a new SSE Event Names section to the AI Connections settings page documenting the SSE-streaming event-name config (recently added to the platform).
It covers:
Includes a concrete SSE stream example mapping each value to its event, plus cross-links to the existing key path, transformers, and multi-turn state sections. Behavior was verified against
ping_streaming.py/verify.pyin confident-cloud.Test plan
fern check—[docs]: ✓ All checks passed(the 8[api]errors are pre-existing inmetrics.ymland unrelated)#actual-output-key-path,#transformers,#configure-multiturn-state)Made with Cursor