Class Annotation

Namespace

OpenAI

Assembly

OpenAI-DotNet.dll

public sealed class Annotation

Inheritance

object

Annotation

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

EndIndex

[JsonInclude]
[JsonPropertyName("end_index")]
public int EndIndex { get; }

Property Value

int

FileCitation

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.

[JsonInclude]
[JsonPropertyName("file_citation")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public FileCitation FileCitation { get; }

Property Value

FileCitation

FilePath

A URL for the file that's generated when the assistant used the 'code_interpreter' tool to generate a file.

[JsonInclude]
[JsonPropertyName("file_path")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public FilePath FilePath { get; }

Property Value

FilePath

Index

[JsonInclude]
[JsonPropertyName("index")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public int? Index { get; }

Property Value

int?

StartIndex

[JsonInclude]
[JsonPropertyName("start_index")]
public int StartIndex { get; }

Property Value

int

Text

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

[JsonInclude]
[JsonPropertyName("text")]
public string Text { get; }

Property Value

string

Type

[JsonInclude]
[JsonPropertyName("type")]
[JsonConverter(typeof(JsonStringEnumConverter<AnnotationType>))]
public AnnotationType Type { get; }

Property Value

AnnotationType

Methods

AppendFrom(Annotation)

public void AppendFrom(Annotation other)

Parameters

other Annotation