Files - Import
Membuat entitas file baru dengan mengimpor data dari url yang disediakan. File yang diunggah dapat, misalnya, digunakan untuk melatih atau mengevaluasi model yang disempurnakan.
POST {endpoint}/openai/files/import?api-version=2024-02-01
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). |
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. |
Isi Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
content_url | True |
string |
Url untuk mengunduh dokumen dari (dapat berupa url SAS blob atau url eksternal lainnya yang dapat diakses dengan permintaan GET). |
filename | True |
string |
Nama file Baris JSON yang akan diunggah.
|
purpose | True |
Tujuan |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
201 Created |
File berhasil dibuat. Headers Location: string |
|
Other Status Codes |
Error |
Terjadi kesalahan. |
Keamanan
api-key
Berikan kunci akun Azure OpenAI Cognitive Services Anda di sini.
Type:
apiKey
In:
header
Contoh
Importing a file with a blob url as source.
Sample Request
POST https://aoairesource.openai.azure.com/openai/files/import?api-version=2024-02-01
{
"purpose": "fine-tune",
"filename": "puppy.jsonl",
"content_url": "https://www.contoso.com/trainingdata/puppy.jsonl"
}
Sample Response
location: https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099
{
"purpose": "fine-tune",
"filename": "puppy.jsonl",
"id": "file-181a1cbdcdcf4677ada87f63a0928099",
"status": "notRunning",
"created_at": 1646126127,
"object": "file"
}
Definisi
Nama | Deskripsi |
---|---|
Error |
Kesalahan |
Error |
ErrorCode |
Error |
ErrorResponse |
File |
File |
File |
FileImport |
File |
FileState |
Inner |
InnerError |
Inner |
InnerErrorCode |
Purpose |
Tujuan |
Type |
TypeDiscriminator |
Error
Kesalahan
Nama | Jenis | Deskripsi |
---|---|---|
code |
Error |
ErrorCode |
details |
Error[] |
Detail kesalahan jika tersedia. |
innererror |
Inner |
InnerError |
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 keamanan 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 |
Kesalahan |
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 |
Type |
TypeDiscriminator |
purpose |
Tujuan |
|
status |
File |
FileState |
status_details |
string |
Pesan kesalahan dengan detail jika pemrosesan file ini gagal. |
FileImport
FileImport
Nama | Jenis | Deskripsi |
---|---|---|
content_url |
string |
Url untuk mengunduh dokumen dari (dapat berupa url SAS blob atau url eksternal lainnya yang dapat diakses dengan permintaan GET). |
filename |
string |
Nama file Baris JSON yang akan diunggah.
|
purpose |
Tujuan |
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 |
Inner |
InnerErrorCode |
innererror |
Inner |
InnerError |
InnerErrorCode
InnerErrorCode
Nama | Jenis | Deskripsi |
---|---|---|
invalidPayload |
string |
Data permintaan tidak valid untuk operasi ini. |
Purpose
Tujuan
Nama | Jenis | Deskripsi |
---|---|---|
fine-tune |
string |
File ini berisi data pelatihan untuk menyempurnakan pekerjaan. |
fine-tune-results |
string |
File ini berisi hasil pekerjaan penyempurnaan. |
TypeDiscriminator
TypeDiscriminator
Nama | Jenis | Deskripsi |
---|---|---|
file |
string |
Objek ini mewakili file. |
fine-tune |
string |
Objek ini mewakili pekerjaan penyempurnaan. |
fine-tune-event |
string |
Objek ini mewakili peristiwa pekerjaan penyempurnaan. |
fine_tuning.job |
string |
Objek ini mewakili pekerjaan penyempurnaan. |
fine_tuning.job.event |
string |
Objek ini mewakili peristiwa pekerjaan penyetelan yang baik. |
list |
string |
Objek ini mewakili daftar objek lain. |
model |
string |
Objek ini mewakili model (dapat menjadi model dasar atau menyempurnakan hasil pekerjaan). |