ResponseStreamEvent Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
The ResponseStreamEvent. Please note ResponseStreamEvent is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ResponseErrorEvent, ResponseCodeInterpreterCallCodeDeltaEvent, ResponseCodeInterpreterCallCodeDoneEvent, ResponseCodeInterpreterCallCompletedEvent, ResponseCodeInterpreterCallInProgressEvent, ResponseCodeInterpreterCallInterpretingEvent, ResponseCompletedEvent, ResponseContentPartAddedEvent, ResponseContentPartDoneEvent, ResponseCreatedEvent, ResponseFailedEvent, ResponseFileSearchCallCompletedEvent, ResponseFileSearchCallInProgressEvent, ResponseFileSearchCallSearchingEvent, ResponseFunctionCallArgumentsDeltaEvent, ResponseFunctionCallArgumentsDoneEvent, ResponseImageGenCallCompletedEvent, ResponseImageGenCallGeneratingEvent, ResponseImageGenCallInProgressEvent, ResponseImageGenCallPartialImageEvent, ResponseInProgressEvent, ResponseIncompleteEvent, ResponseMCPCallArgumentsDeltaEvent, ResponseMCPCallArgumentsDoneEvent, ResponseMCPCallCompletedEvent, ResponseMCPCallFailedEvent, ResponseMCPCallInProgressEvent, ResponseMCPListToolsCompletedEvent, ResponseMCPListToolsFailedEvent, ResponseMCPListToolsInProgressEvent, ResponseOutputItemAddedEvent, ResponseOutputItemDoneEvent, ResponseTextDeltaEvent, ResponseTextDoneEvent, ResponseQueuedEvent, ResponseReasoningSummaryPartAddedEvent, ResponseReasoningSummaryPartDoneEvent, ResponseReasoningSummaryTextDeltaEvent, ResponseReasoningSummaryTextDoneEvent, ResponseReasoningSummaryDeltaEvent, ResponseReasoningSummaryDoneEvent, ResponseReasoningDeltaEvent, ResponseReasoningDoneEvent, ResponseRefusalDeltaEvent, ResponseRefusalDoneEvent, ResponseWebSearchCallCompletedEvent, ResponseWebSearchCallInProgressEvent and ResponseWebSearchCallSearchingEvent.
[System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.AgentServer.Contracts.Generated.OpenAI.UnknownResponseStreamEvent))]
public abstract class ResponseStreamEvent : Azure.AI.AgentServer.Contracts.Generated.Common.IUtf8JsonSerializable, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponseStreamEvent>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponseStreamEvent>[<System.ClientModel.Primitives.PersistableModelProxy(typeof(Azure.AI.AgentServer.Contracts.Generated.OpenAI.UnknownResponseStreamEvent))>]
type ResponseStreamEvent = class
interface IUtf8JsonSerializable
interface IJsonModel<ResponseStreamEvent>
interface IPersistableModel<ResponseStreamEvent>Public MustInherit Class ResponseStreamEvent
Implements IJsonModel(Of ResponseStreamEvent), IPersistableModel(Of ResponseStreamEvent), IUtf8JsonSerializable- Inheritance
-
ResponseStreamEvent
- Derived
- Attributes
- Implements
Constructors
| Name | Description |
|---|---|
| ResponseStreamEvent() |
Initializes a new instance of ResponseStreamEvent for deserialization. |
| ResponseStreamEvent(Int32) |
Initializes a new instance of ResponseStreamEvent. |
| ResponseStreamEvent(ResponseStreamEventType, Int32, IDictionary<String,BinaryData>) |
Initializes a new instance of ResponseStreamEvent. |
Properties
| Name | Description |
|---|---|
| SequenceNumber |
The sequence number for this event. |
| Type |
Gets or sets the type. |
Methods
| Name | Description |
|---|---|
| DeserializeResponseStreamEvent(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. |
| IJsonModel<ResponseStreamEvent>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<ResponseStreamEvent>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<ResponseStreamEvent>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<ResponseStreamEvent>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
| IUtf8JsonSerializable.Write(Utf8JsonWriter) | |
