Class FileCitation

Namespace

OpenAI

Assembly

OpenAI-DotNet.dll

public sealed class FileCitation : IAnnotation

Inheritance

object

FileCitation

Implements

IAnnotation

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

FileId

The ID of the file.

[JsonInclude]
[JsonPropertyName("file_id")]
public string FileId { get; }

Property Value

string

FileName

The filename of the file cited.

[JsonInclude]
[JsonPropertyName("filename")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public string FileName { get; }

Property Value

string

Index

The index of the file in the list of files.

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

Property Value

int?

Type

[JsonInclude]
[JsonPropertyName("type")]
[JsonConverter(typeof(JsonStringEnumConverter<AnnotationType>))]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public AnnotationType Type { get; }

Property Value

AnnotationType