Share via


ResponseWebSearchCallInProgressEvent Class

Definition

Note: web_search is not yet available via Azure OpenAI.

public class ResponseWebSearchCallInProgressEvent : Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponseStreamEvent, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponseWebSearchCallInProgressEvent>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponseWebSearchCallInProgressEvent>
type ResponseWebSearchCallInProgressEvent = class
    inherit ResponseStreamEvent
    interface IUtf8JsonSerializable
    interface IJsonModel<ResponseWebSearchCallInProgressEvent>
    interface IPersistableModel<ResponseWebSearchCallInProgressEvent>
Public Class ResponseWebSearchCallInProgressEvent
Inherits ResponseStreamEvent
Implements IJsonModel(Of ResponseWebSearchCallInProgressEvent), IPersistableModel(Of ResponseWebSearchCallInProgressEvent)
Inheritance
ResponseWebSearchCallInProgressEvent
Implements

Constructors

Name Description
ResponseWebSearchCallInProgressEvent()

Initializes a new instance of ResponseWebSearchCallInProgressEvent for deserialization.

ResponseWebSearchCallInProgressEvent(Int32, Int32, String)

Initializes a new instance of ResponseWebSearchCallInProgressEvent.

ResponseWebSearchCallInProgressEvent(ResponseStreamEventType, Int32, IDictionary<String,BinaryData>, Int32, String)

Initializes a new instance of ResponseWebSearchCallInProgressEvent.

Properties

Name Description
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

The sequence number for this event.

(Inherited from ResponseStreamEvent)
Type

Gets or sets the type.

(Inherited from ResponseStreamEvent)

Methods

Name Description
DeserializeResponseWebSearchCallInProgressEvent(JsonElement, ModelReaderWriterOptions)
FromResponse(Response)

Deserializes the model from a raw response.

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
ToRequestContent()

Convert into a RequestContent.

Explicit Interface Implementations

Name Description
IJsonModel<ResponseStreamEvent>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from ResponseStreamEvent)
IJsonModel<ResponseStreamEvent>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from ResponseStreamEvent)
IJsonModel<ResponseWebSearchCallInProgressEvent>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<ResponseWebSearchCallInProgressEvent>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ResponseStreamEvent>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from ResponseStreamEvent)
IPersistableModel<ResponseStreamEvent>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from ResponseStreamEvent)
IPersistableModel<ResponseStreamEvent>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from ResponseStreamEvent)
IPersistableModel<ResponseWebSearchCallInProgressEvent>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ResponseWebSearchCallInProgressEvent>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<ResponseWebSearchCallInProgressEvent>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to