Skip to content

Latest commit

 

History

History
32 lines (26 loc) · 9.96 KB

openaifile.md

File metadata and controls

32 lines (26 loc) · 9.96 KB

OpenAIFile

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

Example Usage

import { OpenAIFile } from "argot-open-ai/models/components";

let value: OpenAIFile = {
  id: "<id>",
  bytes: 725255,
  createdAt: 501324,
  filename: "example.file",
  object: "file",
  purpose: "vision",
  status: "processed",
};

Fields

Field Type Required Description
id string ✔️ The file identifier, which can be referenced in the API endpoints.
bytes number ✔️ The size of the file, in bytes.
createdAt number ✔️ The Unix timestamp (in seconds) for when the file was created.
filename string ✔️ The name of the file.
object components.OpenAIFileObject ✔️ The object type, which is always file.
purpose components.Purpose ✔️ The intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results and vision.
status components.Status ✔️ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Deprecated. The current status of the file, which can be either uploaded, processed, or error.
statusDetails string ➖ : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

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