Files - Delete

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

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

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

FileDelete

Objek

FileDelete

Nama Jenis Deskripsi
deleted

boolean

Nilai yang menunjukkan apakah mendapatkan jika file dihapus.
id

string

minLength: 1

Id file yang dihapus.
object

TypeDiscriminator

TypeDiscriminator
Menentukan jenis objek.

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.

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.