OutputItemImageGenCallBuilder Class

Definition

Namespace:

Azure.AI.AgentServer.Responses

Assembly:

Azure.AI.AgentServer.Responses.dll

Package:

Azure.AI.AgentServer.Responses v1.0.0-beta.4

Source:

OutputItemImageGenCallBuilder.cs

Scoped builder for an image_generation_call output item. Provides methods for lifecycle events and streaming partial image data.

The typical lifecycle is: EmitAdded() → EmitInProgress() → EmitGenerating() → zero or more EmitPartialImage(String) → EmitCompleted() → EmitDone(String). The final EmitDone(String) call carries the base64-encoded image result.

public class OutputItemImageGenCallBuilder : Azure.AI.AgentServer.Responses.OutputItemBuilder<Azure.AI.AgentServer.Responses.Models.OutputItemImageGenToolCall>

type OutputItemImageGenCallBuilder = class
    inherit OutputItemBuilder<OutputItemImageGenToolCall>

Public Class OutputItemImageGenCallBuilder
Inherits OutputItemBuilder(Of OutputItemImageGenToolCall)

Inheritance

Object

OutputItemBuilder<OutputItemImageGenToolCall>

OutputItemImageGenCallBuilder

Constructors

Name	Description
OutputItemImageGenCallBuilder()	Initializes a new instance of OutputItemImageGenCallBuilder for mocking.

Properties

Name	Description
ItemId	The auto-generated item ID for this output item. (Inherited from OutputItemBuilder<T>)
OutputIndex	The output index assigned to this output item. (Inherited from OutputItemBuilder<T>)

Methods

Name	Description
EmitAdded()	Produces a response.output_item.added event with an in-progress image generation item. The item is emitted with an empty result and in_progress status.
EmitAdded(T)	Produces a response.output_item.added event wrapping the given item. (Inherited from OutputItemBuilder<T>)
EmitCompleted()	Produces a response.image_gen_call.completed event.
EmitDone(String)	Produces a response.output_item.done event with a completed image generation item containing the final image result.
EmitDone(T)	Produces a response.output_item.done event wrapping the given item and tracks it in the response's output list. (Inherited from OutputItemBuilder<T>)
EmitGenerating()	Produces a response.image_gen_call.generating event.
EmitInProgress()	Produces a response.image_gen_call.in_progress event.
EmitPartialImage(String)	Produces a response.image_gen_call.partial_image event with the given image data. Partial images allow clients to display progressive rendering while the image is being generated.