Referensi REST API Azure OpenAI di Microsoft Foundry Models

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

Spesifikasi API

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

• Pesawat Kontrol
• Bidang data - penulisan
• Bidang data - inferensi

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

Important

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

API	Rilis pratinjau terbaru	Rilis GA terbaru	Specifications	Description
Pesawat kontrol	2025-07-01-preview	2025-06-01	File spesifikasi teknis	API sarana kontrol digunakan untuk operasi seperti membuat sumber daya, penyebaran model, dan tugas manajemen sumber daya tingkat tinggi lainnya. Sarana kontrol juga mengatur apa yang mungkin dilakukan dengan kemampuan seperti Azure Resource Manager, Bicep, Terraform, dan Azure CLI.
Bidang data	v1 preview	v1	File spesifikasi teknis	API bidang data mengontrol operasi inferensi dan penurunan.

Authentication

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

• Autentikasi Kunci API: Untuk jenis autentikasi ini, semua permintaan API harus menyertakan Kunci API di api-key header HTTP. Mulai Cepat memberikan panduan tentang cara melakukan panggilan dengan jenis autentikasi ini.

• Microsoft Entra ID autentikasi: Anda dapat mengautentikasi panggilan API menggunakan token Microsoft Entra. Token autentikasi disertakan dalam permintaan sebagai Authorization header. Token yang diberikan harus didahului oleh Bearer, misalnya Bearer YOUR_AUTH_TOKEN. Anda dapat membaca panduan cara kami tentang autentikasi dengan Microsoft Entra ID.

Penerapan versi REST API

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

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

Inferensi bidang data

Sisa artikel mencakup rilis GA dari spesifikasi inferensi bidang data OpenAI Azure, 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	Required	Tipe	Description
titik akhir	path	Yes	string Url	Didukung Azure titik akhir OpenAI (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
ID penempatan	path	Yes	string	ID penyebaran model yang disebarkan.
Versi API	kueri	Yes	string	Versi API

Header Permohonan

Nama	Required	Tipe	Description
kunci API	Benar	string	Berikan kunci API Azure OpenAI di sini

Badan Permintaan

Content-Type: application/json

Nama	Tipe	Description	Required	Default
minta	string atau array	Prompt 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 perintah tidak ditentukan, model akan dihasilkan seolah-olah dari awal dokumen baru.	Yes
terbaik_dari	integer	Menghasilkan best_of penyelesaian di sisi server dan mengembalikan "terbaik" (yang memiliki probabilitas log tertinggi per token). Hasil tidak dapat dialirkan. Saat digunakan dengan n, best_of mengontrol jumlah penyelesaian kandidat dan n menentukan berapa banyak yang harus dikembalikan - best_of harus lebih besar dari n. Catatan: Karena parameter ini menghasilkan banyak penyelesaian, parameter ini dapat dengan cepat menghabiskan kuota token Anda. Gunakan dengan hati-hati dan pastikan Anda memiliki pengaturan yang wajar untuk max_tokens dan stop.	No	1
Echo	Boolean	Echo kembali prompt selain penyelesaian	No	False
penalti frekuensi	number	Angka antara -2.0 dan 2.0. Nilai positif menghukum token baru berdasarkan frekuensi yang ada dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi baris yang sama kata demi kata.	No	0
logit_bias	objek	Ubah kemungkinan token tertentu muncul dalam penyelesaian. Menerima objek JSON yang memetakan token (ditentukan oleh ID tokennya 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 pastinya akan bervariasi per model, tetapi nilai antara -1 dan 1 harus menurunkan atau meningkatkan kemungkinan seleksi; Nilai seperti -100 atau 100 harus menghasilkan larangan atau pemilihan 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 token keluaran yang logprobs paling mungkin, serta token yang dipilih. Misalnya, jika logprobs 5, API akan mengembalikan daftar lima token yang paling mungkin. API akan selalu mengembalikan logprob token sampel, sehingga mungkin ada elemen dalam logprobs+1 respons. Nilai maksimum untuk logprobs adalah 5.	No	Tidak
maksimum token	integer	Jumlah maksimum token yang dapat dihasilkan dalam penyelesaian. Jumlah token prompt plus max_tokens Anda tidak boleh melebihi panjang konteks model.	No	16
n	integer	Berapa banyak penyelesaian yang harus dihasilkan untuk setiap perintah. Catatan: Karena parameter ini menghasilkan banyak penyelesaian, parameter ini dapat dengan cepat menghabiskan kuota token Anda. Gunakan dengan hati-hati dan pastikan Anda memiliki pengaturan yang wajar untuk max_tokens dan stop.	No	1
penalti_kehadiran	number	Angka antara -2.0 dan 2.0. Nilai positif menghukum token baru berdasarkan apakah mereka 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 mengambil sampel secara deterministik, sehingga permintaan berulang dengan parameter dan parameter yang sama seed 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 ditampilkan tidak akan berisi urutan penghentian.	No
aliran	Boolean	Apakah akan mengalirkan kembali kemajuan parsial. Jika ditetapkan, token akan dikirim sebagai peristiwa yang dikirim server hanya data saat tersedia, dengan aliran dihentikan oleh data: [DONE] pesan.	No	False
Akhiran	string	Akhiran yang muncul setelah selesainya teks yang disisipkan. Parameter ini hanya didukung untuk gpt-3.5-turbo-instruct.	No	Tidak
suhu	number	Suhu pengambilan sampel apa yang digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sedangkan 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 probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10 massa probabilitas% 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

Responses

Kode Status: 200

Deskripsi: OK

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

Kode Status: default

Deskripsi: Layanan tidak tersedia

Content-Type	Tipe	Description
application/json	errorResponse

Examples

Example

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
}

Tanggapan: 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
    }
  }
}

Pembedaian

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 algoritme pembelajaran mesin.

Parameter URI

Nama	Dalam	Required	Tipe	Description
titik akhir	path	Yes	string Url	Didukung Azure titik akhir OpenAI (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
ID penempatan	path	Yes	string
Versi API	kueri	Yes	string	Versi API

Header Permohonan

Nama	Required	Tipe	Description
kunci API	Benar	string	Berikan kunci API Azure OpenAI di sini

Badan Permintaan

Content-Type: application/json

Nama	Tipe	Description	Required	Default
input	string atau array	Masukkan teks untuk disematkan, dikodekan sebagai string atau array token. Untuk menyematkan beberapa input dalam satu permintaan, teruskan array string atau 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. Selain batas token per input, semua model penyematan memberlakukan maksimum 300.000 token yang dijumlahkan di semua input dalam satu permintaan.	Yes
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	No
tipe_masukan	string	Jenis input pencarian penyematan untuk digunakan	No
encoding_format	string	Format untuk mengembalikan penyematan. Bisa salah satu atau floatbase64. Default ke float.	No
dimensions	integer	Jumlah dimensi yang harus dimiliki oleh penyematan keluaran yang dihasilkan. Hanya didukung dalam text-embedding-3 dan model yang lebih baru.	No

Responses

Nama	Tipe	Description	Required	Default
objek	string		Yes
model	string		Yes
data	array		Yes
penggunaan	objek		Yes

Properti untuk digunakan

prompt_tokens

Nama	Tipe	Description	Default
prompt_tokens	integer

total_tokens

Nama	Tipe	Description	Default
total_tokens	integer

Kode Status: 200

Deskripsi: OK

Content-Type	Tipe	Description
application/json	objek

Examples

Example

Kembalikan penyematan untuk perintah tertentu.

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

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

Tanggapan: Kode Status: 200

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

Penyelesaian percakapan

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

Membuat penyelesaian untuk pesan chat

Parameter URI

Nama	Dalam	Required	Tipe	Description
titik akhir	path	Yes	string Url	Didukung Azure titik akhir OpenAI (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
ID penempatan	path	Yes	string	ID penyebaran model yang disebarkan.
Versi API	kueri	Yes	string	Versi API

Header Permohonan

Nama	Required	Tipe	Description
kunci API	Benar	string	Berikan kunci API Azure OpenAI di sini

Badan Permintaan

Content-Type: application/json

Nama	Tipe	Description	Required	Default
suhu	number	Suhu pengambilan sampel apa yang digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sedangkan 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 probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10 massa probabilitas% teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau temperature tetapi tidak keduanya.	No	1
aliran	Boolean	Jika diatur, delta pesan parsial akan dikirim, seperti di ChatGPT. Token akan dikirim sebagai peristiwa yang dikirim server hanya data saat tersedia, dengan aliran dihentikan oleh data: [DONE] pesan.	No	False
stop	string atau array	Hingga empat urutan di mana API akan berhenti menghasilkan token lebih lanjut.	No
maksimum token	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 keluaran yang terlihat dan token penalaran.	No
penalti_kehadiran	number	Angka antara -2.0 dan 2.0. Nilai positif menghukum token baru berdasarkan apakah mereka muncul dalam teks sejauh ini, meningkatkan kemungkinan model untuk berbicara tentang topik baru.	No	0
penalti frekuensi	number	Angka antara -2.0 dan 2.0. Nilai positif menghukum token baru berdasarkan frekuensi yang ada dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi baris yang sama kata demi kata.	No	0
logit_bias	objek	Ubah kemungkinan token tertentu muncul dalam penyelesaian. Menerima objek JSON yang memetakan token (ditentukan oleh ID tokennya di tokenizer) ke nilai bias terkait dari -100 hingga 100. Secara matematis, bias ditambahkan ke logit yang dihasilkan oleh model sebelum pengambilan sampel. Efek pastinya akan bervariasi per model, tetapi nilai antara -1 dan 1 harus menurunkan atau meningkatkan kemungkinan seleksi; Nilai seperti -100 atau 100 harus menghasilkan larangan atau pemilihan 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.	Yes
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 dikembalikan dalam content of message.	No	False
top_logprobs	integer	Bilangan bulat antara 0 dan 20 yang menentukan jumlah token yang paling mungkin 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. Tetap n untuk 1 meminimalkan biaya.	No	1
pemanggilan_alat_paralel	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 sediakan. 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 pesan sistem atau pengguna. Tanpa ini, model dapat menghasilkan aliran spasi kosong yang tak ada habisnya hingga generasi mencapai batas token, menghasilkan permintaan yang berjalan lama dan tampaknya "macet". Perhatikan juga bahwa konten pesan dapat dipotong sebagian jika finish_reason="length", yang menunjukkan generasi terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	No
seed	integer	Fitur ini dalam versi Beta. Jika ditentukan, sistem kami akan melakukan upaya terbaik untuk mengambil sampel secara deterministik, sehingga permintaan berulang dengan parameter dan parameter yang sama seed 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 dapat dipanggil model. Saat ini, hanya fungsi yang didukung sebagai alat. Gunakan ini untuk menyediakan daftar fungsi yang dapat dihasilkan oleh 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 sebagai gantinya menghasilkan pesan. auto berarti model dapat memilih antara membuat pesan atau memanggil satu atau beberapa alat. required berarti model harus memanggil satu atau lebih alat. Menentukan alat tertentu melalui {"type": "function", "function": {"name": "my_function"}} memaksa model untuk memanggil alat tersebut. none adalah default ketika tidak ada alat. auto adalah default jika ada alat.	No
function_call	string atau chatCompletionFunctionCallOption	Tidak digunakan lagi untuk mendukung tool_choice. Mengontrol fungsi mana (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil fungsi dan sebagai ganti 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. auto adalah default jika ada fungsi.	No
functions	array	Tidak digunakan lagi untuk mendukung tools. Daftar fungsi yang dapat dihasilkan oleh model input JSON.	No

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Tipe	Description
application/json	createChatCompletionResponse atau createChatCompletionStreamResponse

Kode Status: default

Deskripsi: Layanan tidak tersedia

Content-Type	Tipe	Description
application/json	errorResponse

Examples

Example

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?"
  }
 ]
}

Tanggapan: 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
    }
  }
}

Example

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"
    }
   }
  }
 ]
}

Tanggapan: 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
    }
  }
}

Example

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"
     ]
    }
   }
  }
 ]
}

Tanggapan: 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
    }
  }
}

Example

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"
     ]
    }
   }
  }
 ]
}

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

Menyalin audio ke dalam bahasa input.

Parameter URI

Nama	Dalam	Required	Tipe	Description
titik akhir	path	Yes	string Url	Didukung Azure titik akhir OpenAI (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
ID penempatan	path	Yes	string	ID penyebaran model ucapan ke teks. Untuk informasi tentang model yang didukung, lihat [/azure/ai-foundry/openai/concepts/models#audio-models].
Versi API	kueri	Yes	string	Versi API

Header Permohonan

Nama	Required	Tipe	Description
kunci API	Benar	string	Berikan kunci API Azure OpenAI di sini

Badan Permintaan

Tipe Konten: multipart/form-data

Nama	Tipe	Description	Required	Default
berkas	string	Objek file audio untuk ditranskripsikan.	Yes
minta	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Perintah harus sesuai 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, sedangkan 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 tercapai.	No	0
bahasa	string	Bahasa audio input. Memasok bahasa input dalam format ISO-639-1 akan meningkatkan akurasi dan latensi.	No

Responses

Kode Status: 200

Deskripsi: OK

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

Examples

Example

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

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

Tanggapan: Kode Status: 200

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

Example

Mendapatkan teks yang ditranskripsi 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--"

Tanggapan: 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 menerjemahkan audio input ke dalam teks bahasa Inggris.

Parameter URI

Nama	Dalam	Required	Tipe	Description
titik akhir	path	Yes	string Url	Didukung Azure titik akhir OpenAI (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
ID penempatan	path	Yes	string	ID penyebaran model bisikan yang disebarkan. Untuk informasi tentang model yang didukung, lihat [/azure/ai-foundry/openai/concepts/models#audio-models].
Versi API	kueri	Yes	string	Versi API

Header Permohonan

Nama	Required	Tipe	Description
kunci API	Benar	string	Berikan kunci API Azure OpenAI di sini

Badan Permintaan

Tipe Konten: multipart/form-data

Nama	Tipe	Description	Required	Default
berkas	string	File audio yang akan diterjemahkan.	Yes
minta	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, sedangkan 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 tercapai.	No	0

Responses

Kode Status: 200

Deskripsi: OK

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

Examples

Example

Mendapatkan teks yang ditranskripsi dalam 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--"

Tanggapan: Kode Status: 200

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

Example

Mendapatkan teks yang ditranskripsi dalam 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--"

Tanggapan: 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 kumpulan gambar dari keterangan teks pada penyebaran model dall-e tertentu

Parameter URI

Nama	Dalam	Required	Tipe	Description
titik akhir	path	Yes	string Url	Didukung Azure titik akhir OpenAI (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya Azure OpenAI Anda). https://{your-resource-name}.openai.azure.com
ID penempatan	path	Yes	string	ID penyebaran model dall-e yang disebarkan.
Versi API	kueri	Yes	string	Versi API

Header Permohonan

Nama	Required	Tipe	Description
kunci API	Benar	string	Berikan kunci API Azure OpenAI di sini

Badan Permintaan

Content-Type: application/json

Nama	Tipe	Description	Required	Default
minta	string	Deskripsi teks dari gambar yang diinginkan. Panjang maksimum adalah 4.000 karakter.	Yes
n	integer	Jumlah gambar yang akan dihasilkan.	No	1
size	imageSize	Ukuran gambar yang dihasilkan.	No	1024x1024
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

Responses

Kode Status: 200

Deskripsi: Ok

Content-Type	Tipe	Description
application/json	generateImagesResponse

Kode Status: default

Deskripsi: Terjadi kesalahan.

Content-Type	Tipe	Description
application/json	dalleErrorResponse

Examples

Example

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"
}

Tanggapan: 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
          }
        }
      }
    ]
  }
}

Components

errorResponse

Nama	Tipe	Description	Required	Default
galat	error		No

errorBase

Nama	Tipe	Description	Required	Default
kode	string		No
pesan	string		No

galat

Nama	Tipe	Description	Required	Default
param	string		No
jenis	string		No
inner_error	innerError	Kesalahan batin dengan detail tambahan.	No

innerError

Kesalahan batin dengan detail tambahan.

Nama	Tipe	Description	Required	Default
kode	innerErrorCode	Kode kesalahan untuk objek kesalahan dalam.	No
content_filter_results	contentFilterPromptResults	Informasi tentang kategori pemfilteran konten (kebencian, seksual, kekerasan, self_harm), apakah telah terdeteksi, serta tingkat keparahan (skala very_low, rendah, sedang, tinggi yang menentukan intensitas dan tingkat risiko konten berbahaya) dan apakah telah disaring atau belum. Informasi tentang konten jailbreak dan kata-kata kotor, apakah sudah terdeteksi, dan apakah sudah disaring atau belum. Dan informasi tentang daftar blokir pelanggan, jika sudah disaring dan id-nya.	No

innerErrorCode

Kode kesalahan untuk objek kesalahan dalam.

Deskripsi: Kode kesalahan untuk objek kesalahan dalam.

Jenis: teks

Default:

Nama Enum: InnerErrorCode

Nilai Enum:

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

dalleErrorResponse

Nama	Tipe	Description	Required	Default
galat	dalleError		No

dalleError

Nama	Tipe	Description	Required	Default
param	string		No
jenis	string		No
inner_error	dalleInnerError	Kesalahan batin dengan detail tambahan.	No

dalleInnerError

Kesalahan batin dengan detail tambahan.

Nama	Tipe	Description	Required	Default
kode	innerErrorCode	Kode kesalahan untuk objek kesalahan dalam.	No
content_filter_results	dalleFilterResults	Informasi tentang kategori pemfilteran konten (kebencian, seksual, kekerasan, self_harm), apakah telah terdeteksi, serta tingkat keparahan (skala very_low, rendah, sedang, tinggi yang menentukan intensitas dan tingkat risiko konten berbahaya) dan apakah telah disaring atau belum. Informasi tentang konten jailbreak dan kata-kata kotor, apakah sudah terdeteksi, dan apakah sudah disaring atau belum. Dan informasi tentang daftar blokir pelanggan, jika sudah disaring dan id-nya.	No
petunjuk_direvisi	string	Prompt yang digunakan untuk menghasilkan gambar, jika ada revisi pada prompt.	No

HasilFilterKontenDasar

Nama	Tipe	Description	Required	Default
filtered	Boolean		Yes

HasilTingkatKeparahanPenyaringanKonten

Nama	Tipe	Description	Required	Default
filtered	Boolean		Yes
severity	string		No

Hasil Deteksi Penyaringan Konten

Nama	Tipe	Description	Required	Default
filtered	Boolean		Yes
detected	Boolean		No

Deteksi Filter Konten dengan Hasil Kutipan

Nama	Tipe	Description	Required	Default
kutipan	objek		No

Properti untuk kutipan

URL

Nama	Tipe	Description	Default
URL	string

lisensi

Nama	Tipe	Description	Default
lisensi	string

dasarHasilPenyaringanKonten

Informasi tentang hasil pemfilteran konten.

Nama	Tipe	Description	Required	Default
sexual	hasil tingkat keparahan penyaring konten		No
violence	hasil tingkat keparahan penyaring konten		No
hate	hasil tingkat keparahan penyaring konten		No
self_harm	hasil tingkat keparahan penyaring konten		No
profanity	contentFilterDetectedResult		No
galat	errorBase		No

contentFilterPromptResults

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

Nama	Tipe	Description	Required	Default
sexual	hasil tingkat keparahan penyaring konten		No
violence	hasil tingkat keparahan penyaring konten		No
hate	hasil tingkat keparahan penyaring konten		No
self_harm	hasil tingkat keparahan penyaring konten		No
profanity	contentFilterDetectedResult		No
galat	errorBase		No
jailbreak	contentFilterDetectedResult		No

hasil pilihan filter konten

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

Nama	Tipe	Description	Required	Default
sexual	hasil tingkat keparahan penyaring konten		No
violence	hasil tingkat keparahan penyaring konten		No
hate	hasil tingkat keparahan penyaring konten		No
self_harm	hasil tingkat keparahan penyaring konten		No
profanity	contentFilterDetectedResult		No
galat	errorBase		No
protected_material_text	contentFilterDetectedResult		No
protected_material_code	KontenTersaringTerdeteksiDenganHasilKutipan		No

hasilPemfilteranPrompt

Hasil pemfilteran konten untuk satu permintaan dalam permintaan.

Nama	Tipe	Description	Required	Default
prompt_index	integer		No
content_filter_results	contentFilterPromptResults	Informasi tentang kategori pemfilteran konten (kebencian, seksual, kekerasan, self_harm), apakah telah terdeteksi, serta tingkat keparahan (skala very_low, rendah, sedang, tinggi yang menentukan intensitas dan tingkat risiko konten berbahaya) dan apakah telah disaring atau belum. Informasi tentang konten jailbreak dan kata-kata kotor, apakah sudah terdeteksi, dan apakah sudah disaring atau belum. Dan informasi tentang daftar blokir pelanggan, jika sudah disaring dan id-nya.	No

promptFilterResults

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

Tidak ada properti yang ditentukan untuk komponen ini.

hasil penyaringan konten dalle

Informasi tentang hasil pemfilteran konten.

Nama	Tipe	Description	Required	Default
sexual	hasil tingkat keparahan penyaring konten		No
violence	hasil tingkat keparahan penyaring konten		No
hate	hasil tingkat keparahan penyaring konten		No
self_harm	hasil tingkat keparahan penyaring konten		No

dalleFilterResults

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

Nama	Tipe	Description	Required	Default
sexual	hasil tingkat keparahan penyaring konten		No
violence	hasil tingkat keparahan penyaring konten		No
hate	hasil tingkat keparahan penyaring konten		No
self_harm	hasil tingkat keparahan penyaring konten		No
profanity	contentFilterDetectedResult		No
jailbreak	contentFilterDetectedResult		No

PermintaanPenyelesaianObrolanUmum

Nama	Tipe	Description	Required	Default
suhu	number	Suhu pengambilan sampel apa yang digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sedangkan 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 probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10 massa probabilitas% teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau temperature tetapi tidak keduanya.	No	1
aliran	Boolean	Jika diatur, delta pesan parsial akan dikirim, seperti di ChatGPT. Token akan dikirim sebagai peristiwa yang dikirim server hanya data saat tersedia, dengan aliran dihentikan oleh data: [DONE] pesan.	No	False
stop	string atau array	Hingga empat urutan di mana API akan berhenti menghasilkan token lebih lanjut.	No
maksimum token	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 untuk mendukung 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 keluaran yang terlihat dan token penalaran.	No
penalti_kehadiran	number	Angka antara -2.0 dan 2.0. Nilai positif menghukum token baru berdasarkan apakah mereka muncul dalam teks sejauh ini, meningkatkan kemungkinan model untuk berbicara tentang topik baru.	No	0
penalti frekuensi	number	Angka antara -2.0 dan 2.0. Nilai positif menghukum token baru berdasarkan frekuensi yang ada dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi baris yang sama kata demi kata.	No	0
logit_bias	objek	Ubah kemungkinan token tertentu muncul dalam penyelesaian. Menerima objek json yang memetakan token (ditentukan oleh ID tokennya di tokenizer) ke nilai bias terkait dari -100 hingga 100. Secara matematis, bias ditambahkan ke logit yang dihasilkan oleh model sebelum pengambilan sampel. Efek pastinya akan bervariasi per model, tetapi nilai antara -1 dan 1 harus menurunkan atau meningkatkan kemungkinan seleksi; Nilai seperti -100 atau 100 harus menghasilkan larangan atau pemilihan 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

buatPermintaanPenyelesaian

Nama	Tipe	Description	Required	Default
minta	string atau array	Prompt 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 perintah tidak ditentukan, model akan dihasilkan seolah-olah dari awal dokumen baru.	Yes
terbaik_dari	integer	Menghasilkan best_of penyelesaian di sisi server dan mengembalikan "terbaik" (yang memiliki probabilitas log tertinggi per token). Hasil tidak dapat dialirkan. Saat digunakan dengan n, best_of mengontrol jumlah penyelesaian kandidat dan n menentukan berapa banyak yang harus dikembalikan - best_of harus lebih besar dari n. Catatan: Karena parameter ini menghasilkan banyak penyelesaian, parameter ini dapat dengan cepat menghabiskan kuota token Anda. Gunakan dengan hati-hati dan pastikan Anda memiliki pengaturan yang wajar untuk max_tokens dan stop.	No	1
Echo	Boolean	Echo kembali prompt selain penyelesaian	No	False
penalti frekuensi	number	Angka antara -2.0 dan 2.0. Nilai positif menghukum token baru berdasarkan frekuensi yang ada dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi baris yang sama kata demi kata.	No	0
logit_bias	objek	Ubah kemungkinan token tertentu muncul dalam penyelesaian. Menerima objek JSON yang memetakan token (ditentukan oleh ID tokennya 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 pastinya akan bervariasi per model, tetapi nilai antara -1 dan 1 harus menurunkan atau meningkatkan kemungkinan seleksi; Nilai seperti -100 atau 100 harus menghasilkan larangan atau pemilihan 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 token keluaran yang logprobs paling mungkin, serta token yang dipilih. Misalnya, jika logprobs 5, API akan mengembalikan daftar lima token yang paling mungkin. API akan selalu mengembalikan logprob token sampel, sehingga mungkin ada elemen dalam logprobs+1 respons. Nilai maksimum untuk logprobs adalah 5.	No	Tidak
maksimum token	integer	Jumlah maksimum token yang dapat dihasilkan dalam penyelesaian. Jumlah token prompt plus max_tokens Anda tidak boleh melebihi panjang konteks model.	No	16
n	integer	Berapa banyak penyelesaian yang harus dihasilkan untuk setiap perintah. Catatan: Karena parameter ini menghasilkan banyak penyelesaian, parameter ini dapat dengan cepat menghabiskan kuota token Anda. Gunakan dengan hati-hati dan pastikan Anda memiliki pengaturan yang wajar untuk max_tokens dan stop.	No	1
penalti_kehadiran	number	Angka antara -2.0 dan 2.0. Nilai positif menghukum token baru berdasarkan apakah mereka 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 mengambil sampel secara deterministik, sehingga permintaan berulang dengan parameter dan parameter yang sama seed 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 ditampilkan tidak akan berisi urutan penghentian.	No
aliran	Boolean	Apakah akan mengalirkan kembali kemajuan parsial. Jika ditetapkan, token akan dikirim sebagai peristiwa yang dikirim server hanya data saat tersedia, dengan aliran dihentikan oleh data: [DONE] pesan.	No	False
Akhiran	string	Akhiran yang muncul setelah selesainya teks yang disisipkan. Parameter ini hanya didukung untuk gpt-3.5-turbo-instruct.	No	Tidak
suhu	number	Suhu pengambilan sampel apa yang digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sedangkan 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 probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10 massa probabilitas% 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 streaming dan non-streaming memiliki bentuk yang sama (tidak seperti titik akhir obrolan).

Nama	Tipe	Description	Required	Default
id	string	Pengidentifikasi unik untuk penyelesaian.	Yes
choices	array	Daftar pilihan penyelesaian yang dihasilkan model untuk prompt input.	Yes
Dibuat	integer	Stempel waktu Unix (dalam detik) saat penyelesaian dibuat.	Yes
model	string	Model yang digunakan untuk penyelesaian.	Yes
prompt_filter_results	promptFilterResults	Hasil pemfilteran konten untuk nol atau lebih permintaan dalam permintaan. Dalam permintaan streaming, hasil untuk petunjuk yang berbeda mungkin tiba pada waktu yang berbeda atau dalam urutan yang berbeda.	No
system_fingerprint	string	Sidik jari ini mewakili konfigurasi backend yang digunakan model untuk berjalan. Dapat digunakan bersama dengan seed parameter permintaan untuk memahami kapan perubahan backend telah dilakukan yang mungkin memengaruhi determinisme.	No
objek	enum	Jenis objek, yang selalu "text_completion" Nilai yang memungkinkan: text_completion	Yes
penggunaan	completionUsage	Statistik penggunaan untuk permintaan penyelesaian.	No

buatPermintaanPenyelesaianChat

Nama	Tipe	Description	Required	Default
suhu	number	Suhu pengambilan sampel apa yang digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sedangkan 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 probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10 massa probabilitas% teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau temperature tetapi tidak keduanya.	No	1
aliran	Boolean	Jika diatur, delta pesan parsial akan dikirim, seperti di ChatGPT. Token akan dikirim sebagai peristiwa yang dikirim server hanya data saat tersedia, dengan aliran dihentikan oleh data: [DONE] pesan.	No	False
stop	string atau array	Hingga empat urutan di mana API akan berhenti menghasilkan token lebih lanjut.	No
maksimum token	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 keluaran yang terlihat dan token penalaran.	No
penalti_kehadiran	number	Angka antara -2.0 dan 2.0. Nilai positif menghukum token baru berdasarkan apakah mereka muncul dalam teks sejauh ini, meningkatkan kemungkinan model untuk berbicara tentang topik baru.	No	0
penalti frekuensi	number	Angka antara -2.0 dan 2.0. Nilai positif menghukum token baru berdasarkan frekuensi yang ada dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi baris yang sama kata demi kata.	No	0
logit_bias	objek	Ubah kemungkinan token tertentu muncul dalam penyelesaian. Menerima objek JSON yang memetakan token (ditentukan oleh ID tokennya di tokenizer) ke nilai bias terkait dari -100 hingga 100. Secara matematis, bias ditambahkan ke logit yang dihasilkan oleh model sebelum pengambilan sampel. Efek pastinya akan bervariasi per model, tetapi nilai antara -1 dan 1 harus menurunkan atau meningkatkan kemungkinan seleksi; Nilai seperti -100 atau 100 harus menghasilkan larangan atau pemilihan 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.	Yes
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 dikembalikan dalam content of message.	No	False
top_logprobs	integer	Bilangan bulat antara 0 dan 20 yang menentukan jumlah token yang paling mungkin 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. Tetap n untuk 1 meminimalkan biaya.	No	1
pemanggilan_alat_paralel	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 sediakan. 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 pesan sistem atau pengguna. Tanpa ini, model dapat menghasilkan aliran spasi kosong yang tak ada habisnya hingga generasi mencapai batas token, menghasilkan permintaan yang berjalan lama dan tampaknya "macet". Perhatikan juga bahwa konten pesan dapat dipotong sebagian jika finish_reason="length", yang menunjukkan generasi terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	No
seed	integer	Fitur ini dalam versi Beta. Jika ditentukan, sistem kami akan melakukan upaya terbaik untuk mengambil sampel secara deterministik, sehingga permintaan berulang dengan parameter dan parameter yang sama seed 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 dapat dipanggil model. Saat ini, hanya fungsi yang didukung sebagai alat. Gunakan ini untuk menyediakan daftar fungsi yang dapat dihasilkan oleh 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 sebagai gantinya menghasilkan pesan. auto berarti model dapat memilih antara membuat pesan atau memanggil satu atau beberapa alat. required berarti model harus memanggil satu atau lebih alat. Menentukan alat tertentu melalui {"type": "function", "function": {"name": "my_function"}} memaksa model untuk memanggil alat tersebut. none adalah default ketika tidak ada alat. auto adalah default jika ada alat.	No
function_call	string atau chatCompletionFunctionCallOption	Tidak digunakan lagi untuk mendukung tool_choice. Mengontrol fungsi mana (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil fungsi dan sebagai ganti 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. auto adalah default jika ada fungsi.	No
functions	array	Tidak digunakan lagi untuk mendukung tools. Daftar fungsi yang dapat dihasilkan oleh model input JSON.	No

chatCompletionFunctions

Nama	Tipe	Description	Required	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.	Yes
parameters	FunctionParameters	Parameter yang diterima fungsi, dijelaskan sebagai objek Skema JSON. Lihat panduan untuk contoh, dan referensi Skema JSON untuk dokumentasi tentang format. Menghilangkan parameters mendefinisikan fungsi dengan daftar parameter kosong.	No

Opsi pemanggilan fungsi penyelesaian obrolan

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

Nama	Tipe	Description	Required	Default
Nama	string	Nama fungsi yang akan dipanggil.	Yes

Pesan Permintaan Penyelesaian Obrolan

Komponen ini dapat berupa salah satu dari berikut ini:

chatCompletionRequestSystemMessage

Nama	Tipe	Description	Required	Default
isi	string atau array	Isi pesan sistem.	Yes
peran	enum	Peran penulis pesan, dalam hal systemini . Nilai yang mungkin: sistem	Yes
Nama	string	Nama opsional untuk peserta. Memberikan informasi model untuk membedakan antara peserta dengan peran yang sama.	No

chatCompletionRequestUserMessage

Nama	Tipe	Description	Required	Default
isi	string atau array	Isi pesan pengguna.	Yes
peran	enum	Peran penulis pesan, dalam hal userini . Nilai yang mungkin: pengguna	Yes
Nama	string	Nama opsional untuk peserta. Memberikan informasi model untuk membedakan antara peserta dengan peran yang sama.	No

chatCompletionRequestAssistantMessage

Nama	Tipe	Description	Required	Default
isi	string atau array	Isi pesan asisten. Diperlukan kecuali atau tool_callsfunction_call ditentukan.	No
refusal	string	Pesan penolakan oleh asisten.	No
peran	enum	Peran penulis pesan, dalam hal assistantini . Nilai yang mungkin: asisten	Yes
Nama	string	Nama opsional untuk peserta. Memberikan 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	objek	Tidak digunakan lagi dan diganti dengan tool_calls. Nama dan argumen fungsi yang harus dipanggil, seperti yang dihasilkan oleh model.	No

Properti untuk function_call

arguments

Nama	Tipe	Description	Default
arguments	string	Argumen untuk memanggil fungsi, 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	Description	Default
Nama	string	Nama fungsi yang akan dipanggil.

chatCompletionRequestToolMessage

Nama	Tipe	Description	Required	Default
peran	enum	Peran penulis pesan, dalam hal toolini . Nilai yang mungkin: alat	Yes
isi	string atau array	Isi pesan alat.	Yes
tool_call_id	string	Panggilan alat yang ditanggapi pesan ini.	Yes

chatCompletionRequestFunctionMessage

Nama	Tipe	Description	Required	Default
peran	enum	Peran penulis pesan, dalam hal functionini . Nilai yang mungkin: fungsi	Yes
isi	string	Isi pesan fungsi.	Yes
Nama	string	Nama fungsi yang akan dipanggil.	Yes

BagianKontenPesanSistemPermintaanPenyelesaianObrolan

Komponen ini dapat berupa salah satu dari berikut ini:

BagianKontenPesanPenggunaPermintaanPenyelesaianObrolan

Komponen ini dapat berupa salah satu dari berikut ini:

PermintaanKompletasiPesanBagianKontenAsistenChat

Komponen ini dapat berupa salah satu dari berikut ini:

AlatPesanKontenPermintaanPenyelesaianChat

Komponen ini dapat berupa salah satu dari berikut ini:

chatCompletionRequestMessageContentPartText

Nama	Tipe	Description	Required	Default
jenis	enum	Jenis bagian konten. Nilai yang memungkinkan: teks	Yes
kirim pesan teks	string	Konten teks.	Yes

chatCompletionRequestMessageContentPartImage

Nama	Tipe	Description	Required	Default
jenis	enum	Jenis bagian konten. Nilai yang memungkinkan: image_url	Yes
image_url	objek		Yes

Properti untuk image_url

Url

Nama	Tipe	Description	Default
Url	string	Baik URL gambar atau data gambar yang dikodekan base64.

detail

Nama	Tipe	Description	Default
detail	string	Menentukan tingkat detail gambar. Pelajari lebih lanjut di panduan Vision.	auto

chatCompletionRequestMessageContentPartRefusal

Nama	Tipe	Description	Required	Default
jenis	enum	Jenis bagian konten. Nilai yang mungkin: penolakan	Yes
refusal	string	Pesan penolakan yang dihasilkan oleh model.	Yes

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	Description	Required	Default
jenis	azureChatExtensionType	Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh obrolan penyelesaian yang harus menggunakan ekstensi obrolan Azure OpenAI untuk menambah perilaku respons. Penggunaan konfigurasi ini hanya kompatibel dengan Azure OpenAI.	Yes

azureChatExtensionType

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.

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

Jenis: teks

Default:

Nama Enum: AzureChatExtensionType

Nilai Enum:

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

azureSearchChatExtensionConfiguration

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

Nama	Tipe	Description	Required	Default
jenis	azureChatExtensionType	Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh obrolan penyelesaian yang harus menggunakan ekstensi obrolan Azure OpenAI untuk menambah perilaku respons. Penggunaan konfigurasi ini hanya kompatibel dengan Azure OpenAI.	Yes
parameters	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	Description	Required	Default
autentikasi	onYourDataApiKeyAuthenticationOptions atau onYourDataSystemAssignedManagedIdentityAuthenticationOptions atau onYourDataUserAssignedManagedIdentityAuthenticationOptions		Yes
top_n_documents	integer	Jumlah dokumen teratas yang dikonfigurasi untuk ditampilkan untuk kueri yang dikonfigurasi.	No
dalam cakupan	Boolean	Apakah kueri harus dibatasi untuk penggunaan data yang diindeks.	No
keketatan	integer	Ketegasan pemfilteran relevansi pencarian yang dikonfigurasi. Semakin tinggi ketegasan, semakin tinggi presisi tetapi lebih rendah ingatan jawabannya.	No
informasi_peran	string	Berikan instruksi model tentang bagaimana seharusnya berperilaku dan konteks apa pun yang harus direferensikan saat menghasilkan respons. Anda dapat menggambarkan kepribadian asisten dan memberitahunya cara memformat tanggapan. Ada batas 100 token untuk itu, dan itu dihitung terhadap batas token keseluruhan.	No
titik akhir	string	Jalur titik akhir absolut untuk sumber daya Azure Search yang akan digunakan.	Yes
nama indeks	string	Nama indeks yang akan digunakan seperti yang tersedia di sumber daya Azure Search yang direferensikan.	Yes
pemetaan_bidang	Opsi Pemetaan Bidang Indeks AzureSearch	Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Azure Search yang dikonfigurasi.	No
tipe_kueri	azureSearchQueryType	Jenis kueri pengambilan Azure Search yang harus dijalankan saat menggunakannya sebagai ekstensi obrolan Azure OpenAI.	No
konfigurasi semantik	string	Konfigurasi semantik tambahan untuk kueri.	No
filter	string	Filter pencarian.	No
ketergantungan_penyematan	onYourDataEndpointVectorizationSource atau onYourDataDeploymentNameVectorizationSource		No

Opsi Pemetaan Bidang Indeks AzureSearch

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

Nama	Tipe	Description	Required	Default
bidang_judul	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 filepath.	No
bidang_konten	array	Nama bidang indeks yang harus diperlakukan sebagai konten.	No
pemisah_bidang_konten	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 Pencarian Azure yang harus dijalankan saat menggunakannya sebagai ekstensi obrolan OpenAI Azure.

Jenis: teks

Default:

Nama Enum: AzureSearchQueryType

Nilai Enum:

Nilai	Description
simple	Mewakili pengurai kueri sederhana default.
Semantik	Mewakili pengurai kueri semantik untuk pemodelan semantik tingkat lanjut.
vektor	Mewakili pencarian vektor di atas data yang dihitung.
vektor_sederhana_hibrid	Mewakili kombinasi strategi kueri sederhana dengan data vektor.
vektor_semantik_hibrida	Mewakili kombinasi pencarian semantik dan kueri data vektor.

azureCosmosDBChatExtensionConfiguration

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

Nama	Tipe	Description	Required	Default
jenis	azureChatExtensionType	Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh obrolan penyelesaian yang harus menggunakan ekstensi obrolan Azure OpenAI untuk menambah perilaku respons. Penggunaan konfigurasi ini hanya kompatibel dengan Azure OpenAI.	Yes
parameters	azureCosmosDBChatExtensionParameters	Parameter yang akan digunakan saat mengonfigurasi ekstensi obrolan Azure OpenAI On Your Data saat menggunakan Azure Cosmos DB untuk MongoDB vCore.	No

azureCosmosDBChatExtensionParameters

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

Nama	Tipe	Description	Required	Default
autentikasi	padaOpsiOtentikasiStringKoneksiDataAnda	Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan string koneksi.	Yes
top_n_documents	integer	Jumlah dokumen teratas yang dikonfigurasi untuk ditampilkan untuk kueri yang dikonfigurasi.	No
dalam cakupan	Boolean	Apakah kueri harus dibatasi untuk penggunaan data yang diindeks.	No
keketatan	integer	Ketegasan pemfilteran relevansi pencarian yang dikonfigurasi. Semakin tinggi ketegasan, semakin tinggi presisi tetapi lebih rendah ingatan jawabannya.	No
informasi_peran	string	Berikan instruksi model tentang bagaimana seharusnya berperilaku dan konteks apa pun yang harus direferensikan saat menghasilkan respons. Anda dapat menggambarkan kepribadian asisten dan memberitahunya cara memformat tanggapan. Ada batas 100 token untuk itu, dan itu dihitung terhadap batas token keseluruhan.	No
database_name	string	Nama database MongoDB vCore untuk digunakan dengan Azure Cosmos DB.	Yes
nama_kontainer	string	Nama kontainer sumber daya Azure Cosmos DB.	Yes
nama indeks	string	Nama indeks MongoDB vCore untuk digunakan dengan Azure Cosmos DB.	Yes
pemetaan_bidang	azureCosmosDBFieldMappingOptions	Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Azure Cosmos DB yang dikonfigurasi.	Yes
ketergantungan_penyematan	onYourDataEndpointVectorizationSource atau onYourDataDeploymentNameVectorizationSource		Yes

azureCosmosDBFieldMappingOptions

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

Nama	Tipe	Description	Required	Default
bidang_judul	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 filepath.	No
bidang_konten	array	Nama bidang indeks yang harus diperlakukan sebagai konten.	Yes
pemisah_bidang_konten	string	Pola pemisah yang harus digunakan bidang konten.	No
vector_fields	array	Nama bidang yang mewakili data vektor.	Yes

Pilihan Otorisasi Data Anda

Opsi autentikasi untuk Azure OpenAI Pada Data Anda.

Nama	Tipe	Description	Required	Default
jenis	padaTipeOtentikasiDataAnda	Jenis autentikasi yang didukung dengan Azure OpenAI Pada Data Anda.	Yes

padaTipeOtentikasiDataAnda

Jenis autentikasi yang didukung dengan Azure OpenAI Pada Data Anda.

Deskripsi: Jenis autentikasi yang didukung dengan Azure OpenAI Pada Data Anda.

Jenis: teks

Default:

Nama Enum: OnYourDataAuthenticationType

Nilai Enum:

Nilai	Description
kunci_api	Autentikasi melalui kunci API.
connection_string	Otentikasi melalui string koneksi.
sistem_identitas_terkelola_ditetapkan	Autentikasi melalui identitas terkelola yang ditetapkan sistem.
identitas_terkelola_yang_ditugaskan_pada_pengguna	Autentikasi melalui identitas terkelola yang ditetapkan pengguna.

OpsiOtentikasiKunciApiDataAnda

Opsi autentikasi untuk Azure OpenAI Pada Data Anda saat menggunakan kunci API.

Nama	Tipe	Description	Required	Default
jenis	padaTipeOtentikasiDataAnda	Jenis autentikasi yang didukung dengan Azure OpenAI Pada Data Anda.	Yes
kunci	string	Kunci API yang akan digunakan untuk autentikasi.	No

padaOpsiOtentikasiStringKoneksiDataAnda

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

Nama	Tipe	Description	Required	Default
jenis	padaTipeOtentikasiDataAnda	Jenis autentikasi yang didukung dengan Azure OpenAI Pada Data Anda.	Yes
connection_string	string	string koneksi yang akan digunakan untuk autentikasi.	No

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

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

Nama	Tipe	Description	Required	Default
jenis	padaTipeOtentikasiDataAnda	Jenis autentikasi yang didukung dengan Azure OpenAI Pada Data Anda.	Yes

onYourDataUserAssignedManagedIdentityAuthenticationOptions

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

Nama	Tipe	Description	Required	Default
jenis	padaTipeOtentikasiDataAnda	Jenis autentikasi yang didukung dengan Azure OpenAI Pada Data Anda.	Yes
managed_identity_resource_id	string	ID sumber daya dari identitas terkelola yang ditetapkan pengguna untuk digunakan untuk autentikasi.	No

Source PemvektoranDataAnda

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

Nama	Tipe	Description	Required	Default
jenis	padaTipeSumberVektorisasiDataAnda	Mewakili sumber yang tersedia yang dapat digunakan Azure OpenAI On Your Data untuk mengonfigurasi vektorisasi data untuk digunakan dengan pencarian vektor.	Yes

padaTipeSumberVektorisasiDataAnda

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

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

Jenis: teks

Default:

Nama Enum: OnYourDataVectorizationSourceType

Nilai Enum:

Nilai	Description
titik akhir	Mewakili vektorisasi yang dilakukan oleh panggilan layanan publik ke model penyematan Azure OpenAI.
nama_penerapan	Mewakili nama penyebaran model Ada yang akan 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 panggilan publik, yang memungkinkan vektor Cari bahkan di jaringan pribadi.

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	Description	Required	Default
jenis	padaTipeSumberVektorisasiDataAnda	Mewakili sumber yang tersedia yang dapat digunakan Azure OpenAI On Your Data untuk mengonfigurasi vektorisasi data untuk digunakan dengan pencarian vektor.	Yes
nama_penerapan	string	Menentukan nama penyebaran model yang akan digunakan untuk vektorisasi. Penyebaran model ini harus berada di sumber daya Azure OpenAI yang sama, tetapi On Your Data akan menggunakan penyebaran model ini melalui panggilan internal daripada panggilan publik, yang memungkinkan pencarian vektor bahkan di jaringan pribadi.	No

SumberVektorisasiTitikAkhirDataAnda

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

Nama	Tipe	Description	Required	Default
jenis	padaTipeSumberVektorisasiDataAnda	Mewakili sumber yang tersedia yang dapat digunakan Azure OpenAI On Your Data untuk mengonfigurasi vektorisasi data untuk digunakan dengan pencarian vektor.	Yes
autentikasi	OpsiOtentikasiKunciApiDataAnda	Opsi autentikasi untuk Azure OpenAI Pada Data Anda 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 On Your Data akan menggunakan titik akhir ini melalui panggilan internal daripada panggilan publik, yang memungkinkan pencarian vektor bahkan di jaringan pribadi.	No

KonteksPesanEkstensiAzureChat

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

Nama	Tipe	Description	Required	Default
citations	array	Hasil pengambilan sumber data, digunakan untuk menghasilkan pesan asisten dalam respons.	No
niat	string	Maksud yang terdeteksi dari riwayat obrolan, digunakan untuk beralih ke giliran berikutnya untuk meneruskan konteks.	No

kutipan

informasi kutipan untuk pesan respons penyelesaian obrolan.

Nama	Tipe	Description	Required	Default
isi	string	Isi kutipan.	Yes
title	string	Judul kutipan.	No
Url	string	URL kutipan.	No
jalur file	string	Jalur file kutipan.	No
chunk_id	string	ID potongan kutipan.	No

PanggilanAlatPesanSelesaiObrolan

Nama	Tipe	Description	Required	Default
id	string	ID panggilan alat.	Yes
jenis	toolCallType	Jenis panggilan alat, dalam hal functionini .	Yes
fungsi	objek	Fungsi yang dipanggil model.	Yes

Properti untuk fungsi

Nama

Nama	Tipe	Description	Default
Nama	string	Nama fungsi yang akan dipanggil.

arguments

Nama	Tipe	Description	Default
arguments	string	Argumen untuk memanggil fungsi, 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: teks

Default:

Nama Enum: ToolCallType

Nilai Enum:

Nilai	Description
fungsi	Jenis panggilan alat adalah fungsi.

chatCompletionRequestMessageTool

Nama	Tipe	Description	Required	Default
tool_call_id	string	Panggilan alat yang ditanggapi pesan ini.	No
isi	string	Isi pesan.	No

fungsi pesan permintaan penyelesaian obrolan

Nama	Tipe	Description	Required	Default
peran	enum	Peran penulis pesan, dalam hal functionini . Nilai yang mungkin: fungsi	No
Nama	string	Isi pesan.	No
isi	string	Isi pesan.	No

createChatCompletionResponse

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

Nama	Tipe	Description	Required	Default
id	string	Pengidentifikasi unik untuk penyelesaian obrolan.	Yes
prompt_filter_results	promptFilterResults	Hasil pemfilteran konten untuk nol atau lebih permintaan dalam permintaan. Dalam permintaan streaming, hasil untuk petunjuk yang berbeda mungkin tiba pada waktu yang berbeda atau dalam urutan yang berbeda.	No
choices	array	Daftar pilihan penyelesaian obrolan. Bisa lebih dari satu jika n lebih besar dari 1.	Yes
Dibuat	integer	Stempel waktu Unix (dalam detik) saat penyelesaian obrolan dibuat.	Yes
model	string	Model yang digunakan untuk penyelesaian obrolan.	Yes
system_fingerprint	string	Sidik jari ini mewakili konfigurasi backend yang digunakan model untuk berjalan. Dapat digunakan bersama dengan seed parameter permintaan untuk memahami kapan perubahan backend telah dilakukan yang mungkin memengaruhi determinisme.	No
objek	enum	Jenis objek, yang selalu chat.completion. Nilai yang memungkinkan: chat.completion	Yes
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	Description	Required	Default
id	string	Pengidentifikasi unik untuk penyelesaian obrolan. Setiap potongan memiliki ID yang sama.	Yes
choices	array	Daftar pilihan penyelesaian obrolan. Dapat berisi lebih dari satu elemen jika n lebih besar dari 1.	Yes
Dibuat	integer	Stempel waktu Unix (dalam detik) saat penyelesaian obrolan dibuat. Setiap potongan memiliki stempel waktu yang sama.	Yes
model	string	Model untuk menghasilkan penyelesaian.	Yes
system_fingerprint	string	Sidik jari ini mewakili konfigurasi backend yang digunakan model untuk berjalan. Dapat digunakan bersama dengan seed parameter permintaan untuk memahami kapan perubahan backend telah dilakukan yang mungkin memengaruhi determinisme.	No
objek	enum	Jenis objek, yang selalu chat.completion.chunk. Nilai yang memungkinkan: chat.completion.chunk	Yes

chatCompletionStreamResponseDelta

Delta penyelesaian chat yang dihasilkan oleh respons model streaming.

Nama	Tipe	Description	Required	Default
isi	string	Isi pesan potongan.	No
function_call	objek	Tidak digunakan lagi dan diganti dengan tool_calls. Nama dan argumen fungsi yang harus dipanggil, seperti yang dihasilkan oleh model.	No
tool_calls	array		No
peran	enum	Peran penulis pesan ini. Nilai yang mungkin: sistem, pengguna, asisten, alat	No
refusal	string	Pesan penolakan yang dihasilkan oleh model.	No

Properti untuk function_call

arguments

Nama	Tipe	Description	Default
arguments	string	Argumen untuk memanggil fungsi, 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	Description	Default
Nama	string	Nama fungsi yang akan dipanggil.

kolomAlatPanggilanPesanPenyelesaianChat

Nama	Tipe	Description	Required	Default
indeks	integer		Yes
id	string	ID panggilan alat.	No
jenis	enum	Jenis alat. Saat ini, hanya function didukung. Nilai yang mungkin: fungsi	No
fungsi	objek		No

Properti untuk fungsi

Nama

Nama	Tipe	Description	Default
Nama	string	Nama fungsi yang akan dipanggil.

arguments

Nama	Tipe	Description	Default
arguments	string	Argumen untuk memanggil fungsi, 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. Atur ini hanya saat Anda mengatur stream: true.

Nama	Tipe	Description	Required	Default
include_usage	Boolean	Jika ditetapkan, potongan tambahan akan dialirkan sebelum data: [DONE] pesan. Bidang usage pada potongan ini menunjukkan statistik penggunaan token untuk seluruh permintaan, dan choices bidang akan selalu menjadi array kosong. Semua potongan lainnya juga akan menyertakan bidang usage , tetapi dengan nilai null.	No

chatCompletionChoiceLogProbs

Log informasi probabilitas untuk pilihan.

Nama	Tipe	Description	Required	Default
isi	array	Daftar token konten pesan dengan informasi probabilitas log.	Yes
refusal	array	Daftar token penolakan pesan dengan informasi probabilitas log.	No

chatCompletionTokenLogprob

Nama	Tipe	Description	Required	Default
token	string	Token tersebut.	Yes
logprob	number	Probabilitas log token ini.	Yes
Byte	array	Daftar bilangan bulat yang mewakili representasi token byte UTF-8. Berguna dalam kasus di mana karakter diwakili oleh beberapa token dan representasi bytenya harus digabungkan untuk menghasilkan representasi teks yang benar. Bisa jika null tidak ada representasi byte untuk token.	Yes
top_logprobs	array	Daftar token yang paling mungkin dan probabilitas lognya, pada posisi token ini. Dalam kasus yang jarang terjadi, mungkin ada lebih sedikit dari jumlah yang diminta top_logprobs kembali.	Yes

pesanTanggapanPenyelesaianChat

Pesan penyelesaian obrolan yang dihasilkan oleh model.

Nama	Tipe	Description	Required	Default
peran	chatCompletionResponseMessageRole	Peran penulis pesan tanggapan.	Yes
refusal	string	Pesan penolakan yang dihasilkan oleh model.	Yes
isi	string	Isi pesan.	Yes
tool_calls	array	Panggilan alat yang dihasilkan oleh model, seperti panggilan fungsi.	No
function_call	chatCompletionFunctionCall	Tidak digunakan lagi dan diganti dengan 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 pembuatan 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 tanggapan.

Deskripsi: Peran penulis pesan respons.

Jenis: teks

Default:

Nilai Enum:

• asisten

chatCompletionToolChoiceOption

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

Komponen ini dapat berupa salah satu dari berikut ini:

chatCompletionNamedToolChoice

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

Nama	Tipe	Description	Required	Default
jenis	enum	Jenis alat. Saat ini, hanya function didukung. Nilai yang mungkin: fungsi	Yes
fungsi	objek		Yes

Properti untuk fungsi

Nama

Nama	Tipe	Description	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 diganti dengan tool_calls. Nama dan argumen fungsi yang harus dipanggil, seperti yang dihasilkan oleh model.

Nama	Tipe	Description	Required	Default
Nama	string	Nama fungsi yang akan dipanggil.	Yes
arguments	string	Argumen untuk memanggil fungsi, 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.	Yes

completionUsage

Statistik penggunaan untuk permintaan penyelesaian.

Nama	Tipe	Description	Required	Default
prompt_tokens	integer	Jumlah token dalam prompt.	Yes
completion_tokens	integer	Jumlah token dalam penyelesaian yang dihasilkan.	Yes
total_tokens	integer	Jumlah total token yang digunakan dalam permintaan (prompt + penyelesaian).	Yes
completion_tokens_details	objek	Perincian token yang digunakan dalam penyelesaian.	No

Properti untuk completion_tokens_details

token_penalaran

Nama	Tipe	Description	Default
token_penalaran	integer	Token yang dihasilkan oleh model untuk penalaran.

chatCompletionTool

Nama	Tipe	Description	Required	Default
jenis	enum	Jenis alat. Saat ini, hanya function didukung. Nilai yang mungkin: fungsi	Yes
fungsi	FunctionObject		Yes

FunctionParameters

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

Menghilangkan parameters mendefinisikan fungsi dengan daftar parameter kosong.

Tidak ada properti yang ditentukan untuk komponen ini.

FunctionObject

Nama	Tipe	Description	Required	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.	Yes
parameters	FunctionParameters	Parameter yang diterima fungsi, dijelaskan sebagai objek Skema JSON. Lihat panduan untuk contoh, dan referensi Skema JSON untuk dokumentasi tentang format. Menghilangkan parameters mendefinisikan fungsi dengan daftar parameter kosong.	No
tegas	Boolean	Apakah akan mengaktifkan kepatuhan skema yang ketat saat membuat 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 .true	No	False

ResponseFormatText

Nama	Tipe	Description	Required	Default
jenis	enum	Jenis format respons yang ditentukan: text Nilai yang memungkinkan: teks	Yes

FormatTanggapanJsonObject

Nama	Tipe	Description	Required	Default
jenis	enum	Jenis format respons yang ditentukan: json_object Nilai yang mungkin: json_object	Yes

ResponseFormatJsonSchemaSkema

Skema untuk format respons, digambarkan sebagai objek Skema JSON.

Tidak ada properti yang ditentukan untuk komponen ini.

ResponseFormatJsonSchema

Nama	Tipe	Description	Required	Default
jenis	enum	Jenis format respons yang ditentukan: json_schema Nilai yang memungkinkan: json_schema	Yes
json_schema	objek		Yes

Properti untuk json_schema

description

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

Nama

Nama	Tipe	Description	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	Description	Default
skema	ResponseFormatJsonSchema	Skema untuk format respons, digambarkan sebagai objek Skema JSON.

tegas

Nama	Tipe	Description	Default
tegas	Boolean	Apakah akan mengaktifkan kepatuhan skema yang ketat saat menghasilkan output. Jika diatur ke true, model akan selalu mengikuti skema persis yang ditentukan di schema bidang. Hanya subset Skema JSON yang didukung saat strict .true	False

pilihanPenyelesaianChatUmum

Nama	Tipe	Description	Required	Default
indeks	integer		No
alasan_selesai	string		No

buatPermintaanTerjemahan

Permintaan terjemahan.

Nama	Tipe	Description	Required	Default
berkas	string	File audio yang akan diterjemahkan.	Yes
minta	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, sedangkan 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 tercapai.	No	0

audioResponse

Respons terjemahan atau transkripsi ketika response_format adalah json

Nama	Tipe	Description	Required	Default
kirim pesan teks	string	Teks yang diterjemahkan atau ditranskripsi.	Yes

audioVerboseResponse

Respons terjemahan atau transkripsi saat response_format verbose_json

Nama	Tipe	Description	Required	Default
kirim pesan teks	string	Teks yang diterjemahkan atau ditranskripsi.	Yes
tugas	string	Jenis tugas audio.	No
bahasa	string	Bahasa.	No
duration	number	Durasi.	No
segments	array		No

audioResponseFormat

Menentukan format output.

Deskripsi: Menentukan format output.

Jenis: teks

Default:

Nilai Enum:

• json
• kirim pesan teks
• SRT
• verbose_json
• vtt

buatPermintaanTranskripsi

Permintaan transkripsi.

Nama	Tipe	Description	Required	Default
berkas	string	Objek file audio untuk ditranskripsikan.	Yes
minta	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Perintah harus sesuai 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, sedangkan 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 tercapai.	No	0
bahasa	string	Bahasa audio input. Memasok bahasa input dalam format ISO-639-1 akan meningkatkan akurasi dan latensi.	No

audioSegment

Segmen transkripsi atau terjemahan.

Nama	Tipe	Description	Required	Default
id	integer	Pengidentifikasi segmen.	No
seek	number	Offset segmen.	No
mulai	number	Offset awal segmen.	No
akhir	number	Offset akhir segmen.	No
kirim pesan teks	string	Teks segmentasi.	No
tokens	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: teks

Default: standar

Nama Enum: Kualitas

Nilai Enum:

Nilai	Description
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 ditampilkan.

Jenis: teks

Default: url

Nama Enum: ImagesResponseFormat

Nilai Enum:

Nilai	Description
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: teks

Default: 1024x1024

Nama Enum: Ukuran

Nilai Enum:

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

imageStyle

Gaya gambar yang dihasilkan.

Deskripsi: Gaya gambar yang dihasilkan.

Jenis: teks

Default: vivid

Nama Enum: Gaya

Nilai Enum:

Nilai	Description
Jelas	Vivid menciptakan gambar yang hiper-realistis dan dramatis.
alami	Natural menciptakan gambar yang lebih alami dan kurang hiper-realistis.

permintaanPembuatanGambar

Nama	Tipe	Description	Required	Default
minta	string	Deskripsi teks dari gambar yang diinginkan. Panjang maksimum adalah 4.000 karakter.	Yes
n	integer	Jumlah gambar yang akan dihasilkan.	No	1
size	imageSize	Ukuran gambar yang dihasilkan.	No	1024x1024
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	Description	Required	Default
Dibuat	integer	Stempel waktu unix saat operasi dibuat.	Yes
data	array	Data hasil operasi, jika berhasil	Yes

hasilGambar

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

Nama	Tipe	Description	Required	Default
Url	string	URL gambar.	No
b64_json	string	Gambar yang dikodekan base64	No
content_filter_results	dalleContentFilterResults	Informasi tentang hasil pemfilteran konten.	No
petunjuk_direvisi	string	Prompt yang digunakan untuk menghasilkan gambar, jika ada revisi pada prompt.	No
prompt_filter_results	dalleFilterResults	Informasi tentang kategori pemfilteran konten (kebencian, seksual, kekerasan, self_harm), apakah telah terdeteksi, serta tingkat keparahan (skala very_low, rendah, sedang, tinggi yang menentukan intensitas dan tingkat risiko konten berbahaya) dan apakah telah disaring atau belum. Informasi tentang konten jailbreak dan kata-kata kotor, apakah sudah terdeteksi, dan apakah sudah disaring atau belum. Dan informasi tentang daftar blokir pelanggan, jika sudah disaring dan id-nya.	No

Ekstensi penyelesaian otomatis

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

Pesan Obrolan

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

Teks ke ucapan (Pratinjau)

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

Langkah berikutnya

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