Files - Upload

Layanan:: Azure AI Services

Versi API:: 2024-10-21

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-10-21

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 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. Header Location: string
Other Status Codes	ErrorResponse	Terjadi kesalahan.

Nama

Jenis

Deskripsi

201 Created

File

File berhasil dibuat.

Header

Location: string

Other Status Codes

ErrorResponse

Terjadi kesalahan.

Keamanan

api-key

Berikan kunci akun Azure OpenAI Cognitive Services Anda di sini.

Jenis: apiKey
Dalam: header

Contoh

Upload a file.

Permintaan sampel

HTTP

POST https://aoairesource.openai.azure.com/openai/files?api-version=2024-10-21

Respon sampel

Kode status:: 201

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

{
  "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	Arsip
FileState	FileState
InnerError	InnerError
InnerErrorCode	InnerErrorCode
Purpose	Maksud
TypeDiscriminator	TypeDiscriminator

Error

Objek

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 minLength: 1	Pesan kesalahan ini.
target	string	Lokasi tempat kesalahan terjadi jika tersedia.

ErrorCode

Enumerasi

ErrorCode

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

ErrorResponse

Objek

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

Objek

Arsip

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

FileState

Enumerasi

FileState

Nilai	Deskripsi
uploaded	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.
pending	Operasi dibuat dan tidak diantrekan untuk diproses di masa mendatang. Ini dapat dikategorikan sebagai status tidak aktif.
running	Operasi telah mulai diproses. Ini dapat dikategorikan sebagai status aktif.
processed	Operasi telah berhasil diproses dan siap untuk dikonsumsi. Ini dapat dikategorikan sebagai status terminal.
error	Operasi telah menyelesaikan pemrosesan dengan kegagalan dan tidak dapat dikonsumsi lebih lanjut. Ini dapat dikategorikan sebagai status terminal.
deleting	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.
deleted	Entitas telah dihapus tetapi mungkin masih dirujuk oleh entitas lain yang mendahului penghapusan. Ini dapat dikategorikan sebagai status terminal.

InnerError

Objek

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

Enumerasi

InnerErrorCode

Nilai	Deskripsi
invalidPayload	Data permintaan tidak valid untuk operasi ini.

Purpose

Enumerasi

Maksud

Nilai	Deskripsi
fine-tune	File ini berisi data pelatihan untuk pekerjaan yang menyempurnakan.
fine-tune-results	File ini berisi hasil pekerjaan penyempurnaan halus.
assistants	File ini berisi data yang akan digunakan dalam asisten.
assistants_output	File ini berisi hasil asisten.
batch	File ini berisi data input untuk batch.
batch_output	File ini berisi hasil batch.

TypeDiscriminator

Enumerasi

TypeDiscriminator

Nilai	Deskripsi
list	Objek ini mewakili daftar objek lain.
fine_tuning.job	Objek ini mewakili pekerjaan penyetelan halus.
file	Objek ini mewakili file.
fine_tuning.job.event	Objek ini mewakili peristiwa pekerjaan penyetelan halus.
fine_tuning.job.checkpoint	Objek ini mewakili titik pemeriksaan dari pekerjaan penyetelan halus.
model	Objek ini mewakili model (dapat menjadi model dasar atau menyempurnakan hasil pekerjaan).
batch	Objek ini mewakili batch.
upload	Objek ini mewakili unggahan file.
upload.part	Objek ini mewakili bagian dari unggahan file.