ResponseWebSearchCallInProgressEvent Class

Definition

Namespace:
Azure.AI.AgentServer.Responses.Models
Assembly:
Azure.AI.AgentServer.Responses.dll
Package:
Azure.AI.AgentServer.Responses v1.0.0-beta.3
Source:
ResponseWebSearchCallInProgressEvent.cs

Emitted when a web search call is initiated.

public class ResponseWebSearchCallInProgressEvent : Azure.AI.AgentServer.Responses.Models.ResponseStreamEvent, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Responses.Models.ResponseWebSearchCallInProgressEvent>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Responses.Models.ResponseWebSearchCallInProgressEvent>
type ResponseWebSearchCallInProgressEvent = class
    inherit ResponseStreamEvent
    interface IJsonModel<ResponseWebSearchCallInProgressEvent>
    interface IPersistableModel<ResponseWebSearchCallInProgressEvent>
Public Class ResponseWebSearchCallInProgressEvent
Inherits ResponseStreamEvent
Implements IJsonModel(Of ResponseWebSearchCallInProgressEvent), IPersistableModel(Of ResponseWebSearchCallInProgressEvent)
Inheritance
Object
ResponseStreamEvent
ResponseWebSearchCallInProgressEvent
Implements
IJsonModel<ResponseWebSearchCallInProgressEvent> IPersistableModel<ResponseWebSearchCallInProgressEvent> IPersistableModel<T>

Constructors

Name Description
ResponseWebSearchCallInProgressEvent(Int64, Int64, String)

Initializes a new instance of ResponseWebSearchCallInProgressEvent.

Properties

Name Description
EventType

Gets the event type discriminator (e.g. response.created, response.completed).

(Inherited from ResponseStreamEvent)
ItemId

Unique ID for the output item associated with the web search call.
OutputIndex

The index of the output item that the web search call is associated with.
SequenceNumber

Gets the SequenceNumber.

(Inherited from ResponseStreamEvent)

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Operators

Name Description
Explicit(ClientResult to ResponseWebSearchCallInProgressEvent)

Explicit Interface Implementations

Name Description
IJsonModel<ResponseStreamEvent>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from ResponseStreamEvent)
IJsonModel<ResponseStreamEvent>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ResponseStreamEvent)
IJsonModel<ResponseWebSearchCallInProgressEvent>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<ResponseWebSearchCallInProgressEvent>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<ResponseStreamEvent>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from ResponseStreamEvent)
IPersistableModel<ResponseStreamEvent>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from ResponseStreamEvent)
IPersistableModel<ResponseStreamEvent>.Write(ModelReaderWriterOptions) (Inherited from ResponseStreamEvent)
IPersistableModel<ResponseWebSearchCallInProgressEvent>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<ResponseWebSearchCallInProgressEvent>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<ResponseWebSearchCallInProgressEvent>.Write(ModelReaderWriterOptions)

Extension Methods

Name Description
SnapshotEmbeddedResponse(ResponseStreamEvent, ResponseObject)

If the event is a lifecycle event that embeds a ResponseObject reference, replaces it with an immutable snapshot of the given accumulator. Non-lifecycle events are left unchanged.

Applies to