Share via


AnnotationUrlCitation Class

Definition

A citation for a web resource used to generate a model response.

public class AnnotationUrlCitation : Azure.AI.AgentServer.Contracts.Generated.OpenAI.Annotation, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.AnnotationUrlCitation>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.AnnotationUrlCitation>
type AnnotationUrlCitation = class
    inherit Annotation
    interface IUtf8JsonSerializable
    interface IJsonModel<AnnotationUrlCitation>
    interface IPersistableModel<AnnotationUrlCitation>
Public Class AnnotationUrlCitation
Inherits Annotation
Implements IJsonModel(Of AnnotationUrlCitation), IPersistableModel(Of AnnotationUrlCitation)
Inheritance
AnnotationUrlCitation
Implements

Constructors

Name Description
AnnotationUrlCitation()

Initializes a new instance of AnnotationUrlCitation for deserialization.

AnnotationUrlCitation(AnnotationType, IDictionary<String,BinaryData>, Uri, Int32, Int32, String)

Initializes a new instance of AnnotationUrlCitation.

AnnotationUrlCitation(Uri, Int32, Int32, String)

Initializes a new instance of AnnotationUrlCitation.

Properties

Name Description
EndIndex

The index of the last character of the URL citation in the message.

StartIndex

The index of the first character of the URL citation in the message.

Title

The title of the web resource.

Type

Gets or sets the type.

(Inherited from Annotation)
Url

The URL of the web resource.

Methods

Name Description
DeserializeAnnotationUrlCitation(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<Annotation>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from Annotation)
IJsonModel<AnnotationUrlCitation>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<AnnotationUrlCitation>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<Annotation>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from Annotation)
IPersistableModel<AnnotationUrlCitation>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<AnnotationUrlCitation>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<AnnotationUrlCitation>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to