Azure OpenAI dalam referensi dari REST API Model Azure AI Foundry

2025-07-02

Artikel ini menyediakan detail tentang titik akhir REST API inferensi untuk Azure OpenAI.

Spesifikasi API

Mengelola dan berinteraksi dengan model dan sumber daya Azure OpenAI dibagi di tiga permukaan API utama:

Pesawat pengendali
Bidang data - penulisan
Bidang data - inferensi

Setiap permukaan/spesifikasi API merangkum serangkaian kemampuan Azure OpenAI yang berbeda. Setiap API memiliki serangkaian pratinjau uniknya sendiri dan rilis API stabil/tersedia secara umum (GA). Rilis pratinjau saat ini cenderung mengikuti irama bulanan.

Penting

Sekarang ada API pratinjau inferensi baru. Pelajari lebih lanjut di panduan siklus hidup API kami.

API	Rilis pratinjau terbaru	Rilis GA terbaru	Spesifikasi	Deskripsi
Pesawat kontrol	`2024-06-01-preview`	`2024-10-01`	File spesifikasi teknis	Azure OpenAI berbagi sarana kontrol umum dengan semua layanan lainnya. API sarana kontrol digunakan untuk hal-hal seperti membuat sumber daya Azure OpenAI, penyebaran model, dan tugas manajemen sumber daya tingkat lebih tinggi lainnya. Sarana kontrol juga mengatur apa yang mungkin dilakukan dengan kemampuan seperti Azure Resource Manager, Bicep, Terraform, dan Azure CLI.
Lapisan data - pengaturan	`2025-04-01-preview`	`2024-10-21`	File spesifikasi teknis	API penulisan sarana data mengontrol penyempurnaan, pengunggahan berkas, pekerjaan penyerapan, batch dan kueri tingkat model tertentu
Lapisan data - inferensi	`2025-04-01-preview`	`2024-10-21`	File spesifikasi teknis	API inferensi lapisan data menyediakan kemampuan/titik akhir inferensi untuk fitur seperti pemrosesan akhir, pemrosesan obrolan, penyematan, audio, berdasarkan data Anda, Dall-e, asisten, dll.

Otentikasi

Azure OpenAI menyediakan dua metode untuk autentikasi. Anda dapat menggunakan Kunci API atau ID Microsoft Entra.

Autentikasi Kunci API: Untuk jenis autentikasi ini, semua permintaan API harus menyertakan Kunci API di api-key header HTTP. Mulai Cepat menyediakan panduan tentang cara melakukan panggilan dengan jenis autentikasi ini.
Autentikasi ID Microsoft Entra: Anda dapat mengautentikasi panggilan API menggunakan token Microsoft Entra. Token autentikasi disertakan dalam permintaan sebagai header Authorization. Nilai token yang diberikan harus didahului dengan Bearer, contohnya Bearer YOUR_AUTH_TOKEN. Anda dapat membaca panduan cara mengautentikasi dengan MICROSOFT Entra ID.

Pemversionan REST API

Versi API layanan diterapkan menggunakan parameter kueri api-version. Semua versi mengikuti struktur tanggal YYYY-MM-DD. Contohnya:

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

Inferensi bidang data

Sisa artikel ini membahas rilis GA terbaru dari spesifikasi inferensi sarana data Azure OpenAI, 2024-10-21.

Jika Anda mencari dokumentasi tentang rilis API pratinjau terbaru, lihat API inferensi sarana data pratinjau terbaru

Penyelesaian

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-21

Membuat penyelesaian untuk prompt, parameter, dan model yang dipilih yang disediakan.

Parameter URI

Nama	Di dalam	Diperlukan	Tipe	Deskripsi
titik akhir	jalan	Ya	string URL	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: `https://aoairesource.openai.azure.com`. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
ID penempatan	jalan	Ya	string	ID penyebaran model yang telah disebarkan.
versi-API	kueri	Ya	string	Versi API

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
kunci API	Benar	string	Sediakan kunci API Azure OpenAI di sini

Badan Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
minta	string atau array	Perintah untuk menghasilkan penyelesaian, dikodekan sebagai string, array string, array token, atau array dari array token. Perhatikan bahwa <\|endoftext\|> adalah pemisah dokumen yang dilihat model selama pelatihan, jadi jika permintaan tidak ditentukan, model akan dihasilkan seolah-olah dari awal dokumen baru.	Ya
terbaik dari	bilangan bulat	Menghasilkan penyelesaian di sisi server dan mengembalikan yang "terbaik" (dengan probabilitas log tertinggi per token). Hasil tidak dapat dialirkan. Ketika digunakan dengan `n`, `best_of` mengontrol jumlah penyelesaian kandidat dan `n` menentukan berapa banyak yang harus dikembalikan – `best_of` harus lebih besar dari `n`. Catatan: Karena parameter ini menghasilkan banyak penyelesaian, parameter ini dapat dengan cepat menggunakan kuota token Anda. Gunakan dengan hati-hati dan pastikan Anda memiliki pengaturan yang wajar untuk `max_tokens` dan `stop`.	Tidak.	1
gema	Boolean	Gema ulang perintah beserta penyelesaiannya	Tidak.	Tidak benar
penalti frekuensi	nomor/angka	Angka antara -2,0 dan 2,0. Nilai positif memberi penalti pada token baru berdasarkan frekuensi kemunculannya dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi secara persis kalimat yang sama.	Tidak.	0
logit_bias	objek	Ubah kemungkinan token tertentu muncul dalam penyelesaian. Menerima objek JSON yang memetakan token (ditentukan oleh ID token mereka di tokenizer GPT) ke nilai bias terkait dari -100 hingga 100. Secara matematis, bias ditambahkan ke logit yang dihasilkan oleh model sebelum pengambilan sampel. Efek yang tepat akan bervariasi per model, tetapi nilai antara -1 dan 1 harus mengurangi atau meningkatkan kemungkinan pilihan; nilai seperti -100 atau 100 harus menghasilkan larangan atau pilihan eksklusif dari token yang relevan. Sebagai contoh, Anda dapat meneruskan `{"50256": -100}` untuk mencegah <token \|endoftext\|> dihasilkan.	Tidak.	Tidak ada
logprobs	bilangan bulat	Sertakan probabilitas log pada `logprobs` token output yang paling mungkin, serta token yang dipilih. Misalnya, jika `logprobs` adalah 5, API akan mengembalikan daftar lima token yang paling mungkin. API akan selalu mengembalikan `logprob` token sampel, sehingga mungkin ada hingga `logprobs+1` elemen dalam respons. Nilai maksimum untuk `logprobs` adalah 5.	Tidak.	Tidak ada
maksimum token	bilangan bulat	Jumlah maksimum token yang dapat dihasilkan dalam penyelesaian. Jumlah token prompt Anda ditambah `max_tokens` tidak dapat melebihi panjang konteks model.	Tidak.	16
n	bilangan bulat	Berapa banyak penyelesaian yang dihasilkan untuk setiap perintah. Catatan: Karena parameter ini menghasilkan banyak penyelesaian, parameter ini dapat dengan cepat menggunakan kuota token Anda. Gunakan dengan hati-hati dan pastikan Anda memiliki pengaturan yang wajar untuk `max_tokens` dan `stop`.	Tidak.	1
presence_penalty (penalti kehadiran)	nomor/angka	Angka antara -2,0 dan 2,0. Nilai positif memberikan penalti pada token baru berdasarkan kemunculannya dalam teks sejauh ini, meningkatkan kemungkinan model berbicara tentang topik baru.	Tidak.	0
benih	bilangan bulat	Jika ditentukan, sistem kami akan melakukan upaya terbaik untuk sampel secara deterministik, sehingga permintaan berulang dengan yang sama `seed` dan parameter harus mengembalikan hasil yang sama. Determinisme tidak dijamin, dan Anda harus merujuk ke `system_fingerprint` parameter respons untuk memantau perubahan di backend.	Tidak.
berhenti	string atau array	Hingga empat urutan di mana API akan berhenti menghasilkan token lebih lanjut. Teks yang dikembalikan tidak akan berisi urutan berhenti.	Tidak.
aliran	Boolean	Apakah ingin melakukan streaming kemajuan parsial. Jika diatur, token akan dikirimkan sebagai peristiwa yang hanya berupa data yang dikirimkan oleh server saat tersedia, dan streaming dihentikan oleh pesan.	Tidak.	Tidak benar
Akhiran	string	Akhiran yang muncul setelah penyelesaian penyisipan teks. Parameter ini hanya didukung untuk `gpt-3.5-turbo-instruct`.	Tidak.	Tidak ada
suhu	nomor/angka	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Kami umumnya merekomendasikan untuk memodifikasi ini atau `top_p` tetapi tidak keduanya.	Tidak.	1
top_p	nomor/angka	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk memodifikasi ini atau `temperature` tetapi tidak keduanya.	Tidak.	1
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	Tidak.

Tanggapan

Kode Status: 200

Deskripsi: OK

Content-Type	Tipe	Deskripsi
application/json	createCompletionResponse	Mewakili respons penyelesaian dari API. Catatan: objek respons yang dialirkan dan tidak dialirkan memiliki bentuk yang sama (tidak seperti titik akhir obrolan).

Kode Status: default

Deskripsi: Layanan tidak tersedia

Content-Type	Tipe	Deskripsi
application/json	errorResponse

Contoh

Membuat penyelesaian untuk prompt, parameter, dan model yang dipilih yang disediakan.

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-21

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

Respons: Kode Status: 200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

Pemadatan

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21

Dapatkan representasi vektor dari input tertentu yang dapat dengan mudah dikonsumsi oleh model dan algoritma pembelajaran mesin.

Parameter URI

Nama	Di dalam	Diperlukan	Tipe	Deskripsi
titik akhir	jalan	Ya	string URL	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: `https://aoairesource.openai.azure.com`. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
ID penempatan	jalan	Ya	string
versi-API	kueri	Ya	string	Versi API

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
kunci API	Benar	string	Sediakan kunci API Azure OpenAI di sini

Badan Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan
Masukan	string atau array	Masukkan teks untuk disematkan, dikodekan sebagai string atau array token. Untuk menyematkan beberapa input dalam satu permintaan, berikan array string atau array kumpulan token. Input tidak boleh melebihi token input maksimum untuk model (8.192 token untuk `text-embedding-ada-002`), tidak boleh berupa string kosong, dan array apa pun harus 2.048 dimensi atau kurang.	Ya
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	Tidak.
tipe_masukan	string	jenis input untuk pencarian embedding yang akan digunakan	Tidak.
format_pengkodean	string	Format untuk mengembalikan penggabungan dalam. Dapat berupa `float` atau `base64`. Secara default menjadi `float`.	Tidak.
ukuran	bilangan bulat	Jumlah dimensi yang harus dimiliki oleh embedding output yang dihasilkan. Hanya didukung pada model `text-embedding-3` dan yang lebih baru.	Tidak.

Tanggapan

Nama	Tipe	Diperlukan
objek	string	Ya
model	string	Ya
data	array	Ya
penggunaan	objek	Ya

Sifat untuk penggunaan

prompt_tokens

Nama	Tipe	Deskripsi	Bawaan
prompt_tokens	bilangan bulat

jumlah_token

Nama	Tipe	Deskripsi	Bawaan
jumlah_token	bilangan bulat

Kode Status: 200

Deskripsi: OK

Content-Type	Tipe	Deskripsi
application/json	objek

Contoh

Kembalikan penyematan untuk prompt tertentu.

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21

{
 "input": [
  "this is a test"
 ]
}

Respons: Kode Status: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Penyelesaian percakapan

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

Membuat penyelesaian untuk pesan obrolan

Parameter URI

Nama	Di dalam	Diperlukan	Tipe	Deskripsi
titik akhir	jalan	Ya	string URL	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: `https://aoairesource.openai.azure.com`. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
ID penempatan	jalan	Ya	string	ID penyebaran model yang telah disebarkan.
versi-API	kueri	Ya	string	Versi API

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
kunci API	Benar	string	Sediakan kunci API Azure OpenAI di sini

Badan Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
suhu	nomor/angka	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Kami umumnya merekomendasikan untuk memodifikasi ini atau `top_p` tetapi tidak keduanya.	Tidak.	1
top_p	nomor/angka	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk memodifikasi ini atau `temperature` tetapi tidak keduanya.	Tidak.	1
aliran	Boolean	Jika diatur, delta pesan parsial akan dikirim, seperti di ChatGPT. Token akan dikirim sebagai peristiwa yang dikirim server hanya data saat tersedia, dengan aliran dihentikan oleh pesan `data: [DONE]`.	Tidak.	Tidak benar
berhenti	string atau array	Hingga empat urutan di mana API akan berhenti menghasilkan token lebih lanjut.	Tidak.
maksimum token	bilangan bulat	Jumlah maksimum token yang dapat dihasilkan dalam penyelesaian obrolan. Panjang total token input dan token yang dihasilkan dibatasi oleh panjang konteks model.	Tidak.
max_completion_tokens (batas maksimal token penyelesaian)	bilangan bulat	Batas atas untuk jumlah token yang dapat dihasilkan untuk penyelesaian, termasuk token output yang terlihat dan token penalaran.	Tidak.
presence_penalty (penalti kehadiran)	nomor/angka	Angka antara -2,0 dan 2,0. Nilai positif memberikan penalti pada token baru berdasarkan kemunculannya dalam teks sejauh ini, meningkatkan kemungkinan model berbicara tentang topik baru.	Tidak.	0
penalti frekuensi	nomor/angka	Angka antara -2,0 dan 2,0. Nilai positif memberi penalti pada token baru berdasarkan frekuensi kemunculannya dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi secara persis kalimat yang sama.	Tidak.	0
logit_bias	objek	Ubah kemungkinan token tertentu muncul dalam penyelesaian. Menerima objek JSON yang memetakan token (ditentukan oleh ID token mereka di tokenizer) ke nilai bias terkait dari -100 hingga 100. Secara matematis, bias ditambahkan ke logit yang dihasilkan oleh model sebelum pengambilan sampel. Efek yang tepat akan bervariasi per model, tetapi nilai antara -1 dan 1 harus mengurangi atau meningkatkan kemungkinan pilihan; nilai seperti -100 atau 100 harus menghasilkan larangan atau pilihan eksklusif dari token yang relevan.	Tidak.	Tidak ada
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	Tidak.
pesan	array	Daftar pesan yang terdiri dari percakapan sejauh ini.	Ya
sumber data	array	Entri konfigurasi untuk ekstensi obrolan Azure OpenAI yang menggunakannya. Spesifikasi tambahan ini hanya kompatibel dengan Azure OpenAI.	Tidak.
logprobs	Boolean	Apakah akan mengembalikan probabilitas log dari token output atau tidak. Jika benar, mengembalikan probabilitas logaritmik dari setiap token keluaran yang dikembalikan di `content` dari `message`.	Tidak.	Tidak benar
top_logprobs	bilangan bulat	Bilangan bulat antara 0 dan 20 yang menentukan jumlah token yang kemungkinan besar akan dikembalikan pada setiap posisi token, masing-masing dengan probabilitas log terkait. `logprobs` harus diatur ke `true` jika parameter ini digunakan.	Tidak.
n	bilangan bulat	Berapa banyak pilihan penyelesaian obrolan yang akan dihasilkan untuk setiap pesan input. Perhatikan bahwa Anda akan dikenakan biaya berdasarkan jumlah token yang dihasilkan di semua pilihan. Pertahankan `n` sebagai `1` untuk meminimalkan biaya.	Tidak.	1
pemanggilan_alat_paralel	ParallelToolCalls	Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.	Tidak.	Benar
response_format	ResponseFormatText atau ResponseFormatJsonObject atau ResponseFormatJsonSchema	Objek yang menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4o, GPT-4o mini, GPT-4 Turbo, dan semua model GPT-3.5 Turbo yang lebih baru dari `gpt-3.5-turbo-1106`. Pengaturan untuk `{ "type": "json_schema", "json_schema": {...} }` mengaktifkan Output Terstruktur yang menjamin model akan cocok dengan skema JSON yang Anda berikan. Pengaturan untuk `{ "type": "json_object" }` mengaktifkan mode JSON, yang menjamin pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan deretan ruang kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berlangsung lama dan tampak "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika `finish_reason="length"`, yang menunjukkan pembuatan terlampaui `max_tokens` atau percakapan melebihi panjang konteks maksimum.	Tidak.
benih	bilangan bulat	Fitur ini ada di Beta. Jika ditentukan, sistem kami akan melakukan upaya terbaik untuk sampel secara deterministik, sehingga permintaan berulang dengan yang sama `seed` dan parameter harus mengembalikan hasil yang sama. Determinisme tidak dijamin, dan Anda harus merujuk ke `system_fingerprint` parameter respons untuk memantau perubahan di backend.	Tidak.
perangkat	array	Daftar alat yang mungkin dipanggil model. Saat ini, hanya fungsi yang ditunjang sebagai sarana. Gunakan ini untuk menyediakan daftar fungsi untuk model yang dapat menghasilkan input JSON. Maksimal 128 fungsi didukung.	Tidak.
pilihan alat	chatCompletionToolChoiceOption	Mengontrol alat mana (jika ada) yang dipanggil oleh model. `none` berarti model tidak akan memanggil alat apa pun dan sebaliknya menghasilkan pesan. `auto` berarti model dapat memilih antara menghasilkan pesan atau memanggil satu atau beberapa alat. `required` berarti model harus memanggil satu atau beberapa alat. Menentukan alat tertentu melalui `{"type": "function", "function": {"name": "my_function"}}` memaksa model untuk memanggil alat tersebut. `none` adalah default ketika tidak ada alat yang ada. `auto` adalah default jika alat ada.	Tidak.
pemanggilan_fungsi	teks atau chatCompletionFunctionCallOption	Diganti untuk `tool_choice`. Mengontrol mana fungsi (jika ada) yang dipanggil oleh model. `none` berarti model tidak akan memanggil fungsi dan sebaliknya menghasilkan pesan. `auto` berarti model dapat memilih antara menghasilkan pesan atau memanggil fungsi. Menentukan fungsi tertentu melalui `{"name": "my_function"}` memaksa model untuk memanggil fungsi tersebut. `none` adalah default ketika tidak ada fungsi yang ada. `auto` adalah default jika fungsi ada.	Tidak.
fungsi	array	Diganti untuk `tools`. Daftar fungsi yang digunakan model dapat menghasilkan input JSON.	Tidak.

Tanggapan

Kode Status: 200

Deskripsi: OK

Content-Type	Tipe	Deskripsi
application/json	createChatCompletionResponse atau createChatCompletionStreamResponse

Kode Status: default

Deskripsi: Layanan tidak tersedia

Content-Type	Tipe	Deskripsi
application/json	errorResponse

Contoh

Membuat penyelesaian untuk prompt, parameter, dan model yang dipilih yang disediakan.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

Respons: Kode Status: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Contoh

Membuat kompletasi berdasarkan data Azure Search dan identitas terkelola yang ditetapkan oleh sistem.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

Respons: Kode Status: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Contoh

Membuat penyelesaian berdasarkan data vektor Azure Search, pesan asisten sebelumnya, dan identitas terkelola yang ditetapkan pengguna.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Respons: Kode Status: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Contoh

Membuat penyelesaian untuk Azure Cosmos DB yang disediakan.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-21

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Respons: Kode Status: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Transkripsi - Buat

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

Mentranskripsikan audio ke dalam bahasa input.

Parameter URI

Nama	Di dalam	Diperlukan	Tipe	Deskripsi
titik akhir	jalan	Ya	string URL	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: `https://aoairesource.openai.azure.com`. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
ID penempatan	jalan	Ya	string	ID penerapan model ucapan ke teks. Untuk informasi tentang model yang didukung, lihat [/azure/ai-services/openai/concepts/models#audio-models].
versi-API	kueri	Ya	string	Versi API

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
kunci API	Benar	string	Sediakan kunci API Azure OpenAI di sini

Badan Permintaan

Tipe Konten: multipart/form-data

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
berkas	string	Objek file audio yang akan ditranskripsikan.	Ya
minta	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Perintah harus cocok dengan bahasa audio.	Tidak.
response_format	audioResponseFormat	Menentukan format output.	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel, antara 0 dan 1. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Jika diatur ke 0, model akan menggunakan probabilitas log untuk secara otomatis meningkatkan suhu hingga ambang batas tertentu terpukul.	Tidak.	0
bahasa	string	Bahasa audio input. Menyediakan bahasa input dalam format ISO-639-1 akan meningkatkan akurasi dan latensi.	Tidak.

Tanggapan

Kode Status: 200

Deskripsi: OK

Content-Type	Tipe	Deskripsi
application/json	audioResponse atau audioVerboseResponse
teks/polosan	string	Teks yang ditranskripsikan dalam format output (ketika response_format adalah salah satu teks, vtt atau srt).

Contoh

Mendapatkan teks yang ditranskripsikan dan metadata terkait dari data audio lisan yang disediakan.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

Respons: Kode Status: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Contoh

Mendapatkan teks yang ditranskripsikan dan metadata terkait dari data audio lisan yang disediakan.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-21

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Respons: Kode Status: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Terjemahan - Buat

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

Mentranskripsikan dan terjemahkan audio input ke dalam teks bahasa Inggris.

Parameter URI

Nama	Di dalam	Diperlukan	Tipe	Deskripsi
titik akhir	jalan	Ya	string URL	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: `https://aoairesource.openai.azure.com`. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
ID penempatan	jalan	Ya	string	ID penyebaran dari model bisikan yang telah disebarkan. Untuk informasi tentang model yang didukung, lihat [/azure/ai-services/openai/concepts/models#audio-models].
versi-API	kueri	Ya	string	Versi API

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
kunci API	Benar	string	Sediakan kunci API Azure OpenAI di sini

Badan Permintaan

Tipe Konten: multipart/form-data

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
berkas	string	File audio yang akan diterjemahkan.	Ya
minta	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Prompt harus dalam bahasa Inggris.	Tidak.
response_format	audioResponseFormat	Menentukan format output.	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel, antara 0 dan 1. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Jika diatur ke 0, model akan menggunakan probabilitas log untuk secara otomatis meningkatkan suhu hingga ambang batas tertentu terpukul.	Tidak.	0

Tanggapan

Kode Status: 200

Deskripsi: OK

Content-Type	Tipe	Deskripsi
application/json	audioResponse atau audioVerboseResponse
teks/polosan	string	Teks yang ditranskripsikan dalam format output (ketika response_format adalah salah satu teks, vtt atau srt).

Contoh

Mendapatkan teks yang ditranskripsikan bahasa Inggris dan metadata terkait dari data audio lisan yang disediakan.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Respons: Kode Status: 200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Contoh

Mendapatkan teks yang ditranskripsikan bahasa Inggris dan metadata terkait dari data audio lisan yang disediakan.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

Respons: Kode Status: 200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

Pembuatan gambar

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

Menghasilkan batch gambar dari keterangan teks pada penerapan model DALL-E tertentu.

Parameter URI

Nama	Di dalam	Diperlukan	Tipe	Deskripsi
titik akhir	jalan	Ya	string URL	Titik akhir Azure OpenAI yang didukung (protokol dan nama host, misalnya: `https://aoairesource.openai.azure.com`. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
ID penempatan	jalan	Ya	string	ID penyebaran dari model DALL-E yang telah disebarkan.
versi-API	kueri	Ya	string	Versi API

Header Permohonan

Nama	Diperlukan	Tipe	Deskripsi
kunci API	Benar	string	Sediakan kunci API Azure OpenAI di sini

Badan Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
minta	string	Deskripsi teks gambar yang diinginkan. Panjang maksimum adalah 4.000 karakter.	Ya
n	bilangan bulat	Jumlah gambar yang akan dihasilkan.	Tidak.	1
ukuran	imageSize	Ukuran gambar yang dihasilkan.	Tidak.	1024x1024
response_format	imagesResponseFormat	Format di mana gambar yang dihasilkan dikembalikan.	Tidak.	URL
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	Tidak.
kualitas	imageQuality	Kualitas gambar yang akan dihasilkan.	Tidak.	standar
gaya	imageStyle	Gaya gambar yang dihasilkan.	Tidak.	Jelas

Tanggapan

Kode Status: 200

Deskripsi: Ok

Content-Type	Tipe	Deskripsi
application/json	generateImagesResponse

Kode Status: default

Deskripsi: Terjadi kesalahan.

Content-Type	Tipe	Deskripsi
application/json	dalleErrorResponse

Contoh

Membuat gambar yang diberi perintah.

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

{
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

Respons: Kode Status: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

Komponen

responKesalahan

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
galat	kesalahan		Tidak.

errorBase

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
kode	string		Tidak.
pesan	string		Tidak.

galat

Nama	Tipe	Deskripsi	Diperlukan
Parameter	string		Tidak.
jenis	string		Tidak.
kesalahan internal	innerError	Kesalahan internal dengan detail tambahan.	Tidak.

innerError

Kesalahan internal dengan detail tambahan.

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
kode	innerErrorCode	Kode kesalahan untuk objek kesalahan internal.	Tidak.
hasil_penyaringan_konten	contentFilterPromptResults	Informasi tentang kategori pemfilteran konten (kebencian, seksual, kekerasan, self_harm), jika telah terdeteksi, serta tingkat keparahan (very_low, rendah, sedang, skala tinggi yang menentukan intensitas dan tingkat risiko konten berbahaya) dan jika telah difilter atau tidak. Informasi tentang konten jailbreak dan kata-kata kasar, jika telah terdeteksi, dan apakah telah difilter atau belum. Dan informasi tentang daftar blokir pelanggan, jika telah difilter dan id-nya.	Tidak.

Kode Kesalahan Dalam

Kode kesalahan untuk objek kesalahan internal.

Deskripsi: Kode kesalahan untuk objek kesalahan dalam.

Jenis: teks

Default:

Nama Enum: InnerErrorCode

Nilai Enum:

Nilai	Deskripsi
Pelanggaran Kebijakan AI yang Bertanggung Jawab	Perintah melanggar salah satu aturan filter konten lainnya.

dalleErrorResponse

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
galat	dalleError		Tidak.

dalleError

Nama	Tipe	Deskripsi	Diperlukan
Parameter	string		Tidak.
jenis	string		Tidak.
kesalahan internal	dalleInnerError	Kesalahan internal dengan detail tambahan.	Tidak.

dalleInnerError

Kesalahan internal dengan detail tambahan.

Nama	Tipe	Deskripsi	Diperlukan
kode	innerErrorCode	Kode kesalahan untuk objek kesalahan internal.	Tidak.
hasil_penyaringan_konten	dalleFilterResults	Informasi tentang kategori pemfilteran konten (kebencian, seksual, kekerasan, self_harm), jika telah terdeteksi, serta tingkat keparahan (very_low, rendah, sedang, skala tinggi yang menentukan intensitas dan tingkat risiko konten berbahaya) dan jika telah difilter atau tidak. Informasi tentang konten jailbreak dan kata-kata kasar, jika telah terdeteksi, dan apakah telah difilter atau belum. Dan informasi tentang daftar blokir pelanggan, jika telah difilter dan id-nya.	Tidak.
petunjuk_direvisi	string	Perintah yang digunakan untuk menghasilkan gambar, jika ada revisi pada perintah.	Tidak.

HasilFilterKontenDasar

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
Terfilter	Boolean		Ya

HasilTingkatKeparahanPenyaringanKonten

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
Terfilter	Boolean		Ya
Tingkat Keseriusan	string		Tidak.

Hasil Deteksi Penyaringan Konten

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
Terfilter	Boolean		Ya
terdeteksi	Boolean		Tidak.

Deteksi Filter Konten dengan Hasil Kutipan

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
kutipan	objek		Tidak.

Fitur untuk kutipan

URL

Nama	Tipe	Deskripsi	Bawaan
URL	string

lisensi

Nama	Tipe	Deskripsi	Bawaan
lisensi	string

dasarHasilPenyaringanKonten

Informasi tentang hasil pemfilteran konten.

Nama	Tipe	Diperlukan
seksual	hasil tingkat keparahan penyaring konten	Tidak.
kekerasan	hasil tingkat keparahan penyaring konten	Tidak.
benci	hasil tingkat keparahan penyaring konten	Tidak.
melukai diri sendiri	hasil tingkat keparahan penyaring konten	Tidak.
Kata-kata kasar	contentFilterDetectedResult	Tidak.
galat	errorBase	Tidak.

hasilPromptFilterKonten

Informasi tentang kategori pemfilteran konten (kebencian, seksual, kekerasan, self_harm), jika telah terdeteksi, serta tingkat keparahan (very_low, rendah, sedang, skala tinggi yang menentukan intensitas dan tingkat risiko konten berbahaya) dan jika telah difilter atau tidak. Informasi tentang konten jailbreak dan kata-kata kasar, jika telah terdeteksi, dan apakah telah difilter atau belum. Dan informasi tentang daftar blokir pelanggan, jika telah difilter dan id-nya.

Nama	Tipe	Diperlukan
seksual	hasil tingkat keparahan penyaring konten	Tidak.
kekerasan	hasil tingkat keparahan penyaring konten	Tidak.
benci	hasil tingkat keparahan penyaring konten	Tidak.
melukai diri sendiri	hasil tingkat keparahan penyaring konten	Tidak.
Kata-kata kasar	contentFilterDetectedResult	Tidak.
galat	errorBase	Tidak.
Jailbreak	contentFilterDetectedResult	Tidak.

hasil pilihan filter konten

Informasi tentang kategori pemfilteran konten (kebencian, seksual, kekerasan, self_harm), jika telah terdeteksi, serta tingkat keparahan (very_low, rendah, sedang, skala tinggi yang menentukan intensitas dan tingkat risiko konten berbahaya) dan jika telah difilter atau tidak. Informasi tentang teks pihak ketiga dan kata-kata kocak, jika telah terdeteksi, dan apakah telah difilter atau belum. Dan informasi tentang daftar blokir pelanggan, jika telah difilter dan id-nya.

Nama	Tipe	Diperlukan
seksual	hasil tingkat keparahan penyaring konten	Tidak.
kekerasan	hasil tingkat keparahan penyaring konten	Tidak.
benci	hasil tingkat keparahan penyaring konten	Tidak.
melukai diri sendiri	hasil tingkat keparahan penyaring konten	Tidak.
Kata-kata kasar	contentFilterDetectedResult	Tidak.
galat	errorBase	Tidak.
teks_bahan_terlindungi	contentFilterDetectedResult	Tidak.
kode_bahan_terlindungi	KontenTersaringTerdeteksiDenganHasilKutipan	Tidak.

hasilPemfilteranPrompt

Hasil pemfilteran konten untuk satu permintaan dalam permintaan.

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
indeks_prompt	bilangan bulat		Tidak.
hasil_penyaringan_konten	contentFilterPromptResults	Informasi tentang kategori pemfilteran konten (kebencian, seksual, kekerasan, self_harm), jika telah terdeteksi, serta tingkat keparahan (very_low, rendah, sedang, skala tinggi yang menentukan intensitas dan tingkat risiko konten berbahaya) dan jika telah difilter atau tidak. Informasi tentang konten jailbreak dan kata-kata kasar, jika telah terdeteksi, dan apakah telah difilter atau belum. Dan informasi tentang daftar blokir pelanggan, jika telah difilter dan id-nya.	Tidak.

promptFilterResults

Hasil pemfilteran konten untuk nol atau lebih permintaan dalam permintaan. Dalam permintaan streaming, hasil untuk permintaan yang berbeda dapat tiba pada waktu yang berbeda atau dalam urutan yang berbeda.

Tidak ada properti yang ditentukan untuk komponen ini.

hasil penyaringan konten dalle

Informasi tentang hasil pemfilteran konten.

Nama	Tipe	Diperlukan
seksual	hasil tingkat keparahan penyaring konten	Tidak.
kekerasan	hasil tingkat keparahan penyaring konten	Tidak.
benci	hasil tingkat keparahan penyaring konten	Tidak.
melukai diri sendiri	hasil tingkat keparahan penyaring konten	Tidak.

HasilPenyaringanDalle

Nama	Tipe	Diperlukan
seksual	hasil tingkat keparahan penyaring konten	Tidak.
kekerasan	hasil tingkat keparahan penyaring konten	Tidak.
benci	hasil tingkat keparahan penyaring konten	Tidak.
melukai diri sendiri	hasil tingkat keparahan penyaring konten	Tidak.
Kata-kata kasar	contentFilterDetectedResult	Tidak.
Jailbreak	contentFilterDetectedResult	Tidak.

PermintaanPenyelesaianObrolanUmum

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
suhu	nomor/angka	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Kami umumnya merekomendasikan untuk memodifikasi ini atau `top_p` tetapi tidak keduanya.	Tidak.	1
top_p	nomor/angka	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk memodifikasi ini atau `temperature` tetapi tidak keduanya.	Tidak.	1
aliran	Boolean	Jika diatur, delta pesan parsial akan dikirim, seperti di ChatGPT. Token akan dikirim sebagai peristiwa yang hanya berisi data dari server saat tersedia, dengan aliran diakhiri oleh pesan `data: [DONE]`.	Tidak.	Tidak benar
berhenti	string atau array	Hingga empat urutan di mana API akan berhenti menghasilkan token lebih lanjut.	Tidak.
maksimum token	bilangan bulat	Jumlah maksimum token yang diizinkan untuk jawaban yang dihasilkan. Secara default, jumlah token yang dapat dikembalikan oleh model adalah (4096 - token prompt). Nilai ini sekarang tidak digunakan lagi untuk mendukung `max_completion_tokens`, dan tidak kompatibel dengan model seri o1.	Tidak.	4096
max_completion_tokens (batas maksimal token penyelesaian)	bilangan bulat	Batas atas untuk jumlah token yang dapat dihasilkan untuk penyelesaian, termasuk token output yang terlihat dan token penalaran.	Tidak.
presence_penalty (penalti kehadiran)	nomor/angka	Angka antara -2,0 dan 2,0. Nilai positif memberikan penalti pada token baru berdasarkan kemunculannya dalam teks sejauh ini, meningkatkan kemungkinan model berbicara tentang topik baru.	Tidak.	0
penalti frekuensi	nomor/angka	Angka antara -2,0 dan 2,0. Nilai positif memberi penalti pada token baru berdasarkan frekuensi kemunculannya dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi secara persis kalimat yang sama.	Tidak.	0
logit_bias	objek	Ubah kemungkinan token tertentu muncul dalam penyelesaian. Menerima objek json yang memetakan token (ditentukan oleh ID token mereka di tokenizer) ke nilai bias terkait dari -100 hingga 100. Secara matematis, bias ditambahkan ke logit yang dihasilkan oleh model sebelum pengambilan sampel. Efek yang tepat akan bervariasi per model, tetapi nilai antara -1 dan 1 harus mengurangi atau meningkatkan kemungkinan pilihan; nilai seperti -100 atau 100 harus menghasilkan larangan atau pilihan eksklusif dari token yang relevan.	Tidak.
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu Azure OpenAI memantau dan mendeteksi penyalahgunaan.	Tidak.

buatPermintaanPenyelesaian

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
minta	string atau array	Perintah untuk menghasilkan penyelesaian, dikodekan sebagai string, array string, array token, atau array dari array token. Perhatikan bahwa <\|endoftext\|> adalah pemisah dokumen yang dilihat model selama pelatihan, jadi jika permintaan tidak ditentukan, model akan dihasilkan seolah-olah dari awal dokumen baru.	Ya
terbaik dari	bilangan bulat	Menghasilkan penyelesaian di sisi server dan mengembalikan yang "terbaik" (dengan probabilitas log tertinggi per token). Hasil tidak dapat dialirkan. Ketika digunakan dengan `n`, `best_of` mengontrol jumlah penyelesaian kandidat dan `n` menentukan berapa banyak yang harus dikembalikan – `best_of` harus lebih besar dari `n`. Catatan: Karena parameter ini menghasilkan banyak penyelesaian, parameter ini dapat dengan cepat menggunakan kuota token Anda. Gunakan dengan hati-hati dan pastikan Anda memiliki pengaturan yang wajar untuk `max_tokens` dan `stop`.	Tidak.	1
gema	Boolean	Gema ulang perintah beserta penyelesaiannya	Tidak.	Tidak benar
penalti frekuensi	nomor/angka	Angka antara -2,0 dan 2,0. Nilai positif memberi penalti pada token baru berdasarkan frekuensi kemunculannya dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi secara persis kalimat yang sama.	Tidak.	0
logit_bias	objek	Ubah kemungkinan token tertentu muncul dalam penyelesaian. Menerima objek JSON yang memetakan token (ditentukan oleh ID token mereka di tokenizer GPT) ke nilai bias terkait dari -100 hingga 100. Secara matematis, bias ditambahkan ke logit yang dihasilkan oleh model sebelum pengambilan sampel. Efek yang tepat akan bervariasi per model, tetapi nilai antara -1 dan 1 harus mengurangi atau meningkatkan kemungkinan pilihan; nilai seperti -100 atau 100 harus menghasilkan larangan atau pilihan eksklusif dari token yang relevan. Sebagai contoh, Anda dapat meneruskan `{"50256": -100}` untuk mencegah <token \|endoftext\|> dihasilkan.	Tidak.	Tidak ada
logprobs	bilangan bulat	Sertakan probabilitas log pada `logprobs` token output yang paling mungkin, serta token yang dipilih. Misalnya, jika `logprobs` adalah 5, API akan mengembalikan daftar lima token yang paling mungkin. API akan selalu mengembalikan `logprob` token sampel, sehingga mungkin ada hingga `logprobs+1` elemen dalam respons. Nilai maksimum untuk `logprobs` adalah 5.	Tidak.	Tidak ada
maksimum token	bilangan bulat	Jumlah maksimum token yang dapat dihasilkan dalam penyelesaian. Jumlah token prompt Anda ditambah `max_tokens` tidak dapat melebihi panjang konteks model.	Tidak.	16
n	bilangan bulat	Berapa banyak penyelesaian yang dihasilkan untuk setiap perintah. Catatan: Karena parameter ini menghasilkan banyak penyelesaian, parameter ini dapat dengan cepat menggunakan kuota token Anda. Gunakan dengan hati-hati dan pastikan Anda memiliki pengaturan yang wajar untuk `max_tokens` dan `stop`.	Tidak.	1
presence_penalty (penalti kehadiran)	nomor/angka	Angka antara -2,0 dan 2,0. Nilai positif memberikan penalti pada token baru berdasarkan kemunculannya dalam teks sejauh ini, meningkatkan kemungkinan model berbicara tentang topik baru.	Tidak.	0
benih	bilangan bulat	Jika ditentukan, sistem kami akan melakukan upaya terbaik untuk sampel secara deterministik, sehingga permintaan berulang dengan yang sama `seed` dan parameter harus mengembalikan hasil yang sama. Determinisme tidak dijamin, dan Anda harus merujuk ke `system_fingerprint` parameter respons untuk memantau perubahan di backend.	Tidak.
berhenti	string atau array	Hingga empat urutan di mana API akan berhenti menghasilkan token lebih lanjut. Teks yang dikembalikan tidak akan berisi urutan berhenti.	Tidak.
aliran	Boolean	Apakah ingin melakukan streaming kemajuan parsial. Jika diatur, token akan dikirimkan sebagai peristiwa yang hanya berupa data yang dikirimkan oleh server saat tersedia, dan streaming dihentikan oleh pesan.	Tidak.	Tidak benar
Akhiran	string	Akhiran yang muncul setelah penyelesaian penyisipan teks. Parameter ini hanya didukung untuk `gpt-3.5-turbo-instruct`.	Tidak.	Tidak ada
suhu	nomor/angka	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Kami umumnya merekomendasikan untuk memodifikasi ini atau `top_p` tetapi tidak keduanya.	Tidak.	1
top_p	nomor/angka	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk memodifikasi ini atau `temperature` tetapi tidak keduanya.	Tidak.	1
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	Tidak.

createCompletionResponse

Mewakili respons penyelesaian dari API. Catatan: objek respons yang dialirkan dan tidak dialirkan memiliki bentuk yang sama (tidak seperti titik akhir obrolan).

Nama	Tipe	Deskripsi	Diperlukan
Id	string	Pengidentifikasi unik untuk penyelesaian.	Ya
Pilihan	array	Daftar pilihan penyelesaian model yang dihasilkan untuk perintah input.	Ya
Dibuat	bilangan bulat	Tanda waktu Unix (dalam detik) saat penyelesaian dibuat.	Ya
model	string	Model yang digunakan untuk penyelesaian tugas.	Ya
memfilter hasil prompt	promptFilterResults	Hasil pemfilteran konten untuk nol atau lebih permintaan dalam permintaan. Dalam permintaan streaming, hasil untuk permintaan yang berbeda dapat tiba pada waktu yang berbeda atau dalam urutan yang berbeda.	Tidak.
sidik_jari_sistem	string	Sidik jari ini mewakili konfigurasi backend yang dijalankan model. Dapat digunakan bersama dengan `seed` parameter permintaan untuk memahami kapan perubahan backend telah dilakukan yang mungkin berdampak pada determinisme.	Tidak.
objek	enum	Jenis objek, yang selalu "penyelesaian_teks" Nilai yang mungkin: text_completion	Ya
penggunaan	completionUsage	Statistik penggunaan untuk permintaan penyelesaian tugas.	Tidak.

buatPermintaanPenyelesaianChat

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
suhu	nomor/angka	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Kami umumnya merekomendasikan untuk memodifikasi ini atau `top_p` tetapi tidak keduanya.	Tidak.	1
top_p	nomor/angka	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk memodifikasi ini atau `temperature` tetapi tidak keduanya.	Tidak.	1
aliran	Boolean	Jika diatur, delta pesan parsial akan dikirim, seperti di ChatGPT. Token akan dikirim sebagai peristiwa yang dikirim server hanya data saat tersedia, dengan aliran dihentikan oleh pesan `data: [DONE]`.	Tidak.	Tidak benar
berhenti	string atau array	Hingga empat urutan di mana API akan berhenti menghasilkan token lebih lanjut.	Tidak.
maksimum token	bilangan bulat	Jumlah maksimum token yang dapat dihasilkan dalam penyelesaian obrolan. Panjang total token input dan token yang dihasilkan dibatasi oleh panjang konteks model.	Tidak.
max_completion_tokens (batas maksimal token penyelesaian)	bilangan bulat	Batas atas untuk jumlah token yang dapat dihasilkan untuk penyelesaian, termasuk token output yang terlihat dan token penalaran.	Tidak.
presence_penalty (penalti kehadiran)	nomor/angka	Angka antara -2,0 dan 2,0. Nilai positif memberikan penalti pada token baru berdasarkan kemunculannya dalam teks sejauh ini, meningkatkan kemungkinan model berbicara tentang topik baru.	Tidak.	0
penalti frekuensi	nomor/angka	Angka antara -2,0 dan 2,0. Nilai positif memberi penalti pada token baru berdasarkan frekuensi kemunculannya dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi secara persis kalimat yang sama.	Tidak.	0
logit_bias	objek	Ubah kemungkinan token tertentu muncul dalam penyelesaian. Menerima objek JSON yang memetakan token (ditentukan oleh ID token mereka di tokenizer) ke nilai bias terkait dari -100 hingga 100. Secara matematis, bias ditambahkan ke logit yang dihasilkan oleh model sebelum pengambilan sampel. Efek yang tepat akan bervariasi per model, tetapi nilai antara -1 dan 1 harus mengurangi atau meningkatkan kemungkinan pilihan; nilai seperti -100 atau 100 harus menghasilkan larangan atau pilihan eksklusif dari token yang relevan.	Tidak.	Tidak ada
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	Tidak.
pesan	array	Daftar pesan yang terdiri dari percakapan sejauh ini.	Ya
sumber data	array	Entri konfigurasi untuk ekstensi obrolan Azure OpenAI yang menggunakannya. Spesifikasi tambahan ini hanya kompatibel dengan Azure OpenAI.	Tidak.
logprobs	Boolean	Apakah akan mengembalikan probabilitas log dari token output atau tidak. Jika benar, mengembalikan probabilitas logaritmik dari setiap token keluaran yang dikembalikan di `content` dari `message`.	Tidak.	Tidak benar
top_logprobs - nilai probabilitas log tertinggi	bilangan bulat	Bilangan bulat antara 0 dan 20 yang menentukan jumlah token yang kemungkinan besar akan dikembalikan pada setiap posisi token, masing-masing dengan probabilitas log terkait. `logprobs` harus diatur ke `true` jika parameter ini digunakan.	Tidak.
n	bilangan bulat	Berapa banyak pilihan penyelesaian obrolan yang akan dihasilkan untuk setiap pesan input. Perhatikan bahwa Anda akan dikenakan biaya berdasarkan jumlah token yang dihasilkan di semua pilihan. Pertahankan `n` sebagai `1` untuk meminimalkan biaya.	Tidak.	1
pemanggilan_alat_paralel	ParallelToolCalls	Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.	Tidak.	Benar
response_format	ResponseFormatText atau ResponseFormatJsonObject atau ResponseFormatJsonSchema	Objek yang menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4o, GPT-4o mini, GPT-4 Turbo, dan semua model GPT-3.5 Turbo yang lebih baru dari `gpt-3.5-turbo-1106`. Pengaturan untuk `{ "type": "json_schema", "json_schema": {...} }` mengaktifkan Output Terstruktur yang menjamin model akan cocok dengan skema JSON yang Anda berikan. Pengaturan untuk `{ "type": "json_object" }` mengaktifkan mode JSON, yang menjamin pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan deretan ruang kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berlangsung lama dan tampak "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika `finish_reason="length"`, yang menunjukkan pembuatan terlampaui `max_tokens` atau percakapan melebihi panjang konteks maksimum.	Tidak.
benih	bilangan bulat	Fitur ini ada di Beta. Jika ditentukan, sistem kami akan melakukan upaya terbaik untuk sampel secara deterministik, sehingga permintaan berulang dengan yang sama `seed` dan parameter harus mengembalikan hasil yang sama. Determinisme tidak dijamin, dan Anda harus merujuk ke `system_fingerprint` parameter respons untuk memantau perubahan di backend.	Tidak.
perangkat	array	Daftar alat yang mungkin dipanggil model. Saat ini, hanya fungsi yang ditunjang sebagai sarana. Gunakan ini untuk menyediakan daftar fungsi untuk model yang dapat menghasilkan input JSON. Maksimal 128 fungsi didukung.	Tidak.
pilihan alat	chatCompletionToolChoiceOption	Mengontrol alat mana (jika ada) yang dipanggil oleh model. `none` berarti model tidak akan memanggil alat apa pun dan sebaliknya menghasilkan pesan. `auto` berarti model dapat memilih antara menghasilkan pesan atau memanggil satu atau beberapa alat. `required` berarti model harus memanggil satu atau beberapa alat. Menentukan alat tertentu melalui `{"type": "function", "function": {"name": "my_function"}}` memaksa model untuk memanggil alat tersebut. `none` adalah default ketika tidak ada alat yang ada. `auto` adalah default jika alat ada.	Tidak.
pemanggilan_fungsi	teks atau chatCompletionFunctionCallOption	Diganti untuk `tool_choice`. Mengontrol mana fungsi (jika ada) yang dipanggil oleh model. `none` berarti model tidak akan memanggil fungsi dan sebaliknya menghasilkan pesan. `auto` berarti model dapat memilih antara menghasilkan pesan atau memanggil fungsi. Menentukan fungsi tertentu melalui `{"name": "my_function"}` memaksa model untuk memanggil fungsi tersebut. `none` adalah default ketika tidak ada fungsi yang ada. `auto` adalah default jika fungsi ada.	Tidak.
fungsi	array	Diganti untuk `tools`. Daftar fungsi yang digunakan model dapat menghasilkan input JSON.	Tidak.

chatCompletionFunctions

Nama	Tipe	Deskripsi	Diperlukan
deskripsi	string	Deskripsi tentang apa yang dilakukan fungsi, digunakan oleh model untuk memilih kapan dan bagaimana memanggil fungsi.	Tidak.
Nama	string	Nama fungsi yang akan dipanggil. Harus a-z, A-Z, 0-9, atau berisi garis bawah dan tanda hubung, dengan panjang maksimum 64.	Ya
parameter	FunctionParameters	Parameter yang diterima fungsi, dijelaskan sebagai objek Skema JSON. Lihat panduan untuk contoh, dan Referensi untuk Skema JSON untuk dokumentasi tentang format. Menghilangkan `parameters` mendefinisikan fungsi dengan daftar parameter kosong.	Tidak.

Opsi pemanggilan fungsi penyelesaian obrolan

Menentukan fungsi tertentu melalui {"name": "my_function"} memaksa model untuk memanggil fungsi tersebut.

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
Nama	string	Nama fungsi yang akan dipanggil.	Ya

Pesan Permintaan Penyelesaian Obrolan

Komponen ini bisa menjadi salah satu hal berikut:

chatCompletionRequestSystemMessage

Nama	Tipe	Deskripsi	Diperlukan
isi	string atau array	Isi pesan sistem.	Ya
peran	enum	Peran penulis pesan, dalam hal `system`ini . Nilai yang mungkin: sistem	Ya
Nama	string	Nama opsional untuk peserta. Menyediakan informasi model untuk membedakan antara peserta dengan peran yang sama.	Tidak.

pesanPenggunaPermintaanPenyelesaianObrolan

Nama	Tipe	Deskripsi	Diperlukan
isi	string atau array	Konten pesan pengguna.	Ya
peran	enum	Peran penulis pesan, dalam hal `user`ini . Nilai yang mungkin: pengguna	Ya
Nama	string	Nama opsional untuk peserta. Menyediakan informasi model untuk membedakan antara peserta dengan peran yang sama.	Tidak.

PermintaanPesanBantuanChat

Nama	Tipe	Deskripsi	Diperlukan
isi	string atau array	Isi pesan asisten. Diperlukan kecuali `tool_calls` atau `function_call` ditentukan.	Tidak.
penolakan	string	Pesan penolakan oleh asisten.	Tidak.
peran	enum	Peran penulis pesan, dalam hal `assistant`ini . Nilai yang mungkin: asisten	Ya
Nama	string	Nama opsional untuk peserta. Menyediakan informasi model untuk membedakan antara peserta dengan peran yang sama.	Tidak.
panggilan_alat	chatCompletionMessageToolCalls	Panggilan alat yang dihasilkan oleh model, seperti panggilan fungsi.	Tidak.
pemanggilan_fungsi	objek	Tidak digunakan lagi dan digantikan oleh `tool_calls`. Nama dan argumen fungsi yang harus dipanggil, seperti yang dihasilkan oleh model.	Tidak.

Properti untuk _function_call_

argumen

Nama	Tipe	Deskripsi	Bawaan
argumen	string	Argumen untuk memanggil fungsi dengan, seperti yang dihasilkan oleh model dalam format JSON. Perhatikan bahwa model tidak selalu menghasilkan JSON yang valid, dan dapat menghasilkan parameter yang tidak ditentukan oleh skema fungsi Anda. Validasi argumen dalam kode Anda sebelum memanggil fungsi Anda.

Nama

Nama	Tipe	Deskripsi	Bawaan
Nama	string	Nama fungsi yang akan dipanggil.

chatCompletionRequestToolMessage

Nama	Tipe	Deskripsi	Diperlukan
peran	enum	Peran penulis pesan, dalam hal `tool`ini . Nilai yang mungkin: alat	Ya
isi	string atau array	Isi pesan alat.	Ya
ID_Panggilan_Alat	string	Panggilan alat yang direspons pesan ini.	Ya

chatCompletionRequestFunctionMessage

Nama	Tipe	Deskripsi	Diperlukan
peran	enum	Peran penulis pesan, dalam hal `function`ini . Nilai yang mungkin: fungsi	Ya
isi	string	Isi pesan fungsi.	Ya
Nama	string	Nama fungsi yang akan dipanggil.	Ya

BagianKontenPesanSistemPermintaanPenyelesaianObrolan

Komponen ini bisa menjadi salah satu hal berikut:

BagianKontenPesanPenggunaPermintaanPenyelesaianObrolan

Komponen ini bisa menjadi salah satu hal berikut:

PermintaanKompletasiPesanBagianKontenAsistenChat

Komponen ini bisa menjadi salah satu hal berikut:

AlatPesanKontenPermintaanPenyelesaianChat

Komponen ini bisa menjadi salah satu hal berikut:

BagianKontenPesanPermintaanChatLengkap

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
jenis	enum	Jenis bagian konten. Nilai yang mungkin: teks	Ya
kirim pesan teks	string	Isi teks.	Ya

kontenPesanPermintaanPenyelesaianObrolanBagianGambar

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
jenis	enum	Jenis bagian konten. Nilai yang mungkin: image_url	Ya
URL gambar	objek		Ya

Properti untuk url_gambar

URL

Nama	Tipe	Deskripsi	Bawaan
URL	string	Baik URL gambar atau data gambar yang telah dikodekan dalam base64.

perincian

Nama	Tipe	Deskripsi	Bawaan
perincian	string	Menentukan tingkat detail gambar. Pelajari lebih lanjut di panduan Visi.	otomatis

PenolakanBagianIsiPesanPermintaanPenyelesaianObrolan

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
jenis	enum	Jenis bagian konten. Nilai yang mungkin: penolakan	Ya
penolakan	string	Pesan penolakan yang dihasilkan oleh model.	Ya

azureChatExtensionConfiguration

Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh permintaan penyelesaian obrolan yang harus menggunakan ekstensi obrolan Azure OpenAI untuk menambah perilaku respons. Penggunaan konfigurasi ini hanya kompatibel dengan Azure OpenAI.

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
jenis	azureChatExtensionType	Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh obrolan permintaan pelengkapan yang harus menggunakan ekstensi obrolan Azure OpenAI untuk menambah perilaku respons. Penggunaan konfigurasi ini hanya kompatibel dengan Azure OpenAI.	Ya

azureChatExtensionType

Deskripsi: Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh permintaan penyelesaian obrolan yang harus menggunakan ekstensi obrolan Azure OpenAI untuk menambah perilaku respons. Penggunaan konfigurasi ini hanya kompatibel dengan Azure OpenAI.

Jenis: teks

Default:

Nama Enum: AzureChatExtensionType

Nilai Enum:

Nilai	Deskripsi
pencarian Azure	Mewakili penggunaan Azure Search sebagai ekstensi obrolan Azure OpenAI.
azure_cosmos_db	Mewakili penggunaan Azure Cosmos DB sebagai ekstensi obrolan Azure OpenAI.

azureSearchChatExtensionConfiguration

Representasi tertentu dari opsi yang dapat dikonfigurasi untuk Azure Search saat menggunakannya sebagai ekstensi obrolan Azure OpenAI.

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
jenis	azureChatExtensionType	Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh obrolan permintaan pelengkapan yang harus menggunakan ekstensi obrolan Azure OpenAI untuk menambah perilaku respons. Penggunaan konfigurasi ini hanya kompatibel dengan Azure OpenAI.	Ya
parameter	azureSearchChatExtensionParameters	Parameter untuk Azure Search saat digunakan sebagai ekstensi obrolan Azure OpenAI.	Tidak.

azureSearchChatExtensionParameter

Parameter untuk Azure Search saat digunakan sebagai ekstensi obrolan Azure OpenAI.

Nama	Tipe	Deskripsi	Diperlukan
autentikasi	onYourDataApiKeyAuthenticationOptions atau onYourDataSystemAssignedManagedIdentityAuthenticationOptions atau onYourDataUserAssignedManagedIdentityAuthenticationOptions		Ya
top_n_documents	bilangan bulat	Jumlah dokumen terbanyak yang dipilih untuk ditampilkan untuk kueri yang dipilih.	Tidak.
dalam cakupan	Boolean	Apakah kueri harus dibatasi untuk menggunakan data terindeks.	Tidak.
keketatan	bilangan bulat	Ketatnya pemfilteran relevansi pencarian yang dikonfigurasi. Semakin tinggi ketegasan, semakin tinggi presisi tetapi pengenalan jawaban yang lebih rendah.	Tidak.
informasi_peran	string	Berikan instruksi model tentang bagaimana seharusnya perilakunya dan konteks apa pun yang harus dirujuknya saat menghasilkan respons. Anda dapat menjelaskan kepribadian asisten dan mengatur cara respons diformat. Ada batas 100 token baginya, dan termasuk dalam batas token keseluruhan.	Tidak.
titik akhir	string	Jalur titik akhir absolut untuk sumber daya Azure Search yang akan digunakan.	Ya
nama indeks	string	Nama indeks yang akan digunakan yang tersedia di sumber daya Azure Search yang dirujuk.	Ya
pemetaan_bidang	Opsi Pemetaan Bidang Indeks AzureSearch	Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Azure Search yang dikonfigurasi.	Tidak.
jenis_kueri	azureSearchQueryType	Jenis kueri pengambilan Azure Search yang harus dijalankan saat menggunakannya sebagai ekstensi obrolan Azure OpenAI.	Tidak.
konfigurasi semantik	string	Konfigurasi semantik tambahan untuk pertanyaan.	Tidak.
filter	string	Filter pencarian.	Tidak.
ketergantungan_penyematan	onYourDataEndpointVectorizationSource atau onYourDataDeploymentNameVectorizationSource		Tidak.

OpsiPemetaanBidangIndeksPencarianAzure

Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Azure Search yang dikonfigurasi.

Nama	Tipe	Deskripsi	Diperlukan
bidang_judul	string	Nama bidang indeks yang akan digunakan sebagai judul.	Tidak.
url_field	string	Nama bidang indeks yang akan digunakan sebagai URL.	Tidak.
filepath_field	string	Nama bidang indeks yang akan digunakan sebagai jalur file.	Tidak.
bidang_konten	array	Nama bidang indeks yang harus diperlakukan sebagai konten.	Tidak.
pemisah_bidang_konten	string	Pola pemisah yang harus digunakan oleh bidang konten.	Tidak.
vector_fields	array	Nama bidang yang mewakili data vektor.	Tidak.

azureSearchQueryType

Jenis kueri pengambilan Azure Search yang harus dijalankan saat menggunakannya sebagai ekstensi obrolan Azure OpenAI.

Deskripsi: Jenis kueri pengambilan Azure Search yang harus dijalankan saat menggunakannya sebagai ekstensi obrolan Azure OpenAI.

Jenis: teks

Default:

Nama Enum: AzureSearchQueryType

Nilai Enum:

Nilai	Deskripsi
sederhana	Mewakili pengurai kueri sederhana default.
semantik	Mewakili pengurai kueri semantik untuk pemodelan semantik tingkat lanjut.
vektor	Mewakili pencarian vektor atas data komputasi.
vektor_sederhana_hibrid	Mewakili kombinasi strategi kueri sederhana dengan data vektor.
vektor_semantik_hibrida	Mewakili kombinasi pencarian semantik dan kueri data vektor.

azureCosmosDBChatExtensionConfiguration

Representasi spesifik dari opsi yang dapat dikonfigurasi untuk Azure Cosmos DB saat menggunakannya sebagai ekstensi obrolan Azure OpenAI.

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
jenis	azureChatExtensionType	Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh obrolan permintaan pelengkapan yang harus menggunakan ekstensi obrolan Azure OpenAI untuk menambah perilaku respons. Penggunaan konfigurasi ini hanya kompatibel dengan Azure OpenAI.	Ya
parameter	azureCosmosDBChatExtensionParameters	Parameter yang digunakan saat mengonfigurasi ekstensi obrolan Azure OpenAI On Your Data saat menggunakan Azure Cosmos DB untuk MongoDB vCore.	Tidak.

azureCosmosDBChatExtensionParameters

Parameter yang digunakan saat mengonfigurasi ekstensi obrolan Azure OpenAI On Your Data saat menggunakan Azure Cosmos DB untuk MongoDB vCore.

Nama	Tipe	Deskripsi	Diperlukan
autentikasi	padaOpsiOtentikasiStringKoneksiDataAnda	Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan string koneksi.	Ya
top_n_documents	bilangan bulat	Jumlah dokumen terbanyak yang dipilih untuk ditampilkan untuk kueri yang dipilih.	Tidak.
dalam cakupan	Boolean	Apakah kueri harus dibatasi untuk menggunakan data terindeks.	Tidak.
keketatan	bilangan bulat	Ketatnya pemfilteran relevansi pencarian yang dikonfigurasi. Semakin tinggi ketegasan, semakin tinggi presisi tetapi pengenalan jawaban yang lebih rendah.	Tidak.
informasi_peran	string	Berikan instruksi model tentang bagaimana seharusnya perilakunya dan konteks apa pun yang harus dirujuknya saat menghasilkan respons. Anda dapat menjelaskan kepribadian asisten dan mengatur cara respons diformat. Ada batas 100 token baginya, dan termasuk dalam batas token keseluruhan.	Tidak.
nama_basis_data	string	Nama database MongoDB vCore untuk digunakan dengan Azure Cosmos DB.	Ya
nama_kontainer	string	Nama kontainer sumber daya Azure Cosmos DB.	Ya
nama indeks	string	Nama indeks MongoDB vCore untuk digunakan dengan Azure Cosmos DB.	Ya
pemetaan_bidang	azureCosmosDBFieldMappingOptions	Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Azure Cosmos DB yang dikonfigurasi.	Ya
ketergantungan_penyematan	onYourDataEndpointVectorizationSource atau onYourDataDeploymentNameVectorizationSource		Ya

Azure Cosmos DB Pilihan Pemetaan Bidang

Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Azure Cosmos DB yang dikonfigurasi.

Nama	Tipe	Deskripsi	Diperlukan
bidang_judul	string	Nama bidang indeks yang akan digunakan sebagai judul.	Tidak.
url_field	string	Nama bidang indeks yang akan digunakan sebagai URL.	Tidak.
filepath_field	string	Nama bidang indeks yang akan digunakan sebagai jalur file.	Tidak.
bidang_konten	array	Nama bidang indeks yang harus diperlakukan sebagai konten.	Ya
pemisah_bidang_konten	string	Pola pemisah yang harus digunakan oleh bidang konten.	Tidak.
vector_fields	array	Nama bidang yang mewakili data vektor.	Ya

Pilihan Otorisasi Data Anda

Opsi autentikasi untuk Azure OpenAI On Your Data.

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
jenis	padaTipeOtentikasiDataAnda	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Ya

onTipeAutentikasiDataAnda

Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.

Deskripsi: Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.

Jenis: teks

Default:

Nama Enum: OnYourDataAuthenticationType

Nilai Enum:

Nilai	Deskripsi
kunci_api	Autentikasi melalui kunci API.
String_koneksi	Autentikasi melalui string koneksi.
sistem_identitas_terkelola_ditetapkan	Autentikasi melalui identitas terkelola yang ditetapkan sistem.
identitas_terkelola_yang_ditugaskan_pada_pengguna	Autentikasi melalui identitas terkelola yang ditetapkan pengguna.

OpsiAutentikasiKunciApiOnYourData

Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan kunci API.

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
jenis	onYourDataAuthenticationType	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Ya
kunci	string	Kunci API yang digunakan untuk autentikasi.	Tidak.

padaPilihanOtentikasiStringKoneksiDataAnda

Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan string koneksi.

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
jenis	JenisOtentikasiDataAnda	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Ya
String_koneksi	string	string koneksi yang digunakan untuk autentikasi.	Tidak.

OpsiOtentikasiIdentitasTerkelolaYangDitugaskanSistemDataAnda

Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan identitas terkelola yang ditetapkan sistem.

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
jenis	onYourDataAuthenticationType	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Ya

onYourDataOpsiAutentikasiIdentitasTerkelolaPenggunaYangDiberikan

Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan identitas terkelola yang ditetapkan pengguna.

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
jenis	onYourDataAuthenticationType	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Ya
id_sumber_identitas_terkelola	string	ID sumber daya identitas terkelola yang ditetapkan pengguna untuk digunakan untuk autentikasi.	Tidak.

Source PemvektoranDataAnda

Representasi abstrak sumber vektorisasi untuk Azure OpenAI On Your Data dengan pencarian vektor.

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
jenis	padaTipeSumberVektorisasiDataAnda	Mewakili sumber yang tersedia yang dapat digunakan Azure OpenAI On Your Data untuk mengonfigurasi vektorisasi data untuk digunakan pencarian vektor.	Ya

padaTipeSumberVektorisasiDataAnda

Mewakili sumber yang tersedia yang dapat digunakan Azure OpenAI On Your Data untuk mengonfigurasi vektorisasi data untuk digunakan dengan pencarian vektor.

Deskripsi: Mewakili sumber yang tersedia yang dapat digunakan Azure OpenAI On Your Data untuk mengonfigurasi vektorisasi data untuk digunakan
pencarian vektor.

Jenis: teks

Default:

Nama Enum: OnYourDataVectorizationSourceType

Nilai Enum:

Nilai	Deskripsi
titik akhir	Mewakili vektorisasi yang dilakukan oleh panggilan layanan publik ke model penyematan Azure OpenAI.
nama_penerapan	Mewakili nama penyebaran model Ada untuk digunakan. Penyebaran model ini harus berada di sumber daya Azure OpenAI yang sama, tetapi Pada Data Anda, penyebaran model ini akan digunakan melalui panggilan internal alih-alih panggilan publik, yang memungkinkan penggunaan vektor. cari bahkan di jaringan privat.

onYourDataDeploymentNameVectorizationSource

Detail sumber vektorisasi, yang digunakan oleh Azure OpenAI On Your Data saat menerapkan pencarian vektor, yang didasarkan pada nama penyebaran model penyematan internal di sumber daya Azure OpenAI yang sama.

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
jenis	padaTipeSumberVektorisasiDataAnda	Mewakili sumber yang tersedia yang dapat digunakan Azure OpenAI On Your Data untuk mengonfigurasi vektorisasi data untuk digunakan pencarian vektor.	Ya
nama_penerapan	string	Menentukan nama penyebaran model yang akan digunakan untuk vektorisasi. Penyebaran model ini harus berada di sumber daya Azure OpenAI yang sama, tetapi On Your Data akan menggunakan penyebaran model ini melalui panggilan internal daripada yang publik, yang memungkinkan pencarian vektor bahkan di jaringan privat.	Tidak.

SumberVektorisasiTitikAkhirDataAnda

Rincian sumber vektorisasi yang digunakan oleh layanan Azure OpenAI On Your Data saat menerapkan pencarian vektor, yang didasarkan pada panggilan ke titik akhir Azure OpenAI publik untuk mendapatkan penyematan.

Nama	Tipe	Deskripsi	Diperlukan
jenis	padaTipeSumberVektorisasiDataAnda	Mewakili sumber yang tersedia yang dapat digunakan Azure OpenAI On Your Data untuk mengonfigurasi vektorisasi data untuk digunakan pencarian vektor.	Ya
autentikasi	OpsiOtentikasiKunciApiDataAnda	Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan kunci API.	Tidak.
titik akhir	string	Menentukan titik akhir yang akan digunakan untuk vektorisasi. Titik akhir ini harus berada di dalam sumber daya Azure OpenAI yang sama, tetapi fitur On Your Data akan menggunakan titik akhir ini melalui panggilan internal alih-alih publik, yang memungkinkan pencarian vektor bahkan di jaringan privat.	Tidak.

KonteksPesanEkstensiAzureChat

Representasi informasi konteks tambahan yang tersedia saat ekstensi obrolan Azure OpenAI terlibat dalam pembuatan respons penyelesaian obrolan yang sesuai. Informasi konteks ini hanya diisi saat menggunakan permintaan Azure OpenAI yang dikonfigurasi untuk menggunakan ekstensi yang cocok.

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
Kutipan	array	Hasil pengambilan sumber data, digunakan untuk menghasilkan pesan asisten dalam respons.	Tidak.
niat	string	Niat yang terdeteksi dari riwayat obrolan, digunakan untuk meneruskan ke giliran berikutnya untuk membawa konteks.	Tidak.

kutipan

informasi kutipan untuk pesan respons penyelesaian obrolan.

Nama	Tipe	Deskripsi	Diperlukan
isi	string	Isi kutipan.	Ya
judul	string	Judul kutipan.	Tidak.
URL	string	URL dari kutipan.	Tidak.
jalur file	string	Lokasi file kutipan.	Tidak.
chunk_id	string	ID bagian kutipan.	Tidak.

PanggilanAlatPesanSelesaiObrolan

Nama	Tipe	Deskripsi	Diperlukan
Id	string	ID panggilan alat.	Ya
jenis	toolCallType	Jenis panggilan alat, dalam hal ini `function`.	Ya
fungsi	objek	Fungsi yang dipanggil oleh model.	Ya

Properti untuk fungsi

Nama

Nama	Tipe	Deskripsi	Bawaan
Nama	string	Nama fungsi yang akan dipanggil.

argumen

Nama	Tipe	Deskripsi	Bawaan
argumen	string	Argumen untuk memanggil fungsi dengan, seperti yang dihasilkan oleh model dalam format JSON. Perhatikan bahwa model tidak selalu menghasilkan JSON yang valid, dan dapat menghasilkan parameter yang tidak ditentukan oleh skema fungsi Anda. Validasi argumen dalam kode Anda sebelum memanggil fungsi Anda.

JenisPanggilanAlat

Jenis panggilan alat, dalam hal ini function.

Deskripsi: Jenis panggilan alat, dalam hal ini function.

Jenis: teks

Default:

Nama Enum: ToolCallType

Nilai Enum:

Nilai	Deskripsi
fungsi	Jenis panggilan alat ini adalah tipe fungsi.

chatCompletionRequestMessageTool

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
ID_Panggilan_Alat	string	Panggilan alat yang direspons pesan ini.	Tidak.
isi	string	Isi pesan.	Tidak.

fungsi pesan permintaan penyelesaian obrolan

Nama	Tipe	Deskripsi	Diperlukan
peran	enum	Peran penulis pesan, dalam hal `function`ini . Nilai yang mungkin: fungsi	Tidak.
Nama	string	Isi pesan.	Tidak.
isi	string	Isi pesan.	Tidak.

createChatCompletionResponse

Mewakili respons penyelesaian percakapan yang diberikan oleh model, berdasarkan input yang disediakan.

Nama	Tipe	Deskripsi	Diperlukan
Id	string	Pengidentifikasi unik untuk penyelesaian percakapan.	Ya
memfilter hasil prompt	promptFilterResults	Hasil pemfilteran konten untuk nol atau lebih permintaan dalam permintaan. Dalam permintaan streaming, hasil untuk permintaan yang berbeda dapat tiba pada waktu yang berbeda atau dalam urutan yang berbeda.	Tidak.
Pilihan	array	Daftar pilihan penyelesaian obrolan. Bisa lebih dari satu jika `n` lebih besar dari 1.	Ya
Dibuat	bilangan bulat	Tanda waktu Unix (dalam detik) saat penyelesaian obrolan dibuat.	Ya
model	string	Model yang digunakan untuk menyelesaikan obrolan.	Ya
sidik_jari_sistem	string	Sidik jari ini mewakili konfigurasi backend yang dijalankan model. Dapat digunakan bersama dengan `seed` parameter permintaan untuk memahami kapan perubahan backend telah dilakukan yang mungkin berdampak pada determinisme.	Tidak.
objek	enum	Tipe objek, yang selalu `chat.completion`. Nilai yang mungkin: obrolan.penyelesaian	Ya
penggunaan	completionUsage	Statistik penggunaan untuk permintaan penyelesaian tugas.	Tidak.

createChatCompletionStreamResponse

Mewakili potongan data yang dialirkan dari respons penyelesaian obrolan yang diberikan oleh model, berdasarkan input yang disediakan.

Nama	Tipe	Deskripsi	Diperlukan
Id	string	Pengidentifikasi unik untuk penyelesaian percakapan. Setiap gugus memiliki ID yang sama.	Ya
Pilihan	array	Daftar pilihan penyelesaian obrolan. Dapat berisi lebih dari satu elemen jika `n` lebih besar dari 1.	Ya
Dibuat	bilangan bulat	Tanda waktu Unix (dalam detik) saat penyelesaian obrolan dibuat. Setiap gugus memiliki tanda waktu yang sama.	Ya
model	string	Model untuk menghasilkan penyelesaian.	Ya
sidik_jari_sistem	string	Sidik jari ini mewakili konfigurasi backend yang dijalankan model. Dapat digunakan bersama dengan `seed` parameter permintaan untuk memahami kapan perubahan backend telah dilakukan yang mungkin berdampak pada determinisme.	Tidak.
objek	enum	Tipe objek, yang selalu `chat.completion.chunk`. Nilai yang mungkin: chat.completion.chunk	Ya

chatCompletionStreamResponseDelta

Delta penyelesaian obrolan yang dihasilkan oleh respons model yang dialirkan.

Nama	Tipe	Deskripsi	Diperlukan
isi	string	Isi pesan potongan.	Tidak.
pemanggilan_fungsi	objek	Tidak digunakan lagi dan digantikan oleh `tool_calls`. Nama dan argumen fungsi yang harus dipanggil, seperti yang dihasilkan oleh model.	Tidak.
panggilan_alat	array		Tidak.
peran	enum	Peran penulis pesan ini. Nilai yang mungkin: sistem, pengguna, asisten, alat	Tidak.
penolakan	string	Pesan penolakan yang dihasilkan oleh model.	Tidak.

Properti untuk _function_call_

argumen

Nama	Tipe	Deskripsi	Bawaan
argumen	string	Argumen untuk memanggil fungsi dengan, seperti yang dihasilkan oleh model dalam format JSON. Perhatikan bahwa model tidak selalu menghasilkan JSON yang valid, dan dapat menghasilkan parameter yang tidak ditentukan oleh skema fungsi Anda. Validasi argumen dalam kode Anda sebelum memanggil fungsi Anda.

Nama

Nama	Tipe	Deskripsi	Bawaan
Nama	string	Nama fungsi yang akan dipanggil.

kolomAlatPanggilanPesanPenyelesaianChat

Nama	Tipe	Deskripsi	Diperlukan
indeks	bilangan bulat		Ya
Id	string	ID panggilan alat.	Tidak.
jenis	enum	Jenis alat. Saat ini, hanya `function` didukung. Nilai yang mungkin: fungsi	Tidak.
fungsi	objek		Tidak.

Properti untuk fungsi

Nama

Nama	Tipe	Deskripsi	Bawaan
Nama	string	Nama fungsi yang akan dipanggil.

argumen

Nama	Tipe	Deskripsi	Bawaan
argumen	string	Argumen untuk memanggil fungsi dengan, seperti yang dihasilkan oleh model dalam format JSON. Perhatikan bahwa model tidak selalu menghasilkan JSON yang valid, dan dapat menghasilkan parameter yang tidak ditentukan oleh skema fungsi Anda. Validasi argumen dalam kode Anda sebelum memanggil fungsi Anda.

chatCompletionStreamOptions

Opsi untuk respons streaming. Hanya atur ini saat Anda mengatur stream: true.

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
Termasuk Penggunaan	Boolean	Jika diatur, bagian tambahan akan dialirkan sebelum pesan `data: [DONE]`. Bidang `usage` pada gugus ini menunjukkan statistik penggunaan token untuk seluruh permintaan, dan `choices` bidang akan selalu menjadi array kosong. Semua bagian lainnya juga akan menyertakan `usage` bidang, tetapi dengan nilai null.	Tidak.

chatCompletionChoiceLogProbs

Catat informasi probabilitas untuk pilihan tersebut.

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
isi	array	Daftar token konten pesan dengan informasi probabilitas log.	Ya
penolakan	array	Daftar token penolakan pesan dengan informasi probabilitas log.	Tidak.

chatCompletionTokenLogprob

Nama	Tipe	Deskripsi	Diperlukan
token	string	Token tersebut.	Ya
logprob	nomor/angka	Probabilitas log dari token ini.	Ya
Byte	array	Daftar bilangan bulat yang mewakili representasi UTF-8 byte dari token. Berguna dalam kasus di mana karakter diwakili oleh beberapa token dan representasi bytenya harus digabungkan untuk menghasilkan representasi teks yang benar. Bisa jadi `null` jika tidak ada representasi byte untuk token.	Ya
top_logprobs	array	Daftar token yang paling mungkin dan probabilitas lognya, pada posisi token ini. Dalam kasus yang jarang terjadi, jumlah `top_logprobs` yang dikembalikan mungkin kurang dari yang diminta.	Ya

pesanTanggapanPenyelesaianChat

Pesan penyelesaian obrolan yang dihasilkan oleh model.

Nama	Tipe	Deskripsi	Diperlukan
peran	chatCompletionResponseMessageRole	Peran penulis pesan respons.	Ya
penolakan	string	Pesan penolakan yang dihasilkan oleh model.	Ya
isi	string	Isi pesan.	Ya
panggilan_alat	array	Panggilan alat yang dihasilkan oleh model, seperti panggilan fungsi.	Tidak.
pemanggilan_fungsi	chatCompletionFunctionCall	Tidak digunakan lagi dan digantikan oleh `tool_calls`. Nama dan argumen fungsi yang harus dipanggil, seperti yang dihasilkan oleh model.	Tidak.
konteks	azureChatExtensionsMessageContext	Representasi informasi konteks tambahan yang tersedia saat ekstensi obrolan Azure OpenAI terlibat dalam generasi respons penyelesaian obrolan yang sesuai. Informasi konteks ini hanya diisi ketika menggunakan permintaan Azure OpenAI yang dikonfigurasi untuk menggunakan ekstensi yang cocok.	Tidak.

PeranPesanResponMenyelesaikanObrolan

Peran penulis pesan respons.

Deskripsi: Peran penulis pesan respons.

Jenis: teks

Default:

Nilai Enum:

asisten

opsiPilihanAlatChatCompletion

Mengontrol alat mana (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil alat apa pun dan sebaliknya menghasilkan pesan. auto berarti model dapat memilih antara menghasilkan pesan atau memanggil satu atau beberapa alat. required berarti model harus memanggil satu atau beberapa alat. Menentukan alat tertentu melalui {"type": "function", "function": {"name": "my_function"}} memaksa model untuk memanggil alat tersebut. none adalah default ketika tidak ada alat yang ada. auto adalah default jika alat ada.

Komponen ini bisa menjadi salah satu hal berikut:

PilihanAlatBeriNamaPenyelesaianObrolan

Menentukan alat yang harus digunakan model. Gunakan untuk memaksa model memanggil fungsi tertentu.

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
jenis	enum	Jenis alat. Saat ini, hanya `function` didukung. Nilai yang mungkin: fungsi	Ya
fungsi	objek		Ya

Properti untuk fungsi

Nama

Nama	Tipe	Deskripsi	Bawaan
Nama	string	Nama fungsi yang akan dipanggil.

ParallelToolCalls

Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.

Tidak ada properti yang ditentukan untuk komponen ini.

panggilanAlatPesanPenyelesaianObrolan

Panggilan alat yang dihasilkan oleh model, seperti panggilan fungsi.

Tidak ada properti yang ditentukan untuk komponen ini.

chatCompletionFungsiPanggilan

Tidak digunakan lagi dan digantikan oleh tool_calls. Nama dan argumen fungsi yang harus dipanggil, seperti yang dihasilkan oleh model.

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
Nama	string	Nama fungsi yang akan dipanggil.	Ya
argumen	string	Argumen untuk memanggil fungsi dengan, seperti yang dihasilkan oleh model dalam format JSON. Perhatikan bahwa model tidak selalu menghasilkan JSON yang valid, dan dapat menghasilkan parameter yang tidak ditentukan oleh skema fungsi Anda. Validasi argumen dalam kode Anda sebelum memanggil fungsi Anda.	Ya

penggunaanPenyelesaian

Statistik penggunaan untuk permintaan penyelesaian tugas.

Nama	Tipe	Deskripsi	Diperlukan
prompt_tokens	bilangan bulat	Jumlah token dalam prompt.	Ya
token_penyelesaian	bilangan bulat	Jumlah token dalam penyelesaian yang dihasilkan.	Ya
jumlah_token	bilangan bulat	Jumlah total token yang digunakan dalam permintaan (prompt + penyelesaian).	Ya
rincian_token_penyelesaian	objek	Perincian token yang digunakan dalam penyelesaian.	Tidak.

Properti untuk rincian_token_penyelesaian

token_penalaran

Nama	Tipe	Deskripsi	Bawaan
token_penalaran	bilangan bulat	Token yang dihasilkan oleh model untuk penalaran.

chatCompletionTool

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
jenis	enum	Jenis alat. Saat ini, hanya `function` didukung. Nilai yang mungkin: fungsi	Ya
fungsi	FunctionObject		Ya

FunctionParameters

Parameter yang diterima fungsi, dijelaskan sebagai objek Skema JSON. Lihat panduan untuk contoh, dan Referensi untuk Skema JSON untuk dokumentasi tentang format.

Menghilangkan parameters mendefinisikan fungsi dengan daftar parameter kosong.

Tidak ada properti yang ditentukan untuk komponen ini.

FunctionObject

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
deskripsi	string	Deskripsi tentang apa yang dilakukan fungsi, digunakan oleh model untuk memilih kapan dan bagaimana memanggil fungsi.	Tidak.
Nama	string	Nama fungsi yang akan dipanggil. Harus a-z, A-Z, 0-9, atau berisi garis bawah dan tanda hubung, dengan panjang maksimum 64.	Ya
parameter	FunctionParameters	Parameter yang diterima fungsi, dijelaskan sebagai objek Skema JSON. Lihat panduan untuk contoh, dan Referensi untuk Skema JSON untuk dokumentasi tentang format. Menghilangkan `parameters` mendefinisikan fungsi dengan daftar parameter kosong.	Tidak.
tegas	Boolean	Apakah akan mengaktifkan kepatuhan skema yang ketat saat menghasilkan panggilan fungsi. Jika diatur ke true, model akan mengikuti skema yang tepat yang ditentukan di `parameters` bidang . Hanya subset Skema JSON yang didukung saat `strict` adalah `true`.	Tidak.	Tidak benar

ResponseFormatText

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
jenis	enum	Jenis format respons yang ditentukan: `text` Nilai yang mungkin: teks	Ya

FormatTanggapanJsonObject

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
jenis	enum	Jenis format respons yang ditentukan: `json_object` Nilai yang mungkin: json_object	Ya

ResponseFormatJsonSchemaSkema

Skema untuk format respons, dijelaskan sebagai objek Skema JSON.

Tidak ada properti yang ditentukan untuk komponen ini.

ResponseFormatJsonSchema

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
jenis	enum	Jenis format respons yang ditentukan: `json_schema` Nilai yang mungkin: json_schema	Ya
json_schema	objek		Ya

Sifat-sifat untuk json_schema

deskripsi

Nama	Tipe	Deskripsi	Bawaan
deskripsi	string	Sebuah deskripsi tentang tujuan format respons, yang digunakan oleh model untuk menentukan cara merespons dalam format tersebut.

Nama

Nama	Tipe	Deskripsi	Bawaan
Nama	string	Nama format tanggapan. Harus a-z, A-Z, 0-9, atau berisi garis bawah dan tanda hubung, dengan panjang maksimum 64.

skema

Nama	Tipe	Deskripsi	Bawaan
skema	ResponseFormatJsonSchema	Skema untuk format respons, dijelaskan sebagai objek Skema JSON.

tegas

Nama	Tipe	Deskripsi	Bawaan
tegas	Boolean	Apakah akan mengaktifkan kepatuhan skema yang ketat saat menghasilkan output. Jika diatur ke true, model akan selalu mengikuti skema yang tepat yang ditentukan di `schema` bidang . Hanya subset Skema JSON yang didukung saat `strict` adalah `true`.	Tidak benar

pilihanPenyelesaianChatUmum

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
indeks	bilangan bulat		Tidak.
alasan_selesai	string		Tidak.

buatPermintaanTerjemahan

Permintaan terjemahan.

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
berkas	string	File audio yang akan diterjemahkan.	Ya
minta	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Prompt harus dalam bahasa Inggris.	Tidak.
response_format	audioResponseFormat	Menentukan format output.	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel, antara 0 dan 1. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Jika diatur ke 0, model akan menggunakan probabilitas log untuk secara otomatis meningkatkan suhu hingga ambang batas tertentu terpukul.	Tidak.	0

audioResponse

Respons terjemahan atau transkripsi saat response_format adalah json

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
kirim pesan teks	string	Teks yang diterjemahkan atau ditranskripsikan.	Ya

audioVerboseResponse

Respons terjemahan atau transkripsi ketika format_ respons adalah verbose_json

Nama	Tipe	Deskripsi	Diperlukan
kirim pesan teks	string	Teks yang diterjemahkan atau ditranskripsikan.	Ya
tugas	string	Jenis tugas audio.	Tidak.
bahasa	string	Bahasa.	Tidak.
durasi	nomor/angka	Durasi.	Tidak.
segmen	array		Tidak.

audioResponseFormat

Menentukan format output.

Deskripsi: Menentukan format output.

Jenis: teks

Default:

Nilai Enum:

JSON
kirim pesan teks
SRT
verbose_json
vtt

buatPermintaanTranskripsi

Permintaan transkripsi.

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
berkas	string	Objek file audio yang akan ditranskripsikan.	Ya
minta	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Perintah harus cocok dengan bahasa audio.	Tidak.
response_format	audioResponseFormat	Menentukan format output.	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel, antara 0 dan 1. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Jika diatur ke 0, model akan menggunakan probabilitas log untuk secara otomatis meningkatkan suhu hingga ambang batas tertentu terpukul.	Tidak.	0
bahasa	string	Bahasa audio input. Menyediakan bahasa input dalam format ISO-639-1 akan meningkatkan akurasi dan latensi.	Tidak.

audioSegment

Segmen transkripsi atau terjemahan.

Nama	Tipe	Deskripsi	Diperlukan
Id	bilangan bulat	Pengidentifikasi segmen.	Tidak.
mencari	nomor/angka	Offset segmen.	Tidak.
mulai	nomor/angka	Offset segmen mulai.	Tidak.
akhir	nomor/angka	Offset akhir segmen.	Tidak.
kirim pesan teks	string	Teks segmentasi.	Tidak.
Token	array	Token teks tersebut.	Tidak.
suhu	nomor/angka	Suhu.	Tidak.
avg_logprob	nomor/angka	Probabilitas log rata-rata.	Tidak.
rasio kompresi	nomor/angka	Rasio kompresi.	Tidak.
probabilitas_tidak_ada_suara	nomor/angka	Probabilitas `no speech`.	Tidak.

kualitas gambar

Kualitas gambar yang akan dihasilkan.

Deskripsi: Kualitas gambar yang akan dihasilkan.

Jenis: teks

Default: standar

Nama Enum: Kualitas

Nilai Enum:

Nilai	Deskripsi
standar	Kualitas standar menciptakan gambar dengan kualitas standar.
HD	Kualitas HD menciptakan gambar dengan detail yang lebih halus dan konsistensi yang lebih besar di seluruh gambar.

imagesResponseFormat

Format di mana gambar yang dihasilkan dikembalikan.

Deskripsi: Format di mana gambar yang dihasilkan dikembalikan.

Jenis: teks

Default: url

Nama Enum: ImagesResponseFormat

Nilai Enum:

Nilai	Deskripsi
URL	URL yang menyediakan akses sementara untuk mengunduh gambar yang dihasilkan.
b64_json	Gambar yang dihasilkan dikembalikan sebagai string yang dikodekan base64.

ukuran gambar

Ukuran gambar yang dihasilkan.

Deskripsi: Ukuran gambar yang dihasilkan.

Jenis: teks

Default: 1024x1024

Nama Enum: Ukuran

Nilai Enum:

Nilai	Deskripsi
1792x1024	Ukuran gambar yang dihasilkan yang diinginkan adalah 1792x1024 piksel.
1024x1792	Ukuran gambar yang dihasilkan yang diinginkan adalah 1024x1792 piksel.
1024x1024	Ukuran gambar yang dihasilkan yang diinginkan adalah 1024x1024 piksel.

imageStyle

Gaya gambar yang dihasilkan.

Deskripsi: Gaya gambar yang dihasilkan.

Jenis: teks

Default: vivid

Nama Enum: Gaya

Nilai Enum:

Nilai	Deskripsi
Jelas	Vivid menciptakan gambar yang hiper-realistis dan dramatis.
alami	Gaya alami menciptakan gambar yang lebih bersifat alami dan lebih sedikit hiper-realistis.

permintaanPembuatanGambar

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
minta	string	Deskripsi teks gambar yang diinginkan. Panjang maksimum adalah 4.000 karakter.	Ya
n	bilangan bulat	Jumlah gambar yang akan dihasilkan.	Tidak.	1
ukuran	imageSize	Ukuran gambar yang dihasilkan.	Tidak.	1024x1024
response_format	imagesResponseFormat	Format di mana gambar yang dihasilkan dikembalikan.	Tidak.	URL
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	Tidak.
kualitas	imageQuality	Kualitas gambar yang akan dihasilkan.	Tidak.	standar
gaya	imageStyle	Gaya gambar yang dihasilkan.	Tidak.	Jelas

generateImagesResponse

Nama	Tipe	Deskripsi	Diperlukan	Bawaan
Dibuat	bilangan bulat	Tanda waktu unix saat operasi dibuat.	Ya
data	array	Data hasil operasi, jika berhasil	Ya

hasilGambar

Url gambar atau gambar yang dikodekan jika berhasil, atau pesan kesalahan jika tidak berhasil.

Nama	Tipe	Deskripsi	Diperlukan
URL	string	URL dari gambar	Tidak.
b64_json	string	Gambar berformat base64	Tidak.
hasil_penyaringan_konten	dalleContentFilterResults	Informasi tentang hasil pemfilteran konten.	Tidak.
petunjuk_direvisi	string	Perintah yang digunakan untuk menghasilkan gambar, jika ada revisi pada perintah.	Tidak.
memfilter hasil prompt	dalleFilterResults	Informasi tentang kategori pemfilteran konten (kebencian, seksual, kekerasan, self_harm), jika telah terdeteksi, serta tingkat keparahan (very_low, rendah, sedang, skala tinggi yang menentukan intensitas dan tingkat risiko konten berbahaya) dan jika telah difilter atau tidak. Informasi tentang konten jailbreak dan kata-kata kasar, jika telah terdeteksi, dan apakah telah difilter atau belum. Dan informasi tentang daftar blokir pelanggan, jika telah difilter dan id-nya.	Tidak.

Ekstensi penyelesaian otomatis

Ekstensi penyelesaian bukan bagian dari versi GA terbaru dari spesifikasi inferensi sarana data Azure OpenAI.

Pesan Obrolan

Objek pesan Obrolan bukan bagian dari versi GA terbaru dari spesifikasi inferensi sarana data Azure OpenAI.

Teks menjadi ucapan (Pratinjau)

Saat ini bukan bagian dari versi ketersediaan umum (GA) Azure OpenAI terbaru dari spesifikasi inferensi bidang data Azure OpenAI. Silakan merujuk pada versi pratinjau terbaru untuk kemampuan ini.

Langkah selanjutnya

Pelajari tentang Model, dan penyempurnaan dengan REST API. Pelajari selengkapnya tentang model yang mendasari yang mendukung Azure OpenAI.

Bagikan melalui

Azure OpenAI dalam referensi dari REST API Model Azure AI Foundry

Spesifikasi API

Otentikasi

Pemversionan REST API

Inferensi bidang data

Penyelesaian

Parameter URI

Header Permohonan

Badan Permintaan

Tanggapan

Contoh

Contoh

Pemadatan

Parameter URI

Header Permohonan

Badan Permintaan

Tanggapan

Sifat untuk penggunaan

prompt_tokens

jumlah_token

Contoh

Contoh

Penyelesaian percakapan

Parameter URI

Header Permohonan

Badan Permintaan

Tanggapan

Contoh

Contoh

Contoh

Contoh

Contoh

Transkripsi - Buat

Parameter URI

Header Permohonan

Badan Permintaan

Tanggapan

Contoh

Contoh

Contoh

Terjemahan - Buat

Parameter URI

Header Permohonan

Badan Permintaan

Tanggapan

Contoh

Contoh

Contoh

Pembuatan gambar

Parameter URI

Header Permohonan

Badan Permintaan

Tanggapan

Contoh

Contoh

Komponen

responKesalahan

errorBase

galat

innerError

Kode Kesalahan Dalam

dalleErrorResponse

dalleError

dalleInnerError

HasilFilterKontenDasar

HasilTingkatKeparahanPenyaringanKonten

Hasil Deteksi Penyaringan Konten

Deteksi Filter Konten dengan Hasil Kutipan

Fitur untuk kutipan

URL

lisensi

dasarHasilPenyaringanKonten

hasilPromptFilterKonten

hasil pilihan filter konten

hasilPemfilteranPrompt

promptFilterResults

hasil penyaringan konten dalle

HasilPenyaringanDalle

PermintaanPenyelesaianObrolanUmum