MessageTextFilePathAnnotation Class

Definition

A citation within the message that points to a file located at a specific path.

public class MessageTextFilePathAnnotation : Azure.AI.OpenAI.Assistants.MessageTextAnnotation, System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.MessageTextFilePathAnnotation>
type MessageTextFilePathAnnotation = class
    inherit MessageTextAnnotation
    interface IJsonModel<MessageTextFilePathAnnotation>
    interface IPersistableModel<MessageTextFilePathAnnotation>
Public Class MessageTextFilePathAnnotation
Inherits MessageTextAnnotation
Implements IJsonModel(Of MessageTextFilePathAnnotation), IPersistableModel(Of MessageTextFilePathAnnotation)
Inheritance
MessageTextFilePathAnnotation
Implements

Properties

EndIndex

The last text index associated with this text annotation.

(Inherited from MessageTextAnnotation)
FileId

The ID of the specific file that the citation is from.

StartIndex

The first text index associated with this text annotation.

(Inherited from MessageTextAnnotation)
Text

The textual content associated with this text annotation item.

(Inherited from MessageTextAnnotation)

Explicit Interface Implementations

IJsonModel<MessageTextAnnotation>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from MessageTextAnnotation)
IJsonModel<MessageTextFilePathAnnotation>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<MessageTextFilePathAnnotation>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<MessageTextAnnotation>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from MessageTextAnnotation)
IPersistableModel<MessageTextFilePathAnnotation>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<MessageTextFilePathAnnotation>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<MessageTextFilePathAnnotation>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to