ResponseContentPartDoneEvent 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.
Emitted when a content part is done.
public class ResponseContentPartDoneEvent : Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponseStreamEvent, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponseContentPartDoneEvent>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ResponseContentPartDoneEvent>
type ResponseContentPartDoneEvent = class
inherit ResponseStreamEvent
interface IUtf8JsonSerializable
interface IJsonModel<ResponseContentPartDoneEvent>
interface IPersistableModel<ResponseContentPartDoneEvent>
Public Class ResponseContentPartDoneEvent
Inherits ResponseStreamEvent
Implements IJsonModel(Of ResponseContentPartDoneEvent), IPersistableModel(Of ResponseContentPartDoneEvent)
- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| ResponseContentPartDoneEvent() |
Initializes a new instance of ResponseContentPartDoneEvent for deserialization. |
| ResponseContentPartDoneEvent(Int32, String, Int32, Int32, ItemContent) |
Initializes a new instance of ResponseContentPartDoneEvent. |
| ResponseContentPartDoneEvent(ResponseStreamEventType, Int32, IDictionary<String,BinaryData>, String, Int32, Int32, ItemContent) |
Initializes a new instance of ResponseContentPartDoneEvent. |
Properties
| Name | Description |
|---|---|
| ContentIndex |
The index of the content part that is done. |
| ItemId |
The ID of the output item that the content part was added to. |
| OutputIndex |
The index of the output item that the content part was added to. |
| Part |
The content part that is done. Please note ItemContent 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 ItemContentInputAudio, ItemContentInputFile, ItemContentInputImage, ItemContentInputText, ItemContentOutputAudio, ItemContentOutputText and ItemContentRefusal. |
| SequenceNumber |
The sequence number for this event. (Inherited from ResponseStreamEvent) |
| Type |
Gets or sets the type. (Inherited from ResponseStreamEvent) |
Methods
| Name | Description |
|---|---|
| DeserializeResponseContentPartDoneEvent(JsonElement, ModelReaderWriterOptions) | |
| FromResponse(Response) |
Deserializes the model from a raw response. |
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
| ToRequestContent() |
Convert into a RequestContent. |