Sign in

v27

latestOpenAPI 3.0.02026-07-1347144237.4 KB
Files:

Creates a new file entity by importing data from a provided url. Uploaded files can, for example, be used for training or evaluating fine-tuned models.

post/files/import

Query parameters

api-versionstring required

The requested API version.

Request body

purpose'fine-tune' | 'fine-tune-results' | 'assistants' | 'assistants_output' | 'batch' | 'batch_output' | 'evals' | 'evals_output' required

The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file.

filenamestring required

The name of the JSON Lines file to be uploaded. If the purpose is set to "fine-tune", each line is a JSON record with "prompt" and "completion" fields representing your training examples.

content_urlstring url required

The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request).

Response

The file has been successfully created.

object'list' | 'fine_tuning.job' | 'file' | 'fine_tuning.job.event' | 'fine_tuning.job.checkpoint' | 'model' | 'upload' | 'upload.part' | 'batch' | 'wandb'

Defines the type of an object.

created_atinteger

A timestamp when this job or item was created (in unix epochs).

idstring

The identity of this item.

status'uploaded' | 'pending' | 'running' | 'processed' | 'error' | 'deleting' | 'deleted'

The state of a file.

bytesinteger

The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers.

purpose'fine-tune' | 'fine-tune-results' | 'assistants' | 'assistants_output' | 'batch' | 'batch_output' | 'evals' | 'evals_output' required

The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file.

filenamestring required

The name of the file.

expires_atinteger

A unix timestamp (the number of seconds that have elapsed since January 1, 1970) when the file is expired.

status_detailsstring

The error message with details in case processing of this file failed. Deprecated.