IStreamingResponse Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
public interface IStreamingResponsetype IStreamingResponse = interfacePublic Interface IStreamingResponseProperties
| Citations |
The citations for the response. |
| EnableGeneratedByAILabel |
Sets the "Generated by AI" Entity. Defaults to false. |
| EndStreamTimeout |
The time in milliseconds that EndStream or Reset wait. After this period expires, the final message will be sent. |
| FinalMessage |
Set IActivity that will be (optionally) used for the final streaming message. |
| Interval |
The interval in milliseconds at which intermediate messages are sent. |
| IsStreamingChannel |
Indicate if the current channel supports intermediate messages. |
| Message |
The buffered message. |
| SensitivityLabel |
The sensitivity label for the GeneratedByAI entity. |
Methods
| AddCitations(IList<Citation>) |
Sets the citations for the full message. |
| EndStreamAsync(CancellationToken) |
Ends the stream by sending the final message to the client. |
| IsStreamStarted() | |
| QueueInformativeUpdateAsync(String, CancellationToken) |
Queues an informative update to be sent to the client. |
| QueueTextChunk(String) |
Queues a chunk of partial message text to be sent to the client. |
| ResetAsync(CancellationToken) |
Reset an already used stream. If the stream is still running, this will wait for completion. |
| UpdatesSent() |
Gets the number of updates sent for the stream. |