ResponseEventStream.OutputItemMessage Method
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.
Overloads
| Name | Description |
|---|---|
| OutputItemMessage(String) |
Convenience generator that yields the complete message output-item lifecycle with a single text content part from a complete string (S-056). |
| OutputItemMessage(IAsyncEnumerable<String>, CancellationToken) |
Convenience generator that yields the complete message output-item lifecycle with a single text content part from streaming chunks (S-056, S-058). |
| OutputItemMessage(String, IEnumerable<Annotation>) |
Convenience generator that yields the complete message output-item lifecycle with a single text content part and annotations (S-056). |
OutputItemMessage(String)
- Source:
- ResponseEventStream.cs
Convenience generator that yields the complete message output-item lifecycle with a single text content part from a complete string (S-056).
public System.Collections.Generic.IEnumerable<Azure.AI.AgentServer.Responses.Models.ResponseStreamEvent> OutputItemMessage(string text);member this.OutputItemMessage : string -> seq<Azure.AI.AgentServer.Responses.Models.ResponseStreamEvent>Public Function OutputItemMessage (text As String) As IEnumerable(Of ResponseStreamEvent)Parameters
- text
- String
The complete message text.
Returns
An enumerable of events: output_item.added → text content convenience → output_item.done.
Applies to
OutputItemMessage(IAsyncEnumerable<String>, CancellationToken)
- Source:
- ResponseEventStream.cs
Convenience generator that yields the complete message output-item lifecycle with a single text content part from streaming chunks (S-056, S-058).
public System.Collections.Generic.IAsyncEnumerable<Azure.AI.AgentServer.Responses.Models.ResponseStreamEvent> OutputItemMessage(System.Collections.Generic.IAsyncEnumerable<string> chunks, System.Threading.CancellationToken cancellationToken = default);member this.OutputItemMessage : System.Collections.Generic.IAsyncEnumerable<string> * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.AI.AgentServer.Responses.Models.ResponseStreamEvent>Public Function OutputItemMessage (chunks As IAsyncEnumerable(Of String), Optional cancellationToken As CancellationToken = Nothing) As IAsyncEnumerable(Of ResponseStreamEvent)Parameters
- chunks
- IAsyncEnumerable<String>
An async enumerable of text chunks.
- cancellationToken
- CancellationToken
A token to cancel iteration.
Returns
An async enumerable of events: output_item.added → text content convenience → output_item.done.
Applies to
OutputItemMessage(String, IEnumerable<Annotation>)
- Source:
- ResponseEventStream.cs
Convenience generator that yields the complete message output-item lifecycle with a single text content part and annotations (S-056).
public System.Collections.Generic.IEnumerable<Azure.AI.AgentServer.Responses.Models.ResponseStreamEvent> OutputItemMessage(string text, System.Collections.Generic.IEnumerable<Azure.AI.AgentServer.Responses.Models.Annotation> annotations);member this.OutputItemMessage : string * seq<Azure.AI.AgentServer.Responses.Models.Annotation> -> seq<Azure.AI.AgentServer.Responses.Models.ResponseStreamEvent>Public Iterator Function OutputItemMessage (text As String, annotations As IEnumerable(Of Annotation)) As IEnumerable(Of ResponseStreamEvent)Parameters
- text
- String
The complete message text.
- annotations
- IEnumerable<Annotation>
The annotations to attach to the text content part.
Returns
An enumerable of events: output_item.added → text content convenience (with annotations) → output_item.done.
