Files - Upload
Creates a new file entity by uploading data from a local machine. Uploaded files can, for example, be used for training or evaluating fine-tuned models.
POST {endpoint}/openai/files?api-version=2024-08-01-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
file
|
formData | True |
file |
Gets or sets the file to upload into Azure OpenAI. |
purpose
|
formData | True |
The intended purpose of the uploaded documents. Use "fine-tune" for fine-tuning. This allows us to validate the format of the uploaded file. |
|
endpoint
|
path | True |
string url |
Supported Cognitive Services endpoints (protocol and hostname, for example: https://aoairesource.openai.azure.com. Replace "aoairesource" with your Azure OpenAI account name). |
api-version
|
query | True |
string |
The requested API version. |
Responses
Name | Type | Description |
---|---|---|
201 Created |
The file has been successfully created. Headers Location: string |
|
Other Status Codes |
An error occurred. |
Security
api-key
API key authentication
Type:
apiKey
In:
header
OAuth2Auth
OAuth2 authentication
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Scopes
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default |
Examples
Upload a file.
Sample request
POST https://aoairesource.openai.azure.com/openai/files?api-version=2024-08-01-preview
Sample response
location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099
{
"purpose": "fine-tune",
"filename": "puppy.jsonl",
"id": "file-181a1cbdcdcf4677ada87f63a0928099",
"created_at": 1646126127,
"object": "file"
}
Definitions
Name | Description |
---|---|
Error |
Error |
Error |
ErrorCode |
Error |
ErrorResponse |
File |
File |
Inner |
InnerError |
Inner |
InnerErrorCode |
Purpose |
Purpose |
Type |
TypeDiscriminator |
Error
Error
Name | Type | Description |
---|---|---|
code |
ErrorCode |
|
details |
Error[] |
The error details if available. |
innererror |
InnerError |
|
message |
string |
The message of this error. |
target |
string |
The location where the error happened if available. |
ErrorCode
ErrorCode
Name | Type | Description |
---|---|---|
conflict |
string |
The requested operation conflicts with the current resource state. |
contentFilter |
string |
Image generation failed as a result of our safety system. |
fileImportFailed |
string |
Import of file failed. |
forbidden |
string |
The operation is forbidden for the current user/api key. |
internalFailure |
string |
Internal error. Please retry. |
invalidPayload |
string |
The request data is invalid for this operation. |
itemDoesAlreadyExist |
string |
The item does already exist. |
jsonlValidationFailed |
string |
Validation of jsonl data failed. |
notFound |
string |
The resource is not found. |
quotaExceeded |
string |
Quota exceeded. |
serviceUnavailable |
string |
The service is currently not available. |
tooManyRequests |
string |
Too many requests. Please retry later. |
unauthorized |
string |
The current user/api key is not authorized for the operation. |
unexpectedEntityState |
string |
The operation cannot be executed in the current resource's state. |
ErrorResponse
ErrorResponse
Name | Type | Description |
---|---|---|
error |
Error |
File
File
Name | Type | Description |
---|---|---|
bytes |
integer |
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. |
created_at |
integer |
A timestamp when this job or item was created (in unix epochs). |
filename |
string |
The name of the file. |
id |
string |
The identity of this item. |
object |
TypeDiscriminator |
|
purpose |
Purpose |
InnerError
InnerError
Name | Type | Description |
---|---|---|
code |
InnerErrorCode |
|
innererror |
InnerError |
InnerErrorCode
InnerErrorCode
Name | Type | Description |
---|---|---|
invalidPayload |
string |
The request data is invalid for this operation. |
Purpose
Purpose
Name | Type | Description |
---|---|---|
assistants |
string |
This file contains data to be used in assistants. |
assistants_output |
string |
This file contains the results of an assistant. |
batch |
string |
This file contains the input data for a batch. |
batch_output |
string |
This file contains the results of a batch. |
fine-tune |
string |
This file contains training data for a fine tune job. |
fine-tune-results |
string |
This file contains the results of a fine tune job. |
TypeDiscriminator
TypeDiscriminator
Name | Type | Description |
---|---|---|
file |
string |
This object represents a file. |
fine_tuning.job |
string |
This object represents a fine tune job. |
fine_tuning.job.checkpoint |
string |
This object represents a checkpoint of a fine tuning job. |
fine_tuning.job.event |
string |
This object represents an event of a fine tuning job. |
list |
string |
This object represents a list of other objects. |
model |
string |
This object represents a model (can be a base model or fine tune job result). |
upload |
string |
This object represents a file upload. |
upload.part |
string |
This object represents part of a file upload. |