Urus Tugas Kelompok

Hantar permintaan pukal tak segerak dan semak status pelaksanaan kelompok.

Hantar permintaan pukal tak segerak merentasi titik akhir model yang disokong menggunakan Batch API yang serasi dengan OpenAI.

POST/openai/v1/batches

Badan Permintaan

MedanJenisDiperlukanPenerangan
input_file_idstringYaPengecam fail dimuat naik dengan tujuan ditetapkan kepada batch.
endpointstringYaTitik akhir sasaran (/v1/chat/completions, /v1/completions, /v1/responses atau /v1/embeddings).
completion_windowstringYaTempoh penyelesaian, kini ditetapkan pada 24h.
metadataobjectTidakPasangan nilai kunci pilihan untuk penjejakan dan audit.

Fail input mestilah UTF-8 JSONL dengan maksimum 50,000 item dan had saiz fail 200 MiB. Setiap baris JSONL mestilah objek JSON sah yang mengandungi custom_id unik tidak kosong, method: "POST", url yang sepadan dengan endpoint kelompok, dan objek body (dengan medan model wajib untuk kelompok prabayar ketat). Untuk kelompok prabayar natif, get laluan mengesahkan checksum fail dan dasar pelaksanaan sebelum pembiayaan; semua tempahan item dikomit secara atomik sebelum penyerahan kepada pembekal. Dana agregat yang tidak mencukupi mengembalikan HTTP 402 tanpa penyerahan separa. Konfigurasi pembekal yang tidak serasi tidak boleh dipecahkan dalam satu kelompok, dan failover rentas pembekal peringkat item tidak dilakukan.

Kitaran Hayat Kelompok

GET/openai/v1/batches/{batch_id}
POST/openai/v1/batches/{batch_id}/cancel
  • validating: Mengesahkan format fail input, sintaks JSONL, dan pematuhan skema.
  • in_progress: Mengedarkan item ke kelayakan pembekal yang ditetapkan tanpa pertukaran rentas pembekal.
  • finalizing: Mengagregat output penjanaan dan merekodkan penyelesaian caj penggunaan.
  • completed: Pemprosesan selesai dengan jayanya, menghasilkan output_file_id serta error_file_id pilihan.
  • failed: Kegagalan terminal jika pengesahan fail atau koordinasi kelompok gagal sepenuhnya.
  • cancelling: Menghentikan pemprosesan atas permintaan dan beralih kepada status dibatalkan.
  • cancelled: Menandakan pelaksanaan kelompok dihentikan sebelum selesai sepenuhnya. Keputusan item yang gagal, dibatalkan, atau hilang tidak membuktikan kos penyedia sifar; penyelesaian mengekalkan dana tempahan untuk penyesuaian terhadap rekod penyedia. Status kanonikal dalam AnyInt ialah cancelled.
  • expired: Dicetuskan apabila pemprosesan melebihi tempoh 24 jam; pelaksanaan yang belum disahkan memerlukan penyesuaian berdasarkan rekod pembekal dan tidak bermakna kos sifar huluan.

Senarai Kelompok dan Muat Turun Hasil

GET/openai/v1/batches
  • Senarai kelompok: GET /openai/v1/batches menyenaraikan tugas kelompok aktif dan bersejarah untuk organisasi atau projek yang dibenarkan.
  • Storan objek & muat turun: Menerima fail dengan purpose: "batch" dan menjalankan operasi kelompok memerlukan storan objek kongsi (OBJECT_STORE_MODE). Setelah selesai, fail JSONL output dan ralat boleh dimuat turun melalui API fail di GET /openai/v1/files/{file_id}/content.

Alias Keserasian

  • Get laluan menerima /v1/batches untuk keserasian; gunakan /openai/v1/batches untuk integrasi baharu.