MessageTextFileCitationAnnotation Class

  • Reference

Definition

Namespace:
Azure.AI.OpenAI.Assistants
Assembly:
Azure.AI.OpenAI.Assistants.dll
Package:
Azure.AI.OpenAI.Assistants v1.0.0-beta.4
Source:
MessageTextFileCitationAnnotation.cs

A citation within the message that points to a specific quote from a specific File associated with the assistant or the message. Generated when the assistant uses the 'retrieval' tool to search files.

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

Properties

EndIndex

The last text index associated with this text annotation.

(Inherited from MessageTextAnnotation)
FileId

The ID of the file associated with this citation.
Quote

The specific quote cited in the associated file.
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<MessageTextFileCitationAnnotation>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<MessageTextFileCitationAnnotation>.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<MessageTextFileCitationAnnotation>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<MessageTextFileCitationAnnotation>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<MessageTextFileCitationAnnotation>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to