Package version:

Interface FileInfo

Represents an agent that can call the model and use tools.

interface FileInfo {
    bytes: number;
    createdAt: Date;
    filename: string;
    id: string;
    object: "file";
    purpose: FilePurpose;
    status?: FileState;
    statusDetails?: string;
}

Properties

bytes: number

The size of the file, in bytes.

createdAt: Date

The Unix timestamp, in seconds, representing when this object was created.

filename: string

The name of the file.

id: string

The identifier, which can be referenced in API endpoints.

The object type, which is always 'file'.

The intended purpose of a file.

The state of the file. This field is available in Azure OpenAI only.

statusDetails?: string

The error message with details in case processing of this file failed. This field is available in Azure OpenAI only.