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