OutputItemReasoningItemBuilder.SummaryPart 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 |
|---|---|
| SummaryPart(String) |
Convenience generator that yields the complete summary part sub-item event sequence from a single string (S-053, complete-text mode per S-054). |
| SummaryPart(IAsyncEnumerable<String>, CancellationToken) |
Convenience generator that yields the complete summary part sub-item event sequence from streaming chunks (S-053, streaming mode per S-054). Each chunk is emitted as a delta immediately (S-055). |
SummaryPart(String)
Convenience generator that yields the complete summary part sub-item event sequence from a single string (S-053, complete-text mode per S-054).
public virtual System.Collections.Generic.IEnumerable<Azure.AI.AgentServer.Responses.Models.ResponseStreamEvent> SummaryPart(string text);abstract member SummaryPart : string -> seq<Azure.AI.AgentServer.Responses.Models.ResponseStreamEvent>
override this.SummaryPart : string -> seq<Azure.AI.AgentServer.Responses.Models.ResponseStreamEvent>Public Iterator Overridable Function SummaryPart (text As String) As IEnumerable(Of ResponseStreamEvent)Parameters
- text
- String
The complete summary text.
Returns
An enumerable of events: reasoning_summary_part.added → reasoning_summary_text.delta → reasoning_summary_text.done → reasoning_summary_part.done.
Applies to
SummaryPart(IAsyncEnumerable<String>, CancellationToken)
Convenience generator that yields the complete summary part sub-item event sequence from streaming chunks (S-053, streaming mode per S-054). Each chunk is emitted as a delta immediately (S-055).
public virtual System.Collections.Generic.IAsyncEnumerable<Azure.AI.AgentServer.Responses.Models.ResponseStreamEvent> SummaryPart(System.Collections.Generic.IAsyncEnumerable<string> chunks, System.Threading.CancellationToken cancellationToken = default);abstract member SummaryPart : System.Collections.Generic.IAsyncEnumerable<string> * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.AI.AgentServer.Responses.Models.ResponseStreamEvent>
override this.SummaryPart : System.Collections.Generic.IAsyncEnumerable<string> * System.Threading.CancellationToken -> System.Collections.Generic.IAsyncEnumerable<Azure.AI.AgentServer.Responses.Models.ResponseStreamEvent>Public Overridable Function SummaryPart (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: reasoning_summary_part.added → N × reasoning_summary_text.delta → reasoning_summary_text.done → reasoning_summary_part.done.
