Skip to main content
Module

x/openai/resources/files.ts>FileObject

Deno build of the official Typescript library for the OpenAI API.
Extremely Popular
Go to Latest
interface FileObject
import { type FileObject } from "https://deno.land/x/openai@v4.21.0/resources/files.ts";

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

Properties

id: string

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

bytes: number

The size of the file, in bytes.

created_at: number

The Unix timestamp (in seconds) for when the file was created.

filename: string

The name of the file.

object: "file"

The object type, which is always file.

purpose:
| "fine-tune"
| "fine-tune-results"
| "assistants"
| "assistants_output"

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

status: "uploaded" | "processed" | "error"

Deprecated. The current status of the file, which can be either uploaded, processed, or error.

optional
status_details: string

Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.