ResponseOutputItemDoneEvent Class

Definition

Namespace:: Azure.AI.AgentServer.Contracts.Generated.OpenAI

Assembly:: Azure.AI.AgentServer.Contracts.dll

Package:: Azure.AI.AgentServer.Contracts v1.0.0-beta.4

Source:: ResponseOutputItemDoneEvent.cs

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.

Emitted when an output item is marked done.

public class ResponseOutputItemDoneEvent : Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponseStreamEvent, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponseOutputItemDoneEvent>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponseOutputItemDoneEvent>

type ResponseOutputItemDoneEvent = class
    inherit ResponseStreamEvent
    interface IUtf8JsonSerializable
    interface IJsonModel<ResponseOutputItemDoneEvent>
    interface IPersistableModel<ResponseOutputItemDoneEvent>

Public Class ResponseOutputItemDoneEvent
Inherits ResponseStreamEvent
Implements IJsonModel(Of ResponseOutputItemDoneEvent), IPersistableModel(Of ResponseOutputItemDoneEvent)

Inheritance: Object

ResponseStreamEvent
ResponseOutputItemDoneEvent

Implements: IUtf8JsonSerializable IJsonModel<ResponseOutputItemDoneEvent> IPersistableModel<ResponseOutputItemDoneEvent> IPersistableModel<T>

Constructors

Name	Description
ResponseOutputItemDoneEvent()	Initializes a new instance of ResponseOutputItemDoneEvent for deserialization.
ResponseOutputItemDoneEvent(Int32, Int32, ItemResource)	Initializes a new instance of ResponseOutputItemDoneEvent.
ResponseOutputItemDoneEvent(ResponseStreamEventType, Int32, IDictionary<String,BinaryData>, Int32, ItemResource)	Initializes a new instance of ResponseOutputItemDoneEvent.

Properties

Name	Description
Item	The output item that was marked done. Please note ItemResource 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 ResponsesAssistantMessageItemResource, CodeInterpreterToolCallItemResource, ComputerToolCallItemResource, ComputerToolCallOutputItemResource, ResponsesDeveloperMessageItemResource, FileSearchToolCallItemResource, FunctionToolCallItemResource, FunctionToolCallOutputItemResource, ImageGenToolCallItemResource, InvokeAzureAgentWorkflowActionOutputItemResource, LocalShellToolCallItemResource, LocalShellToolCallOutputItemResource, MCPApprovalRequestItemResource, MCPApprovalResponseItemResource, MCPCallItemResource, MCPListToolsItemResource, MemorySearchToolCallItemResource, ResponsesMessageItemResource, OAuthConsentRequestItemResource, ReasoningItemResource, StructuredOutputsItemResource, ResponsesSystemMessageItemResource, ResponsesUserMessageItemResource, WebSearchToolCallItemResource and WorkflowActionOutputItemResource.
OutputIndex	The index of the output item that was marked done.
SequenceNumber	The sequence number for this event. (Inherited from ResponseStreamEvent)
Type	Gets or sets the type. (Inherited from ResponseStreamEvent)

Methods

Name	Description
DeserializeResponseOutputItemDoneEvent(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<ResponseOutputItemDoneEvent>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ResponseOutputItemDoneEvent>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
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)
IPersistableModel<ResponseOutputItemDoneEvent>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<ResponseOutputItemDoneEvent>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ResponseOutputItemDoneEvent>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.
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)
IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to

Feedback

Was this page helpful?