Files - Delete

Referensi

Layanan:: Azure AI Services

Versi API:: 2024-10-21

Menghapus file dengan id-file yang diberikan. Penghapusan juga diizinkan jika file digunakan, misalnya, sebagai file pelatihan dalam pekerjaan yang disempurnakan.

DELETE {endpoint}/openai/files/{file-id}?api-version=2024-10-21

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
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).
file-id	path	True	string	Pengidentifikasi file.
api-version	query	True	string	Versi API yang diminta.

Header Permintaan

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

Respons

Nama	Jenis	Deskripsi
200 OK	FileDelete	File berhasil dihapus.
Other Status Codes	ErrorResponse	Terjadi kesalahan.

Keamanan

api-key

Berikan kunci akun Azure OpenAI Cognitive Services Anda di sini.

Jenis: apiKey
Dalam: header

Contoh

Deleting a file.

Permintaan sampel

HTTP

DELETE https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099?api-version=2024-10-21

Respon sampel

Kode status:: 200

{
  "object": "file",
  "deleted": true,
  "id": "file-181a1cbdcdcf4677ada87f63a0928099"
}

Definisi

Nama	Deskripsi
Error	Kesalahan
ErrorCode	ErrorCode
ErrorResponse	ErrorResponse
FileDelete	FileDelete
InnerError	InnerError
InnerErrorCode	InnerErrorCode
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

Nama	Jenis	Deskripsi
conflict	string	Operasi yang diminta berkonflik dengan status sumber daya saat ini.
contentFilter	string	Pembuatan gambar gagal sebagai akibat dari sistem keamanan kami.
fileImportFailed	string	Impor file gagal.
forbidden	string	Operasi dilarang untuk kunci pengguna/api saat ini.
internalFailure	string	Kesalahan internal. Silakan 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. Silakan coba lagi 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

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).

FileDelete

Nama	Jenis	Deskripsi
deleted	boolean	Nilai yang menunjukkan apakah mendapatkan jika file dihapus.
id	string	Id file yang dihapus.
object	TypeDiscriminator	TypeDiscriminator Menentukan jenis 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

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

TypeDiscriminator

Nama	Jenis	Deskripsi
batch	string	Objek ini mewakili batch.
file	string	Objek ini mewakili file.
fine_tuning.job	string	Objek ini mewakili pekerjaan penyetelan halus.
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).
upload	string	Objek ini mewakili unggahan file.
upload.part	string	Objek ini mewakili bagian dari unggahan file.

Bagikan melalui