Class OpenAIFile

The File object represents a document that has been uploaded to OpenAI.

Inheritance
object
OpenAIFile
GroqCloudFile
Implements
Inherited Members
Namespace: Glitch9.AIDevKit.OpenAI
Assembly: Glitch9.AIDevKit.Provider.OpenAI.dll
Syntax
public class OpenAIFile : IUploadedFile, IAIResource, IData, IHasId<string>, IHasName, IDeprecatable

Properties

| Edit this page View Source

Api

Declaration
[JsonIgnore]
public virtual Api Api { get; }
Property Value
Type Description
Api
| Edit this page View Source

ByteSize

The size of the file, in bytes

Declaration
[JsonProperty("bytes")]
public int ByteSize { get; set; }
Property Value
Type Description
int
| Edit this page View Source

CreatedAt

The Unix timestamp (in seconds) of when this object was created.

Declaration
[JsonProperty("created_at")]
public UnixTime? CreatedAt { get; set; }
Property Value
Type Description
UnixTime?
| Edit this page View Source

ExpiresAt

The Unix timestamp (in seconds) of when this object will expire.

Declaration
[JsonProperty("expires_at")]
public UnixTime? ExpiresAt { get; set; }
Property Value
Type Description
UnixTime?
| Edit this page View Source

Id

The file identifier, which can be referenced in the API endpoints.

Declaration
[JsonProperty("id")]
public string Id { get; set; }
Property Value
Type Description
string
| Edit this page View Source

MimeType

Gets the MIME type associated with the file. This can be used to select preview, parsing, or processing paths.

Declaration
[JsonIgnore]
public MimeType MimeType { get; }
Property Value
Type Description
MimeType
| Edit this page View Source

Name

The name of the file

Declaration
[JsonProperty("filename")]
public string Name { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Object

The object type, which is always file.

Declaration
[JsonProperty("object")]
public string Object { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Purpose

The intended purpose of the file. Supported values are fine-tune, fine-tune-results, Assistants, and Assistants_Output

Declaration
[JsonProperty("purpose")]
public UploadPurpose? Purpose { get; set; }
Property Value
Type Description
UploadPurpose?

Methods

| Edit this page View Source

GetMetadata()

Declaration
public SerializableMetadata GetMetadata()
Returns
Type Description
SerializableMetadata

Implements

Extension Methods