Files - Upload

Service:

Azure AI Services

API Version:

2024-05-01-preview

Membuat entitas file baru dengan mengunggah data dari komputer lokal. File yang diunggah dapat, misalnya, digunakan untuk melatih atau mengevaluasi model yang disempurnakan.

POST {endpoint}/openai/files?api-version=2024-05-01-preview

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
file	formData	True	file	Mendapatkan atau mengatur file untuk diunggah ke Azure OpenAI.
purpose	formData	True	Purpose	Tujuan yang dimaksudkan dari dokumen yang diunggah. Gunakan "fine-tune" untuk menyempurnakan. Ini memungkinkan kami untuk memvalidasi format file yang diunggah.
endpoint	path	True	string url	Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama akun Azure OpenAI Anda).
api-version	query	True	string	Versi API yang diminta.

Header Permintaan

Media Types: "multipart/form-data"

Nama	Diperlukan	Jenis	Deskripsi
api-key	True	string	Berikan kunci akun Azure OpenAI Cognitive Services Anda di sini.

Respons

Nama	Jenis	Deskripsi
201 Created	File	File berhasil dibuat. Headers Location: string
Other Status Codes	ErrorResponse	Terjadi kesalahan.

Keamanan

api-key

Berikan kunci akun Azure OpenAI Cognitive Services Anda di sini.

Type: apiKey
In: header

Contoh

Upload a file.

Sample Request

HTTP

POST https://aoairesource.openai.azure.com/openai/files?api-version=2024-05-01-preview

Sample Response

Status code:

201

location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099

Response Body

{
  "status": "pending",
  "purpose": "fine-tune",
  "filename": "puppy.jsonl",
  "id": "file-181a1cbdcdcf4677ada87f63a0928099",
  "created_at": 1646126127,
  "object": "file"
}

Definisi

Nama	Deskripsi
Error	Kesalahan
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
File	File
FileState	FileState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
Purpose	Tujuan
TypeDiscriminator	TypeDiscriminator

Error

Kesalahan

Nama	Jenis	Deskripsi
code	ErrorCode	ErrorCode Kode kesalahan seperti yang didefinisikan dalam panduan Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
details	Error[]	Detail kesalahan jika tersedia.
innererror	InnerError	InnerError Kesalahan dalam seperti yang didefinisikan dalam panduan Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
message	string	Pesan kesalahan ini.
target	string	Lokasi tempat kesalahan terjadi jika tersedia.

ErrorCode

ErrorCode

Nama	Jenis	Deskripsi
conflict	string	Operasi yang diminta berkonflik dengan status sumber daya saat ini.
contentFilter	string	Pembuatan gambar gagal sebagai akibat dari sistem keselamatan kami.
fileImportFailed	string	Impor file gagal.
forbidden	string	Operasi dilarang untuk kunci pengguna/api saat ini.
internalFailure	string	Kesalahan internal. Coba lagi.
invalidPayload	string	Data permintaan tidak valid untuk operasi ini.
itemDoesAlreadyExist	string	Item sudah ada.
jsonlValidationFailed	string	Validasi data jsonl gagal.
notFound	string	Sumber daya tidak ditemukan.
quotaExceeded	string	Kuota terlampaui.
serviceUnavailable	string	Layanan saat ini tidak tersedia.
tooManyRequests	string	Terlalu banyak permintaan. Coba ulang nanti.
unauthorized	string	Kunci pengguna/api saat ini tidak diotorisasi untuk operasi.
unexpectedEntityState	string	Operasi tidak dapat dijalankan dalam status sumber daya saat ini.

ErrorResponse

ErrorResponse

Nama	Jenis	Deskripsi
error	Error	Kesalahan Konten kesalahan seperti yang didefinisikan dalam panduan Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

File

File

Nama	Jenis	Deskripsi
bytes	integer	Ukuran file ini bila tersedia (bisa null). Ukuran file yang lebih besar dari 2^53-1 tidak didukung untuk memastikan kompatibilitas dengan bilangan bulat JavaScript.
created_at	integer	Tanda waktu ketika pekerjaan atau item ini dibuat (dalam epoch unix).
filename	string	Nama file.
id	string	Identitas item ini.
object	TypeDiscriminator	TypeDiscriminator Menentukan jenis objek.
purpose	Purpose	Tujuan Tujuan yang dimaksudkan dari dokumen yang diunggah. Gunakan "fine-tune" untuk menyempurnakan. Ini memungkinkan kami untuk memvalidasi format file yang diunggah.
status	FileState	FileState Status file.
status_details	string	Pesan kesalahan dengan detail jika pemrosesan file ini gagal.

FileState

FileState

Nama	Jenis	Deskripsi
deleted	string	Entitas telah dihapus tetapi masih dapat dirujuk oleh entitas lain yang mendahului penghapusan. Ini dapat dikategorikan sebagai status terminal.
deleting	string	Entitas adalah ni proses yang akan dihapus. Status ini tidak dikembalikan oleh Azure OpenAI dan hanya diekspos untuk kompatibilitas. Ini dapat dikategorikan sebagai status aktif.
error	string	Operasi telah menyelesaikan pemrosesan dengan kegagalan dan tidak dapat dikonsumsi lebih lanjut. Ini dapat dikategorikan sebagai status terminal.
pending	string	Operasi dibuat dan tidak diantrekan untuk diproses di masa mendatang. Ini dapat dikategorikan sebagai status tidak aktif.
processed	string	Operasi telah berhasil diproses dan siap untuk dikonsumsi. Ini dapat dikategorikan sebagai status terminal.
running	string	Operasi sudah mulai diproses. Ini dapat dikategorikan sebagai status aktif.
uploaded	string	File telah diunggah tetapi belum diproses. Status ini tidak dikembalikan oleh Azure OpenAI dan hanya diekspos untuk kompatibilitas. Ini dapat dikategorikan sebagai status tidak aktif.

InnerError

InnerError

Nama	Jenis	Deskripsi
code	InnerErrorCode	InnerErrorCode Kode kesalahan dalam seperti yang didefinisikan dalam panduan Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).
innererror	InnerError	InnerError Kesalahan dalam seperti yang didefinisikan dalam panduan Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

InnerErrorCode

Nama	Jenis	Deskripsi
invalidPayload	string	Data permintaan tidak valid untuk operasi ini.

Purpose

Tujuan

Nama	Jenis	Deskripsi
assistants	string	File ini berisi data yang akan digunakan dalam asisten.
assistants_output	string	File ini berisi hasil asisten.
fine-tune	string	File ini berisi data pelatihan untuk pekerjaan penyempurnaan.
fine-tune-results	string	File ini berisi hasil pekerjaan penyempurnaan.

TypeDiscriminator

TypeDiscriminator

Nama	Jenis	Deskripsi
file	string	Objek ini mewakili file.
fine_tuning.job	string	Objek ini mewakili pekerjaan yang baik.
fine_tuning.job.checkpoint	string	Objek ini mewakili titik pemeriksaan dari pekerjaan penyetelan halus.
fine_tuning.job.event	string	Objek ini mewakili peristiwa pekerjaan penyetelan halus.
list	string	Objek ini mewakili daftar objek lain.
model	string	Objek ini mewakili model (dapat menjadi model dasar atau menyempurnakan hasil pekerjaan).