Referensi REST API Azure OpenAI Service

Artikel
01/29/2025

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:

Sarana kontrol
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.

API	Rilis pratinjau terbaru	Rilis GA terbaru	Spesifikasi	Deskripsi
Sarana kontrol	`2024-06-01-preview`	`2024-10-01`	File spesifikasi	Azure OpenAI berbagi sarana kontrol umum dengan semua Layanan Azure AI 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.
Bidang data - penulisan	`2025-02-01-preview`	`2024-10-21`	File spesifikasi	API penulisan sarana data mengontrol penyempurnaan, pengunggahan file, pekerjaan penyerapan, batch, dan kueri tingkat model tertentu
Bidang data - inferensi	`2025-02-01-preview`	`2024-10-21`	File spesifikasi	API inferensi bidang data menyediakan kemampuan/titik akhir inferensi untuk fitur seperti penyelesaian, penyelesaian obrolan, penyematan, ucapan/bisikan, pada data Anda, Dall-e, asisten, dll.

Autentikasi

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.

Penerapan versi REST API

API layanan diterapkan versinya 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 sarana 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	Dalam	Wajib	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
deployment-id	jalan	Ya	string	ID penyebaran model yang disebarkan.
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi	Default
perintah	string atau array	Perintah untuk menghasilkan penyelesaian untuk, dikodekan sebagai string, array string, array token, atau array 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
best_of	Integer	`best_of` Menghasilkan sisi server penyelesaian dan mengembalikan "terbaik" (yang 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 untuk mengembalikan â€" `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`.	No	1
echo	Boolean	Gema mengembalikan perintah selain penyelesaian	No	Salah
frequency_penalty	number	Angka antara -2,0 dan 2,0. Nilai positif mengkhususkan token baru berdasarkan frekuensi yang ada dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi verbatim baris yang sama.	No	0
logit_bias	object	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.	No	Tidak
logprobs	Integer	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.	No	Tidak
max_tokens	Integer	Jumlah maksimum token yang dapat dihasilkan dalam penyelesaian. Jumlah token prompt Anda ditambah `max_tokens` tidak dapat melebihi panjang konteks model.	No	16
n	Integer	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`.	No	1
presence_penalty	number	Angka antara -2,0 dan 2,0. Nilai positif mengkhususkan token baru berdasarkan apakah token tersebut muncul dalam teks sejauh ini, meningkatkan kemungkinan model untuk berbicara tentang topik baru.	No	0
seed	Integer	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.	No
stop	string atau array	Hingga empat urutan di mana API akan berhenti menghasilkan token lebih lanjut. Teks yang dikembalikan tidak akan berisi urutan berhenti.	No
stream	Boolean	Apakah akan kembali melakukan streaming pada kemajuan parsial. Jika diatur, token akan dikirim sebagai peristiwa yang dikirim server khusus data saat tersedia, dengan streaming dihentikan oleh pesan`data: [DONE]`.	No	Salah
Akhiran	string	Akhiran yang muncul setelah penyelesaian teks yang disisipkan. Parameter ini hanya didukung untuk `gpt-3.5-turbo-instruct`.	No	Tidak
suhu	number	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 mengubah ini atau `top_p` tetapi tidak keduanya.	No	1
top_p	number	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa peluang top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau `temperature` tetapi tidak keduanya.	No	1
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	No

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
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

Tipe-Konten	Jenis	Keterangan
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
    }
  }
}

Penyematan

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	Dalam	Wajib	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
deployment-id	jalan	Ya	string
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi
input	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 array 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.	No
input_type	string	jenis input pencarian penyematan yang akan digunakan	No
encoding_format	string	Format untuk mengembalikan penyematan. Dapat berupa `float` atau `base64`. Default ke `float`.	No
ukuran	Integer	Jumlah dimensi yang harus dimiliki penyematan output yang dihasilkan. Hanya didukung dalam `text-embedding-3` model dan yang lebih baru.	No

Respons

Nama	Tipe	Wajib diisi
object	string	Ya
model	string	Ya
data	array	Ya
penggunaan	object	Ya

Properti untuk penggunaan

prompt_tokens

Nama	Tipe	Deskripsi	Default
prompt_tokens	Integer

total_tokens

Nama	Tipe	Deskripsi	Default
total_tokens	Integer

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	object

Contoh

Mengembalikan penyematan untuk perintah 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 obrolan

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

Membuat penyelesaian untuk pesan obrolan

Parameter URI

Nama	Dalam	Wajib	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
deployment-id	jalan	Ya	string	ID penyebaran model yang disebarkan.
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi	Default
suhu	number	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 mengubah ini atau `top_p` tetapi tidak keduanya.	No	1
top_p	number	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa peluang top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau `temperature` tetapi tidak keduanya.	No	1
stream	Boolean	Jika diatur, delta pesan parsial akan dikirim, seperti di ChatGPT. Token akan dikirim sebagai peristiwa yang dikirim server khusus data saat tersedia, dengan aliran dihentikan oleh pesan`data: [DONE]`.	No	Salah
stop	string atau array	Hingga empat urutan di mana API akan berhenti menghasilkan token lebih lanjut.	No
max_tokens	Integer	Jumlah maksimum token yang dapat dihasilkan dalam penyelesaian obrolan. Panjang total token input dan token yang dihasilkan dibatasi oleh panjang konteks model.	No
max_completion_tokens	Integer	Batas atas untuk jumlah token yang dapat dihasilkan untuk penyelesaian, termasuk token output yang terlihat dan token penalaran.	No
presence_penalty	number	Angka antara -2,0 dan 2,0. Nilai positif mengkhususkan token baru berdasarkan apakah token tersebut muncul dalam teks sejauh ini, meningkatkan kemungkinan model untuk berbicara tentang topik baru.	No	0
frequency_penalty	number	Angka antara -2,0 dan 2,0. Nilai positif mengkhususkan token baru berdasarkan frekuensi yang ada dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi verbatim baris yang sama.	No	0
logit_bias	object	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.	No	Tidak
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	No
pesan	array	Daftar pesan yang terdiri dari percakapan sejauh ini.	Ya
data_sources	array	Entri konfigurasi untuk ekstensi obrolan Azure OpenAI yang menggunakannya. Spesifikasi tambahan ini hanya kompatibel dengan Azure OpenAI.	No
logprobs	Boolean	Apakah akan mengembalikan probabilitas log dari token output atau tidak. Jika true, mengembalikan probabilitas log dari setiap token output yang `content` dikembalikan di dari `message`.	No	Salah
top_logprobs	Integer	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.	No
n	Integer	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. `1` Pertahankan `n` untuk meminimalkan biaya.	No	1
parallel_tool_calls	ParallelToolCalls	Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.	No	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 aliran spasi kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berjalan lama dan tampaknya "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.	No
seed	Integer	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.	No
alat	array	Daftar alat yang mungkin dipanggil model. Saat ini, hanya fungsi yang didukung sebagai alat. Gunakan ini untuk menyediakan daftar fungsi yang dapat dihasilkan model input JSON. Maksimal 128 fungsi didukung.	No
tool_choice	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.	No
function_call	string atau chatCompletionFunctionCallOption	Tidak digunakan lagi demi `tool_choice`. Mengontrol fungsi (jika ada) mana 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.	No
fungsi	array	Tidak digunakan lagi demi `tools`. Daftar fungsi yang digunakan model dapat menghasilkan input JSON.	No

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	createChatCompletionResponse atau createChatCompletionStreamResponse

Kode Status: default

Deskripsi: Layanan tidak tersedia

Tipe-Konten	Jenis	Keterangan
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 penyelesaian berdasarkan data Azure Search dan identitas terkelola yang ditetapkan 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	Dalam	Wajib	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
deployment-id	jalan	Ya	string	ID penyebaran model bisikan.
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Tipe Konten: multipart/form-data

Nama	Tipe	Deskripsi	Wajib diisi	Default
file	string	Objek file audio yang akan ditranskripsikan.	Ya
perintah	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Perintah harus cocok dengan bahasa audio.	No
response_format	audioResponseFormat	Menentukan format output.	No
suhu	number	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.	No	0
bahasa	string	Bahasa audio input. Menyediakan bahasa input dalam format ISO-639-1 akan meningkatkan akurasi dan latensi.	No

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	audioResponse atau audioVerboseResponse
text/plain	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	Dalam	Wajib	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
deployment-id	jalan	Ya	string	ID penyebaran model bisikan yang disebarkan.
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Tipe Konten: multipart/form-data

Nama	Tipe	Deskripsi	Wajib diisi	Default
file	string	File audio yang akan diterjemahkan.	Ya
perintah	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Prompt harus dalam bahasa Inggris.	No
response_format	audioResponseFormat	Menentukan format output.	No
suhu	number	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.	No	0

Respons

Kode Status: 200

Deskripsi: OK

Tipe-Konten	Jenis	Keterangan
application/json	audioResponse atau audioVerboseResponse
text/plain	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 penyebaran model dall-e tertentu

Parameter URI

Nama	Dalam	Wajib	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
deployment-id	jalan	Ya	string	ID penyebaran model dall-e yang disebarkan.
versi-api	pertanyaan	Ya	string	versi API

Header Permintaan

Nama	Wajib	Tipe	Deskripsi
api-key	Benar	string	Sediakan kunci API Azure OpenAI di sini

Isi Permintaan

Jenis-Konten: application/json

Nama	Tipe	Deskripsi	Wajib diisi	Default
perintah	string	Deskripsi teks gambar yang diinginkan. Panjang maksimum adalah 4.000 karakter.	Ya
n	Integer	Jumlah gambar yang akan dihasilkan.	No	1
size	imageSize	Ukuran gambar yang dihasilkan.	No	1024 x 1024
response_format	imagesResponseFormat	Format di mana gambar yang dihasilkan dikembalikan.	No	url
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	No
kualitas	imageQuality	Kualitas gambar yang akan dihasilkan.	No	standar
gaya	imageStyle	Gaya gambar yang dihasilkan.	No	Jelas

Respons

Kode Status: 200

Deskripsi: Ok

Tipe-Konten	Jenis	Keterangan
application/json	generateImagesResponse

Kode Status: default

Deskripsi: Terjadi kesalahan.

Tipe-Konten	Jenis	Keterangan
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

errorResponse

Nama	Tipe	Deskripsi	Wajib diisi	Default
kesalahan	kesalahan		No

errorBase

Nama	Tipe	Deskripsi	Wajib diisi	Default
kode	string		No
pesan	string		No

kesalahan

Nama	Tipe	Deskripsi	Wajib diisi
param	string		No
jenis	string		No
inner_error	innerError	Kesalahan dalam dengan detail tambahan.	No

innerError

Kesalahan dalam dengan detail tambahan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
kode	innerErrorCode	Kode kesalahan untuk objek kesalahan dalam.	No
content_filter_results	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 kodrat, jika telah terdeteksi, dan apakah telah difilter atau belum. Dan informasi tentang daftar blokir pelanggan, jika telah difilter dan id-nya.	No

innerErrorCode

Kode kesalahan untuk objek kesalahan dalam.

Deskripsi: Kode kesalahan untuk objek kesalahan dalam.

Jenis: string

Default:

Nama Enum: InnerErrorCode

Nilai Enum:

Nilai	Deskripsi
ResponsibleAIPolicyViolation	Perintah melanggar salah satu aturan filter konten lainnya.

dalleErrorResponse

Nama	Tipe	Deskripsi	Wajib diisi	Default
kesalahan	dalleError		No

dalleError

Nama	Tipe	Deskripsi	Wajib diisi
param	string		No
jenis	string		No
inner_error	dalleInnerError	Kesalahan dalam dengan detail tambahan.	No

dalleInnerError

Kesalahan dalam dengan detail tambahan.

Nama	Tipe	Deskripsi	Wajib diisi
kode	innerErrorCode	Kode kesalahan untuk objek kesalahan dalam.	No
content_filter_results	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 kodrat, jika telah terdeteksi, dan apakah telah difilter atau belum. Dan informasi tentang daftar blokir pelanggan, jika telah difilter dan id-nya.	No
revised_prompt	string	Perintah yang digunakan untuk menghasilkan gambar, jika ada revisi pada perintah.	No

contentFilterResultBase

Nama	Tipe	Deskripsi	Wajib diisi	Default
Disaring	Boolean		Ya

contentFilterSeverityResult

Nama	Tipe	Deskripsi	Wajib diisi	Default
Disaring	Boolean		Ya
keparahan	string		No

contentFilterDetectedResult

Nama	Tipe	Deskripsi	Wajib diisi	Default
Disaring	Boolean		Ya
terdeteksi	Boolean		No

contentFilterDetectedWithCitationResult

Nama	Tipe	Deskripsi	Wajib diisi	Default
kutipan	object		No

Properti untuk kutipan

URL

Nama	Tipe	Deskripsi	Default
URL	string

lisensi

Nama	Tipe	Deskripsi	Default
lisensi	string

contentFilterResultsBase

Informasi tentang hasil pemfilteran konten.

Nama	Tipe	Wajib diisi
seksual	contentFilterSeverityResult	No
kekerasan	contentFilterSeverityResult	No
benci	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
Senonoh	contentFilterDetectedResult	No
kesalahan	errorBase	No

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 kodrat, jika telah terdeteksi, dan apakah telah difilter atau belum. Dan informasi tentang daftar blokir pelanggan, jika telah difilter dan id-nya.

Nama	Tipe	Wajib diisi
seksual	contentFilterSeverityResult	No
kekerasan	contentFilterSeverityResult	No
benci	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
Senonoh	contentFilterDetectedResult	No
kesalahan	errorBase	No
Jailbreak	contentFilterDetectedResult	No

contentFilterChoiceResults

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	Wajib diisi
seksual	contentFilterSeverityResult	No
kekerasan	contentFilterSeverityResult	No
benci	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
Senonoh	contentFilterDetectedResult	No
kesalahan	errorBase	No
protected_material_text	contentFilterDetectedResult	No
protected_material_code	contentFilterDetectedWithCitationResult	No

promptFilterResult

Hasil pemfilteran konten untuk satu permintaan dalam permintaan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
prompt_index	Integer		No
content_filter_results	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 kodrat, jika telah terdeteksi, dan apakah telah difilter atau belum. Dan informasi tentang daftar blokir pelanggan, jika telah difilter dan id-nya.	No

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.

dalleContentFilterResults

Informasi tentang hasil pemfilteran konten.

Nama	Tipe	Wajib diisi
seksual	contentFilterSeverityResult	No
kekerasan	contentFilterSeverityResult	No
benci	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No

dalleFilterResults

Nama	Tipe	Wajib diisi
seksual	contentFilterSeverityResult	No
kekerasan	contentFilterSeverityResult	No
benci	contentFilterSeverityResult	No
self_harm	contentFilterSeverityResult	No
Senonoh	contentFilterDetectedResult	No
Jailbreak	contentFilterDetectedResult	No

chatCompletionsRequestCommon

Nama	Tipe	Deskripsi	Wajib diisi	Default
suhu	number	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 mengubah ini atau `top_p` tetapi tidak keduanya.	No	1
top_p	number	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa peluang top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau `temperature` tetapi tidak keduanya.	No	1
stream	Boolean	Jika diatur, delta pesan parsial akan dikirim, seperti di ChatGPT. Token akan dikirim sebagai peristiwa yang dikirim server khusus data saat tersedia, dengan aliran dihentikan oleh pesan `data: [DONE]` .	No	Salah
stop	string atau array	Hingga empat urutan di mana API akan berhenti menghasilkan token lebih lanjut.	No
max_tokens	Integer	Jumlah maksimum token yang diizinkan untuk jawaban yang dihasilkan. Secara default, jumlah token yang dapat dikembalikan model adalah (4096 - token prompt). Nilai ini sekarang tidak digunakan lagi demi `max_completion_tokens`, dan tidak kompatibel dengan model seri o1.	No	4096
max_completion_tokens	Integer	Batas atas untuk jumlah token yang dapat dihasilkan untuk penyelesaian, termasuk token output yang terlihat dan token penalaran.	No
presence_penalty	number	Angka antara -2,0 dan 2,0. Nilai positif mengkhususkan token baru berdasarkan apakah token tersebut muncul dalam teks sejauh ini, meningkatkan kemungkinan model untuk berbicara tentang topik baru.	No	0
frequency_penalty	number	Angka antara -2,0 dan 2,0. Nilai positif mengkhususkan token baru berdasarkan frekuensi yang ada dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi verbatim baris yang sama.	No	0
logit_bias	object	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.	No
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu Azure OpenAI memantau dan mendeteksi penyalahgunaan.	No

createCompletionRequest

Nama	Tipe	Deskripsi	Wajib diisi	Default
perintah	string atau array	Perintah untuk menghasilkan penyelesaian untuk, dikodekan sebagai string, array string, array token, atau array 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
best_of	Integer	`best_of` Menghasilkan sisi server penyelesaian dan mengembalikan "terbaik" (yang 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 untuk mengembalikan â€" `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`.	No	1
echo	Boolean	Gema mengembalikan perintah selain penyelesaian	No	Salah
frequency_penalty	number	Angka antara -2,0 dan 2,0. Nilai positif mengkhususkan token baru berdasarkan frekuensi yang ada dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi verbatim baris yang sama.	No	0
logit_bias	object	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.	No	Tidak
logprobs	Integer	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.	No	Tidak
max_tokens	Integer	Jumlah maksimum token yang dapat dihasilkan dalam penyelesaian. Jumlah token prompt Anda ditambah `max_tokens` tidak dapat melebihi panjang konteks model.	No	16
n	Integer	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`.	No	1
presence_penalty	number	Angka antara -2,0 dan 2,0. Nilai positif mengkhususkan token baru berdasarkan apakah token tersebut muncul dalam teks sejauh ini, meningkatkan kemungkinan model untuk berbicara tentang topik baru.	No	0
seed	Integer	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.	No
stop	string atau array	Hingga empat urutan di mana API akan berhenti menghasilkan token lebih lanjut. Teks yang dikembalikan tidak akan berisi urutan berhenti.	No
stream	Boolean	Apakah akan kembali melakukan streaming pada kemajuan parsial. Jika diatur, token akan dikirim sebagai peristiwa yang dikirim server khusus data saat tersedia, dengan streaming dihentikan oleh pesan`data: [DONE]`.	No	Salah
Akhiran	string	Akhiran yang muncul setelah penyelesaian teks yang disisipkan. Parameter ini hanya didukung untuk `gpt-3.5-turbo-instruct`.	No	Tidak
suhu	number	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 mengubah ini atau `top_p` tetapi tidak keduanya.	No	1
top_p	number	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa peluang top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau `temperature` tetapi tidak keduanya.	No	1
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	No

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	Wajib diisi
id	string	Pengidentifikasi unik untuk penyelesaian.	Ya
Pilihan	array	Daftar pilihan penyelesaian model yang dihasilkan untuk perintah input.	Ya
Dibuat	Integer	Tanda waktu Unix (dalam detik) saat penyelesaian dibuat.	Ya
model	string	Model yang digunakan untuk penyelesaian.	Ya
prompt_filter_results	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.	No
system_fingerprint	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.	No
object	enum	Jenis objek, yang selalu "text_completion" Nilai yang mungkin: text_completion	Ya
penggunaan	completionUsage	Statistik penggunaan untuk permintaan penyelesaian.	No

createChatCompletionRequest

Nama	Tipe	Deskripsi	Wajib diisi	Default
suhu	number	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 mengubah ini atau `top_p` tetapi tidak keduanya.	No	1
top_p	number	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa peluang top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau `temperature` tetapi tidak keduanya.	No	1
stream	Boolean	Jika diatur, delta pesan parsial akan dikirim, seperti di ChatGPT. Token akan dikirim sebagai peristiwa yang dikirim server khusus data saat tersedia, dengan aliran dihentikan oleh pesan`data: [DONE]`.	No	Salah
stop	string atau array	Hingga empat urutan di mana API akan berhenti menghasilkan token lebih lanjut.	No
max_tokens	Integer	Jumlah maksimum token yang dapat dihasilkan dalam penyelesaian obrolan. Panjang total token input dan token yang dihasilkan dibatasi oleh panjang konteks model.	No
max_completion_tokens	Integer	Batas atas untuk jumlah token yang dapat dihasilkan untuk penyelesaian, termasuk token output yang terlihat dan token penalaran.	No
presence_penalty	number	Angka antara -2,0 dan 2,0. Nilai positif mengkhususkan token baru berdasarkan apakah token tersebut muncul dalam teks sejauh ini, meningkatkan kemungkinan model untuk berbicara tentang topik baru.	No	0
frequency_penalty	number	Angka antara -2,0 dan 2,0. Nilai positif mengkhususkan token baru berdasarkan frekuensi yang ada dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi verbatim baris yang sama.	No	0
logit_bias	object	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.	No	Tidak
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	No
pesan	array	Daftar pesan yang terdiri dari percakapan sejauh ini.	Ya
data_sources	array	Entri konfigurasi untuk ekstensi obrolan Azure OpenAI yang menggunakannya. Spesifikasi tambahan ini hanya kompatibel dengan Azure OpenAI.	No
logprobs	Boolean	Apakah akan mengembalikan probabilitas log dari token output atau tidak. Jika true, mengembalikan probabilitas log dari setiap token output yang `content` dikembalikan di dari `message`.	No	Salah
top_logprobs	Integer	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.	No
n	Integer	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. `1` Pertahankan `n` untuk meminimalkan biaya.	No	1
parallel_tool_calls	ParallelToolCalls	Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.	No	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 aliran spasi kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berjalan lama dan tampaknya "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.	No
seed	Integer	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.	No
alat	array	Daftar alat yang mungkin dipanggil model. Saat ini, hanya fungsi yang didukung sebagai alat. Gunakan ini untuk menyediakan daftar fungsi yang dapat dihasilkan model input JSON. Maksimal 128 fungsi didukung.	No
tool_choice	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.	No
function_call	string atau chatCompletionFunctionCallOption	Tidak digunakan lagi demi `tool_choice`. Mengontrol fungsi (jika ada) mana 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.	No
fungsi	array	Tidak digunakan lagi demi `tools`. Daftar fungsi yang digunakan model dapat menghasilkan input JSON.	No

chatCompletionFunctions

Nama	Tipe	Deskripsi	Wajib diisi
description	string	Deskripsi tentang apa yang dilakukan fungsi, digunakan oleh model untuk memilih kapan dan bagaimana memanggil fungsi.	No
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 Skema JSON untuk dokumentasi tentang format. Menghilangkan mendefinisikan `parameters` fungsi dengan daftar parameter kosong.	No

chatCompletionFunctionCallOption

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

Nama	Tipe	Deskripsi	Wajib diisi	Default
nama	string	Nama fungsi yang akan dipanggil.	Ya

chatCompletionRequestMessage

Komponen ini bisa menjadi salah satu hal berikut:

chatCompletionRequestSystemMessage

Nama	Tipe	Deskripsi	Wajib diisi
konten	string atau array	Isi pesan sistem.	Ya
role	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.	No

chatCompletionRequestUserMessage

Nama	Tipe	Deskripsi	Wajib diisi
konten	string atau array	Konten pesan pengguna.	Ya
role	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.	No

chatCompletionRequestAssistantMessage

Nama	Tipe	Deskripsi	Wajib diisi
konten	string atau array	Isi pesan asisten. Diperlukan kecuali `tool_calls` atau `function_call` ditentukan.	No
penolakan	string	Pesan penolakan oleh asisten.	No
role	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.	No
tool_calls	chatCompletionMessageToolCalls	Panggilan alat yang dihasilkan oleh model, seperti panggilan fungsi.	No
function_call	object	Tidak digunakan lagi dan digantikan oleh `tool_calls`. Nama dan argumen fungsi yang harus dipanggil, seperti yang dihasilkan oleh model.	No

Properti untuk function_call

arguments

Nama	Tipe	Deskripsi	Default
arguments	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	Default
nama	string	Nama fungsi yang akan dipanggil.

chatCompletionRequestToolMessage

Nama	Tipe	Deskripsi	Wajib diisi
role	enum	Peran penulis pesan, dalam hal `tool`ini . Nilai yang mungkin: alat	Ya
konten	string atau array	Isi pesan alat.	Ya
tool_call_id	string	Panggilan alat yang direspons pesan ini.	Ya

chatCompletionRequestFunctionMessage

Nama	Tipe	Deskripsi	Wajib diisi
role	enum	Peran penulis pesan, dalam hal `function`ini . Nilai yang mungkin: fungsi	Ya
konten	string	Isi pesan fungsi.	Ya
nama	string	Nama fungsi yang akan dipanggil.	Ya

chatCompletionRequestSystemMessageContentPart

Komponen ini bisa menjadi salah satu hal berikut:

chatCompletionRequestUserMessageContentPart

Komponen ini bisa menjadi salah satu hal berikut:

chatCompletionRequestAssistantMessageContentPart

Komponen ini bisa menjadi salah satu hal berikut:

chatCompletionRequestToolMessageContentPart

Komponen ini bisa menjadi salah satu hal berikut:

chatCompletionRequestMessageContentPartText

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	enum	Jenis bagian konten. Nilai yang mungkin: teks	Ya
text	string	Isi teks.	Ya

chatCompletionRequestMessageContentPartImage

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	enum	Jenis bagian konten. Nilai yang mungkin: image_url	Ya
image_url	object		Ya

Properti untuk image_url

url

Nama	Tipe	Deskripsi	Default
url	string	Baik URL gambar atau data gambar yang dikodekan base64.

detail

Nama	Tipe	Deskripsi	Default
detail	string	Menentukan tingkat detail gambar. Pelajari lebih lanjut di panduan Visi.	auto

chatCompletionRequestMessageContentPartRefusal

Nama	Tipe	Deskripsi	Wajib diisi	Default
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	Wajib diisi	Default
jenis	azureChatExtensionType	Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh obrolan permintaan penyelesaian 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: string

Default:

Nama Enum: AzureChatExtensionType

Nilai Enum:

Nilai	Deskripsi
azure_search	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	Wajib diisi	Default
jenis	azureChatExtensionType	Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh obrolan permintaan penyelesaian 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.	No

azureSearchChatExtensionParameters

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

Nama	Tipe	Deskripsi	Wajib diisi
Autentikasi	onYourDataApiKeyAuthenticationOptions atau onYourDataSystemAssignedManagedIdentityAuthenticationOptions atau onYourDataUserAssignedManagedIdentityAuthenticationOptions		Ya
top_n_documents	Integer	Jumlah dokumen teratas yang dikonfigurasi untuk ditampilkan untuk kueri yang dikonfigurasi.	No
in_scope	Boolean	Apakah kueri harus dibatasi untuk menggunakan data terindeks.	No
keketatan	Integer	Ketatnya pemfilteran relevansi pencarian yang dikonfigurasi. Semakin tinggi ketegasan, semakin tinggi presisi tetapi pengenalan jawaban yang lebih rendah.	No
role_information	string	Berikan instruksi model tentang bagaimana seharusnya perilakunya dan konteks apa pun yang harus dirujuknya saat menghasilkan respons. Anda dapat menjelaskan kepribadian asisten dan memberi tahunya cara memformat respons. Ada batas token 100 untuk itu, dan dihitung terhadap batas token keseluruhan.	No
titik akhir	string	Jalur titik akhir absolut untuk digunakan sumber daya Azure Search.	Ya
index_name	string	Nama indeks yang akan digunakan sebagai tersedia di sumber daya Azure Search yang dirujuk.	Ya
fields_mapping	azureSearchIndexFieldMappingOptions	Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Azure Search yang dikonfigurasi.	No
query_type	azureSearchQueryType	Jenis kueri pengambilan Azure Search yang harus dijalankan saat menggunakannya sebagai ekstensi obrolan Azure OpenAI.	No
semantic_configuration	string	Konfigurasi semantik tambahan untuk kueri.	No
filter	string	Filter pencarian.	No
embedding_dependency	onYourDataEndpointVectorizationSource atau onYourDataDeploymentNameVectorizationSource		No

azureSearchIndexFieldMappingOptions

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

Nama	Tipe	Deskripsi	Wajib diisi
title_field	string	Nama bidang indeks yang akan digunakan sebagai judul.	No
url_field	string	Nama bidang indeks yang akan digunakan sebagai URL.	No
filepath_field	string	Nama bidang indeks yang akan digunakan sebagai jalur file.	No
content_fields	array	Nama bidang indeks yang harus diperlakukan sebagai konten.	No
content_fields_separator	string	Pola pemisah yang harus digunakan bidang konten.	No
vector_fields	array	Nama bidang yang mewakili data vektor.	No

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: string

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.
vector_simple_hybrid	Mewakili kombinasi strategi kueri sederhana dengan data vektor.
vector_semantic_hybrid	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	Wajib diisi	Default
jenis	azureChatExtensionType	Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh obrolan permintaan penyelesaian 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.	No

azureCosmosDBChatExtensionParameters

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

Nama	Tipe	Deskripsi	Wajib diisi
Autentikasi	onYourDataConnectionStringAuthenticationOptions	Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan string koneksi.	Ya
top_n_documents	Integer	Jumlah dokumen teratas yang dikonfigurasi untuk ditampilkan untuk kueri yang dikonfigurasi.	No
in_scope	Boolean	Apakah kueri harus dibatasi untuk menggunakan data terindeks.	No
keketatan	Integer	Ketatnya pemfilteran relevansi pencarian yang dikonfigurasi. Semakin tinggi ketegasan, semakin tinggi presisi tetapi pengenalan jawaban yang lebih rendah.	No
role_information	string	Berikan instruksi model tentang bagaimana seharusnya perilakunya dan konteks apa pun yang harus dirujuknya saat menghasilkan respons. Anda dapat menjelaskan kepribadian asisten dan memberi tahunya cara memformat respons. Ada batas token 100 untuk itu, dan dihitung terhadap batas token keseluruhan.	No
database_name	string	Nama database MongoDB vCore untuk digunakan dengan Azure Cosmos DB.	Ya
container_name	string	Nama kontainer sumber daya Azure Cosmos DB.	Ya
index_name	string	Nama indeks MongoDB vCore untuk digunakan dengan Azure Cosmos DB.	Ya
fields_mapping	azureCosmosDBFieldMappingOptions	Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Azure Cosmos DB yang dikonfigurasi.	Ya
embedding_dependency	onYourDataEndpointVectorizationSource atau onYourDataDeploymentNameVectorizationSource		Ya

azureCosmosDBFieldMappingOptions

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

Nama	Tipe	Deskripsi	Wajib diisi
title_field	string	Nama bidang indeks yang akan digunakan sebagai judul.	No
url_field	string	Nama bidang indeks yang akan digunakan sebagai URL.	No
filepath_field	string	Nama bidang indeks yang akan digunakan sebagai jalur file.	No
content_fields	array	Nama bidang indeks yang harus diperlakukan sebagai konten.	Ya
content_fields_separator	string	Pola pemisah yang harus digunakan bidang konten.	No
vector_fields	array	Nama bidang yang mewakili data vektor.	Ya

onYourDataAuthenticationOptions

Opsi autentikasi untuk Azure OpenAI On Your Data.

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	onYourDataAuthenticationType	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Ya

onYourDataAuthenticationType

Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.

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

Jenis: string

Default:

Nama Enum: OnYourDataAuthenticationType

Nilai Enum:

Nilai	Deskripsi
api_key	Autentikasi melalui kunci API.
String_koneksi	Autentikasi melalui string koneksi.
system_assigned_managed_identity	Autentikasi melalui identitas terkelola yang ditetapkan sistem.
user_assigned_managed_identity	Autentikasi melalui identitas terkelola yang ditetapkan pengguna.

onYourDataApiKeyAuthenticationOptions

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

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	onYourDataAuthenticationType	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Ya
kunci	string	Kunci API yang digunakan untuk autentikasi.	No

onYourDataConnectionStringAuthenticationOptions

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

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	onYourDataAuthenticationType	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Ya
String_koneksi	string	string koneksi yang digunakan untuk autentikasi.	No

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

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

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	onYourDataAuthenticationType	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Ya

onYourDataUserAssignedManagedIdentityAuthenticationOptions

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

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	onYourDataAuthenticationType	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Ya
managed_identity_resource_id	string	ID sumber daya identitas terkelola yang ditetapkan pengguna untuk digunakan untuk autentikasi.	No

onYourDataVectorizationSource

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

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	onYourDataVectorizationSourceType	Mewakili sumber yang tersedia yang dapat digunakan Azure OpenAI On Your Data untuk mengonfigurasi vektorisasi data untuk digunakan pencarian vektor.	Ya

onYourDataVectorizationSourceType

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: string

Default:

Nama Enum: OnYourDataVectorizationSourceType

Nilai Enum:

Nilai	Deskripsi
titik akhir	Mewakili vektorisasi yang dilakukan oleh panggilan layanan publik ke model penyematan Azure OpenAI.
deployment_name	Mewakili nama penyebaran model Ada untuk digunakan. Penyebaran model ini harus berada di sumber daya Azure OpenAI yang sama, tetapi Pada Data Anda akan menggunakan penyebaran model ini melalui panggilan internal daripada yang publik, yang memungkinkan 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	Wajib diisi	Default
jenis	onYourDataVectorizationSourceType	Mewakili sumber yang tersedia yang dapat digunakan Azure OpenAI On Your Data untuk mengonfigurasi vektorisasi data untuk digunakan pencarian vektor.	Ya
deployment_name	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.	No

onYourDataEndpointVectorizationSource

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

Nama	Tipe	Deskripsi	Wajib diisi
jenis	onYourDataVectorizationSourceType	Mewakili sumber yang tersedia yang dapat digunakan Azure OpenAI On Your Data untuk mengonfigurasi vektorisasi data untuk digunakan pencarian vektor.	Ya
Autentikasi	onYourDataApiKeyAuthenticationOptions	Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan kunci API.	No
titik akhir	string	Menentukan titik akhir yang akan digunakan untuk vektorisasi. Titik akhir ini harus berada di sumber daya Azure OpenAI yang sama, tetapi Pada Data Anda akan menggunakan titik akhir ini melalui panggilan internal daripada yang publik, yang memungkinkan pencarian vektor bahkan di jaringan privat.	No

azureChatExtensionsMessageContext

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	Wajib diisi	Default
Kutipan	array	Hasil pengambilan sumber data, digunakan untuk menghasilkan pesan asisten dalam respons.	No
tujuan	string	Niat yang terdeteksi dari riwayat obrolan, digunakan untuk meneruskan ke giliran berikutnya untuk membawa konteks.	No

kutipan

informasi kutipan untuk pesan respons penyelesaian obrolan.

Nama	Tipe	Deskripsi	Wajib diisi
konten	string	Konten kutipan.	Ya
title	string	Judul kutipan.	No
url	string	URL kutipan.	No
jalur file	string	Jalur file kutipan.	No
chunk_id	string	ID gugus kutipan.	No

chatCompletionMessageToolCall

Nama	Tipe	Deskripsi	Wajib diisi
id	string	ID panggilan alat.	Ya
jenis	toolCallType	Jenis panggilan alat, dalam hal `function`ini .	Ya
fungsi	object	Fungsi yang dipanggil model.	Ya

Properti untuk fungsi

nama

Nama	Tipe	Deskripsi	Default
nama	string	Nama fungsi yang akan dipanggil.

arguments

Nama	Tipe	Deskripsi	Default
arguments	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.

toolCallType

Jenis panggilan alat, dalam hal functionini .

Deskripsi: Jenis panggilan alat, dalam hal functionini .

Jenis: string

Default:

Nama Enum: ToolCallType

Nilai Enum:

Nilai	Deskripsi
fungsi	Jenis panggilan alat adalah fungsi.

chatCompletionRequestMessageTool

Nama	Tipe	Deskripsi	Wajib diisi	Default
tool_call_id	string	Panggilan alat yang direspons pesan ini.	No
konten	string	Isi pesan.	No

chatCompletionRequestMessageFunction

Nama	Tipe	Deskripsi	Wajib diisi
role	enum	Peran penulis pesan, dalam hal `function`ini . Nilai yang mungkin: fungsi	No
nama	string	Isi pesan.	No
konten	string	Isi pesan.	No

createChatCompletionResponse

Mewakili respons penyelesaian obrolan yang dikembalikan oleh model, berdasarkan input yang disediakan.

Nama	Tipe	Deskripsi	Wajib diisi
id	string	Pengidentifikasi unik untuk penyelesaian obrolan.	Ya
prompt_filter_results	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.	No
Pilihan	array	Daftar pilihan penyelesaian obrolan. Bisa lebih dari satu jika `n` lebih besar dari 1.	Ya
Dibuat	Integer	Tanda waktu Unix (dalam detik) saat penyelesaian obrolan dibuat.	Ya
model	string	Model yang digunakan untuk penyelesaian obrolan.	Ya
system_fingerprint	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.	No
object	enum	Jenis objek, yang selalu `chat.completion`. Nilai yang mungkin: chat.completion	Ya
penggunaan	completionUsage	Statistik penggunaan untuk permintaan penyelesaian.	No

createChatCompletionStreamResponse

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

Nama	Tipe	Deskripsi	Wajib diisi
id	string	Pengidentifikasi unik untuk penyelesaian obrolan. 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	Integer	Tanda waktu Unix (dalam detik) saat penyelesaian obrolan dibuat. Setiap gugus memiliki tanda waktu yang sama.	Ya
model	string	Model untuk menghasilkan penyelesaian.	Ya
system_fingerprint	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.	No
object	enum	Jenis 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	Wajib diisi
konten	string	Isi pesan gugus.	No
function_call	object	Tidak digunakan lagi dan digantikan oleh `tool_calls`. Nama dan argumen fungsi yang harus dipanggil, seperti yang dihasilkan oleh model.	No
tool_calls	array		No
role	enum	Peran penulis pesan ini. Nilai yang mungkin: sistem, pengguna, asisten, alat	No
penolakan	string	Pesan penolakan yang dihasilkan oleh model.	No

Properti untuk function_call

arguments

Nama	Tipe	Deskripsi	Default
arguments	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	Default
nama	string	Nama fungsi yang akan dipanggil.

chatCompletionMessageToolCallChunk

Nama	Tipe	Deskripsi	Wajib diisi
index	Integer		Ya
id	string	ID panggilan alat.	No
jenis	enum	Jenis alat. Saat ini, hanya `function` didukung. Nilai yang mungkin: fungsi	No
fungsi	object		No

Properti untuk fungsi

nama

Nama	Tipe	Deskripsi	Default
nama	string	Nama fungsi yang akan dipanggil.

arguments

Nama	Tipe	Deskripsi	Default
arguments	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	Wajib diisi	Default
include_usage	Boolean	Jika diatur, gugus tambahan akan dialirkan sebelum `data: [DONE]` pesan. Bidang `usage` pada gugus ini menunjukkan statistik penggunaan token untuk seluruh permintaan, dan `choices` bidang akan selalu menjadi array kosong. Semua gugus lainnya juga akan menyertakan `usage` bidang, tetapi dengan nilai null.	No

chatCompletionChoiceLogProbs

Catat informasi probabilitas untuk pilihan tersebut.

Nama	Tipe	Deskripsi	Wajib diisi	Default
konten	array	Daftar token konten pesan dengan informasi probabilitas log.	Ya
penolakan	array	Daftar token penolakan pesan dengan informasi probabilitas log.	No

chatCompletionTokenLogprob

Nama	Tipe	Deskripsi	Wajib diisi
token	string	Token.	Ya
logprob	number	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, mungkin ada kurang dari jumlah yang diminta `top_logprobs` dikembalikan.	Ya

chatCompletionResponseMessage

Pesan penyelesaian obrolan yang dihasilkan oleh model.

Nama	Tipe	Deskripsi	Wajib diisi
role	chatCompletionResponseMessageRole	Peran penulis pesan respons.	Ya
penolakan	string	Pesan penolakan yang dihasilkan oleh model.	Ya
konten	string	Isi pesan.	Ya
tool_calls	array	Panggilan alat yang dihasilkan oleh model, seperti panggilan fungsi.	No
function_call	chatCompletionFunctionCall	Tidak digunakan lagi dan digantikan oleh `tool_calls`. Nama dan argumen fungsi yang harus dipanggil, seperti yang dihasilkan oleh model.	No
context	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.	No

chatCompletionResponseMessageRole

Peran penulis pesan respons.

Deskripsi: Peran penulis pesan respons.

Jenis: string

Default:

Nilai Enum:

assistant

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.

Komponen ini bisa menjadi salah satu hal berikut:

chatCompletionNamedToolChoice

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

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	enum	Jenis alat. Saat ini, hanya `function` didukung. Nilai yang mungkin: fungsi	Ya
fungsi	object		Ya

Properti untuk fungsi

nama

Nama	Tipe	Deskripsi	Default
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.

chatCompletionMessageToolCalls

Panggilan alat yang dihasilkan oleh model, seperti panggilan fungsi.

Tidak ada properti yang ditentukan untuk komponen ini.

chatCompletionFunctionCall

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

Nama	Tipe	Deskripsi	Wajib diisi	Default
nama	string	Nama fungsi yang akan dipanggil.	Ya
arguments	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

completionUsage

Statistik penggunaan untuk permintaan penyelesaian.

Nama	Tipe	Deskripsi	Wajib diisi
prompt_tokens	Integer	Jumlah token dalam perintah.	Ya
completion_tokens	Integer	Jumlah token dalam penyelesaian yang dihasilkan.	Ya
total_tokens	Integer	Jumlah total token yang digunakan dalam permintaan (prompt + completion).	Ya
completion_tokens_details	object	Perincian token yang digunakan dalam penyelesaian.	No

Properti untuk completion_tokens_details

reasoning_tokens

Nama	Tipe	Deskripsi	Default
reasoning_tokens	Integer	Token yang dihasilkan oleh model untuk penalaran.

chatCompletionTool

Nama	Tipe	Deskripsi	Wajib diisi	Default
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 Skema JSON untuk dokumentasi tentang format.

Menghilangkan mendefinisikan parameters fungsi dengan daftar parameter kosong.

Tidak ada properti yang ditentukan untuk komponen ini.

FunctionObject

Nama	Tipe	Deskripsi	Wajib diisi	Default
description	string	Deskripsi tentang apa yang dilakukan fungsi, digunakan oleh model untuk memilih kapan dan bagaimana memanggil fungsi.	No
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 Skema JSON untuk dokumentasi tentang format. Menghilangkan mendefinisikan `parameters` fungsi dengan daftar parameter kosong.	No
ketat	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`.	No	Salah

ResponseFormatText

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	enum	Jenis format respons yang ditentukan: `text` Nilai yang mungkin: teks	Ya

ResponseFormatJsonObject

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	enum	Jenis format respons yang ditentukan: `json_object` Nilai yang mungkin: json_object	Ya

ResponseFormatJsonSchemaSchemaSchema

Skema untuk format respons, dijelaskan sebagai objek Skema JSON.

Tidak ada properti yang ditentukan untuk komponen ini.

ResponseFormatJsonSchema

Nama	Tipe	Deskripsi	Wajib diisi	Default
jenis	enum	Jenis format respons yang ditentukan: `json_schema` Nilai yang mungkin: json_schema	Ya
json_schema	object		Ya

Properti untuk json_schema

description

Nama	Tipe	Deskripsi	Default
description	string	Deskripsi untuk apa format respons, digunakan oleh model untuk menentukan cara merespons dalam format.

nama

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

skema

Nama	Tipe	Deskripsi	Default
skema	ResponseFormatJsonSchemaSchemaSchema	Skema untuk format respons, dijelaskan sebagai objek Skema JSON.

ketat

Nama	Tipe	Deskripsi	Default
ketat	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`.	Salah

chatCompletionChoiceCommon

Nama	Tipe	Deskripsi	Wajib diisi	Default
index	Integer		No
finish_reason	string		No

createTranslationRequest

Permintaan terjemahan.

Nama	Tipe	Deskripsi	Wajib diisi	Default
file	string	File audio yang akan diterjemahkan.	Ya
perintah	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Prompt harus dalam bahasa Inggris.	No
response_format	audioResponseFormat	Menentukan format output.	No
suhu	number	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.	No	0

audioResponse

Respons terjemahan atau transkripsi saat response_format adalah json

Nama	Tipe	Deskripsi	Wajib diisi	Default
text	string	Teks yang diterjemahkan atau ditranskripsikan.	Ya

audioVerboseResponse

Respons terjemahan atau transkripsi saat response_format verbose_json

Nama	Tipe	Deskripsi	Wajib diisi
text	string	Teks yang diterjemahkan atau ditranskripsikan.	Ya
tugas	string	Jenis tugas audio.	No
bahasa	string	Bahasa.	No
durasi	number	Durasi.	No
segmen	array		No

audioResponseFormat

Menentukan format output.

Deskripsi: Menentukan format output.

Jenis: string

Default:

Nilai Enum:

json
text
srt
verbose_json
vtt

createTranscriptionRequest

Permintaan transkripsi.

Nama	Tipe	Deskripsi	Wajib diisi	Default
file	string	Objek file audio yang akan ditranskripsikan.	Ya
perintah	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Perintah harus cocok dengan bahasa audio.	No
response_format	audioResponseFormat	Menentukan format output.	No
suhu	number	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.	No	0
bahasa	string	Bahasa audio input. Menyediakan bahasa input dalam format ISO-639-1 akan meningkatkan akurasi dan latensi.	No

audioSegment

Segmen transkripsi atau terjemahan.

Nama	Tipe	Deskripsi	Wajib diisi
id	Integer	Pengidentifikasi segmen.	No
mencari	number	Offset segmen.	No
mulai	number	Offset mulai segmen.	No
akhir	number	Offset akhir segmen.	No
text	string	Teks segmentasi.	No
Token	array	Token teks.	No
suhu	number	Suhu.	No
avg_logprob	number	Probabilitas log rata-rata.	No
compression_ratio	number	Rasio kompresi.	No
no_speech_prob	number	Probabilitas .`no speech`	No

imageQuality

Kualitas gambar yang akan dihasilkan.

Deskripsi: Kualitas gambar yang akan dihasilkan.

Jenis: string

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: string

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.

imageSize

Ukuran gambar yang dihasilkan.

Deskripsi: Ukuran gambar yang dihasilkan.

Jenis: string

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.
1024 x 1024	Ukuran gambar yang dihasilkan yang diinginkan adalah 1024x1024 piksel.

imageStyle

Gaya gambar yang dihasilkan.

Deskripsi: Gaya gambar yang dihasilkan.

Jenis: string

Default: vivid

Nama Enum: Gaya

Nilai Enum:

Nilai	Deskripsi
Jelas	Vivid menciptakan gambar yang hiper-realistis dan dramatis.
alami	Alami menciptakan gambar yang lebih alami dan kurang hiper-realistis.

imageGenerationsRequest

Nama	Tipe	Deskripsi	Wajib diisi	Default
perintah	string	Deskripsi teks gambar yang diinginkan. Panjang maksimum adalah 4.000 karakter.	Ya
n	Integer	Jumlah gambar yang akan dihasilkan.	No	1
size	imageSize	Ukuran gambar yang dihasilkan.	No	1024 x 1024
response_format	imagesResponseFormat	Format di mana gambar yang dihasilkan dikembalikan.	No	url
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	No
kualitas	imageQuality	Kualitas gambar yang akan dihasilkan.	No	standar
gaya	imageStyle	Gaya gambar yang dihasilkan.	No	Jelas

generateImagesResponse

Nama	Tipe	Deskripsi	Wajib diisi	Default
Dibuat	Integer	Tanda waktu unix saat operasi dibuat.	Ya
data	array	Data hasil operasi, jika berhasil	Ya

imageResult

Url gambar atau gambar yang dikodekan jika berhasil, dan kesalahan sebaliknya.

Nama	Tipe	Deskripsi	Wajib diisi
url	string	Url gambar.	No
b64_json	string	Gambar yang dikodekan base64	No
content_filter_results	dalleContentFilterResults	Informasi tentang hasil pemfilteran konten.	No
revised_prompt	string	Perintah yang digunakan untuk menghasilkan gambar, jika ada revisi pada perintah.	No
prompt_filter_results	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 kodrat, jika telah terdeteksi, dan apakah telah difilter atau belum. Dan informasi tentang daftar blokir pelanggan, jika telah difilter dan id-nya.	No

Ekstensi penyelesaian

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

Chatmessage

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

Teks ke ucapan

Saat ini bukan bagian dari versi Azure OpenAI GA terbaru dari spesifikasi inferensi sarana data Azure OpenAI. Lihat versi pratinjau terbaru untuk kemampuan ini.

Langkah berikutnya

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

Bagikan melalui

Referensi REST API Azure OpenAI Service

Spesifikasi API

Autentikasi

Penerapan versi REST API

Inferensi sarana data

Penyelesaian

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Contoh

Contoh

Penyematan

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Properti untuk penggunaan

prompt_tokens

total_tokens

Contoh

Contoh

Penyelesaian obrolan

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Contoh

Contoh

Contoh

Contoh

Contoh

Transkripsi - Buat

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Contoh

Contoh

Contoh

Terjemahan - Buat

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Contoh

Contoh

Contoh

Pembuatan gambar

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Contoh

Contoh

Komponen

errorResponse

errorBase

kesalahan

innerError

innerErrorCode

dalleErrorResponse

dalleError

dalleInnerError

contentFilterResultBase

contentFilterSeverityResult

contentFilterDetectedResult

contentFilterDetectedWithCitationResult

Properti untuk kutipan

URL

lisensi

contentFilterResultsBase

contentFilterPromptResults

contentFilterChoiceResults

promptFilterResult

promptFilterResults

dalleContentFilterResults

dalleFilterResults

chatCompletionsRequestCommon