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