ResponseEventStream.OutputItemStructuredOutputs(BinaryData) 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.
Convenience generator that yields the complete structured outputs item lifecycle. Use this to return any open-ended structured information as a JSON object. This is useful when none of the existing output item types (message, function call, image, etc.) fit your use case — for example, returning analytics results, classification labels, form data, or any custom JSON payload.
public System.Collections.Generic.IEnumerable<Azure.AI.AgentServer.Responses.Models.ResponseStreamEvent> OutputItemStructuredOutputs(BinaryData output);member this.OutputItemStructuredOutputs : BinaryData -> seq<Azure.AI.AgentServer.Responses.Models.ResponseStreamEvent>Public Iterator Function OutputItemStructuredOutputs (output As BinaryData) As IEnumerable(Of ResponseStreamEvent)Parameters
- output
- BinaryData
The structured data to return. Use FromObjectAsJson<T>(T, JsonSerializerOptions) to serialize a strongly typed object, or FromString(String) to pass raw JSON.
Example:
BinaryData.FromObjectAsJson(new { sentiment = "positive", confidence = 0.95 })
Returns
An enumerable of events: output_item.added → output_item.done.
