AI Dev Kit
Search Results for

    Show / Hide Table of Contents

    Class OpenAIFile

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

    Inheritance
    object
    OpenAIFile
    Implements
    IApiFile
    IData
    Namespace: Glitch9.AIDevKit.OpenAI
    Assembly: .dll
    Syntax
    public class OpenAIFile : IApiFile, IData

    Properties

    Api

    Declaration
    public Api Api { get; }
    Property Value
    Type Description
    Api

    ByteSize

    The size of the file, in bytes

    Declaration
    public int ByteSize { get; set; }
    Property Value
    Type Description
    int

    CreatedAt

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

    Declaration
    public UnixTime CreatedAt { get; set; }
    Property Value
    Type Description
    UnixTime

    ExpiresAt

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

    Declaration
    public UnixTime ExpiresAt { get; set; }
    Property Value
    Type Description
    UnixTime

    Id

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

    Declaration
    public string Id { get; set; }
    Property Value
    Type Description
    string

    MimeType

    Declaration
    public MIMEType MimeType { get; }
    Property Value
    Type Description
    MIMEType

    Name

    The name of the file

    Declaration
    public string Name { get; set; }
    Property Value
    Type Description
    string

    Object

    The object type, which is always file.

    Declaration
    public string Object { get; set; }
    Property Value
    Type Description
    string

    Purpose

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

    Declaration
    public UploadPurpose? Purpose { get; set; }
    Property Value
    Type Description
    UploadPurpose?

    Methods

    BuildMetadata()

    Declaration
    public Metadata BuildMetadata()
    Returns
    Type Description
    Metadata

    Implements

    IApiFile
    IData
    In this article
    Back to top Generated by DocFX