OutputItemCustomToolCallBuilder Class

Definition

Namespace:
Azure.AI.AgentServer.Responses
Assembly:
Azure.AI.AgentServer.Responses.dll
Package:
Azure.AI.AgentServer.Responses v1.0.0-beta.4
Source:
OutputItemCustomToolCallBuilder.cs

Scoped builder for a custom tool call output item. Provides methods for lifecycle events and streaming input deltas.

public class OutputItemCustomToolCallBuilder : Azure.AI.AgentServer.Responses.OutputItemBuilder<Azure.AI.AgentServer.Responses.Models.OutputItemCustomToolCall>
type OutputItemCustomToolCallBuilder = class
    inherit OutputItemBuilder<OutputItemCustomToolCall>
Public Class OutputItemCustomToolCallBuilder
Inherits OutputItemBuilder(Of OutputItemCustomToolCall)
Inheritance
Object
OutputItemBuilder<OutputItemCustomToolCall>
OutputItemCustomToolCallBuilder

Constructors

Name Description
OutputItemCustomToolCallBuilder()

Initializes a new instance of OutputItemCustomToolCallBuilder for mocking.

Properties

Name Description
CallId

The call ID for this custom tool call.
ItemId

The auto-generated item ID for this output item.

(Inherited from OutputItemBuilder<T>)
Name

The tool name.
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 a custom tool call item.
EmitAdded(T)

Produces a response.output_item.added event wrapping the given item.

(Inherited from OutputItemBuilder<T>)
EmitDone()

Produces a response.output_item.done event with the completed custom tool call item.
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>)
EmitInputDelta(String)

Produces a response.custom_tool_call_input.delta event with the given input chunk.
EmitInputDone(String)

Produces a response.custom_tool_call_input.done event with the final input.
Input(IAsyncEnumerable<String>, CancellationToken)

Convenience generator that streams input chunks as real-time delta events followed by a done event with the accumulated input.
Input(String)

Convenience generator that emits a complete input as delta → done events.

Applies to