Azure OpenAI dalam referensi pratinjau REST API Model Microsoft Foundry

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

Spesifikasi API

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

• Pesawat pengendali
• Bidang data - penulisan
• Bidang data - inferensi

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

Penting

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

API	Rilis pratinjau terbaru	Rilis GA terbaru	Spesifikasi	Deskripsi
Sarana kontrol	2025-07-01-preview	2025-06-01	Spec	API sarana kontrol digunakan untuk operasi seperti membuat sumber daya, penyebaran model, dan tugas manajemen sumber daya tingkat lebih tinggi lainnya. Sarana kontrol juga mengatur apa yang mungkin to do dengan kemampuan seperti Azure Resource Manager, Bicep, Terraform, dan Azure CLI.
Bidang data	v1 preview	v1	Spec	API lapisan data mengontrol operasi inferensi dan penyusunan.

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 menyediakan 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 header Authorization. Nilai token yang diberikan harus didahului dengan Bearer, contohnya Bearer YOUR_AUTH_TOKEN. Anda dapat membaca panduan cara kami tentang authenticating dengan Microsoft Entra ID.

Pemversionan REST API

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

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

Inferensi bidang data

Artikel lainnya mencakup rilis pratinjau 2025-04-01-preview dari spesifikasi inferensi bidang data OpenAI Azure.

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

Penyelesaian - Buat

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

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

Parameter URI

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

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Content-Type: application/json

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

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	createCompletionResponse

Kode Status: default

Deskripsi: Layanan tidak tersedia

Content-Type	Jenis	Deskripsi
application/json	errorResponse

Contoh

Contoh

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

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

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

Respons: Kode Status: 200

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

Penyematan - Buat

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

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

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
ID penempatan	path	Yes	string	Id penyebaran dari model yang telah diterapkan.
versi-API	kueri	Yes	string

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Content-Type: application/json

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

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	objek

Contoh

Contoh

Kembalikan penyematan untuk prompt tertentu.

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

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

Respons: Kode Status: 200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0020113448
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

Penyelesaian obrolan - Buat

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

Membuat penyelesaian untuk pesan obrolan

Parameter URI

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

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
audio	objek	Parameter untuk output audio. Diperlukan saat output audio diminta dengan modalities: ["audio"].	Tidak.
└─ bentuk	enum	Menentukan format audio output. Harus salah satu dari wav, mp3, flac, opus, atau pcm16. Nilai yang mungkin: wav, , mp3flac, opus,pcm16	Tidak.
└─ suara	enum	Menentukan jenis suara. Suara yang didukung adalah alloy, echo, fable, onyx, nova, dan shimmer. Nilai yang mungkin: alloy, , echofable, onyx, nova,shimmer	Tidak.
data_sources	array	Entri konfigurasi untuk Azure ekstensi obrolan OpenAI yang menggunakannya. Spesifikasi tambahan ini hanya kompatibel dengan Azure OpenAI.	Tidak.
penalti frekuensi	nomor/angka	Angka antara -2,0 dan 2,0. Nilai positif memberi penalti pada token baru berdasarkan frekuensi kemunculannya dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi secara persis kalimat yang sama.	Tidak.	0
function_call	teks atau chatCompletionFunctionCallOption	Diganti untuk tool_choice. Mengontrol mana fungsi (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil fungsi dan sebaliknya menghasilkan pesan. auto berarti model dapat memilih antara menghasilkan pesan atau memanggil fungsi. Menentukan fungsi tertentu melalui {"name": "my_function"} memaksa model untuk memanggil fungsi tersebut. none adalah default ketika tidak ada fungsi yang ada. auto adalah default jika fungsi ada.	Tidak.
functions	array	Diganti untuk tools. Daftar fungsi yang digunakan model dapat menghasilkan input JSON.	Tidak.
logit_bias	objek	Ubah kemungkinan token tertentu muncul dalam penyelesaian. Menerima objek JSON yang memetakan token (ditentukan oleh ID token mereka di tokenizer) ke nilai bias terkait dari -100 hingga 100. Secara matematis, bias ditambahkan ke logit yang dihasilkan oleh model sebelum pengambilan sampel. Efek yang tepat bervariasi per model, tetapi nilai antara -1 dan 1 harus mengurangi atau meningkatkan kemungkinan pemilihan; nilai seperti -100 atau 100 harus menghasilkan larangan atau pilihan eksklusif dari token yang relevan.	Tidak.	Tidak ada
logprobs	Boolean	Apakah akan mengembalikan probabilitas log dari token output atau tidak. Jika benar, mengembalikan probabilitas logaritmik dari setiap token keluaran yang dikembalikan di content dari message.	Tidak.	False
max_completion_tokens	bilangan bulat	Batas atas untuk jumlah token yang dapat dihasilkan untuk penyelesaian, termasuk token output yang terlihat dan token penalaran.	Tidak.
maksimum token	bilangan bulat	Jumlah maksimum token yang dapat dihasilkan dalam penyelesaian obrolan. Panjang total token input dan token yang dihasilkan dibatasi oleh panjang konteks model.	Tidak.
messages	array	Daftar pesan yang terdiri dari percakapan sejauh ini. Contoh kode Python.	Yes
metadata	objek	Tag dan nilai yang ditentukan pengembang yang digunakan untuk memfilter penyelesaian di dasbor penyelesaian yang disimpan.	Tidak.
Modalitas	ChatCompletionModalities	Jenis output yang Anda inginkan untuk dihasilkan model untuk permintaan ini. Sebagian besar model mampu menghasilkan teks, yang merupakan default: ["text"] Model ini gpt-4o-audio-preview juga dapat digunakan untuk menghasilkan audio. Untuk meminta agar model ini menghasilkan respons teks dan audio, Anda dapat menggunakan: ["text", "audio"]	Tidak.
n	bilangan bulat	Berapa banyak pilihan penyelesaian obrolan yang akan dihasilkan untuk setiap pesan input. Anda akan dikenakan biaya berdasarkan jumlah token yang dihasilkan di semua pilihan. Pertahankan n sebagai 1 untuk meminimalkan biaya.	Tidak.	1
pemanggilan_alat_paralel	ParallelToolCalls	Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.	Tidak.	Benar
prediksi	PredictionContent	Konfigurasi untuk Output Yang Diprediksi, yang dapat sangat meningkatkan waktu respons ketika sebagian besar respons model diketahui sebelumnya. Ini paling umum ketika Anda meregenerasi file hanya dengan perubahan kecil pada sebagian besar konten.	Tidak.
presence_penalty (penalti kehadiran)	nomor/angka	Angka antara -2,0 dan 2,0. Nilai positif memberikan penalti pada token baru berdasarkan kemunculannya dalam teks sejauh ini, meningkatkan kemungkinan model berbicara tentang topik baru.	Tidak.	0
upaya penalaran	enum	model o1 saja Membatasi upaya penalaran untuk model penalaran. Nilai yang saat ini didukung adalah low, medium, dan high. Mengurangi upaya penalaran dapat mengakibatkan respons yang lebih cepat dan lebih sedikit token yang digunakan pada penalaran dalam respons. Nilai yang mungkin: low, medium, high	Tidak.
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 lebih baru dari gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_schema", "json_schema": {...} } mengaktifkan Output Terstruktur, yang menjamin model cocok dengan skema JSON yang Anda berikan. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang menjamin pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan deretan ruang kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berlangsung lama dan tampak "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	Tidak.
seed	bilangan bulat	Fitur ini ada di Beta. Jika ditentukan, sistem kami melakukan upaya terbaik untuk melakukan sampling secara deterministik, sehingga permintaan berulang dengan seed dan parameter yang sama harus mengembalikan hasil yang sama. Determinisme tidak dijamin, dan Anda harus merujuk ke system_fingerprint parameter respons untuk memantau perubahan di backend.	Tidak.
stop	string atau array	Hingga 4 urutan di mana API berhenti menghasilkan token lebih lanjut.	Tidak.
simpan	Boolean	Apakah menyimpan output permintaan penyelesaian obrolan ini untuk digunakan dalam distilasi model atau produk evaluasi kami atau tidak.	Tidak.
aliran	Boolean	Jika diatur, delta pesan parsial dikirim, seperti di ChatGPT. Token dikirim sebagai peristiwa yang dikirim server khusus data saat tersedia, dengan aliran dihentikan oleh pesan data: [DONE] . Contoh kode Python.	Tidak.	False
stream_options	chatCompletionStreamOptions	Opsi untuk respons streaming. Hanya atur ini saat Anda mengatur stream: true.	Tidak.	Tidak ada
suhu	nomor/angka	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 membuatnya lebih fokus dan deterministik. Kami umumnya merekomendasikan untuk memodifikasi ini atau top_p tetapi tidak keduanya.	Tidak.	1
tool_choice	chatCompletionToolChoiceOption	Mengontrol alat mana (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil alat apa pun dan sebaliknya menghasilkan pesan. auto berarti model dapat memilih antara menghasilkan pesan atau memanggil satu atau beberapa alat. required berarti model harus memanggil satu atau beberapa alat. Menentukan alat tertentu melalui {"type": "function", "function": {"name": "my_function"}} memaksa model untuk memanggil alat tersebut. none adalah default ketika tidak ada alat yang ada. auto adalah default jika alat ada.	Tidak.
perangkat	array	Daftar alat yang mungkin dipanggil model. Saat ini, hanya fungsi yang ditunjang sebagai sarana. Gunakan ini untuk menyediakan daftar fungsi untuk model yang dapat menghasilkan input JSON. Maksimal 128 fungsi didukung.	Tidak.
top_logprobs	bilangan bulat	Bilangan bulat antara 0 dan 20 yang menentukan jumlah token yang kemungkinan besar akan dikembalikan pada setiap posisi token, masing-masing dengan probabilitas log terkait. logprobs harus diatur ke true jika parameter ini digunakan.	Tidak.
top_p	nomor/angka	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk memodifikasi ini atau temperature tetapi tidak keduanya.	Tidak.	1
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	Tidak.
user_security_context	userSecurityContext	Konteks keamanan pengguna berisi beberapa parameter yang menjelaskan aplikasi AI itu sendiri, dan pengguna akhir yang berinteraksi dengan aplikasi AI. Bidang ini membantu tim operasi keamanan Anda untuk menyelidiki dan mengurangi insiden keamanan dengan memberikan pendekatan komprehensif untuk melindungi aplikasi AI Anda. Learn lebih tentang melindungi aplikasi AI menggunakan Microsoft Defender for Cloud.	Tidak.

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	objek

Kode Status: default

Deskripsi: Layanan tidak tersedia

Content-Type	Jenis	Deskripsi
application/json	errorResponse

Contoh

Contoh

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

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

Respons: Kode Status: 200

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

Contoh

Membuat penyelesaian berdasarkan data pencarian Azure dan identitas terkelola yang ditetapkan sistem.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

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

Respons: Kode Status: 200

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

Contoh

Membuat penyelesaian berdasarkan data vektor gambar pencarian Azure.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "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}",
    "query_type": "vector",
    "fields_mapping": {
     "image_vector_fields": [
      "image_vector"
     ]
    },
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    }
   }
  }
 ]
}

Respons: Kode Status: 200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Contoh

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

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

Respons: Kode Status: 200

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

Contoh

Membuat penyelesaian untuk Azure Cosmos DB yang disediakan.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

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

Respons: Kode Status: 200

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

Contoh

Membuat penyelesaian untuk Mongo DB yang disediakan.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

Respons: Kode Status: 200

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

Contoh

Membuat penyelesaian untuk Elasticsearch yang disediakan.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "elasticsearch",
   "parameters": {
    "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io",
    "index_name": "{index name}",
    "authentication": {
     "type": "key_and_key_id",
     "key": "{key}",
     "key_id": "{key id}"
    }
   }
  }
 ]
}

Respons: Kode Status: 200

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

Contoh

Membuat penyelesaian untuk sumber daya Pinecone yang disediakan.

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "pinecone",
   "parameters": {
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    },
    "environment": "{environment name}",
    "index_name": "{index name}",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "title_field": "title",
     "url_field": "url",
     "filepath_field": "filepath",
     "content_fields": [
      "content"
     ],
     "content_fields_separator": "\n"
    }
   }
  }
 ]
}

Respons: Kode Status: 200

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

Transkripsi - Buat

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

Mentranskripsikan audio ke dalam bahasa input.

Parameter URI

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

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Tipe Konten: multipart/form-data

Nama	Tipe	Deskripsi	Diperlukan	Default
model	string	ID model yang akan digunakan. Opsinya adalah gpt-4o-transcribe, , gpt-4o-mini-transcribegpt-4o-mini-transcribe-2025-12-15, whisper-1, dan gpt-4o-transcribe-diarize.	Yes
berkas	string	Objek file audio yang akan ditranskripsikan.	Yes
bahasa	string	Bahasa audio input. Menyediakan bahasa input dalam format ISO-639-1 meningkatkan akurasi dan latensi.	Tidak.
minta	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Perintah harus cocok dengan bahasa audio.	Tidak.
response_format	audioResponseFormat	Menentukan format output.	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel, antara 0 dan 1. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Jika diatur ke 0, model menggunakan probabilitas log untuk secara otomatis meningkatkan suhu hingga mencapai ambang batas tertentu.	Tidak.	0
timestamp_granularities[]	array	Granularitas tanda waktu untuk mengisi transkripsi ini. response_format harus diatur verbose_json untuk menggunakan granularitas tanda waktu. Salah satu atau kedua opsi ini didukung: word, atau segment. Catatan: Tidak ada latensi tambahan untuk tanda waktu segmen, tetapi menghasilkan tanda waktu kata menimbulkan latensi tambahan.	Tidak.	['segment']

Responses

Kode Status: 200

Deskripsi: OK

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

Contoh

Contoh

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

Respons: Kode Status: 200

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

Contoh

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

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

Respons: Kode Status: 200

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

Terjemahan - Buat

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

Mentranskripsikan dan terjemahkan audio input ke dalam teks bahasa Inggris.

Parameter URI

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

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Tipe Konten: multipart/form-data

Nama	Tipe	Deskripsi	Diperlukan	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.	Tidak.
response_format	audioResponseFormat	Menentukan format output.	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel, antara 0 dan 1. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Jika diatur ke 0, model menggunakan probabilitas log untuk secara otomatis meningkatkan suhu hingga mencapai ambang batas tertentu.	Tidak.	0

Responses

Kode Status: 200

Deskripsi: OK

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

Contoh

Contoh

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

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

Respons: Kode Status: 200

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

Contoh

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

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

Respons: Kode Status: 200

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

Ucapan - Buat

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

Menghasilkan audio dari teks input.

Parameter URI

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

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Tipe Konten: multipart/form-data

Nama	Tipe	Deskripsi	Diperlukan	Default
Masukan	string	Teks yang akan disintesis audio. Panjang maksimum adalah 4.096 karakter.	Yes
response_format	enum	Format untuk mensintesis audio masuk. Nilai yang mungkin: mp3, , opusaac, flac, wav,pcm	Tidak.
speed	nomor/angka	Kecepatan audio yang disintesis. Pilih nilai dari 0.25 ke 4.0. 1.0 adalah default.	Tidak.	1.0
voice	enum	Suara yang digunakan untuk sintesis ucapan. Nilai yang mungkin: alloy, , echofable, onyx, nova,shimmer	Yes

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/octet-stream	string

Contoh

Contoh

Mensintesis audio dari teks yang disediakan.

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3"
}

Respons: Kode Status: 200

{
  "body": "101010101"
}

Pembuatan gambar - Buat

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

Menghasilkan batch gambar dari keterangan teks menggunakan implementasi model seri DALL-E atau gpt-image-1 tertentu.

Parameter URI

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

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
latar belakang	imageBackground	Memungkinkan untuk mengatur transparansi untuk latar belakang gambar yang dihasilkan. Parameter ini hanya didukung untuk model seri gpt-image-1.	Tidak.	auto
n	bilangan bulat	Jumlah gambar yang akan dihasilkan. Untuk dall-e-3, hanya n=1 yang didukung.	Tidak.	1
kompresi keluaran	bilangan bulat	Tingkat kompresi (0-100%) untuk gambar yang dihasilkan. Parameter ini hanya didukung untuk model seri gpt-image-1 dengan format output jpeg.	Tidak.	100
format keluaran	imagesOutputFormat	Format file tempat gambar yang dihasilkan dikembalikan. Hanya didukung untuk model seri gpt-image-1.	Tidak.	png
minta	string	Deskripsi teks gambar yang diinginkan. Panjang maksimum adalah 32000 karakter untuk seri gpt-image-1 dan 4000 karakter untuk dall-e-3	Yes
gambar sebagian	bilangan bulat	Jumlah gambar parsial yang akan dihasilkan. Parameter ini digunakan untuk respons streaming yang mengembalikan gambar parsial. Nilai harus antara 0 dan 3. Saat diatur ke 0, respons akan menjadi satu gambar yang dikirim dalam satu acara streaming. Perhatikan bahwa gambar akhir dapat dikirim sebelum jumlah lengkap gambar parsial dihasilkan jika gambar lengkap dihasilkan lebih cepat.	0
aliran	Boolean	Edit gambar dalam mode streaming.	no	false
kualitas	imageQuality	Kualitas gambar yang akan dihasilkan.	Tidak.	auto
response_format	imagesResponseFormat	Format di mana gambar yang dihasilkan dikembalikan. Parameter ini tidak didukung untuk gpt-image-1model seri yang akan selalu mengembalikan gambar yang dikodekan base64. Nilai yang mungkin: url, b64_json.	Tidak.	URL
ukuran	imageSize	Ukuran gambar yang dihasilkan.	Tidak.	auto
gaya	imageStyle	Gaya gambar yang dihasilkan. Hanya didukung untuk dall-e-3.	Tidak.	Jelas
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	Tidak.

Responses

Kode Status: 200

Deskripsi: Ok

Content-Type	Jenis	Deskripsi
application/json	generateImagesResponse

Kode Status: default

Deskripsi: Terjadi kesalahan.

Content-Type	Jenis	Deskripsi
application/json	dalleErrorResponse

Contoh

Contoh

Membuat gambar yang diberi perintah.

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

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

Respons: Kode Status: 200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "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
          }
        }
      }
    ]
  }
}

Pembuatan gambar - Edit

POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview

Mengedit gambar dari keterangan teks pada penyebaran model gpt-image-1 tertentu

Parameter URI

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

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Tipe Konten: multipart/form-data

Nama	Tipe	Deskripsi	Diperlukan	Default
citra	string atau array	Gambar yang akan diedit. Harus berupa file gambar yang didukung atau array gambar. Setiap gambar harus berupa file png, atau jpg kurang dari 50MB.	Yes
input_fidelity	string	Kontrol berapa banyak upaya yang akan dilakukan model untuk mencocokkan gaya dan fitur, terutama fitur wajah, dari gambar input. Parameter ini hanya didukung untuk model seri gpt-image-1. Mendukung high dan low.	no	low.
masker	string	Gambar tambahan yang areanya sepenuhnya transparan (misalnya, di mana alfa nol) menunjukkan di mana gambar harus diedit. Jika ada beberapa gambar yang disediakan, masker akan diterapkan ke gambar pertama. Harus berupa file PNG yang valid, kurang dari 4MB, dan memiliki dimensi yang sama dengan gambar.	Tidak.
n	bilangan bulat	Jumlah gambar yang akan dihasilkan. Harus antara 1 dan 10.	Tidak.	1
minta	string	Deskripsi teks gambar yang diinginkan. Panjang maksimum adalah 32000 karakter.	Yes
kualitas	imageQuality	Kualitas gambar yang akan dihasilkan.	Tidak.	auto
gambar sebagian	Jumlah gambar parsial yang akan dihasilkan. Parameter ini digunakan untuk respons streaming yang mengembalikan gambar parsial. Nilai harus antara 0 dan 3. Saat diatur ke 0, respons akan menjadi satu gambar yang dikirim dalam satu acara streaming. Perhatikan bahwa gambar akhir dapat dikirim sebelum jumlah lengkap gambar parsial dihasilkan jika gambar lengkap dihasilkan lebih cepat.
aliran	Boolean	Edit gambar dalam mode streaming.	no	false
response_format	imagesResponseFormat	Format di mana gambar yang dihasilkan dikembalikan.	Tidak.	URL
ukuran	imageSize	Ukuran gambar yang dihasilkan.	Tidak.	auto
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	Tidak.

Responses

Kode Status: 200

Deskripsi: Ok

Content-Type	Jenis	Deskripsi
application/json	generateImagesResponse

Kode Status: default

Deskripsi: Terjadi kesalahan.

Content-Type	Jenis	Deskripsi
application/json	dalleErrorResponse

Daftar - Asisten

Nota

Assistants API tidak digunakan lagi dan akan dihentikan pada 26 Agustus 2026. Gunakan layanan Microsoft Foundry Agents yang tersedia secara umum. Ikuti panduan migrasi untuk memperbarui beban kerja Anda. Pelajari selengkapnya.

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Mengembalikan daftar asisten.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
limit	kueri	Tidak.	bilangan bulat	Batas jumlah objek yang akan dikembalikan. Batas dapat berkisar antara 1 dan 100, dan defaultnya adalah 20.
order	kueri	Tidak.	string Nilai yang mungkin: asc, desc	Urutkan urutan menurut created_at tanda waktu objek. asc untuk urutan naik dan desc untuk urutan turun.
after	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. after adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, berakhir dengan obj_foo, panggilan berikutnya dapat menyertakan after=obj_foo untuk mengambil halaman berikutnya dari daftar.
sebelum	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. before adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, dimulai dengan obj_foo, panggilan berikutnya dapat menyertakan before=obj_foo untuk mengambil halaman sebelumnya dari daftar.
versi-API	kueri	Yes	string

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	listAssistantsResponse

Contoh

Contoh

Mengembalikan daftar asisten.

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "asst_abc123",
        "object": "assistant",
        "created_at": 1707257477,
        "name": "Stock Analyst",
        "description": null,
        "model": "gpt-4-1106-preview",
        "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.",
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc456",
        "object": "assistant",
        "created_at": 1698982718,
        "name": "My Assistant",
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": "You are a helpful assistant designed to make me better at coding!",
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc789",
        "object": "assistant",
        "created_at": 1698982643,
        "name": null,
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      }
    ],
    "first_id": "asst_abc123",
    "last_id": "asst_abc789",
    "has_more": false
  }
}

Buat - Asisten

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

Buat asisten dengan model dan instruksi.

Parameter URI

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

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
deskripsi	string	Penjabaran dari asisten. Panjang maksimum adalah 512 karakter.	Tidak.
instructions	string	Instruksi sistem yang digunakan asisten. Panjang maksimum adalah 256.000 karakter.	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.
model	string		Yes
Nama	string	Nama asisten. Panjang maksimum adalah 256 karakter.	Tidak.
response_format	assistantsApiResponseFormatOption	Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4o, GPT-4 Turbo, dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_schema", "json_schema": {...} } mengaktifkan Output Terstruktur yang memastikan model cocok dengan skema JSON yang Anda berikan. Pelajari selengkapnya di panduan Output Terstruktur. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang memastikan pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan deretan ruang kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berlangsung lama dan tampak "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik.	Tidak.	1
tool_resources	objek	Sekumpulan sumber daya yang digunakan oleh alat asisten. Sumber daya khusus untuk jenis alat. Misalnya, alat ini code_interpreter memerlukan daftar ID file, sementara alat ini file_search memerlukan daftar ID penyimpanan vektor.	Tidak.
└─ penerjemah_kode	objek		Tidak.
└─ file_ids	array	Daftar ID file yang disediakan untuk alat ini code_interpreter . Mungkin ada maksimal 20 file yang terkait dengan alat ini.	Tidak.	[]
└─ pencarian_berkas	objek		Tidak.
└─ vector_store_ids	array	Penyimpanan vektor yang terpasang pada asisten ini. Maksimal 1 penyimpanan vektor dapat terpasang pada asisten.	Tidak.
└─ vector_stores	array	Pembantu untuk membuat penyimpanan vektor dengan file_ids dan melampirkannya ke asisten ini. Maksimal 1 penyimpanan vektor dapat terpasang pada asisten.	Tidak.
perangkat	array	Daftar alat yang diaktifkan pada asisten. Mungkin ada maksimal 128 alat per asisten. Alat bisa dari jenis code_interpreter, retrieval, atau function.	Tidak.	[]
top_p	nomor/angka	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau suhu tetapi tidak keduanya.	Tidak.	1

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	assistantObject

Contoh

Contoh

Buat asisten dengan model dan instruksi.

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

{
 "name": "Math Tutor",
 "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
 "tools": [
  {
   "type": "code_interpreter"
  }
 ],
 "model": "gpt-4-1106-preview"
}

Respons: Kode Status: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant",
    "created_at": 1707295707,
    "name": "Math Tutor",
    "description": null,
    "model": "gpt-4-1106-preview",
    "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Dapatkan - Asisten

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Mengambil asisten.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
assistant_id	path	Yes	string	ID asisten yang akan diambil.
versi-API	kueri	Yes	string

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	assistantObject

Contoh

Contoh

Mengambil asisten.

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "asst_abc123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Modifikasi - Asisten

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Memodifikasi asisten.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
assistant_id	path	Yes	string	ID asisten yang akan dimodifikasi.
versi-API	kueri	Yes	string

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
deskripsi	string	Penjabaran dari asisten. Panjang maksimum adalah 512 karakter.	Tidak.
instructions	string	Instruksi sistem yang digunakan asisten. Panjang maksimum adalah 32768 karakter.	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.
model	string		Tidak.
Nama	string	Nama asisten. Panjang maksimum adalah 256 karakter.	Tidak.
response_format	assistantsApiResponseFormatOption	Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4o, GPT-4 Turbo, dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_schema", "json_schema": {...} } mengaktifkan Output Terstruktur yang memastikan model cocok dengan skema JSON yang Anda berikan. Pelajari selengkapnya di panduan Output Terstruktur. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang memastikan pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan deretan ruang kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berlangsung lama dan tampak "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik.	Tidak.	1
tool_resources	objek	Sekumpulan sumber daya yang digunakan oleh alat asisten. Sumber daya khusus untuk jenis alat. Misalnya, alat ini code_interpreter memerlukan daftar ID file, sementara alat ini file_search memerlukan daftar ID penyimpanan vektor.	Tidak.
└─ penerjemah_kode	objek		Tidak.
└─ file_ids	array	Mengambil alih daftar ID file yang tersedia untuk alat ini code_interpreter . Mungkin ada maksimal 20 file yang terkait dengan alat ini.	Tidak.	[]
└─ pencarian_berkas	objek		Tidak.
└─ vector_store_ids	array	Mengambil alih penyimpanan vektor yang terpasang pada asisten ini. Maksimal 1 penyimpanan vektor dapat terpasang pada asisten.	Tidak.
perangkat	array	Daftar alat yang diaktifkan pada asisten. Mungkin ada maksimal 128 alat per asisten. Alat bisa dari jenis code_interpreter, retrieval, atau function.	Tidak.	[]
top_p	nomor/angka	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau suhu tetapi tidak keduanya.	Tidak.	1

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	assistantObject

Contoh

Contoh

Memodifikasi asisten.

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

{
 "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
 "tools": [
  {
   "type": "file_search"
  }
 ],
 "model": "gpt-4-turbo"
}

Respons: Kode Status: 200

{
  "body": {
    "id": "asst_123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": []
      }
    },
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Hapus - Asisten

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Menghapus asisten.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
assistant_id	path	Yes	string	ID asisten yang akan dihapus.
versi-API	kueri	Yes	string

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	deleteAssistantResponse

Contoh

Contoh

Menghapus asisten.

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant.deleted",
    "deleted": true
  }
}

Buat - Utas

Nota

Assistants API tidak digunakan lagi dan akan dihentikan pada 26 Agustus 2026. Gunakan layanan Microsoft Foundry Agents yang tersedia secara umum. Ikuti panduan migrasi untuk memperbarui beban kerja Anda. Pelajari selengkapnya.

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

Buat utas.

Parameter URI

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

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
messages	array	Daftar pesan untuk mengawali utas.	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.
tool_resources	objek	Sekumpulan sumber daya yang tersedia untuk alat asisten di utas ini. Sumber daya khusus untuk jenis alat. Misalnya, alat ini code_interpreter memerlukan daftar ID file, sementara alat ini file_search memerlukan daftar ID penyimpanan vektor.	Tidak.
└─ penerjemah_kode	objek		Tidak.
└─ file_ids	array	Daftar ID file yang disediakan untuk alat ini code_interpreter . Mungkin ada maksimal 20 file yang terkait dengan alat ini.	Tidak.	[]
└─ pencarian_berkas	objek		Tidak.
└─ vector_store_ids	array	Penyimpanan vektor yang terpasang pada utas ini. Mungkin ada maksimal 1 penyimpanan vektor yang terpasang pada utas.	Tidak.
└─ vector_stores	array	Pembantu untuk membuat penyimpanan vektor dengan file_ids dan melampirkannya ke utas ini. Mungkin ada maksimal 1 penyimpanan vektor yang terpasang pada utas.	Tidak.

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	threadObject

Contoh

Contoh

Membuat utas.

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {}
  }
}

Dapatkan - Utas

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Mengambil utas.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
thread_id	path	Yes	string	ID utas yang akan diambil.
versi-API	kueri	Yes	string

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	threadObject

Contoh

Contoh

Mengambil utas.

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {},
    "tool_resources": {
      "code_interpreter": {
        "file_ids": []
      }
    }
  }
}

Modifikasi - Utas

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Memodifikasi utas.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
thread_id	path	Yes	string	ID utas yang akan dimodifikasi. Hanya yang metadata dapat dimodifikasi.
versi-API	kueri	Yes	string

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.
tool_resources	objek	Sekumpulan sumber daya yang tersedia untuk alat asisten di utas ini. Sumber daya khusus untuk jenis alat. Misalnya, alat ini code_interpreter memerlukan daftar ID file, sementara alat ini file_search memerlukan daftar ID penyimpanan vektor.	Tidak.
└─ penerjemah_kode	objek		Tidak.
└─ file_ids	array	Daftar ID File yang disediakan untuk alat ini code_interpreter . Mungkin ada maksimal 20 file yang terkait dengan alat ini.	Tidak.	[]
└─ pencarian_berkas	objek		Tidak.
└─ vector_store_ids	array	Penyimpanan vektor yang terpasang pada utas ini. Mungkin ada maksimal 1 penyimpanan vektor yang terpasang pada utas.	Tidak.

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	threadObject

Contoh

Contoh

Memodifikasi utas.

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

Respons: Kode Status: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {
      "modified": "true",
      "user": "abc123"
    },
    "tool_resources": {}
  }
}

Hapus - Utas

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Menghapus utas.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
thread_id	path	Yes	string	ID utas yang akan dihapus.
versi-API	kueri	Yes	string

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	deleteThreadResponse

Contoh

Contoh

Menghapus utas.

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread.deleted",
    "deleted": true
  }
}

Daftar - Pesan

Nota

Assistants API tidak digunakan lagi dan akan dihentikan pada 26 Agustus 2026. Gunakan layanan Microsoft Foundry Agents yang tersedia secara umum. Ikuti panduan migrasi untuk memperbarui beban kerja Anda. Pelajari selengkapnya.

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Mengembalikan daftar pesan untuk utas tertentu.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
thread_id	path	Yes	string	ID utas tempat pesan berada.
limit	kueri	Tidak.	bilangan bulat	Batas jumlah objek yang akan dikembalikan. Batas dapat berkisar antara 1 dan 100, dan defaultnya adalah 20.
order	kueri	Tidak.	string Nilai yang mungkin: asc, desc	Urutkan urutan menurut created_at tanda waktu objek. asc untuk urutan naik dan desc untuk urutan turun.
after	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. after adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, berakhir dengan obj_foo, panggilan berikutnya dapat menyertakan after=obj_foo untuk mengambil halaman berikutnya dari daftar.
sebelum	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. before adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, dimulai dengan obj_foo, panggilan berikutnya dapat menyertakan before=obj_foo untuk mengambil halaman sebelumnya dari daftar.
run_id	kueri	Tidak.	string	Filter pesan menurut ID eksekusi yang menghasilkannya.
versi-API	kueri	Yes	string

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	listMessagesResponse

Contoh

Contoh

Daftar Pesan

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "msg_abc123",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "How does AI work? Explain it in simple terms.",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      },
      {
        "id": "msg_abc456",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "Hello, what is AI?",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      }
    ],
    "first_id": "msg_abc123",
    "last_id": "msg_abc456",
    "has_more": false
  }
}

Buat - Pesan

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

Buat pesan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
thread_id	path	Yes	string	ID utas yang digunakan untuk membuat pesan.
versi-API	kueri	Yes	string

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
attachments	array	Daftar file yang dilampirkan ke pesan, dan alat yang harus ditambahkan.	Tidak.
isi	string	Isi pesan.	Yes
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.
peran	string	Peran entitas yang membuat pesan. Nilai yang diizinkan meliputi: - user: Menunjukkan pesan dikirim oleh pengguna aktual dan harus digunakan dalam banyak kasus untuk mewakili pesan yang dihasilkan pengguna. - assistant: Menunjukkan pesan dihasilkan oleh asisten. Gunakan nilai ini untuk menyisipkan pesan dari asisten ke dalam percakapan.	Yes

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	messageObject

Contoh

Contoh

Buat pesan.

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

{
 "role": "user",
 "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces."
}

Respons: Kode Status: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "assistant_id": null,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "attachments": [],
    "metadata": {}
  }
}

Dapatkan - Pesan

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Mengambil pesan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
thread_id	path	Yes	string	ID dari topik yang dimiliki oleh pesan ini.
message_id	path	Yes	string	ID pesan yang akan diambil.
versi-API	kueri	Yes	string

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	messageObject

Contoh

Contoh

Mengambil pesan.

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }
}

Ubah - Pesan

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

Memodifikasi pesan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
thread_id	path	Yes	string	ID utas tempat pesan ini berada.
message_id	path	Yes	string	ID pesan yang akan diubah.
versi-API	kueri	Yes	string

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	messageObject

Contoh

Contoh

Mengubah pesan.

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

Respons: Kode Status: 200

{
  "body": {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "assistant_id": null,
    "thread_id": "thread_abc123",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "metadata": {
      "modified": "true",
      "user": "abc123"
    }
  }
}

Buat - Utas Dan Jalankan

Nota

Assistants API tidak digunakan lagi dan akan dihentikan pada 26 Agustus 2026. Gunakan layanan Microsoft Foundry Agents yang tersedia secara umum. Ikuti panduan migrasi untuk memperbarui beban kerja Anda. Pelajari selengkapnya.

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

Buat utas dan jalankan dalam satu permintaan.

Parameter URI

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

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
assistant_id	string	ID asisten yang digunakan untuk menjalankan eksekusi ini.	Yes
instructions	string	Ambil alih pesan sistem default asisten. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi.	Tidak.
max_completion_tokens	bilangan bulat	Jumlah maksimum token penyelesaian yang dapat digunakan selama eksekusi. Jalankan berupaya sebaik mungkin untuk membatasi penggunaan hanya pada jumlah token penyelesaian yang ditentukan, di beberapa putaran jalankan. Jika eksekusi melebihi jumlah token penyelesaian yang ditentukan, eksekusi akan berakhir dengan status incomplete. Lihat incomplete_details untuk informasi selengkapnya.	Tidak.
max_prompt_tokens	bilangan bulat	Jumlah maksimum token prompt yang dapat digunakan selama eksekusi. Pengerjaan berupaya sebaik mungkin untuk hanya menggunakan jumlah token prompt yang telah ditentukan, dalam beberapa giliran pengerjaan. Jika eksekusi melebihi jumlah token prompt yang ditentukan, eksekusi akan berakhir dengan status incomplete. Lihat incomplete_details untuk informasi selengkapnya.	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.
model	string	ID model yang akan digunakan untuk menjalankan eksekusi ini. Jika nilai disediakan di sini, nilai akan mengambil alih model yang terkait dengan asisten. Jika tidak, model yang terkait dengan asisten akan digunakan.	Tidak.
pemanggilan_alat_paralel	ParallelToolCalls	Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.	Tidak.	Benar
response_format	assistantsApiResponseFormatOption	Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4o, GPT-4 Turbo, dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_schema", "json_schema": {...} } mengaktifkan Output Terstruktur yang memastikan model cocok dengan skema JSON yang Anda berikan. Pelajari selengkapnya di panduan Output Terstruktur. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang memastikan pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan deretan ruang kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berlangsung lama dan tampak "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	Tidak.
aliran	Boolean	Jika true, mengembalikan aliran peristiwa yang terjadi selama peristiwa Jalankan sebagai yang dikirim server, mengakhiri saat Eksekusi memasuki status terminal dengan data: [DONE] pesan.	Tidak.
stream_options	chatCompletionStreamOptions	Opsi untuk respons streaming. Hanya atur ini saat Anda mengatur stream: true.	Tidak.	Tidak ada
suhu	nomor/angka	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik.	Tidak.	1
alur	createThreadRequest		Tidak.
tool_choice	assistantsApiToolChoiceOption	Mengontrol alat mana (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil alat apa pun dan sebaliknya menghasilkan pesan. auto adalah nilai default dan berarti model dapat memilih antara menghasilkan pesan atau memanggil alat. Menentukan alat tertentu seperti {"type": "file_search"} atau {"type": "function", "function": {"name": "my_function"}} memaksa model untuk memanggil alat tersebut.	Tidak.
tool_resources	objek	Sekumpulan sumber daya yang digunakan oleh alat asisten. Sumber daya khusus untuk jenis alat. Misalnya, alat ini code_interpreter memerlukan daftar ID file, sementara alat ini file_search memerlukan daftar ID penyimpanan vektor.	Tidak.
└─ penerjemah_kode	objek		Tidak.
└─ file_ids	array	Daftar ID file yang disediakan untuk alat ini code_interpreter . Mungkin ada maksimal 20 file yang terkait dengan alat ini.	Tidak.	[]
└─ pencarian_berkas	objek		Tidak.
└─ vector_store_ids	array	ID penyimpanan vektor yang terpasang pada asisten ini. Maksimal 1 penyimpanan vektor dapat terpasang pada asisten.	Tidak.
perangkat	array	Ambil alih alat yang dapat digunakan asisten untuk eksekusi ini. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi.	Tidak.
top_p	nomor/angka	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau suhu tetapi tidak keduanya.	Tidak.	1
truncation_strategy	truncationObject	Kontrol tentang bagaimana utas akan dipotong sebelum eksekusi. Gunakan ini untuk mengontrol jendela konteks awal eksekusi.	Tidak.

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	runObject

Contoh

Contoh

Buat utas dan jalankan dalam satu permintaan.

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123",
 "thread": {
  "messages": [
   {
    "role": "user",
    "content": "Explain deep learning to a 5 year old."
   }
  ]
 }
}

Respons: Kode Status: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076792,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": null,
    "expires_at": 1699077392,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "required_action": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You are a helpful assistant.",
    "tools": [],
    "tool_resources": {},
    "metadata": {},
    "temperature": 1.0,
    "top_p": 1.0,
    "max_completion_tokens": null,
    "max_prompt_tokens": null,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "incomplete_details": null,
    "usage": null,
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Daftar - Berjalan

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Mengembalikan daftar eksekusi milik utas.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
thread_id	path	Yes	string	ID utas milik eksekusi.
limit	kueri	Tidak.	bilangan bulat	Batas jumlah objek yang akan dikembalikan. Batas dapat berkisar antara 1 dan 100, dan defaultnya adalah 20.
order	kueri	Tidak.	string Nilai yang mungkin: asc, desc	Urutkan urutan menurut created_at tanda waktu objek. asc untuk urutan naik dan desc untuk urutan turun.
after	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. after adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, berakhir dengan obj_foo, panggilan berikutnya dapat menyertakan after=obj_foo untuk mengambil halaman berikutnya dari daftar.
sebelum	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. before adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, dimulai dengan obj_foo, panggilan berikutnya dapat menyertakan before=obj_foo untuk mengambil halaman sebelumnya dari daftar.
versi-API	kueri	Yes	string

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	listRunsResponse

Contoh

Contoh

Mengembalikan daftar eksekusi milik utas.

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "run_abc123",
        "object": "thread.run",
        "created_at": 1699075072,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699075072,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699075073,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      },
      {
        "id": "run_abc456",
        "object": "thread.run",
        "created_at": 1699063290,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699063290,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699063291,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      }
    ],
    "first_id": "run_abc123",
    "last_id": "run_abc456",
    "has_more": false
  }
}

Buat - Jalankan

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

Buat eksekusi.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
thread_id	path	Yes	string	ID thread yang akan dijalankan.
include[]	kueri	Tidak.	array	Daftar bidang tambahan untuk disertakan dalam respons. Saat ini satu-satunya nilai yang didukung adalah step_details.tool_calls[*].file_search.results[*].content mengambil konten hasil pencarian file.
versi-API	kueri	Yes	string

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
additional_instructions	string	Menambahkan instruksi tambahan di akhir instruksi untuk eksekusi. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi tanpa menimpa instruksi lain.	Tidak.
additional_messages	array	Menambahkan pesan tambahan ke utas sebelum membuat eksekusi.	Tidak.
assistant_id	string	ID asisten yang digunakan untuk menjalankan eksekusi ini.	Yes
instructions	string	Ambil alih pesan sistem default asisten. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi.	Tidak.
max_completion_tokens	bilangan bulat	Jumlah maksimum token penyelesaian yang dapat digunakan selama eksekusi. Jalankan berupaya sebaik mungkin untuk membatasi penggunaan hanya pada jumlah token penyelesaian yang ditentukan, di beberapa putaran jalankan. Jika eksekusi melebihi jumlah token penyelesaian yang ditentukan, eksekusi akan berakhir dengan status incomplete. Lihat incomplete_details untuk informasi selengkapnya.	Tidak.
max_prompt_tokens	bilangan bulat	Jumlah maksimum token prompt yang dapat digunakan selama eksekusi. Pengerjaan berupaya sebaik mungkin untuk hanya menggunakan jumlah token prompt yang telah ditentukan, dalam beberapa giliran pengerjaan. Jika eksekusi melebihi jumlah token prompt yang ditentukan, eksekusi akan berakhir dengan status incomplete. Lihat incomplete_details untuk informasi selengkapnya.	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.
model	string	ID Model yang akan digunakan untuk menjalankan eksekusi ini. Jika nilai disediakan di sini, nilai akan mengambil alih model yang terkait dengan asisten. Jika tidak, model yang terkait dengan asisten akan digunakan.	Tidak.
pemanggilan_alat_paralel	ParallelToolCalls	Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.	Tidak.	Benar
response_format	assistantsApiResponseFormatOption	Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4o, GPT-4 Turbo, dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_schema", "json_schema": {...} } mengaktifkan Output Terstruktur yang memastikan model cocok dengan skema JSON yang Anda berikan. Pelajari selengkapnya di panduan Output Terstruktur. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang memastikan pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan deretan ruang kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berlangsung lama dan tampak "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	Tidak.
aliran	Boolean	Jika true, mengembalikan aliran peristiwa yang terjadi selama peristiwa Jalankan sebagai yang dikirim server, mengakhiri saat Eksekusi memasuki status terminal dengan data: [DONE] pesan.	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik.	Tidak.	1
tool_choice	assistantsApiToolChoiceOption	Mengontrol alat mana (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil alat apa pun dan sebaliknya menghasilkan pesan. auto adalah nilai default dan berarti model dapat memilih antara menghasilkan pesan atau memanggil alat. Menentukan alat tertentu seperti {"type": "file_search"} atau {"type": "function", "function": {"name": "my_function"}} memaksa model untuk memanggil alat tersebut.	Tidak.
perangkat	array	Ambil alih alat yang dapat digunakan asisten untuk eksekusi ini. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi.	Tidak.
top_p	nomor/angka	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau suhu tetapi tidak keduanya.	Tidak.	1
truncation_strategy	truncationObject	Kontrol tentang bagaimana utas akan dipotong sebelum eksekusi. Gunakan ini untuk mengontrol jendela konteks awal eksekusi.	Tidak.

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	runObject

Contoh

Contoh

Buat eksekusi.

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123"
}

Respons: Kode Status: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699063290,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": 1699063290,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699063291,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Dapatkan - Jalankan

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Mengambil eksekusi.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
thread_id	path	Yes	string	ID utas yang telah dijalankan.
run_id	path	Yes	string	ID run untuk diambil.
versi-API	kueri	Yes	string

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	runObject

Contoh

Contoh

Mendapatkan eksekusi.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q",
    "object": "thread.run",
    "created_at": 1707303196,
    "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl",
    "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh",
    "status": "completed",
    "started_at": 1707303197,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1707303201,
    "last_error": null,
    "model": "gpt-4-1106-preview",
    "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.",
    "tools": [],
    "file_ids": [],
    "metadata": {}
  }
}

Modifikasi - Jalankan

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

Memodifikasi eksekusi.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
thread_id	path	Yes	string	ID utas yang telah dijalankan.
run_id	path	Yes	string	ID "run" yang akan diubah.
versi-API	kueri	Yes	string

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	runObject

Contoh

Contoh

Memodifikasi eksekusi.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "user_id": "user_abc123"
 }
}

Respons: Kode Status: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699075072,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "completed",
    "started_at": 1699075072,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699075073,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "tool_resources": {
      "code_interpreter": {
        "file_ids": [
          "file-abc123",
          "file-abc456"
        ]
      }
    },
    "metadata": {
      "user_id": "user_abc123"
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    },
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Kirim - Output Alat Untuk Dijalankan

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

Ketika eksekusi memiliki status: "requires_action" dan required_action.type adalah submit_tool_outputs, titik akhir ini dapat digunakan untuk mengirimkan output dari panggilan alat setelah semuanya selesai. Semua output harus dikirimkan dalam satu permintaan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
thread_id	path	Yes	string	ID utas tempat eksekusi ini berada.
run_id	path	Yes	string	ID dari proses yang memerlukan pengiriman hasil alat.
versi-API	kueri	Yes	string

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
aliran	Boolean	Jika true, mengembalikan aliran peristiwa yang terjadi selama peristiwa Jalankan sebagai yang dikirim server, mengakhiri saat Eksekusi memasuki status terminal dengan data: [DONE] pesan.	Tidak.
tool_outputs	array	Daftar alat yang outputnya sedang dikirimkan.	Yes

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	runObject

Contoh

Contoh

Ketika eksekusi memiliki status: "requires_action" dan required_action.type adalah submit_tool_outputs, titik akhir ini dapat digunakan untuk mengirimkan output dari panggilan alat setelah semuanya selesai. Semua output harus dikirimkan dalam satu permintaan.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

{
 "tool_outputs": [
  {
   "tool_call_id": "call_001",
   "output": "70 degrees and sunny."
  }
 ]
}

Respons: Kode Status: 200

{
  "body": {
    "id": "run_123",
    "object": "thread.run",
    "created_at": 1699075592,
    "assistant_id": "asst_123",
    "thread_id": "thread_123",
    "status": "queued",
    "started_at": 1699075592,
    "expires_at": 1699076192,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_current_weather",
          "description": "Get the current weather in a given location",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "The city and state, e.g. San Francisco, CA"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "celsius",
                  "fahrenheit"
                ]
              }
            },
            "required": [
              "location"
            ]
          }
        }
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

Batal - Jalankan

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

Membatalkan eksekusi yaitu in_progress.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
thread_id	path	Yes	string	ID utas tempat dijalankannya proses ini.
run_id	path	Yes	string	ID dari eksekusi yang ingin dibatalkan.
versi-API	kueri	Yes	string

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	runObject

Contoh

Contoh

Membatalkan eksekusi yaitu in_progress.

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076126,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "cancelling",
    "started_at": 1699076126,
    "expires_at": 1699076726,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You summarize books.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": [
          "vs_123"
        ]
      }
    },
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "response_format": "auto"
  }
}

Daftar - Jalankan Langkah

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

Mengembalikan daftar langkah eksekusi milik eksekusi.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
thread_id	path	Yes	string	ID utas tempat langkah-langkah dijalankan.
run_id	path	Yes	string	ID jalur tempat langkah-langkah eksekusi berasal.
limit	kueri	Tidak.	bilangan bulat	Batas jumlah objek yang akan dikembalikan. Batas dapat berkisar antara 1 dan 100, dan defaultnya adalah 20.
order	kueri	Tidak.	string Nilai yang mungkin: asc, desc	Urutkan urutan menurut created_at tanda waktu objek. asc untuk urutan naik dan desc untuk urutan turun.
after	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. after adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, berakhir dengan obj_foo, panggilan berikutnya dapat menyertakan after=obj_foo untuk mengambil halaman berikutnya dari daftar.
sebelum	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. before adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, dimulai dengan obj_foo, panggilan berikutnya dapat menyertakan before=obj_foo untuk mengambil halaman sebelumnya dari daftar.
versi-API	kueri	Yes	string
include[]	kueri	Tidak.	array	Daftar bidang tambahan untuk disertakan dalam respons. Saat ini satu-satunya nilai yang didukung adalah step_details.tool_calls[*].file_search.results[*].content mengambil konten hasil pencarian file.

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	listRunStepsResponse

Contoh

Contoh

Mengembalikan daftar langkah eksekusi milik eksekusi.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "step_abc123",
        "object": "thread.run.step",
        "created_at": 1699063291,
        "run_id": "run_abc123",
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "type": "message_creation",
        "status": "completed",
        "cancelled_at": null,
        "completed_at": 1699063291,
        "expired_at": null,
        "failed_at": null,
        "last_error": null,
        "step_details": {
          "type": "message_creation",
          "message_creation": {
            "message_id": "msg_abc123"
          }
        },
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        }
      }
    ],
    "first_id": "step_abc123",
    "last_id": "step_abc456",
    "has_more": false
  }
}

Dapatkan - Jalankan Langkah

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

Mengambil langkah eksekusi.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
thread_id	path	Yes	string	ID benang tempat run dan langkahnya berada.
run_id	path	Yes	string	ID dari eksekusi yang menjadi bagian dari langkah eksekusi.
step_id	path	Yes	string	ID langkah pelaksanaan yang akan diambil.
include[]	kueri	Tidak.	array	Daftar bidang tambahan untuk disertakan dalam respons. Saat ini satu-satunya nilai yang didukung adalah step_details.tool_calls[*].file_search.results[*].content mengambil konten hasil pencarian file.
versi-API	kueri	Yes	string

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	runStepObject

Contoh

Contoh

Mengambil langkah eksekusi.

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "step_abc123",
    "object": "thread.run.step",
    "created_at": 1699063291,
    "run_id": "run_abc123",
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "type": "message_creation",
    "status": "completed",
    "cancelled_at": null,
    "completed_at": 1699063291,
    "expired_at": null,
    "failed_at": null,
    "last_error": null,
    "step_details": {
      "type": "message_creation",
      "message_creation": {
        "message_id": "msg_abc123"
      }
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    }
  }
}

Daftar - Toko Vektor

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Mengembalikan daftar penyimpanan vektor.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
limit	kueri	Tidak.	bilangan bulat	Batas jumlah objek yang akan dikembalikan. Batas dapat berkisar antara 1 dan 100, dan defaultnya adalah 20.
order	kueri	Tidak.	string Nilai yang mungkin: asc, desc	Urutkan urutan menurut created_at tanda waktu objek. asc untuk urutan naik dan desc untuk urutan turun.
after	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. after adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, berakhir dengan obj_foo, panggilan berikutnya dapat menyertakan after=obj_foo untuk mengambil halaman berikutnya dari daftar.
sebelum	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. before adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, dimulai dengan obj_foo, panggilan berikutnya dapat menyertakan before=obj_foo untuk mengambil halaman sebelumnya dari daftar.
versi-API	kueri	Yes	string	versi api

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	listVectorStoresResponse

Contoh

Contoh

Mengembalikan daftar penyimpanan vektor.

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "vs_abc123",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      },
      {
        "id": "vs_abc456",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ v2",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      }
    ],
    "first_id": "vs_abc123",
    "last_id": "vs_abc456",
    "has_more": false
  }
}

Buat - Penyimpanan Vektor

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Buat penyimpanan vektor.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
versi-API	kueri	Yes	string	versi api

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
chunking_strategy	autoChunkingStrategyRequestParam atau staticChunkingStrategyRequestParam	Strategi penggugusan yang digunakan untuk memotong file. Jika tidak diatur, akan menggunakan auto strategi. Hanya berlaku jika file_ids tidak kosong.	Tidak.
kedaluwarsa_setelah	vectorStoreExpirationAfter	Kebijakan kedaluwarsa untuk penyimpanan vektor.	Tidak.
file_ids	array	Daftar ID file yang harus digunakan penyimpanan vektor. Berguna untuk alat seperti file_search yang dapat access file.	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.
Nama	string	Nama toko vektor.	Tidak.

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	vectorStoreObject

Contoh

Contoh

Membuat penyimpanan vektor.

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Get - Vector Store

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Mengambil penyimpanan vektor.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
vector_store_id	path	Yes	string	ID penyimpanan vektor yang akan diambil.
versi-API	kueri	Yes	string	versi api

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	vectorStoreObject

Contoh

Contoh

Mengambil penyimpanan vektor.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776
  }
}

Modifikasi - Penyimpanan Vektor

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Memodifikasi penyimpanan vektor.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
vector_store_id	path	Yes	string	ID penyimpanan vektor untuk dimodifikasi.
versi-API	kueri	Yes	string	versi api

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
kedaluwarsa_setelah	vectorStoreExpirationAfter	Kebijakan kedaluwarsa untuk penyimpanan vektor.	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.
Nama	string	Nama toko vektor.	Tidak.

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	vectorStoreObject

Contoh

Contoh

Memodifikasi penyimpanan vektor.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

{
 "name": "Support FAQ"
}

Respons: Kode Status: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Hapus - Penyimpanan Vektor

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Menghapus penyimpanan vektor.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
vector_store_id	path	Yes	string	ID penyimpanan vektor yang akan dihapus.
versi-API	kueri	Yes	string	versi api

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	deleteVectorStoreResponse

Contoh

Contoh

Menghapus penyimpanan vektor.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store.deleted",
    "deleted": true
  }
}

Daftar - File Penyimpanan Vektor

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Mengembalikan daftar file penyimpanan vektor.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
vector_store_id	path	Yes	string	ID penyimpanan vektor tempat file berada.
limit	kueri	Tidak.	bilangan bulat	Batas jumlah objek yang akan dikembalikan. Batas dapat berkisar antara 1 dan 100, dan defaultnya adalah 20.
order	kueri	Tidak.	string Nilai yang mungkin: asc, desc	Urutkan urutan menurut created_at tanda waktu objek. asc untuk urutan naik dan desc untuk urutan turun.
after	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. after adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, berakhir dengan obj_foo, panggilan berikutnya dapat menyertakan after=obj_foo untuk mengambil halaman berikutnya dari daftar.
sebelum	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. before adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, dimulai dengan obj_foo, panggilan berikutnya dapat menyertakan before=obj_foo untuk mengambil halaman sebelumnya dari daftar.
filter	kueri	Tidak.	string Nilai yang mungkin: in_progress, completed, failed, cancelled	Filter menurut status file. Salah satu dari in_progress, completed, failed, cancelled.
versi-API	kueri	Yes	string	versi api

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	listVectorStoreFilesResponse

Contoh

Contoh

Mengembalikan daftar file penyimpanan vektor.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Buat - File Penyimpanan Vektor

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

Buat file penyimpanan vektor dengan melampirkan File ke penyimpanan vektor.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
vector_store_id	path	Yes	string	ID penyimpanan vektor yang digunakan untuk membuat berkas.
versi-API	kueri	Yes	string	versi api

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
chunking_strategy	chunkingStrategyRequestParam	Strategi penggugusan yang digunakan untuk memotong file. Jika tidak diatur, akan menggunakan auto strategi.	Tidak.
file_id	string	ID File yang harus digunakan penyimpanan vektor. Berguna untuk alat seperti file_search yang dapat access file.	Yes

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	vectorStoreFileObject

Contoh

Contoh

Buat file penyimpanan vektor dengan melampirkan File ke penyimpanan vektor.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

{
 "file_id": "file-abc123"
}

Respons: Kode Status: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "usage_bytes": 1234,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Get - File Penyimpanan Vektor

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Mengambil file penyimpanan vektor.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
vector_store_id	path	Yes	string	ID penyimpanan vektor tempat file berada.
file_id	path	Yes	string	ID file yang diambil.
versi-API	kueri	Yes	string	versi api

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	vectorStoreFileObject

Contoh

Contoh

Mengambil file penyimpanan vektor.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Hapus - File Penyimpanan Vektor

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Menghapus file penyimpanan vektor. Ini akan menghapus file dari penyimpanan vektor tetapi file itu sendiri tidak akan dihapus. Untuk menghapus file, gunakan titik akhir file penghapusan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
vector_store_id	path	Yes	string	ID penyimpanan vektor tempat file berada.
file_id	path	Yes	string	ID file yang akan dihapus.
versi-API	kueri	Yes	string	versi api

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	deleteVectorStoreFileResponse

Contoh

Contoh

Menghapus file penyimpanan vektor. Ini akan menghapus file dari penyimpanan vektor tetapi file itu sendiri tidak akan dihapus. Untuk menghapus file, gunakan titik akhir file penghapusan.

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "file_abc123",
    "object": "vector_store.file.deleted",
    "deleted": true
  }
}

Updatevectorstorefileattributes

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

Memperbarui atribut pada file penyimpanan vektor.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
vector_store_id	path	Yes	string	ID penyimpanan vektor tempat file berada.
file_id	path	Yes	string	ID dari file yang ingin diperbarui atributnya.

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
attributes	VectorStoreFileAttributes	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter, boolean, atau angka.	Yes

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	vectorStoreFileObject

Mengambil isi file penyimpan vektor

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}/content?api-version=2025-04-01-preview

Ambil konten yang diurai dari file penyimpanan vektor.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
vector_store_id	path	Yes	string	ID penyimpanan vektor.
file_id	path	Yes	string	ID file dalam penyimpanan vektor.

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	VectorStoreFileContentResponse

Cari penyimpanan vektor

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/search?api-version=2025-04-01-preview

Cari di penyimpanan vektor untuk potongan yang relevan berdasarkan kueri dan filter atribut file.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
vector_store_id	path	Yes	string	ID dari penyimpanan vektor yang akan dicari.

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
filters	ComparisonFilter atau CompoundFilter	Filter untuk diterapkan berdasarkan atribut file.	Tidak.
jumlah_maksimum_hasil	bilangan bulat	Jumlah maksimum hasil yang akan dikembalikan. Angka ini harus antara 1 dan 50 inklusif.	Tidak.	10
kueri	string atau array	String kueri untuk pencarian	Yes
opsi_peringkat	objek	Opsi peringkat untuk pencarian.	Tidak.
└─ peringkat	enum	Nilai yang mungkin: auto, default-2024-11-15	Tidak.
└─ ambang_batas_skornya	nomor/angka		Tidak.	0
rewrite_query	Boolean	Apakah akan menulis ulang kueri bahasa alami untuk pencarian vektor.	Tidak.	False

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	VectorStoreSearchResultsPage

Buat - Batch File Penyimpanan Vektor

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

Buat batch file penyimpanan vektor.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
vector_store_id	path	Yes	string	ID penyimpanan vektor yang digunakan untuk membuat File Batch.
versi-API	kueri	Yes	string	versi api

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
chunking_strategy	chunkingStrategyRequestParam	Strategi penggugusan yang digunakan untuk memotong file. Jika tidak diatur, akan menggunakan auto strategi.	Tidak.
file_ids	array	Daftar ID File yang harus digunakan penyimpanan vektor. Berguna untuk alat seperti file_search yang dapat access file.	Yes

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	vectorStoreFileBatchObject

Contoh

Contoh

Buat batch file penyimpanan vektor.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

{
 "file_ids": [
  "file-abc123",
  "file-abc456"
 ]
}

Respons: Kode Status: 200

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0
  }
}

Dapatkan - Batch File Penyimpanan Vektor

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

Mengambil batch file penyimpanan vektor.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
vector_store_id	path	Yes	string	ID penyimpanan vektor tempat batch file berada.
batch_id	path	Yes	string	ID batch file yang sedang diambil.
versi-API	kueri	Yes	string	versi api

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	vectorStoreFileBatchObject

Contoh

Contoh

Mengambil batch file penyimpanan vektor.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "in_progress",
    "file_counts": {
      "in_progress": 1,
      "completed": 1,
      "failed": 0,
      "cancelled": 0,
      "total": 0
    }
  }
}

Batal - Batch File Penyimpanan Vektor

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

Batalkan batch file penyimpanan vektor. Upaya ini untuk membatalkan pemrosesan file dalam batch ini sesegera mungkin.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
vector_store_id	path	Yes	string	ID penyimpanan vektor tempat batch file berada.
batch_id	path	Yes	string	ID batch file yang akan dibatalkan.
versi-API	kueri	Yes	string	versi api

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	vectorStoreFileBatchObject

Contoh

Contoh

Batalkan batch file penyimpanan vektor. Upaya ini untuk membatalkan pemrosesan file dalam batch ini sesegera mungkin.

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "cancelling",
    "file_counts": {
      "in_progress": 12,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 15
    }
  }
}

Daftar - File Batch File Penyimpanan Vektor

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

Mengembalikan daftar file penyimpanan vektor dalam batch.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
vector_store_id	path	Yes	string	ID penyimpanan vektor tempat file berada.
batch_id	path	Yes	string	ID batch file tempat file berada.
limit	kueri	Tidak.	bilangan bulat	Batas jumlah objek yang akan dikembalikan. Batas dapat berkisar antara 1 dan 100, dan defaultnya adalah 20.
order	kueri	Tidak.	string Nilai yang mungkin: asc, desc	Urutkan urutan menurut created_at tanda waktu objek. asc untuk urutan naik dan desc untuk urutan turun.
after	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. after adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, berakhir dengan obj_foo, panggilan berikutnya dapat menyertakan after=obj_foo untuk mengambil halaman berikutnya dari daftar.
sebelum	kueri	Tidak.	string	Kursor untuk digunakan dalam penomoran halaman. before adalah ID objek yang menentukan tempat Anda dalam daftar. Misalnya, jika Anda membuat permintaan daftar dan menerima 100 objek, dimulai dengan obj_foo, panggilan berikutnya dapat menyertakan before=obj_foo untuk mengambil halaman sebelumnya dari daftar.
filter	kueri	Tidak.	string Nilai yang mungkin: in_progress, completed, failed, cancelled	Filter menurut status file. Salah satu dari in_progress, completed, failed, cancelled.
versi-API	kueri	Yes	string	versi api

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	listVectorStoreFilesResponse

Contoh

Contoh

Mengembalikan daftar file penyimpanan vektor.

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

Respons: Kode Status: 200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Buat - Realtimesession

POST https://{endpoint}/openai/realtimeapi/sessions?api-version=2025-04-01-preview

Buat token API sementara untuk digunakan dalam aplikasi sisi klien dengan API Realtime. Dapat dikonfigurasi dengan parameter sesi session.update yang sama dengan acara klien. Ini merespons dengan objek sesi, serta kunci client_secret yang berisi token API sementara yang dapat digunakan untuk mengautentikasi klien browser untuk API Realtime.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
input_audio_format	enum	Format dari audio input. Opsinya adalah pcm16, g711_ulaw, atau g711_alaw. Untuk pcm16, input audio harus PCM 16-bit dengan laju sampel 24kHz, saluran tunggal (mono), dan memiliki urutan byte little-endian. Nilai yang mungkin: pcm16, g711_ulaw, g711_alaw	Tidak.
input_audio_noise_reduction	objek	Konfigurasi untuk pengurangan kebisingan audio masukan. Ini dapat diatur ke null untuk menonaktifkan. Pengurangan kebisingan memfilter audio yang ditambahkan ke buffer audio input sebelum dikirim ke VAD dan model. Pemfilteran audio dapat meningkatkan VAD dan mengubah akurasi deteksi (mengurangi positif palsu) dan performa model dengan meningkatkan persepsi audio input.	Tidak.
└─ jenis	enum	Jenis pengurangan kebisingan. near_field adalah untuk mikrofon jarak dekat seperti headphone, far_field adalah untuk mikrofon jarak jauh seperti milik laptop atau mikrofon ruang konferensi. Nilai yang mungkin: near_field, far_field	Tidak.
input_audio_transcription	objek	Konfigurasi untuk transkripsi audio input, secara default dinonaktifkan, dan dapat diatur ke null untuk menjadi nonaktif saat diaktifkan sekali. Model tidak menangani transkripsi audio secara bawaan, karena model memproses audio secara langsung. Transkripsi berjalan secara asinkron melalui titik akhir Transkripsi dan harus diperlakukan sebagai panduan konten audio input daripada yang didengar model. Klien dapat secara opsional mengatur bahasa dan meminta transkripsi, ini menawarkan panduan tambahan untuk layanan transkripsi.	Tidak.
└─ bahasa	string	Bahasa audio input. Menyediakan bahasa input dalam format ISO-639-1 (misalnya en) meningkatkan akurasi dan latensi.	Tidak.
└─ model	string	Model yang digunakan untuk transkripsi, opsi saat ini adalah gpt-4o-transcribe, , gpt-4o-transcribe-diarizegpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, dan whisper-1.	Tidak.
└─ perintah	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Untuk whisper-1, prompt tersebut merupakan daftar kata kunci. Untuk model-model gpt-4o-transcribe, perintahnya adalah string teks bebas, misalnya "kata-kata yang berkaitan dengan teknologi".	Tidak.
instructions	string	Instruksi sistem default (yaitu pesan sistem) yang ditambahkan di awal panggilan model. Bidang ini memungkinkan klien untuk memandu model pada respons yang diinginkan. Model ini dapat diinstruksikan tentang konten dan format respons, (misalnya "sangat singkat", "bersikap ramah", "berikut adalah contoh tanggapan yang baik") dan pada perilaku audio (misalnya "bicara cepat", "menyuntikkan emosi ke dalam suara Anda", "sering tertawa"). Instruksi tidak dijamin diikuti oleh model, tetapi mereka memberikan panduan untuk model tentang perilaku yang diinginkan. Perhatikan bahwa server menetapkan instruksi bawaan yang akan digunakan jika bidang ini tidak ditetapkan dan terlihat dalam session.created kejadian di awal sesi.	Tidak.
max_response_output_tokens	bilangan bulat atau string	Jumlah maksimum token output untuk satu respons asisten, termasuk panggilan alat. Berikan bilangan bulat antara 1 dan 4096 untuk membatasi token output, atau inf untuk token maksimum yang tersedia untuk model tertentu. Secara default menjadi inf.	Tidak.
Modalitas		Sekumpulan modalitas yang dapat dijawab oleh model. Untuk menonaktifkan audio, atur ini ke ["text"].	Tidak.
model	string	Nama penyebaran yang digunakan untuk sesi ini.	Tidak.
output_audio_format	enum	Format audio output. Opsinya adalah pcm16, g711_ulaw, atau g711_alaw. Untuk pcm16, audio output diambil sampelnya dengan kecepatan 24kHz. Nilai yang mungkin: pcm16, g711_ulaw, g711_alaw	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel untuk model, terbatas pada [0.6, 1.2]. Untuk model audio, suhu 0,8 sangat disarankan untuk performa terbaik.	Tidak.	0.8
tool_choice	string	Bagaimana model memilih alat. Opsinya adalah auto, none, required, atau menentukan fungsi.	Tidak.	auto
perangkat	array	Alat (fungsi) tersedia untuk model.	Tidak.
turn_detection	objek	Konfigurasi untuk deteksi giliran, entah Server VAD atau Semantic VAD. Ini dapat diatur ke null untuk menonaktifkan, dalam hal ini klien harus memicu respons model secara manual. VAD Server berarti bahwa model akan mendeteksi awal dan akhir ucapan berdasarkan volume audio dan merespons di akhir ucapan pengguna. Semantic VAD lebih canggih dan menggunakan model deteksi giliran (bersama dengan VAD) untuk secara semantik memperkirakan apakah pengguna telah selesai berbicara, kemudian secara dinamis mengatur batas waktu berdasarkan probabilitas ini. Misalnya, jika audio pengguna perlahan-lahan menghilang dengan uhhm, model akan menilai kemungkinan rendah untuk akhir giliran dan menunggu lebih lama hingga pengguna melanjutkan berbicara. Ini dapat berguna untuk percakapan yang lebih alami, tetapi mungkin memiliki latensi yang lebih tinggi.	Tidak.
└─ buat_respons	Boolean	Apakah akan secara otomatis menghasilkan respons saat peristiwa penghentian VAD terjadi.	Tidak.	Benar
└─ bersemangat	enum	Digunakan hanya untuk semantic_vad mode. Keinginan model untuk merespons. low akan menunggu lebih lama bagi pengguna untuk terus berbicara, high akan merespons lebih cepat. auto adalah default dan setara dengan medium. Nilai yang mungkin: low, medium, high, auto	Tidak.
└─ interrupt_response	Boolean	Secara otomatis menghentikan respons yang sedang berlangsung dengan output ke percakapan default (misalnya conversation dari auto) ketika terjadi peristiwa mulai VAD.	Tidak.	Benar
└─ prefix_padding_ms (isian_awalan_dalam_milidetik)	bilangan bulat	Digunakan hanya untuk server_vad mode. Jumlah audio yang akan disertakan sebelum ucapan yang terdeteksi oleh VAD (dalam milidetik). Pengaturan awal adalah 300ms.	Tidak.
└─ durasi_keheningan_dalam_milidetik (silence_duration_ms)	bilangan bulat	Digunakan hanya untuk server_vad mode. Durasi keheningan untuk mendeteksi pemberhentian ucapan (dalam milidetik). Default ke 500ms. Dengan nilai yang lebih pendek, model akan merespons lebih cepat, tetapi mungkin melompat pada jeda singkat dari pengguna.	Tidak.
└─ ambang batas	nomor/angka	Digunakan hanya untuk server_vad mode. Ambang aktivasi untuk VAD (0,0 hingga 1,0), ini default ke 0,5. Ambang yang lebih tinggi akan memerlukan audio yang lebih keras untuk mengaktifkan model, dan dengan demikian mungkin berkinerja lebih baik di lingkungan yang berisik.	Tidak.
└─ jenis	enum	Jenis deteksi belokan. Nilai yang mungkin: server_vad, semantic_vad	Tidak.
voice	VoiceIdsShared		Tidak.

Responses

Kode Status: 200

Deskripsi: Sesi berhasil dibuat.

Content-Type	Jenis	Deskripsi
application/json	RealtimeSessionCreateResponse

Buat - Transkripsi Sesi Waktu Nyata

POST https://{endpoint}/openai/realtimeapi/transcription_sessions?api-version=2025-04-01-preview

Buat token API sementara untuk digunakan dalam aplikasi sisi klien dengan API Realtime khusus untuk transkripsi realtime. Dapat dikonfigurasi dengan parameter sesi transcription_session.update yang sama dengan acara klien. Ini merespons dengan objek sesi, serta kunci client_secret yang berisi token API sementara yang dapat digunakan untuk mengautentikasi klien browser untuk API Realtime.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
termasuk	array	Kumpulan item yang akan disertakan dalam transkripsi. Item yang tersedia saat ini adalah: - item.input_audio_transcription.logprobs	Tidak.
input_audio_format	enum	Format dari audio input. Opsinya adalah pcm16, g711_ulaw, atau g711_alaw. Untuk pcm16, input audio harus PCM 16-bit dengan laju sampel 24kHz, saluran tunggal (mono), dan memiliki urutan byte little-endian. Nilai yang mungkin: pcm16, g711_ulaw, g711_alaw	Tidak.
input_audio_noise_reduction	objek	Konfigurasi untuk pengurangan kebisingan audio masukan. Ini dapat diatur ke null untuk menonaktifkan. Pengurangan kebisingan memfilter audio yang ditambahkan ke buffer audio input sebelum dikirim ke VAD dan model. Pemfilteran audio dapat meningkatkan VAD dan mengubah akurasi deteksi (mengurangi positif palsu) dan performa model dengan meningkatkan persepsi audio input.	Tidak.
└─ jenis	enum	Jenis pengurangan kebisingan. near_field adalah untuk mikrofon jarak dekat seperti headphone, far_field adalah untuk mikrofon jarak jauh seperti milik laptop atau mikrofon ruang konferensi. Nilai yang mungkin: near_field, far_field	Tidak.
input_audio_transcription	objek	Konfigurasi untuk transkripsi audio input. Klien dapat secara opsional mengatur bahasa dan meminta transkripsi, ini menawarkan panduan tambahan untuk layanan transkripsi.	Tidak.
└─ bahasa	string	Bahasa audio input. Menyediakan bahasa input dalam format ISO-639-1 (misalnya en) meningkatkan akurasi dan latensi.	Tidak.
└─ model	enum	Model yang digunakan untuk transkripsi, opsi saat ini adalah gpt-4o-transcribe, , gpt-4o-mini-transcribegpt-4o-mini-transcribe-2025-12-15, dan whisper-1. Nilai yang mungkin: gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, whisper-1	Tidak.
└─ perintah	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Untuk whisper-1, prompt tersebut merupakan daftar kata kunci. Untuk model-model gpt-4o-transcribe, perintahnya adalah string teks bebas, misalnya "kata-kata yang berkaitan dengan teknologi".	Tidak.
Modalitas		Sekumpulan modalitas yang dapat dijawab oleh model. Untuk menonaktifkan audio, atur ini ke ["text"].	Tidak.
turn_detection	objek	Konfigurasi untuk deteksi giliran, entah Server VAD atau Semantic VAD. Ini dapat diatur ke null untuk menonaktifkan, dalam hal ini klien harus memicu respons model secara manual. VAD Server berarti bahwa model akan mendeteksi awal dan akhir ucapan berdasarkan volume audio dan merespons di akhir ucapan pengguna. Semantic VAD lebih canggih dan menggunakan model deteksi giliran (bersama dengan VAD) untuk secara semantik memperkirakan apakah pengguna telah selesai berbicara, kemudian secara dinamis mengatur batas waktu berdasarkan probabilitas ini. Misalnya, jika audio pengguna perlahan-lahan menghilang dengan uhhm, model akan menilai kemungkinan rendah untuk akhir giliran dan menunggu lebih lama hingga pengguna melanjutkan berbicara. Ini dapat berguna untuk percakapan yang lebih alami, tetapi mungkin memiliki latensi yang lebih tinggi.	Tidak.
└─ buat_respons	Boolean	Apakah akan secara otomatis menghasilkan respons saat peristiwa penghentian VAD terjadi. Tidak tersedia untuk sesi transkripsi.	Tidak.	Benar
└─ bersemangat	enum	Digunakan hanya untuk semantic_vad mode. Keinginan model untuk merespons. low akan menunggu lebih lama bagi pengguna untuk terus berbicara, high akan merespons lebih cepat. auto adalah default dan setara dengan medium. Nilai yang mungkin: low, medium, high, auto	Tidak.
└─ interrupt_response	Boolean	Secara otomatis menghentikan respons yang sedang berlangsung dengan output ke percakapan default (misalnya conversation dari auto) ketika terjadi peristiwa mulai VAD. Tidak tersedia untuk sesi transkripsi.	Tidak.	Benar
└─ prefix_padding_ms (isian_awalan_dalam_milidetik)	bilangan bulat	Digunakan hanya untuk server_vad mode. Jumlah audio yang akan disertakan sebelum ucapan yang terdeteksi oleh VAD (dalam milidetik). Pengaturan awal adalah 300ms.	Tidak.
└─ durasi_keheningan_dalam_milidetik (silence_duration_ms)	bilangan bulat	Digunakan hanya untuk server_vad mode. Durasi keheningan untuk mendeteksi pemberhentian ucapan (dalam milidetik). Default ke 500ms. Dengan nilai yang lebih pendek, model akan merespons lebih cepat, tetapi mungkin melompat pada jeda singkat dari pengguna.	Tidak.
└─ ambang batas	nomor/angka	Digunakan hanya untuk server_vad mode. Ambang aktivasi untuk VAD (0,0 hingga 1,0), ini default ke 0,5. Ambang yang lebih tinggi akan memerlukan audio yang lebih keras untuk mengaktifkan model, dan dengan demikian mungkin berkinerja lebih baik di lingkungan yang berisik.	Tidak.
└─ jenis	enum	Jenis deteksi belokan. Nilai yang mungkin: server_vad, semantic_vad	Tidak.

Responses

Kode Status: 200

Deskripsi: Sesi berhasil dibuat.

Content-Type	Jenis	Deskripsi
application/json	RealtimeTranscriptionSessionCreateResponse

Responses

POST https://{endpoint}/openai/responses?api-version=2025-04-01-preview

Membuat tanggapan berdasarkan model.

Isi Permintaan

Content-Type: application/json

Nama	Tipe	Deskripsi	Diperlukan	Default
termasuk	array		Tidak.
Masukan	string atau array	Input model	Yes
instructions	string	Menyisipkan pesan sistem (atau pengembang) sebagai item pertama dalam konteks model. Saat menggunakan bersama dengan previous_response_id, instruksi dari respons sebelumnya tidak akan dibawa ke respons berikutnya. Ini memudahkan untuk menukar pesan sistem (atau pengembang) dalam respons baru.	Tidak.
max_output_tokens	bilangan bulat	Batas atas untuk jumlah token yang dapat dihasilkan untuk respons, termasuk token output dan status percakapan yang terlihat.	Tidak.
pemanggilan_alat_paralel	Boolean	Apakah akan mengizinkan model menjalankan panggilan alat secara paralel.	Tidak.	Benar
previous_response_id	string	ID unik dari respons sebelumnya ke model. Gunakan ini untuk membuat percakapan multi-giliran. Pelajari selengkapnya tentang status percakapan.	Tidak.
reasoning	Reasoning	Opsi konfigurasi untuk model penalaran.	Tidak.
simpan	Boolean	Apakah akan menyimpan respons model yang dihasilkan untuk pengambilan nanti melalui API.	Tidak.	Benar
aliran	Boolean	Jika diatur ke true, data respons model akan dialirkan ke klien saat dibuat menggunakan peristiwa yang dikirim server. Lihat bagian Streaming di bawah ini untuk informasi selengkapnya.	Tidak.	False
kirim pesan teks	objek	Opsi konfigurasi untuk respons teks dari model. Dapat berupa teks biasa atau data JSON terstruktur. Pelajari lebih lanjut: - Input dan output teks - Output Terstruktur	Tidak.
└─ bentuk	TextResponseFormatConfiguration	Objek yang menentukan format yang harus dihasilkan model. Mengonfigurasi { "type": "json_schema" } memungkinkan Output Terstruktur, yang memastikan model cocok dengan skema JSON yang Anda berikan. Format defaultnya adalah { "type": "text" } tanpa opsi tambahan. Tidak disarankan untuk model gpt-4o dan yang lebih baru: Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON yang lebih lama, yang memastikan pesan yang dihasilkan model adalah JSON yang valid. Penggunaan json_schema lebih disukai untuk model yang mendukungnya.	Tidak.
tool_choice	ToolChoiceOptions atau ToolChoiceTypes atau ToolChoiceFunction	Bagaimana model harus memilih alat (atau alat) mana yang akan digunakan saat menghasilkan respons. tools Lihat parameter untuk melihat cara menentukan alat mana yang dapat dipanggil model.	Tidak.
perangkat	array	Sekumpulan alat yang dapat dipanggil model ketika menghasilkan respons. Anda dapat menentukan alat mana yang akan digunakan dengan mengatur tool_choice parameter . Dua kategori alat yang dapat Anda sediakan untuk model adalah: - Alat bawaan: Alat yang disediakan oleh OpenAI yang memperluas kemampuan model	Tidak.
truncation	enum	Strategi pemotongan yang akan digunakan untuk respons model. - auto: Jika konteks respons ini dan yang sebelumnya melebihi ukuran jendela konteks model, model akan memotong respons agar sesuai dengan jendela konteks dengan menjatuhkan item input di tengah percakapan. - disabled (default): Jika respons model akan melebihi ukuran jendela konteks untuk model, permintaan akan gagal dengan kesalahan 400. Nilai yang mungkin: auto, disabled	Tidak.

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	response
text/event-stream	responseStreamEvent

Kode Status: default

Deskripsi: Layanan tidak tersedia

Content-Type	Jenis	Deskripsi
application/json	errorResponse

API Tanggapan - item-item input

GET https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

Mengambil respons model dengan ID yang diberikan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
response_id	path	Yes	string	ID respons yang akan diambil.
termasuk	kueri	Tidak.	array	Bidang tambahan untuk disertakan dalam respons. include Lihat parameter untuk Pembuatan respons di atas untuk informasi selengkapnya.

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	response

Kode Status: default

Deskripsi: Layanan tidak tersedia

Content-Type	Jenis	Deskripsi
application/json	errorResponse

Hapus tanggapan

DELETE https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

Menghapus respons model dengan ID yang diberikan.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
response_id	path	Yes	string	ID respons untuk dihapus.

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Kode Status: 404

Deskripsi: Tidak Ditemukan

Content-Type	Jenis	Deskripsi
application/json	kesalahan

Kode Status: default

Deskripsi: Layanan tidak tersedia

Content-Type	Jenis	Deskripsi
application/json	errorResponse

API Respons - daftar item respons

GET https://{endpoint}/openai/responses/{response_id}/input_items?api-version=2025-04-01-preview

Mengembalikan daftar item input untuk respons tertentu.

Parameter URI

Nama	In	Diperlukan	Tipe	Deskripsi
titik akhir	path	Yes	string URL	Titik akhir OpenAI Azure yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama sumber daya OpenAI Azure Anda). https://{your-resource-name}.openai. azure.com
response_id	path	Yes	string	ID respons untuk mendapatkan item input.
limit	kueri	Tidak.	bilangan bulat	Batas jumlah objek yang akan dikembalikan. Batas dapat berkisar antara 1 dan 100, dan defaultnya adalah 20.
order	kueri	Tidak.	string Nilai yang mungkin: asc, desc	Urutan untuk mengembalikan item input. Defaultnya adalah asc. - asc: Mengembalikan item input dalam urutan naik. - desc: Mengembalikan item input dalam urutan turun.
after	kueri	Tidak.	string	ID item untuk mencantumkan item setelahnya, digunakan dalam penomoran halaman.
sebelum	kueri	Tidak.	string	ID item untuk mencantumkan item sebelumnya, digunakan dalam penomoran halaman.

Header Permohonan

Gunakan autentikasi berbasis token atau kunci API. Mengautentikasi dengan autentikasi berbasis token direkomendasikan dan lebih aman.

Nama	Diperlukan	Tipe	Deskripsi
Authorization	Benar	string	Contoh :Authorization: Bearer {Azure_OpenAI_Auth_Token} Untukan menghasilkan token autentikasi menggunakan Azure CLI: az account get-access-token --resource https://cognitiveservices.azure.com Jenis: oauth2 Url Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize cakupan: https://ai.azure.com/.default
kunci API	Benar	string	Sediakan kunci API OpenAI Azure di sini

Responses

Kode Status: 200

Deskripsi: OK

Content-Type	Jenis	Deskripsi
application/json	responseItemList

Komponen

responKesalahan

Nama	Tipe	Deskripsi	Diperlukan	Default
galat	kesalahan		Tidak.

errorBase

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

galat

Nama	Tipe	Deskripsi	Diperlukan	Default
inner_error	innerError	Kesalahan internal dengan detail tambahan.	Tidak.
param	string		Tidak.
jenis	string		Tidak.

innerError

Kesalahan internal dengan detail tambahan.

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

Kode Kesalahan Dalam

Kode kesalahan untuk objek kesalahan internal.

Harta benda	Nilai
Deskripsi	Kode kesalahan untuk objek kesalahan internal.
Jenis	string
Nilai	ResponsibleAIPolicyViolation

dalleErrorResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
galat	dalleError		Tidak.

dalleError

Nama	Tipe	Deskripsi	Diperlukan	Default
inner_error	dalleInnerError	Kesalahan internal dengan detail tambahan.	Tidak.
param	string		Tidak.
jenis	string		Tidak.

dalleInnerError

Kesalahan internal dengan detail tambahan.

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

contentFilterCompletionTextSpan

Menjelaskan rentang dalam teks penyelesaian yang dihasilkan. Offset 0 adalah titik kode UTF32 pertama dari teks penyelesaian.

Nama	Tipe	Deskripsi	Diperlukan	Default
completion_end_offset	bilangan bulat	Offset titik kode UTF32 pertama yang dikecualikan dari rentang. Bidang ini selalu sama dengan completion_start_offset untuk rentang kosong. Bidang ini selalu lebih besar dari completion_start_offset untuk rentang yang tidak kosong.	Yes
completion_start_offset	bilangan bulat	Offset titik kode UTF32 yang memulai rentang.	Yes

HasilFilterKontenDasar

Nama	Tipe	Deskripsi	Diperlukan	Default
filtered	Boolean		Yes

HasilTingkatKeparahanPenyaringanKonten

Nama	Tipe	Deskripsi	Diperlukan	Default
filtered	Boolean		Yes
severity	string		Tidak.

Hasil Deteksi Penyaringan Konten

Nama	Tipe	Deskripsi	Diperlukan	Default
detected	Boolean		Tidak.
filtered	Boolean		Yes

Deteksi Filter Konten dengan Hasil Kutipan

Nama	Tipe	Deskripsi	Diperlukan	Default
kutipan	objek		Tidak.
└─ URL	string		Tidak.
└─ Lisensi	string		Tidak.

contentFilterDetectedWithCompletionTextSpansResult

Nama	Tipe	Deskripsi	Diperlukan	Default
details	array		Tidak.

contentFilterIdResult

Nama	Tipe	Deskripsi	Diperlukan	Default
filtered	Boolean		Yes
id	string		Tidak.

dasarHasilPenyaringanKonten

Informasi tentang hasil pemfilteran konten.

Nama	Tipe	Deskripsi	Diperlukan	Default
custom_blocklists	contentFilterDetailedResults	Hasil pemfilteran konten dengan detail id filter konten untuk segmen yang difilter.	Tidak.
galat	errorBase		Tidak.
hate	hasil tingkat keparahan penyaring konten		Tidak.
profanity	contentFilterDetectedResult		Tidak.
self_harm	hasil tingkat keparahan penyaring konten		Tidak.
sexual	hasil tingkat keparahan penyaring konten		Tidak.
violence	hasil tingkat keparahan penyaring konten		Tidak.

hasilPromptFilterKonten

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

Nama	Tipe	Deskripsi	Diperlukan	Default
custom_blocklists	contentFilterDetailedResults	Hasil pemfilteran konten dengan detail id filter konten untuk segmen yang difilter.	Tidak.
galat	errorBase		Tidak.
hate	hasil tingkat keparahan penyaring konten		Tidak.
indirect_attack	contentFilterDetectedResult		Tidak.
jailbreak	contentFilterDetectedResult		Tidak.
profanity	contentFilterDetectedResult		Tidak.
self_harm	hasil tingkat keparahan penyaring konten		Tidak.
sexual	hasil tingkat keparahan penyaring konten		Tidak.
violence	hasil tingkat keparahan penyaring konten		Tidak.

hasil pilihan filter konten

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

Nama	Tipe	Deskripsi	Diperlukan	Default
custom_blocklists	contentFilterDetailedResults	Hasil pemfilteran konten dengan detail id filter konten untuk segmen yang difilter.	Tidak.
galat	errorBase		Tidak.
hate	hasil tingkat keparahan penyaring konten		Tidak.
profanity	contentFilterDetectedResult		Tidak.
protected_material_code	KontenTersaringTerdeteksiDenganHasilKutipan		Tidak.
protected_material_text	contentFilterDetectedResult		Tidak.
self_harm	hasil tingkat keparahan penyaring konten		Tidak.
sexual	hasil tingkat keparahan penyaring konten		Tidak.
ungrounded_material	contentFilterDetectedWithCompletionTextSpansResult		Tidak.
violence	hasil tingkat keparahan penyaring konten		Tidak.

contentFilterDetailedResults

Hasil pemfilteran konten dengan detail id filter konten untuk segmen yang difilter.

Nama	Tipe	Deskripsi	Diperlukan	Default
details	array		Tidak.
filtered	Boolean		Yes

hasilPemfilteranPrompt

Hasil pemfilteran konten untuk satu permintaan dalam permintaan.

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

promptFilterResults

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

Tidak ada properti yang ditentukan untuk komponen ini.

hasil penyaringan konten dalle

Informasi tentang hasil pemfilteran konten.

Nama	Tipe	Deskripsi	Diperlukan	Default
hate	hasil tingkat keparahan penyaring konten		Tidak.
self_harm	hasil tingkat keparahan penyaring konten		Tidak.
sexual	hasil tingkat keparahan penyaring konten		Tidak.
violence	hasil tingkat keparahan penyaring konten		Tidak.

HasilPenyaringanDalle

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

Nama	Tipe	Deskripsi	Diperlukan	Default
custom_blocklists	contentFilterDetailedResults	Hasil pemfilteran konten dengan detail id filter konten untuk segmen yang difilter.	Tidak.
hate	hasil tingkat keparahan penyaring konten		Tidak.
jailbreak	contentFilterDetectedResult		Tidak.
profanity	contentFilterDetectedResult		Tidak.
self_harm	hasil tingkat keparahan penyaring konten		Tidak.
sexual	hasil tingkat keparahan penyaring konten		Tidak.
violence	hasil tingkat keparahan penyaring konten		Tidak.

PermintaanPenyelesaianObrolanUmum

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

buatPermintaanPenyelesaian

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

createCompletionResponse

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

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

buatPermintaanPenyelesaianChat

Nama	Tipe	Deskripsi	Diperlukan	Default
audio	objek	Parameter untuk output audio. Diperlukan saat output audio diminta dengan modalities: ["audio"].	Tidak.
└─ bentuk	enum	Menentukan format audio output. Harus salah satu dari wav, mp3, flac, opus, atau pcm16. Nilai yang mungkin: wav, , mp3flac, opus,pcm16	Tidak.
└─ suara	enum	Menentukan jenis suara. Suara yang didukung adalah alloy, echo, fable, onyx, nova, dan shimmer. Nilai yang mungkin: alloy, , echofable, onyx, nova,shimmer	Tidak.
data_sources	array	Entri konfigurasi untuk Azure ekstensi obrolan OpenAI yang menggunakannya. Spesifikasi tambahan ini hanya kompatibel dengan Azure OpenAI.	Tidak.
penalti frekuensi	nomor/angka	Angka antara -2,0 dan 2,0. Nilai positif memberi penalti pada token baru berdasarkan frekuensi kemunculannya dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi secara persis kalimat yang sama.	Tidak.	0
function_call	teks atau chatCompletionFunctionCallOption	Diganti untuk tool_choice. Mengontrol mana fungsi (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil fungsi dan sebaliknya menghasilkan pesan. auto berarti model dapat memilih antara menghasilkan pesan atau memanggil fungsi. Menentukan fungsi tertentu melalui {"name": "my_function"} memaksa model untuk memanggil fungsi tersebut. none adalah default ketika tidak ada fungsi yang ada. auto adalah default jika fungsi ada.	Tidak.
functions	array	Diganti untuk tools. Daftar fungsi yang digunakan model dapat menghasilkan input JSON.	Tidak.
logit_bias	objek	Ubah kemungkinan token tertentu muncul dalam penyelesaian. Menerima objek JSON yang memetakan token (ditentukan oleh ID token mereka di tokenizer) ke nilai bias terkait dari -100 hingga 100. Secara matematis, bias ditambahkan ke logit yang dihasilkan oleh model sebelum pengambilan sampel. Efek yang tepat bervariasi per model, tetapi nilai antara -1 dan 1 harus mengurangi atau meningkatkan kemungkinan pemilihan; nilai seperti -100 atau 100 harus menghasilkan larangan atau pilihan eksklusif dari token yang relevan.	Tidak.	Tidak ada
logprobs	Boolean	Apakah akan mengembalikan probabilitas log dari token output atau tidak. Jika benar, mengembalikan probabilitas logaritmik dari setiap token keluaran yang dikembalikan di content dari message.	Tidak.	False
max_completion_tokens	bilangan bulat	Batas atas untuk jumlah token yang dapat dihasilkan untuk penyelesaian, termasuk token output yang terlihat dan token penalaran.	Tidak.
maksimum token	bilangan bulat	Jumlah maksimum token yang dapat dihasilkan dalam penyelesaian obrolan. Panjang total token input dan token yang dihasilkan dibatasi oleh panjang konteks model.	Tidak.
messages	array	Daftar pesan yang terdiri dari percakapan sejauh ini. Contoh kode Python.	Yes
metadata	objek	Tag dan nilai yang ditentukan pengembang yang digunakan untuk memfilter penyelesaian di dasbor penyelesaian yang disimpan.	Tidak.
Modalitas	ChatCompletionModalities	Jenis output yang Anda inginkan untuk dihasilkan model untuk permintaan ini. Sebagian besar model mampu menghasilkan teks, yang merupakan default: ["text"] Model ini gpt-4o-audio-preview juga dapat digunakan untuk menghasilkan audio. Untuk meminta agar model ini menghasilkan respons teks dan audio, Anda dapat menggunakan: ["text", "audio"]	Tidak.
n	bilangan bulat	Berapa banyak pilihan penyelesaian obrolan yang akan dihasilkan untuk setiap pesan input. Perhatikan bahwa Anda akan dikenakan biaya berdasarkan jumlah token yang dihasilkan di semua pilihan. Pertahankan n sebagai 1 untuk meminimalkan biaya.	Tidak.	1
pemanggilan_alat_paralel	ParallelToolCalls	Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.	Tidak.	Benar
prediksi	PredictionContent	Konfigurasi untuk Output Yang Diprediksi, yang dapat sangat meningkatkan waktu respons ketika sebagian besar respons model diketahui sebelumnya. Ini paling umum ketika Anda meregenerasi file hanya dengan perubahan kecil pada sebagian besar konten.	Tidak.
presence_penalty (penalti kehadiran)	nomor/angka	Angka antara -2,0 dan 2,0. Nilai positif memberikan penalti pada token baru berdasarkan kemunculannya dalam teks sejauh ini, meningkatkan kemungkinan model berbicara tentang topik baru.	Tidak.	0
upaya penalaran	enum	model o1 saja Membatasi upaya penalaran untuk model penalaran. Nilai yang saat ini didukung adalah low, medium, dan high. Mengurangi upaya penalaran dapat mengakibatkan respons yang lebih cepat dan lebih sedikit token yang digunakan pada penalaran dalam respons. Nilai yang mungkin: low, medium, high	Tidak.
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 lebih baru dari gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_schema", "json_schema": {...} } mengaktifkan Output Terstruktur yang menjamin model cocok dengan skema JSON yang Anda berikan. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang menjamin pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan deretan ruang kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berlangsung lama dan tampak "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	Tidak.
seed	bilangan bulat	Fitur ini ada di Beta. Jika ditentukan, sistem kami melakukan upaya terbaik untuk melakukan sampling secara deterministik, sehingga permintaan berulang dengan seed dan parameter yang sama harus mengembalikan hasil yang sama. Determinisme tidak dijamin, dan Anda harus merujuk ke system_fingerprint parameter respons untuk memantau perubahan di backend.	Tidak.
stop	string atau array	Hingga 4 urutan di mana API berhenti menghasilkan token lebih lanjut.	Tidak.
simpan	Boolean	Apakah menyimpan output permintaan penyelesaian obrolan ini untuk digunakan dalam distilasi model atau produk evaluasi kami atau tidak.	Tidak.
aliran	Boolean	Jika diatur, delta pesan parsial dikirim, seperti di ChatGPT. Token dikirim sebagai peristiwa yang dikirim server khusus data saat tersedia, dengan aliran dihentikan oleh pesan data: [DONE] . Contoh kode Python.	Tidak.	False
stream_options	chatCompletionStreamOptions	Opsi untuk respons streaming. Hanya atur ini saat Anda mengatur stream: true.	Tidak.	Tidak ada
suhu	nomor/angka	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Kami umumnya merekomendasikan untuk memodifikasi ini atau top_p tetapi tidak keduanya.	Tidak.	1
tool_choice	chatCompletionToolChoiceOption	Mengontrol alat mana (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil alat apa pun dan sebaliknya menghasilkan pesan. auto berarti model dapat memilih antara menghasilkan pesan atau memanggil satu atau beberapa alat. required berarti model harus memanggil satu atau beberapa alat. Menentukan alat tertentu melalui {"type": "function", "function": {"name": "my_function"}} memaksa model untuk memanggil alat tersebut. none adalah default ketika tidak ada alat yang ada. auto adalah default jika alat ada.	Tidak.
perangkat	array	Daftar alat yang mungkin dipanggil model. Saat ini, hanya fungsi yang ditunjang sebagai sarana. Gunakan ini untuk menyediakan daftar fungsi untuk model yang dapat menghasilkan input JSON. Maksimal 128 fungsi didukung.	Tidak.
top_logprobs	bilangan bulat	Bilangan bulat antara 0 dan 20 yang menentukan jumlah token yang kemungkinan besar akan dikembalikan pada setiap posisi token, masing-masing dengan probabilitas log terkait. logprobs harus diatur ke true jika parameter ini digunakan.	Tidak.
top_p	nomor/angka	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk memodifikasi ini atau temperature tetapi tidak keduanya.	Tidak.	1
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	Tidak.
user_security_context	userSecurityContext	Konteks keamanan pengguna berisi beberapa parameter yang menjelaskan aplikasi AI itu sendiri, dan pengguna akhir yang berinteraksi dengan aplikasi AI. Bidang ini membantu tim operasi keamanan Anda untuk menyelidiki dan mengurangi insiden keamanan dengan memberikan pendekatan komprehensif untuk melindungi aplikasi AI Anda. Learn lebih tentang melindungi aplikasi AI menggunakan Microsoft Defender for Cloud.	Tidak.

userSecurityContext

Konteks keamanan pengguna berisi beberapa parameter yang menjelaskan aplikasi AI itu sendiri, dan pengguna akhir yang berinteraksi dengan aplikasi AI. Bidang ini membantu tim operasi keamanan Anda untuk menyelidiki dan mengurangi insiden keamanan dengan memberikan pendekatan komprehensif untuk melindungi aplikasi AI Anda. Learn lebih tentang melindungi aplikasi AI menggunakan Microsoft Defender for Cloud.

Nama	Tipe	Deskripsi	Diperlukan	Default
application_name	string	Nama aplikasi. Informasi pribadi sensitif tidak boleh disertakan dalam bidang ini.	Tidak.
end_user_id	string	Pengidentifikasi ini adalah ID objek pengguna Microsoft Entra ID (sebelumnya Azure Active Directory) yang digunakan untuk mengautentikasi pengguna akhir dalam aplikasi AI generatif. Informasi pribadi sensitif tidak boleh disertakan dalam bidang ini.	Tidak.
end_user_tenant_id	string	ID penyewa Microsoft 365 milik pengguna akhir. Ini diperlukan ketika aplikasi AI generatif adalah multi penyewa.	Tidak.
source_ip	string	Mengambil alamat IP klien asli, menerima format IPv4 dan IPv6.	Tidak.

chatCompletionFunctions

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

Opsi pemanggilan fungsi penyelesaian obrolan

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

Nama	Tipe	Deskripsi	Diperlukan	Default
Nama	string	Nama fungsi yang akan dipanggil.	Yes

chatCompletionFunctionParameters

Parameter yang diterima fungsi, dijelaskan sebagai objek Skema JSON. Lihat guide/ misalnya, dan referensi Skema JSON untuk dokumentasi tentang format.

Tidak ada properti yang ditentukan untuk komponen ini.

Pesan Permintaan Penyelesaian Obrolan

Komponen ini bisa menjadi salah satu hal berikut:

• ChatCompletionRequestDeveloperMessage
• chatCompletionRequestSystemMessage
• chatCompletionRequestUserMessage
• chatCompletionRequestAssistantMessage
• chatCompletionRequestToolMessage
• chatCompletionRequestFunctionMessage

ChatCompletionRequestDeveloperMessage

Instruksi yang disediakan pengembang yang harus diikuti model, terlepas dari pesan yang dikirim oleh pengguna. Dengan model o1 dan yang lebih baru, developer pesan menggantikan pesan sebelumnya system .

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	string atau array	Konten pesan pengembang.	Yes
Nama	string	Nama opsional untuk peserta. Menyediakan informasi model untuk membedakan antara peserta dengan peran yang sama.	Tidak.
peran	enum	Peran penulis pesan, dalam hal developerini . Nilai yang mungkin: developer	Yes

chatCompletionRequestSystemMessage

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

pesanPenggunaPermintaanPenyelesaianObrolan

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

PermintaanPesanBantuanChat

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	string atau array	Isi pesan asisten. Diperlukan kecuali tool_calls atau function_call ditentukan.	Tidak.
function_call	objek	Tidak digunakan lagi dan digantikan oleh tool_calls. Nama dan argumen fungsi yang harus dipanggil, seperti yang dihasilkan oleh model.	Tidak.
└─ argumen-argumen	string	Argumen untuk memanggil fungsi dengan, seperti yang dihasilkan oleh model dalam format JSON. Perhatikan bahwa model tidak selalu menghasilkan JSON yang valid, dan mungkin berhalusinasi parameter yang tidak ditentukan oleh skema fungsi Anda. Validasi argumen dalam kode Anda sebelum memanggil fungsi Anda.	Tidak.
└─ nama	string	Nama fungsi yang akan dipanggil.	Tidak.
Nama	string	Nama opsional untuk peserta. Menyediakan informasi model untuk membedakan antara peserta dengan peran yang sama.	Tidak.
refusal	string	Pesan penolakan oleh asisten.	Tidak.
peran	enum	Peran penulis pesan, dalam hal assistantini . Nilai yang mungkin: assistant	Yes
tool_calls	chatCompletionMessageToolCalls	Panggilan alat yang dihasilkan oleh model, seperti panggilan fungsi.	Tidak.

chatCompletionRequestToolMessage

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	string atau array	Isi pesan alat.	Yes
peran	enum	Peran penulis pesan, dalam hal toolini . Nilai yang mungkin: tool	Yes
tool_call_id	string	Panggilan alat yang direspons pesan ini.	Yes

chatCompletionRequestFunctionMessage

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

chatCompletionRequestDeveloperMessageContentPart

Komponen ini bisa menjadi salah satu hal berikut:

• chatCompletionRequestMessageContentPartText

BagianKontenPesanSistemPermintaanPenyelesaianObrolan

Komponen ini bisa menjadi salah satu hal berikut:

• chatCompletionRequestMessageContentPartText

BagianKontenPesanPenggunaPermintaanPenyelesaianObrolan

Komponen ini bisa menjadi salah satu hal berikut:

• chatCompletionRequestMessageContentPartText
• chatCompletionRequestMessageContentPartImage
• chatCompletionRequestMessageContentPartAudio

PermintaanKompletasiPesanBagianKontenAsistenChat

Komponen ini bisa menjadi salah satu hal berikut:

• chatCompletionRequestMessageContentPartText
• chatCompletionRequestMessageContentPartRefusal

AlatPesanKontenPermintaanPenyelesaianChat

Komponen ini bisa menjadi salah satu hal berikut:

• chatCompletionRequestMessageContentPartText

BagianKontenPesanPermintaanChatLengkap

Nama	Tipe	Deskripsi	Diperlukan	Default
kirim pesan teks	string	Isi teks.	Yes
jenis	enum	Jenis bagian konten. Nilai yang mungkin: text	Yes

chatCompletionRequestMessageContentPartAudio

Nama	Tipe	Deskripsi	Diperlukan	Default
input_audio	objek		Yes
└─ data	string	Data audio yang dikodekan Base64.	Tidak.
└─ bentuk	enum	Format data audio yang dikodekan. Saat ini mendukung "wav" dan "mp3". Nilai yang mungkin: wav, mp3	Tidak.
jenis	enum	Jenis bagian konten. Selalu input_audio. Nilai yang mungkin: input_audio	Yes

kontenPesanPermintaanPenyelesaianObrolanBagianGambar

Nama	Tipe	Deskripsi	Diperlukan	Default
image_url	objek		Yes
└─ rinci	enum	Menentukan tingkat detail gambar. Pelajari selengkapnya di panduan Vision. Nilai yang mungkin: auto, low, high	Tidak.
└─ url	string	Baik URL gambar atau data gambar yang telah dikodekan dalam base64.	Tidak.
jenis	enum	Jenis bagian konten. Nilai yang mungkin: image_url	Yes

PenolakanBagianIsiPesanPermintaanPenyelesaianObrolan

Nama	Tipe	Deskripsi	Diperlukan	Default
refusal	string	Pesan penolakan yang dihasilkan oleh model.	Yes
jenis	enum	Jenis bagian konten. Nilai yang mungkin: refusal	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.

###Discriminator untuk azureChatExtensionConfiguration

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
azure_search	azureSearchChatExtensionConfiguration
azure_cosmos_db	azureCosmosDBChatExtensionConfiguration
elasticsearch	elasticsearchChatExtensionConfiguration
mongo_db	mongoDBChatExtensionConfiguration
pinecone	pineconeChatExtensionConfiguration

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

Harta benda	Nilai
Deskripsi	Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh permintaan penyelesaian obrolan yang harus menggunakan ekstensi obrolan Azure OpenAI untuk menambah perilaku respons. Penggunaan konfigurasi ini hanya kompatibel dengan Azure OpenAI.
Jenis	string
Nilai	azure_search azure_cosmos_db elasticsearch mongo_db pinecone

azureSearchChatExtensionConfiguration

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

Nama	Tipe	Deskripsi	Diperlukan	Default
parameter	azureSearchChatExtensionParameters	Parameter untuk pencarian Azure saat digunakan sebagai ekstensi obrolan OpenAI Azure.	Tidak.
jenis	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.	Yes

azureSearchChatExtensionParameter

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

Nama	Tipe	Deskripsi	Diperlukan	Default
allow_partial_result	Boolean	Jika ditentukan sebagai true, sistem akan mengizinkan hasil pencarian parsial untuk digunakan dan permintaan gagal jika semua kueri gagal. Jika tidak ditentukan, atau ditentukan sebagai false, permintaan akan gagal jika ada kueri pencarian yang gagal.	Tidak.	False
autentikasi	onYourDataApiKeyAuthenticationOptions atau onYourDataSystemAssignedManagedIdentityAuthenticationOptions atau onYourDataUserAssignedManagedIdentityAuthenticationOptions atau onYourDataAccessTokenAuthenticationOptions		Yes
ketergantungan_penyematan	onYourDataEndpointVectorizationSource atau onYourDataDeploymentNameVectorizationSource atau onYourDataIntegratedVectorizationSource		Tidak.
titik akhir	string	Jalur titik akhir absolut untuk sumber daya pencarian Azure digunakan.	Yes
pemetaan_bidang	Opsi Pemetaan Bidang Indeks AzureSearch	Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya pencarian Azure yang dikonfigurasi.	Tidak.
filter	string	Filter pencarian.	Tidak.
dalam cakupan	Boolean	Apakah kueri harus dibatasi untuk menggunakan data terindeks.	Tidak.
include_contexts	array	Properti konteks output yang disertakan. Jika tidak ditentukan, nilai defaultnya adalah citations dan intent.	Tidak.
nama indeks	string	Nama indeks yang akan digunakan sebagai tersedia dalam sumber daya pencarian Azure yang dirujuk.	Yes
max_search_queries	bilangan bulat	Jumlah maksimum kueri yang ditulis ulang harus dikirim ke penyedia pencarian untuk satu pesan pengguna. Jika tidak ditentukan, sistem akan memutuskan jumlah kueri yang akan dikirim.	Tidak.
jenis_kueri	azureSearchQueryType	Jenis kueri pengambilan pencarian Azure yang harus dijalankan saat menggunakannya sebagai ekstensi obrolan OpenAI Azure.	Tidak.
konfigurasi semantik	string	Konfigurasi semantik tambahan untuk pertanyaan.	Tidak.
keketatan	bilangan bulat	Ketatnya pemfilteran relevansi pencarian yang dikonfigurasi. Semakin tinggi ketegasan, semakin tinggi presisi tetapi pengenalan jawaban yang lebih rendah.	Tidak.
top_n_documents	bilangan bulat	Jumlah dokumen terbanyak yang dipilih untuk ditampilkan untuk kueri yang dipilih.	Tidak.

OpsiPemetaanBidangIndeksPencarianAzure

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

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

azureSearchQueryType

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

Harta benda	Nilai
Deskripsi	Jenis kueri pengambilan pencarian Azure yang harus dijalankan saat menggunakannya sebagai ekstensi obrolan OpenAI Azure.
Jenis	string
Nilai	simple semantic vector vector_simple_hybrid vector_semantic_hybrid

azureCosmosDBChatExtensionConfiguration

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

Nama	Tipe	Deskripsi	Diperlukan	Default
parameter	azureCosmosDBChatExtensionParameters	Parameter yang digunakan saat mengonfigurasi ekstensi obrolan OpenAI On Your Data Azure saat menggunakan Azure Cosmos DB untuk MongoDB vCore.	Tidak.
jenis	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.	Yes

azureCosmosDBChatExtensionParameters

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

Nama	Tipe	Deskripsi	Diperlukan	Default
allow_partial_result	Boolean	Jika ditentukan sebagai true, sistem akan mengizinkan hasil pencarian parsial untuk digunakan dan permintaan gagal jika semua kueri gagal. Jika tidak ditentukan, atau ditentukan sebagai false, permintaan akan gagal jika ada kueri pencarian yang gagal.	Tidak.	False
autentikasi	padaOpsiOtentikasiStringKoneksiDataAnda	Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan connection string.	Yes
nama_kontainer	string	Nama kontainer sumber daya Azure Cosmos DB.	Yes
nama_basis_data	string	Nama database MongoDB vCore untuk digunakan dengan Azure Cosmos DB.	Yes
ketergantungan_penyematan	onYourDataEndpointVectorizationSource atau onYourDataDeploymentNameVectorizationSource		Yes
pemetaan_bidang	azureCosmosDBFieldMappingOptions	Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Azure Cosmos DB yang dikonfigurasi.	Yes
dalam cakupan	Boolean	Apakah kueri harus dibatasi untuk menggunakan data terindeks.	Tidak.
include_contexts	array	Properti konteks output yang disertakan. Jika tidak ditentukan, nilai defaultnya adalah citations dan intent.	Tidak.
nama indeks	string	Nama indeks MongoDB vCore untuk digunakan dengan Azure Cosmos DB.	Yes
max_search_queries	bilangan bulat	Jumlah maksimum kueri yang ditulis ulang harus dikirim ke penyedia pencarian untuk satu pesan pengguna. Jika tidak ditentukan, sistem akan memutuskan jumlah kueri yang akan dikirim.	Tidak.
keketatan	bilangan bulat	Ketatnya pemfilteran relevansi pencarian yang dikonfigurasi. Semakin tinggi ketegasan, semakin tinggi presisi tetapi pengenalan jawaban yang lebih rendah.	Tidak.
top_n_documents	bilangan bulat	Jumlah dokumen terbanyak yang dipilih untuk ditampilkan untuk kueri yang dipilih.	Tidak.

Azure Cosmos DB Pilihan Pemetaan Bidang

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

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

elasticsearchChatExtensionConfiguration

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

Nama	Tipe	Deskripsi	Diperlukan	Default
parameter	elasticsearchChatExtensionParameters	Parameter yang digunakan saat mengonfigurasi Elasticsearch® sebagai ekstensi obrolan OpenAI Azure.	Tidak.
jenis	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.	Yes

elasticsearchChatExtensionParameters

Parameter yang digunakan saat mengonfigurasi Elasticsearch® sebagai ekstensi obrolan OpenAI Azure.

Nama	Tipe	Deskripsi	Diperlukan	Default
allow_partial_result	Boolean	Jika ditentukan sebagai true, sistem akan mengizinkan hasil pencarian parsial untuk digunakan dan permintaan gagal jika semua kueri gagal. Jika tidak ditentukan, atau ditentukan sebagai false, permintaan akan gagal jika ada kueri pencarian yang gagal.	Tidak.	False
autentikasi	onYourDataKeyAndKeyIdAuthenticationOptions atau onYourDataEncodedApiKeyAuthenticationOptions		Yes
ketergantungan_penyematan	onYourDataEndpointVectorizationSource atau onYourDataDeploymentNameVectorizationSource atau onYourDataModelIdVectorizationSource		Tidak.
titik akhir	string	Titik akhir Elasticsearch®.	Yes
pemetaan_bidang	elasticsearchIndexFieldMappingOptions	Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Elasticsearch® yang dikonfigurasi.	Tidak.
dalam cakupan	Boolean	Apakah kueri harus dibatasi untuk menggunakan data terindeks.	Tidak.
include_contexts	array	Properti konteks output yang disertakan. Jika tidak ditentukan, nilai defaultnya adalah citations dan intent.	Tidak.
nama indeks	string	Nama indeks Elasticsearch®.	Yes
max_search_queries	bilangan bulat	Jumlah maksimum kueri yang ditulis ulang harus dikirim ke penyedia pencarian untuk satu pesan pengguna. Jika tidak ditentukan, sistem akan memutuskan jumlah kueri yang akan dikirim.	Tidak.
jenis_kueri	elasticsearchQueryType	Jenis kueri pengambilan Elasticsearch® yang harus dijalankan saat menggunakannya sebagai ekstensi obrolan OpenAI Azure.	Tidak.
keketatan	bilangan bulat	Ketatnya pemfilteran relevansi pencarian yang dikonfigurasi. Semakin tinggi ketegasan, semakin tinggi presisi tetapi pengenalan jawaban yang lebih rendah.	Tidak.
top_n_documents	bilangan bulat	Jumlah dokumen terbanyak yang dipilih untuk ditampilkan untuk kueri yang dipilih.	Tidak.

elasticsearchIndexFieldMappingOptions

Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Elasticsearch® yang dikonfigurasi.

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

elasticsearchQueryType

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

Harta benda	Nilai
Deskripsi	Jenis kueri pengambilan Elasticsearch® yang harus dijalankan saat menggunakannya sebagai ekstensi obrolan OpenAI Azure.
Jenis	string
Nilai	simple vector

mongoDBChatExtensionConfiguration

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

Nama	Tipe	Deskripsi	Diperlukan	Default
parameter	mongoDBChatExtensionParameters	Parameter yang digunakan saat mengonfigurasi ekstensi obrolan OpenAI On Your Data Azure saat menggunakan Mongo DB.	Tidak.
jenis	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.	Yes

mongoDBChatExtensionParameters

Parameter yang digunakan saat mengonfigurasi ekstensi obrolan OpenAI On Your Data Azure saat menggunakan Mongo DB.

Nama	Tipe	Deskripsi	Diperlukan	Default
allow_partial_result	Boolean	Jika ditentukan sebagai true, sistem akan mengizinkan hasil pencarian parsial untuk digunakan dan permintaan gagal jika semua kueri gagal. Jika tidak ditentukan, atau ditentukan sebagai false, permintaan akan gagal jika ada kueri pencarian yang gagal.	Tidak.	False
app_name	string	Nama Aplikasi Mongo DB.	Yes
autentikasi	onYourDataUsernameAndPasswordAuthenticationOptions	Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan nama pengguna dan kata sandi.	Yes
collection_name	string	Nama Koleksi Mongo DB.	Yes
nama_basis_data	string	Nama database Mongo DB.	Yes
ketergantungan_penyematan	onYourDataEndpointVectorizationSource atau onYourDataDeploymentNameVectorizationSource		Yes
titik akhir	string	Nama titik akhir kluster Mongo DB.	Yes
pemetaan_bidang	mongoDBFieldMappingOptions	Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Mongo DB yang dikonfigurasi.	Yes
dalam cakupan	Boolean	Apakah kueri harus dibatasi untuk menggunakan data terindeks.	Tidak.
include_contexts	array	Properti konteks output yang disertakan. Jika tidak ditentukan, nilai defaultnya adalah citations dan intent.	Tidak.
nama indeks	string	Nama indeks Mongo DB.	Yes
max_search_queries	bilangan bulat	Jumlah maksimum kueri yang ditulis ulang harus dikirim ke penyedia pencarian untuk satu pesan pengguna. Jika tidak ditentukan, sistem akan memutuskan jumlah kueri yang akan dikirim.	Tidak.
keketatan	bilangan bulat	Ketatnya pemfilteran relevansi pencarian yang dikonfigurasi. Semakin tinggi ketegasan, semakin tinggi presisi tetapi pengenalan jawaban yang lebih rendah.	Tidak.
top_n_documents	bilangan bulat	Jumlah dokumen terbanyak yang dipilih untuk ditampilkan untuk kueri yang dipilih.	Tidak.

mongoDBFieldMappingOptions

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

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

pineconeChatExtensionConfiguration

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

Nama	Tipe	Deskripsi	Diperlukan	Default
parameter	pineconeChatExtensionParameters	Parameter untuk mengonfigurasi ekstensi obrolan Azure OpenAI Pinecone.	Tidak.
jenis	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.	Yes

pineconeChatExtensionParameters

Parameter untuk mengonfigurasi ekstensi obrolan Azure OpenAI Pinecone.

Nama	Tipe	Deskripsi	Diperlukan	Default
allow_partial_result	Boolean	Jika ditentukan sebagai true, sistem akan mengizinkan hasil pencarian parsial untuk digunakan dan permintaan gagal jika semua kueri gagal. Jika tidak ditentukan, atau ditentukan sebagai false, permintaan akan gagal jika ada kueri pencarian yang gagal.	Tidak.	False
autentikasi	OpsiOtentikasiKunciApiDataAnda	Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan kunci API.	Yes
ketergantungan_penyematan	onYourDataDeploymentNameVectorizationSource	Detail sumber vektorisasi, digunakan oleh Azure OpenAI On Your Data saat menerapkan pencarian vektor, yang didasarkan pada nama penyebaran model penyematan internal dalam sumber daya OpenAI Azure yang sama.	Yes
environment	string	Nama lingkungan Pinecone.	Yes
pemetaan_bidang	pineconeFieldMappingOptions	Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Pinecone yang dikonfigurasi.	Yes
dalam cakupan	Boolean	Apakah kueri harus dibatasi untuk menggunakan data terindeks.	Tidak.
include_contexts	array	Properti konteks output yang disertakan. Jika tidak ditentukan, nilai defaultnya adalah citations dan intent.	Tidak.
nama indeks	string	Nama indeks database Pinecone.	Yes
max_search_queries	bilangan bulat	Jumlah maksimum kueri yang ditulis ulang harus dikirim ke penyedia pencarian untuk satu pesan pengguna. Jika tidak ditentukan, sistem akan memutuskan jumlah kueri yang akan dikirim.	Tidak.
keketatan	bilangan bulat	Ketatnya pemfilteran relevansi pencarian yang dikonfigurasi. Semakin tinggi ketegasan, semakin tinggi presisi tetapi pengenalan jawaban yang lebih rendah.	Tidak.
top_n_documents	bilangan bulat	Jumlah dokumen terbanyak yang dipilih untuk ditampilkan untuk kueri yang dipilih.	Tidak.

pineconeFieldMappingOptions

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

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

Pilihan Otorisasi Data Anda

Opsi autentikasi untuk Azure OpenAI On Your Data.

Diskriminator untuk onYourDataAuthenticationOptions

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
api_key	OpsiOtentikasiKunciApiDataAnda
connection_string	padaOpsiOtentikasiStringKoneksiDataAnda
key_and_key_id	onYourDataKeyAndKeyIdAuthenticationOptions
encoded_api_key	onYourDataEncodedApiKeyAuthenticationOptions
access_token	onYourDataAccessTokenAuthenticationOptions
system_assigned_managed_identity	onYourDataSystemAssignedManagedIdentityAuthenticationOptions
user_assigned_managed_identity	onYourDataUserAssignedManagedIdentityAuthenticationOptions
username_and_password	onYourDataUsernameAndPasswordAuthenticationOptions

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

onYourDataContextProperty

Properti konteks.

Harta benda	Nilai
Deskripsi	Properti konteks.
Jenis	string
Nilai	citations intent all_retrieved_documents

onTipeAutentikasiDataAnda

Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.

Harta benda	Nilai
Deskripsi	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.
Jenis	string
Nilai	api_key connection_string key_and_key_id encoded_api_key access_token system_assigned_managed_identity user_assigned_managed_identity username_and_password

OpsiAutentikasiKunciApiOnYourData

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

Nama	Tipe	Deskripsi	Diperlukan	Default
kunci	string	Kunci API yang digunakan untuk autentikasi.	Tidak.
jenis	padaTipeOtentikasiDataAnda	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Yes

padaPilihanOtentikasiStringKoneksiDataAnda

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

Nama	Tipe	Deskripsi	Diperlukan	Default
connection_string	string	connection string yang digunakan untuk autentikasi.	Tidak.
jenis	padaTipeOtentikasiDataAnda	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Yes

onYourDataKeyAndKeyIdAuthenticationOptions

Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan kunci Elasticsearch dan pasangan ID kunci.

Nama	Tipe	Deskripsi	Diperlukan	Default
kunci	string	Kunci Elasticsearch yang digunakan untuk autentikasi.	Tidak.
key_id	string	ID kunci Elasticsearch yang digunakan untuk autentikasi.	Tidak.
jenis	padaTipeOtentikasiDataAnda	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Yes

onYourDataEncodedApiKeyAuthenticationOptions

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

Nama	Tipe	Deskripsi	Diperlukan	Default
encoded_api_key	string	Kunci API yang dikodekan Elasticsearch untuk digunakan untuk autentikasi.	Tidak.
jenis	padaTipeOtentikasiDataAnda	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Yes

onYourDataAccessTokenAuthenticationOptions

Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan token access.

Nama	Tipe	Deskripsi	Diperlukan	Default
access_token	string	Token access yang digunakan untuk autentikasi.	Tidak.
jenis	padaTipeOtentikasiDataAnda	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Yes

OpsiOtentikasiIdentitasTerkelolaYangDitugaskanSistemDataAnda

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

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

onYourDataOpsiAutentikasiIdentitasTerkelolaPenggunaYangDiberikan

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

Nama	Tipe	Deskripsi	Diperlukan	Default
managed_identity_resource_id	string	ID sumber daya identitas terkelola yang ditetapkan pengguna untuk digunakan untuk autentikasi.	Tidak.
jenis	padaTipeOtentikasiDataAnda	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Yes

onYourDataUsernameAndPasswordAuthenticationOptions

Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan nama pengguna dan kata sandi.

Nama	Tipe	Deskripsi	Diperlukan	Default
kata sandi	string	Kata sandi. untuk digunakan untuk autentikasi.	Tidak.
jenis	padaTipeOtentikasiDataAnda	Jenis autentikasi yang didukung dengan Azure OpenAI On Your Data.	Yes
nama pengguna	string	Nama pengguna yang digunakan untuk autentikasi.	Tidak.

Source PemvektoranDataAnda

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

Komponen ini menggunakan properti type untuk mendiskriminasi antara berbagai jenis:

Tipe Nilai	Skema
endpoint	onYourDataEndpointVectorizationSource
deployment_name	onYourDataDeploymentNameVectorizationSource
integrated	onYourDataIntegratedVectorizationSource
model_id	onYourDataModelIdVectorizationSource

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

padaTipeSumberVektorisasiDataAnda

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

Harta benda	Nilai
Deskripsi	Mewakili sumber yang tersedia Azure OpenAI On Your Data dapat digunakan untuk mengonfigurasi vektorisasi data untuk digunakan dengan pencarian vektor.
Jenis	string
Nilai	endpoint deployment_name integrated model_id

SumberVektorisasiTitikAkhirDataAnda

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

Nama	Tipe	Deskripsi	Diperlukan	Default
autentikasi	onYourDataApiKeyAuthenticationOptions atau onYourDataAccessTokenAuthenticationOptions		Tidak.
dimensions	bilangan bulat	Jumlah dimensi yang harus dimiliki penyematan. Hanya didukung pada model text-embedding-3 dan yang lebih baru.	Tidak.
titik akhir	string	Menentukan URL titik akhir sumber daya tempat penyematan harus diambil. Ini harus dalam format https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. Parameter kueri versi api tidak diizinkan.	Tidak.
jenis	padaTipeSumberVektorisasiDataAnda	Mewakili sumber yang tersedia Azure OpenAI On Your Data dapat digunakan untuk mengonfigurasi vektorisasi data untuk digunakan dengan pencarian vektor.	Yes

onYourDataDeploymentNameVectorizationSource

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

Nama	Tipe	Deskripsi	Diperlukan	Default
nama_penerapan	string	Menentukan nama penyebaran model yang akan digunakan untuk vektorisasi. Penyebaran model ini harus berada dalam sumber daya OpenAI Azure yang sama, tetapi On Your Data akan menggunakan penyebaran model ini melalui panggilan internal daripada yang publik, yang memungkinkan pencarian vektor bahkan di jaringan privat.	Tidak.
dimensions	bilangan bulat	Jumlah dimensi yang harus dimiliki penyematan. Hanya didukung pada model text-embedding-3 dan yang lebih baru.	Tidak.
jenis	padaTipeSumberVektorisasiDataAnda	Mewakili sumber yang tersedia Azure OpenAI On Your Data dapat digunakan untuk mengonfigurasi vektorisasi data untuk digunakan dengan pencarian vektor.	Yes

onYourDataIntegratedVectorizationSource

Mewakili vektorizer terintegrasi yang ditentukan dalam sumber daya pencarian.

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

onYourDataModelIdVectorizationSource

Detail sumber vektorisasi, digunakan oleh Azure OpenAI On Your Data saat menerapkan pencarian vektor, yang didasarkan pada ID model search service. Saat ini hanya didukung oleh Elasticsearch®.

Nama	Tipe	Deskripsi	Diperlukan	Default
model_id	string	Menentukan ID model yang akan digunakan untuk vektorisasi. ID model ini harus ditentukan dalam search service.	Tidak.
jenis	padaTipeSumberVektorisasiDataAnda	Mewakili sumber yang tersedia Azure OpenAI On Your Data dapat digunakan untuk mengonfigurasi vektorisasi data untuk digunakan dengan pencarian vektor.	Yes

KonteksPesanEkstensiAzureChat

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

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

kutipan

informasi kutipan untuk pesan respons penyelesaian obrolan.

Nama	Tipe	Deskripsi	Diperlukan	Default
chunk_id	string	ID bagian kutipan.	Tidak.
isi	string	Isi kutipan.	Yes
jalur file	string	Lokasi file kutipan.	Tidak.
rerank_score	nomor/angka	Skor rerank dari dokumen yang diambil.	Tidak.
title	string	Judul kutipan.	Tidak.
URL	string	URL dari kutipan.	Tidak.

retrievedDocument

Dokumen yang diambil.

Nama	Tipe	Deskripsi	Diperlukan	Default
chunk_id	string	ID bagian kutipan.	Tidak.
isi	string	Isi kutipan.	Yes
data_source_index	bilangan bulat	Indeks sumber data.	Tidak.
jalur file	string	Lokasi file kutipan.	Tidak.
filter_reason	filterReason	Alasan pemfilteran dokumen yang diambil.	Tidak.
original_search_score	nomor/angka	Skor pencarian asli dokumen yang diambil.	Tidak.
rerank_score	nomor/angka	Skor rerank dari dokumen yang diambil.	Tidak.
search_queries	array	Kueri pencarian yang digunakan untuk mengambil dokumen.	Tidak.
title	string	Judul kutipan.	Tidak.
URL	string	URL dari kutipan.	Tidak.

filterReason

Alasan pemfilteran dokumen yang diambil.

Harta benda	Nilai
Deskripsi	Alasan pemfilteran dokumen yang diambil.
Jenis	string
Nilai	score rerank

PanggilanAlatPesanSelesaiObrolan

Nama	Tipe	Deskripsi	Diperlukan	Default
fungsi	objek	Fungsi yang dipanggil oleh model.	Yes
└─ argumen-argumen	string	Argumen untuk memanggil fungsi dengan, seperti yang dihasilkan oleh model dalam format JSON. Perhatikan bahwa model tidak selalu menghasilkan JSON yang valid, dan mungkin berhalusinasi parameter yang tidak ditentukan oleh skema fungsi Anda. Validasi argumen dalam kode Anda sebelum memanggil fungsi Anda.	Tidak.
└─ nama	string	Nama fungsi yang akan dipanggil.	Tidak.
id	string	ID panggilan alat.	Yes
jenis	toolCallType	Jenis panggilan alat, dalam hal ini function.	Yes

JenisPanggilanAlat

Jenis panggilan alat, dalam hal ini function.

Harta benda	Nilai
Deskripsi	Jenis panggilan alat, dalam hal ini function.
Jenis	string
Nilai	function

chatCompletionRequestMessageTool

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	string	Isi pesan.	Tidak.
tool_call_id	string	Panggilan alat yang direspons pesan ini.	Tidak.

fungsi pesan permintaan penyelesaian obrolan

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

createChatCompletionResponse

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

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

createChatCompletionStreamResponse

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

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

chatCompletionStreamResponseDelta

Delta penyelesaian obrolan yang dihasilkan oleh respons model yang dialirkan.

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	string	Isi pesan potongan.	Tidak.
function_call	objek	Tidak digunakan lagi dan digantikan oleh tool_calls. Nama dan argumen fungsi yang harus dipanggil, seperti yang dihasilkan oleh model.	Tidak.
└─ argumen-argumen	string	Argumen untuk memanggil fungsi dengan, seperti yang dihasilkan oleh model dalam format JSON. Perhatikan bahwa model tidak selalu menghasilkan JSON yang valid, dan mungkin berhalusinasi parameter yang tidak ditentukan oleh skema fungsi Anda. Validasi argumen dalam kode Anda sebelum memanggil fungsi Anda.	Tidak.
└─ nama	string	Nama fungsi yang akan dipanggil.	Tidak.
refusal	string	Pesan penolakan yang dihasilkan oleh model.	Tidak.
peran	enum	Peran penulis pesan ini. Nilai yang mungkin: system, user, assistant, tool	Tidak.
tool_calls	array		Tidak.

kolomAlatPanggilanPesanPenyelesaianChat

Nama	Tipe	Deskripsi	Diperlukan	Default
fungsi	objek		Tidak.
└─ argumen-argumen	string	Argumen untuk memanggil fungsi dengan, seperti yang dihasilkan oleh model dalam format JSON. Perhatikan bahwa model tidak selalu menghasilkan JSON yang valid, dan mungkin berhalusinasi parameter yang tidak ditentukan oleh skema fungsi Anda. Validasi argumen dalam kode Anda sebelum memanggil fungsi Anda.	Tidak.
└─ nama	string	Nama fungsi yang akan dipanggil.	Tidak.
id	string	ID panggilan alat.	Tidak.
indeks	bilangan bulat		Yes
jenis	enum	Jenis alat. Saat ini, hanya function didukung. Nilai yang mungkin: function	Tidak.

chatCompletionStreamOptions

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

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

chatCompletionChoiceLogProbs

Catat informasi probabilitas untuk pilihan tersebut.

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	array	Daftar token konten pesan dengan informasi probabilitas log.	Yes
refusal	array	Daftar token penolakan pesan dengan informasi probabilitas log.	Tidak.

chatCompletionTokenLogprob

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

pesanTanggapanPenyelesaianChat

Pesan penyelesaian obrolan yang dihasilkan oleh model.

Nama	Tipe	Deskripsi	Diperlukan	Default
audio	objek	Jika modalitas output audio diminta, objek ini berisi data tentang respons audio dari model.	Tidak.
└─ data	string	Byte audio yang dikodekan Base64 yang dihasilkan oleh model, dalam format yang ditentukan dalam permintaan.	Tidak.
└─ berakhir_pada	bilangan bulat	Tanda waktu Unix (dalam detik) ketika respons audio ini tidak akan lagi dapat diakses di server untuk digunakan dalam percakapan multi-giliran.	Tidak.
└─ ID	string	Pengidentifikasi unik untuk respons audio ini.	Tidak.
└─ transkrip	string	Transkrip audio yang dihasilkan oleh model.	Tidak.
isi	string	Isi pesan.	Yes
context	azureChatExtensionsMessageContext	Representasi informasi konteks tambahan yang tersedia saat Azure ekstensi obrolan OpenAI terlibat dalam pembuatan respons penyelesaian obrolan yang sesuai. Informasi konteks ini hanya diisi saat menggunakan permintaan OpenAI Azure yang dikonfigurasi untuk menggunakan ekstensi yang cocok.	Tidak.
function_call	chatCompletionFunctionCall	Tidak digunakan lagi dan digantikan oleh tool_calls. Nama dan argumen fungsi yang harus dipanggil, seperti yang dihasilkan oleh model.	Tidak.
refusal	string	Pesan penolakan yang dihasilkan oleh model.	Yes
peran	chatCompletionResponseMessageRole	Peran penulis pesan respons.	Yes
tool_calls	array	Panggilan alat yang dihasilkan oleh model, seperti panggilan fungsi.	Tidak.

PeranPesanResponMenyelesaikanObrolan

Peran penulis pesan respons.

Harta benda	Nilai
Deskripsi	Peran penulis pesan respons.
Jenis	string
Nilai	assistant

opsiPilihanAlatChatCompletion

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

Komponen ini bisa menjadi salah satu hal berikut:

• chatCompletionNamedToolChoice

PilihanAlatBeriNamaPenyelesaianObrolan

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

Nama	Tipe	Deskripsi	Diperlukan	Default
fungsi	objek		Yes
└─ nama	string	Nama fungsi yang akan dipanggil.	Tidak.
jenis	enum	Jenis alat. Saat ini, hanya function didukung. Nilai yang mungkin: function	Yes

ParallelToolCalls

Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.

Tidak ada properti yang ditentukan untuk komponen ini.

PredictionContent

Konten output yang diprediksi statis, seperti konten file teks yang sedang diregenerasi.

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	string atau array	Konten yang harus dicocokkan saat menghasilkan respons model. Jika token yang dihasilkan akan cocok dengan konten ini, seluruh respons model dapat dikembalikan jauh lebih cepat.	Yes
jenis	enum	Jenis konten yang diprediksi yang ingin Anda sediakan. Jenis ini saat ini selalu content. Nilai yang mungkin: content	Yes

panggilanAlatPesanPenyelesaianObrolan

Panggilan alat yang dihasilkan oleh model, seperti panggilan fungsi.

Tidak ada properti yang ditentukan untuk komponen ini.

ChatCompletionModalities

Jenis output yang Anda inginkan untuk dihasilkan model untuk permintaan ini. Sebagian besar model mampu menghasilkan teks, yang merupakan default:

["text"]

Model ini gpt-4o-audio-preview juga dapat digunakan untuk menghasilkan audio. Untuk meminta agar model ini menghasilkan respons teks dan audio, Anda dapat menggunakan:

["text", "audio"]

Tidak ada properti yang ditentukan untuk komponen ini.

chatCompletionFungsiPanggilan

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

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

penggunaanPenyelesaian

Statistik penggunaan untuk permintaan penyelesaian tugas.

Nama	Tipe	Deskripsi	Diperlukan	Default
completion_tokens	bilangan bulat	Jumlah token dalam penyelesaian yang dihasilkan.	Yes
completion_tokens_details	objek	Perincian token yang digunakan dalam penyelesaian.	Tidak.
token_prediksi_diterima	bilangan bulat	Saat menggunakan Output Yang Diprediksi, jumlah token dalam prediksi yang muncul dalam penyelesaian.	Tidak.
└─ audio_tokens	bilangan bulat	Token input audio yang dihasilkan oleh model.	Tidak.
└─ token_penalaran	bilangan bulat	Token yang dihasilkan oleh model untuk penalaran.	Tidak.
└─ token_prediksi_ditolak	bilangan bulat	Saat menggunakan Output Yang Diprediksi, jumlah token dalam prediksi yang tidak muncul dalam penyelesaian. Namun, seperti token penalaran, token ini masih dihitung dalam total token penyelesaian untuk tujuan penagihan, output, dan batas jendela konteks.	Tidak.
prompt_tokens	bilangan bulat	Jumlah token dalam prompt.	Yes
prompt_tokens_details	objek	Detail token perintah.	Tidak.
└─ audio_tokens	bilangan bulat	Token input audio ada di prompt.	Tidak.
└─ token_yang_di-cache	bilangan bulat	Jumlah token prompt yang di-cache.	Tidak.
total_tokens	bilangan bulat	Jumlah total token yang digunakan dalam permintaan (prompt + penyelesaian).	Yes

chatCompletionTool

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

FunctionParameters

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

ResponseFormatText

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Jenis format respons yang ditentukan: text Nilai yang mungkin: text	Yes

FormatTanggapanJsonObject

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Jenis format respons yang ditentukan: json_object Nilai yang mungkin: json_object	Yes

ResponseFormatJsonSchemaSkema

Skema untuk format respons, dijelaskan sebagai objek Skema JSON.

Tidak ada properti yang ditentukan untuk komponen ini.

ResponseFormatJsonSchema

Nama	Tipe	Deskripsi	Diperlukan	Default
json_schema	objek		Yes
└─ deskripsi	string	Sebuah deskripsi tentang tujuan format respons, yang digunakan oleh model untuk menentukan cara merespons dalam format tersebut.	Tidak.
└─ nama	string	Nama format tanggapan. Harus a-z, A-Z, 0-9, atau berisi garis bawah dan tanda hubung, dengan panjang maksimum 64.	Tidak.
└─ skema	ResponseFormatJsonSchema	Skema untuk format respons, dijelaskan sebagai objek Skema JSON.	Tidak.
└─ ketat	Boolean	Apakah akan mengaktifkan kepatuhan skema yang ketat saat menghasilkan output. Jika diatur ke true, model akan selalu mengikuti skema yang tepat yang ditentukan di schema bidang . Hanya subset Skema JSON yang didukung saat strict adalah true.	Tidak.	False
jenis	enum	Jenis format respons yang ditentukan: json_schema Nilai yang mungkin: json_schema	Yes

pilihanPenyelesaianChatUmum

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

buatPermintaanTerjemahan

Permintaan terjemahan.

Nama	Tipe	Deskripsi	Diperlukan	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.	Tidak.
response_format	audioResponseFormat	Menentukan format output.	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel, antara 0 dan 1. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Jika diatur ke 0, model menggunakan probabilitas log untuk secara otomatis meningkatkan suhu hingga mencapai ambang batas tertentu.	Tidak.	0

audioResponse

Respons terjemahan atau transkripsi saat response_format adalah json

Nama	Tipe	Deskripsi	Diperlukan	Default
kirim pesan teks	string	Teks yang diterjemahkan atau ditranskripsikan.	Yes

audioVerboseResponse

Respons terjemahan atau transkripsi ketika format_ respons adalah verbose_json

Nama	Tipe	Deskripsi	Diperlukan	Default
duration	nomor/angka	Durasi.	Tidak.
bahasa	string	Bahasa.	Tidak.
segments	array		Tidak.
tugas	string	Jenis tugas audio.	Tidak.
kirim pesan teks	string	Teks yang diterjemahkan atau ditranskripsikan.	Yes
words	array		Tidak.

audioResponseFormat

Menentukan format output.

Harta benda	Nilai
Deskripsi	Menentukan format output.
Jenis	string
Nilai	json text srt verbose_json vtt

buatPermintaanTranskripsi

Permintaan transkripsi.

Nama	Tipe	Deskripsi	Diperlukan	Default
berkas	string	Objek file audio yang akan ditranskripsikan.	Yes
bahasa	string	Bahasa audio input. Menyediakan bahasa input dalam format ISO-639-1 meningkatkan akurasi dan latensi.	Tidak.
minta	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Perintah harus cocok dengan bahasa audio.	Tidak.
response_format	audioResponseFormat	Menentukan format output.	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel, antara 0 dan 1. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Jika diatur ke 0, model menggunakan probabilitas log untuk secara otomatis meningkatkan suhu hingga mencapai ambang batas tertentu.	Tidak.	0
timestamp_granularities[]	array	Granularitas tanda waktu untuk mengisi transkripsi ini. response_format harus diatur verbose_json untuk menggunakan granularitas tanda waktu. Salah satu atau kedua opsi ini didukung: word, atau segment. Catatan: Tidak ada latensi tambahan untuk tanda waktu segmen, tetapi menghasilkan tanda waktu kata menimbulkan latensi tambahan.	Tidak.	['segment']

audioSegment

Segmen transkripsi atau terjemahan.

Nama	Tipe	Deskripsi	Diperlukan	Default
avg_logprob	nomor/angka	Probabilitas log rata-rata.	Tidak.
compression_ratio	nomor/angka	Rasio kompresi.	Tidak.
akhir	nomor/angka	Offset akhir segmen.	Tidak.
id	bilangan bulat	Pengidentifikasi segmen.	Tidak.
no_speech_prob	nomor/angka	Probabilitas 'tidak ada ucapan'.	Tidak.
seek	nomor/angka	Offset segmen.	Tidak.
mulai	nomor/angka	Offset segmen mulai.	Tidak.
suhu	nomor/angka	Suhu.	Tidak.
kirim pesan teks	string	Teks segmentasi.	Tidak.
tokens	array	Token teks tersebut.	Tidak.

audioWord

Transkripsi atau kata terjemahan.

Nama	Tipe	Deskripsi	Diperlukan	Default
akhir	nomor/angka	Offset akhir kata.	Tidak.
mulai	nomor/angka	Offset mulai word.	Tidak.
word	string	Microsoft Word	Tidak.

createSpeechRequest

Permintaan ucapan.

Nama	Tipe	Deskripsi	Diperlukan	Default
Masukan	string	Teks yang akan disintesis audio. Panjang maksimum adalah 4.096 karakter.	Yes
response_format	enum	Format untuk mensintesis audio masuk. Nilai yang mungkin: mp3, , opusaac, flac, wav,pcm	Tidak.
speed	nomor/angka	Kecepatan audio yang disintesis. Pilih nilai dari 0.25 ke 4.0. 1.0 adalah default.	Tidak.	1.0
voice	enum	Suara yang digunakan untuk sintesis ucapan. Nilai yang mungkin: alloy, , echofable, onyx, nova,shimmer	Yes

kualitas gambar

Kualitas gambar yang akan dihasilkan.

Harta benda	Nilai
Deskripsi	Kualitas gambar yang akan dihasilkan.
Jenis	string
Default	auto
Nilai	auto high medium low hd standard

imagesResponseFormat

Format di mana gambar yang dihasilkan dikembalikan.

Harta benda	Nilai
Deskripsi	Format di mana gambar yang dihasilkan dikembalikan.
Jenis	string
Default	URL
Nilai	url b64_json

imagesOutputFormat

Format file tempat gambar yang dihasilkan dikembalikan. Dukungan hanya untuk model seri.

Harta benda	Nilai
Deskripsi	Format file tempat gambar yang dihasilkan dikembalikan. Hanya didukung untuk model seri gpt-image-1.
Jenis	string
Default	png
Nilai	png jpeg

ukuran gambar

Ukuran gambar yang dihasilkan.

Harta benda	Nilai
Deskripsi	Ukuran gambar yang dihasilkan.
Jenis	string
Default	auto
Nilai	auto 1792x1024 1024x1792 1024x1024 1024x1536 1536x1024

imageStyle

Gaya gambar yang dihasilkan. Hanya didukung untuk dall-e-3.

Harta benda	Nilai
Deskripsi	Gaya gambar yang dihasilkan. Hanya didukung untuk dall-e-3.
Jenis	string
Default	Jelas
Nilai	vivid natural

imageBackground

Memungkinkan untuk mengatur transparansi untuk latar belakang gambar yang dihasilkan. Parameter ini hanya didukung untuk model seri gpt-image-1.

Harta benda	Nilai
Deskripsi	Memungkinkan untuk mengatur transparansi untuk latar belakang gambar yang dihasilkan. Parameter ini hanya didukung untuk model seri gpt-image-1.
Jenis	string
Default	auto
Nilai	transparent opaque auto

permintaanPembuatanGambar

Nama	Tipe	Deskripsi	Diperlukan	Default
latar belakang	imageBackground	Memungkinkan untuk mengatur transparansi untuk latar belakang gambar yang dihasilkan. Parameter ini hanya didukung untuk model seri gpt-image-1.	Tidak.	auto
n	bilangan bulat	Jumlah gambar yang akan dihasilkan. Untuk dall-e-3, hanya n=1 yang didukung.	Tidak.	1
kompresi keluaran	bilangan bulat	Tingkat kompresi (0-100%) untuk gambar yang dihasilkan. Parameter ini hanya didukung untuk model seri gpt-image-1 dengan format output jpeg.	Tidak.	100
format keluaran	imagesOutputFormat	Format file tempat gambar yang dihasilkan dikembalikan. Hanya didukung untuk model seri gpt-image-1.	Tidak.	png
minta	string	Deskripsi teks gambar yang diinginkan. Panjang maksimum adalah 32000 karakter untuk model seri gpt-image-1 dan 4000 karakter untuk dall-e-3	Yes
kualitas	imageQuality	Kualitas gambar yang akan dihasilkan.	Tidak.	auto
response_format	imagesResponseFormat	Format di mana gambar yang dihasilkan dikembalikan. Hanya didukung untuk dall-e-3.	Tidak.	URL
ukuran	imageSize	Ukuran gambar yang dihasilkan.	Tidak.	auto
gaya	imageStyle	Gaya gambar yang dihasilkan. Hanya didukung untuk dall-e-3.	Tidak.	Jelas
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	Tidak.

imageEditsRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
citra	string atau array	Gambar yang akan diedit. Harus berupa file gambar yang didukung atau array gambar. Setiap gambar harus berupa file png, atau jpg kurang dari 25MB.	Yes
masker	string	Gambar tambahan yang areanya sepenuhnya transparan (misalnya, di mana alfa nol) menunjukkan di mana gambar harus diedit. Jika ada beberapa gambar yang disediakan, masker akan diterapkan ke gambar pertama. Harus berupa file PNG yang valid, kurang dari 4MB, dan memiliki dimensi yang sama dengan gambar.	Tidak.
n	bilangan bulat	Jumlah gambar yang akan dihasilkan.	Tidak.	1
minta	string	Deskripsi teks gambar yang diinginkan. Panjang maksimum adalah 32000 karakter.	Yes
kualitas	imageQuality	Kualitas gambar yang akan dihasilkan.	Tidak.	auto
response_format	imagesResponseFormat	Format di mana gambar yang dihasilkan dikembalikan.	Tidak.	URL
ukuran	imageSize	Ukuran gambar yang dihasilkan.	Tidak.	auto
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu memantau dan mendeteksi penyalahgunaan.	Tidak.

generateImagesResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
Dibuat	bilangan bulat	Tanda waktu unix saat operasi dibuat.	Yes
data	array	Data hasil operasi, jika berhasil	Yes
usage	imageGenerationsUsage	Mewakili detail penggunaan token untuk permintaan pembuatan gambar. Hanya untuk model seri gpt-image-1.	Tidak.

hasilGambar

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

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

imageGenerationsUsage

Mewakili detail penggunaan token untuk permintaan pembuatan gambar. Hanya untuk model seri gpt-image-1.

Nama	Tipe	Deskripsi	Diperlukan	Default
input_tokens	bilangan bulat	Jumlah token input.	Tidak.
input_tokens_details	objek	Perincian terperinci dari token input.	Tidak.
└─ token_gambar	bilangan bulat	Jumlah token gambar.	Tidak.
└─ text_tokens	bilangan bulat	Jumlah token teks.	Tidak.
output_tokens	bilangan bulat	Jumlah token output.	Tidak.
total_tokens	bilangan bulat	Jumlah total token yang digunakan.	Tidak.

garis

Objek baris konten yang terdiri dari urutan elemen konten yang berdekatan, seperti kata dan tanda pilihan.

Nama	Tipe	Deskripsi	Diperlukan	Default
spans	array	Array rentang yang mewakili objek yang terdeteksi dan informasi kotak pembatasnya.	Yes
kirim pesan teks	string		Yes

span

Objek rentang yang mewakili objek yang terdeteksi dan informasi kotak pembatasnya.

Nama	Tipe	Deskripsi	Diperlukan	Default
length	bilangan bulat	Panjang rentang dalam karakter, diukur dalam titik kode Unicode.	Yes
offset	bilangan bulat	Offset karakter dalam teks tempat rentang dimulai. Offset ini didefinisikan sebagai posisi karakter pertama rentang, dihitung dari awal teks sebagai titik kode Unicode.	Yes
polygon	array	Array objek yang mewakili titik dalam poligon yang mencakup objek yang terdeteksi.	Yes
kirim pesan teks	string	Konten teks rentang yang mewakili objek yang terdeteksi.	Yes

runCompletionUsage

Statistik penggunaan yang terkait dengan eksekusi. Nilai ini akan menjadi null jika eksekusi tidak dalam status terminal (yaitu in_progress, , queueddll.).

Nama	Tipe	Deskripsi	Diperlukan	Default
completion_tokens	bilangan bulat	Jumlah token penyelesaian yang digunakan selama eksekusi.	Yes
prompt_tokens	bilangan bulat	Jumlah token prompt yang digunakan selama eksekusi.	Yes
total_tokens	bilangan bulat	Jumlah total token yang digunakan (prompt + completion).	Yes

runStepCompletionUsage

Statistik penggunaan yang terkait dengan langkah eksekusi. Nilai ini akan sementara null status langkah eksekusi adalah in_progress.

Nama	Tipe	Deskripsi	Diperlukan	Default
completion_tokens	bilangan bulat	Jumlah token penyelesaian yang digunakan selama langkah eksekusi.	Yes
prompt_tokens	bilangan bulat	Jumlah token prompt yang digunakan selama langkah eksekusi.	Yes
total_tokens	bilangan bulat	Jumlah total token yang digunakan (prompt + completion).	Yes

assistantsApiResponseFormatOption

Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4o, GPT-4 Turbo, dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106.

Pengaturan untuk { "type": "json_schema", "json_schema": {...} } mengaktifkan Output Terstruktur yang memastikan model cocok dengan skema JSON yang Anda berikan. Pelajari selengkapnya di panduan Output Terstruktur.

Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang memastikan pesan yang dihasilkan model adalah JSON yang valid.

Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan deretan ruang kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berlangsung lama dan tampak "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.

Komponen ini bisa menjadi salah satu hal berikut:

• ResponseFormatText
• ResponseFormatJsonObject
• ResponseFormatJsonSchema

assistantsApiResponseFormat

Objek yang menjelaskan output model yang diharapkan. Jika json_object hanya function jenis tools yang diizinkan untuk diteruskan ke Jalankan. Jika text model dapat mengembalikan teks atau nilai apa pun yang diperlukan.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	string	Harus salah satu dari text atau json_object.	Tidak.	kirim pesan teks

tipe Enum: AssistantsApiResponseFormat

Nilai	Deskripsi
kirim pesan teks
json_object

assistantObject

Mewakili yang assistant dapat memanggil model dan menggunakan alat.

Nama	Tipe	Deskripsi	Diperlukan	Default
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat asisten dibuat.	Yes
deskripsi	string	Penjabaran dari asisten. Panjang maksimum adalah 512 karakter.	Yes
id	string	Pengidentifikasi, yang dapat dirujuk di titik akhir API.	Yes
instructions	string	Instruksi sistem yang digunakan asisten. Panjang maksimum adalah 256.000 karakter.	Yes
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Yes
model	string	ID model yang akan digunakan.	Yes
Nama	string	Nama asisten. Panjang maksimum adalah 256 karakter.	Yes
objek	string	Tipe objek, yang selalu assistant.	Yes
response_format	assistantsApiResponseFormatOption	Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4o, GPT-4 Turbo, dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_schema", "json_schema": {...} } mengaktifkan Output Terstruktur yang memastikan model cocok dengan skema JSON yang Anda berikan. Pelajari selengkapnya di panduan Output Terstruktur. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang memastikan pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan deretan ruang kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berlangsung lama dan tampak "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik.	Tidak.	1
tool_resources	objek	Sekumpulan sumber daya yang digunakan oleh alat asisten. Sumber daya khusus untuk jenis alat. Misalnya, alat ini code_interpreter memerlukan daftar ID file, sementara alat ini file_search memerlukan daftar ID penyimpanan vektor.	Tidak.
└─ penerjemah_kode	objek		Tidak.
└─ file_ids	array	Daftar ID file yang disediakan untuk alat ini code_interpreter . Mungkin ada maksimal 20 file yang terkait dengan alat ini.	Tidak.	[]
└─ pencarian_berkas	objek		Tidak.
└─ vector_store_ids	array	ID penyimpanan vektor yang terpasang pada asisten ini. Maksimal 1 penyimpanan vektor dapat terpasang pada asisten.	Tidak.
perangkat	array	Daftar alat yang diaktifkan pada asisten. Mungkin ada maksimal 128 alat per asisten. Alat bisa dari jenis code_interpreter, file_search, atau function.	Yes	[]
top_p	nomor/angka	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau suhu tetapi tidak keduanya.	Tidak.	1

enum objek: AssistantObjectType

Nilai	Deskripsi
asisten	Jenis objek, yang selalu asisten

createAssistantRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
deskripsi	string	Penjabaran dari asisten. Panjang maksimum adalah 512 karakter.	Tidak.
instructions	string	Instruksi sistem yang digunakan asisten. Panjang maksimum adalah 256.000 karakter.	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.
model	string		Yes
Nama	string	Nama asisten. Panjang maksimum adalah 256 karakter.	Tidak.
response_format	assistantsApiResponseFormatOption	Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4o, GPT-4 Turbo, dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_schema", "json_schema": {...} } mengaktifkan Output Terstruktur yang memastikan model cocok dengan skema JSON yang Anda berikan. Pelajari selengkapnya di panduan Output Terstruktur. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang memastikan pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan deretan ruang kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berlangsung lama dan tampak "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik.	Tidak.	1
tool_resources	objek	Sekumpulan sumber daya yang digunakan oleh alat asisten. Sumber daya khusus untuk jenis alat. Misalnya, alat ini code_interpreter memerlukan daftar ID file, sementara alat ini file_search memerlukan daftar ID penyimpanan vektor.	Tidak.
└─ penerjemah_kode	objek		Tidak.
└─ file_ids	array	Daftar ID file yang disediakan untuk alat ini code_interpreter . Mungkin ada maksimal 20 file yang terkait dengan alat ini.	Tidak.	[]
└─ pencarian_berkas	objek		Tidak.
└─ vector_store_ids	array	Penyimpanan vektor yang terpasang pada asisten ini. Maksimal 1 penyimpanan vektor dapat terpasang pada asisten.	Tidak.
└─ vector_stores	array	Pembantu untuk membuat penyimpanan vektor dengan file_ids dan melampirkannya ke asisten ini. Maksimal 1 penyimpanan vektor dapat terpasang pada asisten.	Tidak.
perangkat	array	Daftar alat yang diaktifkan pada asisten. Mungkin ada maksimal 128 alat per asisten. Alat bisa dari jenis code_interpreter, retrieval, atau function.	Tidak.	[]
top_p	nomor/angka	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau suhu tetapi tidak keduanya.	Tidak.	1

modifyAssistantRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
deskripsi	string	Penjabaran dari asisten. Panjang maksimum adalah 512 karakter.	Tidak.
instructions	string	Instruksi sistem yang digunakan asisten. Panjang maksimum adalah 32768 karakter.	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.
model	string		Tidak.
Nama	string	Nama asisten. Panjang maksimum adalah 256 karakter.	Tidak.
response_format	assistantsApiResponseFormatOption	Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4o, GPT-4 Turbo, dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_schema", "json_schema": {...} } mengaktifkan Output Terstruktur yang memastikan model cocok dengan skema JSON yang Anda berikan. Pelajari selengkapnya di panduan Output Terstruktur. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang memastikan pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan deretan ruang kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berlangsung lama dan tampak "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik.	Tidak.	1
tool_resources	objek	Sekumpulan sumber daya yang digunakan oleh alat asisten. Sumber daya khusus untuk jenis alat. Misalnya, alat ini code_interpreter memerlukan daftar ID file, sementara alat ini file_search memerlukan daftar ID penyimpanan vektor.	Tidak.
└─ penerjemah_kode	objek		Tidak.
└─ file_ids	array	Mengambil alih daftar ID file yang tersedia untuk alat ini code_interpreter . Mungkin ada maksimal 20 file yang terkait dengan alat ini.	Tidak.	[]
└─ pencarian_berkas	objek		Tidak.
└─ vector_store_ids	array	Mengambil alih penyimpanan vektor yang terpasang pada asisten ini. Maksimal 1 penyimpanan vektor dapat terpasang pada asisten.	Tidak.
perangkat	array	Daftar alat yang diaktifkan pada asisten. Mungkin ada maksimal 128 alat per asisten. Alat bisa dari jenis code_interpreter, retrieval, atau function.	Tidak.	[]
top_p	nomor/angka	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau suhu tetapi tidak keduanya.	Tidak.	1

deleteAssistantResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
dihapus	Boolean		Yes
id	string		Yes
objek	string		Yes

enum objek: DeleteAssistantResponseState

Nilai	Deskripsi
assistant.deleted

listAssistantsResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array		Yes
first_id	string		Yes
ada_lagi	Boolean		Yes
ID terakhir	string		Yes
objek	string		Yes

assistantToolsCode

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	string	Jenis alat yang didefinisikan: code_interpreter	Yes

jenis Enum: assistantToolsCodeType

Nilai	Deskripsi
code_interpreter

assistantToolsFileSearch

Nama	Tipe	Deskripsi	Diperlukan	Default
file_search	objek	Ambil alih untuk alat pencarian file.	Tidak.
└─ jumlah_maks_hasil	bilangan bulat	Jumlah maksimum hasil yang harus dihasilkan alat pencarian file. Defaultnya adalah 20 untuk model gpt-4* dan 5 untuk gpt-3.5-turbo. Angka ini harus antara 1 dan 50 inklusif. Perhatikan bahwa alat pencarian file mungkin menghasilkan lebih sedikit dari max_num_results hasil.	Tidak.
jenis	string	Jenis alat yang didefinisikan: file_search	Yes

jenis Enum: assistantToolsFileSearchType

Nilai	Deskripsi
file_search

assistantToolsFileSearchTypeOnly

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	string	Jenis alat yang didefinisikan: file_search	Yes

jenis Enum: assistantToolsFileSearchType

Nilai	Deskripsi
file_search

assistantToolsFunction

Nama	Tipe	Deskripsi	Diperlukan	Default
fungsi	objek	Definisi fungsi.	Yes
└─ deskripsi	string	Deskripsi tentang apa yang dilakukan fungsi, digunakan oleh model untuk memilih kapan dan bagaimana memanggil fungsi.	Tidak.
└─ nama	string	Nama fungsi yang akan dipanggil. Harus a-z, A-Z, 0-9, atau berisi garis bawah dan tanda hubung, dengan panjang maksimum 64.	Tidak.
└─ parameter	chatCompletionFunctionParameters	Parameter yang diterima fungsi, dijelaskan sebagai objek Skema JSON. Lihat guide/ misalnya, dan referensi Skema JSON untuk dokumentasi tentang format.	Tidak.
jenis	string	Jenis alat yang didefinisikan: function	Yes

jenis Enum: assistantToolsFunction

Nilai	Deskripsi
fungsi

truncationObject

Kontrol tentang bagaimana utas akan dipotong sebelum eksekusi. Gunakan ini untuk mengontrol jendela konteks awal eksekusi.

Nama	Tipe	Deskripsi	Diperlukan	Default
last_messages	bilangan bulat	Jumlah pesan terbaru dari utas saat membuat konteks untuk eksekusi.	Tidak.
jenis	string	Strategi pemotongan yang digunakan untuk utas. Defaultnya adalah auto. Jika diatur ke last_messages, utas akan dipotong ke n pesan terbaru di utas. Ketika diatur ke auto, pesan di tengah utas akan dihilangkan agar sesuai dengan panjang konteks model, max_prompt_tokens.	Yes

type Enum: JenisTrunkasi

Nilai	Deskripsi
auto
last_messages

assistantsApiToolChoiceOption

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

Komponen ini bisa menjadi salah satu hal berikut:

• assistantsNamedToolChoice

assistantsNamedToolChoice

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

Nama	Tipe	Deskripsi	Diperlukan	Default
fungsi	objek		Tidak.
└─ nama	string	Nama fungsi yang akan dipanggil.	Tidak.
jenis	string	Jenis alat. Jika jenis adalah function, nama fungsi harus diatur	Yes

jenis Enum: AssistantsNamedToolChoiceType

Nilai	Deskripsi
fungsi
code_interpreter
file_search

runObject

Mewakili eksekusi yang dijalankan pada beberapa utas.

Nama	Tipe	Deskripsi	Diperlukan	Default
assistant_id	string	ID asisten yang digunakan untuk eksekusi eksekusi ini.	Yes
dibatalkan pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat eksekusi dibatalkan.	Yes
selesai_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat eksekusi selesai.	Yes
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat eksekusi dibuat.	Yes
kedaluwarsa_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat eksekusi akan kedaluwarsa.	Yes
gagal_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat eksekusi gagal.	Yes
id	string	Pengidentifikasi, yang dapat dirujuk di titik akhir API.	Yes
incomplete_details	objek	Detail tentang mengapa eksekusi tidak lengkap. Akan jika null eksekusi tidak lengkap.	Yes
└─ alasan	string	Alasan mengapa eksekusi tidak lengkap. Ini akan menunjuk ke batas token tertentu yang tercapai selama eksekusi.	Tidak.
instructions	string	Instruksi yang digunakan asisten untuk eksekusi ini.	Yes
kesalahan_terakhir	objek	Kesalahan terakhir yang terkait dengan eksekusi ini. Akan terjadi null jika tidak ada kesalahan.	Yes
└─ kode	string	Salah satu server_error atau rate_limit_exceeded.	Tidak.
└─ pesan	string	Deskripsi kesalahan yang dapat dibaca manusia.	Tidak.
max_completion_tokens	bilangan bulat	Jumlah maksimum token penyelesaian yang ditentukan telah digunakan selama eksekusi.	Yes
max_prompt_tokens	bilangan bulat	Jumlah maksimum token prompt yang ditentukan telah digunakan selama eksekusi.	Yes
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Yes
model	string	Model yang digunakan asisten untuk eksekusi ini.	Yes
objek	string	Tipe objek, yang selalu thread.run.	Yes
pemanggilan_alat_paralel	ParallelToolCalls	Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.	Tidak.	Benar
required_action	objek	Detail tentang tindakan yang diperlukan untuk melanjutkan eksekusi. null Akan jika tidak ada tindakan yang diperlukan.	Yes
└─ kirim_output_alat	objek	Detail tentang output alat yang diperlukan agar jalannya ini berlanjut.	Tidak.
└─ pemanggilan_alat	array	Daftar panggilan alat yang relevan.	Tidak.
└─ jenis	enum	Untuk saat ini, ini selalu submit_tool_outputs. Nilai yang mungkin: submit_tool_outputs	Tidak.
response_format	assistantsApiResponseFormatOption	Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4o, GPT-4 Turbo, dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_schema", "json_schema": {...} } mengaktifkan Output Terstruktur yang memastikan model cocok dengan skema JSON yang Anda berikan. Pelajari selengkapnya di panduan Output Terstruktur. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang memastikan pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan deretan ruang kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berlangsung lama dan tampak "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	Yes
started_at	bilangan bulat	Tanda waktu Unix (dalam detik) saat eksekusi dimulai.	Yes
status	string	Status eksekusi, yang dapat berupa queued, , in_progress, requires_action, cancelling, cancelled, failedcompleted, atau expired.	Yes
suhu	nomor/angka	Suhu pengambilan sampel yang digunakan untuk eksekusi ini. Jika tidak diatur, default ke 1.	Tidak.
thread_id	string	ID utas yang dioperasikan sebagai bagian dari pelaksanaan proses ini.	Yes
tool_choice	assistantsApiToolChoiceOption	Mengontrol alat mana (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil alat apa pun dan sebaliknya menghasilkan pesan. auto adalah nilai default dan berarti model dapat memilih antara menghasilkan pesan atau memanggil alat. Menentukan alat tertentu seperti {"type": "file_search"} atau {"type": "function", "function": {"name": "my_function"}} memaksa model untuk memanggil alat tersebut.	Yes
perangkat	array	Daftar alat yang digunakan asisten untuk eksekusi ini.	Yes	[]
top_p	nomor/angka	Nilai pengambilan sampel nukleus yang digunakan untuk proses ini. Jika tidak diatur, default ke 1.	Tidak.
truncation_strategy	truncationObject	Kontrol tentang bagaimana utas akan dipotong sebelum eksekusi. Gunakan ini untuk mengontrol jendela konteks awal eksekusi.	Yes
usage	runCompletionUsage	Statistik penggunaan yang terkait dengan eksekusi. Nilai ini akan menjadi null jika eksekusi tidak dalam status terminal (yaitu in_progress, , queueddll.).	Yes

enum objek: runObjectType

Nilai	Deskripsi
thread.run	Jenis objek eksekusi yang selalu thread.run

status Enum: StatusObjekBerjalan

Nilai	Deskripsi
queued	Status antrean
in_progress	Status in_progress
requires_action	Status required_action
cancelling	Status pembatalan
cancelled	Status dibatalkan
gagal	Status gagal
selesai	Status selesai
expired	Status kedaluwarsa

createRunRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
additional_instructions	string	Menambahkan instruksi tambahan di akhir instruksi untuk eksekusi. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi tanpa menimpa instruksi lain.	Tidak.
additional_messages	array	Menambahkan pesan tambahan ke utas sebelum membuat eksekusi.	Tidak.
assistant_id	string	ID asisten yang digunakan untuk menjalankan eksekusi ini.	Yes
instructions	string	Ambil alih pesan sistem default asisten. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi.	Tidak.
max_completion_tokens	bilangan bulat	Jumlah maksimum token penyelesaian yang dapat digunakan selama eksekusi. Jalankan berupaya sebaik mungkin untuk membatasi penggunaan hanya pada jumlah token penyelesaian yang ditentukan, di beberapa putaran jalankan. Jika eksekusi melebihi jumlah token penyelesaian yang ditentukan, eksekusi akan berakhir dengan status incomplete. Lihat incomplete_details untuk informasi selengkapnya.	Tidak.
max_prompt_tokens	bilangan bulat	Jumlah maksimum token prompt yang dapat digunakan selama eksekusi. Pengerjaan berupaya sebaik mungkin untuk hanya menggunakan jumlah token prompt yang telah ditentukan, dalam beberapa giliran pengerjaan. Jika eksekusi melebihi jumlah token prompt yang ditentukan, eksekusi akan berakhir dengan status incomplete. Lihat incomplete_details untuk informasi selengkapnya.	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.
model	string	ID Model yang akan digunakan untuk menjalankan eksekusi ini. Jika nilai disediakan di sini, nilai akan mengambil alih model yang terkait dengan asisten. Jika tidak, model yang terkait dengan asisten akan digunakan.	Tidak.
pemanggilan_alat_paralel	ParallelToolCalls	Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.	Tidak.	Benar
response_format	assistantsApiResponseFormatOption	Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4o, GPT-4 Turbo, dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_schema", "json_schema": {...} } mengaktifkan Output Terstruktur yang memastikan model cocok dengan skema JSON yang Anda berikan. Pelajari selengkapnya di panduan Output Terstruktur. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang memastikan pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan deretan ruang kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berlangsung lama dan tampak "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	Tidak.
aliran	Boolean	Jika true, mengembalikan aliran peristiwa yang terjadi selama peristiwa Jalankan sebagai yang dikirim server, mengakhiri saat Eksekusi memasuki status terminal dengan data: [DONE] pesan.	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik.	Tidak.	1
tool_choice	assistantsApiToolChoiceOption	Mengontrol alat mana (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil alat apa pun dan sebaliknya menghasilkan pesan. auto adalah nilai default dan berarti model dapat memilih antara menghasilkan pesan atau memanggil alat. Menentukan alat tertentu seperti {"type": "file_search"} atau {"type": "function", "function": {"name": "my_function"}} memaksa model untuk memanggil alat tersebut.	Tidak.
perangkat	array	Ambil alih alat yang dapat digunakan asisten untuk eksekusi ini. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi.	Tidak.
top_p	nomor/angka	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau suhu tetapi tidak keduanya.	Tidak.	1
truncation_strategy	truncationObject	Kontrol tentang bagaimana utas akan dipotong sebelum eksekusi. Gunakan ini untuk mengontrol jendela konteks awal eksekusi.	Tidak.

listRunsResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array		Yes
first_id	string		Yes
ada_lagi	Boolean		Yes
ID terakhir	string		Yes
objek	string		Yes

modifyRunRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.

submitToolOutputsRunRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
aliran	Boolean	Jika true, mengembalikan aliran peristiwa yang terjadi selama peristiwa Jalankan sebagai yang dikirim server, mengakhiri saat Eksekusi memasuki status terminal dengan data: [DONE] pesan.	Tidak.
tool_outputs	array	Daftar alat yang outputnya sedang dikirimkan.	Yes

runToolCallObject

Objek panggilan alat

Nama	Tipe	Deskripsi	Diperlukan	Default
fungsi	objek	Definisi fungsi.	Yes
└─ argumen-argumen	string	Argumen yang diharapkan model untuk Anda teruskan ke fungsi .	Tidak.
└─ nama	string	Nama fungsi.	Tidak.
id	string	ID panggilan alat. ID ini harus dirujuk ketika Anda mengirimkan output alat untuk menggunakan alat pengiriman output dan menjalankan endpoint.	Yes
jenis	string	Jenis alat yang memanggil output diperlukan. Untuk saat ini, ini selalu function.	Yes

tipe Enum: RunToolCallObjectType

Nilai	Deskripsi
fungsi

createThreadAndRunRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
assistant_id	string	ID asisten yang digunakan untuk menjalankan eksekusi ini.	Yes
instructions	string	Ambil alih pesan sistem default asisten. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi.	Tidak.
max_completion_tokens	bilangan bulat	Jumlah maksimum token penyelesaian yang dapat digunakan selama eksekusi. Jalankan berupaya sebaik mungkin untuk membatasi penggunaan hanya pada jumlah token penyelesaian yang ditentukan, di beberapa putaran jalankan. Jika eksekusi melebihi jumlah token penyelesaian yang ditentukan, eksekusi akan berakhir dengan status incomplete. Lihat incomplete_details untuk informasi selengkapnya.	Tidak.
max_prompt_tokens	bilangan bulat	Jumlah maksimum token prompt yang dapat digunakan selama eksekusi. Pengerjaan berupaya sebaik mungkin untuk hanya menggunakan jumlah token prompt yang telah ditentukan, dalam beberapa giliran pengerjaan. Jika eksekusi melebihi jumlah token prompt yang ditentukan, eksekusi akan berakhir dengan status incomplete. Lihat incomplete_details untuk informasi selengkapnya.	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.
model	string	ID model yang akan digunakan untuk menjalankan eksekusi ini. Jika nilai disediakan di sini, nilai akan mengambil alih model yang terkait dengan asisten. Jika tidak, model yang terkait dengan asisten akan digunakan.	Tidak.
pemanggilan_alat_paralel	ParallelToolCalls	Apakah akan mengaktifkan panggilan fungsi paralel selama penggunaan alat.	Tidak.	Benar
response_format	assistantsApiResponseFormatOption	Menentukan format yang harus dihasilkan model. Kompatibel dengan GPT-4o, GPT-4 Turbo, dan semua model GPT-3.5 Turbo sejak gpt-3.5-turbo-1106. Pengaturan untuk { "type": "json_schema", "json_schema": {...} } mengaktifkan Output Terstruktur yang memastikan model cocok dengan skema JSON yang Anda berikan. Pelajari selengkapnya di panduan Output Terstruktur. Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON, yang memastikan pesan yang dihasilkan model adalah JSON yang valid. Penting: saat menggunakan mode JSON, Anda juga harus menginstruksikan model untuk menghasilkan JSON sendiri melalui sistem atau pesan pengguna. Tanpa ini, model dapat menghasilkan deretan ruang kosong yang tidak berujung sampai pembuatan mencapai batas token, yang mengakibatkan permintaan yang berlangsung lama dan tampak "macet". Perhatikan juga bahwa konten pesan mungkin dipotong sebagian jika finish_reason="length", yang menunjukkan pembuatan terlampaui max_tokens atau percakapan melebihi panjang konteks maksimum.	Tidak.
aliran	Boolean	Jika true, mengembalikan aliran peristiwa yang terjadi selama peristiwa Jalankan sebagai yang dikirim server, mengakhiri saat Eksekusi memasuki status terminal dengan data: [DONE] pesan.	Tidak.
stream_options	chatCompletionStreamOptions	Opsi untuk respons streaming. Hanya atur ini saat Anda mengatur stream: true.	Tidak.	Tidak ada
suhu	nomor/angka	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik.	Tidak.	1
alur	createThreadRequest		Tidak.
tool_choice	assistantsApiToolChoiceOption	Mengontrol alat mana (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil alat apa pun dan sebaliknya menghasilkan pesan. auto adalah nilai default dan berarti model dapat memilih antara menghasilkan pesan atau memanggil alat. Menentukan alat tertentu seperti {"type": "file_search"} atau {"type": "function", "function": {"name": "my_function"}} memaksa model untuk memanggil alat tersebut.	Tidak.
tool_resources	objek	Sekumpulan sumber daya yang digunakan oleh alat asisten. Sumber daya khusus untuk jenis alat. Misalnya, alat ini code_interpreter memerlukan daftar ID file, sementara alat ini file_search memerlukan daftar ID penyimpanan vektor.	Tidak.
└─ penerjemah_kode	objek		Tidak.
└─ file_ids	array	Daftar ID file yang disediakan untuk alat ini code_interpreter . Mungkin ada maksimal 20 file yang terkait dengan alat ini.	Tidak.	[]
└─ pencarian_berkas	objek		Tidak.
└─ vector_store_ids	array	ID penyimpanan vektor yang terpasang pada asisten ini. Maksimal 1 penyimpanan vektor dapat terpasang pada asisten.	Tidak.
perangkat	array	Ambil alih alat yang dapat digunakan asisten untuk eksekusi ini. Ini berguna untuk memodifikasi perilaku berdasarkan per-eksekusi.	Tidak.
top_p	nomor/angka	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk mengubah ini atau suhu tetapi tidak keduanya.	Tidak.	1
truncation_strategy	truncationObject	Kontrol tentang bagaimana utas akan dipotong sebelum eksekusi. Gunakan ini untuk mengontrol jendela konteks awal eksekusi.	Tidak.

threadObject

Mewakili utas yang berisi pesan.

Nama	Tipe	Deskripsi	Diperlukan	Default
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat utas dibuat.	Yes
id	string	Pengidentifikasi, yang dapat dirujuk di titik akhir API.	Yes
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Yes
objek	string	Tipe objek, yang selalu thread.	Yes
tool_resources	objek	Sekumpulan sumber daya yang tersedia untuk alat asisten di utas ini. Sumber daya khusus untuk jenis alat. Misalnya, alat ini code_interpreter memerlukan daftar ID file, sementara alat ini file_search memerlukan daftar ID penyimpanan vektor.	Yes
└─ penerjemah_kode	objek		Tidak.
└─ file_ids	array	Daftar ID file yang disediakan untuk alat ini code_interpreter . Mungkin ada maksimal 20 file yang terkait dengan alat ini.	Tidak.	[]
└─ pencarian_berkas	objek		Tidak.
└─ vector_store_ids	array	Penyimpanan vektor yang terpasang pada utas ini. Mungkin ada maksimal 1 penyimpanan vektor yang terpasang pada utas.	Tidak.

enum objek: ThreadObjectType

Nilai	Deskripsi
alur	Jenis objek utas yang selalu thread

createThreadRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
messages	array	Daftar pesan untuk mengawali utas.	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.
tool_resources	objek	Sekumpulan sumber daya yang tersedia untuk alat asisten di utas ini. Sumber daya khusus untuk jenis alat. Misalnya, alat ini code_interpreter memerlukan daftar ID file, sementara alat ini file_search memerlukan daftar ID penyimpanan vektor.	Tidak.
└─ penerjemah_kode	objek		Tidak.
└─ file_ids	array	Daftar ID file yang disediakan untuk alat ini code_interpreter . Mungkin ada maksimal 20 file yang terkait dengan alat ini.	Tidak.	[]
└─ pencarian_berkas	objek		Tidak.
└─ vector_store_ids	array	Penyimpanan vektor yang terpasang pada utas ini. Mungkin ada maksimal 1 penyimpanan vektor yang terpasang pada utas.	Tidak.
└─ vector_stores	array	Pembantu untuk membuat penyimpanan vektor dengan file_ids dan melampirkannya ke utas ini. Mungkin ada maksimal 1 penyimpanan vektor yang terpasang pada utas.	Tidak.

modifyThreadRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.
tool_resources	objek	Sekumpulan sumber daya yang tersedia untuk alat asisten di utas ini. Sumber daya khusus untuk jenis alat. Misalnya, alat ini code_interpreter memerlukan daftar ID file, sementara alat ini file_search memerlukan daftar ID penyimpanan vektor.	Tidak.
└─ penerjemah_kode	objek		Tidak.
└─ file_ids	array	Daftar ID File yang disediakan untuk alat ini code_interpreter . Mungkin ada maksimal 20 file yang terkait dengan alat ini.	Tidak.	[]
└─ pencarian_berkas	objek		Tidak.
└─ vector_store_ids	array	Penyimpanan vektor yang terpasang pada utas ini. Mungkin ada maksimal 1 penyimpanan vektor yang terpasang pada utas.	Tidak.

deleteThreadResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
dihapus	Boolean		Yes
id	string		Yes
objek	string		Yes

enum objek: DeleteThreadResponseObjectState

Nilai	Deskripsi
thread.deleted	Status objek respons utas penghapusan yaitu thread.deleted

listThreadsResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array		Yes
first_id	string		Yes
ada_lagi	Boolean		Yes
ID terakhir	string		Yes
objek	string		Yes

messageObject

Mewakili pesan dalam utas.

Nama	Tipe	Deskripsi	Diperlukan	Default
assistant_id	string	Jika berlaku, ID asisten yang menulis pesan ini.	Yes
attachments	array	Daftar file yang dilampirkan ke pesan, dan alat tempat file ditambahkan.	Yes
selesai_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat pesan selesai.	Yes
isi	array	Konten pesan dalam array teks dan/atau gambar.	Yes
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat pesan dibuat.	Yes
id	string	Pengidentifikasi, yang dapat dirujuk di titik akhir API.	Yes
incomplete_at	bilangan bulat	Tanda waktu Unix (dalam detik) saat pesan ditandai sebagai tidak lengkap.	Yes
incomplete_details	objek	Pada pesan yang tidak lengkap, detail tentang mengapa pesan tidak lengkap.	Yes
└─ alasan	string	Alasan pesan tidak lengkap.	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Yes
objek	string	Tipe objek, yang selalu thread.message.	Yes
peran	string	Entitas yang menghasilkan pesan. Salah satu user atau assistant.	Yes
run_id	string	Jika berlaku, ID eksekusi yang terkait dengan penulisan pesan ini.	Yes
status	string	Status pesan, yang dapat berupa in_progress, , incompleteatau completed.	Yes
thread_id	string	ID utas di mana pesan ini berada.	Yes

enum objek: MessageObjectType

Nilai	Deskripsi
thread.message	Jenis objek pesan yang merupakan thread.message

status Enum: MessageObjectStatus

Nilai	Deskripsi
in_progress
incomplete
selesai

enum peran: MessageObjectRole

Nilai	Deskripsi
pengguna
asisten

messageDeltaObject

Mewakili delta pesan yaitu bidang yang diubah pada pesan selama streaming.

Nama	Tipe	Deskripsi	Diperlukan	Default
delta	objek	Delta yang berisi bidang yang telah berubah pada Pesan.	Yes
└─ konten	array	Konten pesan dalam array teks dan/atau gambar.	Tidak.
└─ peran	string	Entitas yang menghasilkan pesan. Salah satu user atau assistant.	Tidak.
id	string	Pengidentifikasi pesan, yang dapat dirujuk di titik akhir API.	Yes
objek	string	Tipe objek, yang selalu thread.message.delta.	Yes

enum objek: MessageDeltaObjectType

Nilai	Deskripsi
thread.message.delta

createMessageRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
attachments	array	Daftar file yang dilampirkan ke pesan, dan alat yang harus ditambahkan.	Tidak.
isi	string	Isi pesan.	Yes
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.
peran	string	Peran entitas yang membuat pesan. Nilai yang diizinkan meliputi: - user: Menunjukkan pesan dikirim oleh pengguna aktual dan harus digunakan dalam banyak kasus untuk mewakili pesan yang dihasilkan pengguna. - assistant: Menunjukkan pesan dihasilkan oleh asisten. Gunakan nilai ini untuk menyisipkan pesan dari asisten ke dalam percakapan.	Yes

peran Enum: CreateMessageRequestRole

Nilai	Deskripsi
pengguna
asisten

modifyMessageRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.

deleteMessageResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
dihapus	Boolean		Yes
id	string		Yes
objek	string		Yes

enum objek: DeleteMessageResponseObject

Nilai	Deskripsi
thread.message.deleted	Status hapus objek respons pesan

listMessagesResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array		Yes
first_id	string		Yes
ada_lagi	Boolean		Yes
ID terakhir	string		Yes
objek	string		Yes

messageContentImageFileObject

Mereferensikan File gambar dalam konten pesan.

Nama	Tipe	Deskripsi	Diperlukan	Default
image_file	objek		Yes
└─ file_id	string	ID File gambar dalam konten pesan.	Tidak.
jenis	string	Selalu image_file.	Yes

ketik Enum: MessageContentImageFileObjectType

Nilai	Deskripsi
image_file	Jenis file gambar konten pesan

messageContentTextObject

Konten teks yang merupakan bagian dari pesan.

Nama	Tipe	Deskripsi	Diperlukan	Default
kirim pesan teks	objek		Yes
└─ anotasi	array		Tidak.
└─ nilai	string	Data yang membentuk teks.	Tidak.
jenis	string	Selalu text.	Yes

ketik Enum: messageContentTextObjectType

Nilai	Deskripsi
kirim pesan teks	Tipe objek teks isi pesan

messageContentTextAnnotationsFileCitationObject

Kutipan dalam pesan yang menunjuk ke kutipan tertentu dari File tertentu yang terkait dengan asisten atau pesan. Dihasilkan ketika asisten menggunakan alat "pengambilan" untuk mencari file.

Nama	Tipe	Deskripsi	Diperlukan	Default
end_index	bilangan bulat		Yes
file_citation	objek		Yes
└─ file_id	string	ID File tertentu tempat kutipan berasal.	Tidak.
start_index	bilangan bulat		Yes
kirim pesan teks	string	Teks dalam konten pesan yang perlu diganti.	Yes
jenis	string	Selalu file_citation.	Yes

tipe Enum: FileCitationObjectType

Nilai	Deskripsi
file_citation	Jenis objek kutipan file

messageContentTextAnnotationsFilePathObject

URL untuk file yang dihasilkan saat asisten menggunakan code_interpreter alat untuk menghasilkan file.

Nama	Tipe	Deskripsi	Diperlukan	Default
end_index	bilangan bulat		Yes
file_path	objek		Yes
└─ file_id	string	ID file yang dihasilkan.	Tidak.
start_index	bilangan bulat		Yes
kirim pesan teks	string	Teks dalam konten pesan yang perlu diganti.	Yes
jenis	string	Selalu file_path.	Yes

jenis Enum: FilePathObjectType

Nilai	Deskripsi
file_path	Jenis objek jalur file

messageDeltaContentImageFileObject

Mereferensikan File gambar dalam konten pesan.

Nama	Tipe	Deskripsi	Diperlukan	Default
image_file	objek		Tidak.
└─ file_id	string	ID File gambar dalam konten pesan.	Tidak.
indeks	bilangan bulat	Indeks bagian konten dalam pesan.	Yes
jenis	string	Selalu image_file.	Yes

ketik Enum: MessageDeltaContentImageFileObjectType

Nilai	Deskripsi
image_file

messageDeltaContentTextObject

Konten teks yang merupakan bagian dari pesan.

Nama	Tipe	Deskripsi	Diperlukan	Default
indeks	bilangan bulat	Indeks bagian konten dalam pesan.	Yes
kirim pesan teks	objek		Tidak.
└─ anotasi	array		Tidak.
└─ nilai	string	Data yang membentuk teks.	Tidak.
jenis	string	Selalu text.	Yes

type Enum: MessageDeltaContentTextObjectType

Nilai	Deskripsi
kirim pesan teks

messageDeltaContentTextAnnotationsFileCitationObject

Kutipan dalam pesan yang menunjuk ke kutipan tertentu dari File tertentu yang terkait dengan asisten atau pesan. Dihasilkan ketika asisten menggunakan alat "file_search" untuk mencari file.

Nama	Tipe	Deskripsi	Diperlukan	Default
end_index	bilangan bulat		Tidak.
file_citation	objek		Tidak.
└─ file_id	string	ID File tertentu tempat kutipan berasal.	Tidak.
└─ kutipan	string	Kutipan spesifik dalam file.	Tidak.
indeks	bilangan bulat	Indeks anotasi di bagian konten teks.	Yes
start_index	bilangan bulat		Tidak.
kirim pesan teks	string	Teks dalam konten pesan yang perlu diganti.	Tidak.
jenis	string	Selalu file_citation.	Yes

type Enum: MessageDeltaContentTextAnnotationsFileCitationObjectType

Nilai	Deskripsi
file_citation

messageDeltaContentTextAnnotationsFilePathObject

URL untuk file yang dihasilkan saat asisten menggunakan code_interpreter alat untuk menghasilkan file.

Nama	Tipe	Deskripsi	Diperlukan	Default
end_index	bilangan bulat		Tidak.
file_path	objek		Tidak.
└─ file_id	string	ID file yang dihasilkan.	Tidak.
indeks	bilangan bulat	Indeks anotasi di bagian konten teks.	Yes
start_index	bilangan bulat		Tidak.
kirim pesan teks	string	Teks dalam konten pesan yang perlu diganti.	Tidak.
jenis	string	Selalu file_path.	Yes

type Enum: MessageDeltaContentTextAnnotationsFilePathObjectType

Nilai	Deskripsi
file_path

runStepObject

Mewakili langkah dalam eksekusi eksekusi.

Nama	Tipe	Deskripsi	Diperlukan	Default
assistant_id	string	ID asisten yang terkait dengan langkah eksekusi.	Yes
dibatalkan pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat langkah eksekusi dibatalkan.	Yes
selesai_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat langkah eksekusi selesai.	Yes
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat langkah eksekusi dibuat.	Yes
kadaluarsa_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat langkah eksekusi kedaluwarsa. Langkah dianggap kedaluwarsa jika eksekusi induk kedaluwarsa.	Yes
gagal_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat langkah eksekusi gagal.	Yes
id	string	Pengidentifikasi langkah eksekusi, yang dapat dirujuk di titik akhir API.	Yes
kesalahan_terakhir	objek	Kesalahan terakhir yang terkait dengan langkah eksekusi ini. Akan terjadi null jika tidak ada kesalahan.	Yes
└─ kode	string	Salah satu server_error atau rate_limit_exceeded.	Tidak.
└─ pesan	string	Deskripsi kesalahan yang dapat dibaca manusia.	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Yes
objek	string	Tipe objek, yang selalu assistant.run.step.	Yes
run_id	string	ID eksekusi yang merupakan bagian dari langkah eksekusi ini.	Yes
status	string	Status eksekusi, yang dapat berupa in_progress, , cancelled, failedcompleted, atau expired.	Yes
step_details	runStepDetailsMessageCreationObject atau runStepDetailsToolCallsObject	Detail langkah eksekusi.	Yes
thread_id	string	ID utas yang telah dijalankan.	Yes
jenis	string	Jenis langkah eksekusi, yang dapat berupa message_creation atau tool_calls.	Yes

enum objek: RunStepObjectType

Nilai	Deskripsi
assistant.run.step	Jenis objek, yang selalu assistant.run.step

ketik Enum: RunStepObjectType

Nilai	Deskripsi
message_creation	Langkah eksekusi message_creation
tool_calls	Langkah eksekusi tool_calls

Status Enum: RunStepObjectStatus

Nilai	Deskripsi
in_progress	Status eksekusi in_progress
cancelled	Status eksekusi yang dibatalkan
gagal	Status eksekusi yang dibatalkan
selesai	Status eksekusi yang dibatalkan
expired	Status eksekusi yang dibatalkan

runStepDeltaObject

Mewakili delta langkah eksekusi yaitu bidang yang diubah pada langkah eksekusi selama streaming.

Nama	Tipe	Deskripsi	Diperlukan	Default
delta	objek	Delta yang berisi bidang yang telah berubah pada langkah eksekusi.	Yes
└─ detail_langkah	runStepDeltaStepDetailsMessageCreationObject atau runStepDeltaStepDetailsToolCallsObject	Detail langkah eksekusi.	Tidak.
id	string	Pengidentifikasi langkah eksekusi, yang dapat dirujuk di titik akhir API.	Yes
objek	string	Tipe objek, yang selalu thread.run.step.delta.	Yes

enum objek: RunStepDeltaObjectType

Nilai	Deskripsi
thread.run.step.delta

listRunStepsResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array		Yes
first_id	string		Yes
ada_lagi	Boolean		Yes
ID terakhir	string		Yes
objek	string		Yes

runStepDetailsMessageCreationObject

Detail pembuatan pesan dengan langkah eksekusi.

Nama	Tipe	Deskripsi	Diperlukan	Default
message_creation	objek		Yes
└─ message_id	string	ID pesan yang dibuat oleh langkah eksekusi ini.	Tidak.
jenis	string	Selalu message_creation.	Yes

tipe Enum: RunStepDetailsMessageCreationObjectType

Nilai	Deskripsi
message_creation

runStepDeltaStepDetailsMessageCreationObject

Detail pembuatan pesan dengan langkah eksekusi.

Nama	Tipe	Deskripsi	Diperlukan	Default
message_creation	objek		Tidak.
└─ message_id	string	ID pesan yang dibuat oleh langkah eksekusi ini.	Tidak.
jenis	string	Selalu message_creation.	Yes

tipe Enum: ObjekPembuatanPesanDetailLangkahDeltaRunLangkah

Nilai	Deskripsi
message_creation

runStepDetailsToolCallsObject

Detail panggilan alat.

Nama	Tipe	Deskripsi	Diperlukan	Default
tool_calls	array	Array alat yang memanggil langkah eksekusi terlibat. Ini dapat dikaitkan dengan salah satu dari tiga jenis alat: code_interpreter, retrieval atau function.	Yes
jenis	string	Selalu tool_calls.	Yes

jenis Enum: RunStepDetailsToolCallsObjectType

Nilai	Deskripsi
tool_calls

runStepDeltaStepDetailsToolCallsObject

Detail panggilan alat.

Nama	Tipe	Deskripsi	Diperlukan	Default
tool_calls	array	Array alat yang memanggil langkah eksekusi terlibat. Ini dapat dikaitkan dengan salah satu dari tiga jenis alat: code_interpreter, file_search atau function.	Tidak.
jenis	string	Selalu tool_calls.	Yes

type Enum: RunStepDeltaStepDetailsToolCallsObjectType

Nilai	Deskripsi
tool_calls

runStepDetailsToolCallsCodeObject

Detail alat Penerjemah Kode yang menyebut langkah eksekusi terlibat.

Nama	Tipe	Deskripsi	Diperlukan	Default
code_interpreter	objek	Definisi panggilan alat Penerjemah Kode.	Yes
└─ masukan	string	Input ke panggilan alat Penerjemah Kode.	Tidak.
└─ output	array	Output dari panggilan alat Penerjemah Kode. Penerjemah Kode dapat menghasilkan satu atau beberapa item, termasuk teks (logs) atau gambar (image). Masing-masing diwakili oleh jenis objek yang berbeda.	Tidak.
id	string	ID panggilan alat.	Yes
jenis	string	Jenis panggilan alat. Ini akan selalu untuk code_interpreter jenis panggilan alat ini.	Yes

jenis Enum: RunStepDetailsToolCallsCodeObjectType

Nilai	Deskripsi
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

Detail alat Penerjemah Kode yang menyebut langkah eksekusi terlibat.

Nama	Tipe	Deskripsi	Diperlukan	Default
code_interpreter	objek	Definisi panggilan alat Penerjemah Kode.	Tidak.
└─ masukan	string	Input ke panggilan alat Penerjemah Kode.	Tidak.
└─ output	array	Output dari panggilan alat Penerjemah Kode. Penerjemah Kode dapat menghasilkan satu atau beberapa item, termasuk teks (logs) atau gambar (image). Masing-masing diwakili oleh jenis objek yang berbeda.	Tidak.
id	string	ID panggilan alat.	Tidak.
indeks	bilangan bulat	Indeks panggilan alat dalam array panggilan alat.	Yes
jenis	string	Jenis panggilan alat. Ini akan selalu untuk code_interpreter jenis panggilan alat ini.	Yes

jenis Enum: RunStepDeltaStepDetailsToolCallsCodeObjectType

Nilai	Deskripsi
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

Output teks dari panggilan alat Penerjemah Kode sebagai bagian dari langkah eksekusi.

Nama	Tipe	Deskripsi	Diperlukan	Default
logs	string	Output teks dari panggilan alat Penerjemah Kode.	Yes
jenis	string	Selalu logs.	Yes

tipe Enum: Rincian Langkah Menjalankan Panggilan Alat Kode Output Log Tipe Objek

Nilai	Deskripsi
logs

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

Output teks dari panggilan alat Penerjemah Kode sebagai bagian dari langkah eksekusi.

Nama	Tipe	Deskripsi	Diperlukan	Default
indeks	bilangan bulat	Indeks output dalam array output.	Yes
logs	string	Output teks dari panggilan alat Penerjemah Kode.	Tidak.
jenis	string	Selalu logs.	Yes

Jenis Enum: JalankanLangkahDeltaLangkahDetailAlatPanggilanKodeKeluaranCatatanJenisObjek

Nilai	Deskripsi
logs

runStepDetailsToolCallsCodeOutputImageObject

Nama	Tipe	Deskripsi	Diperlukan	Default
citra	objek		Yes
└─ file_id	string	ID File gambar.	Tidak.
jenis	string	Selalu image.	Yes

type Enum: RunStepDetailsToolCallsCodeOutputImageObjectType

Nilai	Deskripsi
citra

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

Nama	Tipe	Deskripsi	Diperlukan	Default
citra	objek		Tidak.
└─ file_id	string	ID file gambar.	Tidak.
indeks	bilangan bulat	Indeks output dalam array output.	Yes
jenis	string	Selalu image.	Yes

jenis Enum: RunStepDeltaStepDetailsToolCallsCodeOutputImageObject

Nilai	Deskripsi
citra

runStepDetailsToolCallsFileSearchObject

Nama	Tipe	Deskripsi	Diperlukan	Default
file_search	objek	Untuk saat ini, ini selalu akan menjadi objek kosong.	Yes
└─ hasil	array	Hasil pencarian file.	Tidak.
id	string	ID objek panggilan alat.	Yes
jenis	string	Jenis panggilan alat. Ini akan selalu untuk file_search jenis panggilan alat ini.	Yes

type Enum: RunStepDetailsToolCalls FileSearch ObjectType

Nilai	Deskripsi
file_search

runStepDetailsToolCallsFileSearchResultObject

Contoh hasil pencarian file.

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	array	Konten hasil yang ditemukan. Konten hanya disertakan jika diminta melalui parameter sertakan kueri.	Tidak.
file_id	string	ID file yang hasilnya ditemukan.	Yes
file_name	string	Nama file yang hasilnya ditemukan.	Yes
skor	nomor/angka	Skor hasilnya. Semua nilai harus berupa angka titik mengambang antara 0 dan 1.	Yes

runStepDeltaStepDetailsToolCallsFileSearchObject

Nama	Tipe	Deskripsi	Diperlukan	Default
file_search	objek	Untuk saat ini, ini selalu akan menjadi objek kosong.	Yes
id	string	ID objek panggilan alat.	Tidak.
indeks	bilangan bulat	Indeks panggilan alat dalam array panggilan alat.	Yes
jenis	string	Jenis panggilan alat. Ini akan selalu untuk retrieval jenis panggilan alat ini.	Yes

type Enum: RunStepDeltaStepDetailsToolCallsFileSearchObjectType

Nilai	Deskripsi
file_search

runStepDetailsToolCallsFunctionObject

Nama	Tipe	Deskripsi	Diperlukan	Default
fungsi	objek	Definisi fungsi yang dipanggil.	Yes
└─ argumen-argumen	string	Argumen diteruskan ke fungsi .	Tidak.
└─ nama	string	Nama fungsi.	Tidak.
└─ keluaran	string	Output fungsi. Ini akan terjadi null jika output belum dikirimkan.	Tidak.
id	string	ID objek panggilan alat.	Yes
jenis	string	Jenis panggilan alat. Ini akan selalu untuk function jenis panggilan alat ini.	Yes

type Enum: RunStepDetailsToolCallsFunctionObjectType

Nilai	Deskripsi
fungsi

runStepDeltaStepDetailsToolCallsFunctionObject

Nama	Tipe	Deskripsi	Diperlukan	Default
fungsi	objek	Definisi fungsi yang dipanggil.	Tidak.
└─ argumen-argumen	string	Argumen diteruskan ke fungsi .	Tidak.
└─ nama	string	Nama fungsi.	Tidak.
└─ keluaran	string	Output fungsi. Ini akan terjadi null jika output belum dikirimkan.	Tidak.
id	string	ID objek panggilan alat.	Tidak.
indeks	bilangan bulat	Indeks panggilan alat dalam array panggilan alat.	Yes
jenis	string	Jenis panggilan alat. Ini akan selalu untuk function jenis panggilan alat ini.	Yes

type Enum: RunStepDetailsToolCallsFunctionObjectType

Nilai	Deskripsi
fungsi

vectorStoreExpirationAfter

Kebijakan kedaluwarsa untuk penyimpanan vektor.

Nama	Tipe	Deskripsi	Diperlukan	Default
jangkar	string	Tanda waktu jangkar setelah kebijakan kedaluwarsa berlaku. Jangkar yang didukung: last_active_at.	Yes
Hari	bilangan bulat	Jumlah hari setelah waktu jangkar penyimpanan vektor akan kedaluwarsa.	Yes

jangkar Enum: VectorStoreExpirationAfterAnchor

Nilai	Deskripsi
terakhir_aktif_pada	Tanda waktu jangkar setelah kebijakan kedaluwarsa berlaku.

vectorStoreObject

Penyimpanan vektor adalah kumpulan file yang diproses dapat digunakan oleh alat.file_search

Nama	Tipe	Deskripsi	Diperlukan	Default
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat penyimpanan vektor dibuat.	Yes
kedaluwarsa_setelah	vectorStoreExpirationAfter	Kebijakan kedaluwarsa untuk penyimpanan vektor.	Tidak.
kedaluwarsa_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat penyimpanan vektor akan kedaluwarsa.	Tidak.
jumlah berkas	objek		Yes
└─ dibatalkan	bilangan bulat	Jumlah file yang dibatalkan.	Tidak.
└─ selesai	bilangan bulat	Jumlah file yang berhasil diproses.	Tidak.
└─ gagal	bilangan bulat	Jumlah file yang gagal diproses.	Tidak.
└─ dalam_proses	bilangan bulat	Jumlah file yang saat ini sedang diproses.	Tidak.
└─ jumlah	bilangan bulat	Jumlah total file.	Tidak.
id	string	Pengidentifikasi, yang dapat dirujuk di titik akhir API.	Yes
terakhir_aktif_pada	bilangan bulat	Tanda waktu Unix (dalam detik) ketika penyimpanan vektor terakhir aktif.	Yes
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Yes
Nama	string	Nama toko vektor.	Yes
objek	enum	Tipe objek, yang selalu vector_store. Nilai yang mungkin: vector_store	Yes
status	string	Status penyimpanan vektor, yang dapat berupa expired, , in_progressatau completed. Status completed menunjukkan bahwa penyimpanan vektor siap digunakan.	Yes
usage_bytes	bilangan bulat	Jumlah total byte yang digunakan oleh file di penyimpanan vektor.	Yes

status Enum: VectorStoreObjectStatus

Nilai	Deskripsi
expired
in_progress
selesai

createVectorStoreRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
chunking_strategy	autoChunkingStrategyRequestParam atau staticChunkingStrategyRequestParam	Strategi penggugusan yang digunakan untuk memotong file. Jika tidak diatur, akan menggunakan auto strategi. Hanya berlaku jika file_ids tidak kosong.	Tidak.
kedaluwarsa_setelah	vectorStoreExpirationAfter	Kebijakan kedaluwarsa untuk penyimpanan vektor.	Tidak.
file_ids	array	Daftar ID file yang harus digunakan penyimpanan vektor. Berguna untuk alat seperti file_search yang dapat access file.	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.
Nama	string	Nama toko vektor.	Tidak.

updateVectorStoreRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
kedaluwarsa_setelah	vectorStoreExpirationAfter	Kebijakan kedaluwarsa untuk penyimpanan vektor.	Tidak.
metadata	objek	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur. Kunci dapat memiliki panjang maksimal 64 karakter dan nilai dapat memiliki panjang maksimal 512 karakter.	Tidak.
Nama	string	Nama toko vektor.	Tidak.

listVectorStoresResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array		Yes
first_id	string		Yes
ada_lagi	Boolean		Yes
ID terakhir	string		Yes
objek	string		Yes

deleteVectorStoreResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
dihapus	Boolean		Yes
id	string		Yes
objek	string		Yes

enum objek: DeleteVectorStoreResponseObject

Nilai	Deskripsi
vector_store.deleted	Status objek respons penyimpanan vektor penghapusan

vectorStoreFileObject

Daftar file yang dilampirkan ke penyimpanan vektor.

Nama	Tipe	Deskripsi	Diperlukan	Default
chunking_strategy	autoChunkingStrategyRequestParam atau staticChunkingStrategyRequestParam	Strategi penggugusan yang digunakan untuk memotong file. Jika tidak diatur, akan menggunakan auto strategi. Hanya berlaku jika file_ids tidak kosong.	Tidak.
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) saat file penyimpanan vektor dibuat.	Yes
id	string	Pengidentifikasi, yang dapat dirujuk di titik akhir API.	Yes
kesalahan_terakhir	objek	Kesalahan terakhir yang terkait dengan file penyimpanan vektor ini. Akan terjadi null jika tidak ada kesalahan.	Yes
└─ kode	string	Salah satu dari server_error atau invalid_file atau unsupported_file.	Tidak.
└─ pesan	string	Deskripsi kesalahan yang dapat dibaca manusia.	Tidak.
objek	string	Tipe objek, yang selalu vector_store.file.	Yes
status	string	Status file penyimpanan vektor, yang dapat berupa in_progress, , completedcancelled, atau failed. Status completed menunjukkan bahwa file penyimpanan vektor siap digunakan.	Yes
usage_bytes	bilangan bulat	Total penggunaan penyimpanan vektor dalam byte. Perhatikan bahwa ini mungkin berbeda dari ukuran file asli.	Yes
vector_store_id	string	ID penyimpanan vektor tempat file dilampirkan.	Yes

enum objek: VectorStoreFileObjectType

Nilai	Deskripsi
vector_store.file

status Enum: VectorStoreFileObjectStatus

Nilai	Deskripsi
in_progress
selesai
cancelled
gagal

otherChunkingStrategyResponseParam

Ini dikembalikan ketika strategi penggugusan tidak diketahui. Biasanya, ini karena file diindeks sebelum chunking_strategy konsep diperkenalkan dalam API.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	string	Selalu other.	Yes

jenis Enum: OtherChunkingStrategyResponseParamType

Nilai	Deskripsi
other

staticChunkingStrategyResponseParam

Nama	Tipe	Deskripsi	Diperlukan	Default
statik	staticChunkingStrategy		Yes
jenis	string	Selalu static.	Yes

tipe Enum: StatikStrategiPengelompokanResponParamTipe

Nilai	Deskripsi
statik

staticChunkingStrategy

Nama	Tipe	Deskripsi	Diperlukan	Default
token tumpang tindih potongan	bilangan bulat	Jumlah token yang tumpang tindih di antara gugus. Nilai defaultnya adalah 400. Perhatikan bahwa tumpang tindih tidak boleh melebihi setengah dari max_chunk_size_tokens.	Yes
ukuran_maksimum_potongan_token	bilangan bulat	Jumlah maksimum token di setiap gugus. Nilai defaultnya adalah 800. Nilai minimum adalah 100 dan nilai maksimumnya adalah 4096.	Yes

autoChunkingStrategyRequestParam

Strategi default. Strategi ini saat ini menggunakan max_chunk_size_tokens dari 800 dan chunk_overlap_tokens dari 400.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Selalu auto. Nilai yang mungkin: auto	Yes

staticChunkingStrategyRequestParam

Nama	Tipe	Deskripsi	Diperlukan	Default
statik	staticChunkingStrategy		Yes
jenis	enum	Selalu static. Nilai yang mungkin: static	Yes

chunkingStrategyRequestParam

Strategi penggugusan yang digunakan untuk memotong file. Jika tidak diatur, akan menggunakan auto strategi.

Komponen ini bisa menjadi salah satu hal berikut:

• autoChunkingStrategyRequestParam
• staticChunkingStrategyRequestParam

createVectorStoreFileRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
chunking_strategy	chunkingStrategyRequestParam	Strategi penggugusan yang digunakan untuk memotong file. Jika tidak diatur, akan menggunakan auto strategi.	Tidak.
file_id	string	ID File yang harus digunakan penyimpanan vektor. Berguna untuk alat seperti file_search yang dapat access file.	Yes

listVectorStoreFilesResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array		Yes
first_id	string		Yes
ada_lagi	Boolean		Yes
ID terakhir	string		Yes
objek	string		Yes

deleteVectorStoreFileResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
dihapus	Boolean		Yes
id	string		Yes
objek	string		Yes

enum objek: DeleteVectorStoreFileResponseObject

Nilai	Deskripsi
vector_store.file.deleted

vectorStoreFileBatchObject

Batch file yang dilampirkan ke penyimpanan vektor.

Nama	Tipe	Deskripsi	Diperlukan	Default
dibuat_pada	bilangan bulat	Tanda waktu Unix (dalam detik) ketika batch file penyimpanan vektor dibuat.	Yes
jumlah berkas	objek		Yes
└─ dibatalkan	bilangan bulat	Jumlah file yang dibatalkan.	Tidak.
└─ selesai	bilangan bulat	Jumlah file yang telah diproses.	Tidak.
└─ gagal	bilangan bulat	Jumlah file yang gagal diproses.	Tidak.
└─ dalam_proses	bilangan bulat	Jumlah file yang saat ini sedang diproses.	Tidak.
└─ jumlah	bilangan bulat	Jumlah total file.	Tidak.
id	string	Pengidentifikasi, yang dapat dirujuk di titik akhir API.	Yes
objek	string	Tipe objek, yang selalu vector_store.file_batch.	Yes
status	string	Status batch file penyimpanan vektor, yang dapat berupa in_progress, , completedcancelled atau failed.	Yes
vector_store_id	string	ID penyimpanan vektor tempat File dilampirkan.	Yes

enum objek: VectorStoreFileBatchObjectType

Nilai	Deskripsi
vector_store.files_batch

status Enum: VectorStoreFileBatchObjectStatus

Nilai	Deskripsi
in_progress
selesai
cancelled
gagal

createVectorStoreFileBatchRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
chunking_strategy	chunkingStrategyRequestParam	Strategi penggugusan yang digunakan untuk memotong file. Jika tidak diatur, akan menggunakan auto strategi.	Tidak.
file_ids	array	Daftar ID File yang harus digunakan penyimpanan vektor. Berguna untuk alat seperti file_search yang dapat access file.	Yes

assistantStreamEvent

Mewakili peristiwa yang dipancarkan saat melakukan streaming Eksekusi.

Setiap peristiwa dalam aliran peristiwa yang dikirim server memiliki event properti dan data :

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

Kami mengeluarkan peristiwa setiap kali objek baru dibuat, beralih ke status baru, atau sedang dialirkan di bagian (delta). Misalnya, kami memancarkan thread.run.created saat eksekusi baru dibuat, thread.run.completed saat eksekusi selesai, dan sebagainya. Saat Asisten memilih untuk membuat pesan selama eksekusi, kami memancarkan thread.message.created event, thread.message.in_progress peristiwa, banyak thread.message.delta peristiwa, dan akhirnya peristiwa thread.message.completed .

Kami dapat menambahkan peristiwa tambahan dari waktu ke waktu, jadi sebaiknya tangani peristiwa yang tidak diketahui dengan baik dalam kode Anda.

Komponen ini bisa menjadi salah satu hal berikut:

• threadStreamEvent
• runStreamEvent
• runStepStreamEvent
• messageStreamEvent
• errorEvent
• doneEvent

threadStreamEvent

Komponen ini bisa menjadi salah satu hal berikut:

thread.created

Terjadi ketika utas baru dibuat.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	threadObject	Mewakili utas yang berisi pesan.	Yes
acara	string		Yes

Data: threadObject

Enum Peristiwa: ThreadStreamEventEnum

Nilai	Deskripsi
thread.created	Peristiwa yang dibuat utas

---

runStreamEvent

Komponen ini bisa menjadi salah satu hal berikut:

thread.run.created

Terjadi ketika eksekusi baru dibuat.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	runObject	Mewakili eksekusi yang dijalankan pada beberapa utas.	Yes
acara	string		Yes

Data: runObject

Enum Peristiwa: RunStreamEventCreated

Nilai	Deskripsi
thread.run.created

---

thread.run.queued

Terjadi saat eksekusi berpindah ke queued status.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	runObject	Mewakili eksekusi yang dijalankan pada beberapa utas.	Yes
acara	string		Yes

Data: runObject

Enum Peristiwa: RunStreamEventQueued

Nilai	Deskripsi
thread.run.queued

---

thread.run.in_progress

Terjadi ketika eksekusi berpindah ke in_progress status.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	runObject	Mewakili eksekusi yang dijalankan pada beberapa utas.	Yes
acara	string		Yes

Data: runObject

Enum Peristiwa: RunStreamEventInProgress

Nilai	Deskripsi
thread.run.in_progress

---

thread.run.requires_action

Terjadi saat eksekusi berpindah ke requires_action status.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	runObject	Mewakili eksekusi yang dijalankan pada beberapa utas.	Yes
acara	string		Yes

Data: runObject

Enum Peristiwa: RunStreamEventRequiresAction

Nilai	Deskripsi
thread.run.requires_action

---

thread.run.completed

Terjadi ketika eksekusi selesai.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	runObject	Mewakili eksekusi yang dijalankan pada beberapa utas.	Yes
acara	string		Yes

Data: runObject

Enum Peristiwa: RunStreamEventCompleted

Nilai	Deskripsi
thread.run.completed

---

thread.run.failed

Terjadi ketika eksekusi gagal.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	runObject	Mewakili eksekusi yang dijalankan pada beberapa utas.	Yes
acara	string		Yes

Data: runObject

Enum Peristiwa: RunStreamEventFailed

Nilai	Deskripsi
thread.run.failed

---

thread.run.cancelling

Terjadi saat eksekusi berpindah ke cancelling status.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	runObject	Mewakili eksekusi yang dijalankan pada beberapa utas.	Yes
acara	string		Yes

Data: runObject

Enum Peristiwa: RunStreamEventCancelling

Nilai	Deskripsi
thread.run.cancelling

---

thread.run.cancelled

Terjadi ketika eksekusi dibatalkan.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	runObject	Mewakili eksekusi yang dijalankan pada beberapa utas.	Yes
acara	string		Yes

Data: runObject

Enum Peristiwa: RunStreamEventCancelled

Nilai	Deskripsi
thread.run.cancelled

---

thread.run.expired

Terjadi ketika eksekusi kedaluwarsa.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	runObject	Mewakili eksekusi yang dijalankan pada beberapa utas.	Yes
acara	string		Yes

Data: runObject

Enum Peristiwa: RunStreamEventExpired

Nilai	Deskripsi
thread.run.expired

---

runStepStreamEvent

Komponen ini bisa menjadi salah satu hal berikut:

thread.run.step.created

Terjadi ketika langkah eksekusi dibuat.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	runStepObject	Mewakili langkah dalam eksekusi eksekusi.	Yes
acara	string		Yes

Data: runStepObject

Enum Peristiwa: RunStepStreamEventCreated

Nilai	Deskripsi
thread.run.step.created

---

thread.run.step.in_progress

Terjadi ketika langkah eksekusi berpindah ke status in_progress .

Nama	Tipe	Deskripsi	Diperlukan	Default
data	runStepObject	Mewakili langkah dalam eksekusi eksekusi.	Yes
acara	string		Yes

Data: runStepObject

Enum Peristiwa: RunStepStreamEventInProgress

Nilai	Deskripsi
thread.run.step.in_progress

---

thread.run.step.delta

Terjadi ketika bagian dari langkah eksekusi sedang dialirkan.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	runStepDeltaObject	Mewakili delta langkah eksekusi yaitu bidang yang diubah pada langkah eksekusi selama streaming.	Yes
acara	string		Yes

Data: runStepDeltaObject

Enum Peristiwa: RunStepStreamEventDelta

Nilai	Deskripsi
thread.run.step.delta

---

thread.run.step.completed

Terjadi ketika langkah eksekusi selesai.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	runStepObject	Mewakili langkah dalam eksekusi eksekusi.	Yes
acara	string		Yes

Data: runStepObject

Enum Peristiwa: RunStepStreamEventCompleted

Nilai	Deskripsi
thread.run.step.completed

---

thread.run.step.failed

Terjadi ketika langkah eksekusi gagal.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	runStepObject	Mewakili langkah dalam eksekusi eksekusi.	Yes
acara	string		Yes

Data: runStepObject

Enum Peristiwa: RunStepStreamEventFailed

Nilai	Deskripsi
thread.run.step.failed

---

thread.run.step.cancelled

Terjadi ketika langkah eksekusi dibatalkan.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	runStepObject	Mewakili langkah dalam eksekusi eksekusi.	Yes
acara	string		Yes

Data: runStepObject

Enum Peristiwa: RunStepStreamEventCancelled

Nilai	Deskripsi
thread.run.step.cancelled

---

thread.run.step.expired

Terjadi ketika langkah eksekusi kedaluwarsa.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	runStepObject	Mewakili langkah dalam eksekusi eksekusi.	Yes
acara	string		Yes

Data: runStepObject

Enum Peristiwa: RunStepStreamEventExpired

Nilai	Deskripsi
thread.run.step.expired

---

messageStreamEvent

Komponen ini bisa menjadi salah satu hal berikut:

thread.message.created

Terjadi saat pesan dibuat.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	messageObject	Mewakili pesan dalam utas.	Yes
acara	string		Yes

Data: messageObject

Enum Peristiwa: MessageStreamEventCreated

Nilai	Deskripsi
thread.message.created

---

thread.message.in_progress

Terjadi ketika pesan berpindah ke status in_progress .

Nama	Tipe	Deskripsi	Diperlukan	Default
data	messageObject	Mewakili pesan dalam utas.	Yes
acara	string		Yes

Data: messageObject

Enum Peristiwa: MessageStreamEventInProgress

Nilai	Deskripsi
thread.message.in_progress

---

thread.message.delta

Terjadi ketika bagian pesan sedang dialirkan.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	messageDeltaObject	Mewakili delta pesan yaitu bidang yang diubah pada pesan selama streaming.	Yes
acara	string		Yes

Data: messageDeltaObject

Enum Peristiwa: MessageStreamEventDelta

Nilai	Deskripsi
thread.message.delta

---

thread.message.completed

Terjadi ketika pesan selesai.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	messageObject	Mewakili pesan dalam utas.	Yes
acara	string		Yes

Data: messageObject

Enum Peristiwa: MessageStreamEventCompleted

Nilai	Deskripsi
thread.message.completed

---

thread.message.incomplete

Terjadi ketika pesan berakhir sebelum selesai.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	messageObject	Mewakili pesan dalam utas.	Yes
acara	string		Yes

Data: messageObject

Enum Peristiwa: MessageStreamEventIncomplete

Nilai	Deskripsi
thread.message.incomplete

---

Annotation

Komponen ini bisa menjadi salah satu hal berikut:

• FileCitation
• UrlCitation
• FilePath

Click

Sebuah tindakan klik.

Nama	Tipe	Deskripsi	Diperlukan	Default
tombol	enum	Menunjukkan tombol mouse mana yang ditekan selama klik. Salah satu dari left, right, wheel, back, atau forward. Nilai yang mungkin: left, , rightwheel, back,forward	Yes
jenis	enum	Menentukan jenis peristiwa. Untuk tindakan klik, properti ini selalu diatur ke click. Nilai yang mungkin: click	Yes
x	bilangan bulat	Koordinat x tempat klik terjadi.	Yes
y	bilangan bulat	Koordinat y di mana klik terjadi.	Yes

CodeInterpreterFileOutput

Output yang dihasilkan dari panggilan alat interpretasi kode adalah sebuah file.

Nama	Tipe	Deskripsi	Diperlukan	Default
files	array		Yes
jenis	enum	Jenis berkas keluaran penerjemah kode. Selalu files. Nilai yang mungkin: files	Yes

CodeInterpreterTextOutput

Output dari panggilan alat penafsir kode adalah teks.

Nama	Tipe	Deskripsi	Diperlukan	Default
logs	string	Log panggilan alat penerjemah kode.	Yes
jenis	enum	Jenis output teks penerjemah kode. Selalu logs. Nilai yang mungkin: logs	Yes

CodeInterpreterTool

Alat yang menjalankan kode.

Nama	Tipe	Deskripsi	Diperlukan	Default
file_ids	array	ID file untuk menjalankan kode.	Yes
jenis	enum	Jenis alat penerjemah kode. Selalu code_interpreter. Nilai yang mungkin: code_interpreter	Yes

CodeInterpreterToolCall

Panggilan alat untuk menjalankan kode.

Nama	Tipe	Deskripsi	Diperlukan	Default
kode	string	Kode yang akan dijalankan.	Yes
id	string	ID unik dari panggilan alat penerjemah kode.	Yes
results	array	Hasil panggilan alat penerjemah kode.	Yes
status	enum	Status panggilan alat penerjemah kode. Nilai yang mungkin: in_progress, interpreting, completed	Yes
jenis	enum	Jenis panggilan alat penerjemah kode. Selalu code_interpreter_call. Nilai yang mungkin: code_interpreter_call	Yes

CodeInterpreterToolOutput

Komponen ini bisa menjadi salah satu hal berikut:

• CodeInterpreterTextOutput
• CodeInterpreterFileOutput

ComparisonFilter

Filter yang digunakan untuk membandingkan kunci atribut tertentu dengan nilai tertentu menggunakan operasi perbandingan yang ditentukan.

Nama	Tipe	Deskripsi	Diperlukan	Default
kunci	string	Kunci pembanding terhadap nilai.	Yes
jenis	enum	Menentukan operator perbandingan: eq, , ne, gt, gte, lt, lte. - eq:Sama - ne: tidak sama dengan - gt: lebih besar dari - gte: lebih besar dari atau sama dengan - lt: Kurang dari - lte: kurang dari atau sama dengan Nilai yang mungkin: eq, , negt, gte, lt,lte	Yes
nilai	string atau angka atau boolean	Nilai untuk dibandingkan dengan kunci atribut; mendukung jenis string, angka, atau boolean.	Yes

CompoundFilter

Gabungkan beberapa filter menggunakan and atau or.

Nama	Tipe	Deskripsi	Diperlukan	Default
filters	array	Kumpulan filter untuk digabungkan. Item dapat berupa ComparisonFilter atau CompoundFilter.	Yes
jenis	enum	Jenis operasi: and atau or. Nilai yang mungkin: and, or	Yes

ComputerAction

Komponen ini bisa menjadi salah satu hal berikut:

• Click
• DoubleClick
• Drag
• KeyPress
• Move
• Screenshot
• Scroll
• Jenis
• Wait

ComputerScreenshotImage

Gambar cuplikan layar komputer yang digunakan dengan alat untuk penggunaan komputer.

Nama	Tipe	Deskripsi	Diperlukan	Default
file_id	string	Pengidentifikasi file yang diunggah yang berisi cuplikan layar.	Tidak.
image_url	string	URL gambar cuplikan layar.	Tidak.
jenis	enum	Menentukan jenis peristiwa. Untuk cuplikan layar komputer, properti ini selalu diatur ke computer_screenshot. Nilai yang mungkin: computer_screenshot	Yes

ComputerTool

Alat yang mengontrol komputer virtual.

Nama	Tipe	Deskripsi	Diperlukan	Default
tinggi_tampilan	nomor/angka	Tinggi layar komputer.	Yes
lebar_tampilan	nomor/angka	Lebar tampilan komputer.	Yes
environment	enum	Jenis lingkungan komputer yang akan dikontrol. Nilai yang mungkin: mac, windows, ubuntu, browser	Yes
jenis	enum	Jenis alat penggunaan komputer. Selalu computer_use_preview. Nilai yang mungkin: computer-use-preview	Yes

ComputerToolCall

Panggilan alat ke alat penggunaan komputer.

Nama	Tipe	Deskripsi	Diperlukan	Default
tindakan	ComputerAction		Yes
call_id	string	Identifikasi yang digunakan ketika merespon panggilan alat dengan output.	Yes
id	string	ID unik panggilan komputer.	Yes
pending_safety_checks	array	Pemeriksaan keamanan tertunda untuk panggilan komputer.	Yes
status	enum	Status barang tersebut. Salah satu dari in_progress, completed, atau incomplete. Diisi saat item dikembalikan melalui API. Nilai yang mungkin: in_progress, completed, incomplete	Yes
jenis	enum	Jenis panggilan komputer. Selalu computer_call. Nilai yang mungkin: computer_call	Yes

ComputerToolCallOutput

Keluaran dari pengoperasian alat komputer.

Nama	Tipe	Deskripsi	Diperlukan	Default
acknowledged_safety_checks	array	Pemeriksaan keamanan yang dilaporkan oleh API dan telah diakui oleh pengembang.	Tidak.
call_id	string	ID panggilan alat komputer yang menghasilkan output.	Yes
id	string	ID dari keluaran panggilan alat komputer.	Tidak.
output	ComputerScreenshotImage	Gambar cuplikan layar komputer yang digunakan dengan alat untuk penggunaan komputer.	Yes
status	enum	Status dari input pesan. Salah satu dari in_progress, completed, atau incomplete. Diisi saat item input dikembalikan melalui API. Nilai yang mungkin: in_progress, completed, incomplete	Tidak.
jenis	enum	Jenis output panggilan alat komputer. Selalu computer_call_output. Nilai yang mungkin: computer_call_output	Yes

ComputerToolCallOutputResource

Nama	Tipe	Deskripsi	Diperlukan	Default
acknowledged_safety_checks	array	Pemeriksaan keamanan yang dilaporkan oleh API dan telah diakui oleh pengembang.	Tidak.
call_id	string	ID panggilan alat komputer yang menghasilkan output.	Yes
id	string	ID unik dari output alat panggilan komputer.	Yes
output	ComputerScreenshotImage	Gambar cuplikan layar komputer yang digunakan dengan alat untuk penggunaan komputer.	Yes
status	enum	Status dari input pesan. Salah satu dari in_progress, completed, atau incomplete. Diisi saat item input dikembalikan melalui API. Nilai yang mungkin: in_progress, completed, incomplete	Tidak.
jenis	enum	Jenis output panggilan alat komputer. Selalu computer_call_output. Nilai yang mungkin: computer_call_output	Yes

ComputerToolCallSafetyCheck

Pemeriksaan keamanan tertunda untuk panggilan komputer.

Nama	Tipe	Deskripsi	Diperlukan	Default
kode	string	Jenis pemeriksaan keamanan yang tertunda.	Yes
id	string	ID pemeriksaan keamanan yang tertunda.	Yes
pesan	string	Detail tentang pemeriksaan keamanan yang tertunda.	Yes

Content

Konten multi-modal untuk input dan output.

Komponen ini bisa menjadi salah satu hal berikut:

• InputContent
• OutputContent

Coordinate

Pasangan koordinat x/y, misalnya { x: 100, y: 200 }.

Nama	Tipe	Deskripsi	Diperlukan	Default
x	bilangan bulat	Koordinat x.	Yes
y	bilangan bulat	Koordinat y.	Yes

CreateModelResponseProperties

Nama	Tipe	Deskripsi	Diperlukan	Default
metadata	Metadata	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
model	string	Model yang digunakan untuk menghasilkan respons.	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Kami umumnya merekomendasikan untuk memodifikasi ini atau top_p tetapi tidak keduanya.	Tidak.	1
top_p	nomor/angka	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk memodifikasi ini atau temperature tetapi tidak keduanya.	Tidak.	1
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu OpenAI memantau dan mendeteksi penyalahgunaan. .	Tidak.

createResponse

Nama	Tipe	Deskripsi	Diperlukan	Default
termasuk	array	{"$ref": "#/components/schemas/includable/description"}	Tidak.
Masukan	string atau array	Input teks, gambar, atau file ke model, digunakan untuk menghasilkan respons.	Yes
instructions	string	Menyisipkan pesan sistem (atau pengembang) sebagai item pertama dalam konteks model. Saat menggunakan bersama dengan previous_response_id, instruksi dari respons sebelumnya tidak akan dibawa ke respons berikutnya. Ini memudahkan untuk menukar pesan sistem (atau pengembang) dalam respons baru.	Tidak.
max_output_tokens	bilangan bulat	Batas maksimum untuk jumlah token yang dapat dihasilkan untuk respons, termasuk token keluaran yang terlihat dan token penalaran.	Tidak.
pemanggilan_alat_paralel	Boolean	Apakah akan mengizinkan model menjalankan panggilan alat secara paralel.	Tidak.	Benar
previous_response_id	string	ID unik dari respons sebelumnya ke model. Gunakan ini untuk membuat percakapan multi-giliran.	Tidak.
reasoning	Reasoning	Opsi konfigurasi untuk model penalaran.	Tidak.
simpan	Boolean	Apakah akan menyimpan respons model yang dihasilkan untuk pengambilan nanti melalui API.	Tidak.	Benar
aliran	Boolean	Jika diatur ke true, data respons model akan dialirkan ke klien saat dibuat menggunakan peristiwa yang dikirim server.	Tidak.	False
kirim pesan teks	objek	Opsi konfigurasi untuk respons teks dari model. Dapat berupa teks biasa atau data JSON terstruktur. Pelajari lebih lanjut: - masukan dan keluaran teks - Output Terstruktur	Tidak.
└─ bentuk	TextResponseFormatConfiguration	Objek yang menentukan format yang harus dihasilkan model. Mengonfigurasi { "type": "json_schema" } memungkinkan Output Terstruktur, yang memastikan model cocok dengan skema JSON yang Anda berikan. Format defaultnya adalah { "type": "text" } tanpa opsi tambahan. Tidak disarankan untuk model gpt-4o dan yang lebih baru: Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON yang lebih lama, yang memastikan pesan yang dihasilkan model adalah JSON yang valid. Penggunaan json_schema lebih disukai untuk model yang mendukungnya.	Tidak.
tool_choice	ToolChoiceOptions atau ToolChoiceTypes atau ToolChoiceFunction	Bagaimana model harus memilih alat (atau alat) mana yang akan digunakan saat menghasilkan respons. tools Lihat parameter untuk melihat cara menentukan alat mana yang dapat dipanggil model.	Tidak.
perangkat	array	Sekumpulan alat yang dapat dipanggil model ketika menghasilkan respons. Anda dapat menentukan alat mana yang akan digunakan dengan mengatur tool_choice parameter . Dua kategori alat yang dapat Anda sediakan untuk model adalah: - Alat bawaan	Tidak.
truncation	enum	Strategi pemotongan yang akan digunakan untuk respons model. - auto: Jika konteks respons ini dan yang sebelumnya melebihi ukuran jendela konteks model, model akan memotong menyesuaikan respons agar sesuai dengan jendela konteks dengan menghilangkan item input di tengah percakapan. - disabled (default): Jika respons model akan melebihi ukuran jendela konteks untuk model, permintaan akan gagal dengan kesalahan 400. Nilai yang mungkin: auto, disabled	Tidak.

DoubleClick

Tindakan klik ganda.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Menentukan jenis peristiwa. Untuk tindakan klik ganda, properti ini selalu diatur ke double_click. Nilai yang mungkin: double_click	Yes
x	bilangan bulat	Koordinat x tempat klik ganda terjadi.	Yes
y	bilangan bulat	Koordinat y pada tempat klik ganda dilakukan.	Yes

Drag

Aksi menyeret

Nama	Tipe	Deskripsi	Diperlukan	Default
path	array	Sekumpulan koordinat yang mewakili jalur aksi tarik. Koordinat akan muncul sebagai array objek, misalnya[{ x: 100, y: 200 }, { x: 200, y: 300 }]	Yes
jenis	enum	Menentukan jenis peristiwa. Untuk tindakan seret, properti ini selalu diatur ke drag. Nilai yang mungkin: drag	Yes

EasyInputMessage

Sebuah pesan input ke model dengan peran yang menunjukkan adanya instruksi yang mengikuti hierarki. Instruksi yang diberikan dengan peran developer atau system lebih diutamakan daripada instruksi yang diberikan dengan peran user. Pesan dengan assistant peran tersebut diduga telah dihasilkan oleh model dalam interaksi sebelumnya.

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	string atau InputMessageContentList	Input teks, gambar, atau audio ke model, digunakan untuk menghasilkan respons. Juga dapat berisi respons asisten sebelumnya.	Yes
peran	enum	Peran dalam memasukkan pesan. Salah satu dari user, assistant, system, atau developer. Nilai yang mungkin: user, assistant, system, developer	Yes
jenis	enum	Jenis input pesan. Selalu message. Nilai yang mungkin: message	Tidak.

FileCitation

Kutipan ke file.

Nama	Tipe	Deskripsi	Diperlukan	Default
file_id	string	ID file.	Yes
indeks	bilangan bulat	Indeks file dalam daftar file tersebut.	Yes
jenis	enum	Jenis kutipan dari file Selalu file_citation. Nilai yang mungkin: file_citation	Yes

FilePath

Jalur ke file.

Nama	Tipe	Deskripsi	Diperlukan	Default
file_id	string	ID file.	Yes
indeks	bilangan bulat	Indeks file dalam daftar file tersebut.	Yes
jenis	enum	Jenis jalur file. Selalu file_path. Nilai yang mungkin: file_path	Yes

FileSearchRanker

Ranker yang digunakan untuk pencarian file. Jika tidak ditentukan akan menggunakan pemeringkat auto.

Harta benda	Nilai
Deskripsi	Ranker yang digunakan untuk pencarian file. Jika tidak ditentukan akan menggunakan pemeringkat auto.
Jenis	string
Nilai	auto default_2024_08_21

FileSearchTool

Alat yang mencari konten yang relevan dari file yang diunggah.

Nama	Tipe	Deskripsi	Diperlukan	Default
filters	ComparisonFilter atau CompoundFilter	Filter untuk diterapkan berdasarkan atribut file.	Tidak.
jumlah_maksimum_hasil	bilangan bulat	Jumlah maksimum hasil yang akan dikembalikan. Angka ini harus antara 1 dan 50 inklusif.	Tidak.
opsi_peringkat	objek	Opsi peringkat untuk pencarian.	Tidak.
└─ peringkat	enum	Ranker yang digunakan untuk pencarian file. Nilai yang mungkin: auto, default-2024-11-15	Tidak.
└─ ambang_batas_skornya	nomor/angka	Ambang skor untuk pencarian file, angka antara 0 dan 1. Angka yang lebih dekat ke 1 akan mencoba mengembalikan hanya hasil yang paling relevan, tetapi dapat mengembalikan lebih sedikit hasil.	Tidak.	0
jenis	enum	Jenis alat pencarian file. Selalu file_search. Nilai yang mungkin: file_search	Yes
vektor_penyimpanan_ID	array	ID dari penyimpanan vektor yang akan dicari.	Yes

FileSearchToolCall

Hasil panggilan alat pencarian file.

Nama	Tipe	Deskripsi	Diperlukan	Default
id	string	ID unik dari panggilan alat pencarian file.	Yes
queries	array	Kueri yang digunakan untuk mencari file.	Yes
results	array	Hasil panggilan alat pencarian file.	Tidak.
status	enum	Status panggilan alat pencarian file. Salah satu dari in_progress, searching, incomplete atau failed, Nilai yang mungkin: in_progress, , searchingcompleted, incomplete,failed	Yes
jenis	enum	Jenis panggilan alat pencarian file. Selalu file_search_call. Nilai yang mungkin: file_search_call	Yes

FunctionTool

Menentukan fungsi dalam kode Anda sendiri yang dapat dipilih model untuk dipanggil.

Nama	Tipe	Deskripsi	Diperlukan	Default
deskripsi	string	Deskripsi fungsi. Digunakan oleh model untuk menentukan apakah akan memanggil fungsi atau tidak.	Tidak.
Nama	string	Nama fungsi yang akan dipanggil.	Yes
parameter	objek	Objek skema JSON yang menjelaskan parameter fungsi.	Yes
tegas	Boolean	Apakah akan menerapkan validasi parameter yang ketat. Bawaan true.	Yes
jenis	enum	Jenis alat bantu fungsi. Selalu function. Nilai yang mungkin: function	Yes

FunctionToolCall

Panggilan alat untuk menjalankan fungsi.

Nama	Tipe	Deskripsi	Diperlukan	Default
argumen	string	String JSON berisi argumen untuk dilewatkan ke fungsi.	Yes
call_id	string	ID unik dari panggilan alat fungsional yang dihasilkan oleh model.	Yes
id	string	ID unik dari panggilan alat fungsi.	Yes
Nama	string	Nama fungsi yang akan dijalankan.	Yes
status	enum	Status barang tersebut. Salah satu dari in_progress, completed, atau incomplete. Diisi saat item dikembalikan melalui API. Nilai yang mungkin: in_progress, completed, incomplete	Tidak.
jenis	enum	Jenis pemanggilan alat fungsi. Selalu function_call. Nilai yang mungkin: function_call	Yes

FunctionToolCallOutput

Output dari pemanggilan fungsi alat.

Nama	Tipe	Deskripsi	Diperlukan	Default
call_id	string	ID unik dari panggilan alat fungsional yang dihasilkan oleh model.	Yes
id	string	ID unik dari keluaran panggilan peranti fungsi. Diisi saat item ini dikembalikan melalui API.	Tidak.
output	string	String JSON dari output pemanggilan fungsi alat.	Yes
status	enum	Status barang tersebut. Salah satu dari in_progress, completed, atau incomplete. Diisi saat item dikembalikan melalui API. Nilai yang mungkin: in_progress, completed, incomplete	Tidak.
jenis	enum	Jenis keluaran panggilan fungsi perangkat. Selalu function_call_output. Nilai yang mungkin: function_call_output	Yes

FunctionToolCallOutputResource

Nama	Tipe	Deskripsi	Diperlukan	Default
call_id	string	ID unik dari panggilan alat fungsional yang dihasilkan oleh model.	Yes
id	string	ID unik dari output alat panggilan fungsi.	Yes
output	string	String JSON dari output pemanggilan fungsi alat.	Yes
status	enum	Status barang tersebut. Salah satu dari in_progress, completed, atau incomplete. Diisi saat item dikembalikan melalui API. Nilai yang mungkin: in_progress, completed, incomplete	Tidak.
jenis	enum	Jenis keluaran panggilan fungsi perangkat. Selalu function_call_output. Nilai yang mungkin: function_call_output	Yes

includable

Tentukan data output tambahan untuk disertakan dalam respons model. Nilai yang saat ini didukung adalah:

• file_search_call.results: Sertakan hasil pencarian panggilan alat pencarian file.
• message.input_image.image_url: Sertakan url gambar dari pesan input.
• computer_call_output.output.image_url: Sertakan url gambar dari output panggilan komputer.

Harta benda	Nilai
Deskripsi	Tentukan data output tambahan untuk disertakan dalam respons model. Nilai yang saat ini didukung adalah: - file_search_call.results: Sertakan hasil pencarian dari alat pencari file. - message.input_image.image_url: Sertakan url gambar dari pesan input. - computer_call_output.output.image_url: Sertakan url gambar dari output panggilan komputer.
Jenis	string
Nilai	file_search_call.results message.input_image.image_url computer_call_output.output.image_url

InputAudio

Masukan audio ke dalam model.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	string	Data audio yang dikodekan Base64.	Yes
format	enum	Format audio data. Format yang saat ini didukung adalah mp3 dan wav. Nilai yang mungkin: mp3, wav	Yes
jenis	enum	Jenis item input. Selalu input_audio. Nilai yang mungkin: input_audio	Yes

InputContent

Komponen ini bisa menjadi salah satu hal berikut:

• InputText
• InputImage
• InputFile

InputFile

Sebuah file input ke model.

Nama	Tipe	Deskripsi	Diperlukan	Default
file_data	string	Konten file yang akan dikirim ke model.	Tidak.
file_id	string	ID file yang akan dikirim ke model.	Tidak.
filename	string	Nama file yang akan dikirim ke model.	Tidak.
jenis	enum	Jenis item input. Selalu input_file. Nilai yang mungkin: input_file	Yes

InputImage

Input gambar ke model.

Nama	Tipe	Deskripsi	Diperlukan	Default
detail	enum	Tingkat detail gambar yang akan dikirim ke model. Salah satu dari high, low, atau auto. Secara default menjadi auto. Nilai yang mungkin: high, low, auto	Yes
file_id	string	ID file yang akan dikirim ke model.	Tidak.
image_url	string	URL gambar yang akan dikirim ke model. URL yang sepenuhnya memenuhi syarat atau gambar yang dikodekan base64 dalam URL data.	Tidak.
jenis	enum	Jenis item input. Selalu input_image. Nilai yang mungkin: input_image	Yes

InputItem

Komponen ini bisa menjadi salah satu hal berikut:

• EasyInputMessage
• Item
• ItemReference

Pesan Masukan

Sebuah pesan input ke model dengan peran yang menunjukkan adanya instruksi yang mengikuti hierarki. Instruksi yang diberikan dengan peran developer atau system lebih diutamakan daripada instruksi yang diberikan dengan peran user.

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	InputMessageContentList	Daftar satu atau banyak item input ke model, berisi konten yang berbeda types.	Yes
peran	enum	Peran dalam memasukkan pesan. Salah satu dari user, system, atau developer. Nilai yang mungkin: user, system, developer	Yes
status	enum	Status dari item. Salah satu dari in_progress, completed, atau incomplete. Diisi saat item dikembalikan melalui API. Nilai yang mungkin: in_progress, completed, incomplete	Tidak.
jenis	enum	Jenis input pesan. Selalu setel ke message. Nilai yang mungkin: message	Tidak.

InputMessageContentList

Daftar satu atau banyak item input ke model, yang berisi jenis konten yang berbeda.

Tidak ada properti yang ditentukan untuk komponen ini.

InputMessageResource

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	InputMessageContentList	Daftar satu atau banyak item input ke model, berisi konten yang berbeda types.	Yes
id	string	ID input pesan yang unik.	Yes
peran	enum	Peran dalam memasukkan pesan. Salah satu dari user, system, atau developer. Nilai yang mungkin: user, system, developer	Yes
status	enum	Status dari item. Salah satu dari in_progress, completed, atau incomplete. Diisi saat item dikembalikan melalui API. Nilai yang mungkin: in_progress, completed, incomplete	Tidak.
jenis	enum	Jenis input pesan. Selalu setel ke message. Nilai yang mungkin: message	Tidak.

InputText

Input teks ke model.

Nama	Tipe	Deskripsi	Diperlukan	Default
kirim pesan teks	string	Input teks ke model.	Yes
jenis	enum	Jenis item input. Selalu input_text. Nilai yang mungkin: input_text	Yes

Barang

Item konten yang digunakan untuk menghasilkan respons.

Komponen ini bisa menjadi salah satu hal berikut:

• InputMessage
• OutputMessage
• FileSearchToolCall
• ComputerToolCall
• ComputerToolCallOutput
• FunctionToolCall
• FunctionToolCallOutput
• ReasoningItem

ItemReference

Pengidentifikasi internal untuk item yang akan dirujuk.

Nama	Tipe	Deskripsi	Diperlukan	Default
id	string	ID item yang akan dirujuk.	Yes
jenis	enum	Jenis item yang akan dirujuk. Selalu item_reference. Nilai yang mungkin: item_reference	Yes

ItemResource

Item konten yang digunakan untuk menghasilkan respons.

Komponen ini bisa menjadi salah satu hal berikut:

• InputMessageResource
• OutputMessage
• FileSearchToolCall
• ComputerToolCall
• ComputerToolCallOutputResource
• FunctionToolCall
• FunctionToolCallOutputResource

KeyPress

Koleksi tombol yang ingin ditekan oleh model.

Nama	Tipe	Deskripsi	Diperlukan	Default
Kunci	array	Kombinasi tombol yang harus ditekan sesuai permintaan model. Ini adalah sekumpulan string, yang masing-masing mewakili sebuah kunci.	Yes
jenis	enum	Menentukan jenis peristiwa. Untuk tindakan penekanan kunci, properti ini selalu diatur ke keypress. Nilai yang mungkin: keypress	Yes

Metainformasi

Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur, dan mengkueri objek melalui API atau dasbor.

Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.

Tidak ada properti yang ditentukan untuk komponen ini.

ModelResponseProperties

Nama	Tipe	Deskripsi	Diperlukan	Default
metadata	Metadata	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Tidak.
model	string	Model yang digunakan untuk menghasilkan respons.	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Kami umumnya merekomendasikan untuk memodifikasi ini atau top_p tetapi tidak keduanya.	Tidak.	1
top_p	nomor/angka	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk memodifikasi ini atau temperature tetapi tidak keduanya.	Tidak.	1
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu OpenAI memantau dan mendeteksi penyalahgunaan. .	Tidak.

Move

Aksi gerakan mouse.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Menentukan jenis peristiwa. Untuk tindakan pemindahan, properti ini selalu diatur ke move. Nilai yang mungkin: move	Yes
x	bilangan bulat	Koordinat x yang menjadi tujuan pergerakan.	Yes
y	bilangan bulat	Koordinat y yang akan dituju.	Yes

OutputAudio

Keluaran audio dari model.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	string	Data audio yang telah dikodekan Base64 dari model.	Yes
transkrip	string	Transkrip data audio dari model.	Yes
jenis	enum	Jenis suara keluaran. Selalu output_audio. Nilai yang mungkin: output_audio	Yes

OutputContent

Komponen ini bisa menjadi salah satu hal berikut:

• OutputText
• Refusal

OutputItem

Nama	Tipe	Deskripsi	Diperlukan	Default
tindakan	ComputerAction		Yes
argumen	string	String JSON berisi argumen untuk dilewatkan ke fungsi.	Yes
call_id	string	Identifikasi yang digunakan ketika merespon panggilan alat dengan output.	Yes
isi	array	Pemikiran mengenai isi teks	Yes
id	string	Pengidentifikasi unik dari konten alasan.	Yes
Nama	string	Nama fungsi yang akan dijalankan.	Yes
pending_safety_checks	array	Pemeriksaan keamanan tertunda untuk panggilan komputer.	Yes
queries	array	Kueri yang digunakan untuk mencari file.	Yes
results	array	Hasil panggilan alat pencarian file.	Tidak.
peran	enum	Peran pesan keluaran. Selalu assistant. Nilai yang mungkin: assistant	Yes
status	enum	Status barang tersebut. Salah satu dari in_progress, completed, atau incomplete. Diisi saat item dikembalikan melalui API. Nilai yang mungkin: in_progress, completed, incomplete	Yes
jenis	enum	Jenis objek. Selalu reasoning. Nilai yang mungkin: reasoning	Yes

OutputMessage

Pesan hasil dari model.

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	array	Isi pesan keluaran.	Yes
id	string	ID unik pesan output.	Yes
peran	enum	Peran pesan keluaran. Selalu assistant. Nilai yang mungkin: assistant	Yes
status	enum	Status dari input pesan. Salah satu dari in_progress, completed, atau incomplete. Diisi saat item input dikembalikan melalui API. Nilai yang mungkin: in_progress, completed, incomplete	Yes
jenis	enum	Jenis pesan output. Selalu message. Nilai yang mungkin: message	Yes

OutputText

Teks output dari model.

Nama	Tipe	Deskripsi	Diperlukan	Default
Anotasi	array	Anotasi keluaran teks.	Yes
kirim pesan teks	string	Output teks dari sebuah model.	Yes
jenis	enum	Jenis teks output. Selalu output_text. Nilai yang mungkin: output_text	Yes

RealtimeSessionCreateRequest

Konfigurasi objek sesi realtime.

Nama	Tipe	Deskripsi	Diperlukan	Default
input_audio_format	enum	Format dari audio input. Opsinya adalah pcm16, g711_ulaw, atau g711_alaw. Untuk pcm16, input audio harus PCM 16-bit dengan laju sampel 24kHz, saluran tunggal (mono), dan memiliki urutan byte little-endian. Nilai yang mungkin: pcm16, g711_ulaw, g711_alaw	Tidak.
input_audio_noise_reduction	objek	Konfigurasi untuk pengurangan kebisingan audio masukan. Ini dapat diatur ke null untuk menonaktifkan. Pengurangan kebisingan memfilter audio yang ditambahkan ke buffer audio input sebelum dikirim ke VAD dan model. Pemfilteran audio dapat meningkatkan VAD dan mengubah akurasi deteksi (mengurangi positif palsu) dan performa model dengan meningkatkan persepsi audio input.	Tidak.
└─ jenis	enum	Jenis pengurangan kebisingan. near_field adalah untuk mikrofon jarak dekat seperti headphone, far_field adalah untuk mikrofon jarak jauh seperti milik laptop atau mikrofon ruang konferensi. Nilai yang mungkin: near_field, far_field	Tidak.
input_audio_transcription	objek	Konfigurasi untuk transkripsi audio input, secara default dinonaktifkan, dan dapat diatur ke null untuk menjadi nonaktif saat diaktifkan sekali. Model tidak menangani transkripsi audio secara bawaan, karena model memproses audio secara langsung. Transkripsi berjalan secara asinkron melalui titik akhir Transkripsi dan harus diperlakukan sebagai panduan konten audio input daripada yang didengar model. Klien dapat secara opsional mengatur bahasa dan meminta transkripsi, ini menawarkan panduan tambahan untuk layanan transkripsi.	Tidak.
└─ bahasa	string	Bahasa audio input. Menyediakan bahasa input dalam format ISO-639-1 (misalnya en) meningkatkan akurasi dan latensi.	Tidak.
└─ model	string	Model yang digunakan untuk transkripsi, opsi saat ini adalah gpt-4o-transcribe, , gpt-4o-mini-transcribegpt-4o-mini-transcribe-2025-12-15, dan whisper-1.	Tidak.
└─ perintah	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Untuk whisper-1, prompt tersebut merupakan daftar kata kunci. Untuk model-model gpt-4o-transcribe, perintahnya adalah string teks bebas, misalnya "kata-kata yang berkaitan dengan teknologi".	Tidak.
instructions	string	Instruksi sistem default (yaitu pesan sistem) yang ditambahkan di awal panggilan model. Bidang ini memungkinkan klien untuk memandu model pada respons yang diinginkan. Model ini dapat diinstruksikan tentang konten dan format respons, (misalnya "sangat singkat", "bersikap ramah", "berikut adalah contoh tanggapan yang baik") dan pada perilaku audio (misalnya "bicara cepat", "menyuntikkan emosi ke dalam suara Anda", "sering tertawa"). Instruksi tidak dijamin diikuti oleh model, tetapi mereka memberikan panduan untuk model tentang perilaku yang diinginkan. Perhatikan bahwa server menetapkan instruksi bawaan yang akan digunakan jika bidang ini tidak ditetapkan dan terlihat dalam session.created kejadian di awal sesi.	Tidak.
max_response_output_tokens	bilangan bulat atau string	Jumlah maksimum token output untuk satu respons asisten, termasuk panggilan alat. Berikan bilangan bulat antara 1 dan 4096 untuk membatasi token output, atau inf untuk token maksimum yang tersedia untuk model tertentu. Secara default menjadi inf.	Tidak.
Modalitas		Sekumpulan modalitas yang dapat dijawab oleh model. Untuk menonaktifkan audio, atur ini ke ["text"].	Tidak.
model	string	Nama penyebaran yang digunakan untuk sesi ini.	Tidak.
output_audio_format	enum	Format audio output. Opsinya adalah pcm16, g711_ulaw, atau g711_alaw. Untuk pcm16, audio output diambil sampelnya dengan kecepatan 24kHz. Nilai yang mungkin: pcm16, g711_ulaw, g711_alaw	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel untuk model, terbatas pada [0.6, 1.2]. Untuk model audio, suhu 0,8 sangat disarankan untuk performa terbaik.	Tidak.	0.8
tool_choice	string	Bagaimana model memilih alat. Opsinya adalah auto, none, required, atau menentukan fungsi.	Tidak.	auto
perangkat	array	Alat (fungsi) tersedia untuk model.	Tidak.
turn_detection	objek	Konfigurasi untuk deteksi giliran, entah Server VAD atau Semantic VAD. Ini dapat diatur ke null untuk menonaktifkan, dalam hal ini klien harus memicu respons model secara manual. VAD Server berarti bahwa model akan mendeteksi awal dan akhir ucapan berdasarkan volume audio dan merespons di akhir ucapan pengguna. Semantic VAD lebih canggih dan menggunakan model deteksi giliran (bersama dengan VAD) untuk secara semantik memperkirakan apakah pengguna telah selesai berbicara, kemudian secara dinamis mengatur batas waktu berdasarkan probabilitas ini. Misalnya, jika audio pengguna perlahan-lahan menghilang dengan uhhm, model akan menilai kemungkinan rendah untuk akhir giliran dan menunggu lebih lama hingga pengguna melanjutkan berbicara. Ini dapat berguna untuk percakapan yang lebih alami, tetapi mungkin memiliki latensi yang lebih tinggi.	Tidak.
└─ buat_respons	Boolean	Apakah akan secara otomatis menghasilkan respons saat peristiwa penghentian VAD terjadi.	Tidak.	Benar
└─ bersemangat	enum	Digunakan hanya untuk semantic_vad mode. Keinginan model untuk merespons. low akan menunggu lebih lama bagi pengguna untuk terus berbicara, high akan merespons lebih cepat. auto adalah default dan setara dengan medium. Nilai yang mungkin: low, medium, high, auto	Tidak.
└─ interrupt_response	Boolean	Secara otomatis menghentikan respons yang sedang berlangsung dengan output ke percakapan default (misalnya conversation dari auto) ketika terjadi peristiwa mulai VAD.	Tidak.	Benar
└─ prefix_padding_ms (isian_awalan_dalam_milidetik)	bilangan bulat	Digunakan hanya untuk server_vad mode. Jumlah audio yang akan disertakan sebelum ucapan yang terdeteksi oleh VAD (dalam milidetik). Pengaturan awal adalah 300ms.	Tidak.
└─ durasi_keheningan_dalam_milidetik (silence_duration_ms)	bilangan bulat	Digunakan hanya untuk server_vad mode. Durasi keheningan untuk mendeteksi pemberhentian ucapan (dalam milidetik). Default ke 500ms. Dengan nilai yang lebih pendek, model akan merespons lebih cepat, tetapi mungkin melompat pada jeda singkat dari pengguna.	Tidak.
└─ ambang batas	nomor/angka	Digunakan hanya untuk server_vad mode. Ambang aktivasi untuk VAD (0,0 hingga 1,0), ini default ke 0,5. Ambang yang lebih tinggi akan memerlukan audio yang lebih keras untuk mengaktifkan model, dan dengan demikian mungkin berkinerja lebih baik di lingkungan yang berisik.	Tidak.
└─ jenis	enum	Jenis deteksi belokan. Nilai yang mungkin: server_vad, semantic_vad	Tidak.
voice	VoiceIdsShared		Tidak.

RealtimeSessionCreateResponse

Konfigurasi sesi Realtime baru, dengan kunci sementara. TTL default untuk kunci adalah satu menit.

Nama	Tipe	Deskripsi	Diperlukan	Default
client_secret (kunci rahasia klien)	objek	Kunci sementara yang dikembalikan oleh API.	Yes
└─ berakhir_pada	bilangan bulat	Tanda waktu untuk saat token kedaluwarsa. Saat ini, semua token kedaluwarsa setelah satu menit.	Tidak.
└─ nilai	string	Kunci sementara dapat digunakan di lingkungan klien untuk mengautentikasi koneksi ke API Realtime. Gunakan ini di lingkungan sisi klien daripada token API standar, yang seharusnya hanya digunakan di sisi server.	Tidak.
input_audio_format	string	Format dari audio input. Opsinya adalah pcm16, g711_ulaw, atau g711_alaw.	Tidak.
input_audio_transcription	objek	Konfigurasi untuk transkripsi audio input, secara default dinonaktifkan, dan dapat diatur ke null untuk menjadi nonaktif saat diaktifkan sekali. Model tidak menangani transkripsi audio secara bawaan, karena model memproses audio secara langsung. Transkripsi berjalan secara asinkron melalui Whisper dan harus diperlakukan sebagai panduan kasar daripada representasi yang dipahami oleh model.	Tidak.
└─ model	string	Model yang digunakan untuk transkripsi, whisper-1 adalah satu-satunya model yang saat ini didukung.	Tidak.
instructions	string	Instruksi sistem default (yaitu pesan sistem) yang ditambahkan di awal panggilan model. Bidang ini memungkinkan klien untuk memandu model pada respons yang diinginkan. Model ini dapat diinstruksikan tentang konten dan format respons (misalnya "sangat singkat", "bersikap ramah", "berikut adalah contoh respons yang baik") dan perilaku audio (misalnya "bicara dengan cepat", "masukkan emosi ke dalam suara Anda", "sering tertawa"). Instruksi tidak dijamin diikuti oleh model, tetapi mereka memberikan panduan untuk model tentang perilaku yang diinginkan. Perhatikan bahwa server menetapkan instruksi bawaan yang akan digunakan jika bidang ini tidak ditetapkan dan terlihat dalam session.created kejadian di awal sesi.	Tidak.
max_response_output_tokens	bilangan bulat atau string	Jumlah maksimum token output untuk satu respons asisten, termasuk panggilan alat. Berikan bilangan bulat antara 1 dan 4096 untuk membatasi token output, atau inf untuk token maksimum yang tersedia untuk model tertentu. Secara default menjadi inf.	Tidak.
Modalitas		Sekumpulan modalitas yang dapat dijawab oleh model. Untuk menonaktifkan audio, atur ini ke ["text"].	Tidak.
output_audio_format	string	Format audio output. Opsinya adalah pcm16, g711_ulaw, atau g711_alaw.	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel untuk model, terbatas pada [0.6, 1.2]. Default ke 0,8.	Tidak.
tool_choice	string	Bagaimana model memilih alat. Opsinya adalah auto, none, required, atau menentukan fungsi.	Tidak.
perangkat	array	Alat (fungsi) tersedia untuk model.	Tidak.
turn_detection	objek	Pengaturan untuk deteksi belokan. Dapat diatur ke null untuk mematikan. VAD Server berarti bahwa model akan mendeteksi awal dan akhir ucapan berdasarkan volume audio dan merespons di akhir ucapan pengguna.	Tidak.
└─ prefix_padding_ms (isian_awalan_dalam_milidetik)	bilangan bulat	Jumlah audio yang akan disertakan sebelum ucapan yang terdeteksi oleh VAD (dalam milidetik). Pengaturan awal adalah 300ms.	Tidak.
└─ durasi_keheningan_dalam_milidetik (silence_duration_ms)	bilangan bulat	Durasi keheningan untuk mendeteksi pemberhentian ucapan (dalam milidetik). Default ke 500ms. Dengan nilai yang lebih pendek, model akan merespons lebih cepat, tetapi mungkin melompat pada jeda singkat dari pengguna.	Tidak.
└─ ambang batas	nomor/angka	Ambang aktivasi untuk VAD (0,0 hingga 1,0), ini default ke 0,5. Ambang yang lebih tinggi akan memerlukan audio yang lebih keras untuk mengaktifkan model, dan dengan demikian mungkin berkinerja lebih baik di lingkungan yang berisik.	Tidak.
└─ jenis	string	Jenis deteksi belokan, hanya server_vad didukung saat ini.	Tidak.
voice	VoiceIdsShared		Tidak.

RealtimeTranscriptionSessionCreateRequest

Konfigurasi objek sesi transkripsi waktu nyata.

Nama	Tipe	Deskripsi	Diperlukan	Default
termasuk	array	Kumpulan item yang akan disertakan dalam transkripsi. Item yang tersedia saat ini adalah: - item.input_audio_transcription.logprobs	Tidak.
input_audio_format	enum	Format dari audio input. Opsinya adalah pcm16, g711_ulaw, atau g711_alaw. Untuk pcm16, input audio harus PCM 16-bit dengan laju sampel 24kHz, saluran tunggal (mono), dan memiliki urutan byte little-endian. Nilai yang mungkin: pcm16, g711_ulaw, g711_alaw	Tidak.
input_audio_noise_reduction	objek	Konfigurasi untuk pengurangan kebisingan audio masukan. Ini dapat diatur ke null untuk menonaktifkan. Pengurangan kebisingan memfilter audio yang ditambahkan ke buffer audio input sebelum dikirim ke VAD dan model. Pemfilteran audio dapat meningkatkan VAD dan mengubah akurasi deteksi (mengurangi positif palsu) dan performa model dengan meningkatkan persepsi audio input.	Tidak.
└─ jenis	enum	Jenis pengurangan kebisingan. near_field adalah untuk mikrofon jarak dekat seperti headphone, far_field adalah untuk mikrofon jarak jauh seperti milik laptop atau mikrofon ruang konferensi. Nilai yang mungkin: near_field, far_field	Tidak.
input_audio_transcription	objek	Konfigurasi untuk transkripsi audio input. Klien dapat secara opsional mengatur bahasa dan meminta transkripsi, ini menawarkan panduan tambahan untuk layanan transkripsi.	Tidak.
└─ bahasa	string	Bahasa audio input. Menyediakan bahasa input dalam format ISO-639-1 (misalnya en) meningkatkan akurasi dan latensi.	Tidak.
└─ model	enum	Model yang digunakan untuk transkripsi, opsi saat ini adalah gpt-4o-transcribe, , gpt-4o-transcribe-diarizegpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, dan whisper-1. Nilai yang mungkin: gpt-4o-transcribe, , gpt-4o-transcribe-diarizegpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15,whisper-1	Tidak.
└─ perintah	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Untuk whisper-1, prompt tersebut merupakan daftar kata kunci. Untuk model-model gpt-4o-transcribe, perintahnya adalah string teks bebas, misalnya "kata-kata yang berkaitan dengan teknologi".	Tidak.
Modalitas		Sekumpulan modalitas yang dapat dijawab oleh model. Untuk menonaktifkan audio, atur ini ke ["text"].	Tidak.
turn_detection	objek	Konfigurasi untuk deteksi giliran, entah Server VAD atau Semantic VAD. Ini dapat diatur ke null untuk menonaktifkan, dalam hal ini klien harus memicu respons model secara manual. VAD Server berarti bahwa model akan mendeteksi awal dan akhir ucapan berdasarkan volume audio dan merespons di akhir ucapan pengguna. Semantic VAD lebih canggih dan menggunakan model deteksi giliran (bersama dengan VAD) untuk secara semantik memperkirakan apakah pengguna telah selesai berbicara, kemudian secara dinamis mengatur batas waktu berdasarkan probabilitas ini. Misalnya, jika audio pengguna perlahan-lahan menghilang dengan uhhm, model akan menilai kemungkinan rendah untuk akhir giliran dan menunggu lebih lama hingga pengguna melanjutkan berbicara. Ini dapat berguna untuk percakapan yang lebih alami, tetapi mungkin memiliki latensi yang lebih tinggi.	Tidak.
└─ buat_respons	Boolean	Apakah akan secara otomatis menghasilkan respons saat peristiwa penghentian VAD terjadi. Tidak tersedia untuk sesi transkripsi.	Tidak.	Benar
└─ bersemangat	enum	Digunakan hanya untuk semantic_vad mode. Keinginan model untuk merespons. low akan menunggu lebih lama bagi pengguna untuk terus berbicara, high akan merespons lebih cepat. auto adalah default dan setara dengan medium. Nilai yang mungkin: low, medium, high, auto	Tidak.
└─ interrupt_response	Boolean	Secara otomatis menghentikan respons yang sedang berlangsung dengan output ke percakapan default (misalnya conversation dari auto) ketika terjadi peristiwa mulai VAD. Tidak tersedia untuk sesi transkripsi.	Tidak.	Benar
└─ prefix_padding_ms (isian_awalan_dalam_milidetik)	bilangan bulat	Digunakan hanya untuk server_vad mode. Jumlah audio yang akan disertakan sebelum ucapan yang terdeteksi oleh VAD (dalam milidetik). Pengaturan awal adalah 300ms.	Tidak.
└─ durasi_keheningan_dalam_milidetik (silence_duration_ms)	bilangan bulat	Digunakan hanya untuk server_vad mode. Durasi keheningan untuk mendeteksi pemberhentian ucapan (dalam milidetik). Default ke 500ms. Dengan nilai yang lebih pendek, model akan merespons lebih cepat, tetapi mungkin melompat pada jeda singkat dari pengguna.	Tidak.
└─ ambang batas	nomor/angka	Digunakan hanya untuk server_vad mode. Ambang aktivasi untuk VAD (0,0 hingga 1,0), ini default ke 0,5. Ambang yang lebih tinggi akan memerlukan audio yang lebih keras untuk mengaktifkan model, dan dengan demikian mungkin berkinerja lebih baik di lingkungan yang berisik.	Tidak.
└─ jenis	enum	Jenis deteksi belokan. Nilai yang mungkin: server_vad, semantic_vad	Tidak.

RealtimeTranscriptionSessionCreateResponse

Konfigurasi sesi transkripsi waktu nyata baru.

Saat sesi dibuat di server melalui REST API, objek sesi juga berisi kunci ephemeral. TTL default untuk kunci adalah satu menit. Properti ini tidak ada saat sesi diperbarui melalui API WebSocket.

Nama	Tipe	Deskripsi	Diperlukan	Default
client_secret (kunci rahasia klien)	objek	Kunci sementara yang dikembalikan oleh API. Hanya ada saat sesi dibuat di server melalui REST API.	Yes
└─ berakhir_pada	bilangan bulat	Tanda waktu untuk saat token kedaluwarsa. Saat ini, semua token kedaluwarsa setelah satu menit.	Tidak.
└─ nilai	string	Kunci sementara dapat digunakan di lingkungan klien untuk mengautentikasi koneksi ke API Realtime. Gunakan ini di lingkungan sisi klien daripada token API standar, yang seharusnya hanya digunakan di sisi server.	Tidak.
input_audio_format	string	Format dari audio input. Opsinya adalah pcm16, g711_ulaw, atau g711_alaw.	Tidak.
input_audio_transcription	objek	Konfigurasi model transkripsi.	Tidak.
└─ bahasa	string	Bahasa audio input. Menyediakan bahasa input dalam format ISO-639-1 (misalnya en) meningkatkan akurasi dan latensi.	Tidak.
└─ model	enum	Model yang digunakan untuk transkripsi. Dapat berupa gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, atau whisper-1. Nilai yang mungkin: gpt-4o-transcribe, gpt-4o-mini-transcribe, gpt-4o-mini-transcribe-2025-12-15, whisper-1	Tidak.
└─ perintah	string	Teks opsional untuk memandu gaya model atau melanjutkan segmen audio sebelumnya. Perintah harus cocok dengan bahasa audio.	Tidak.
Modalitas		Sekumpulan modalitas yang dapat dijawab oleh model. Untuk menonaktifkan audio, atur ini ke ["text"].	Tidak.
turn_detection	objek	Pengaturan untuk deteksi belokan. Dapat diatur ke null untuk mematikan. VAD Server berarti bahwa model akan mendeteksi awal dan akhir ucapan berdasarkan volume audio dan merespons di akhir ucapan pengguna.	Tidak.
└─ prefix_padding_ms (isian_awalan_dalam_milidetik)	bilangan bulat	Jumlah audio yang akan disertakan sebelum ucapan yang terdeteksi oleh VAD (dalam milidetik). Pengaturan awal adalah 300ms.	Tidak.
└─ durasi_keheningan_dalam_milidetik (silence_duration_ms)	bilangan bulat	Durasi keheningan untuk mendeteksi pemberhentian ucapan (dalam milidetik). Default ke 500ms. Dengan nilai yang lebih pendek, model akan merespons lebih cepat, tetapi mungkin melompat pada jeda singkat dari pengguna.	Tidak.
└─ ambang batas	nomor/angka	Ambang aktivasi untuk VAD (0,0 hingga 1,0), ini default ke 0,5. Ambang yang lebih tinggi akan memerlukan audio yang lebih keras untuk mengaktifkan model, dan dengan demikian mungkin berkinerja lebih baik di lingkungan yang berisik.	Tidak.
└─ jenis	string	Jenis deteksi belokan, hanya server_vad didukung saat ini.	Tidak.

Pertimbangan

Opsi konfigurasi untuk model penalaran.

Nama	Tipe	Deskripsi	Diperlukan	Default
effort	ReasoningEffort	Membatasi upaya penalaran untuk model penalaran. Nilai yang saat ini didukung adalah low, medium, dan high. Mengurangi upaya penalaran dapat mengakibatkan respons yang lebih cepat dan lebih sedikit token yang digunakan pada penalaran dalam respons.	Yes	Sedang
summary	enum	Ringkasan penalaran yang dilakukan oleh model. Ini dapat berguna untuk men-debug dan memahami proses penalaran model. Salah satu concise atau detailed. Nilai yang mungkin: concise, detailed	Tidak.

ReasoningItem

Deskripsi rantai pemikiran yang digunakan oleh model penalaran saat menghasilkan respons.

Nama	Tipe	Deskripsi	Diperlukan	Default
isi	array	Pemikiran mengenai isi teks	Yes
id	string	Pengidentifikasi unik dari konten alasan.	Yes
status	enum	Status barang tersebut. Salah satu dari in_progress, completed, atau incomplete. Diisi saat item dikembalikan melalui API. Nilai yang mungkin: in_progress, completed, incomplete	Tidak.
jenis	enum	Jenis objek. Selalu reasoning. Nilai yang mungkin: reasoning	Yes

Refusal

Penolakan dari model.

Nama	Tipe	Deskripsi	Diperlukan	Default
refusal	string	Penjelasan mengenai penolakan dari model.	Yes
jenis	enum	Jenis penolakan. Selalu refusal. Nilai yang mungkin: refusal	Yes

response

Nama	Tipe	Deskripsi	Diperlukan	Default
dibuat_pada	nomor/angka	Tanda waktu Unix (dalam detik) saat Respons ini dibuat.	Yes
galat	ResponseError	Objek kesalahan dikembalikan saat model gagal menghasilkan Respons.	Yes
id	string	Pengidentifikasi unik untuk Respons ini.	Yes
incomplete_details	objek	Detail tentang mengapa respons tidak lengkap.	Yes
└─ alasan	enum	Alasan mengapa respons tidak lengkap. Nilai yang mungkin: max_output_tokens, content_filter	Tidak.
instructions	string	Menyisipkan pesan sistem (atau pengembang) sebagai item pertama dalam konteks model. Saat menggunakan bersama dengan previous_response_id, instruksi dari respons sebelumnya tidak akan dibawa ke respons berikutnya. Ini memudahkan untuk menukar pesan sistem (atau pengembang) dalam respons baru.	Yes
max_output_tokens	bilangan bulat	Batas atas untuk jumlah token yang dapat dihasilkan untuk respons, termasuk token output dan status percakapan yang terlihat.	Tidak.
metadata	Metadata	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter.	Yes
model	string	Model yang digunakan untuk menghasilkan respons.	Yes
objek	enum	Jenis objek sumber daya ini - selalu diatur ke response. Nilai yang mungkin: response	Yes
output	array	Sebuah array item konten yang dihasilkan oleh model. - Panjang dan urutan item dalam output array tergantung pada respons model. - Alih-alih mengakses item pertama dalam output array dan mengasumsikan bahwa itu adalah pesan dengan konten yang dihasilkan oleh model assistant, Anda mungkin mempertimbangkan untuk menggunakan properti output_text jika didukung dalam SDK.	Yes
output_text	string	Properti kemudahan khusus SDK yang berisi output teks agregat dari semua item output_text pada array output, jika ada. Didukung di SDK Python dan JavaScript.	Tidak.
pemanggilan_alat_paralel	Boolean	Apakah akan mengizinkan model menjalankan panggilan alat secara paralel.	Yes	Benar
previous_response_id	string	ID unik dari respons sebelumnya ke model. Gunakan ini untuk membuat percakapan multi-giliran.	Tidak.
reasoning	Reasoning	Opsi konfigurasi untuk model penalaran.	Tidak.
status	enum	Status generasi respons. Salah satu dari completed, failed, in_progress, atau incomplete. Nilai yang mungkin: completed, failed, in_progress, incomplete	Tidak.
suhu	nomor/angka	Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik. Kami umumnya merekomendasikan untuk memodifikasi ini atau top_p tetapi tidak keduanya.	Yes	1
kirim pesan teks	objek	Opsi konfigurasi untuk respons teks dari model. Dapat berupa teks biasa atau data JSON terstruktur. Pelajari lebih lanjut: - masukan dan keluaran teks - Output Terstruktur	Tidak.
└─ bentuk	TextResponseFormatConfiguration	Objek yang menentukan format yang harus dihasilkan model. Mengonfigurasi { "type": "json_schema" } memungkinkan Output Terstruktur, yang memastikan model cocok dengan skema JSON yang Anda berikan. Format defaultnya adalah { "type": "text" } tanpa opsi tambahan. Tidak disarankan untuk model gpt-4o dan yang lebih baru: Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON yang lebih lama, yang memastikan pesan yang dihasilkan model adalah JSON yang valid. Penggunaan json_schema lebih disukai untuk model yang mendukungnya.	Tidak.
tool_choice	ToolChoiceOptions atau ToolChoiceTypes atau ToolChoiceFunction	Bagaimana model harus memilih alat (atau alat) mana yang akan digunakan saat menghasilkan respons. tools Lihat parameter untuk melihat cara menentukan alat mana yang dapat dipanggil model.	Yes
perangkat	array	Sekumpulan alat yang dapat dipanggil model ketika menghasilkan respons. Anda dapat menentukan alat mana yang akan digunakan dengan mengatur tool_choice parameter . Dua kategori alat yang dapat Anda sediakan untuk model adalah: - Alat bawaan	Yes
top_p	nomor/angka	Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10% massa peluang teratas yang dipertimbangkan. Kami umumnya merekomendasikan untuk memodifikasi ini atau temperature tetapi tidak keduanya.	Yes	1
truncation	enum	Strategi pemotongan yang akan digunakan untuk respons model. - auto: Jika konteks respons ini dan yang sebelumnya melebihi ukuran jendela konteks model, model akan memotong respons agar sesuai dengan jendela konteks dengan menjatuhkan item input di tengah percakapan. - disabled (default): Jika respons model akan melebihi ukuran jendela konteks untuk model, permintaan akan gagal dengan kesalahan 400. Nilai yang mungkin: auto, disabled	Tidak.
usage	ResponseUsage	Mewakili detail penggunaan token termasuk token input, token output, perincian token output, dan total token yang digunakan.	Tidak.
pengguna	string	Pengidentifikasi unik yang mewakili pengguna akhir Anda, yang dapat membantu OpenAI memantau dan mendeteksi penyalahgunaan. .	Tidak.

ResponseAudioDeltaEvent

Dipancarkan ketika ada respons audio parsial.

Nama	Tipe	Deskripsi	Diperlukan	Default
delta	string	Potongan audio byte balasan yang telah dikodekan Base64.	Yes
jenis	enum	Jenis peristiwa. Selalu response.audio.delta. Nilai yang mungkin: response.audio.delta	Yes

ResponseAudioDoneEvent

Dipancarkan saat respons audio selesai.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Jenis peristiwa. Selalu response.audio.done. Nilai yang mungkin: response.audio.done	Yes

ResponseAudioTranscriptDeltaEvent

Dipancarkan ketika ada transkrip audio parsial.

Nama	Tipe	Deskripsi	Diperlukan	Default
delta	string	Transkrip parsial respons audio.	Yes
jenis	enum	Jenis peristiwa. Selalu response.audio.transcript.delta. Nilai yang mungkin: response.audio.transcript.delta	Yes

ResponseAudioTranscriptDoneEvent

Dipancarkan ketika transkrip audio lengkap selesai.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Jenis peristiwa. Selalu response.audio.transcript.done. Nilai yang mungkin: response.audio.transcript.done	Yes

ResponseCodeInterpreterCallCodeDeltaEvent

Dipancarkan ketika cuplikan kode parsial ditambahkan oleh penerjemah kode.

Nama	Tipe	Deskripsi	Diperlukan	Default
delta	string	Cuplikan kode parsial ditambahkan oleh penerjemah kode.	Yes
output_index	bilangan bulat	Indeks item output yang dipanggil penerjemah kode sedang berlangsung.	Yes
jenis	enum	Jenis peristiwa. Selalu response.code_interpreter_call.code.delta. Nilai yang mungkin: response.code_interpreter_call.code.delta	Yes

ResponseCodeInterpreterCallCodeDoneEvent

Dipancarkan ketika output cuplikan kode diselesaikan oleh penerjemah kode.

Nama	Tipe	Deskripsi	Diperlukan	Default
kode	string	Output cuplikan kode akhir oleh penerjemah kode.	Yes
output_index	bilangan bulat	Indeks item output yang dipanggil penerjemah kode sedang berlangsung.	Yes
jenis	enum	Jenis peristiwa. Selalu response.code_interpreter_call.code.done. Nilai yang mungkin: response.code_interpreter_call.code.done	Yes

ResponseCodeInterpreterCallCompletedEvent

Dipancarkan ketika panggilan penerjemah kode selesai.

Nama	Tipe	Deskripsi	Diperlukan	Default
code_interpreter_call	CodeInterpreterToolCall	Panggilan alat untuk menjalankan kode.	Yes
output_index	bilangan bulat	Indeks item output yang dipanggil penerjemah kode sedang berlangsung.	Yes
jenis	enum	Jenis peristiwa. Selalu response.code_interpreter_call.completed. Nilai yang mungkin: response.code_interpreter_call.completed	Yes

ResponseCodeInterpreterCallInProgressEvent

Dipancarkan saat panggilan penerjemah kode sedang berlangsung.

Nama	Tipe	Deskripsi	Diperlukan	Default
code_interpreter_call	CodeInterpreterToolCall	Panggilan alat untuk menjalankan kode.	Yes
output_index	bilangan bulat	Indeks item output yang dipanggil penerjemah kode sedang berlangsung.	Yes
jenis	enum	Jenis peristiwa. Selalu response.code_interpreter_call.in_progress. Nilai yang mungkin: response.code_interpreter_call.in_progress	Yes

ResponseCodeInterpreterCallInterpretingEvent

Dipancarkan ketika penerjemah kode secara aktif menafsirkan cuplikan kode.

Nama	Tipe	Deskripsi	Diperlukan	Default
code_interpreter_call	CodeInterpreterToolCall	Panggilan alat untuk menjalankan kode.	Yes
output_index	bilangan bulat	Indeks item output yang dipanggil penerjemah kode sedang berlangsung.	Yes
jenis	enum	Jenis peristiwa. Selalu response.code_interpreter_call.interpreting. Nilai yang mungkin: response.code_interpreter_call.interpreting	Yes

ResponseCompletedEvent

Dipancarkan saat respons model selesai.

Nama	Tipe	Deskripsi	Diperlukan	Default
response	response		Yes
jenis	enum	Jenis peristiwa. Selalu response.completed. Nilai yang mungkin: response.completed	Yes

ResponseContentPartAddedEvent

Dipancarkan saat bagian konten baru ditambahkan.

Nama	Tipe	Deskripsi	Diperlukan	Default
content_index	bilangan bulat	Indeks bagian konten yang ditambahkan.	Yes
item_id	string	ID item output tempat bagian konten ditambahkan.	Yes
output_index	bilangan bulat	Indeks item keluaran di mana bagian konten ditambahkan.	Yes
bagian	OutputContent		Yes
jenis	enum	Jenis peristiwa. Selalu response.content_part.added. Nilai yang mungkin: response.content_part.added	Yes

ResponseContentPartDoneEvent

Dipancarkan saat bagian konten selesai.

Nama	Tipe	Deskripsi	Diperlukan	Default
content_index	bilangan bulat	Indeks dari bagian konten yang sudah selesai.	Yes
item_id	string	ID item output tempat bagian konten ditambahkan.	Yes
output_index	bilangan bulat	Indeks item keluaran di mana bagian konten ditambahkan.	Yes
bagian	OutputContent		Yes
jenis	enum	Jenis peristiwa. Selalu response.content_part.done. Nilai yang mungkin: response.content_part.done	Yes

ResponseCreatedEvent

Peristiwa yang dipancarkan saat respons dibuat.

Nama	Tipe	Deskripsi	Diperlukan	Default
response	response		Yes
jenis	enum	Jenis peristiwa. Selalu response.created. Nilai yang mungkin: response.created	Yes

ResponseError

Objek kesalahan dikembalikan saat model gagal menghasilkan Respons.

Nama	Tipe	Deskripsi	Diperlukan	Default
kode	ResponseErrorCode	Kode kesalahan untuk respons.	Yes
pesan	string	Deskripsi kesalahan yang dapat dibaca manusia.	Yes

ResponseErrorCode

Kode kesalahan untuk respons.

Harta benda	Nilai
Deskripsi	Kode kesalahan untuk respons.
Jenis	string
Nilai	server_error rate_limit_exceeded invalid_prompt vector_store_timeout invalid_image invalid_image_format invalid_base64_image invalid_image_url image_too_large image_too_small image_parse_error image_content_policy_violation invalid_image_mode image_file_too_large unsupported_image_media_type empty_image_file failed_to_download_image image_file_not_found

ResponseErrorEvent

Dipancarkan ketika terjadi kesalahan.

Nama	Tipe	Deskripsi	Diperlukan	Default
kode	string	Kode kesalahan.	Yes
pesan	string	Pesan kesalahan.	Yes
param	string	Parameter kesalahan.	Yes
jenis	enum	Jenis peristiwa. Selalu error. Nilai yang mungkin: error	Yes

ResponseFailedEvent

Sebuah event yang dikeluarkan ketika respons gagal.

Nama	Tipe	Deskripsi	Diperlukan	Default
response	response		Yes
jenis	enum	Jenis peristiwa. Selalu response.failed. Nilai yang mungkin: response.failed	Yes

ResponseFileSearchCallCompletedEvent

Dipancarkan ketika panggilan pencarian file selesai (hasil ditemukan).

Nama	Tipe	Deskripsi	Diperlukan	Default
item_id	string	ID item keluaran yang dipicu oleh panggilan pencarian file.	Yes
output_index	bilangan bulat	Indeks item output yang dimulai oleh panggilan pencarian file.	Yes
jenis	enum	Jenis peristiwa. Selalu response.file_search_call.completed. Nilai yang mungkin: response.file_search_call.completed	Yes

ResponseFileSearchCallInProgressEvent

Dipancarkan ketika panggilan pencarian file dimulai.

Nama	Tipe	Deskripsi	Diperlukan	Default
item_id	string	ID item keluaran yang dipicu oleh panggilan pencarian file.	Yes
output_index	bilangan bulat	Indeks item output yang dimulai oleh panggilan pencarian file.	Yes
jenis	enum	Jenis peristiwa. Selalu response.file_search_call.in_progress. Nilai yang mungkin: response.file_search_call.in_progress	Yes

ResponseFileSearchCallSearchingEvent

Dipancarkan ketika pencarian file sedang berlangsung.

Nama	Tipe	Deskripsi	Diperlukan	Default
item_id	string	ID item keluaran yang dipicu oleh panggilan pencarian file.	Yes
output_index	bilangan bulat	Indeks item output yang dicari oleh panggilan pencarian file.	Yes
jenis	enum	Jenis peristiwa. Selalu response.file_search_call.searching. Nilai yang mungkin: response.file_search_call.searching	Yes

ResponseFunctionCallArgumentsDeltaEvent

Dipancarkan ketika ada delta argumen pemanggilan fungsi parsial.

Nama	Tipe	Deskripsi	Diperlukan	Default
delta	string	Delta argumen pemanggilan fungsi yang ditambahkan.	Yes
item_id	string	ID item keluaran yang ditambahkan dengan delta dari argumen panggilan fungsi.	Yes
output_index	bilangan bulat	Indeks keluaran item yang ditambahkan dengan delta dari argumen panggilan fungsi.	Yes
jenis	enum	Jenis peristiwa. Selalu response.function_call_arguments.delta. Nilai yang mungkin: response.function_call_arguments.delta	Yes

ResponseFunctionCallArgumentsDoneEvent

Dipancarkan ketika argumen pemanggilan fungsi diselesaikan.

Nama	Tipe	Deskripsi	Diperlukan	Default
argumen	string	Argumen pemanggilan fungsi.	Yes
item_id	string	ID dari item.	Yes
output_index	bilangan bulat	Indeks dari item keluaran.	Yes
jenis	enum	Nilai yang mungkin: response.function_call_arguments.done	Yes

ResponseInProgressEvent

Dipancarkan ketika respons sedang berlangsung.

Nama	Tipe	Deskripsi	Diperlukan	Default
response	response		Yes
jenis	enum	Jenis peristiwa. Selalu response.in_progress. Nilai yang mungkin: response.in_progress	Yes

ResponseIncompleteEvent

Peristiwa yang dipancarkan ketika respons selesai sebagai tidak lengkap.

Nama	Tipe	Deskripsi	Diperlukan	Default
response	response		Yes
jenis	enum	Jenis peristiwa. Selalu response.incomplete. Nilai yang mungkin: response.incomplete	Yes

responseItemList

Daftar item Respons.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array	Daftar item yang digunakan untuk menghasilkan respons ini.	Yes
first_id	string	ID elemen pertama dalam daftar.	Yes
ada_lagi	Boolean	Apakah ada lebih banyak item yang tersedia.	Yes
ID terakhir	string	ID item terakhir dalam daftar.	Yes
objek	enum	Jenis objek yang dikembalikan, harus list. Nilai yang mungkin: list	Yes

ResponseModalities

Jenis output yang Anda inginkan untuk dihasilkan model. Sebagian besar model mampu menghasilkan teks, yang merupakan default:

["text"]

Model ini gpt-4o-audio-preview juga dapat digunakan untuk menghasilkan audio. Untuk meminta agar model ini menghasilkan respons teks dan audio, Anda dapat menggunakan:

["text", "audio"]

Tidak ada properti yang ditentukan untuk komponen ini.

ResponseModalitiesTextOnly

Jenis output yang Anda inginkan untuk dihasilkan model. Sebagian besar model mampu menghasilkan teks, yang merupakan default:

["text"]

API ini akan segera mendukung modalitas output lainnya, termasuk audio dan gambar.

Tidak ada properti yang ditentukan untuk komponen ini.

ResponseOutputItemAddedEvent

Dipancarkan saat item output baru ditambahkan.

Nama	Tipe	Deskripsi	Diperlukan	Default
item	OutputItem		Yes
output_index	bilangan bulat	Indeks item output yang ditambahkan.	Yes
jenis	enum	Jenis peristiwa. Selalu response.output_item.added. Nilai yang mungkin: response.output_item.added	Yes

ResponseOutputItemDoneEvent

Dipancarkan saat item output ditandai selesai.

Nama	Tipe	Deskripsi	Diperlukan	Default
item	OutputItem		Yes
output_index	bilangan bulat	Indeks item keluaran yang telah ditandai selesai.	Yes
jenis	enum	Jenis peristiwa. Selalu response.output_item.done. Nilai yang mungkin: response.output_item.done	Yes

ResponseProperties

Nama	Tipe	Deskripsi	Diperlukan	Default
instructions	string	Menyisipkan pesan sistem (atau pengembang) sebagai item pertama dalam konteks model. Saat menggunakan bersama dengan previous_response_id, instruksi dari respons sebelumnya tidak akan dibawa ke respons berikutnya. Ini memudahkan untuk menukar pesan sistem (atau pengembang) dalam respons baru.	Tidak.
max_output_tokens	bilangan bulat	Batas atas untuk jumlah token yang dapat dihasilkan untuk respons, termasuk token output dan status percakapan yang terlihat.	Tidak.
previous_response_id	string	ID unik dari respons sebelumnya ke model. Gunakan ini untuk membuat percakapan multi-giliran.	Tidak.
reasoning	Reasoning	Opsi konfigurasi untuk model penalaran.	Tidak.
kirim pesan teks	objek	Opsi konfigurasi untuk respons teks dari model. Dapat berupa teks biasa atau data JSON terstruktur. Pelajari lebih lanjut: - masukan dan keluaran teks - Output Terstruktur	Tidak.
└─ bentuk	TextResponseFormatConfiguration	Objek yang menentukan format yang harus dihasilkan model. Mengonfigurasi { "type": "json_schema" } memungkinkan Output Terstruktur, yang memastikan model cocok dengan skema JSON yang Anda berikan. Format defaultnya adalah { "type": "text" } tanpa opsi tambahan. Tidak disarankan untuk model gpt-4o dan yang lebih baru: Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON yang lebih lama, yang memastikan pesan yang dihasilkan model adalah JSON yang valid. Penggunaan json_schema lebih disukai untuk model yang mendukungnya.	Tidak.
tool_choice	ToolChoiceOptions atau ToolChoiceTypes atau ToolChoiceFunction	Bagaimana model harus memilih alat (atau alat) mana yang akan digunakan saat menghasilkan respons. tools Lihat parameter untuk melihat cara menentukan alat mana yang dapat dipanggil model.	Tidak.
perangkat	array	Sekumpulan alat yang dapat dipanggil model ketika menghasilkan respons. Anda dapat menentukan alat mana yang akan digunakan dengan mengatur tool_choice parameter . Dua kategori alat yang dapat Anda sediakan untuk model adalah: - Alat bawaan	Tidak.
truncation	enum	Strategi pemotongan yang akan digunakan untuk respons model. - auto: Jika konteks respons ini dan yang sebelumnya melebihi ukuran jendela konteks model, model akan memotong respons agar sesuai dengan jendela konteks dengan menjatuhkan item input di tengah percakapan. - disabled (default): Jika respons model akan melebihi ukuran jendela konteks untuk model, permintaan akan gagal dengan kesalahan 400. Nilai yang mungkin: auto, disabled	Tidak.

ResponseRefusalDeltaEvent

Dipancarkan ketika ada teks penolakan parsial.

Nama	Tipe	Deskripsi	Diperlukan	Default
content_index	bilangan bulat	Indeks dari bagian konten di mana teks penolakan ditambahkan.	Yes
delta	string	Teks penolakan yang ditambahkan.	Yes
item_id	string	ID dari item keluaran tempat teks penolakan ditambahkan.	Yes
output_index	bilangan bulat	Indeks item output tempat teks penolakan ditambahkan.	Yes
jenis	enum	Jenis peristiwa. Selalu response.refusal.delta. Nilai yang mungkin: response.refusal.delta	Yes

ResponseRefusalDoneEvent

Dipancarkan ketika teks penolakan diselesaikan.

Nama	Tipe	Deskripsi	Diperlukan	Default
content_index	bilangan bulat	Indeks bagian konten tempat teks penolakan diselesaikan.	Yes
item_id	string	ID item keluaran dari teks penolakan yang selesai.	Yes
output_index	bilangan bulat	Indeks item output tempat teks penolakan dianggap selesai.	Yes
refusal	string	Teks penolakan yang sudah difinalisasi.	Yes
jenis	enum	Jenis peristiwa. Selalu response.refusal.done. Nilai yang mungkin: response.refusal.done	Yes

responseStreamEvent

Nama	Tipe	Deskripsi	Diperlukan	Default
anotasi	Annotation		Yes
annotation_index	bilangan bulat	Indeks anotasi yang ditambahkan.	Yes
argumen	string	Argumen pemanggilan fungsi.	Yes
kode	string	Kode kesalahan.	Yes
code_interpreter_call	CodeInterpreterToolCall	Panggilan alat untuk menjalankan kode.	Yes
content_index	bilangan bulat	Indeks bagian konten tempat konten teks difinalisasi.	Yes
delta	string	Delta teks yang ditambahkan.	Yes
item	OutputItem	Item keluaran yang sudah ditandai sebagai selesai.	Yes
item_id	string	ID dari item keluaran yang konten teksnya telah difinalisasi.	Yes
pesan	string	Pesan kesalahan.	Yes
output_index	bilangan bulat	Indeks item output yang difinalisasi konten teksnya.	Yes
param	string	Parameter kesalahan.	Yes
bagian	OutputContent	Bagian konten yang sudah selesai.	Yes
refusal	string	Teks penolakan yang sudah difinalisasi.	Yes
response	response	Tanggapan yang tidak lengkap.	Yes
kirim pesan teks	string	Konten teks yang sudah final.	Yes
jenis	enum	Jenis peristiwa. Selalu response.output_text.done. Nilai yang mungkin: response.output_text.done	Yes

ResponseTextAnnotationDeltaEvent

Dipancarkan saat anotasi teks ditambahkan.

Nama	Tipe	Deskripsi	Diperlukan	Default
anotasi	Annotation		Yes
annotation_index	bilangan bulat	Indeks anotasi yang ditambahkan.	Yes
content_index	bilangan bulat	Indeks dari bagian konten yang mendapat tambahan anotasi teks.	Yes
item_id	string	ID item output tempat anotasi teks ditambahkan.	Yes
output_index	bilangan bulat	Indeks item output di mana anotasi teks ditambahkan.	Yes
jenis	enum	Jenis peristiwa. Selalu response.output_text.annotation.added. Nilai yang mungkin: response.output_text.annotation.added	Yes

ResponseTextDeltaEvent

Dipancarkan ketika ada delta teks tambahan.

Nama	Tipe	Deskripsi	Diperlukan	Default
content_index	bilangan bulat	Indeks bagian konten tempat delta teks ditambahkan.	Yes
delta	string	Delta teks yang ditambahkan.	Yes
item_id	string	ID item keluaran tempat delta teks ditambahkan.	Yes
output_index	bilangan bulat	Indeks item output tempat delta teks ditambahkan.	Yes
jenis	enum	Jenis peristiwa. Selalu response.output_text.delta. Nilai yang mungkin: response.output_text.delta	Yes

ResponseTextDoneEvent

Dipancarkan ketika konten teks diselesaikan.

Nama	Tipe	Deskripsi	Diperlukan	Default
content_index	bilangan bulat	Indeks bagian konten tempat konten teks difinalisasi.	Yes
item_id	string	ID dari item keluaran yang konten teksnya telah difinalisasi.	Yes
output_index	bilangan bulat	Indeks item output yang difinalisasi konten teksnya.	Yes
kirim pesan teks	string	Konten teks yang sudah final.	Yes
jenis	enum	Jenis peristiwa. Selalu response.output_text.done. Nilai yang mungkin: response.output_text.done	Yes

ResponseUsage

Mewakili detail penggunaan token termasuk token input, token output, perincian token output, dan total token yang digunakan.

Nama	Tipe	Deskripsi	Diperlukan	Default
input_tokens	bilangan bulat	Jumlah token input.	Yes
output_tokens	bilangan bulat	Jumlah token output.	Yes
output_tokens_details	objek	Perincian terperinci dari token output.	Yes
└─ token_penalaran	bilangan bulat	Jumlah token penalaran.	Tidak.
total_tokens	bilangan bulat	Jumlah total token yang digunakan.	Yes

Screenshot

Aksi tangkapan layar.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Menentukan jenis peristiwa. Untuk tindakan cuplikan layar, properti ini selalu diatur ke screenshot. Nilai yang mungkin: screenshot	Yes

Scroll

Sebuah aksi pengguliran.

Nama	Tipe	Deskripsi	Diperlukan	Default
scroll_x	bilangan bulat	Jarak gulir horizontal tersebut.	Yes
scroll_y	bilangan bulat	Jarak gulir vertikal.	Yes
jenis	enum	Menentukan jenis peristiwa. Untuk tindakan gulir, properti ini selalu diatur ke scroll. Nilai yang mungkin: scroll	Yes
x	bilangan bulat	Koordinat x di mana gulir terjadi.	Yes
y	bilangan bulat	Koordinat y tempat pengguliran terjadi.	Yes

StopConfiguration

Hingga 4 urutan di mana API berhenti menghasilkan token lebih lanjut. Teks yang dikembalikan tidak akan berisi urutan berhenti.

Komponen ini bisa menjadi salah satu hal berikut:

TextResponseFormatConfiguration

Objek yang menentukan format yang harus dihasilkan model.

Mengonfigurasi { "type": "json_schema" } memungkinkan Output Terstruktur, yang memastikan model cocok dengan skema JSON yang Anda berikan.

Format defaultnya adalah { "type": "text" } tanpa opsi tambahan.

Tidak disarankan untuk model gpt-4o dan yang lebih baru:

Pengaturan untuk { "type": "json_object" } mengaktifkan mode JSON yang lebih lama, yang memastikan pesan yang dihasilkan model adalah JSON yang valid. Penggunaan json_schema lebih disukai untuk model yang mendukungnya.

Komponen ini bisa menjadi salah satu hal berikut:

• ResponseFormatText
• TextResponseFormatJsonSchema
• ResponseFormatJsonObject

TextResponseFormatJsonSchema

Format Skema JSON untuk respons. Digunakan untuk menghasilkan respons JSON terstruktur. Pelajari selengkapnya tentang Output Terstruktur.

Nama	Tipe	Deskripsi	Diperlukan	Default
deskripsi	string	Sebuah deskripsi tentang tujuan format respons, yang digunakan oleh model untuk menentukan cara merespons dalam format tersebut.	Tidak.
Nama	string	Nama format tanggapan. Harus a-z, A-Z, 0-9, atau berisi garis bawah dan tanda hubung, dengan panjang maksimum 64.	Tidak.
skema	ResponseFormatJsonSchema	Skema untuk format respons, dijelaskan sebagai objek Skema JSON.	Yes
tegas	Boolean	Apakah akan mengaktifkan kepatuhan skema yang ketat saat menghasilkan output. Jika diatur ke true, model akan selalu mengikuti skema yang tepat yang ditentukan di schema bidang . Hanya subset Skema JSON yang didukung saat strict adalah true.	Tidak.	False
jenis	enum	Jenis format respons yang ditentukan. Selalu json_schema. Nilai yang mungkin: json_schema	Yes

Alat

Komponen ini bisa menjadi salah satu hal berikut:

• FileSearchTool
• FunctionTool
• ComputerTool

ToolChoiceFunction

Gunakan opsi ini untuk memaksa model memanggil fungsi tertentu.

Nama	Tipe	Deskripsi	Diperlukan	Default
Nama	string	Nama fungsi yang akan dipanggil.	Yes
jenis	enum	Untuk panggilan fungsi, jenisnya selalu function. Nilai yang mungkin: function	Yes

ToolChoiceOptions

Mengontrol alat mana (jika ada) yang dipanggil oleh model.

none berarti model tidak akan memanggil alat apa pun dan sebaliknya menghasilkan pesan.

auto berarti model dapat memilih antara menghasilkan pesan atau memanggil satu atau beberapa alat.

required berarti model harus memanggil satu atau beberapa alat.

Harta benda	Nilai
Deskripsi	Mengontrol alat mana (jika ada) yang dipanggil oleh model. none berarti model tidak akan memanggil alat apa pun dan sebaliknya menghasilkan pesan. auto berarti model dapat memilih antara menghasilkan pesan atau memanggil satu atau beberapa alat. required berarti model harus memanggil satu atau beberapa alat.
Jenis	string
Nilai	none auto required

ToolChoiceTypes

Menunjukkan bahwa model harus menggunakan alat bawaan untuk menghasilkan respons.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Jenis alat yang dihosting yang harus digunakan oleh model. Nilai yang diizinkan adalah: - file_search - computer_use_preview Nilai yang mungkin: file_search, computer_use_preview	Yes

Tipe

Tindakan untuk mengetikkan teks.

Nama	Tipe	Deskripsi	Diperlukan	Default
kirim pesan teks	string	Teks yang akan diketik.	Yes
jenis	enum	Menentukan jenis peristiwa. Untuk tindakan jenis, properti ini selalu diatur ke type. Nilai yang mungkin: type	Yes

UpdateVectorStoreFileAttributesRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
attributes	VectorStoreFileAttributes	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter, boolean, atau angka.	Yes

UrlCitation

Kutipan untuk sumber daya web yang digunakan untuk menghasilkan respons model.

Nama	Tipe	Deskripsi	Diperlukan	Default
end_index	bilangan bulat	Indeks karakter terakhir kutipan URL dalam pesan.	Yes
start_index	bilangan bulat	Indeks karakter pertama kutipan URL dalam pesan.	Yes
title	string	Judul sumber daya web.	Yes
jenis	enum	Jenis kutipan URL. Selalu url_citation. Nilai yang mungkin: url_citation	Yes
URL	string	URL sumber daya web.	Yes

VectorStoreFileAttributes

Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter, boolean, atau angka.

Tidak ada properti yang ditentukan untuk komponen ini.

VectorStoreFileContentResponse

Mewakili konten yang diurai dari file penyimpanan vektor.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array	Konten dari file yang telah diurai.	Yes
ada_lagi	Boolean	Menunjukkan apakah ada lebih banyak halaman konten untuk diambil.	Yes
next_page	string	Token untuk halaman berikutnya, jika ada.	Yes
objek	enum	Jenis objek, yang selalu vector_store.file_content.page Nilai yang mungkin: vector_store.file_content.page	Yes

VectorStoreSearchRequest

Nama	Tipe	Deskripsi	Diperlukan	Default
filters	ComparisonFilter atau CompoundFilter	Filter untuk diterapkan berdasarkan atribut file.	Tidak.
jumlah_maksimum_hasil	bilangan bulat	Jumlah maksimum hasil yang akan dikembalikan. Angka ini harus antara 1 dan 50 inklusif.	Tidak.	10
kueri	string atau array	String kueri untuk pencarian	Yes
opsi_peringkat	objek	Opsi peringkat untuk pencarian.	Tidak.
└─ peringkat	enum	Nilai yang mungkin: auto, default-2024-11-15	Tidak.
└─ ambang_batas_skornya	nomor/angka		Tidak.	0
rewrite_query	Boolean	Apakah akan menulis ulang kueri bahasa alami untuk pencarian vektor.	Tidak.	False

VectorStoreSearchResultContentObject

Nama	Tipe	Deskripsi	Diperlukan	Default
kirim pesan teks	string	Konten teks yang dikembalikan dari hasil pencarian.	Yes
jenis	enum	Jenis konten. Nilai yang mungkin: text	Yes

VectorStoreSearchResultItem

Nama	Tipe	Deskripsi	Diperlukan	Default
attributes	VectorStoreFileAttributes	Set 16 pasangan kunci-nilai yang dapat dilampirkan ke objek. Ini dapat berguna untuk menyimpan informasi tambahan tentang objek dalam format terstruktur, dan mengkueri objek melalui API atau dasbor. Kunci adalah string dengan panjang maksimum 64 karakter. Nilai adalah string dengan panjang maksimum 512 karakter, boolean, atau angka.	Yes
isi	array	Potongan konten dari file.	Yes
file_id	string	ID berkas penyimpanan vektor.	Yes
filename	string	Nama file penyimpanan vektor.	Yes
skor	nomor/angka	Skor kesamaan untuk suatu hasil.	Yes

VectorStoreSearchResultsPage

Nama	Tipe	Deskripsi	Diperlukan	Default
data	array	Daftar item hasil pencarian.	Yes
ada_lagi	Boolean	Menunjukkan apakah ada lebih banyak hasil untuk diambil.	Yes
next_page	string	Token untuk halaman berikutnya, jika ada.	Yes
objek	enum	Jenis objek, yang selalu vector_store.search_results.page Nilai yang mungkin: vector_store.search_results.page	Yes
search_query	array		Yes

VoiceIdsShared

Tidak ada properti yang ditentukan untuk komponen ini.

Tunggu

Tindakan tunggu.

Nama	Tipe	Deskripsi	Diperlukan	Default
jenis	enum	Menentukan jenis peristiwa. Untuk tindakan tunggu, properti ini selalu diatur ke wait. Nilai yang mungkin: wait	Yes

ReasoningEffort

Membatasi upaya penalaran untuk model penalaran. Nilai yang saat ini didukung adalah low, medium, dan high. Mengurangi upaya penalaran dapat mengakibatkan respons yang lebih cepat dan lebih sedikit token yang digunakan pada penalaran dalam respons.

Harta benda	Nilai
Deskripsi	Membatasi upaya penalaran untuk model penalaran. Nilai yang saat ini didukung adalah low, medium, dan high. Mengurangi upaya penalaran dapat mengakibatkan respons yang lebih cepat dan lebih sedikit token yang digunakan pada penalaran dalam respons.
Jenis	string
Default	Sedang
Nilai	low medium high

errorEvent

Terjadi ketika terjadi kesalahan. Ini dapat terjadi karena kesalahan server internal atau waktu habis.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	kesalahan		Yes
acara	string		Yes

event Enum: ErrorEventEnum

Nilai	Deskripsi
galat

doneEvent

Terjadi saat aliran berakhir.

Nama	Tipe	Deskripsi	Diperlukan	Default
data	string		Yes
acara	string		Yes

event Enum: DoneEventEnum

Nilai	Deskripsi
selesai

enum data: DoneEventDataEnum

Nilai	Deskripsi
[DONE]

Langkah selanjutnya

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