Share via


MessageDeltaTextFileCitationAnnotation Class

Definition

Represents a streamed file citation applied to a streaming text content part.

public class MessageDeltaTextFileCitationAnnotation : Azure.AI.Agents.Persistent.MessageDeltaTextAnnotation, System.ClientModel.Primitives.IJsonModel<Azure.AI.Agents.Persistent.MessageDeltaTextFileCitationAnnotation>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Agents.Persistent.MessageDeltaTextFileCitationAnnotation>
type MessageDeltaTextFileCitationAnnotation = class
    inherit MessageDeltaTextAnnotation
    interface IJsonModel<MessageDeltaTextFileCitationAnnotation>
    interface IPersistableModel<MessageDeltaTextFileCitationAnnotation>
Public Class MessageDeltaTextFileCitationAnnotation
Inherits MessageDeltaTextAnnotation
Implements IJsonModel(Of MessageDeltaTextFileCitationAnnotation), IPersistableModel(Of MessageDeltaTextFileCitationAnnotation)
Inheritance
MessageDeltaTextFileCitationAnnotation
Implements

Fields

Name Description
SerializedAdditionalRawData

Keeps track of any properties unknown to the library.

To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

Examples:

  • BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""): Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.

(Inherited from MessageDeltaTextAnnotation)

Properties

Name Description
EndIndex

The end index of this annotation in the content text.

FileCitation

The file citation information.

Index

The index of the annotation within a text content part.

(Inherited from MessageDeltaTextAnnotation)
StartIndex

The start index of this annotation in the content text.

Text

The text in the message content that needs to be replaced.

Methods

Name Description
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

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

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from MessageDeltaTextAnnotation)
IJsonModel<MessageDeltaTextFileCitationAnnotation>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<MessageDeltaTextFileCitationAnnotation>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<MessageDeltaTextAnnotation>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from MessageDeltaTextAnnotation)
IPersistableModel<MessageDeltaTextFileCitationAnnotation>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<MessageDeltaTextFileCitationAnnotation>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<MessageDeltaTextFileCitationAnnotation>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to