OutputItemWebSearchCallBuilder Class

Definition

Namespace:

Azure.AI.AgentServer.Responses

Assembly:

Azure.AI.AgentServer.Responses.dll

Package:

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

Source:

OutputItemWebSearchCallBuilder.cs

Scoped builder for a web search tool call output item. Provides methods for the web search lifecycle: added, in-progress, searching, completed, done.

public class OutputItemWebSearchCallBuilder : Azure.AI.AgentServer.Responses.OutputItemBuilder<Azure.AI.AgentServer.Responses.Models.OutputItemWebSearchToolCall>

type OutputItemWebSearchCallBuilder = class
    inherit OutputItemBuilder<OutputItemWebSearchToolCall>

Public Class OutputItemWebSearchCallBuilder
Inherits OutputItemBuilder(Of OutputItemWebSearchToolCall)

Inheritance

Object

OutputItemBuilder<OutputItemWebSearchToolCall>

OutputItemWebSearchCallBuilder

Constructors

Name	Description
OutputItemWebSearchCallBuilder()	Initializes a new instance of OutputItemWebSearchCallBuilder 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 web search item.
EmitAdded(T)	Produces a response.output_item.added event wrapping the given item. (Inherited from OutputItemBuilder<T>)
EmitCompleted()	Produces a response.web_search_call.completed event.
EmitDone()	Produces a response.output_item.done event with a completed web search 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>)
EmitInProgress()	Produces a response.web_search_call.in_progress event.
EmitSearching()	Produces a response.web_search_call.searching event.